strong_versions 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 781e63371b2ecd0953ea88bcf84ce8673fe1df2a
-  data.tar.gz: 39099e9c2c5f84bcb67150a7a2b0e6f84c613fb9
+SHA256:
+  metadata.gz: a9da34b3e4b80be8af4d27254850e051518efbf3073be7e13ab612e9ba9e8c75
+  data.tar.gz: 42a655b38542c8b644b593cff388b91ade0229096165d0eba359eeef1a11cf22
 SHA512:
-  metadata.gz: 81a2471b4847714f914b76368b4bce0a0f5f9f2859d999838158ccec69762e293e3e5443fabb5a633874002de4fc77e6946c2388a1ce7403499cd72da19fe2ee
-  data.tar.gz: ea2d11b94e7a6c4932bf3a2fd7bc3aa383756e5870ba1b0df6da1190ad374c56968d16f6bb99a7ced78f457e1934a6ceafea25ea6c0d51d64c6d58f7cdbe88a4
+  metadata.gz: 9002687db125d01a87f404cd27d6f855243c92b87813a44e44453804694735ba1292f5eb751751249ab8478b4efe845809f4739202f1069937830f73996dc4c7
+  data.tar.gz: 616c683f92e0b1a0f8fcd8ac8b24a42bbd5dad96b2d1dbff5d7ea6c2555d78542a9079f4c17aa301a54a29fed5a1d582d0b3bcbed656da46023fb9190bdea428

data/.gitignore

@@ -1,8 +1,8 @@
+Gemfile.lock
 /.bundle/
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
@@ -12,3 +12,5 @@
 
 *.swp
 *.swo
+
+.byebug_history

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Robert Farrell
+
+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.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,13 +1,34 @@
-# Strong Versions
+# StrongVersions
 
-Ensure gems in your `Gemfile` are appropriately versioned.
+```
+The right thing to guide us
+Is right here inside us
+               --Nickelback
+```
+
+# Overview
+
+_StrongVersions_ is a _Bundler_ plugin that enforces a strict policy on your `Gemfile` requirements:
+
+* 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'`
+* 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.
+
+The benefit of applying this standard is that it [should](https://semver.org/) always be relatively safe to run `bundle update` to upgrade to the latest compatible versions of all dependencies.
+
+![StrongVersions](doc/images/strong-versions-example.png)
 
 ## Installation
 
-Add the gem to your `Gemile`
+Add the plugin to your `Gemfile`
 
 ```ruby
-gem 'strong_versions'
+plugin 'strong_versions', '~> 0.2.0'
 ```
 
 And rebuild your bundle:
@@ -15,3 +36,50 @@ And rebuild your bundle:
 ```bash
 $ 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.
+
+### Exclusions
+
+<a name="ignore"></a>You can exclude any gems from this list by adding them to the `ignore` section of `.strong_versions.yml` in your project root, e.g.:
+
+```yaml
+# .strong_versions.yml
+ignore:
+  - rails
+```
+
+### Raise or Warn
+
+_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`.
+
+Set `on_failure` in `.strong_versions.yml` to either `raise` or `warn`:
+
+```yaml
+# .strong_versions.yml
+on_failure: warn
+```
+
+## Contributing
+
+Fork and create a pull request.
+
+Run tests with _RSpec_:
+
+```
+$ bin/rspec
+```
+
+Check code with _Rubocop_:
+
+```
+$ bin/rubocop
+```
+
+## License
+
+[MIT License](LICENSE)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+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]"

data/lib/strong_versions/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class Config
+    def initialize(path)
+      @config = (YAML.load_file(path) if File.exist?(path))
+
+      validate_on_failure
+    end
+
+    def exceptions
+      return [] if @config.nil?
+
+      @config.fetch('ignore', [])
+    end
+
+    def on_failure
+      return 'raise' if @config.nil?
+
+      @config.fetch('on_failure', 'raise')
+    end
+
+    private
+
+    def validate_on_failure
+      expected = %w[warn raise]
+      strategy = on_failure
+      return strategy if expected.include?(strategy)
+
+      raise Bundler::BundlerError,
+            I18n.t(
+              'errors.unknown_on_failure', on_failure: strategy,
+                                           expected: expected
+            )
+    end
+  end
+end

