license_finder 0.8.0-java

data/lib/license_finder/html_report.rb

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

data/lib/license_finder/license.rb

@@ -0,0 +1,90 @@
+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 }
+      end
+    end
+
+    class Text
+      def initialize(text)
+        @text = normalized(text)
+      end
+
+      def to_s
+        @text
+      end
+
+      private
+
+      def normalized(text)
+        text.gsub(/\s+/, ' ').gsub(/['`"]{1,2}/, "\"")
+      end
+    end
+
+    class Base
+      class << self
+        attr_accessor :license_url, :alternative_names
+
+        def inherited(descendant)
+          License.all << descendant
+        end
+
+        def names
+          ([demodulized_name, pretty_name] + self.alternative_names).uniq
+        end
+
+        def alternative_names
+          @alternative_names ||= []
+        end
+
+        def demodulized_name
+          name.gsub(/^.*::/, '')
+        end
+
+        def slug
+          demodulized_name.downcase
+        end
+
+        def pretty_name
+          demodulized_name
+        end
+
+        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)
+          end
+          @license_text
+        end
+
+        def license_regex
+          /#{Regexp.escape(license_text).gsub(/<[^<>]+>/, '(.*)')}/ if license_text
+        end
+      end
+
+      def initialize(text)
+        self.text = text
+      end
+
+      attr_reader :text
+
+      def text=(text)
+        @text = Text.new(text).to_s
+      end
+
+      def matches?
+        !!(text =~ self.class.license_regex if self.class.license_regex)
+      end
+    end
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'license', '*.rb')].each do |license|
+  require license
+end

data/lib/license_finder/license/apache2.rb

@@ -0,0 +1,8 @@
+class LicenseFinder::License::Apache2 < LicenseFinder::License::Base
+  self.alternative_names = ["Apache 2.0", "Apache2", "Apache-2.0"]
+  self.license_url       = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+
+  def self.pretty_name
+    'Apache 2.0'
+  end
+end

data/lib/license_finder/license/bsd.rb

@@ -0,0 +1,4 @@
+class LicenseFinder::License::BSD < LicenseFinder::License::Base
+  self.alternative_names = ["BSD4", "bsd-old", "4-clause BSD", "BSD-4-Clause"]
+  self.license_url = "http://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_.28original_.22BSD_License.22.29"
+end

data/lib/license_finder/license/gplv2.rb

@@ -0,0 +1,4 @@
+class LicenseFinder::License::GPLv2 < LicenseFinder::License::Base
+  self.license_url = 'http://www.gnu.org/licenses/gpl-2.0.txt'
+  self.alternative_names = ["GPL V2", "gpl-v2", "GNU GENERAL PUBLIC LICENSE Version 2"]
+end

data/lib/license_finder/license/isc.rb

@@ -0,0 +1,3 @@
+class LicenseFinder::License::ISC < LicenseFinder::License::Base
+  self.license_url = "http://en.wikipedia.org/wiki/ISC_license"
+end

data/lib/license_finder/license/lgpl.rb

@@ -0,0 +1,3 @@
+class LicenseFinder::License::LGPL < LicenseFinder::License::Base
+  self.license_url = "http://www.gnu.org/licenses/lgpl.txt"
+end

data/lib/license_finder/license/mit.rb

