strong_versions 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8013eab29eed756e82642806ffa493cdfe95b811a04cbf1a8671f438a7d941
-  data.tar.gz: 99d19f00b86a8499cac020279583a32da2a14f3639eeb7036df0338113c60f83
+  metadata.gz: a19f2c731b09de210cb242a54ed087493741010a84fd98324a42834bfffb32f3
+  data.tar.gz: 07fde31789f1c729ede0859404cf5574c20566b3fc2e7e152cc7ee62d45a3d8c
 SHA512:
-  metadata.gz: '047964e0861c334509ae41809d5b57ee2cc0f412223148d374d2008ecca64db6ca4eca7df9ebe2d579dcdfc4d988c1d141642b766a47d701ebb866cb281fab01'
-  data.tar.gz: 48268429b4da20105b90fd3671488180753550f4776467d77e3de0d8c761295b767cd2502a61d99330830a95efde09c129ba9f7e615a2f18e783c885093daf7e
+  metadata.gz: 48f230820ee7ebe3e69c6f4e938a01ef12288d6b624869cddf9905701cd2aaeefd3797cd499ea667dd7816182140688bbf3b6a07019e24cea2bd2a98c8b53c28
+  data.tar.gz: 129dcaae26d6d8546e52dc7384bbd4ddac4879750399d158517b27198a1fc31a2424566322d343f4959a252dea196a809a26e1acd7fcc63628809d07b157c099

data/.rubocop.yml

@@ -11,4 +11,8 @@ Style/FormatStringToken:
     - 'lib/strong_versions/terminal.rb'
 AllCops:
   Exclude:
-    - 'bin/**/*'
+    - 'bin/rake'
+    - 'bin/console'
+    - 'bin/rspec'
+    - 'bin/rubocop'
+    - 'bin/setup'

data/Makefile

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

data/README.md

@@ -13,13 +13,13 @@ _StrongVersions_ 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.6.7' # Bug introduced in 8.6.7`
+* A lower/upper bound can be specified as long as a valid pessimistic version is also specified, e.g. `'~> 8.4', '< 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 be included in included in the _StrongVersions_ output with details on why they did not meet the standard.
+Any gems that do not satisfy these rules will be included in the _StrongVersions_ output with details on why they did not meet the standard.
 
-The benefit of applying this standard is that, if all gems follow [Semantic Versioning](https://semver.org/) always be relatively safe to run `bundle update` to upgrade to the latest compatible versions of all dependencies. Running `bundle update` often brings advantages both in terms of bug fixes and security updates.
+When all gems in a `Gemfile` follow this convention it SHOULD always be safe to run `bundle update` (assuming all gems adhere to [Semantic Versioning](https://semver.org/)).
 
 ![StrongVersions](doc/images/strong-versions-example.png)
 
@@ -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.2'
+gem 'strong_versions', '~> 0.4.3'
 ```
 
 And rebuild your bundle:
@@ -39,7 +39,7 @@ $ bundle install
 
 Or install yourself:
 ```bash
-$ gem install strong_versions -v '0.4.2'
+$ gem install strong_versions -v '0.4.3'
 ```
 
 ## Usage

data/bin/strong_versions

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'bundler/setup'
 require 'optparse'
 require 'shellwords'
 
@@ -12,11 +13,11 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = 'Usage: strong_versions [options]'
 
-  opts.on('-a', '--auto-correct', 'Auto-correct (use with caution)') do |_v|
+  opts.on('-a', '--auto-correct', 'Auto-correct (use with caution)') do
     options[:auto_correct] = true
   end
 
-  opts.on('--no-auto-correct', 'Disable auto-correct') do |_v|
+  opts.on('--no-auto-correct', 'Disable auto-correct') do
     options[:auto_correct] = false
   end
 end.parse!

data/bin/strong_versions.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 require 'strong_versions'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: strong_versions [options]"
+  opts.banner = 'Usage: strong_versions [options]'
 
-  opts.on("-a", "--auto-correct", "Auto-correct (use with caution)") do |v|
+  opts.on('-a', '--auto-correct', 'Auto-correct (use with caution)') do |_v|
     options[:auto_correct] = true
   end
 end.parse!
@@ -24,12 +26,13 @@ validated = StrongVersions::Dependencies.new(dependencies).validate!(
 )
 
 revalidated = false
-revalidated = StrongVersions::Dependencies.new(dependencies).validate!(
-  except: config.exceptions,
-  on_failure: 'warn',
-  auto_correct: false
-) if options[:auto_correct]
+if options[:auto_correct]
+  revalidated = StrongVersions::Dependencies.new(dependencies).validate!(
+    except: config.exceptions,
+    on_failure: 'warn',
+    auto_correct: false
+  )
+end
 
-exit 0 if validated or revalidated
+exit 0 if validated || revalidated
 exit 1
-

data/lib/strong_versions.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'pathname'
 require 'yaml'
 
 require 'i18n'

data/lib/strong_versions/dependencies.rb

@@ -17,7 +17,7 @@ module StrongVersions
         return true
       end
 
-      return update_gemfile if auto_correct
+      return update_definitions if auto_correct
 
       raise_or_warn(options.fetch(:on_failure, 'raise'))
       summary
