strong_versions 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9589edc74d736ee2c17217c9bf8c4efe316c8ada4842ecec28a16d27f939afa9
-  data.tar.gz: 438bcc252b6bde7667b223b2efd55f26ca56597b21f5f238b9747ad78b1fb96b
+  metadata.gz: f73f7623edb5e3a662b18ea78cd67822dfdbcc81bd6eb0e9332e80bd1eda57c6
+  data.tar.gz: 9ed40edc5e76826e6458848fadd2b92a5b9f0985cefa0a3e56943c176e32edbb
 SHA512:
-  metadata.gz: 1688a28f9c4c9fa03c78c99d59994508bfa1cec61005751aa2e0b32f5388cec5736557449ae072965ef6448c229e4527bcbee7f53581e2cf47fbf8df72ea8e2f
-  data.tar.gz: aeae4848ecfb0ad258806e42ca4294d5010d0c7cbf5c434914eea8dc29214f1e9c7be11cd1c6c5de0c37683f2efad5ba88a110038ef84415566ed365970697d3
+  metadata.gz: 17fc0b16150395edf3d57daed7893803fd012311620285ad3a57df5330cfb28b1c1eebde904ece4484c5651c203dc27eeeb34f4699d79e6d443954020da23f81
+  data.tar.gz: 67d7d4dd885f70cf4877e72180311545606abc33d8191039c95c9afdcc2d2ef8a081222ab4fa56207e23e7830fa9adda0269444c093d8983e4c227119f9fe82a

data/Makefile

@@ -3,3 +3,4 @@ test:
 	@bin/rspec
 	@bundle exec bin/strong_versions
 	@bin/rubocop
+	@bin/rubocop 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.2'
+gem 'strong_versions', '~> 0.4.0'
 ```
 
 And rebuild your bundle:
@@ -39,7 +39,7 @@ $ bundle install
 
 Or install yourself:
 ```bash
