licensed 1.5.2 → 2.0.0

data/lib/licensed/sources/source.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Licensed
+  module Sources
+    class Source
+      class DependencyEnumerationNotImplementedError < StandardError
+        def initialize(message = "Source classes must implemented `enumerate_dependencies`")
+          super
+        end
+      end
+
+      class Error < StandardError; end
+
+      class << self
+        attr_reader :sources
+        def inherited(klass)
+          # add child source classes are defined,
+          # add them to the known sources list
+          (@sources ||= []) << klass
+        end
+
+        # Returns the source name as the snake cased class name
+        def type
+          self.name.split(/::/)
+                   .last
+                   .gsub(/([A-Z\d]+)([A-Z][a-z])/, "\\1_\\2".freeze)
+                   .gsub(/([a-z\d])([A-Z])/, "\\1_\\2".freeze)
+                   .downcase
+        end
+      end
+
+      # all sources have a configuration
+      attr_accessor :config
+
+      def initialize(configuration)
+        @config = configuration
+      end
+
+      # Returns whether a source is enabled based on the environment in which licensed is run
+      # Defaults to false.
+      def enabled?
+        false
+      end
+
+      # Returns all dependencies that should be evaluated.
+      # Excludes ignored dependencies.
+      def dependencies
+        cached_dependencies.reject { |d| ignored?(d) }
+      end
+
+      # Enumerate all source dependencies.  Must be implemented by each source class.
+      def enumerate_dependencies
+        raise DependencyEnumerationNotImplementedError
+      end
+
+      # Returns whether a dependency is ignored in the configuration.
+      def ignored?(dependency)
+        config.ignored?("type" => self.class.type, "name" => dependency.name)
+      end
+
+      private
+
+      # Returns a cached list of dependencies
+      def cached_dependencies
+        @dependencies ||= enumerate_dependencies.compact
+      end
+    end
+  end
+end

data/lib/licensed/ui/shell.rb

@@ -31,6 +31,10 @@ module Licensed
         @shell.say msg, :red, newline if level?("error")
       end
 
+      def newline
+        info ""
+      end
+
       def level=(level)
         raise ArgumentError unless LEVELS.include?(level.to_s)
         @level = level

data/lib/licensed/version.rb

@@ -1,4 +1,9 @@
 # frozen_string_literal: true
 module Licensed
-  VERSION = "1.5.2".freeze
+  VERSION = "2.0.0".freeze
+
+  def self.previous_major_versions
+    major_version = Gem::Version.new(Licensed::VERSION).segments.first
+    (1...major_version).to_a
+  end
 end

data/licensed.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_dependency "licensee", "~> 9.0"
-  spec.add_dependency "thor", "~>0.19"
-  spec.add_dependency "pathname-common_prefix", "~>0.0.1"
-  spec.add_dependency "tomlrb", "~>1.2"
-  spec.add_dependency "bundler", "~> 1.10"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "pathname-common_prefix", "~> 0.0.1"
+  spec.add_dependency "tomlrb", "~> 1.2"
+  spec.add_dependency "bundler", ">= 1.10"
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.8"

data/script/source-setup/bundler

@@ -14,7 +14,7 @@ cd $BASE_PATH/test/fixtures/bundler
 unset BUNDLE_GEMFILE
 
 if [ "$1" == "-f" ]; then
-  find . -not -regex "\.*" -and -not -name "Gemfile" -print0 | xargs -0 rm -rf
+  find . -not -regex "\.*" -and -not -name "Gemfile" -and -not \( -path ./pathed-gem-fixture -prune \) -print0 | xargs -0 rm -rf
 fi
 
 bundle install --path vendor/gems --without ignore

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensed
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 2.0.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: licensee
@@ -70,14 +70,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
@@ -170,8 +170,12 @@ files:
 - README.md
 - Rakefile
 - docker/Dockerfile.build-linux
+- docs/adding_a_new_source.md
+- docs/commands.md
 - docs/configuration.md
+- docs/migrating_to_newer_versions.md
 - docs/packaging.md
+- docs/reporters.md
 - docs/sources/bower.md
 - docs/sources/bundler.md
 - docs/sources/cabal.md
@@ -185,24 +189,34 @@ files:
 - exe/licensed
 - lib/licensed.rb
 - lib/licensed/cli.rb
-- lib/licensed/command/cache.rb
-- lib/licensed/command/list.rb
-- lib/licensed/command/status.rb
-- lib/licensed/command/version.rb
+- lib/licensed/commands.rb
+- lib/licensed/commands/cache.rb
+- lib/licensed/commands/command.rb
+- lib/licensed/commands/list.rb
+- lib/licensed/commands/status.rb
 - lib/licensed/configuration.rb
 - lib/licensed/dependency.rb
