license_finder 1.0.0.0-java → 1.1.1-java

data/{files/license_finder.yml → lib/data/license_finder.example.yml}

@@ -5,5 +5,8 @@ whitelist:
 ignore_groups:
 #- test
 #- development
+ignore_dependencies:
+#- bundler
 dependencies_file_dir: './doc/'
 project_name: # project name
+gradle_command: # only meaningful if used with a Java/gradle project. Defaults to "gradle".

data/lib/license_finder.rb

@@ -11,7 +11,6 @@ module LicenseFinder
   autoload :DependencyManager,    'license_finder/dependency_manager'
   autoload :PackageSaver,         'license_finder/package_saver'
   autoload :License,              'license_finder/license'
-  autoload :LicenseUrl,           'license_finder/license_url'
   autoload :PossibleLicenseFile,  'license_finder/possible_license_file'
   autoload :PossibleLicenseFiles, 'license_finder/possible_license_files'
   autoload :Configuration,        'license_finder/configuration'
@@ -23,6 +22,7 @@ module LicenseFinder
   autoload :NPM,                  'license_finder/package_managers/npm'
   autoload :Pip,                  'license_finder/package_managers/pip'
   autoload :Maven,                'license_finder/package_managers/maven'
+  autoload :CocoaPods,            'license_finder/package_managers/cocoa_pods'
   autoload :Gradle,               'license_finder/package_managers/gradle'
   autoload :BowerPackage,         'license_finder/package_managers/bower_package'
   autoload :BundlerPackage,       'license_finder/package_managers/bundler_package'
@@ -30,11 +30,12 @@ module LicenseFinder
   autoload :NpmPackage,           'license_finder/package_managers/npm_package'
   autoload :MavenPackage,         'license_finder/package_managers/maven_package'
   autoload :GradlePackage,        'license_finder/package_managers/gradle_package'
+  autoload :CocoaPodsPackage,     'license_finder/package_managers/cocoa_pods_package'
 
 
   autoload :BundlerGroup,         'license_finder/tables/bundler_group'
   autoload :Dependency,           'license_finder/tables/dependency'
-  autoload :LicenseAlias,         'license_finder/tables/license_alias'
+  autoload :ManualApproval,       'license_finder/tables/manual_approval'
   autoload :YmlToSql,             'license_finder/yml_to_sql'
 
   autoload :DependencyReport,     'license_finder/reports/dependency_report'

data/lib/license_finder/cli.rb

@@ -11,12 +11,43 @@ module LicenseFinder
 
       private
 
+      def sync_with_spinner
+        die_on_error {
+          spinner {
+            DependencyManager.sync_with_package_managers
+          }
+        }
+      end
+
       def die_on_error
         yield
       rescue LicenseFinder::Error => e
         say e.message, :red
         exit 1
       end
+
+      def spinner
+        if options[:quiet]
+          yield
+        else
+          begin
+            thread = Thread.new {
+              wheel = '\|/-'
+              i = 0
+              while true do
+                print "\r ---------- #{wheel[i]} ----------"
+                i = (i + 1) % 4
+              end
+            }
+            yield
+          ensure
+            if thread
+              thread.kill
+              puts "\r" + " "*24
+            end
+          end
+        end
+      end
     end
 
     # Thor fix for `license_finder <subcommand> help <action>`
@@ -40,11 +71,13 @@ module LicenseFinder
 
     class Dependencies < Subcommand
       method_option :approve, type: :boolean, desc: "Approve the added dependency"
-      desc "add LICENSE DEPENDENCY_NAME [VERSION] [--approve]", "Add a dependency that is not managed by Bundler, NPM, etc"
+      method_option :approver, desc: "The person granting the approval"
+      method_option :message, desc: "The reason for the approval"
+      desc "add LICENSE DEPENDENCY_NAME [VERSION] [--approve] [--approver APPROVER_NAME] [--message APPROVAL_MESSAGE]", "Add a dependency that is not managed by a package manager, optionally storing who approved the dependency and why"
       def add(license, name, version = nil)
         die_on_error {
-          DependencyManager.create_manually_managed(license, name, version)
-          DependencyManager.approve!(name) if options[:approve]
+          DependencyManager.manually_add(license, name, version)
+          DependencyManager.approve!(name, options[:approver], options[:message]) if options[:approve]
         }
         if options[:approve]
           say "The #{name} dependency has been added and approved!", :green
@@ -53,10 +86,10 @@ module LicenseFinder
         end
       end
 
