strong_versions 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9da34b3e4b80be8af4d27254850e051518efbf3073be7e13ab612e9ba9e8c75
-  data.tar.gz: 42a655b38542c8b644b593cff388b91ade0229096165d0eba359eeef1a11cf22
+  metadata.gz: 1e9137c23cce3c8cf3ca835657b64fbfe74761fad58f14f9572020d5360dc4bf
+  data.tar.gz: 66e4f5b06fc23363b9a83016fcf2140006d124fef6813228d4cd6c6d8d4b5a1e
 SHA512:
-  metadata.gz: 9002687db125d01a87f404cd27d6f855243c92b87813a44e44453804694735ba1292f5eb751751249ab8478b4efe845809f4739202f1069937830f73996dc4c7
-  data.tar.gz: 616c683f92e0b1a0f8fcd8ac8b24a42bbd5dad96b2d1dbff5d7ea6c2555d78542a9079f4c17aa301a54a29fed5a1d582d0b3bcbed656da46023fb9190bdea428
+  metadata.gz: 1b5cfc945a0cbe534a01010b78a263c380943591889839b07a271577a7815ebe9ec03eaed6ac5247cfdbcc3e94ce8f7d9986cb85a8ba7684e45cd0edf3a59cca
+  data.tar.gz: fca7aa528b8aff694f213ec0e8aea6744185060556090a2dfe89d3fb5e2bd95639816832b91ead81203fabb01e1187eac237ea0060e38d86f693458e8d9e5475

data/.gitignore

@@ -14,3 +14,4 @@ Gemfile.lock
 *.swo
 
 .byebug_history
+strong_versions-*.gem

data/README.md

@@ -13,8 +13,8 @@ _StrongVersions_ is a _Bundler_ plugin that enforces a strict policy on your `Ge
 * The pessimistic `~>` operator must be used for all gem requirement definitions.
 * If the gem version is greater than 1, the requirement format must be `major.minor`, e.g. `'~> 2.5`'
 * If the gem version is less than 1, the requirement format must be `major.minor.patch`, e.g. `'~> 0.8.9'`
-* An upper bound can be specified as long as a valid pessimistic version is also specified, e.g. `'~> 8.4', '<= 8.4.7'`
-* All gems with a `path` source are ignored, e.g. `path: '/path/to/gem'`
+* An upper bound can be specified as long as a valid pessimistic version is also specified, e.g. `'~> 8.4', '< 8.6.7' # Bug introduced in 8.6.7`
+* All gems with a `path` or `git` source are ignored, e.g. `path: '/path/to/gem'`, `git: 'https://github.com/bobf/strong_versions'`
 * All gems specified in the [ignore list](#ignore) are ignored.
 
 Any gems that do not satisfy these rules will cause `bundle install` to fail and give output detailing which gems did not meet the standard and why.
@@ -28,7 +28,7 @@ The benefit of applying this standard is that it [should](https://semver.org/) a
 Add the plugin to your `Gemfile`
 
 ```ruby
-plugin 'strong_versions', '~> 0.2.0'
+plugin 'strong_versions', '~> 0.2.1'
 ```
 
 And rebuild your bundle:
@@ -39,7 +39,9 @@ $ bundle install
 
 ## Usage
 
-Once the plugin is installed it will automatically hook into _Bundler_ and raise an exception every time you call `bundle install` if there are any errors.
+_StrongVersions_ will automatically hook into _Bundler_ and raise an exception every time you call `bundle install` if there are any errors.
+
+If you prefer to see a warning rather than raise an exception, see [raise or warn](#raise_or_warn).
 
 ### Exclusions
 
@@ -53,7 +55,7 @@ ignore:
 
 ### Raise or Warn
 
-_StrongVersions_ can be configured to raise an exception (default) or output a warning when the standard is not met.
+<a name="raise_or_warn"></a>_StrongVersions_ can be configured to raise an exception (default) or output a warning when the standard is not met.
 
 Warning instead of raising is especially useful when you want to add new dependencies to your `Gemfile` as you can initially set them with loose requirements and then update the `Gemfile` with more precise values based on your new `Gemfile.lock`.
 

data/lib/strong_versions.rb

@@ -1,19 +1,33 @@
 # frozen_string_literal: true
 
-require 'colorize'
-require 'i18n'
 require 'yaml'
 
-I18n.config.available_locales = :en
-I18n.load_path += Dir[
-  File.join(File.expand_path('..', __dir__), 'config', 'locales', '**', '*.yml')
-]
-
-require 'strong_versions/version'
+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 'strong_versions/config'
 require 'strong_versions/dependency'
 require 'strong_versions/dependencies'
-require 'strong_versions/config'
+require 'strong_versions/gemfile_dsl'
+require 'strong_versions/install_detector'
+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

data/lib/strong_versions/dependencies.rb

@@ -42,25 +42,17 @@ module StrongVersions
     end
 
     def warn_failure
-      STDERR.puts("\n" + 'StrongVersions expectations not met:'.red + "\n\n")
+      terminal = Terminal.new
+      terminal.warn("\nStrongVersions expectations not met:\n")
       @invalid_gems.each do |gem|
-        STDERR.puts(format_errors(gem.name, gem.errors))
+        terminal.output_errors(gem.name, gem.errors)
       end
-      STDERR.puts("\n")
+      terminal.puts("\n")
     end
 
     def raise_unknown(on_failure)
       raise Bundler::Error,
             I18n.t('errors.unknown_on_failure', on_failure: on_failure)
     end
-
-    def format_errors(name, errors)
-      message = "#{name}: ".green
-      message + errors.map do |error|
-        type = I18n.t("errors.#{error[:type]}").red
-        value = error[:value].light_red
-        '"'.red + "#{type} #{value}" + '"'.red
-      end.join(', '.red)
-    end
   end
 end

data/lib/strong_versions/dependency.rb

@@ -76,6 +76,8 @@ module StrongVersions
     end
 
     def path_source?
+      # Bundler::Source::Git inherits from Bundler::Source::Path so git sources
+      # will also return `true`.
       @dependency.source.is_a?(Bundler::Source::Path)
     end
 

data/lib/strong_versions/gemfile_dsl.rb

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,9 @@
+# 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

@@ -0,0 +1,21 @@
+# 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/lib/strong_versions/terminal.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+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))
+    end
+
+    def output_errors(name, errors)
+      puts(format_errors(name, errors))
+    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, ', '))
+    end
+
+    def color(name, string)
+      code = COLOR_CODES.fetch(name)
+      "\033[#{code}m#{string}\033[39m"
+    end
+
+    def check_i18n
+      return unless I18n.respond_to?(:_strong_versions__stub)
+
+      warn("\n`i18n` not installed. Using fallback.")
+      warn('Output will improve when your bundle installation completes.')
+    end
+  end
+end

data/lib/strong_versions/version.rb

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

data/plugins.rb

@@ -3,6 +3,16 @@
 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)
 

data/strong_versions.gemspec

@@ -24,7 +24,10 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'colorize', '~> 0.8'
+  # Rails 4 is locked to I18n ~> 0.7 so, unfortunately, until we are ready to
+  # stop supporting Rails 4 we need to support I18n 0.x and 1.x. At some point,
+  # 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_development_dependency 'bundler', '~> 1.16'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +135,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/terminal.rb
 - lib/strong_versions/version.rb
 - plugins.rb
 - strong_versions.gemspec