smarter_bundler 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fbba5a723688fabe832cd0ae312cb05a512185c
+  data.tar.gz: d8c649cad25c8f219b93065b8b508ac299fc88c7
+SHA512:
+  metadata.gz: 3212fd4edcbc6064e82011b0b3d507334bc97323382ebe36dba899d48d8a87da94bfa8b409494012787b81618fe79501a47121e25d28486e9fad65a4230e0fbc
+  data.tar.gz: 6d3b40270cb45dc82afcb393ff3c5281aff40eef1f20b3153050ee80bd4a92eeb8c029d75f4f007b09fbe0ce78cc06f589e6e0623cebfd4a7eeb0a38c328b23d

data/.gitignore

@@ -8,6 +8,6 @@ Gemfile.lock
 /pkg/
 /spec/reports/
 /tmp/
-/test/rails*/.bundle
-/test/rails*/Gemfile
-/test/rails*/Gemfile.lock
+/test/*/.bundle
+/test/*/Gemfile
+/test/*/Gemfile.lock

data/README.md

@@ -22,12 +22,30 @@ A reasonable limit would be four to ten times the time it normally takes to inst
 Once you hit that limit, then check your install log and incorporate the fixes it has found into your Gemfile
 source to remove the need for it to run bundler multiple times whilst it fixes the Gemfile.
 
+### Cleaning up afterwards
+
+After smarter_bundle has updated the Gemfile, you should examine the changes, as some adjustments may be in order:
+1. If a gem is not already referenced in the Gemfile, then look in Gemfile.lock for the gems that depend on it and place the new line in the same group as the related gems;
+2. smarter_bundle does not backtrack and recheck earlier adjustments - this may result in a gem being restricted that is no longer needed because the gem that originally needed ended up being restricted to the point it no longer has so many prerequisites. In the Gemfile.lock you will see that the gem is not required by any other gems, nor was it a gem you directly need.
+3. smarter_bundle does not know how to handle Gemfiles that are intended to be used with multiple ruby versions, so you will need to make a Gemfile that is intended for the ruby version you are checking it with and then incorporate the changes smarter_bundle makes back into the master Gemfile manually;
+
+### Using in test scripts
+
+If for some reason you do not use Gemfile.lock in automated testing (eg when testing gems with travis-ci), and you are testing against older ruby versions, then you may wish to consider using
+smarter_bundler - instead of the test script failing, smarter_bundler will update the Gemfile on the fly. Of course you are swapping processing time for convienience,
+so you should implement a time limit and manually update your Gemfile once the tests slow down too much.
+
+I usually prefer to fail fast and fix it then and there rather than delay the issue, but sometimes delaying failure till later when it can be worked around is appropriate.
+
 ## Notes
 
-If the error indicates a ruby version conflict, then it will lookup the gem on rubygems to find the earliest version with the same ruby spec
+If the error indicates a ruby version conflict,
+then it will lookup the gem on rubygems to find the earliest version with the same ruby spec
 and update the Gemfile to specify a version prior to that. If the lookup of rubygems fails, then it will simply check the next earlier version.
 
-If the error was not from a ruby version conflict, it will attempt to install the gem directly once more.
+Syntax errors will trigger smarter_bundle to try the immediately earlier version, without looking up rubygems, because a syntax error indicates the gemspec doesn't correctly specify the required ruby versions.
+
+If the error was not from a ruby version conflict or syntax error, it will attempt to install the gem directly once more.
 
 It will attempt to fix the Gemfile up to 100 times before giving up as long as each attempt is making progress.
 

data/Vagrantfile

@@ -9,7 +9,11 @@ Vagrant.configure("2") do |config|
   # provision with a shell script.
   config.vm.provision "shell",
     path: "https://raw.githubusercontent.com/ianheggie/provision_vagrant/master/provision?cache_bust=#{Process.pid}",
-    args: %w{ /vagrant }
+    args: %w{ /vagrant /vagrant/test/rails30 /vagrant/test/rails31 /vagrant/test/rails32 /vagrant/test/rails40
+              /vagrant/test/rails41 /vagrant/test/rails42 /vagrant/test/rails50 /vagrant/test/rails51
+              /vagrant/test/special_cases }
+
+
 
   # Stop nagging as this box changes daily...
   config.vm.box_check_update = true

data/bin/test

@@ -6,30 +6,30 @@ ruby_version=`ruby -e 'puts RUBY_VERSION'`
 psych_ver='< 3.0'
 case "$ruby_version" in
 1.8.7)
-        dirs='rails30 rails31 rails32'
+        dirs='rails30 rails31 rails32 special_cases'
         psych_ver=''
         ;;
 1.9.2)
-        dirs='rails30 rails31 rails32'
+        dirs='rails30 rails31 rails32 special_cases'
         ;;
 1.9.3)
-        dirs='rails30 rails31 rails32 rails40 rails41 rails42'
+        dirs='rails30 rails31 rails32 rails40 rails41 rails42 special_cases'
         ;;
 2.0*)
-        dirs='rails32 rails40 rails41 rails42'
+        dirs='rails32 rails40 rails41 rails42 special_cases'
         ;;
 2.1*)
-        dirs='rails41 rails42'
+        dirs='rails41 rails42 special_cases'
         ;;
 2.2.[01]*)
-        dirs='rails42'
+        dirs='rails42 special_cases'
         ;;
 2.2.2)
-        dirs='rails32 rails42 rails50 rails51'
+        dirs='rails32 rails42 rails50 rails51 special_cases'
         psych_ver='> 2.0'
         ;;
-2.2.[2-9]*|2.[3-9]*)
-        dirs='rails50 rails51'
+2.2.[2-9]*|2.[3-9]*|[3-9]*)
+        dirs='rails50 rails51 special_cases'
         gem install psych
         psych_ver='> 2.0'
         ;;
@@ -62,7 +62,7 @@ do
           rm -f Gemfile.lock
           cp -f Gemfile.default Gemfile
           # Exclude debugger - it breaks for many varied reasons on travis
-          ../../exe/smarter_bundle  --without debug
+          ../../exe/smarter_bundle --aggressive install --no-color --verbose --without debug
           echo Gemfile changes:
           diff Gemfile.default Gemfile
           echo

data/exe/smarter_bundle

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
 
 require 'smarter_bundler'
 
-SmarterBundler::Bundle.new.run ARGV.join(' ')
+SmarterBundler::Bundle.new.run ARGV

data/lib/smarter_bundler/bundle.rb

@@ -8,18 +8,20 @@ module SmarterBundler
   class Bundle
     include SmarterBundler::Shell
 
-    KNOWN_ISSUES_187_192 = {
+    # Note the versions listed in KNOWN_SOLUTIONS are the first NON working version
+    # for the first ruby version listed (eg 1.8.7, 1.9.3, 2.2.2)
+
+    KNOWN_SOLUTIONS_187_192 = {
         'unicorn' => '5.0',
         'nokogiri' => '1.6.0',
         'jbuilder' => '2.0.0',
         'factory_girl' => '3.0',
         'factory_bot' => '3.0',
+        'listen' => '3.1.2',
+        'css_parser' => '1.4.8',  # syntax error
     }
 
-    KNOWN_ISSUES_193_221 = {
-    }
-
-    KNOWN_ISSUES_222_22x = {
+    KNOWN_SOLUTIONS_193_221 = {
         'listen' => '3.1.2',
         'acts-as-taggable-on' => '5.0.0',
         'guard-rails' => '0.7.3',
@@ -27,13 +29,30 @@ module SmarterBundler
         'ruby_dep' => '1.4.0',
     }
 
+    KNOWN_SOLUTIONS_222_22x = {
+    }
+
 
     def run(bundle_args)
+      @aggressive = bundle_args.first == '--aggressive'
+      if @aggressive
+        bundle_args = bundle_args.drop(1)
+      end
       puts 'Smarter Bundler will recursively install your gems and output the successful bundler output. This may take a while.'
       count = 0
       gemfile = SmarterBundler::Gemfile.new
       previous_failure = []
       result = nil
+      if @aggressive
+        known_solutions.each do |gem, version|
+          if gemfile.mentions? gem
+            gemfile.restrict_gem_version(gem, version)
+            count += 1
+          end
+        end
+        puts "Made #{count} adjustments in Gemfile based on known solutions" if count > 0
+      end
+
       while count < 100
         result = call_bundle(bundle_args)
         failed_gem_and_version = parse_output(result)
@@ -44,15 +63,15 @@ module SmarterBundler
           end
           previous_failure = failed_gem_and_version
           gem, version = *failed_gem_and_version
-          if !ruby_version_clash(result) && install_failed_gem(gem, version)
-            puts 'Retrying seems to have fixed the problem'
-          elsif gemfile.restrict_gem_version(gem, known_issues(gem))
+          if gemfile.restrict_gem_version(gem, known_solution(gem))
             gemfile.save
             count += 1
-          elsif ruby_version_clash(result) && gemfile.restrict_gem_version(gem, rubygems_earlier_version(gem, version))
+          elsif !fatal_error(result) && install_failed_gem(gem, version)
+              puts 'Retrying seems to have fixed the problem'
+          elsif ruby_version_error(result) && gemfile.restrict_gem_version(gem, rubygems_earlier_version(gem, version))
             gemfile.save
             count += 1
-          elsif ruby_version_clash(result) && gemfile.restrict_gem_version(gem, version)
+          elsif fatal_error(result) && gemfile.restrict_gem_version(gem, version)
             gemfile.save
             count += 1
           else
@@ -68,26 +87,38 @@ module SmarterBundler
     end
 
     def call_bundle(bundle_args)
-      shell "bundle #{bundle_args}"
+      shell "bundle #{bundle_args.join(' ')} && ruby -e 'puts \"Checking gems can be loaded ...\" ; require \"rubygems\" ; require \"bundler/setup\" ; Bundler.require(:default) ; puts \"PASSED GEM LOAD TEST\" ' "
     end
 
     def install_failed_gem(gem, version)
       shell? "gem install '#{gem}' -v '#{version}'"
     end
 
-    def ruby_version_clash(result)
+    def fatal_error(result)
+      ruby_version_error(result)  || syntax_error(result)
+    end
+
+    def ruby_version_error(result)
       result.output.select { |l| l =~ /requires Ruby version/ }.any?
     end
 
-    def known_issues(gem)
+    def syntax_error(result)
+      result.output.select { |l| l =~ /(: syntax error|SyntaxError: )/ }.any?
+    end
+
+    def known_solution(gem)
+      known_solutions[gem]
+    end
+
+    def known_solutions
       if RUBY_VERSION <= '1.9.2'
-        KNOWN_ISSUES_187_192[gem]
+        KNOWN_SOLUTIONS_187_192
       elsif RUBY_VERSION <= '2.2.1'
-        KNOWN_ISSUES_193_221[gem]
+        KNOWN_SOLUTIONS_193_221
       elsif RUBY_VERSION <= '2.3'
-        KNOWN_ISSUES_222_22x[gem]
+        KNOWN_SOLUTIONS_222_22x
       else
-        nil
+        { }
       end
     end
 
@@ -95,6 +126,10 @@ module SmarterBundler
       result.output.each do |line|
         if line =~ /Make sure that `gem install (\S+) -v '(\S+)'`/
           return [$1, $2]
+        elsif line =~ %r{SyntaxError: .*/ruby/[^/]*/gems/([^/]*)-(\d[^/]+)/}
+            return [$1, $2]
+        elsif line =~ %r{/ruby/[^/]*/gems/([^/]*)-(\d[^/]+)/\S+:\d+: syntax error}
+          return [$1, $2]
         end
       end
       nil

