license_finder 1.0.0.0-java → 1.1.1-java

data/lib/license_finder/license/definitions.rb

@@ -1,106 +1,155 @@
-class LicenseFinder::License
-  def self.mit_matcher
-    url_regexp = %r{MIT Licen[sc]e.*http://(?:www\.)?opensource\.org/licenses/mit-license}
-    header_regexp = /The MIT Licen[sc]e/
-    one_liner_regexp = /is released under the MIT licen[sc]e/
-
-    AnyMatcher.new(
-      Matcher.from_template(Template.named("MIT")),
-      Matcher.new(url_regexp),
-      HeaderMatcher.new(Matcher.new(header_regexp)),
-      Matcher.new(one_liner_regexp)
-    )
+module LicenseFinder
+  class License
+    module Definitions
+      extend self
+
+      def all(whitelist)
+        [
+          apache2,
+          bsd,
+          gplv2,
+          isc,
+          lgpl,
+          mit,
+          newbsd,
+          python,
+          ruby,
+          simplifiedbsd
+        ].map { |license|
+          whitelist_if_necessary(license, whitelist)
+        }
+      end
+
+      def build_unrecognized(name, whitelist)
+        result = License.new(
+          short_name: name,
+          url: nil,
+          matcher: NoneMatcher.new
+        )
+        whitelist_if_necessary(result, whitelist)
+      end
+
+      private
+
+      def whitelist_if_necessary(license, whitelist)
+        whitelisted = whitelist.any? { |name| license.matches_name? name }
+        whitelisted ? license.whitelist : license
+      end
+
+      def apache2
+        License.new(
+          short_name:  "Apache2",
+          pretty_name: "Apache 2.0",
+          other_names: ["Apache-2.0", "Apache Software License", "Apache License 2.0", "Apache License Version 2.0", "Apache Public License 2.0"],
+          url:         "http://www.apache.org/licenses/LICENSE-2.0.txt"
+        )
+      end
+
+      def bsd
+        License.new(
+          short_name:  "BSD",
+          other_names: ["BSD4", "bsd-old", "4-clause BSD", "BSD-4-Clause", "BSD License"],
+          url:         "http://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_.28original_.22BSD_License.22.29"
+        )
+      end
+
+      def gplv2
+        License.new(
+          short_name:  "GPLv2",
+          other_names: ["GPL V2", "gpl-v2", "GNU GENERAL PUBLIC LICENSE Version 2"],
+          url:         "http://www.gnu.org/licenses/gpl-2.0.txt"
+        )
+      end
+
+      def isc
+        License.new(
+          short_name: "ISC",
+          url:        "http://en.wikipedia.org/wiki/ISC_license"
+        )
+      end
+
+      def lgpl
+        License.new(
+          short_name:  "LGPL",
+          other_names: ["LGPL-3", "LGPLv3", "LGPL-3.0"],
+          url:         "http://www.gnu.org/licenses/lgpl.txt"
+        )
+      end
+
+      def mit
+        url_regexp = %r{MIT Licen[sc]e.*http://(?:www\.)?opensource\.org/licenses/mit-license}
+        header_regexp = /The MIT Licen[sc]e/
+        one_liner_regexp = /is released under the MIT licen[sc]e/
+
+        matcher = AnyMatcher.new(
+          Matcher.from_template(Template.named("MIT")),
+          Matcher.from_regex(url_regexp),
+          HeaderMatcher.new(Matcher.from_regex(header_regexp)),
+          Matcher.from_regex(one_liner_regexp)
+        )
+
+        License.new(
+          short_name:  "MIT",
+          other_names: ["Expat", "MIT license", "MIT License"],
+          url:         "http://opensource.org/licenses/mit-license",
+          matcher:     matcher
+        )
+      end
+
+      def newbsd
+        template = Template.named("NewBSD")
+        alternate_content = template.content.gsub(
+          "Neither the name of <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.",
+          "The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission."
+        )
+
+        matcher = AnyMatcher.new(
+          Matcher.from_template(template),
+          Matcher.from_text(alternate_content)
+        )
+
+        License.new(
+          short_name:  "NewBSD",
+          pretty_name: "New BSD",
+          other_names: ["Modified BSD", "BSD3", "BSD-3", "3-clause BSD", "BSD-3-Clause"],
+          url:         "http://opensource.org/licenses/BSD-3-Clause",
+          matcher:     matcher
+        )
+      end
+
+      def python
+        License.new(
+          short_name:  "Python",
+          pretty_name: "Python Software Foundation License",
+          other_names: ["PSF"],
+          url:         "http://hg.python.org/cpython/raw-file/89ce323357db/LICENSE"
+        )
+      end
+
+      def ruby
+        url = "http://www.ruby-lang.org/en/LICENSE.txt"
+
+        matcher = AnyMatcher.new(
+          Matcher.from_template(Template.named("Ruby")),
+          Matcher.from_text(url)
+        )
+
+        License.new(
+          short_name:  "Ruby",
+          pretty_name: "ruby",
+          url:         url,
+          matcher:     matcher
+        )
+      end
+
+      def simplifiedbsd
+        License.new(
+          short_name:  "SimplifiedBSD",
+          pretty_name: "Simplified BSD",
+          other_names: ["FreeBSD", "2-clause BSD", "BSD-2-Clause"],
+          url:         "http://opensource.org/licenses/bsd-license"
+        )
+      end
+    end
   end
-
-  def self.new_bsd_matcher
-    template = Template.named("NewBSD")
-    alternate_content = template.content.gsub(
-      "Neither the name of <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.",
-      "The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission."
-    )
-
-    AnyMatcher.new(
-      Matcher.from_template(template),
-      Matcher.from_text(alternate_content)
-    )
-  end
-
-  def self.ruby_license_url
-    "http://www.ruby-lang.org/en/LICENSE.txt"
-  end
-
-  def self.ruby_matcher
-    url_regex = Regexp.new(Regexp.escape(ruby_license_url))
-
-    AnyMatcher.new(
-      Matcher.from_template(Template.named("Ruby")),
-      Matcher.new(url_regex)
-    )
-  end
-
-  all << new(
-    short_name:  "Apache2",
-    pretty_name: "Apache 2.0",
-    other_names: ["Apache-2.0", "Apache Software License", "Apache License 2.0", "Apache License Version 2.0", "Apache Public License 2.0"],
-    url:         "http://www.apache.org/licenses/LICENSE-2.0.txt"
-  )
-
-  all << new(
-    short_name:  "BSD",
-    other_names: ["BSD4", "bsd-old", "4-clause BSD", "BSD-4-Clause", "BSD License"],
-    url:         "http://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_.28original_.22BSD_License.22.29"
-  )
-
-  all << new(
-    short_name:  "GPLv2",
-    other_names: ["GPL V2", "gpl-v2", "GNU GENERAL PUBLIC LICENSE Version 2"],
-    url:         "http://www.gnu.org/licenses/gpl-2.0.txt"
-  )
-
-  all << new(
-    short_name: "ISC",
-    url:        "http://en.wikipedia.org/wiki/ISC_license"
-  )
-
-  all << new(
-    short_name:  "LGPL",
-    other_names: ["LGPL-3", "LGPLv3", "LGPL-3.0"],
-    url:         "http://www.gnu.org/licenses/lgpl.txt"
-  )
-
-  all << new(
-    short_name:  "MIT",
-    other_names: ["Expat", "MIT license", "MIT License"],
-    url:         "http://opensource.org/licenses/mit-license",
-    matcher:     mit_matcher
-  )
-
-  all << new(
-    short_name:  "NewBSD",
-    pretty_name: "New BSD",
-    other_names: ["Modified BSD", "BSD3", "BSD-3", "3-clause BSD", "BSD-3-Clause"],
-    url:         "http://opensource.org/licenses/BSD-3-Clause",
-    matcher:     new_bsd_matcher
-  )
-
-  all << new(
-    short_name:  "Python",
-    pretty_name: "Python Software Foundation License",
-    other_names: ["PSF"],
-    url:         "http://hg.python.org/cpython/raw-file/89ce323357db/LICENSE"
-  )
-
-  all << new(
-    short_name:  "Ruby",
-    pretty_name: "ruby",
-    url:         ruby_license_url,
-    matcher:     ruby_matcher
-  )
-
-  all << new(
-    short_name:  "SimplifiedBSD",
-    pretty_name: "Simplified BSD",
-    other_names: ["FreeBSD", "2-clause BSD", "BSD-2-Clause"],
-    url:         "http://opensource.org/licenses/bsd-license"
-  )
 end

data/lib/license_finder/license/matcher.rb

@@ -6,7 +6,12 @@ module LicenseFinder
       end
 
       def self.from_text(text)
-        new(Text.compile_to_regex(text))
+        from_regex(Text.compile_to_regex(text))
+      end
+
+      # an alias for Matcher.new, for uniformity of constructors
+      def self.from_regex(regexp)
+        new(regexp)
       end
 
       def matches_text?(text)

data/lib/license_finder/license/none_matcher.rb

@@ -0,0 +1,9 @@
+module LicenseFinder
+  class License
+    class NoneMatcher
+      def matches_text?(text)
+        false
+      end
+    end
+  end
+end

data/lib/license_finder/license/text.rb

@@ -8,6 +8,7 @@ module LicenseFinder
       def self.normalize_punctuation(text)
         text.gsub(SPACES, ' ')
             .gsub(QUOTES, '"')
+            .strip
       end
 
       def self.compile_to_regex(text)

data/lib/license_finder/package.rb

@@ -6,8 +6,9 @@ module LicenseFinder
   #     it_behaves_like "it conforms to interface required by PackageSaver"
   # and see BundlerPackage, PipPackage and NpmPackage
   class Package
-    def self.extract_licenses_from_standard_spec(spec)
+    def self.license_names_from_standard_spec(spec)
       licenses = spec["licenses"] || [spec["license"]].compact
+      licenses = [licenses] unless licenses.is_a?(Array)
       licenses.map do |license|
         if license.is_a? Hash
           license["type"]
@@ -24,15 +25,30 @@ module LicenseFinder
     private
 
     def determine_license
-      licenses = (licenses_from_spec + license_from_files).uniq
-      if licenses.length == 1
-        licenses.first
+      if licenses_from_spec.any?
+        choose_license_from licenses_from_spec
+      elsif licenses_from_files.any?
+        choose_license_from licenses_from_files
       else
         default_license
       end
     end
 
-    def license_from_files
+    def choose_license_from licenses
+      if ( licenses.uniq.size > 1 )
+        License.find_by_name "multiple licenses: #{(licenses).map(&:name).uniq.join(', ')}"
+      else
+        licenses.first
+      end
+    end
+
+    def licenses_from_spec
+      license_names_from_spec.map do |name|
+        License.find_by_name(name)
+      end
+    end
+
+    def licenses_from_files
       license_files.map(&:license).compact
     end
 
@@ -40,8 +56,16 @@ module LicenseFinder
       PossibleLicenseFiles.find(install_path)
     end
 
+    def multiple_licenses
+      if ( licenses_from_spec.uniq.size > 1 )
+        License.find_by_name "multiple licenses: #{(licenses_from_spec).map(&:name).uniq.join(', ')}"
+      else 
+        License.find_by_name "multiple licenses: #{(licenses_from_files).map(&:name).uniq.join(', ')}"
+      end
+    end
+
     def default_license
-      "other"
+      License.find_by_name nil
     end
   end
 end

data/lib/license_finder/package_managers/bower.rb

@@ -14,13 +14,13 @@ module LicenseFinder
     end
 
     def self.active?
-      File.exists?(package_path)
+      package_path.exist?
     end
 
     private
 
     def self.package_path
-      Pathname.new('bower.json').expand_path
+      Pathname.new('bower.json')
     end
   end
 end

data/lib/license_finder/package_managers/bower_package.rb

@@ -42,8 +42,8 @@ module LicenseFinder
       bower_module["canonicalDir"]
     end
 
-    def licenses_from_spec
-      Package.extract_licenses_from_standard_spec(module_metadata)
+    def license_names_from_spec
+      Package.license_names_from_standard_spec(module_metadata)
     end
   end
 end

data/lib/license_finder/package_managers/bundler.rb

@@ -2,15 +2,13 @@ require "bundler"
 
 module LicenseFinder
   class Bundler
-    attr_writer :ignore_groups
-
     class << self
-      def current_packages(config = LicenseFinder.config, bundler_definition=nil)
-        new(config, bundler_definition).packages
+      def current_packages(ignore_groups = LicenseFinder.config.ignore_groups, bundler_definition=nil)
+        new(ignore_groups, bundler_definition).packages
       end
 
       def active?
-        File.exists?(gemfile_path)
+        gemfile_path.exist?
       end
 
       def gemfile_path
@@ -18,17 +16,15 @@ module LicenseFinder
       end
     end
 
-    def initialize(config, bundler_definition=nil)
+    def initialize(ignore_groups, bundler_definition=nil)
       @definition = bundler_definition || ::Bundler::Definition.build(self.class.gemfile_path, lockfile_path, nil)
-      @config = config
+      @ignore_groups = ignore_groups
     end
 
     def packages
-      return @packages if @packages
-
       top_level_gems = Set.new
 
-      @packages ||= definition.specs_for(included_groups).map do |gem_def|
+      packages = definition.specs_for(included_groups).map do |gem_def|
         bundler_def = bundler_defs.detect { |bundler_def| bundler_def.name == gem_def.name }
 
         top_level_gems << format_name(gem_def)
@@ -36,19 +32,15 @@ module LicenseFinder
         BundlerPackage.new(gem_def, bundler_def)
       end
 
-      @packages.each do |gem|
+      packages.each do |gem|
         gem.children = children_for(gem, top_level_gems)
       end
 
-      @packages
+      packages
     end
 
     private
-    attr_reader :definition
-
-    def ignore_groups
-      @ignore_groups ||= @config.ignore_groups
-    end
+    attr_reader :definition, :ignore_groups
 
     def bundler_defs
       @bundler_defs ||= definition.dependencies

data/lib/license_finder/package_managers/bundler_package.rb

@@ -26,7 +26,7 @@ module LicenseFinder
       gem_def.full_gem_path
     end
 
-    def licenses_from_spec
+    def license_names_from_spec
       gem_def.licenses
     end
   end