license_finder 0.7.3 → 0.8.0

data/features/text_report.feature

@@ -9,7 +9,7 @@ Feature: Text Report
       | license | version |
       | MIT     | 1.1.1   |
     When I run "license_finder"
-    Then I should see the file "dependencies.txt" containing:
+    Then I should see the file "doc/dependencies.txt" containing:
       """
       descriptive_gem, 1.1.1, MIT
       """
@@ -21,7 +21,7 @@ Feature: Text Report
       | MIT     | 1.1.1   |
     When I run "license_finder"
     And I run "license_finder"
-    Then I should see the file "dependencies.txt" containing:
+    Then I should see the file "doc/dependencies.txt" containing:
       """
       descriptive_gem, 1.1.1, MIT
       """

data/files/license_finder.yml

@@ -5,4 +5,4 @@ whitelist:
 ignore_groups:
 #- test
 #- development
-dependencies_file_dir: './'
+dependencies_file_dir: './doc/'

data/lib/license_finder.rb

@@ -6,17 +6,15 @@ module LicenseFinder
   ROOT_PATH = Pathname.new(__FILE__).dirname
 
   DEPENDENCY_ATTRIBUTES = [
-    "name", "source", "version", "license", "license_url", "approved", "notes",
+    "name", "version", "license", "license_url", "approved", "notes",
     "license_files", "bundler_groups", "summary",
-    "description", "homepage", "children", "parents"
+    "description", "homepage", "children", "parents", "manual"
   ]
 
   autoload :Bundle, 'license_finder/bundle'
   autoload :BundledGem, 'license_finder/bundled_gem'
   autoload :CLI, 'license_finder/cli'
   autoload :Configuration, 'license_finder/configuration'
-  autoload :Persistence, 'license_finder/persistence/yaml'
-  autoload :Dependency, 'license_finder/dependency'
   autoload :License, 'license_finder/license'
   autoload :LicenseUrl, 'license_finder/license_url'
   autoload :PossibleLicenseFile, 'license_finder/possible_license_file'
@@ -25,10 +23,17 @@ module LicenseFinder
   autoload :TextReport, 'license_finder/text_report'
   autoload :Reporter, 'license_finder/reporter'
   autoload :BundleSyncer, 'license_finder/bundle_syncer'
-  autoload :SourceSyncer, 'license_finder/source_syncer'
+  autoload :YmlToSql, 'license_finder/yml_to_sql'
+  autoload :Dependency, 'license_finder/tables/dependency'
+  autoload :Approval, 'license_finder/tables/approval'
+  autoload :LicenseAlias, 'license_finder/tables/license_alias'
+  autoload :BundlerGroup, 'license_finder/tables/bundler_group'
+  autoload :GemSaver, 'license_finder/gem_saver'
+  autoload :LicenseFiles, 'license_finder/license_files'
+  autoload :Platform, 'license_finder/platform'
 
   def self.config
-    @config ||= Configuration.new
+    @config ||= Configuration.ensure_default
   end
 
   def self.load_rake_tasks
@@ -37,3 +42,6 @@ module LicenseFinder
 end
 
 require 'license_finder/railtie' if defined?(Rails)
+require 'license_finder/tables'
+
+LicenseFinder::YmlToSql.convert_if_required

data/lib/license_finder/bundle.rb

@@ -2,6 +2,10 @@ module LicenseFinder
   class Bundle
     attr_writer :ignore_groups
 
+    def self.current_gem_dependencies(bundler_definition=nil)
+      new(bundler_definition).gems.map(&:save_or_merge)
+    end
+
     def initialize(bundler_definition=nil)
       @definition = bundler_definition || Bundler::Definition.build(gemfile_path, lockfile_path, nil)
     end
@@ -15,8 +19,6 @@ module LicenseFinder
         BundledGem.new(spec, dependency)
       end
 
-      setup_parent_child_relationships
-
       @gems
     end
 
@@ -27,21 +29,6 @@ module LicenseFinder
       @ignore_groups ||= LicenseFinder.config.ignore_groups
     end
 
-    def setup_parent_child_relationships
-      dependency_index = {}
-
-      gems.each do |dep|
-        dependency_index[dep.dependency_name] = dep
-      end
-
-      gems.each do |dep|
-        dep.children.each do |child_dep|
-          license_finder_dependency = dependency_index[child_dep]
-          license_finder_dependency.parents << dep.dependency_name if license_finder_dependency
-        end
-      end
-    end
-
     def dependencies
       @dependencies ||= definition.dependencies
     end