@@ -45,38 +45,50 @@ module StrongVersions
       @terminal.summary(@dependencies.size, @invalid_gems.size)
     end
 
-    def update_gemfile
-      updated = 0
-      @dependencies.each do |dependency|
-        next unless dependency.updatable?
+    def updatable_dependencies
+      @dependencies.select(&:updatable?)
+    end
+
+    def update_definitions
+      @terminal.update_summary(update(:gemfile) + update(:gemspec))
+    end
+
+    def update(subject)
+      updatable_dependencies.reduce(0) do |count, dependency|
+        next count unless dependency.updatable?
 
-        updated += 1 if update_dependency(dependency)
+        update_dependency(subject, dependency) ? count : count + 1
       end
-      @terminal.update_summary(updated)
     end
 
-    def update_dependency(dependency)
-      path = dependency.gemfile
+    def update_dependency(subject, dependency)
+      path = dependency.public_send(subject)
+      return if path.nil?
+
       content = File.read(path)
-      update = replace_gem_definition(dependency, content)
+      update = replace_gem_definition(subject, dependency, content)
       return false if content == update
 
       File.write(path, update)
-      @terminal.gem_update(path, dependency)
+      @terminal.gem_update(path, dependency, subject)
       true
     end
 
-    def replace_gem_definition(dependency, content)
-      regex = gem_regex(dependency.name)
+    def replace_gem_definition(subject, dependency, content)
+      regex = gem_regex(subject, dependency.name)
       match = content.match(regex)
       return content unless match
 
       indent = match.captures.first
-      content.gsub(regex, "#{indent}#{dependency.suggested_definition}")
+      definition = dependency.suggested_definition(subject)
+      content.gsub(regex, "#{indent}#{definition}")
     end
 
-    def gem_regex(name)
-      /^(\s*)gem\s+['"]#{name}['"].*$/
+    def gem_regex(subject, name)
+      {
+        gemfile: /^(\s*)gem\s+['"]#{name}['"].*$/,
+        gemspec: /^(\s*)spec.add_[a-z_]*_dependency\s+['"]#{name}['"].*$/
+      }.fetch(subject)
     end
 
     def raise_or_warn(on_failure)

data/lib/strong_versions/dependency.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module StrongVersions
+  # rubocop:disable Metrics/ClassLength
   class Dependency
     attr_reader :name, :errors
 
@@ -17,6 +18,10 @@ module StrongVersions
       Pathname.new(@dependency.gemfile) if @dependency.respond_to?(:gemfile)
     end
 
+    def gemspec
+      Pathname.new(gemspec_path) unless gemspec_path.nil?
+    end
+
     def valid?
       @errors.empty?
     end
@@ -25,9 +30,10 @@ module StrongVersions
       GemVersion.new(GemVersion.new(lockfile_version).version_string)
     end
 
-    def suggested_definition
+    def suggested_definition(subject = :gemfile)
       guards = guard_versions.map { |op, version| "'#{op} #{version}'" }
-      "gem '#{@name}', #{[suggested_version.suggestion, *guards].join(', ')}"
+      constraints = [suggested_version.suggestion, *guards].join(', ')
+      send(:"suggested_#{subject}_definition", constraints)
     end
 
     def definition
@@ -39,11 +45,38 @@ module StrongVersions
     end
 
     def updatable?
-      !valid? && gemfile && !suggested_version.missing? && !path_source?
+      !valid? && !suggested_version.missing? && !path_source?
     end
 
     private
 
+    def gemspec_path
+      _spec, path = gemspec_dependency
+      path
+    end
+
+    def gemspec_spec
+      spec, _path = gemspec_dependency
+      spec
+    end
+
+    def gemspec_dependency
+      DependencyFinder.new.gemspec_dependencies.each do |path, specs|
+        specs.each do |spec|
+          return [spec, path] if spec.name == @dependency.name
+        end
+      end
+      nil
+    end
+
+    def suggested_gemspec_definition(constraints)
+      "spec.add_#{gemspec_spec.type}_dependency '#{@name}', #{constraints}"
+    end
+
+    def suggested_gemfile_definition(constraints)
+      "gem '#{@name}', #{constraints}"
+    end
+
     def versions
       @dependency.requirements_list.map { |version| parse_version(version) }
     end
@@ -124,4 +157,5 @@ module StrongVersions
       I18n.t("strong_versions.#{name}")
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/strong_versions/dependency_finder.rb

@@ -6,6 +6,12 @@ module StrongVersions
       development + runtime
     end
 
+    def gemspec_dependencies
+      Hash[gemspecs.compact.map do |gemspec|
+        [gemspec.loaded_from, dependencies]
+      end]
+    end
+
     private
 
     def development

data/lib/strong_versions/terminal.rb

@@ -10,14 +10,14 @@ module StrongVersions
       puts(color(string, :bright, :red))
     end
 
-    def gem_update(path, gem)
+    def gem_update(path, gem, subject)
       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)
+        color('[', :cyan),
+        color(relpath.to_s, :green),
+        color('] ', :cyan),
+        color('updated: ', :default),
+        color(gem.suggested_definition(subject), :green)
       ].join
       puts(output)
     end

data/lib/strong_versions/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_versions
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-26 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n