strong_versions 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c22d65fb8950d91b5f8303c8f5eba7842a39d6ea9410b70071ccd7cf5944a0c
-  data.tar.gz: 840a9a7c0dd86371ca55a2b8884a7a7b86688342c1cadd038d501ffd864f6166
+  metadata.gz: adffa925b8acf616a7d80b8f7122efcd450375d3dd001dbf7a7735a13199a415
+  data.tar.gz: 3495a49f991f76bff0f75ea9d726a324eac68819b821dd419a1a8f8ea5b8e641
 SHA512:
-  metadata.gz: 460734cdc1a68bdc008f7bb496895da1f0735e9e4b29db2a1f816f41895717cae236ae27e14242ca92f25d0fe5346ff1cdb1532115a8997f63f86dfcee0e10ab
-  data.tar.gz: 634139436aec6caa3d9be60723a6fea378c702799046ffc6929d84e38a61d1927cf8c5f3820dc79c5f67c4e2628c0238da7caeb0fd71b57536b4cea897d5555a
+  metadata.gz: f88d7e3db8ad162490eb0426a48638fa8c5195d1b7ffc2342d8084166cd7af46fe5bd0667a2703ce68e3ef0fb54addc32739b0a1e8612f2dd5651d68d8848a5e
+  data.tar.gz: 9a798e3a31a229f9191daf7e631171c5cd757bbf1d01db4426b905caa7b6ac6f4bfa76f3234fba778a96f131e11bd43fdb58fae4d20a7f1047cc14fef462c9b1

data/.rubocop.yml

@@ -5,6 +5,10 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
+Style/FormatStringToken:
+  Exclude:
+    # The `Paint` gem requires this format of string template.
+    - 'lib/strong_versions/terminal.rb'
 AllCops:
   Exclude:
     - 'bin/**/*'

data/.strong_versions.yml

@@ -0,0 +1,2 @@
+ignore:
+  - i18n

data/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bin/rspec
+	bin/rubocop
+	bundle exec bin/strong_versions

data/README.md