data/lib/license_finder/bundle_syncer.rb

@@ -3,9 +3,8 @@ module LicenseFinder
     extend self
 
     def sync!
-      source_dependencies = Bundle.new.gems.map(&:to_dependency)
-      target_dependencies = Dependency.all.select {|d| d.source == "bundle" }
-      SourceSyncer.new(source_dependencies, target_dependencies).sync!
+      current_dependencies = Bundle.current_gem_dependencies
+      Dependency.destroy_obsolete(current_dependencies)
     end
   end
 end

data/lib/license_finder/bundled_gem.rb

@@ -1,8 +1,6 @@
 module LicenseFinder
   class BundledGem
-    LICENSE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
-
-    attr_reader :parents
+    attr_reader :parents, :spec, :bundler_dependency
 
     def initialize(spec, bundler_dependency = nil)
       @spec = spec
@@ -29,22 +27,6 @@ module LicenseFinder
       @children ||= @spec.dependencies.collect(&:name)
     end
 
-    def to_dependency
-      @dependency ||= LicenseFinder::Dependency.new(
-        'name' => @spec.name,
-        'version' => @spec.version.to_s,
-        'license' => determine_license,
-        'license_files' => license_files.map(&:file_path),
-        'source' => 'bundle',
-        'bundler_groups' => (@bundler_dependency.groups if @bundler_dependency),
-        'summary' => @spec.summary,
-        'description' => @spec.description,
-        'homepage' => @spec.homepage,
-        'children' => children,
-        'parents'  => parents
-      )
-    end
-
     def determine_license
       return @spec.license if @spec.license
 
@@ -52,40 +34,15 @@ module LicenseFinder
     end
 
     def license_files
-      paths_with_license_names = find_matching_files(LICENSE_FILE_NAMES)
-      paths_for_license_files = paths_with_license_names.map do |path|
-        File.directory?(path) ? paths_for_files_in_license_directory(path) : path
-      end.flatten.uniq
-      get_files_for_paths(paths_for_license_files)
-    end
-
-    def install_path
-      @spec.full_gem_path
+      LicenseFiles.new(@spec.full_gem_path).files
     end
 
     def sort_order
       dependency_name.downcase
     end
 
-    private
-
-    def find_matching_files(names)
-      Dir.glob(File.join(install_path, '**', "*{#{names.join(',')}}*"))
-    end
-
-    def get_file_for_path(path)
-      PossibleLicenseFile.new(install_path, path)
-    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_files_for_paths(paths_for_license_files)
-      paths_for_license_files.map do |path|
-        get_file_for_path(path)
-      end
+    def save_or_merge
+      GemSaver.find_or_initialize_by_name(@spec.name, self).save
     end
   end
 end

data/lib/license_finder/cli.rb

@@ -2,13 +2,16 @@ module LicenseFinder
   module CLI
     extend self
 
+    @@run_complete = false
+
     def check_for_action_items
-      create_default_configuration
       BundleSyncer.sync!
+      @@run_complete = true
       generate_reports
 
       unapproved = Dependency.unapproved
 
+      puts "\r" + " "*24
       if unapproved.count == 0
         puts "All gems are approved for use"
       else
@@ -19,18 +22,18 @@ module LicenseFinder
     end
 
     def execute!(options={})
-      create_default_configuration
-
       if options.empty?
         check_for_action_items
       else
-        dependency = Dependency.find_by_name(options[:dependency])
+        dependency = Dependency.first(name: options[:dependency])
 
+        @@run_complete = true
+        puts "\r" + " "*24
         if options[:approve]
           dependency.approve!
           puts "The #{dependency.name} has been approved!\n\n"
         elsif options[:license]
-          dependency.update_attributes :license => options[:license]
+          dependency.set_license_manually options[:license]
           puts "The #{dependency.name} has been marked as using #{options[:license]} license!\n\n"
         end
 
@@ -40,17 +43,7 @@ module LicenseFinder
 
     private
     def generate_reports
-      LicenseFinder::Reporter.write_reports
-    end
-
-    def create_default_configuration
-      unless File.exists?(LicenseFinder.config.config_file_path)
-        FileUtils.mkdir_p(File.join('.', 'config'))
-        FileUtils.cp(
-          File.join(File.dirname(__FILE__), '..', '..', 'files', 'license_finder.yml'),
-          LicenseFinder.config.config_file_path
-        )
-      end
+      Reporter.write_reports
     end
   end
 end