+- lib/licensed/dependency_record.rb
 - lib/licensed/git.rb
-- lib/licensed/license.rb
+- lib/licensed/migrations.rb
+- lib/licensed/migrations/v2.rb
+- lib/licensed/reporters.rb
+- lib/licensed/reporters/cache_reporter.rb
+- lib/licensed/reporters/list_reporter.rb
+- lib/licensed/reporters/reporter.rb
+- lib/licensed/reporters/status_reporter.rb
 - lib/licensed/shell.rb
-- lib/licensed/source/bower.rb
-- lib/licensed/source/bundler.rb
-- lib/licensed/source/cabal.rb
-- lib/licensed/source/dep.rb
-- lib/licensed/source/git_submodule.rb
-- lib/licensed/source/go.rb
-- lib/licensed/source/manifest.rb
-- lib/licensed/source/npm.rb
-- lib/licensed/source/pip.rb
+- lib/licensed/sources.rb
+- lib/licensed/sources/bower.rb
+- lib/licensed/sources/bundler.rb
+- lib/licensed/sources/cabal.rb
+- lib/licensed/sources/dep.rb
+- lib/licensed/sources/git_submodule.rb
+- lib/licensed/sources/go.rb
+- lib/licensed/sources/manifest.rb
+- lib/licensed/sources/npm.rb
+- lib/licensed/sources/pip.rb
+- lib/licensed/sources/source.rb
 - lib/licensed/ui/shell.rb
 - lib/licensed/version.rb
 - licensed.gemspec

data/lib/licensed/command/cache.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-module Licensed
-  module Command
-    class Cache
-      attr_reader :config
-
-      def initialize(config)
-        @config = config
-      end
-
-      def run(force: false)
-        summary = @config.apps.flat_map do |app|
-          app_name = app["name"]
-          @config.ui.info "Caching licenses for #{app_name}:"
-
-          # load the app environment
-          Dir.chdir app.source_path do
-
-            # map each available app source to it's dependencies
-            app.sources.map do |source|
-              type = source.class.type
-
-              @config.ui.info "  #{type} dependencies:"
-
-              names = []
-              cache_path = app.cache_path.join(type)
-
-              # exclude ignored dependencies
-              dependencies = source.dependencies.select { |d| !app.ignored?(d) }
-
-              # ensure each dependency is cached
-              dependencies.each do |dependency|
-                name = dependency.name
-                version = dependency["version"]
-
-                names << name
-                filename = cache_path.join("#{name}.txt")
-
-                # try to load existing license from disk
-                # or default to a blank license
-                license = Licensed::License.read(filename) || Licensed::License.new
-
-                # cached version string exists and did not change, no need to re-cache
-                has_version = !license["version"].nil? && !license["version"].empty?
-                if !force && has_version && version == license["version"]
-                  @config.ui.info "    Using #{name} (#{version})"
-                  next
-                end
-
-                @config.ui.info "    Caching #{name} (#{version})"
-
-                dependency.detect_license!
-                # use the cached license value if the license text wasn't updated
-                dependency["license"] = license["license"] if dependency.license_text_match?(license)
-
-                dependency.save(filename)
-              end
-
-              # Clean up cached files that dont match current dependencies
-              Dir.glob(cache_path.join("**/*.txt")).each do |file|
-                file_path = Pathname.new(file)
-                relative_path = file_path.relative_path_from(cache_path).to_s
-                FileUtils.rm(file) unless names.include?(relative_path.chomp(".txt"))
-              end
-
-              "* #{app_name} #{type} dependencies: #{dependencies.size}"
-            end
-          end
-        end
-
-        @config.ui.confirm "License caching complete!"
-        summary.each do |message|
-          @config.ui.confirm message
-        end
-      end
-
-      def success?
-        true
-      end
-    end
-  end
-end

data/lib/licensed/command/list.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-module Licensed
-  module Command
-    class List
-      attr_reader :config
-
-      def initialize(config)
-        @config = config
-      end
-
-      def run
-        @config.apps.each do |app|
-          @config.ui.info "Displaying dependencies for #{app["name"]}"
-          Dir.chdir app.source_path do
-            app.sources.each do |source|
-              type = source.class.type
-
-              @config.ui.info "  #{type} dependencies:"
-
-              source_dependencies = dependencies(app, source)
-              source_dependencies.each do |dependency|
-                @config.ui.info "    Found #{dependency.name} (#{dependency["version"]})"
-              end
-
-              @config.ui.confirm "  * #{type} dependencies: #{source_dependencies.size}"
-            end
-          end
-        end
-      end
-
-      # Returns an apps non-ignored dependencies, sorted by name
-      def dependencies(app, source)
-        source.dependencies
-              .select { |d| !app.ignored?(d) }
-              .sort_by { |d| d.name }
-      end
-
-      def success?
-        true
-      end
-    end
-  end
-end

