license_finder 0.8.0-java

data/lib/data/licenses/MIT.txt

@@ -0,0 +1,9 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.

data/lib/data/licenses/NewBSD.txt

@@ -0,0 +1,21 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * 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.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/data/licenses/Ruby.txt

@@ -0,0 +1,52 @@
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+    modifications to Usenet or an equivalent medium, or by allowing
+    the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+    together with instructions (in the manual page or equivalent)
+    on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+    the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/lib/data/licenses/SimplifiedBSD.txt

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.

data/lib/license_finder.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+require 'yaml'
+require 'erb'
+
+module LicenseFinder
+  ROOT_PATH = Pathname.new(__FILE__).dirname
+
+  DEPENDENCY_ATTRIBUTES = [
+    "name", "version", "license", "license_url", "approved", "notes",
+    "license_files", "bundler_groups", "summary",
+    "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 :License, 'license_finder/license'
+  autoload :LicenseUrl, 'license_finder/license_url'
+  autoload :PossibleLicenseFile, 'license_finder/possible_license_file'
+  autoload :DependencyReport, 'license_finder/dependency_report'
+  autoload :HtmlReport, 'license_finder/html_report'
+  autoload :TextReport, 'license_finder/text_report'
+  autoload :Reporter, 'license_finder/reporter'
+  autoload :BundleSyncer, 'license_finder/bundle_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.ensure_default
+  end
+
+  def self.load_rake_tasks
+    load 'tasks/license_finder.rake'
+  end
+end
+
+require 'license_finder/railtie' if defined?(Rails)
+require 'license_finder/tables'
+
+LicenseFinder::YmlToSql.convert_if_required

data/lib/license_finder/bundle.rb

@@ -0,0 +1,48 @@
+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
+
+    def gems
+      return @gems if @gems
+
+      @gems ||= definition.specs_for(included_groups).map do |spec|
+        dependency = dependencies.detect { |dep| dep.name == spec.name }
+
+        BundledGem.new(spec, dependency)
+      end
+
+      @gems
+    end
+
+    private
+    attr_reader :definition
+
+    def ignore_groups
+      @ignore_groups ||= LicenseFinder.config.ignore_groups
+    end
+
+    def dependencies
+      @dependencies ||= definition.dependencies
+    end
+
+    def included_groups
+      definition.groups - ignore_groups
+    end
+
+    def gemfile_path
+      Pathname.new("Gemfile").expand_path
+    end
+
+    def lockfile_path
+      gemfile_path.dirname.join('Gemfile.lock')
+    end
+  end
+end

data/lib/license_finder/bundle_syncer.rb

@@ -0,0 +1,11 @@
+module LicenseFinder
+  module BundleSyncer
+    extend self
+
+    def sync!
+      current_dependencies = Bundle.current_gem_dependencies
+      Dependency.destroy_obsolete(current_dependencies)
+    end
+  end
+end
+

data/lib/license_finder/bundled_gem.rb

@@ -0,0 +1,48 @@
+module LicenseFinder
+  class BundledGem
+    attr_reader :parents, :spec, :bundler_dependency
+
+    def initialize(spec, bundler_dependency = nil)
+      @spec = spec
+      @bundler_dependency = bundler_dependency
+    end
+
+    def name
+      "#{dependency_name} #{dependency_version}"
+    end
+
+    def parents
+      @parents ||= []
+    end
+
+    def dependency_name
+      @spec.name
+    end
+
+    def dependency_version
+      @spec.version.to_s
+    end
+
+    def children
+      @children ||= @spec.dependencies.collect(&:name)
+    end
+
+    def determine_license
+      return @spec.license if @spec.license
+
+      license_files.map(&:license).compact.first || 'other'
+    end
+
+    def license_files
+      LicenseFiles.new(@spec.full_gem_path).files
+    end
+
+    def sort_order
+      dependency_name.downcase
+    end
+
+    def save_or_merge
+      GemSaver.find_or_initialize_by_name(@spec.name, self).save
+    end
+  end
+end

data/lib/license_finder/cli.rb

@@ -0,0 +1,49 @@
+module LicenseFinder
+  module CLI
+    extend self
+
+    @@run_complete = false
+
+    def check_for_action_items
+      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
+        puts "Dependencies that need approval:"
+        puts TextReport.new(unapproved)
+        exit 1
+      end
+    end
+
+    def execute!(options={})
+      if options.empty?
+        check_for_action_items
+      else
+        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.set_license_manually options[:license]
+          puts "The #{dependency.name} has been marked as using #{options[:license]} license!\n\n"
+        end
+
+        generate_reports
+      end
+    end
+
+    private
+    def generate_reports
+      Reporter.write_reports
+    end
+  end
+end

data/lib/license_finder/configuration.rb

@@ -0,0 +1,71 @@
+module LicenseFinder
+  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
+      @ignore_groups.map &:to_sym
+    end
+
+    def whitelisted?(license_name)
+      license = License.find_by_name(license_name) || license_name
+      whitelisted_licenses.include? license
+    end
+
+    private
+
+    def whitelisted_licenses
+      whitelist.map do |license_name|
+        License.find_by_name(license_name) || license_name
+      end.compact
+    end
+  end
+end

data/lib/license_finder/dependency_report.rb

@@ -0,0 +1,30 @@
+module LicenseFinder
+  class DependencyReport
+    def self.underscored_name
+      @underscored_name ||= begin
+        str = name.dup
+        str.sub!(/.*::/, '')
+        str.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+        str.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        str.downcase!
+      end
+    end
+
+    def initialize(dependencies=[])
+      @dependencies = Array dependencies
+    end
+
+    def to_s
+      filename = File.join(File.dirname(__FILE__), '..', 'templates', "#{self.class.underscored_name}.erb")
+      template = ERB.new(File.read(filename), 0, '-')
+      template.result(binding)
+    end
+
+    private
+    attr_reader :dependencies
+
+    def sorted_dependencies
+      dependencies.sort_by(&:name)
+    end
+  end
+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