data/lib/license_finder/configuration.rb

@@ -1,7 +1,58 @@
 module LicenseFinder
-  class Configuration < LicenseFinder::Persistence::Configuration
+  class Configuration
+    attr_accessor :whitelist, :ignore_groups, :dependencies_dir
+
+    def self.config_file_path
+      File.join('.', 'config', 'license_finder.yml')
+    end
+
+    def self.ensure_default
+      make_config_file unless File.exists?(config_file_path)
+      new
+    end
+
+    def self.make_config_file
+      FileUtils.mkdir_p(File.join('.', 'config'))
+      FileUtils.cp(
+        File.join(File.dirname(__FILE__), '..', '..', 'files', 'license_finder.yml'),
+        config_file_path
+      )
+    end
+
+    def initialize(config={})
+      if File.exists?(config_file_path)
+        yaml = File.read(config_file_path)
+        config = YAML.load(yaml).merge config
+      end
+
+      @whitelist = config['whitelist'] || []
+      @ignore_groups = (config["ignore_groups"] || []).map(&:to_sym)
+      @dependencies_dir = config['dependencies_file_dir'] || './doc/'
+      FileUtils.mkdir_p(@dependencies_dir)
+    end
+
+    def config_file_path
+      self.class.config_file_path
+    end
+
+    def database_path
+      File.expand_path(File.join(dependencies_dir, "dependencies.db"))
+    end
+
+    def dependencies_yaml
+      File.join(dependencies_dir, "dependencies.yml")
+    end
+
+    def dependencies_text
+      File.join(dependencies_dir, "dependencies.txt")
+    end
+
+    def dependencies_html
+      File.join(dependencies_dir, "dependencies.html")
+    end
+
     def ignore_groups
-      super.map &:to_sym
+      @ignore_groups.map &:to_sym
     end
 
     def whitelisted?(license_name)
@@ -10,9 +61,10 @@ module LicenseFinder
     end
 
     private
+
     def whitelisted_licenses
       whitelist.map do |license_name|
-        LicenseFinder::License.find_by_name(license_name) || license_name
+        License.find_by_name(license_name) || license_name
       end.compact
     end
   end

data/lib/license_finder/dependency_report.rb

@@ -16,7 +16,7 @@ module LicenseFinder
 
     def to_s
       filename = File.join(File.dirname(__FILE__), '..', 'templates', "#{self.class.underscored_name}.erb")
-      template = ERB.new(File.read(filename))
+      template = ERB.new(File.read(filename), 0, '-')
       template.result(binding)
     end
 

data/lib/license_finder/gem_saver.rb

@@ -0,0 +1,69 @@
+module LicenseFinder
+  class GemSaver
+    extend Forwardable
+    def_delegators :spec, :name, :version, :summary, :description, :homepage
+    def_delegators :bundled_gem, :bundler_dependency, :determine_license, :children
+
+    def self.find_or_initialize_by_name(name, bundled_gem)
+      dependency = Dependency.find_or_create(name: name) do |d|
+        d.approval = Approval.create
+      end
+      new(dependency, bundled_gem)
+    end
+
+    def initialize(dependency, bundled_gem)
+      @bundled_gem = bundled_gem
+      @dependency = dependency
+    end
+
+    def save
+      DB.transaction do
+        apply_dependency_definition
+        refresh_bundler_groups
+        refresh_children
+        apply_better_license
+      end
+      dependency
+    end
+
+    private
+
+    attr_reader :dependency, :bundled_gem
+
+    def spec
+      bundled_gem.spec
+    end
+
+    def apply_dependency_definition
+      dependency.version = version.to_s
+      dependency.summary = summary
+      dependency.description = description
+      dependency.homepage = homepage
+      dependency.license ||= LicenseAlias.create(name: determine_license)
+      dependency.save
+    end
+
+    def refresh_bundler_groups
+      dependency.remove_all_bundler_groups
+      if bundler_dependency
+        bundler_dependency.groups.each { |group|
+          dependency.add_bundler_group BundlerGroup.find_or_create(name: group.to_s)
+        }
+      end
+    end
+
+    def refresh_children
+      dependency.remove_all_children
+      children.each do |child|
+        dependency.add_child Dependency.find_or_create(name: child.to_s)
+      end
+    end
+
+    def apply_better_license
+      if dependency.license && !dependency.license.manual && determine_license != 'other'
+        dependency.license.name = determine_license
+        dependency.license.save
+      end
+    end
+  end
+end

