licensee 8.6.1 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db5339f9df2f471f5e135cac56f74b504a56d8d6
-  data.tar.gz: cac4055b2870d26d98e92b52ac2f1c7d50d75077
+  metadata.gz: 409f633d4be23f1510209f7829bec582d72bf880
+  data.tar.gz: 9e047e3ba7a0d209653bdb0121137c825aed9b28
 SHA512:
-  metadata.gz: 940e7038963a4e2e59db2e496bdee7a04da632fdf022ace519ac03e28d820df17803965fe1e82e1c838a57ca5816450fc30cf630b294dd51c098f40fd3a601dc
-  data.tar.gz: 537151b4d2aa33c9a3f993a1556d5e9f110cf9708cd0ca2cd46689439da34d6c17c9f16556d5a21fda5d1a2c26705ac40d32396b08d4b6c121172112e3f27014
+  metadata.gz: 9bc05051d0b12c781e5d3b4df6f3ab9370117eaec627a4419ac555830c36c8b9f02a0f9c5b57dbd932b561d2d30aac20fa9fade0f4e072704cf08a0a573d6d5f
+  data.tar.gz: a1fa2e528dde49d623c14aafa69b2ae58b44e15caba9ed98ce46115f4f8d1bdbe0ece6600fafe7cb49f413c760fed77f001c5d537e1b06824047c02fcfd1c35c

data/lib/licensee.rb

@@ -1,6 +1,7 @@
 require_relative 'licensee/version'
 require_relative 'licensee/content_helper'
 require_relative 'licensee/license'
+require_relative 'licensee/rule'
 
 # Projects
 require_relative 'licensee/project'

data/lib/licensee/license.rb

@@ -135,6 +135,19 @@ module Licensee
       PSEUDO_LICENSES.include?(key)
     end
 
+    # Returns a hash in the form of rule_group => rules describing
+    # what you legally can and can't do with the given license
+    def rules
+      return @rules if defined? @rules
+      @rules = {}
+
+      Rule.groups.each do |group|
+        @rules[group] = meta[group].map { |tag| Rule.find_by_tag(tag) }
+      end
+
+      @rules
+    end
+
     def inspect
       "#<Licensee::License key=#{key}>"
     end

data/lib/licensee/project.rb

@@ -26,7 +26,7 @@ module Licensee
         license_file = license_from_file { |n| LicenseFile.name_score(n) }
         return license_file unless license_file && license_file.license
 
-        # Special case LGPL, which actuall lives in LICENSE.lesser, per the
+        # Special case LGPL, which actually lives in LICENSE.lesser, per the
         # license instructions. See https://git.io/viwyK
         lesser = if license_file.license.gpl?
           license_from_file { |file| LicenseFile.lesser_gpl_score(file) }

data/lib/licensee/project_files/readme.rb

@@ -6,7 +6,17 @@ module Licensee
         /\AREADME\.(md|markdown|mdown|txt)\z/i => 0.9
       }.freeze
 
-      CONTENT_REGEX = /^#+ Licen[sc]e$(.*?)(?=#+|\z)/im
+      CONTENT_REGEX = /^
+          (?:\#+\sLicen[sc]e     # Start of hashes-based license header
+             |
+             Licen[sc]e\n[-=]+)$ # Start of underlined license header
+          (.*?)                  # License content
+          (?=^(?:\#+             # Next hashes-based header
+                 |
+                 [^\n]+\n[-=]+)  # Next of underlined header
+             |
+             \z)                 # End of file
+        /mix
 
       def self.name_score(filename)
         SCORES.each do |pattern, score|

data/lib/licensee/projects/fs_project.rb

@@ -3,10 +3,14 @@
 # Analyze a folder on the filesystem for license information
 module Licensee
   class FSProject < Project
-    attr_reader :path
-
     def initialize(path, **args)
-      @path = path
+      if ::File.file?(path)
+        @pattern = ::File.basename(path)
+        @dir = ::File.dirname(path)
+      else
+        @pattern = '*'
+        @dir = path
+      end
       super(**args)
     end
 
@@ -17,14 +21,7 @@ module Licensee
     def files
       files = []
 
-      if ::File.file?(path)
-        pattern = ::File.basename(path)
-        @path = ::File.dirname(path)
-      else
-        pattern = '*'
-      end
-
-      Dir.glob(::File.join(path, pattern)) do |file|
+      Dir.glob(::File.join(@dir, @pattern).tr('\\', '/')) do |file|
         next unless ::File.file?(file)
         files.push(name: ::File.basename(file))
       end
@@ -36,9 +33,9 @@ module Licensee
     #
     # file - the file hash, with the :name key as the file's relative path
     #
-    # Returns the fiel contents as a string
+    # Returns the file contents as a string
     def load_file(file)