@@ -28,7 +28,7 @@ The benefit of applying this standard is that, if all gems follow [Semantic Vers
 Add the gem to your `Gemfile`
 
 ```ruby
-gem 'strong_versions', '~> 0.3.0'
+gem 'strong_versions', '~> 0.3.1'
 ```
 
 And rebuild your bundle:

data/bin/strong_versions

@@ -4,8 +4,7 @@ require 'strong_versions'
 
 config_path = Bundler.root.join('.strong_versions.yml')
 config = StrongVersions::Config.new(config_path)
-dependencies = Bundler.definition.dependencies
-
+dependencies = StrongVersions::DependencyFinder.new.dependencies
 valid = StrongVersions::Dependencies.new(dependencies).validate!(
   except: config.exceptions,
   on_failure: 'warn'

data/config/locales/en.yml

@@ -1,6 +1,15 @@
 en:
-  errors:
-    operator: "Expected pessimistic operator (~>), found:"
-    version: "Expected major and minor version (e.g. 1.2), found:"
-    unknown_on_failure: "StrongVersions: Unknown value for `on_failure` in .strong_versions.yml: '%{on_failure}'. Expected one of %{expected}"
-  version_not_specified: "[not specified]"
+  strong_versions:
+    checked: "gem definitions inspected"
+    no_issues: 'no issues'
+    issue: 'issue'
+    issues: 'issues'
+    detected: 'detected'
+
+    errors:
+      failure: "StrongVersions Failure"
+      operator: "Expected pessimistic operator:"
+      version: "Expected major and minor version or unstable version, e.g."
+      unknown_on_failure: "StrongVersions: Unknown value for `on_failure` in .strong_versions.yml: '%{on_failure}'. Expected one of %{expected}"
+      suggested: 'Suggested: '
+    version_not_specified: "[not specified]"

data/lib/strong_versions.rb

@@ -2,32 +2,24 @@
 
 require 'yaml'
 
-begin
-  require 'i18n'
-  I18n.config.available_locales = :en
-  I18n.load_path += Dir[
-    File.join(
-      File.expand_path('..', __dir__), 'config', 'locales', '**', '*.yml'
-    )
-  ]
-rescue LoadError
-  require 'strong_versions/i18n_stub'
-end
+require 'i18n'
+require 'paint'
 
 require 'strong_versions/config'
 require 'strong_versions/dependency'
+require 'strong_versions/dependency_finder'
 require 'strong_versions/dependencies'
-require 'strong_versions/gemfile_dsl'
-require 'strong_versions/install_detector'
+require 'strong_versions/suggestion'
 require 'strong_versions/terminal'
 require 'strong_versions/version'
 
 module StrongVersions
-  def self.installed?
-    InstallDetector.new.installed?
-  end
-
   def self.root
     Pathname.new(File.dirname(__dir__))
   end
 end
+
+I18n.config.available_locales = :en
+I18n.load_path += Dir[
+  StrongVersions.root.join('config', 'locales', '**', '*.yml')
+]

data/lib/strong_versions/config.rb

@@ -3,19 +3,19 @@
 module StrongVersions
   class Config
     def initialize(path)
-      @config = (YAML.load_file(path) if File.exist?(path))
+      @config = YAML.load_file(path) if File.exist?(path)
 
       validate_on_failure
     end
 
     def exceptions
-      return [] if @config.nil?
+      return [] unless @config
 
       @config.fetch('ignore', [])
     end
 
     def on_failure
-      return 'raise' if @config.nil?
+      return 'raise' unless @config
 
       @config.fetch('on_failure', 'raise')
     end
@@ -29,8 +29,8 @@ module StrongVersions
 
       raise Bundler::BundlerError,
             I18n.t(
-              'errors.unknown_on_failure', on_failure: strategy,
-                                           expected: expected
+              'strong_versions.errors.unknown_on_failure',
+              on_failure: strategy, expected: expected
             )
     end
   end

data/lib/strong_versions/dependencies.rb

@@ -7,19 +7,17 @@ module StrongVersions
         Dependency.new(raw_dependency)
       end
       @invalid_gems = []
+      @terminal = Terminal.new
     end
 
     def validate!(options = {})
-      return true if validate(options)
-
-      on_failure = options.fetch(:on_failure, 'raise')
-      case on_failure
-      when 'raise'
-        raise_failure
-      when 'warn'
-        warn_failure
+      if validate(options)
+        summary
+        return true
       end
 
+      raise_or_warn(options.fetch(:on_failure, 'raise'))
+      summary
       false
     end
 
@@ -35,6 +33,19 @@ module StrongVersions
 
     private
 
+    def summary
+      @terminal.summary(@dependencies.size, @invalid_gems.size)
+    end
+
+    def raise_or_warn(on_failure)
+      case on_failure
+      when 'raise'
+        raise_failure
+      when 'warn'
+        warn_failure
+      end
+    end
+
     def raise_failure
       warn_failure
       # We must raise an error that Bundler recognises otherwise it prints a
@@ -44,17 +55,19 @@ module StrongVersions
     end
 
     def warn_failure
-      terminal = Terminal.new
-      terminal.warn("\nStrongVersions expectations not met:\n")
+      @terminal.warn("\n#{I18n.t('strong_versions.errors.failure')}\n")
       @invalid_gems.each do |gem|
-        terminal.output_errors(gem.name, gem.errors)
+        @terminal.output_errors(gem)
       end
-      terminal.puts("\n")
+      @terminal.puts("\n")
     end
 
     def raise_unknown(on_failure)
       raise Bundler::Error,
-            I18n.t('errors.unknown_on_failure', on_failure: on_failure)
+            I18n.t(
+              'strong_versions.errors.unknown_on_failure',
+              on_failure: on_failure
+            )
     end
   end
 end

data/lib/strong_versions/dependency.rb

@@ -4,10 +4,11 @@ module StrongVersions
   class Dependency
     attr_reader :name, :errors
 
-    def initialize(dependency)
+    def initialize(dependency, lockfile = nil)
       @dependency = dependency
       @name = dependency.name
       @errors = []
+      @lockfile = lockfile || default_lockfile
 
       versions.each do |operator, version|
         validate_version(operator, version)
@@ -18,6 +19,14 @@ module StrongVersions
       @errors.empty?
     end
 
+    def suggestion
+      Suggestion.new(lockfile_version)
+    end
+
+    def definition
+      versions.map { |operator, version| "'#{operator} #{version}'" }.join(', ')
+    end
+
     private
 
     def versions
@@ -28,13 +37,25 @@ module StrongVersions
 
     def parse_version(requirement)
       operator, version_obj = Gem::Requirement.parse(requirement)
-      if version_obj.respond_to?(:version)
-        # Ruby >= 2.3.0: `version_obj` is a `Gem::Version`
-        [operator, version_obj.version]
-      else
-        # Ruby < 2.3.0: `version_obj` is a `String`
-        [operator, version_obj]
-      end
+      [operator, version(version_obj)]
+    end
+
+    def lockfile_version
+      @lockfile_version ||= version(
+        @lockfile.specs.find { |spec| spec.name == @name }&.version
+      )
+    end
+
+    def default_lockfile
+      Bundler::LockfileParser.new(Bundler.read_file(Bundler.default_lockfile))
+    end
+
+    def version(version_obj)
+      # Ruby >= 2.3.0: `version_obj` is a `Gem::Version`
+      return version_obj.version if version_obj.respond_to?(:version)
+
+      # Ruby < 2.3.0: `version_obj` is a `String`
+      version_obj
     end
 
     def validate_version(operator, version)
@@ -54,8 +75,12 @@ module StrongVersions
     def check_valid_version(version)
       return if valid_version?(version)
 
-      version = I18n.t('version_not_specified') if version == '0'
-      @errors << { type: :version, value: version }
+      value = if version == '0'
+                I18n.t('strong_versions.version_not_specified')
+              else
+                version
+              end
+      @errors << { type: :version, value: value }
     end
 
     def pessimistic?(operator)

data/lib/strong_versions/dependency_finder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class DependencyFinder
+    def dependencies
+      development + runtime
+    end
+
+    private
+
+    def development
+      # Gem runtime dependencies are not included here:
+      Bundler.definition.dependencies
+    end
+
+    def runtime
+      gemspecs.compact.map(&:dependencies).flatten.select do |spec|
+        spec.type == :runtime
+      end
+    end
+
+    def gemspecs
+      gemspec_paths.map { |path| Bundler.load_gemspec(path) }
+    end
+
+    def gemspec_paths
+      Dir[File.join(Bundler.default_gemfile.dirname, '{,*}.gemspec')]
+    end
+  end
+end

data/lib/strong_versions/suggestion.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class Suggestion
+    def initialize(version)
+      @parts = version.split('.') unless version.nil?
+    end
+
+    def to_s
+      return version.to_s if version.nil?
+
+      "'~> #{version}'"
+    end
+
+    def missing?
+      return false if stable?
+      return false if unstable?
+
+      true
+    end
+
+    private
+
+    def version
+      major, minor, patch = @parts if standard?
+
+      return "#{major}.#{minor}" if stable?
+      return "#{major}.#{minor}.#{patch}" if unstable?
+
+      nil
+    end
+
+    def unstable?
+      standard? && @parts.first.to_i.zero?
+    end
+
+    def stable?
+      standard? && @parts.first.to_i >= 1
+    end
+
+    def standard?
+      return false if @parts.nil?
+      return false unless @parts.size == 3
+      return false unless numeric?
+
+      true
+    end
+
+    def numeric?
+      @parts.all? { |part| part =~ /\A[0-9]+\Z/ }
+    end
+  end
+end

data/lib/strong_versions/terminal.rb

@@ -2,50 +2,105 @@
 
 module StrongVersions
   class Terminal
-    COLOR_CODES = {
-      red: 31,
-      green: 32,
-      light_red: 91
-    }.freeze
-
     def initialize(file = STDERR)
       @file = file
-      check_i18n
     end
 
     def warn(string)
-      puts(color(:red, string))
+      puts(color(string, :underline, :bright, :red))
     end
 
-    def output_errors(name, errors)
-      puts(format_errors(name, errors))
+    def summary(count, failed)
+      return puts(success(count)) if failed.zero?
+
+      puts(failure(count, failed))
     end
 
-    def puts(string)
+    def output_errors(gem)
+      puts(name_and_definition(gem))
+
+      puts(format_errors(gem.errors))
+      suggestion(gem)
+      puts
+    end
+
+    def puts(string = '')
       @file.puts(string)
     end
 
     private
 
-    def format_errors(name, errors)
-      message = color(:green, "#{name}: ")
-      message + errors.map do |error|
-        type = color(:red, I18n.t("errors.#{error[:type]}"))
-        value = color(:light_red, error[:value])
-        color(:red, '"') + "#{type} #{value}" + color(:red, '"')
-      end.join(color(:red, ', '))
+    def t(name)
+      I18n.t("strong_versions.#{name}")
+    end
+
+    # Success and failure output format brazenly stolen from Rubocop.
+    def success(count)
+      color(
+        "#{count} #{t('checked')}, %{no_issues} #{t('detected')}",
+        :default,
+        no_issues: [t('no_issues'), :green]
+      )
     end
 
-    def color(name, string)
-      code = COLOR_CODES.fetch(name)
-      "\033[#{code}m#{string}\033[39m"
+    def failure(count, failed)
+      issues = "#{failed} " + (failed == 1 ? t('issue') : t('issues'))
+      color(
+        "#{count} #{t('checked')}, %{issues} #{t('detected')}",
+        :default,
+        issues: [issues, :red]
+      )
     end
 
-    def check_i18n
-      return unless I18n.respond_to?(:_strong_versions__stub)
+    def format_errors(errors)
+      errors.map do |error|
+        type = t("errors.#{error[:type]}")
+        color(
+          '  %{type} %{example}, found: %{found}',
+          :default,
+          type: [type, :default],
+          example: example(error[:type]),
+          found: [error[:value], :red]
+        )
+      end
+    end
+
+    def suggestion(gem)
+      suggested = '  ' + t('errors.suggested')
+      puts(
+        color(
+          "#{suggested} %{suggestion}",
+          :default,
+          suggestion: [gem.suggestion.to_s, :green]
+        )
+      )
+    end
+
+    def name_and_definition(gem)
+      color(
+        '`%{name}`: %{definition}',
+        :default,
+        name: [gem.name, :reset, :bright, :red],
+        definition: [gem.definition, :reset, :red]
+      )
+    end
+
+    def example(type)
+      case type
+      when :operator
+        color('~>', :green)
+      when :version
+        color('%{major} or %{minor}', :default, major: ['1.2', :green],
+                                                minor: ['0.2.3', :green])
+      else
+        raise ArgumentError
+      end
+    end
 
-      warn("\n`i18n` not installed. Using fallback.")
-      warn('Output will improve when your bundle installation completes.')
+    def color(string, *substitutions)
+      # rubocop:disable Style/FormatString, Layout/SpaceAroundOperators
+      Paint%[string.dup, *substitutions]
+      # rubocop:enable Style/FormatString, Layout/SpaceAroundOperators
     end
   end
 end

data/lib/strong_versions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StrongVersions
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/strong_versions.gemspec

@@ -29,7 +29,9 @@ Gem::Specification.new do |spec|
   # I will do a release that is locked to '~> 1.0' and Rails 4 users can use
   # an older version of the gem but we are not quite there yet.
   spec.add_dependency 'i18n', '>= 0.5.0'
+  spec.add_dependency 'paint', '~> 2.0'
 
+  spec.add_development_dependency 'betterp', '~> 0.1.2'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'byebug', '~> 10.0'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: betterp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -120,9 +148,11 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".strong_versions.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -137,12 +167,10 @@ files:
 - lib/strong_versions/config.rb
 - lib/strong_versions/dependencies.rb
 - lib/strong_versions/dependency.rb
-- lib/strong_versions/gemfile_dsl.rb
-- lib/strong_versions/i18n_stub.rb
-- lib/strong_versions/install_detector.rb
+- lib/strong_versions/dependency_finder.rb
+- lib/strong_versions/suggestion.rb
 - lib/strong_versions/terminal.rb
 - lib/strong_versions/version.rb
-- plugins.rb
 - strong_versions.gemspec
 homepage: https://github.com/bobf/strong_versions
 licenses: []

data/lib/strong_versions/gemfile_dsl.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module StrongVersions
-  class GemfileDSL
-    attr_reader :_strong_versions__installed
-
-    def initialize
-      @_strong_versions__installed = false
-    end
-
-    def plugin(name, *_args)
-      @_strong_versions__installed = true if name == 'strong_versions'
-    end
-
-    # If we don't explicitly define this method then RubyGems' Kernel#gem is
-    # called instead.
-    def gem(*_args); end
-
-    private
-
-    # rubocop:disable Style/MethodMissingSuper
-    def method_missing(_method, *_args, &_block); end
-    # rubocop:enable Style/MethodMissingSuper
-
-    def respond_to_missing?(_method)
-      true
-    end
-  end
-end

data/lib/strong_versions/i18n_stub.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-class I18n
-  def self.t(key)
-    key
-  end
-
-  def self._strong_versions__stub; end
-end

data/lib/strong_versions/install_detector.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module StrongVersions
-  class InstallDetector
-    def initialize(gemfiles = nil)
-      @gemfiles = gemfiles.nil? ? Bundler.definition.gemfiles : gemfiles
-      @dsl = GemfileDSL.new
-    end
-
-    def installed?
-      @gemfiles.each do |gemfile|
-        # Bundler uses the same strategy to parse Gemfiles.
-        @dsl.instance_eval(
-          Bundler.read_file(gemfile).dup.untaint, gemfile.to_s, 1
-        )
-      end
-
-      @dsl._strong_versions__installed
-    end
-  end
-end

data/plugins.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# XXX: StrongVersions was intended to be a Bundler plugin but, unfortunately,
-# the plugin system is still in its infancy and has many issues which make it
-# not fit for purpose. If those issues get resolved then I will re-add
-# documentation for use as a plugin.
-
-require 'strong_versions'
-
-Bundler::Plugin.add_hook('before-install-all') do |dependencies|
-  # `StrongVersions.installed?` checks to see if 'strong_versions' is a
-  # dependency (i.e. included in the `Gemfile`). The reason for this is that,
-  # once a plugin has been installed, removing it from the `Gemfile` does not
-  # remove the plugin or its hooks so the hook will still run on every
-  # `bundle install`. I think that is not what a user would expect so we check
-  # that the plugin is explicitly referenced in the `Gemfile`.
-  run_hook(dependencies) if StrongVersions.installed?
-end
-
-def run_hook(dependencies)
-  config_path = Bundler.root.join('.strong_versions.yml')
-  config = StrongVersions::Config.new(config_path)
-
-  StrongVersions::Dependencies.new(dependencies).validate!(
-    except: config.exceptions,
-    on_failure: config.on_failure
-  )
-end