data/lib/strong_versions/dependencies.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class Dependencies
+    def initialize(dependencies)
+      @dependencies = dependencies.map do |raw_dependency|
+        Dependency.new(raw_dependency)
+      end
+      @invalid_gems = []
+    end
+
+    def validate!(options = {})
+      return if validate(options)
+
+      on_failure = options.fetch(:on_failure, 'raise')
+      case on_failure
+      when 'raise'
+        raise_failure
+      when 'warn'
+        warn_failure
+      end
+    end
+
+    def validate(options = {})
+      @dependencies.each do |dependency|
+        next if options.fetch(:except).include?(dependency.name)
+        next if dependency.valid?
+
+        @invalid_gems.push(dependency) unless dependency.valid?
+      end
+      @invalid_gems.empty?
+    end
+
+    private
+
+    def raise_failure
+      warn_failure
+      # We must raise an error that Bundler recognises otherwise it prints a
+      # huge amount of output. `Bundler::GemspecError` just outputs the error
+      # message we set in red.
+      raise Bundler::GemspecError, 'StrongVersions failure'
+    end
+
+    def warn_failure
+      STDERR.puts("\n" + 'StrongVersions expectations not met:'.red + "\n\n")
+      @invalid_gems.each do |gem|
+        STDERR.puts(format_errors(gem.name, gem.errors))
+      end
+      STDERR.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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class Dependency
+    attr_reader :name, :errors
+
+    def initialize(dependency)
+      @dependency = dependency
+      @name = dependency.name
+      @errors = []
+
+      versions.each do |operator, version|
+        validate_version(operator, version)
+      end
+    end
+
+    def valid?
+      @errors.empty?
+    end
+
+    private
+
+    def versions
+      @dependency.requirements_list.map do |requirement|
+        parse_version(requirement)
+      end
+    end
+
+    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
+    end
+
+    def validate_version(operator, version)
+      return if path_source?
+      return if any_valid?
+
+      check_pessimistic(operator)
+      check_valid_version(version)
+    end
+
+    def check_pessimistic(operator)
+      return if pessimistic?(operator)
+
+      @errors << { type: :operator, value: operator }
+    end
+
+    def check_valid_version(version)
+      return if valid_version?(version)
+
+      version = I18n.t('version_not_specified') if version == '0'
+      @errors << { type: :version, value: version }
+    end
+
+    def pessimistic?(operator)
+      operator == '~>'
+    end
+
+    def valid_version?(version)
+      return true if version =~ /^[1-9][0-9]*\.\d+$/ # major.minor, e.g. "2.5"
+      return true if version =~ /^0\.\d+\.\d+$/ # 0.minor.patch, e.g. "0.1.8"
+
+      false
+    end
+
+    def any_valid?
+      versions.any? do |operator, version|
+        pessimistic?(operator) && valid_version?(version)
+      end
+    end
+
+    def path_source?
+      @dependency.source.is_a?(Bundler::Source::Path)
+    end
+
+    def pessimistic_with_upper_bound?(operator)
+      any_pessimistic? && %w[< <=].include?(operator)
+    end
+
+    def any_pessimistic?
+      versions.any? do |_version, operator|
+        %w[< <= ~>].include?(operator)
+      end
+    end
+  end
+end

data/lib/strong_versions/version.rb

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

data/lib/strong_versions.rb

@@ -1,27 +1,19 @@
 # frozen_string_literal: true
 
-require 'strong_versions/version'
+require 'colorize'
+require 'i18n'
+require 'yaml'
 
-module StrongVersions
-  module_function
+I18n.config.available_locales = :en
+I18n.load_path += Dir[
+  File.join(File.expand_path('..', __dir__), 'config', 'locales', '**', '*.yml')
+]
 
-  def post_install_hooks
-    puts 'post install'
-  end
+require 'strong_versions/version'
 
-  def post_build_hooks
-    puts 'post build'
-  end
+require 'strong_versions/dependency'
+require 'strong_versions/dependencies'
+require 'strong_versions/config'
 
-  def pre_install_hooks
-    puts 'pre-install'
-  end
+module StrongVersions
 end
-
-puts 'hmmm'
-puts 'hmmm'
-puts 'hmmm'
-puts 'hmmm'
-puts 'hmmm'
-puts 'hmmm'
-puts 'hmmm'

data/plugins.rb

@@ -1,11 +1,13 @@
-require 'byebug'; byebug
-class MyCommand < Bundler::Plugin::API
-  command 'my_command'
-  def exec(command, args)
-    require 'byebug'; byebug
-  end
-end
+# frozen_string_literal: true
+
+require 'strong_versions'
+
+Bundler::Plugin.add_hook('before-install-all') do |dependencies|
+  config_path = Bundler.root.join('.strong_versions.yml')
+  config = StrongVersions::Config.new(config_path)
 
-Bundler::Plugin.add_hook('before-install-all') do |_d|
-  require 'byebug'; byebug
+  StrongVersions::Dependencies.new(dependencies).validate!(
+    except: config.exceptions,
+    on_failure: config.on_failure
+  )
 end

data/strong_versions.gemspec

@@ -19,14 +19,18 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  p spec.files
 
   spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = []
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'i18n', '>= 0.5.0'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.59.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'rubocop', '~> 0.60.0'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-28 00:00:00.000000000 Z
+date: 2018-10-31 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,40 +94,61 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.60.0
 description: Ensure your gems are appropriately versioned
 email:
 - robertanthonyfarrell@gmail.com
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
 - bin/setup
+- config/locales/en.yml
+- doc/images/strong-versions-example.png
 - lib/strong_versions.rb
+- lib/strong_versions/config.rb
+- lib/strong_versions/dependencies.rb
+- lib/strong_versions/dependency.rb
 - lib/strong_versions/version.rb
 - plugins.rb
 - strong_versions.gemspec
@@ -108,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Enforce strict versioning on your Gemfile

data/Gemfile.lock

@@ -1,53 +0,0 @@
-PATH
-  remote: .
-  specs:
-    strong_versions (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.1)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.59.2)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (= 0.59.2)
-  strong_versions!
-
-BUNDLED WITH
-   1.16.4