-      ::File.read(::File.join(path, file[:name]))
+      ::File.read(::File.join(@dir, file[:name]))
     end
   end
 end

data/lib/licensee/rule.rb

@@ -0,0 +1,48 @@
+module Licensee
+  class Rule
+    attr_reader :tag, :label, :description, :group
+
+    def initialize(tag: nil, label: nil, description: nil, group: nil)
+      @tag = tag
+      @label = label
+      @description = description
+      @group = group
+    end
+
+    def inspect
+      "#<Licensee::Rule @tag=\"#{tag}\">"
+    end
+
+    class << self
+      def all
+        @all ||= raw_rules.map do |group, rules|
+          rules.map do |rule|
+            Rule.new(
+              tag:         rule['tag'],
+              label:       rule['label'],
+              description: rule['description'],
+              group:       group
+            )
+          end
+        end.flatten
+      end
+
+      def find_by_tag(tag)
+        Rule.all.find { |r| r.tag == tag }
+      end
+
+      def file_path
+        dir = File.dirname(__FILE__)
+        File.expand_path '../../vendor/choosealicense.com/_data/rules.yml', dir
+      end
+
+      def raw_rules
+        YAML.load File.read(Rule.file_path)
+      end
+
+      def groups
+        Rule.raw_rules.keys
+      end
+    end
+  end
+end

data/lib/licensee/version.rb

@@ -1,3 +1,3 @@
 module Licensee
-  VERSION = '8.6.1'.freeze
+  VERSION = '8.7.0'.freeze
 end

data/spec/licensee/license_spec.rb

@@ -221,4 +221,10 @@ RSpec.describe Licensee::License do
       described_class.new('foo').name
     end.to raise_error(Licensee::InvalidLicense)
   end
+
+  it 'returns the rules' do
+    expect(mit.rules).to have_key('permissions')
+    expect(mit.rules['permissions'].first).to be_a(Licensee::Rule)
+    expect(mit.rules.flatten.count).to eql(6)
+  end
 end

data/spec/licensee/project_files/readme_spec.rb

@@ -50,6 +50,14 @@ RSpec.describe Licensee::Project::Readme do
       end
     end
 
+    context 'after an underlined header' do
+      let(:content) { "License\n-------\n\nhello world" }
+
+      it 'returns the license' do
+        expect(license).to eql('hello world')
+      end
+    end
+
     context 'With a strangely cased heading' do
       let(:content) { "## LICENSE\n\nhello world" }
 
@@ -73,5 +81,21 @@ RSpec.describe Licensee::Project::Readme do
         expect(license).to eql('hello world')
       end
     end
+
+    context 'with trailing content that has an underlined header' do
+      let(:content) { "# License\n\nhello world\n\nContributing\n====" }
+
+      it 'returns the license' do
+        expect(license).to eql('hello world')
+      end
+    end
+
+    context 'with trailing content that has a hashes-based header' do
+      let(:content) { "# License\n\nhello world\n\n# Contributing" }
+
+      it 'returns the license' do
+        expect(license).to eql('hello world')
+      end
+    end
   end
 end

data/spec/licensee/rule.rb

@@ -0,0 +1,45 @@
+RSpec.describe Licensee::Rule do
+  let(:groups) { %w(permissions conditions limitations) }
+
+  it 'stores the properties' do
+    rule = described_class.new(
+      tag:         'tag',
+      label:       'label',
+      description: 'description',
+      group:       'group'
+    )
+
+    expect(rule.tag).to eql('tag')
+    expect(rule.label).to eql('label')
+    expect(rule.description).to eql('description')
+    expect(rule.group).to eql('group')
+  end
+
+  it 'loads the groups' do
+    expect(described_class.groups).to eql(groups)
+  end
+
+  it 'loads the raw rules' do
+    groups.each do |key|
+      expect(described_class.raw_rules).to have_key(key)
+    end
+  end
+
+  it 'determines the file path' do
+    path = described_class.file_path
+    expect(File.exist?(path)).to eql(true)
+  end
+
+  it 'loads a rule by tag' do
+    rule = described_class.find_by_tag('commercial-use')
+    expect(rule).to be_a(described_class)
+    expect(rule.tag).to eql('commercial-use')
+  end
+
+  it 'loads all rules' do
+    expect(described_class.all.count).to eql(13)
+    rule = described_class.all.first
+    expect(rule).to be_a(described_class)
+    expect(rule.tag).to eql('commercial-use')
+  end
+end

data/vendor/choosealicense.com/_data/fields.yml