data/lib/licensed/command/status.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-require "yaml"
-
-module Licensed
-  module Command
-    class Status
-      attr_reader :config
-
-      def initialize(config)
-        @config = config
-      end
-
-      def allowed_or_reviewed?(app, dependency)
-        app.allowed?(dependency) || app.reviewed?(dependency)
-      end
-
-      def app_dependencies(app)
-        app.sources.flat_map(&:dependencies).select { |d| !app.ignored?(d) }
-      end
-
-      def run
-        @results = @config.apps.flat_map do |app|
-          Dir.chdir app.source_path do
-            dependencies = app_dependencies(app)
-            @config.ui.info "Checking licenses for #{app['name']}: #{dependencies.size} dependencies"
-
-            results = dependencies.map do |dependency|
-              name = dependency.name
-              filename = app.cache_path.join(dependency["type"], "#{name}.txt")
-
-              warnings = []
-
-              # verify cached license data for dependency
-              if File.exist?(filename)
-                license = License.read(filename)
-
-                if license["version"] != dependency["version"]
-                  warnings << "cached license data out of date"
-                end
-                warnings << "missing license text" if license.license_text.empty?
-                unless allowed_or_reviewed?(app, license)
-                  warnings << "license needs reviewed: #{license["license"]}."
-                end
-              else
-                warnings << "cached license data missing"
-              end
-
-              if warnings.size > 0
-                @config.ui.error("F", false)
-                [filename, warnings]
-              else
-                @config.ui.confirm(".", false)
-                nil
-              end
-            end.compact
-
-            unless results.empty?
-              @config.ui.warn "\n\nWarnings:"
-
-              results.each do |filename, warnings|
-                @config.ui.info "\n#{filename}:"
-                warnings.each do |warning|
-                  @config.ui.error "  - #{warning}"
-                end
-              end
-            end
-
-            puts "\n#{dependencies.size} dependencies checked, #{results.size} warnings found."
-            results
-          end
-        end
-      end
-
-      def success?
-        @results.empty?
-      end
-    end
-  end
-end

data/lib/licensed/command/version.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-module Licensed
-  module Command
-    class Version
-      def initialize
-        @ui = Licensed::UI::Shell.new
-      end
-
-      def run
-        @ui.info(Licensed::VERSION)
-      end
-
-      def success?
-        true
-      end
-    end
-  end
-end

data/lib/licensed/license.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-require "yaml"
-require "fileutils"
-require "forwardable"
-require "licensee"
-
-module Licensed
-  class License
-    include Licensee::ContentHelper
-    extend Forwardable
-
-    YAML_FRONTMATTER_PATTERN = /\A---\s*\n(.*?\n?)^---\s*$\n?(.*)\z/m
-    TEXT_SEPARATOR = ("-" * 80).freeze
-    LICENSE_SEPARATOR = ("*" * 80).freeze
-
-    # Read an existing license file
-    #
-    # filename - A String path to the file
-    #
-    # Returns a Licensed::License
-    def self.read(filename)
-      return unless File.exist?(filename)
-      match = File.read(filename).scrub.match(YAML_FRONTMATTER_PATTERN)
-      new(YAML.load(match[1]), match[2])
-    end
-
-    def_delegators :@metadata, :[], :[]=, :delete
-
-    # The license text and other legal notices
-    attr_accessor :text
-
-    # Construct a new license
-    #
-    # filename - the String path of the file
-    # metadata - a Hash of the metadata for the package
-    # text     - a String of the license text and other legal notices
-    def initialize(metadata = {}, text = nil)
-      @metadata = metadata
-      @text = text
-    end
-
-    # Save the metadata and license to a file
-    def save(filename)
-      FileUtils.mkdir_p(File.dirname(filename))
-      File.write(filename, YAML.dump(@metadata) + "---\n#{text}")
-    end
-
-    # Returns the license text without any notices
-    def license_text
-      return unless text
-
-      # if the text contains the separator, the first string in the array
-      # should always be the license text whether empty or not.
-      # if the text didn't contain the separator, the text itself is the entirety
-      # of the license text
-      split = text.split(TEXT_SEPARATOR)
-      split.length > 1 ? split.first.rstrip : text.rstrip
-    end
-    alias_method :content, :license_text # use license_text for content matching
-
-    # Returns whether the current license should be updated to `other`
-    # based on whether the normalized license content matches
-    def license_text_match?(other)
-      return false unless other.is_a?(License)
-      self.content_normalized == other.content_normalized
-    end
-  end
-end