-$ gem install strong_versions -v '0.3.2'
+$ gem install strong_versions -v '0.4.0'
 ```
 
 ## Usage
@@ -54,6 +54,11 @@ The executable will output all non-passing gems and will return an exit code of
 
 ![StrongVersions](doc/images/ci-pipeline.png)
 
+If you are feeling brave, auto-correct is available:
+```bash
+$ bundle exec strong_versions -a
+```
+
 ### Exclusions
 
 <a name="ignore"></a>You can tell _StrongVersions_ to ignore any of your gems (e.g. those that don't follow _semantic versioning_) by adding them to the `ignore` section of `.strong_versions.yml` in your project root, e.g.:

data/bin/strong_versions

@@ -1,14 +1,43 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'shellwords'
 
 require 'strong_versions'
 
+original_args = ARGV.dup
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: strong_versions [options]'
+
+  opts.on('-a', '--auto-correct', 'Auto-correct (use with caution)') do |_v|
+    options[:auto_correct] = true
+  end
+
+  opts.on('--no-auto-correct', 'Disable auto-correct') do |_v|
+    options[:auto_correct] = false
+  end
+end.parse!
+
+def dependencies
+  StrongVersions::DependencyFinder.new.dependencies
+end
+
 config_path = Bundler.root.join('.strong_versions.yml')
 config = StrongVersions::Config.new(config_path)
-dependencies = StrongVersions::DependencyFinder.new.dependencies
-valid = StrongVersions::Dependencies.new(dependencies).validate!(
+validated = StrongVersions::Dependencies.new(dependencies).validate!(
   except: config.exceptions,
-  on_failure: 'warn'
+  on_failure: 'warn',
+  auto_correct: options[:auto_correct]
 )
 
-exit 0 if valid
+if options[:auto_correct]
+  # Re-evaluate
+  args = original_args.map { |arg| Shellwords.escape(arg) }.join(' ')
+  exec "#{$PROGRAM_NAME} #{args} --no-auto-correct"
+end
+
+exit 0 if validated
 exit 1

data/bin/strong_versions.rb

@@ -0,0 +1,35 @@
+require 'optparse'
+
+require 'strong_versions'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: strong_versions [options]"
+
+  opts.on("-a", "--auto-correct", "Auto-correct (use with caution)") do |v|
+    options[:auto_correct] = true
+  end
+end.parse!
+
+def dependencies
+  StrongVersions::DependencyFinder.new.dependencies
+end
+
+config_path = Bundler.root.join('.strong_versions.yml')
+config = StrongVersions::Config.new(config_path)
+validated = StrongVersions::Dependencies.new(dependencies).validate!(
+  except: config.exceptions,
+  on_failure: 'warn',
+  auto_correct: options[:auto_correct]
+)
+
+revalidated = false
+revalidated = StrongVersions::Dependencies.new(dependencies).validate!(
+  except: config.exceptions,
+  on_failure: 'warn',
+  auto_correct: false
+) if options[:auto_correct]
+
+exit 0 if validated or revalidated
+exit 1
+

data/config/locales/en.yml

@@ -13,3 +13,4 @@ en:
       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]"
+    no-suggestion: "[unable to detect installed gem version]"

data/lib/strong_versions.rb

@@ -9,6 +9,7 @@ require 'strong_versions/config'
 require 'strong_versions/dependency'
 require 'strong_versions/dependency_finder'
 require 'strong_versions/dependencies'
+require 'strong_versions/errors'
 require 'strong_versions/suggestion'
 require 'strong_versions/terminal'
 require 'strong_versions/version'

data/lib/strong_versions/dependencies.rb

@@ -11,19 +11,23 @@ module StrongVersions
     end
 
     def validate!(options = {})
+      auto_correct = options.delete(:auto_correct) { false }
       if validate(options)
         summary
         return true
       end
 
+      return update_gemfile if auto_correct
+
       raise_or_warn(options.fetch(:on_failure, 'raise'))
       summary
       false
     end
 
     def validate(options = {})
+      unsafe_autocorrect_error if options[:auto_correct]
       @dependencies.each do |dependency|
-        next if options.fetch(:except).include?(dependency.name)
+        next if options.fetch(:except, []).include?(dependency.name)
         next if dependency.valid?
 
         @invalid_gems.push(dependency) unless dependency.valid?
@@ -33,10 +37,48 @@ module StrongVersions
 
     private
 
+    def unsafe_autocorrect_error
+      raise UnsafeAutoCorrectError, 'Must use #validate! for autocorrect'
+    end
+
     def summary
       @terminal.summary(@dependencies.size, @invalid_gems.size)
     end
 
+    def update_gemfile
+      updated = 0
+      @dependencies.each do |dependency|
+        next unless dependency.updatable?
+
+        updated += 1 if update_dependency(dependency)
+      end
+      @terminal.update_summary(updated)
+    end
+
+    def update_dependency(dependency)
+      path = dependency.gemfile
+      content = File.read(path)
+      update = replace_gem_definition(dependency, content)
+      return false if content == update
+
+      File.write(path, update)
+      @terminal.gem_update(path, dependency)
+      true
+    end
+
+    def replace_gem_definition(dependency, content)
+      regex = gem_regex(dependency.name)
+      match = content.match(regex)
+      return content unless match
+
+      indent = match.captures.first
+      content.gsub(regex, "#{indent}#{dependency.suggested_definition}")
+    end
+
+    def gem_regex(name)
+      /^(\s*)gem\s+['"]#{name}['"].*$/
+    end
+
     def raise_or_warn(on_failure)
       case on_failure
       when 'raise'

data/lib/strong_versions/dependency.rb

@@ -10,9 +10,11 @@ module StrongVersions
       @errors = []
       @lockfile = lockfile || default_lockfile
 
-      versions.each do |operator, version|
-        validate_version(operator, version)
-      end
+      versions.each { |operator, version| validate_version(operator, version) }
+    end
+
+    def gemfile
+      Pathname.new(@dependency.gemfile) if @dependency.respond_to?(:gemfile)
     end
 
     def valid?
@@ -23,16 +25,31 @@ module StrongVersions
       Suggestion.new(lockfile_version)
     end
 
+    def suggested_definition
+      guards = guard_versions.map { |op, version| "'#{op} #{version}'" }
+      "gem '#{@name}', #{[suggestion, *guards].join(', ')}"
+    end
+
     def definition
-      versions.map { |operator, version| "'#{operator} #{version}'" }.join(', ')
+      versions.map do |operator, version|
+        next t('version_not_specified') if operator == '>=' && version == '0'
+
+        "'#{operator} #{version}'"
+      end.join(', ')
+    end
+
+    def updatable?
+      gemfile && !suggestion.missing? && !path_source?
     end
 
     private
 
     def versions
-      @dependency.requirements_list.map do |requirement|
-        parse_version(requirement)
-      end
+      @dependency.requirements_list.map { |version| parse_version(version) }
+    end
+
+    def guard_versions
+      versions.reject { |op, version| redundant?(op, version) }
     end
 
     def parse_version(requirement)
@@ -76,14 +93,25 @@ module StrongVersions
     def check_valid_version(version)
       return if valid_version?(version)
 
-      value = if version == '0'
-                I18n.t('strong_versions.version_not_specified')
-              else
-                version
-              end
+      value = version == '0' ? t('version_not_specified') : version
       @errors << { type: :version, value: value }
     end
 
+    def redundant?(operator, version)
+      return false unless operator.start_with?('>') || pessimistic?(operator)
+
+      multiply_version(version) <= multiply_version(suggestion.version)
+    end
+
+    def multiply_version(version)
+      # Support extremely precise versions e.g. '1.2.3.4.5.6.7.8.9'
+      components = version.split('.').map(&:to_i)
+      components += [0] * (10 - components.size)
+      components.reverse.each_with_index.map do |component, index|
+        component * 10.pow(index + 1)
+      end.sum
+    end
+
     def pessimistic?(operator)
       operator == '~>'
     end
@@ -107,14 +135,8 @@ module StrongVersions
       @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
+    def t(name)
+      I18n.t("strong_versions.#{name}")
     end
   end
 end

data/lib/strong_versions/dependency_finder.rb

@@ -10,6 +10,7 @@ module StrongVersions
 
     def development
       # Gem runtime dependencies are not included here:
+      Bundler.definition.resolve
       Bundler.definition.dependencies
     end
 

data/lib/strong_versions/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class Error < StandardError; end
+  class UnsafeAutoCorrectError < Error; end
+end

data/lib/strong_versions/suggestion.rb

@@ -3,7 +3,11 @@
 module StrongVersions
   class Suggestion
     def initialize(version)
-      @parts = version.split('.') unless version.nil?
+      return if version.nil?
+
+      @parts = version.split('.')
+      # Treat '4.3.2.1' as '4.3.2'
+      @parts.pop if standard?(@parts.first(3)) && @parts.size == 4
     end
 
     def to_s
@@ -12,6 +16,16 @@ module StrongVersions
       "'~> #{version}'"
     end
 
+    def version
+      return nil unless standard?
+
+      major, minor, patch = @parts
+      return "#{major}.#{minor}" if stable?
+      return "#{major}.#{minor}.#{patch}" if unstable?
+
+      raise 'Unexpected condition met'
+    end
+
     def missing?
       return false if stable?
       return false if unstable?
@@ -21,15 +35,6 @@ module StrongVersions
 
     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
@@ -38,12 +43,13 @@ module StrongVersions
       standard? && @parts.first.to_i >= 1
     end
 
-    def standard?
-      return false if @parts.nil?
-      return false unless @parts.size == 3
+    def standard?(parts = @parts)
+      return false if parts.nil?
       return false unless numeric?
+      return true if [2, 3].include?(parts.size)
+      return true if parts.size == 3 && unstable?
 
-      true
+      false
     end
 
     def numeric?

data/lib/strong_versions/terminal.rb

@@ -7,7 +7,27 @@ module StrongVersions
     end
 
     def warn(string)
-      puts(color(string, :underline, :bright, :red))
+      puts(color(string, :bright, :red))
+    end
+
+    def gem_update(path, gem)
+      relpath = path.relative_path_from(Pathname.new(Dir.pwd))
+      output = [
+        color("[#{relpath}] ", :cyan),
+        color(gem.suggested_definition, :green),
+        color(' (was: ', :default),
+        color(gem.definition, :red),
+        color(')', :default)
+      ].join
+      puts(output)
+    end
+
+    def update_summary(updated)
+      output = [
+        "#{updated} gem definitions ",
+        color('updated', :green)
+      ].join
+      puts("\n#{output}")
     end
 
     def summary(count, failed)
@@ -67,13 +87,15 @@ module StrongVersions
 
     def suggestion(gem)
       suggested = '  ' + t('errors.suggested')
-      puts(
-        color(
-          "#{suggested} %{suggestion}",
-          :default,
-          suggestion: [gem.suggestion.to_s, :green]
-        )
-      )
+      puts(color("#{suggested}%{suggestion}", :default,
+                 suggestion: suggestion_definition(gem)))
+    end
+
+    def suggestion_definition(gem)
+      unidentified = gem.suggestion.to_s.empty?
+      return [t('no-suggestion'), :yellow] if unidentified
+
+      [gem.suggestion.to_s, :green]
     end
 
     def name_and_definition(gem)

data/lib/strong_versions/version.rb

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

data/strong_versions.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'strong_versions'
   spec.version       = StrongVersions::VERSION
   spec.authors       = ['Bob Farrell']
-  spec.email         = ['robertanthonyfarrell@gmail.com']
+  spec.email         = ['oss@bob.frl']
 
   spec.summary       = 'Enforce strict versioning on your Gemfile'
   spec.description   = 'Ensure your gems are appropriately versioned'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -138,7 +138,7 @@ dependencies:
         version: 0.60.0
 description: Ensure your gems are appropriately versioned
 email:
-- robertanthonyfarrell@gmail.com
+- oss@bob.frl
 executables:
 - strong_versions
 extensions: []
@@ -161,6 +161,7 @@ files:
 - bin/rubocop
 - bin/setup
 - bin/strong_versions
+- bin/strong_versions.rb
 - config/locales/en.yml
 - doc/images/ci-pipeline.png
 - doc/images/strong-versions-example.png
@@ -169,6 +170,7 @@ files:
 - lib/strong_versions/dependencies.rb
 - lib/strong_versions/dependency.rb
 - lib/strong_versions/dependency_finder.rb
+- lib/strong_versions/errors.rb
 - lib/strong_versions/suggestion.rb
 - lib/strong_versions/terminal.rb
 - lib/strong_versions/version.rb