@@ -0,0 +1,23 @@
+# The licenses on choosealicense.com are regularly imported to GitHub.com to
+# be used as the list of licenses available when creating a repository. When
+# we create a repository, we will replace certain strings in the license with
+# variables from the repository. These can be used to create accurate copyright
+# notices. The available variables are:
+
+- name: fullname
+  description: The full name or username of the repository owner
+
+- name: login
+  description: The repository owner's username
+
+- name: email
+  description: The repository owner's primary email address
+
+- name: project
+  description: The repository name
+
+- name: description
+  description: The description of the repository
+
+- name: year
+  description: The current year

data/vendor/choosealicense.com/_data/meta.yml

@@ -0,0 +1,60 @@
+# Each license has YAML front matter describing the license's properties.
+# The available fields are:
+
+- name: title
+  description: The license full name specified by http://spdx.org/licenses/
+  required: true
+
+- name: spdx-id
+  description: Short identifier specified by http://spdx.org/licenses/
+  required: required
+
+- name: source
+  description: The URL to the license source text
+  required: true
+
+- name: description
+  description: A human-readable description of the license
+  required: true
+
+- name: how
+  description: Instructions on how to implement the license
+  required: true
+
+- name: conditions
+  description: Bulleted list of required rules
+  required: true
+
+- name: permissions
+  description: Bulleted list of permitted rules
+  required: true
+
+- name: limitations
+  description: Bulleted list of limited rules
+  required: true
+
+# Optional fields
+
+- name: featured
+  description: Whether the license should be featured on the main page (defaults to false)
+  required: false
+
+- name: hidden
+  description: Whether the license is hidden from the license list (defaults to true)
+  required: false
+
+- name: nickname
+  description: Customary short name if applicable (e.g, GPLv3)
+  required: false
+
+- name: note
+  description: Additional information about the licenses
+  required: false
+
+- name: using
+  description: 'A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`'
+  required: false
+
+- name: redirect_from
+  description: Relative path(s) to redirect to the license from, to prevent breaking old URLs
+  required: false

data/vendor/choosealicense.com/_data/rules.yml

@@ -0,0 +1,44 @@
+permissions:
+- description: This software and derivatives may be used for commercial purposes.
+  label: Commercial Use
+  tag: commercial-use
+- description: This software may be modified.
+  label: Modification
+  tag: modifications
+- description: You may distribute this software.
+  label: Distribution
+  tag: distribution
+- description: You may use and modify the software without distributing it.
+  label: Private Use
+  tag: private-use
+- description: This license provides an express grant of patent rights from the contributor to the recipient.
+  label: Patent Use
+  tag: patent-use
+
+conditions:
+- description: Include a copy of the license and copyright notice with the code.
+  label: License and Copyright Notice
+  tag: include-copyright
+- description: Indicate changes made to the code.
+  label: State Changes
+  tag: document-changes
+- description: Source code must be made available when distributing the software.
+  label: Disclose Source
+  tag: disclose-source
+- description: Users who interact with the software via network are given the right to receive a copy of the corresponding source code.
+  label: Network Use is Distribution
+  tag: network-use-disclose
+- description: Modifications must be released under the same license when distributing the software. In some cases a similar or related license may be used.
+  label: Same License
+  tag: same-license
+
+limitations:
+- description: This license explicitly states that it does NOT grant you trademark rights, even though licenses without such a statement probably do not grant you any implicit trademark rights.
+  label: Trademark Use
+  tag: trademark-use
+- description: Software is provided without warranty and the software author/license owner cannot be held liable for damages.
+  label: Hold Liable
+  tag: no-liability
+- description: This license explicitly states that it does NOT grant you any rights in the patents of contributors.
+  label: Patent Use
+  tag: patent-use

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensee
 version: !ruby/object:Gem::Version
-  version: 8.6.1
+  version: 8.7.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -123,6 +123,7 @@ files:
 - lib/licensee/project_files/readme.rb
 - lib/licensee/projects/fs_project.rb
 - lib/licensee/projects/git_project.rb
+- lib/licensee/rule.rb
 - lib/licensee/version.rb
 - spec/bin_spec.rb
 - spec/fixtures/case-sensitive/LiCeNsE.TxT
@@ -148,10 +149,14 @@ files:
 - spec/licensee/project_files/package_info_spec.rb
 - spec/licensee/project_files/readme_spec.rb
 - spec/licensee/project_spec.rb
+- spec/licensee/rule.rb
 - spec/licensee_spec.rb
 - spec/project_file_spec.rb
 - spec/spec_helper.rb
 - spec/vendored_license_spec.rb
+- vendor/choosealicense.com/_data/fields.yml
+- vendor/choosealicense.com/_data/meta.yml
+- vendor/choosealicense.com/_data/rules.yml
 - vendor/choosealicense.com/_licenses/afl-3.0.txt
 - vendor/choosealicense.com/_licenses/agpl-3.0.txt
 - vendor/choosealicense.com/_licenses/apache-2.0.txt
@@ -200,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem to detect open source project licenses