rockit-now 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Current changes
+
+# 0.2.0 March 18, 2012
+
+ - Adding additional default configuration files, mimicking rake behavior
+ - Avoid failing for [if_service_not_running, if_command_missing] if the block returns true
+ - Add verbose mode to print all commands, accessible from the dsl :
+  - ```verbose_on```
+  - ```verbose_off```
+
+# 0.1.0 March 18, 2012
+
+ - Initial DSL definitions for (see docs in [Rockit::Application]):
+  - ```if_file_changed```
+  - ```if_directory_changed```
+  - ```service```
+  - ```if_service_not_running```
+  - ```command```
+  - ```if_command_missing```
+  - ```if_first_time```
+  - ```if_string_changed```
+  - ```if_string_digest_changed```

data/README.md

@@ -2,7 +2,7 @@
 
 Rockit is a dsl to help setup, detect changes and keep your environment up-to-date so you can start working as fast as possible.
 
-## Install - NOT AVAILABLE YET
+## Install
 
 ```gem install rockit-now```
 
@@ -18,12 +18,12 @@ Include in a ruby file :
 
 ```ruby
 require 'rockit'
-Rockit::Application.run
+Rockit::Application.new.run
 ```
 
 ## RockitFile Configuration
 
-Rockit requires a RockitFile for configuration. This is where you use ruby code and some helpful methods to define your environment. It is highly recommended that you commit your configuration to ensure quick and easy setup.
+Rockit requires a Rockitfile for configuration. This is where you use ruby code and some helpful methods to define your environment. It is highly recommended that you commit your configuration to ensure quick and easy setup.
 
 ### Commands and Services
 
@@ -53,20 +53,20 @@ end
 Applications environments are always changing and your local environment needs to react to them. For instance, when working in a rails team, migrations and gems are often changed and need to be updated. Add the following to your configurtion to detect changes and automatically keep stay up-to-date :
 
 ```ruby
-if_directory_changed "db/migrate" do
-  run "rake db:migrate"
-end
-
 if_file_changed "Gemfile" do
   run "bundle"
 end
+
+if_directory_changed "db/migrate" do
+  run "rake db:migrate"
+end
 ```
 
 ### Documentation and Examples
 
-Documentation is available http://rubydoc.info/github/bwillis/rockit/master/frames
+ - Code docs are available http://rubydoc.info/github/bwillis/rockit/master/frames
 
