bundler-auto-update 0.0.3 → 0.0.4

data/lib/bundler_auto_update.rb

@@ -11,6 +11,7 @@ module Bundler
         Updater.new(test_command).auto_update!
       end
 
+      # @return [String] Test command from @argv
       def test_command
         if @argv.first == '-c'
           @argv[1..-1].join(' ')
@@ -33,6 +34,8 @@ module Bundler
         end
       end
 
+      private
+
       def gemfile
         @gemfile ||= Gemfile.new
       end
@@ -45,6 +48,7 @@ module Bundler
         @gem, @gemfile, @test_command = gem, gemfile, test_command
       end
 
+      # Attempt to update to patch, then to minor then to major versions.
       def auto_update
         if updatable?
           Logger.log "Updating #{gem.name}"
@@ -54,6 +58,10 @@ module Bundler
         end
       end
 
+      # Update current gem to latest :version_type:, run test suite and commit new Gemfile
+      # if successful.
+      #
+      # @param version_type :patch or :minor or :major
       # @return [Boolean] true on success or when already at latest version
       def update(version_type)
         new_version = gem.last_version(version_type)
@@ -68,11 +76,19 @@ module Bundler
 
         gem.version = new_version
 
-        (update_gemfile and run_test_suite and commit_new_version) or revert_to_previous_version
+        if update_gemfile and run_test_suite and commit_new_version
+          true
+        else
+          revert_to_previous_version
+          false
+        end
       end
 
       private
 
+      # Update gem version in Gemfile.
+      #
+      # @return true on success, false on failure.
       def update_gemfile
         if gemfile.update_gem(gem) 
           Logger.log_indent "Gemfile updated successfully."
@@ -83,6 +99,7 @@ module Bundler
         end
       end
 
+      # @return true on success, false on failure
       def run_test_suite
         Logger.log_indent "Running test suite"
         if CommandRunner.system test_command
@@ -94,8 +111,9 @@ module Bundler
         end
       end
 
+      # @return true when the gem has a fixed version.
       def updatable?
-        gem.version =~ /^\d+\.\d+\.\d+$/ && gem.options.nil?
+        gem.version =~ /^\d+\.\d+\.\d+$/
       end
 
       def commit_new_version
@@ -108,10 +126,13 @@ module Bundler
         CommandRunner.system "git checkout Gemfile Gemfile.lock"
         gemfile.reload!
       end
-    end # class Updater
+    end # class GemUpdater
 
     class Gemfile
 
