strong_versions 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f73f7623edb5e3a662b18ea78cd67822dfdbcc81bd6eb0e9332e80bd1eda57c6
-  data.tar.gz: 9ed40edc5e76826e6458848fadd2b92a5b9f0985cefa0a3e56943c176e32edbb
+  metadata.gz: 3a6f079070e66cd3ed6ce44e528fac54f1c3c8b0d997b4bf4c8a7d91a0eddeb8
+  data.tar.gz: 2e013a9ff3016707b445a77b18a42f9e84c3b0f8f2235f2f6216ecd6fab0309e
 SHA512:
-  metadata.gz: 17fc0b16150395edf3d57daed7893803fd012311620285ad3a57df5330cfb28b1c1eebde904ece4484c5651c203dc27eeeb34f4699d79e6d443954020da23f81
-  data.tar.gz: 67d7d4dd885f70cf4877e72180311545606abc33d8191039c95c9afdcc2d2ef8a081222ab4fa56207e23e7830fa9adda0269444c093d8983e4c227119f9fe82a
+  metadata.gz: c067dd53846c4b49e7104c11744569703b20c26b50c1de29a2fb7810889945939fe5d70f869f480d52851c28ac1c821541ace4e03c57e6fb09eb0ae15c9a0a05
+  data.tar.gz: 07f2665d5a01d9cc0686f7faf4990536a1151f630dbaeadbbb029a73f3dad5d956c255370938640b2e69aeda4db03845640da0a7bb9b883578cc6a19d4d96d27

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.4.0'
+gem 'strong_versions', '~> 0.4.1'
 ```
 
 And rebuild your bundle:
@@ -39,7 +39,7 @@ $ bundle install
 
 Or install yourself:
 ```bash