data/lib/smarter_bundler/gemfile.rb

@@ -14,9 +14,13 @@ module SmarterBundler
       @changed = false
     end
 
+    def mentions? gem
+      @contents.select { |line| line =~ /^\s*gem\s+['"]#{gem}['"]/ }.any?
+    end
+
     def restrict_gem_version gem, version_limit
       return false unless version_limit.to_s =~ /\d\.\d/
-      if @contents.select { |line| line =~ /^\s*gem\s+['"]#{gem}['"]/ }.empty?
+      if ! mentions? gem
         @contents << "gem '#{gem}', '>=0'"
       end
       adjusted = false

data/lib/smarter_bundler/shell.rb

@@ -3,7 +3,7 @@ module SmarterBundler
     def shell(command)
       puts '', "+ #{command}"
       output = []
-      IO.popen("#{command} 2>&1") do |io|
+      IO.popen("( #{command} ) 2>&1 < /dev/null") do |io|
         while line = io.gets
           puts line.chomp
           output << line.chomp

data/lib/smarter_bundler/version.rb

@@ -1,3 +1,3 @@
 module SmarterBundler
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,81 +1,69 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: smarter_bundler
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Ian Heggie
 autorequire: 
 bindir: exe
 cert_chain: []
-
-date: 2018-03-14 00:00:00 +11:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 1
-        - 16
-        version: "1.16"
-  prerelease: false
-  type: :development
-  requirement: *id001
+date: 2018-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 10
-        - 0
-        version: "10.0"
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
   type: :development
-  requirement: *id002
-  name: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 5
-        - 0
-        version: "5.0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  requirement: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   name: minitest
-description: The smarter_bundle retries installing gems, and if that fails it tries installing an earlier version by adjusting the Gemfile
-email: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: The smarter_bundle retries installing gems, and if that fails it tries
+  installing an earlier version by adjusting the Gemfile
+email:
 - ian@heggie.biz
-executables: 
+executables:
 - smarter_bundle
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .ruby-versions
-- .travis.yml
+files:
+- ".gitignore"
+- ".ruby-versions"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -92,39 +80,28 @@ files:
 - lib/smarter_bundler/shell.rb
 - lib/smarter_bundler/version.rb
 - smarter_bundler.gemspec
-has_rdoc: true
 homepage: https://github.com/ianheggie/smarter_bundler
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Enhances bundler by adjusting Gemfile when correctable errors are found
 test_files: []
-