data/lib/license_finder/html_report.rb

@@ -4,11 +4,11 @@ module LicenseFinder
   class HtmlReport < DependencyReport
     private
     def unapproved_dependencies
-      dependencies.reject(&:approved)
+      dependencies.reject(&:approved?)
     end
 
     def grouped_dependencies
-      dependencies.group_by(&:license).sort_by { |_, group| group.size }.reverse
+      dependencies.group_by {|dep| dep.license.name }.sort_by { |_, group| group.size }.reverse
     end
   end
 end

data/lib/license_finder/license.rb

@@ -1,84 +1,86 @@
-module LicenseFinder::License
-  class << self
-    def all
-      @all ||= []
-    end
+module LicenseFinder
+  module License
+    class << self
+      def all
+        @all ||= []
+      end
 
-    def find_by_name(license_name)
-      all.detect { |l| l.names.map(&:downcase).include? license_name.to_s.downcase }
+      def find_by_name(license_name)
+        all.detect { |l| l.names.map(&:downcase).include? license_name.to_s.downcase }
+      end
     end
-  end
 
-  class Text
-    def initialize(text)
-      @text = normalized(text)
-    end
+    class Text
+      def initialize(text)
+        @text = normalized(text)
+      end
 
-    def to_s
-      @text
-    end
+      def to_s
+        @text
+      end
 
-    private
+      private
 
-    def normalized(text)
-      text.gsub(/\s+/, ' ').gsub(/['`"]{1,2}/, "\"")
+      def normalized(text)
+        text.gsub(/\s+/, ' ').gsub(/['`"]{1,2}/, "\"")
+      end
     end
-  end
 
-  class Base
-    class << self
-      attr_accessor :license_url, :alternative_names
+    class Base
+      class << self
+        attr_accessor :license_url, :alternative_names
 
-      def inherited(descendant)
-        LicenseFinder::License.all << descendant
-      end
+        def inherited(descendant)
+          License.all << descendant
+        end
 
-      def names
-        ([demodulized_name, pretty_name] + self.alternative_names).uniq
-      end
+        def names
+          ([demodulized_name, pretty_name] + self.alternative_names).uniq
+        end
 
-      def alternative_names
-        @alternative_names ||= []
-      end
+        def alternative_names
+          @alternative_names ||= []
+        end
 
-      def demodulized_name
-        name.gsub(/^.*::/, '')
-      end
+        def demodulized_name
+          name.gsub(/^.*::/, '')
+        end
 
-      def slug
-        demodulized_name.downcase
-      end
+        def slug
+          demodulized_name.downcase
+        end
 
-      def pretty_name
-        demodulized_name
-      end
+        def pretty_name
+          demodulized_name
+        end
 
-      def license_text
-        unless defined?(@license_text)
-          template = File.join(LicenseFinder::ROOT_PATH, "data", "licenses", "#{demodulized_name}.txt").to_s
+        def license_text
+          unless defined?(@license_text)
+            template = File.join(ROOT_PATH, "data", "licenses", "#{demodulized_name}.txt").to_s
 
-          @license_text = Text.new(File.read(template)).to_s if File.exists?(template)
+            @license_text = Text.new(File.read(template)).to_s if File.exists?(template)
+          end
+          @license_text
         end
-        @license_text
-      end
 
-      def license_regex
-        /#{Regexp.escape(license_text).gsub(/<[^<>]+>/, '(.*)')}/ if license_text
+        def license_regex
+          /#{Regexp.escape(license_text).gsub(/<[^<>]+>/, '(.*)')}/ if license_text
+        end
       end
-    end
 
-    def initialize(text)
-      self.text = text
-    end
+      def initialize(text)
+        self.text = text
+      end
 
-    attr_reader :text
+      attr_reader :text
 
-    def text=(text)
-      @text = Text.new(text).to_s
-    end
+      def text=(text)
+        @text = Text.new(text).to_s
+      end
 
-    def matches?
-      !!(text =~ self.class.license_regex if self.class.license_regex)
+      def matches?
+        !!(text =~ self.class.license_regex if self.class.license_regex)
+      end
     end
   end
 end