@@ -0,0 +1,23 @@
+class LicenseFinder::License::MIT < LicenseFinder::License::Base
+  self.license_url = "http://opensource.org/licenses/mit-license"
+  self.alternative_names = ["Expat"]
+
+  HEADER_REGEX = /The MIT Licen[sc]e/
+  ONE_LINER_REGEX = /is released under the MIT licen[sc]e/
+  URL_REGEX = %r{MIT Licen[sc]e.*http://(?:www.)?opensource.org/licenses/mit-license}
+
+  def matches?
+    super || matches_url? || matches_header?
+  end
+
+  private
+
+  def matches_url?
+    !!(text =~ URL_REGEX)
+  end
+
+  def matches_header?
+    header = text.split("\n").first
+    header && ((header.strip =~ HEADER_REGEX) || !!(text =~ ONE_LINER_REGEX))
+  end
+end

data/lib/license_finder/license/new_bsd.rb

@@ -0,0 +1,8 @@
+class LicenseFinder::License::NewBSD < LicenseFinder::License::Base
+  self.license_url = "http://opensource.org/licenses/BSD-3-Clause"
+  self.alternative_names = ["Modified BSD", "BSD3", "BSD-3", "3-clause BSD", "BSD-3-Clause"]
+
+  def self.pretty_name
+    'New BSD'
+  end
+end

data/lib/license_finder/license/ruby.rb

@@ -0,0 +1,11 @@
+class LicenseFinder::License::Ruby < LicenseFinder::License::Base
+  self.license_url = "http://www.ruby-lang.org/en/LICENSE.txt"
+
+  def self.pretty_name
+    'ruby'
+  end
+
+  def matches?
+    super || !!(text =~ /#{self.class.license_url}/)
+  end
+end

data/lib/license_finder/license/simplified_bsd.rb

@@ -0,0 +1,8 @@
+class LicenseFinder::License::SimplifiedBSD < LicenseFinder::License::Base
+  self.license_url = "http://opensource.org/licenses/bsd-license"
+  self.alternative_names = ["Simplified BSD", "FreeBSD", "2-clause BSD", "BSD-2-Clause"]
+
+  def self.pretty_name
+    'Simplified BSD'
+  end
+end

data/lib/license_finder/license_files.rb

@@ -0,0 +1,36 @@
+module LicenseFinder
+  class LicenseFiles
+    LICENSE_FILE_NAMES = %w(LICENSE License Licence COPYING README Readme ReadMe)
+
+    def initialize(install_path)
+      @install_path = install_path
+    end
+
+    attr_reader :install_path
+
+    def files
+      paths_for_license_files.map do |path|
+        get_file_for_path(path)
+      end
+    end
+
+    def paths_for_license_files
+      find_matching_files.map do |path|
+        File.directory?(path) ? paths_for_files_in_license_directory(path) : path
+      end.flatten.uniq
+    end
+
+    def find_matching_files
+      Dir.glob(File.join(install_path, '**', "*{#{LICENSE_FILE_NAMES.join(',')}}*"))
+    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)
+      PossibleLicenseFile.new(install_path, path)
+    end
+  end
+end

data/lib/license_finder/license_url.rb

@@ -0,0 +1,12 @@
+module LicenseFinder
+  module LicenseUrl
+    extend self
+
+    def find_by_name(name)
+      name = name.to_s
+
+      license = License.find_by_name(name)
+      license.license_url if license
+    end
+  end
+end

data/lib/license_finder/platform.rb

@@ -0,0 +1,32 @@
+module LicenseFinder
+  module Platform
+    def self.sqlite_adapter
+      if java?
+        'jdbc:sqlite'
+      else
+        'sqlite'
+      end
+    end
+
+    def self.sqlite_gem
+      if java?
+        'jdbc-sqlite3'
+      else
+        'sqlite3'
+      end
+    end
+
+    def self.sqlite_load_path
+      if java?
+        'jdbc/sqlite3'
+      else
+        'sqlite3'
+      end
+    end
+
+    def self.java?
+      RUBY_PLATFORM =~ /java/
+    end
+  end
+end
+

data/lib/license_finder/possible_license_file.rb

@@ -0,0 +1,32 @@
+module LicenseFinder
+  class PossibleLicenseFile
+    def initialize(install_path, file_path)
+      @install_path = Pathname.new(install_path)
+      @file_path = Pathname.new(file_path)
+    end
+
+    def file_path
+      @file_path.relative_path_from(@install_path).to_s
+    end
+
+    def full_file_path
+      Pathname.new(@file_path).realpath.to_s
+    end
+
+    def file_name
+      @file_path.basename.to_s
+    end
+
+    def text
+      @text ||= @file_path.send(@file_path.respond_to?(:binread) ? :binread : :read)
+    end
+
+    def license
+      license = License.all.detect do |klass|
+        klass.new(text).matches?
+      end
+
+      license.pretty_name if license
+    end
+  end
+end

data/lib/license_finder/railtie.rb

@@ -0,0 +1,7 @@
+module LicenseFinder
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/license_finder.rake"
+    end
+  end
+end

data/lib/license_finder/reporter.rb

@@ -0,0 +1,20 @@
+module LicenseFinder
+  module Reporter
+    extend self
+
+    def write_reports
+      dependencies = Dependency.all
+
+      write_file LicenseFinder.config.dependencies_text, TextReport.new(dependencies).to_s
+      write_file LicenseFinder.config.dependencies_html, HtmlReport.new(dependencies).to_s
+    end
+
+    private
+    def write_file(file_path, content)
+      File.open(file_path, 'w+') do |f|
+        f.puts content
+      end
+    end
+  end
+end
+

data/lib/license_finder/tables.rb

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

data/lib/license_finder/tables/approval.rb

@@ -0,0 +1,4 @@
+module LicenseFinder
+  class Approval < Sequel::Model
+  end
+end

data/lib/license_finder/tables/bundler_group.rb

@@ -0,0 +1,4 @@
+module LicenseFinder
+  class BundlerGroup < Sequel::Model
+  end
+end

data/lib/license_finder/tables/dependency.rb

@@ -0,0 +1,31 @@
+module LicenseFinder
+  class Dependency < Sequel::Model
+    many_to_one :license, class: LicenseAlias
+    many_to_one :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
+
+    def self.destroy_obsolete(current_dependencies)
+      exclude(id: current_dependencies.map(&:id)).each(&:destroy)
+    end
+
+    def self.unapproved
+      all.reject(&:approved?)
+    end
+
+    def approve!
+      approval.state = true
+      approval.save
+    end
+
+    def approved?
+      (license && license.whitelisted?) || (approval && approval.state)
+    end
+
+    def set_license_manually(name)
+      license.set_manually(name)
+    end
+  end
+end
+

data/lib/license_finder/tables/license_alias.rb

@@ -0,0 +1,22 @@
+module LicenseFinder
+  class LicenseAlias < Sequel::Model
+    def initialize(*args)
+      super
+      self.url = LicenseUrl.find_by_name name
+    end
+
+    def whitelisted?
+      !!(config.whitelisted?(name))
+    end
+
+    def set_manually(name)
+      update('name' => name, 'manual' => true)
+    end
+
+    private
+
+    def config
+      LicenseFinder.config
+    end
+  end
+end

data/lib/license_finder/text_report.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module LicenseFinder
+  class TextReport < DependencyReport
+    def to_s
+      super.strip
+    end
+  end
+end

data/lib/license_finder/yml_to_sql.rb

@@ -0,0 +1,127 @@
+module LicenseFinder
+  class YmlToSql
+    def self.convert_if_required
+      if needs_conversion?
+        convert_all(load_yml)
+        remove_yml
+      end
+    end
+
+    def self.load_yml
+      YAML.load File.read(yml_path)
+    end
+
+    def self.convert_all(all_legacy_attrs)
+      converters = all_legacy_attrs.map do |attrs|
+        new(attrs)
+      end
+      converters.each(&:convert)
+      converters.each(&:associate_children)
+    end
+
+    def self.needs_conversion?
+      File.exists?(yml_path)
+    end
+
+    def self.remove_yml
+      File.delete(yml_path)
+    end
+
+    def self.yml_path
+      LicenseFinder.config.dependencies_yaml
+    end
+
+    def initialize(attrs)
+      @legacy_attrs = attrs
+    end
+
+    attr_reader :legacy_attrs
+
+    def convert
+      @dep = create_dependency
+      @dep.license = create_license
+      @dep.approval = create_approval
+      associate_bundler_groups
+      @dep.save
+    end
+
+    def associate_children
+      find_children.each do |child|
+        @dep.add_child(child)
+      end
+    end
+
+    def associate_bundler_groups
+      find_bundler_groups.each do |group|
+        @dep.add_bundler_group(group)
+      end
+    end
+
+    def create_dependency
+      Sql::Dependency.convert(legacy_attrs)
+    end
+
+    def create_license
+      Sql::LicenseAlias.convert(legacy_attrs)
+    end
+
+    def create_approval
+      Sql::Approval.convert(legacy_attrs)
+    end
+
+    def find_children
+      Sql::Dependency.where(name: legacy_attrs['children'])
+    end
+
+    def find_bundler_groups
+      (legacy_attrs['bundler_groups'] || []).map do |name|
+        Sql::BundlerGroup.find_or_create(name: name.to_s)
+      end
+    end
+
+    module Sql
+      module Convertable
+        def convert(attrs)
+          create remap_attrs(attrs)
+        end
+
+        def remap_attrs(legacy_attrs)
+          self::VALID_ATTRIBUTES.each_with_object({}) do |(legacy_key, new_key), new_attrs|
+            new_attrs[new_key] = legacy_attrs[legacy_key]
+          end
+        end
+      end
+
+      class Dependency < Sequel::Model
+        extend Convertable
+        VALID_ATTRIBUTES = Hash[*%w[name version summary description homepage].map { |k| [k, k] }.flatten]
+
+        many_to_one :license, class: LicenseAlias
+        many_to_one :approval
+        many_to_many :children, join_table: :ancestries, left_key: :parent_dependency_id, right_key: :child_dependency_id, class: self
+        many_to_many :bundler_groups
+      end
+
+      class BundlerGroup < Sequel::Model
+      end
+
+      class LicenseAlias < Sequel::Model
+        extend Convertable
+
+        VALID_ATTRIBUTES = {
+          'license' => 'name',
+          'license_url' => 'url',
+          'manual' => 'manual'
+        }
+      end
+
+      class Approval < Sequel::Model
+        extend Convertable
+
+        VALID_ATTRIBUTES = {
+          'approved' => 'state'
+        }
+      end
+    end
+  end
+end