docs and create template for new license stanza

some :closed licenses in the code are left undocumented for now, and should not be used.
Homebrew · Oct 1, 2014 · f1604e4 · f1604e4
1 parent 48164c1
commit f1604e4
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -39,6 +39,7 @@ class Alfred < Cask
 
   url 'https://cachefly.alfredapp.com/Alfred_2.3_264.zip'
   homepage 'http://www.alfredapp.com/'
+  license :commercial
 
   app 'Alfred 2.app'
   app 'Alfred 2.app/Contents/Preferences/Alfred Preferences.app'
@@ -54,6 +55,7 @@ class Unity < Cask
 
   url 'http://netstorage.unity3d.com/unity/unity-4.5.4.dmg'
   homepage 'http://unity3d.com/unity/'
+  license :commercial
 
   pkg 'Unity.pkg'
   uninstall :pkgutil => 'com.unity3d.*'
@@ -69,6 +71,7 @@ class Firefox < Cask
 
   url 'https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US'
   homepage 'https://www.mozilla.org/en-US/firefox/'
+  license :mpl
 
   app 'Firefox.app'
 end
@@ -119,6 +122,7 @@ class MyNewCask < Cask
 
   url ''
   homepage ''
+  license :unknown
 
   app ''
 end
@@ -134,6 +138,7 @@ Fill in the following stanzas for your Cask:
 | `sha256`           | SHA-256 checksum of the file downloaded from `url`, calculated by the command `shasum -a 256 <file>`.  Can be suppressed for unversioned downloads by using the special value `:no_check`. (see also [Checksum Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#checksum-stanza-details))
 | `url`              | URL to the `.dmg`/`.zip`/`.tgz` file that contains the application (see also [URL Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#url-stanza-details))
 | `homepage`         | application homepage; used for the `brew cask home` command
+| `license`          | a symbol identifying the license for the application.  Valid category licenses include `:oss`, `:closed`, and `:unknown`.  It is OK to leave as `:unknown`.  (see also [License Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#license-stanza-details))
 | `app`              | relative path to an `.app` bundle that should be linked into the `~/Applications` folder on installation (see also [App Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#app-stanza-details))
 
 Other commonly-used stanzas are:

diff --git a/doc/CASK_LANGUAGE_REFERENCE.md b/doc/CASK_LANGUAGE_REFERENCE.md
@@ -14,6 +14,7 @@ Cask Domain-Specific Language (DSL) which are not needed in most cases.
  * [Caveats Stanza Details](#caveats-stanza-details)
  * [Checksum Stanza Details](#checksum-stanza-details)
  * [URL Stanza Details](#url-stanza-details)
+ * [License Stanza Details](#license-stanza-details)
  * [App Stanza Details](#app-stanza-details)
  * [Suite Stanza Details](#suite-stanza-details)
  * [Pkg Stanza Details](#pkg-stanza-details)
@@ -36,6 +37,7 @@ class Alfred < Cask
 
   url 'https://cachefly.alfredapp.com/Alfred_2.3_264.zip'
   homepage 'http://www.alfredapp.com/'
+  license :commercial
 
   app 'Alfred 2.app'
   app 'Alfred 2.app/Contents/Preferences/Alfred Preferences.app'
@@ -69,6 +71,7 @@ Each of the following stanzas is required for every Cask.
 | `sha256`           | No                            | SHA-256 checksum of the file downloaded from `url`, calculated by the command `shasum -a 256 <file>`.  Can be suppressed for unversioned downloads by using the special value `:no_check`. (see also [Checksum Stanza Details](#checksum-stanza-details))
 | `url`              | No                            | URL to the `.dmg`/`.zip`/`.tgz` file that contains the application (see also [URL Stanza Details](#url-stanza-details))
 | `homepage`         | No                            | application homepage; used for the `brew cask home` command
+| `license`          | No                            | a symbol identifying the license for the application. (see also [License Stanza Details](#license-stanza-details))
 
 
 ## At Least One Artifact Stanza Is Also Required
@@ -305,6 +308,54 @@ following key/value pairs to `url`:
 | `:trust_cert`      | set to `true` to automatically trust the certificate presented by the server (avoiding an interactive prompt)
 
 
+## License Stanza Details
+
+The `license` stanza is not free-form.  The value must be chosen from a
+list of valid symbols.
+
+The distinctions between license types are not very detailed.  For example,
+we do not distinguish between versions of the GPL, or variants of the BSD
+license.  The `license` stanza is intended as an aid to search/filtering of
+Casks.  For detailed information, the user must rely on the vendor's
+homepage.
+
+### Valid Category Licenses
+
+If a Cask does not quite fit one of the specific license types, use one of
+the general categories.  `:unknown` is perfectly fine if you are unsure.
+
+| symbol      | meaning     |
+| ----------- | ----------- |
+| `:oss`      | Open-source software
+| `:closed`   | Closed-source software
+| `:unknown`  | License unknown
+| `:other`    | License is known, but fits no category
+
+### Valid Licenses
+
+| symbol           | category  | meaning                                         | URL         |
+| ---------------- | --------- | ----------------------------------------------- | ----------- |
+| `:gratis`        | `:closed` | Free-to-use, closed source                      | <none>
+| `:commercial`    | `:closed` | Not free to use                                 | <none>
+| `:affero`        | `:oss`    | Affero General Public License                   | <https://gnu.org/licenses/agpl.html>
+| `:apache`        | `:oss`    | Apache Public License                           | <http://www.apache.org/licenses/>
+| `:arphic`        | `:oss`    | Arphic Public License                           | <http://www.arphic.com/tw/download/public_license.rar>
+| `:artistic`      | `:oss`    | Artistic License                                | <http://dev.perl.org/licenses/artistic.html>
+| `:bsd`           | `:oss`    | BSD License                                     | <http://www.linfo.org/bsdlicense.html>
+| `:cc`            | `:oss`    | Creative Commons License                        | <http://creativecommons.org/licenses/>
+| `:eclipse`       | `:oss`    | Eclipse Public License                          | <https://www.eclipse.org/legal/eplfaq.php>
+| `:gpl`           | `:oss`    | GNU Public License                              | <http://www.gnu.org/copyleft/gpl.html>
+| `:isc`           | `:oss`    | Internet Systems Consortium License             | <http://www.isc.org/downloads/software-support-policy/isc-license/>
+| `:lppl`          | `:oss`    | LaTeX Project Public License                    | <http://latex-project.org/lppl/>
+| `:ncsa`          | `:oss`    | University of Illinois/NCSA Open Source License | <http://otm.illinois.edu/uiuc_openSource>
+| `:mit`           | `:oss`    | MIT License                                     | <http://opensource.org/licenses/MIT>
+| `:mpl`           | `:oss`    | Mozilla Public License                          | <https://www.mozilla.org/MPL/>
+| `:ofl`           | `:oss`    | SIL Open Font License                           | <http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL>
+| `:public_domain` | `:oss`    | Not copyrighted                                 | <http://creativecommons.org/publicdomain/zero/1.0/legalcode>
+| `:ubuntu_font`   | `:oss`    | Ubuntu Font License                             | <http://font.ubuntu.com/licence/>
+| `:x11`           | `:oss`    | X Consortium License                            | <http://www.xfree86.org/3.3.6/COPYRIGHT2.html>
+
+
 ## App Stanza Details
 
 In the simple case of a string argument to `app`, a symlink is created in
@@ -689,6 +740,7 @@ class Appname < Cask
 
   version '1.0'
   sha256 'a32565cdb1673f4071593d4cc9e1c26bc884218b62fef8abc450daa47ba8fa92'
+  license :unknown
 
   url "https://#{Utils.arbitrary_method}"
   homepage 'http://www.example.com/'

diff --git a/doc/cask_language_deltas.md b/doc/cask_language_deltas.md
@@ -45,6 +45,7 @@ This notice will be removed for the final form.**
  * `suite`
  * `uninstall :rmdir`
  * `zap`
+ * `license`
 
 
 ## Renames (1.0)

diff --git a/lib/cask/cli/create.rb b/lib/cask/cli/create.rb
@@ -25,6 +25,7 @@ class #{cask_class} < Cask
 
         url 'https://'
         homepage ''
+        license :unknown
 
         app ''
       end

diff --git a/lib/cask/dsl/license.rb b/lib/cask/dsl/license.rb
@@ -9,11 +9,11 @@ class Cask::DSL::License
                     :other         => :other,
 
                     :closed        => :closed,
-                    :abandoned     => :closed,
                     :commercial    => :closed,
-                    :freemium      => :closed,
                     :gratis        => :closed,
-                    :trial         => :closed,
+                    :abandoned     => :closed,  # undocumented, should not be used yet
+                    :freemium      => :closed,  # undocumented, should not be used yet
+                    :trial         => :closed,  # undocumented, should not be used yet
 
                     :oss           => :oss,
                     :affero        => :oss,

diff --git a/test/cask/cli/create_test.rb b/test/cask/cli/create_test.rb
@@ -42,6 +42,7 @@ class NewCask < Cask
 
         url 'https://'
         homepage ''
+        license :unknown
 
         app ''
       end
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,6 +25,7 @@ class #{cask_class} < Cask @@
             url 'https://'
             homepage ''
+            license :unknown
             app ''
           end
@@ Expand Down @@