+      # Regex that matches a gem definition line.
+      #
+      # @return [RegEx] matching [_, name, _, version, _, options]
       def gem_line_regex(gem_name = '(\w+)')
         /^\s*gem\s*['"]#{gem_name}['"]\s*(,\s*['"](.+)['"])?\s*(,\s*(.*))?\n?$/
       end
@@ -130,15 +151,17 @@ module Bundler
         gems
       end
 
-      # @todo spec
+      # Update Gemfile and run 'bundle update'
       def update_gem(gem)
         update_content(gem) and write and run_bundle_update(gem)
       end
 
+      # @return [String] Gemfile content
       def content
         @content ||= read
       end
 
+      # Reload Gemfile content
       def reload!
         @content = read
       end
@@ -158,16 +181,23 @@ module Bundler
         @content = new_content
       end
 
+      # @return [String] Gemfile content read from filesystem
       def read
         File.read('Gemfile')
       end
 
+      # Write content to Gemfile
       def write
         File.open('Gemfile', 'w') do |f|
           f.write(content)
         end
       end
 
+      # Attempt to run 'bundle install' and fall back on running 'bundle update :gem'.
+      #
+      # @param [Dependency] gem The gem to update
+      #
+      # @return true on success, false on failure
       def run_bundle_update(gem)
         CommandRunner.system("bundle install") or CommandRunner.system("bundle update #{gem.name}")
       end
@@ -178,10 +208,16 @@ module Bundler
         puts prefix + msg
       end
 
+      # Log with indentation:
+      # "  - Log message"
+      #
       def self.log_indent(msg)
         log(msg, "  - ")
       end
 
+      # Log command:
+      # "  > bundle update"
+      #
       def self.log_cmd(msg)
         log(msg, "    > ")
       end
@@ -197,6 +233,13 @@ module Bundler
         @major, @minor, @patch = version.split('.') if version
       end
 
+      # Return last version scoped at :version_type:.
+      #
+      # Example: last_version(:patch), returns the last patch version 
+      # for the current major/minor version
+      #
+      # @return [String] last version. Ex: '1.2.3'
+      #
       def last_version(version_type)
         case version_type
         when :patch
@@ -205,26 +248,38 @@ module Bundler
           available_versions.select { |v| v =~ /^#{major}\./ }.first
         when :major
           available_versions.first
+        else
+          raise "Invalid version_type: #{version_type}"
         end
       end
 
+      # Return an ordered array of all available versions.
+      #
+      # @return [Array] of [String].
       def available_versions
         the_gem_line = gem_remote_list_output.scan(/^#{name}\s.*$/).first
         the_gem_line.scan /\d+\.\d+\.\d+/
       end
 
+      private
+
       def gem_remote_list_output
         CommandRunner.run "gem list #{name} -r -a"
       end
     end # class Dependency
 
     class CommandRunner
+
+      # Output the command about to run, and run it using system.
+      #
+      # @return true on success, false on failure
       def self.system(cmd)
         Logger.log_cmd cmd
 
         Kernel.system cmd
       end
 
+      # Run a system command and return its output.
       def self.run(cmd)
         `#{cmd}`
       end

data/lib/bundler_auto_update/version.rb

@@ -1,5 +1,5 @@
 module Bundler
   module AutoUpdate
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/spec_helper.rb

@@ -12,12 +12,16 @@ class Bundler::AutoUpdate::CommandRunner
 
   def self.run(cmd)
     puts "Stub! #{cmd}"
+
+    "command output"
   end
 end
 
 class Gemfile
   def read
     puts "Stub! read"
+
+    true
   end
 
   def write

data/spec/unit/gem_updater_spec.rb

@@ -7,7 +7,7 @@ describe GemUpdater do
   describe "auto_update" do
 
     context "when gem is updatable" do
-      let(:gem_updater) { GemUpdater.new(Dependency.new('rails', '3.0.0', nil), gemfile, test_command) }
+      let(:gem_updater) { GemUpdater.new(Dependency.new('rails', '3.0.0'), gemfile, test_command) }
 
       it "should attempt to update to patch, minor and major" do
         gem_updater.should_receive(:update).with(:patch).and_return(true)
@@ -18,7 +18,7 @@ describe GemUpdater do
       end
     end
 
-    context "when gem is not" do
+    context "when gem is not updatable" do
       let(:gem_updater) { GemUpdater.new(Dependency.new('rake', '<0.9'), gemfile, test_command) }
 
       it "should not attempt to update it" do
@@ -45,41 +45,42 @@ describe GemUpdater do
 
     context "when new version" do
       context "when tests pass" do
-        it "should commit new version" do
+        it "should commit new version and return true" do
           gem.should_receive(:last_version).with(:patch) { gem.version.next }
           gem_updater.should_receive(:update_gemfile).and_return true
           gem_updater.should_receive(:run_test_suite).and_return true
           gem_updater.should_receive(:commit_new_version).and_return true
           gem_updater.should_not_receive(:revert_to_previous_version)
 
-          gem_updater.update(:patch)
+          gem_updater.update(:patch).should == true
         end
       end
 
       context "when tests do not pass" do
-        it "should revert to previous version" do
+        it "should revert to previous version and return false" do
           gem.should_receive(:last_version).with(:patch) { gem.version.next }
           gem_updater.should_receive(:update_gemfile).and_return true
           gem_updater.should_receive(:run_test_suite).and_return false
           gem_updater.should_not_receive(:commit_new_version)
           gem_updater.should_receive(:revert_to_previous_version)
 
-          gem_updater.update(:patch)
+          gem_updater.update(:patch).should == false
         end
       end
 
       context "when it fails to upgrade gem" do
-        it "should revert to previous version" do
+        it "should revert to previous version and return false" do
           gem.should_receive(:last_version).with(:patch) { gem.version.next }
           gem_updater.should_receive(:update_gemfile).and_return false
           gem_updater.should_not_receive(:run_test_suite)
           gem_updater.should_not_receive(:commit_new_version)
           gem_updater.should_receive(:revert_to_previous_version)
 
-          gem_updater.update(:patch)
+          gem_updater.update(:patch).should == false
         end
       end
     end
-  end
+  end # describe "#update"
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bundler-auto-update
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Philippe Creux
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-06 00:00:00 +02:00
+date: 2011-10-13 00:00:00 +02:00
 default_executable: bundle-auto-update
 dependencies: 
 - !ruby/object:Gem::Dependency