license_finder 1.0.0.0-java → 1.1.1-java

data/lib/license_finder/package_managers/cocoa_pods.rb

@@ -0,0 +1,35 @@
+require "json"
+
+module LicenseFinder
+  class CocoaPods
+
+    def self.current_packages
+      podfile = YAML.load_file(lockfile_path)
+
+      acknowledgements = JSON.parse(`plutil -convert json -o - #{Pathname.new('Pods/Pods-acknowledgements.plist').expand_path}`)["PreferenceSpecifiers"]
+
+      podfile["PODS"].map do |pod|
+        pod = pod.keys.first if pod.is_a?(Hash)
+
+        pod_name, pod_version = pod.scan(/(.*)\s\((.*)\)/).flatten
+        pod_acknowledgment = acknowledgements.detect { |hash| hash["Title"] == pod_name } || {}
+        CocoaPodsPackage.new(pod_name, pod_version, pod_acknowledgment["FooterText"])
+      end
+    end
+
+    def self.active?
+      package_path.exist?
+    end
+
+    private
+
+    def self.package_path
+      Pathname.new("Podfile")
+    end
+
+    def self.lockfile_path
+      Pathname.new("Podfile.lock")
+    end
+
+  end
+end

data/lib/license_finder/package_managers/cocoa_pods_package.rb

@@ -0,0 +1,19 @@
+module LicenseFinder
+  class CocoaPodsPackage < Package
+    attr_reader :name, :version
+    attr_reader :summary, :description, :homepage
+
+    def initialize(name, version, license_text)
+      @name = name
+      @version = version
+      @license_text = license_text
+    end
+
+    def groups; []; end
+    def children; []; end
+
+    def license
+      License.find_by_text(@license_text.to_s) || default_license
+    end
+  end
+end

data/lib/license_finder/package_managers/gradle.rb

@@ -3,27 +3,31 @@ require "xmlsimple"
 module LicenseFinder
   class Gradle
     def self.current_packages
-      `gradle downloadLicenses`
+      `#{LicenseFinder.config.gradle_command} downloadLicenses`
 
-      xml = File.read('build/reports/license/dependency-license.xml')
+      xml = license_report.read
 
       options = {
         'GroupTags' => { 'dependencies' => 'dependency' }
       }
-      XmlSimple.xml_in(xml, options)["dependency"].map do |d|
+      XmlSimple.xml_in(xml, options).fetch('dependency', []).map do |d|
         d["license"].reject! { |l| l["name"] == "No license found" }
         GradlePackage.new(d)
       end
     end
 
     def self.active?
-      File.exists?(package_path)
+      package_path.exist?
     end
 
     private
 
+    def self.license_report
+      Pathname.new('build/reports/license/dependency-license.xml')
+    end
+
     def self.package_path
-      Pathname.new('build.gradle').expand_path
+      Pathname.new('build.gradle')
     end
   end
 end

data/lib/license_finder/package_managers/gradle_package.rb

@@ -28,13 +28,13 @@ module LicenseFinder
       []
     end
 
-    def license_from_files
+    private
+
+    def licenses_from_files
       []
     end
 
-    private
-
-    def licenses_from_spec
+    def license_names_from_spec
       @gradle_dependency["license"].map { |l| l["name"] }
     end
   end

data/lib/license_finder/package_managers/maven.rb

@@ -5,7 +5,7 @@ module LicenseFinder
     def self.current_packages
       `mvn license:download-licenses`
 