-      desc "remove DEPENDENCY_NAME", "Remove a dependency that is not managed by Bundler, NPM, etc"
+      desc "remove DEPENDENCY_NAME", "Remove a dependency that is not managed by a package manager"
       def remove(name)
         die_on_error {
-          DependencyManager.destroy_manually_managed(name)
+          DependencyManager.manually_remove(name)
         }
 
         say "The #{name} dependency has been removed.", :green
@@ -71,7 +104,7 @@ module LicenseFinder
           yield
 
           LicenseFinder.config.save
-          Reporter.write_reports
+          sync_with_spinner
         }
       end
     end
@@ -88,7 +121,8 @@ module LicenseFinder
       end
 
       desc "add LICENSE...", "Add one or more licenses to the whitelist"
-      def add(*licenses)
+      def add(license, *other_licenses)
+        licenses = other_licenses.unshift license
         modifying {
           licenses.each do |license|
             LicenseFinder.config.whitelist.push(license)
@@ -98,7 +132,8 @@ module LicenseFinder
       end
 
       desc "remove LICENSE...", "Remove one or more licenses from the whitelist"
-      def remove(*licenses)
+      def remove(license, *other_licenses)
+        licenses = other_licenses.unshift license
         modifying {
           licenses.each do |license|
             LicenseFinder.config.whitelist.delete(license)
@@ -146,31 +181,64 @@ module LicenseFinder
       end
     end
 
+    class IgnoredDependencies < ConfigSubcommand
+      desc "list", "List all the ignored dependencies"
+      def list
+        ignored = LicenseFinder.config.ignore_dependencies
+
+        say "Ignored Dependencies:", :blue
+        if ignored.any?
+          ignored.each do |group|
+            say group
+          end
+        else
+          say '(none)'
+        end
+      end
+
+      desc "add DEPENDENCY", "Add a dependency to be ignored"
+      def add(group)
+        modifying {
+          LicenseFinder.config.ignore_dependencies.push(group)
+        }
+        say "Added #{group} to the ignored dependencies"
+      end
+
+      desc "remove DEPENDENCY", "Remove a dependency from the ignored dependencies"
+      def remove(group)
+        modifying {
+          LicenseFinder.config.ignore_dependencies.delete(group)
+        }
+        say "Removed #{group} from the ignored dependencies"
+      end
+    end
+
     class Main < Base
       method_option :quiet, type: :boolean, desc: "silences loading output"
       desc "rescan", "Find new dependencies. (Default action)"
       def rescan
-        die_on_error {
-          spinner {
-            DependencyManager.sync_with_package_managers
-          }
-        }
+        sync_with_spinner
+        show_results
+      end
 
+      desc "show_results", "Display ignored dependencies and action items"
+      def show_results
+        IgnoredDependencies.new.list
         action_items
       end
+
       default_task :rescan
 
-      desc "approve DEPENDENCY_NAME...", "Approve one or more dependencies by name"
-      def approve(*names)
-        if(names.count < 1)
-          say "Warning: Must specify dependencies to approve.", :red
-        else
-          die_on_error {
-            names.each { |name| DependencyManager.approve!(name) }
-          }
+      method_option :approver, desc: "The person granting the approval"
+      method_option :message, desc: "The reason for the approval"
+      desc "approve DEPENDENCY_NAME... [--approver APPROVER_NAME] [--message APPROVAL_MESSAGE]", "Approve one or more dependencies by name, optionally storing who approved the dependency and why"
+      def approve(name, *other_names)
+        names = other_names.unshift name
+        die_on_error {
+          names.each { |name| DependencyManager.approve!(name, options[:approver], options[:message]) }
+        }
 
-          say "The #{names.join(", ")} dependency has been approved!", :green
-        end
+        say "The #{names.join(", ")} dependency has been approved!", :green
       end
 
       desc "license LICENSE DEPENDENCY_NAME", "Update a dependency's license"
@@ -201,35 +269,12 @@ module LicenseFinder
         end
       end
 
-      subcommand "dependencies", Dependencies, "Manually manage dependencies outside of Bundler, NPM, pip, etc"
-      subcommand "ignored_bundler_groups", IgnoredBundlerGroups, "Manage ignored bundler groups"
+      subcommand "dependencies", Dependencies, "Manually manage dependencies that your package managers are not aware of"
+      subcommand "ignored_bundler_groups", IgnoredBundlerGroups, "Manage ignored Bundler groups"
+      subcommand "ignored_dependencies", IgnoredDependencies, "Manage ignored dependencies"
       subcommand "whitelist", Whitelist, "Manage whitelisted licenses"
       subcommand "project_name", ProjectName, "Manage the project name"
 
-      private
-
-      def spinner
-        if options[:quiet]
-          yield
-        else
-          begin
-            thread = Thread.new {
-              wheel = '\|/-'
-              i = 0
-              while true do
-                print "\r ---------- #{wheel[i]} ----------"
-                i = (i + 1) % 4
-              end
-            }
-            yield
-          ensure
-            if thread
-              thread.kill
-              puts "\r" + " "*24
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/license_finder/configuration.rb

@@ -7,6 +7,10 @@ module LicenseFinder
       prepare(Persistence.get)
     end
 
+    def last_modified
+      Persistence.last_modified
+    end
+
     def self.move!
       config = prepare(Persistence.get.merge('dependencies_file_dir' => './doc/'))
       config.save
@@ -24,18 +28,15 @@ module LicenseFinder
       result
     end
 
-    attr_accessor :whitelist, :ignore_groups, :artifacts, :project_name
+    attr_accessor :whitelist, :ignore_groups, :ignore_dependencies, :artifacts, :project_name, :gradle_command
 
     def initialize(config)
       @whitelist     = Array(config['whitelist'])
       @ignore_groups = Array(config["ignore_groups"])
+      @ignore_dependencies = Array(config["ignore_dependencies"])
       @artifacts     = Artifacts.new(Pathname(config['dependencies_file_dir'] || './doc/'))
       @project_name  = config['project_name'] || determine_project_name
-    end
-
-    def whitelisted?(license_name)
-      license = License.find_by_name(license_name)
-      whitelisted_licenses.include? license
+      @gradle_command = config['gradle_command'] || 'gradle'
     end
 
     def save
@@ -48,17 +49,13 @@ module LicenseFinder
       {
         'whitelist' => whitelist.uniq,
         'ignore_groups' => ignore_groups.uniq,
+        'ignore_dependencies' => ignore_dependencies.uniq,
         'dependencies_file_dir' => artifacts.dir.to_s,
-        'project_name' => project_name
+        'project_name' => project_name,
+        'gradle_command' => gradle_command
       }
     end
 
-    def whitelisted_licenses
-      whitelist.map do |license_name|
-        License.find_by_name(license_name) || license_name
-      end.compact
-    end
-
     def determine_project_name
       Pathname.pwd.basename.to_s
     end
@@ -103,6 +100,12 @@ module LicenseFinder
       def legacy_text_file
         join("dependencies.txt")
       end
+
+      def last_refreshed
+        [database_file, text_file, detailed_text_file, html_file, markdown_file].map do |path|
+          File.mtime(path)
+        end.min
+      end
     end
 
     module Persistence
@@ -122,6 +125,10 @@ module LicenseFinder
         file.open('w') { |f| f.write(YAML.dump(hash)) }
       end
 
+      def last_modified
+        File.mtime(file)
+      end
+
       private
 
       def inited?
@@ -142,7 +149,7 @@ module LicenseFinder
       end
 
       def file_template
-        ROOT_PATH.join('..', 'files', 'license_finder.yml')
+        ROOT_PATH.join('data', 'license_finder.example.yml')
       end
     end
   end

data/lib/license_finder/dependency_manager.rb

@@ -6,42 +6,41 @@ module LicenseFinder
       modifying {
         current_dependencies = PackageSaver.save_all(current_packages)
 
-        Dependency.managed.obsolete(current_dependencies).each(&:destroy)
+        Dependency.added_automatically.obsolete(current_dependencies).each(&:destroy)
       }
     end
 
-    def self.create_manually_managed(license, name, version)
+    def self.manually_add(license, name, version)
       raise Error.new("#{name} dependency already exists") unless Dependency.where(name: name).empty?
 
       modifying {
-        dependency = Dependency.new(manual: true, name: name, version: version)
-        dependency.license = LicenseAlias.named(license)
+        dependency = Dependency.new(added_manually: true, name: name, version: version)
+        dependency.license = License.find_by_name(license)
         dependency.save
       }
     end
 
-    def self.destroy_manually_managed(name)
-      modifying { find_by_name(name, Dependency.manually_managed).destroy }
+    def self.manually_remove(name)
+      modifying { find_by_name(name, Dependency.added_manually).destroy }
     end
 
-    def self.license!(name, license)
+    def self.license!(name, license_name)
+      license = License.find_by_name(license_name)
       modifying { find_by_name(name).set_license_manually!(license) }
     end
 
-    def self.approve!(name)
-      modifying { find_by_name(name).approve!  }
+    def self.approve!(name, approver = nil, notes = nil)
+      modifying { find_by_name(name).approve!(approver, notes)  }
     end
 
     def self.modifying
-      database_file = LicenseFinder.config.artifacts.database_file
-      checksum_before_modifying = checksum(database_file)
-      result = yield
-      checksum_after_modifying = checksum(database_file)
+      checksum_before = checksum
+      result = DB.transaction { yield }
+      checksum_after = checksum
 
-      unless checksum_after_modifying == checksum_before_modifying
-        Reporter.write_reports
-      end
-      unless LicenseFinder.config.artifacts.html_file.exist?
+      database_changed = checksum_before != checksum_after
+
+      if database_changed || reports_do_not_exist || reports_are_stale
         Reporter.write_reports
       end
 
@@ -50,12 +49,20 @@ module LicenseFinder
 
     private # not really private, but it looks like it is!
 
+    def self.reports_do_not_exist
+      !(LicenseFinder.config.artifacts.html_file.exist?)
+    end
+
+    def self.reports_are_stale
+      LicenseFinder.config.last_modified > LicenseFinder.config.artifacts.last_refreshed
+    end
+
     def self.current_packages
       package_managers.select(&:active?).map(&:current_packages).flatten
     end
 
     def self.package_managers
-      [Bundler, NPM, Pip, Bower, Maven, Gradle]
+      [Bundler, NPM, Pip, Bower, Maven, Gradle, CocoaPods]
     end
 
     def self.find_by_name(name, scope = Dependency)
@@ -64,7 +71,8 @@ module LicenseFinder
       dep
     end
 
-    def self.checksum(database_file)
+    def self.checksum
+      database_file = LicenseFinder.config.artifacts.database_file
       if database_file.exist?
         Digest::SHA2.file(database_file).hexdigest
       end

data/lib/license_finder/license.rb

@@ -2,34 +2,42 @@ module LicenseFinder
   class License
     class << self
       def all
-        @all ||= []
+        @all ||= Definitions.all(LicenseFinder.config.whitelist)
       end
 
       def find_by_name(name)
-        all.detect { |l| l.matches_name? name } || UnknownLicense.new(name)
+        name ||= "other"
+        all.detect { |l| l.matches_name? name } || Definitions.build_unrecognized(name, LicenseFinder.config.whitelist)
       end
 
       def find_by_text(text)
-        all.detect { |l| l.matches_text? text } || UnknownLicense.new
+        all.detect { |l| l.matches_text? text }
       end
     end
 
+    autoload :Definitions,   "license_finder/license/definitions"
     autoload :Text,          "license_finder/license/text"
     autoload :Template,      "license_finder/license/template"
     autoload :Matcher,       "license_finder/license/matcher"
     autoload :HeaderMatcher, "license_finder/license/header_matcher"
     autoload :AnyMatcher,    "license_finder/license/any_matcher"
-
-    attr_reader :url, :pretty_name
+    autoload :NoneMatcher,   "license_finder/license/none_matcher"
 
     def initialize(settings)
       @short_name  = settings.fetch(:short_name)
       @pretty_name = settings.fetch(:pretty_name, short_name)
       @other_names = settings.fetch(:other_names, [])
       @url         = settings.fetch(:url)
+      @whitelisted = settings.fetch(:whitelisted, false)
       @matcher     = settings.fetch(:matcher) { Matcher.from_template(Template.named(short_name)) }
     end
 
+    attr_reader :url
+
+    def name
+      pretty_name
+    end
+
     def matches_name?(name)
       names.map(&:downcase).include? name.to_s.downcase
     end
@@ -38,27 +46,33 @@ module LicenseFinder
       matcher.matches_text?(text)
     end
 
+    def whitelisted?
+      @whitelisted
+    end
+
+    def whitelist
+      copy(whitelisted: true)
+    end
+
     private
 
-    attr_reader :short_name, :other_names, :matcher
+    attr_reader :short_name, :pretty_name, :other_names
+    attr_reader :matcher
 
     def names
       ([short_name, pretty_name] + other_names).uniq
     end
-  end
-
-  class UnknownLicense
-    attr_reader :pretty_name
-
-    def initialize(name = nil)
-      @pretty_name = name
-    end
-    def url; end
 
-    def ==(other)
-      pretty_name.eql?(other.pretty_name)
+    def copy(overrides)
+      settings = {
+        short_name:  short_name,
+        pretty_name: pretty_name,
+        other_names: other_names,
+        url:         url,
+        whitelisted: whitelisted?,
+        matcher:     matcher
+      }
+      self.class.new(settings.merge(overrides))
     end
   end
 end
-
-require LicenseFinder::ROOT_PATH.join("license_finder", "license", "definitions.rb")