diff --git a/_includes/footer.html b/_includes/footer.html index abfa674..6a16215 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -21,6 +21,16 @@ {% endif %} diff --git a/_includes/sidebar.html b/_includes/sidebar.html index 1ce7e72..93b5512 100644 --- a/_includes/sidebar.html +++ b/_includes/sidebar.html @@ -1,6 +1,14 @@
Copy license text to clipboard +

Suggest this license

+
+

Make a pull request to suggest this license fo a project that is not licensed. Please be polite: see if a license has already been suggested, try to suggest a license fitting for the project's community, and keep your communicaton with project maintainers friendly.

+
+ +
+
+

How to apply this license

diff --git a/assets/css/application.scss b/assets/css/application.scss index 3a8b5ae..e462748 100644 --- a/assets/css/application.scss +++ b/assets/css/application.scss @@ -294,6 +294,43 @@ strong { width: 100%; } +.sidebar input#repository-url { + width: 100%; + padding: 5px 20px 5px 10px; + box-sizing: border-box; + margin-right: 12px; +} + +.input-wrapper { + position: relative; +} + +.input-wrapper .status-indicator { + position: absolute; + right: 5px; + top: 6px; + height: 8px; + width: 8px; + border-radius: 50%; + background: #fff; + animation: none; + border: 4px solid #ddd; +} + +.input-wrapper .status-indicator.fetching { + border-right-color: transparent; + animation: rotate 0.8s infinite linear; +} + +.input-wrapper .status-indicator.error { + border: 4px solid #c6403d; +} + +@keyframes rotate { + 0% { transform: rotate(0deg); } + 100% { transform: rotate(360deg); } +} + .note { color: #687072; } @@ -386,7 +423,9 @@ strong { .qtip-conditions, .qtip-permissions, -.qtip-limitations { +.qtip-limitations, +.qtip-fetching, +.qtip-error { font-size: 12px; line-height: 1.3; } @@ -402,23 +441,27 @@ strong { color: #fff; } +.qtip-fetching, .qtip-permissions { background-color: #d8f4d7; border-color: #3dc637; color: #298625; } +.qtip-fetching .qtip-titlebar, .qtip-permissions .qtip-titlebar { background-color: #3dc637; color: #fff; } +.qtip-error, .qtip-limitations { background-color: #f4d9d8; border-color: #c6403d; color: #812a28; } +.qtip-error .qtip-titlebar, .qtip-limitations .qtip-titlebar { background-color: #c6403d; color: #fff; diff --git a/assets/js/app.coffee b/assets/js/app.coffee index 2141598..d9b0778 100644 --- a/assets/js/app.coffee +++ b/assets/js/app.coffee @@ -31,6 +31,7 @@ class Choosealicense constructor: -> @initTooltips() @initClipboard() + @initLicenseSuggestion() # Init tooltip action initTooltips: -> @@ -70,6 +71,111 @@ class Choosealicense # Post-copy user feedback callback clipboardComplete: (client, args) -> @textContent = "Copied!" + + # Initializes the repository suggestion feature + initLicenseSuggestion: -> + inputEl = $("#repository-url") + licenseId = inputEl.attr("data-license-id") + statusIndicator = $(".status-indicator") + new LicenseSuggestion(inputEl, licenseId, statusIndicator) +class LicenseSuggestion + constructor: (@inputEl, @licenseId, @statusIndicator) -> + @setupTooltips() + @bindEventHandlers() + + # Initializes tooltips on the input element + setupTooltips: => + @inputEl.qtip + content: + text: false + title: + text: "message" + show: false + hide: false + position: + my: "top center" + at: "bottom center" + style: + classes: "qtip-shadow" + + # Main event handlers for user input + bindEventHandlers: => + @inputEl.on "input", (event) => + @setStatus "" + .on "keyup", (event) => + if event.keyCode == 13 and event.target.value + # Validate the user input first + try + repositoryFullName = @parseUserInput event.target.value + catch + @setStatus "Error", "Invalid URL." + return + + @setStatus "Fetching" + @fetchInfoFromGithubAPI repositoryFullName, (err, repositoryInfo=null) => + if (err) + @setStatus "Error", err.message + return + if repositoryInfo.license # The repository already has a license + license = repositoryInfo.license + @setStatus "Error", @repositoryLicense repositoryFullName, license + else # The repository is not licensed + licenseUrl = encodeURIComponent "https://github.com/#{repositoryFullName}/community/license/new?template=#{@licenseId}" + # Provide the chance to the user log-in, since the URL to suggest a license is restricted + window.location.href = "https://github.com/login?return_to=#{licenseUrl}" + @setStatus "" + @inputEl.val("") + + # Try to extract the repository full name from the user input + parseUserInput: (userInput) -> + repository = /https?:\/\/github\.com\/(.*?)\/(.+)(\.git)?$/.exec userInput + [_, username, project] = repository + project = project + .split /\/|\.git/ + .filter (str) -> str + .slice 0, 1 + .join "" + return username + '/' + project + + # Displays an indicator and tooltips to the user about the current status + setStatus: (status="", message="") => + statusClass = status.toLowerCase() + displayQtip = (status, message) => + @inputEl.qtip("api") + .set("content.text", message) + .set("content.title", status) + .set("style.classes", "qtip-shadow qtip-#{statusClass}") + .show() + + switch status + when "Fetching" + @statusIndicator.removeClass('error').addClass(statusClass) + when "Error" + @statusIndicator.removeClass('fetching').addClass(statusClass) + displayQtip status, message + else + @inputEl.qtip("api").hide() + @statusIndicator.removeClass('fetching error') + + # Fetches information about a repository from the Github API + fetchInfoFromGithubAPI: (repositoryFullName, callback) -> + $.getJSON "https://api.github.com/repos/"+repositoryFullName, (info) -> + callback null, info + .fail (e) -> + if e.status == 404 + callback new Error "Repository #{repositoryFullName} not found." + else + callback new Error "Network error when trying to get information about #{repositoryFullName}." + + # Generates a message showing that a repository is already licensed + repositoryLicense: (repositoryFullName, license) -> + foundLicense = window.licenses.find (lic) -> lic.spdx_id == license.spdx_id + if foundLicense # Links the license to its page on this site + "The repository #{repositoryFullName} is already licensed under the + #{foundLicense.title}." + else + "The repository #{repositoryFullName} is already licensed." + $ -> new Choosealicense() diff --git a/no-permission.md b/no-permission.md index 3b85c5e..02a31f0 100644 --- a/no-permission.md +++ b/no-permission.md @@ -22,7 +22,7 @@ If you find software that doesn't have a license, that generally means you have Your options: -**Ask the maintainers nicely to add a license.** Unless the software includes strong indications to the contrary, lack of a license is probably an oversight. If the software is hosted on a site like GitHub, open an issue requesting a license and include a link to this site, or if you're bold and it's fairly obvious what license is most appropriate, open a pull request to add a license. +**Ask the maintainers nicely to add a license.** Unless the software includes strong indications to the contrary, lack of a license is probably an oversight. If the software is hosted on a site like GitHub, open an issue requesting a license and include a link to this site. If you're bold and it's fairly obvious what license is most appropriate, open a pull request to add a license – see "suggest this license" in the sidebar of the page for each license on this site (e.g., [MIT](/licenses/mit/#suggest-this-license)). **Don't use the software.** Find or create an alternative that is under an open source license.