-      xml = File.read('target/generated-resources/licenses.xml')
+      xml = license_report.read
 
       options = {
         'GroupTags' => { 'licenses' => 'license', 'dependencies' => 'dependency' },
@@ -19,13 +19,17 @@ module LicenseFinder
     end
 
     def self.active?
-      File.exists?(package_path)
+      package_path.exist?
     end
 
     private
 
+    def self.license_report
+      Pathname.new('target/generated-resources/licenses.xml')
+    end
+
     def self.package_path
-      Pathname.new('pom.xml').expand_path
+      Pathname.new('pom.xml')
     end
   end
 end

data/lib/license_finder/package_managers/maven_package.rb

@@ -32,14 +32,14 @@ module LicenseFinder
       []
     end
 
-    def license_from_files
-      []
-    end
-
     private
     attr_reader :mvn_dependency
 
-    def licenses_from_spec
+    def licenses_from_files
+      []
+    end
+
+    def license_names_from_spec
       mvn_dependency["licenses"].map { |l| l["name"] }
     end
   end

data/lib/license_finder/package_managers/npm.rb

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

data/lib/license_finder/package_managers/npm_package.rb

@@ -40,8 +40,8 @@ module LicenseFinder
       node_module["path"]
     end
 
-    def licenses_from_spec
-      Package.extract_licenses_from_standard_spec(node_module)
+    def license_names_from_spec
+      Package.license_names_from_standard_spec(node_module)
     end
   end
 end

data/lib/license_finder/package_managers/pip.rb

@@ -26,13 +26,13 @@ print "[" + ",".join(dists) + "]"
     end
 
     def self.active?
-      File.exists?(requirements_path)
+      requirements_path.exist?
     end
 
     private
 
     def self.requirements_path
-      Pathname.new('requirements.txt').expand_path
+      Pathname.new('requirements.txt')
     end
 
     def self.pypi_def(name, version)

data/lib/license_finder/package_managers/pip_package.rb

@@ -33,19 +33,15 @@ module LicenseFinder
 
     attr_reader :install_path, :pypi_def
 
-    def licenses_from_spec
+    def license_names_from_spec
       license = pypi_def["license"]
 
-      if pypi_def["license"] && pypi_def["license"] != "UNKNOWN"
-        return [license]
-      else
-        classifiers = pypi_def.fetch("classifiers", [])
-        classifiers.map do |c|
-          if c.start_with?("License")
-            c.gsub(/^License.*::\s*(.*)$/, '\1')
-          end
-        end.compact
-      end
+      return [license] if license && license != "UNKNOWN"
+
+      pypi_def.
+        fetch("classifiers", []).
+        select { |c| c.start_with?("License") }.
+        map { |c| c.gsub(/^License.*::\s*(.*)$/, '\1') }
     end
   end
 end

data/lib/license_finder/package_saver.rb

@@ -19,16 +19,18 @@ module LicenseFinder
     end
 
     def save
-      DB.transaction do
-        dependency.version = version.to_s
-        dependency.summary = summary
-        dependency.description = description
-        dependency.homepage = homepage
-        dependency.bundler_group_names = groups.map(&:to_s)
-        dependency.children_names = children
-        dependency.apply_better_license license
-        dependency.save_changes
-      end
+      dependency.version = version.to_s
+      dependency.summary = summary
+      dependency.description = description
+      dependency.homepage = homepage
+      dependency.bundler_group_names = groups.map(&:to_s)
+      dependency.children_names = children
+      dependency.apply_better_license license
+
+      # Only save *changed* dependencies. This ensures re-running
+      # `license_finder` won't always update the DB, and therefore won't always
+      # update the HTML/markdown reports with a new timestamp.
+      dependency.save_changes
       dependency
     end
 

data/lib/license_finder/possible_license_file.rb

@@ -16,7 +16,7 @@ module LicenseFinder
     end
 
     def license
-      License.find_by_text(text).pretty_name
+      License.find_by_text(text)
     end
   end
 end

data/lib/license_finder/possible_license_files.rb

@@ -1,18 +1,19 @@
 module LicenseFinder
   class PossibleLicenseFiles
-    LICENSE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
+    CANDIDATE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
+    CANDIDATE_PATH_WILDCARD = "*{#{CANDIDATE_FILE_NAMES.join(',')}}*"
 
     def self.find(install_path)
       new(install_path).find
     end
 
     def initialize(install_path)
-      @install_path = install_path
+      @install_path = Pathname(install_path)
     end
 
     def find
-      paths_for_license_files.map do |path|
-        get_file_for_path(path)
+      paths_of_candidate_files.map do |path|
+        file_at_path(path)
       end
     end
 
@@ -20,22 +21,17 @@ module LicenseFinder
 
     attr_reader :install_path
 
-    def paths_for_license_files
-      find_matching_files.map do |path|
-        File.directory?(path) ? paths_for_files_in_license_directory(path) : path
+    def paths_of_candidate_files
+      candidate_files_and_dirs.map do |path|
+        path.directory? ? path.children : path
       end.flatten.uniq
     end
 
-    def find_matching_files
-      Dir.glob(File.join(install_path, '**', "*{#{LICENSE_FILE_NAMES.join(',')}}*"))
+    def candidate_files_and_dirs
+      Pathname.glob(install_path.join('**', CANDIDATE_PATH_WILDCARD))
     end
 
-    def paths_for_files_in_license_directory(path)
-      entries_in_directory = Dir::entries(path).reject { |p| p.match(/^(\.){1,2}$/) }
-      entries_in_directory.map { |entry_name| File.join(path, entry_name) }
-    end
-
-    def get_file_for_path(path)
+    def file_at_path(path)
       PossibleLicenseFile.new(install_path, path)
     end
   end

data/lib/license_finder/reports/formatted_report.rb

@@ -7,15 +7,34 @@ module LicenseFinder
 
     def grouped_dependencies
       find_name = lambda do |dep|
-        license = License.find_by_name(dep.license.name)
-        if license
-          license.pretty_name
-        else
-          dep.license.name
-        end
+        dep.license.name
       end
 
       dependencies.group_by(&find_name).sort_by { |_, group| group.size }.reverse
     end
+
+    def link_to_license(license)
+      link_to_maybe license.name, license.url
+    end
+
+    def link_to_dependency(dependency)
+      link_to_maybe dependency.name, dependency.homepage
+    end
+
+    def link_to_maybe(text, link)
+      if link && !link.empty?
+        %{<a href="#{link}">#{text}</a>}
+      else
+        text
+      end
+    end
+
+    def version_groups(dependency)
+      result = "v#{dependency.version}"
+      if dependency.bundler_groups.any?
+        result += " (#{dependency.bundler_groups.map(&:name).join(", ")})"
+      end
+      result
+    end
   end
 end

data/lib/license_finder/reports/html_report.rb

@@ -1,3 +1,4 @@
 module LicenseFinder
-  class HtmlReport < FormattedReport; end
+  class HtmlReport < FormattedReport
+  end
 end

data/lib/license_finder/reports/reporter.rb

@@ -3,7 +3,7 @@ module LicenseFinder
     extend self
 
     def write_reports
-      dependencies = Dependency.all
+      dependencies = Dependency.acknowledged
       artifacts = LicenseFinder.config.artifacts
 
       write_file artifacts.text_file,          TextReport.of(dependencies)
@@ -11,8 +11,8 @@ module LicenseFinder
       write_file artifacts.html_file,          HtmlReport.of(dependencies)
       write_file artifacts.markdown_file,      MarkdownReport.of(dependencies)
 
-      if LicenseFinder.config.artifacts.legacy_text_file.exist?
-        LicenseFinder.config.artifacts.legacy_text_file.delete
+      if artifacts.legacy_text_file.exist?
+        artifacts.legacy_text_file.delete
       end
     end
 

data/lib/license_finder/tables.rb

@@ -1,7 +1,9 @@
-require 'rubygems'
 require 'sequel'
 require LicenseFinder::Platform.sqlite_load_path
 
-LicenseFinder::DB = Sequel.connect("#{LicenseFinder::Platform.sqlite_adapter}://#{LicenseFinder.config.artifacts.database_uri}")
-Sequel.extension :migration, :core_extensions
-Sequel::Migrator.run(LicenseFinder::DB, LicenseFinder::ROOT_PATH.join('../db/migrate'))
+module LicenseFinder
+  DB = Sequel.connect(Platform.sqlite_adapter + "://" + config.artifacts.database_uri)
+
+  Sequel.extension :migration, :core_extensions
+  Sequel::Migrator.run(DB, ROOT_PATH.join('../db/migrate'))
+end

data/lib/license_finder/tables/dependency.rb

@@ -1,18 +1,23 @@
 module LicenseFinder
   class Dependency < Sequel::Model
     plugin :boolean_readers
-    many_to_one :license, class: LicenseAlias
+    plugin :composition
+    composition :license,
+      composer: ->(d) { License.find_by_name(d.license_name) },
+      decomposer: ->(d) { self.license_name = license.name }
+
+    one_to_one :manual_approval
     many_to_many :children, join_table: :ancestries, left_key: :parent_dependency_id, right_key: :child_dependency_id, class: self
     many_to_many :parents, join_table: :ancestries, left_key: :child_dependency_id, right_key: :parent_dependency_id, class: self
     many_to_many :bundler_groups
 
     dataset_module do
-      def managed
-        manually_managed.invert
+      def added_automatically
+        added_manually.invert
       end
 
-      def manually_managed
-        where(manual: true)
+      def added_manually
+        where(added_manually: true)
       end
 
       def obsolete(current)
@@ -21,7 +26,14 @@ module LicenseFinder
     end
 
     def self.unapproved
-      all.reject(&:approved?)
+      acknowledged.reject(&:approved?)
+    end
+
+    def self.acknowledged
+      ignored_dependencies = LicenseFinder.config.ignore_dependencies
+      all.reject do |dependency|
+        ignored_dependencies.include? dependency.name
+      end
     end
 
     def self.named(name)
@@ -36,25 +48,33 @@ module LicenseFinder
       update_association_collection(:children, names)
     end
 
-    def approve!
-      self.manually_approved = true
+    def approve!(approver = nil, notes = nil)
+      self.manual_approval = ManualApproval.new(approver: approver, notes: notes)
       save
     end
 
     def approved?
-      (license && license.whitelisted?) || manually_approved?
+      whitelisted? || approved_manually?
+    end
+
+    def whitelisted?
+      license.whitelisted?
+    end
+
+    def approved_manually?
+      !!manual_approval
     end
 
-    def set_license_manually!(license_name)
-      self.license = LicenseAlias.named(license_name)
-      self.license_manual = true
+    def set_license_manually!(license)
+      self.license = license
+      self.license_assigned_manually = true
       save
     end
 
-    def apply_better_license(license_name)
-      return if license_manual
-      if license.nil? || license.name != license_name
-        self.license = LicenseAlias.named(license_name)
+    def apply_better_license(other_license)
+      return if license_assigned_manually?
+      if license.name != other_license.name
+        self.license = other_license
       end
     end