-$ gem install strong_versions -v '0.4.0'
+$ gem install strong_versions -v '0.4.1'
 ```
 
 ## Usage

data/lib/strong_versions.rb

@@ -10,8 +10,8 @@ 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/gem_version'
 require 'strong_versions/version'
 
 module StrongVersions

data/lib/strong_versions/dependency.rb

@@ -21,25 +21,25 @@ module StrongVersions
       @errors.empty?
     end
 
-    def suggestion
-      Suggestion.new(lockfile_version)
+    def suggested_version
+      GemVersion.new(GemVersion.new(lockfile_version).version_string)
     end
 
     def suggested_definition
       guards = guard_versions.map { |op, version| "'#{op} #{version}'" }
-      "gem '#{@name}', #{[suggestion, *guards].join(', ')}"
+      "gem '#{@name}', #{[suggested_version.suggestion, *guards].join(', ')}"
     end
 
     def definition
       versions.map do |operator, version|
-        next t('version_not_specified') if operator == '>=' && version == '0'
+        next t('version_not_specified') if operator == '>=' && version.zero?
 
         "'#{operator} #{version}'"
       end.join(', ')
     end
 
     def updatable?
-      gemfile && !suggestion.missing? && !path_source?
+      gemfile && !suggested_version.missing? && !path_source?
     end
 
     private
@@ -54,13 +54,13 @@ module StrongVersions
 
     def parse_version(requirement)
       operator, version_obj = Gem::Requirement.parse(requirement)
-      [operator, version(version_obj)]
+      [operator, GemVersion.new(version_obj)]
     end
 
     def lockfile_version
       @lockfile_version ||= begin
         gem_spec = @lockfile.specs.find { |spec| spec.name == @name }
-        gem_spec.nil? ? nil : version(gem_spec.version)
+        gem_spec.nil? ? nil : gem_spec.version
       end
     end
 
@@ -68,14 +68,6 @@ module StrongVersions
       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)
       return if path_source?
       return if any_valid?
@@ -91,41 +83,34 @@ module StrongVersions
     end
 
     def check_valid_version(version)
-      return if valid_version?(version)
+      return if version.valid?
 
-      value = version == '0' ? t('version_not_specified') : version
+      value = version.zero? ? t('version_not_specified') : version
       @errors << { type: :version, value: value }
     end
 
     def redundant?(operator, version)
-      return false unless operator.start_with?('>') || pessimistic?(operator)
+      return true if pessimistic?(operator)
+      return false if guard_needed?(operator, version)
 
-      multiply_version(version) <= multiply_version(suggestion.version)
+      true
     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
+    def guard_needed?(operator, version)
+      return false unless %w[< <= > >=].include?(operator)
+      return true if %(< <=).include?(operator) && suggested_version < version
+      return true if %(> >=).include?(operator) && suggested_version < version
+
+      false
     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)
+        pessimistic?(operator) && version.valid?
       end
     end
 

data/lib/strong_versions/gem_version.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module StrongVersions
+  class GemVersion
+    def initialize(version)
+      @version = normalize(version) || ''
+      @parts = @version&.split('.')
+    end
+
+    def to_s
+      @version
+    end
+
+    def zero?
+      @version == '0'
+    end
+
+    def suggestion
+      return '' if version_string.empty?
+
+      "'~> #{version_string}'"
+    end
+
+    def version_string
+      return '' unless standard?
+
+      major, minor, patch = @parts
+      return "#{major}.#{minor}" if stable?
+      return "#{major}.#{minor}.#{patch}" if unstable?
+
+      raise 'Unexpected condition met'
+    end
+
+    def <(other)
+      numeric < other.numeric
+    end
+
+    def <=(other)
+      numeric <= other.numeric
+    end
+
+    def >(other)
+      numeric > other.numeric
+    end
+
+    def >=(other)
+      numeric >= other.numeric
+    end
+
+    def numeric
+      # 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 valid?
+      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 missing?
+      return false if stable?
+      return false if unstable?
+
+      true
+    end
+
+    private
+
+    def normalize(version)
+      # Ruby >= 2.3.0: `version_obj` is a `Gem::Version`
+      return version.version.to_s if version.respond_to?(:version)
+
+      # Ruby < 2.3.0: `version_obj` is a `String`
+      version
+    end
+
+    def unstable?
+      standard? && @parts.first.to_i.zero?
+    end
+
+    def stable?
+      standard? && @parts.first.to_i >= 1
+    end
+
+    def standard?(parts = @parts)
+      return false if parts.nil?
+      return false unless numeric?
+      return true if [2, 3, 4].include?(parts.size)
+      return true if parts.size == 3
+
+      false
+    end
+
+    def numeric?
+      @parts.all? { |part| part =~ /\A[0-9]+\Z/ }
+    end
+  end
+end

data/lib/strong_versions/terminal.rb

@@ -77,10 +77,9 @@ module StrongVersions
         type = t("errors.#{error[:type]}")
         color(
           '  %{type} %{example}, found: %{found}',
-          :default,
-          type: [type, :default],
-          example: example(error[:type]),
-          found: [error[:value], :red]
+          :default, type: [type, :default],
+                    example: example(error[:type]),
+                    found: [error[:value], :red]
         )
       end
     end
@@ -92,10 +91,11 @@ module StrongVersions
     end
 
     def suggestion_definition(gem)
-      unidentified = gem.suggestion.to_s.empty?
+      version = gem.suggested_version.suggestion
+      unidentified = version.empty?
       return [t('no-suggestion'), :yellow] if unidentified
 
-      [gem.suggestion.to_s, :green]
+      [version, :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.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Bob Farrell
@@ -171,7 +171,7 @@ files:
 - lib/strong_versions/dependency.rb
 - lib/strong_versions/dependency_finder.rb
 - lib/strong_versions/errors.rb
-- lib/strong_versions/suggestion.rb
+- lib/strong_versions/gem_version.rb
 - lib/strong_versions/terminal.rb
 - lib/strong_versions/version.rb
 - strong_versions.gemspec

data/lib/strong_versions/suggestion.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module StrongVersions
-  class Suggestion
-    def initialize(version)
-      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
-      return version.to_s if version.nil?
-
-      "'~> #{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?
-
-      true
-    end
-
-    private
-
-    def unstable?
-      standard? && @parts.first.to_i.zero?
-    end
-
-    def stable?
-      standard? && @parts.first.to_i >= 1
-    end
-
-    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?
-
-      false
-    end
-
-    def numeric?
-      @parts.all? { |part| part =~ /\A[0-9]+\Z/ }
-    end
-  end
-end