-You can find [example configurations](http://github.com/bwillis/rockit/blob/master/example/Rockitfile)
+ - [example configurations](http://github.com/bwillis/rockit/blob/master/example/Rockitfile)
 
 # License
 

data/example/Rockitfile

@@ -1,14 +1,15 @@
-# Rockitfile
+#!/usr/bin/env ruby
+
+# Example Rockitfile Configuration
 
 ###### Require Commands ######
 
 # command 'convert' is equivalent to
 if_command_missing "convert" do
-  puts "required command 'convert' is not available."
-  exit
+  run "brew install imagemagick"
 end
 
-###### Required Service ######
+###### Required Services ######
 
 # service 'mysql' is equivalent to
 if_service_not_running "mysql" do

data/lib/rockit/application.rb

@@ -8,14 +8,24 @@ module Rockit
 
   class Application
 
+    # Default configuration file names
+    CONFIG_FILES = ['rockitfile', 'Rockitfile', 'rockitfile.rb', 'Rockitfile.rb']
+
     def initialize(store=nil)
       @hash_store = store || HashStore.new
+      @debug = false
+    end
+
+    # Turn on debugging
+    def debug(val=true)
+      @debug = val
     end
 
     # Run a Rockit configuration file and Rails dependency checks
     # unless turned off by configuration.
-    def run(rockit_file="Rockitfile")
-      raise ArgumentError unless File.exists?(rockit_file)
+    def run
+      rockit_file = CONFIG_FILES.select { |f| File.exists?(f) }.first
+      raise ArgumentError "No Rockitfile found (looking for: #{CONFIG_FILES.join(',')})" unless rockit_file
       Dsl.new(self).instance_eval(File.read(rockit_file), rockit_file)
     end
 
@@ -33,8 +43,8 @@ module Rockit
     # return only if it finishes successfully
     def command(command, options)
       options = {
-        'print_command' => false,
-        'failure_message' => "required command '#{command}' is not available."
+          'print_command' => false,
+          'failure_message' => "required command '#{command}' is not available."
       }.merge(string_keys(options))
       system_exit_on_error("which #{command}", options)
     end
@@ -48,8 +58,8 @@ module Rockit
     # return only if it finishes successfully
     def service(service_name, options={})
       options = {
-        'print_command' => false,
-        'failure_message' => "required service '#{service_name}' is not running."
+          'print_command' => false,
+          'failure_message' => "required service '#{service_name}' is not running."
       }.merge(string_keys(options))
       system_exit_on_error("ps ax | grep '#{service_name.gsub(/^(.)/, "[\\1]")}'", options)
     end
@@ -98,17 +108,20 @@ module Rockit
     # command - the system command you want to execute
     # options - 'error_message' - a message to print when command is not successful
     #           'print_command' - displays the command being run
-    #           'failure_callback' - Proc to execute when the command fails
+    #           'failure_callback' - Proc to execute when the command fails. If a callback returns
+    #             true then it will avoid
     #           'on_success' - Proc to execute when the command is successful
     #
     # returns only true, will perform exit() when not successful
     #
     def system_exit_on_error(command, options={})
       options = {'print_command' => true}.merge(string_keys(options))
-      output command if options['print_command']
+      output command if options['print_command'] || @debug
       command_output = system_command(command)
+      output command_output if @debug
       unless last_process.success?
-        options['on_failure'].call(command, options) if options['on_failure'].is_a?(Proc)
+        result = options['on_failure'].call(command, options) if options['on_failure'].is_a?(Proc)
+        return true if result
         output options['failure_message'] || command_output
         return exit(last_process.exitstatus)
       end
@@ -161,4 +174,4 @@ module Rockit
     end
 
   end
-end
+end

data/lib/rockit/dsl.rb

@@ -6,6 +6,14 @@ module Rockit
       @app = app
     end
 
+    def verbose_on
+      @app.debug(true)
+    end
+
+    def verbose_off
+      @app.debug(false)
+    end
+
     def command(command, options={})
       @app.command(command, options)
     end

data/lib/rockit/version.rb

@@ -1,3 +1,3 @@
 module Rockit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/rockit/application_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe Rockit::Application do
   before do
     @app = Rockit::Application.new({})
+    @app.stubs(:output)
   end
 
   def block_should_execute
@@ -15,6 +16,27 @@ describe Rockit::Application do
     lambda { |*args| fail }
   end
 
+  describe '#run' do
+    context 'running without a configuration file available' do
+      before do
+        File.exists?('Rockitfile').should_not be
+      end
+      it 'does raises an argument error' do
+        lambda { @app.run }.should raise_error
+      end
+    end
+    context 'running with a configuration file' do
+      before do
+        File.stubs(:exists?).returns(false)
+        File.stubs(:exists?).with('Rockitfile.rb').returns(true)
+        File.stubs(:read).with('Rockitfile.rb').returns("")
+      end
+      it 'does not raise an argument error' do
+        lambda { @app.run }.should_not raise_error
+      end
+    end
+  end
+
   describe '#clear_cache' do
     context 'when calling clear cache' do
       before do
@@ -29,6 +51,37 @@ describe Rockit::Application do
     end
   end
 
+  describe '#service' do
+    context 'when querying an unstarted service with a retry failure block' do
+      before do
+        last_process = mock()
+        @app.stubs(:last_process).returns(last_process)
+        last_process.stubs(:success?).returns(false,true)
+      end
+
+      it 'does not call system exit' do
+        @app.stubs(:exit).returns { fail }
+        @app.service('test', {:on_failure => lambda{|*a| true } })
+      end
+    end
+
+  end
+
+  describe '#command' do
+    context 'when executing a missing command and executing a retry failure block' do
+      before do
+        last_process = mock()
+        @app.stubs(:last_process).returns(last_process)
+        last_process.stubs(:success?).returns(false,true)
+      end
+
+      it 'does not call system exit' do
+        @app.stubs(:exit).returns { fail }
+        @app.command('test', {:on_failure => lambda{|*a| true } })
+      end
+    end
+  end
+
   describe '#if_directory_changed' do
     before do
       Dir.stubs(:glob).returns(['file1', 'file2'])
@@ -154,6 +207,14 @@ describe Rockit::Application do
         @app.stubs('last_process').returns(@last_process)
       end
 
+      context 'with verbose on' do
+        it 'calls output event with print_command off' do
+          @app.expects('output')
+          @app.debug(true)
+          @app.system_exit_on_error('failing command', {'print_command' => false})
+        end
+      end
+
       it 'calls exit' do
         @app.unstub('exit')
         lambda { @app.system_exit_on_error('failing command') }.should raise_error SystemExit
@@ -180,16 +241,22 @@ describe Rockit::Application do
         @app.system_exit_on_error('failing command', :failure_message => new_message)
       end
 
-      it 'calls the failure callback' do
-        block_called = false
-        @app.system_exit_on_error('failing command', :on_failure => lambda { |a, b| block_called = true })
-        block_called.should == true
+      context 'with a failure callback' do
+        it 'calls the failure callback' do
+          @app.system_exit_on_error('failing command', :on_failure => block_should_execute)
+        end
+        context 'that returns true' do
+          it 'does not call exit' do
+            @app.stubs(:exit).with { fail }
+          end
+          it 'does not return failure' do
+            @app.system_exit_on_error('failing command', :on_failure => lambda{ |*a| true } ).should == true
+          end
+        end
       end
 
       it 'does not call the success callback' do
-        block_called = false
-        @app.system_exit_on_error('failing command', :on_success => lambda { |a, b| block_called = true })
-        block_called.should == false
+        @app.system_exit_on_error('failing command', :on_success => block_should_not_execute)
       end
     end
 
@@ -201,6 +268,24 @@ describe Rockit::Application do
         @last_process.stubs(:success?).returns(true)
       end
 
+      context 'with verbose on' do
+        it 'calls output event with print_command off' do
+          @app.expects('output')
+          @app.debug(true)
+          @app.system_exit_on_error('successful command', {'print_command' => false})
+        end
+
+        it 'can be turned on and off between calls' do
+          @app.debug(true)
+          @app.expects('output')
+          @app.system_exit_on_error('successful command', {'print_command' => false})
+
+          @app.debug(false)
+          @app.stubs('output').returns { fail }
+          @app.system_exit_on_error('successful command', {'print_command' => false})
+        end
+      end
+
       it 'does not exit' do
         @app.system_exit_on_error('successful command')
       end
@@ -211,15 +296,11 @@ describe Rockit::Application do
       end
 
       it 'does not call the failure callback' do
-        block_called = false
-        @app.system_exit_on_error('successful command', :on_failure => lambda { |a, b| blocked_called = true })
-        block_called.should == false
+        @app.system_exit_on_error('successful command', :on_failure => block_should_not_execute)
       end
 
       it 'does call the success callback' do
-        block_called = false
-        @app.system_exit_on_error('successful command', :on_success => lambda { |a, b| block_called = true })
-        block_called.should == true
+        @app.system_exit_on_error('successful command', :on_success => block_should_execute)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rockit-now
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-18 00:00:00.000000000Z
+date: 2012-03-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70136619827500 !ruby/object:Gem::Requirement
+  requirement: &70170043798600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70136619827500
+  version_requirements: *70170043798600
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70136619827080 !ruby/object:Gem::Requirement
+  requirement: &70170043797640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70136619827080
+  version_requirements: *70170043797640
 description: Check and verify external project and rails specific project dependencies.
   The script will cache results to ensure quick script execution each time.
 email:
@@ -45,6 +45,7 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE