shake 0.1.2 → 0.1.3

data/.gems

@@ -0,0 +1 @@
+contest

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+.rvmrc
+pkg/
+test/tmp/

data/README.md

@@ -1,7 +1,5 @@
-Shake
-=====
-
-**Simple command runner.**
+# Shake
+#### Simple command runner.
 
 Goals:
 
@@ -19,21 +17,23 @@ Why not Rake or Thor?
 Shake was made with the idea of being easily-embeddable into your projects
 for your command line runners. It's a single ~4kb Ruby file.
 
-    # Shakefile
-    # Place this file in your project somewhere
-    class Shake
-      task(:start) {
-        puts "Starting '#{params.join(' ')}'..."
-      }
+``` ruby
+# Shakefile
+# Place this file in your project somewhere
+class Shake
+  task(:start) {
+    puts "Starting '#{params.join(' ')}'..."
+  }
 
-      task.description = "Starts something"
+  task.description = "Starts something"
 
-      task(:stop) {
-        puts "Stopping..."
-      }
+  task(:stop) {
+    puts "Stopping..."
+  }
 
-      task.description = "Stops it"
-    end
+  task.description = "Stops it"
+end
+```
 
 In your shell:
 
@@ -56,13 +56,15 @@ Usage
 
 Using the command `shake` will load your project's `Shakefile`.
 
-    # ~/project/Shakefile
-    class Shake
-      task(:deploy) do
-        puts "Deploying..."
-        system "ssh admin@server.com git pull && thin restart"
-      end
-    end
+``` ruby
+# ~/project/Shakefile
+class Shake
+  task(:deploy) do
+    puts "Deploying..."
+    system "ssh admin@server.com git pull && thin restart"
+  end
+end
+```
 
 And in your shell:
 
@@ -74,10 +76,12 @@ And in your shell:
 
 Get the parameters with `params` (an array). Verify parameters with `wrong_usage`.
 
-    task(:init) do
-      wrong_usage  if params.empty?
-      system "wget #{params.first}"
-    end
+``` ruby
+task(:init) do
+  wrong_usage  if params.empty?
+  system "wget #{params.first}"
+end
+```
 
 Example:
 
@@ -90,62 +94,74 @@ Example:
 You may get params from it with `params.extract` or `params.delete`. Doing `extract`
 will remove it from params.
 
-    task(:create) do
-      type  = params.extract('-t') || 'default'
-      quiet = params.delete('-q')
-      file  = params.shift
-      wrong_usage  if params.any?
+``` ruby
+task(:create) do
+  type  = params.extract('-t') || 'default'
+  quiet = params.delete('-q')
+  file  = params.shift
+  wrong_usage  if params.any?
 
-      puts "Creating '#{file}' (quiet: #{!!quiet}, type: #{type})"
-    end
+  puts "Creating '#{file}' (quiet: #{!!quiet}, type: #{type})"
+end
+```
 
 Example:
 
-    $ shake create                 #=> Invalid
-    $ shake create foobar          #=> Creating 'foobar' (quiet: false, type: default)
-    $ shake create foobar -q       #=> Creating 'foobar' (quiet: true, type: default)
-    $ shake create foobar -t xyz   #=> Creating 'foobar' (quiet: false, type: xyz)
+``` bash
+$ shake create                 #=> Invalid
+$ shake create foobar          #=> Creating 'foobar' (quiet: false, type: default)
+$ shake create foobar -q       #=> Creating 'foobar' (quiet: true, type: default)
+$ shake create foobar -t xyz   #=> Creating 'foobar' (quiet: false, type: xyz)
+```
 
-# Common commands
+### Common commands
 
 Use `err` to print something to STDERR. Use `pass` to halt execution.
 
-    task(:delete) do
-      unless File.exists?(params.first)
-        err 'You can't delete something that doesn't exist!'
-        pass
-      end
+``` ruby
+task(:delete) do
+  unless File.exists?(params.first)
+    err 'You can't delete something that doesn't exist!'
+    pass
+  end
 
-      FileUtils.rm_rf params.first
-    end
+  FileUtils.rm_rf params.first
+end
+```
 
 You may also pass parameters to `pass` to have it printed out before halting.
 
-    pass 'The target already exists.'  if File.exists?(target)
+``` ruby
+pass 'The target already exists.'  if File.exists?(target)
+```
 
 ### Default tasks
 
 Use `default` to specify a default task. (The default task is usually `help`)
 
-    class Shake
-      task(:test) do
-        Dir['test/**/*_test.rb'].each { |f| load f }
-      end
+``` ruby
+class Shake
+  task(:test) do
+    Dir['test/**/*_test.rb'].each { |f| load f }
+  end
 
-      default :test
-    end
+  default :test
+end
 
-    # Typing `shake` will be the same as `shake test`
+# Typing `shake` will be the same as `shake test`
+```
 
 ### Invalid commands
 
-Use `invalid` to define what happens when
+Use `invalid` to define what happens when you invoke a wrong command.
 
-    class Shake
-      invalid {
-        err "Invalid command. What's wrong with you?"
-      }
-    end
+``` ruby
+class Shake
+  invalid {
+    err "Invalid command. What's wrong with you?"
+  }
+end
+```
 
 In your shell:
 
@@ -156,35 +172,41 @@ In your shell:
 
 Tasks are executed in the class's context, so just define your helpers like so:
 
-    module Helpers
-      def say_status(what, str)
-        puts "%15s %s" % [ what, str ]
-      end
-    end
+``` ruby
+module Helpers
+  def say_status(what, str)
+    puts "%15s %s" % [ what, str ]
+  end
+end
 
-    class Shake
-      extend Helpers
-    end
+class Shake
+  extend Helpers
+end
+```
 
 Then use them in your tasks.
 
-    class Shake
-      task(:info) do
-        say_status :info, "It's a fine day"
-      end
-    end
+``` ruby
+class Shake
+  task(:info) do
+    say_status :info, "It's a fine day"
+  end
+end
+```
 
 ### Manual invocation
 
 You can use shake in your projects without using the `shake` command. (recommended!)
 
-    require 'shake'
+``` ruby
+require 'shake'
 
-    # If you want to load your own project file (optional)
-    file = Shake.find_in_project('Projectfile') and load file
+# If you want to load your own project file (optional)
+file = Shake.find_in_project('Projectfile') and load file
 
-    # Now define some tasks, and then:
-    Shake.run!
+# Now define some tasks, and then:
+Shake.run!
+```
 
 ### Subclassing Shake
 
@@ -193,37 +215,44 @@ You may subclass shake for your own project.
 By default, it will not have any of the default tasks (that is, `shake help`, and
 the "invalid command" message). Use `include Defaults` if you want this behavior.
 
-    require 'shake'
+``` ruby
+require 'shake'
 
-    class CLI < Shake
-      include Defaults  # optional, see above
+class CLI < Shake
+  include Defaults  # optional, see above
 
-      task(:flip) do
-        what = rand < 0.5 ? "heads" : "tails"
-        puts "The coin says #{what}"
-      end
-    end
+  task(:flip) do
+    what = rand < 0.5 ? "heads" : "tails"
+    puts "The coin says #{what}"
+  end
+end
 
-    CLI.run!
+CLI.run!
+```
 
 ### Defining tasks
 
-    # In your Shakefile or something
-    class Shake
-      task(:reset) do
-        # ...
-      end
+``` ruby
+# In your Shakefile or something
+class Shake
+  task(:reset) do
+    # ...
+  end
 
-      task.description = "Resets passwords."
-    end
+  # These are optional
+  task.description = "Resets passwords."
+  task.usage = "reset USERNAME"
+end
+```
 
 Alternatively:
 
-    class Shake
-      task(:reset) do
-        # ...
-      end
-
-      task(:reset).description = "Resets passwords."
-    end
+``` ruby
+class Shake
+  task(:reset) do
+    # ...
+  end
 
+  task(:reset).description = "Resets passwords."
+end
+```

data/Rakefile

@@ -2,4 +2,13 @@ task :test do
   Dir['test/**/*_test.rb'].each { |f| load f }
 end
 
+desc "Invokes the test suite in multiple RVM environments"
+task :'test!' do
+  # Override this by adding RVM_TEST_ENVS=".." in .rvmrc
+  envs = ENV['RVM_TEST_ENVS'] || '1.9.2@shake,1.8.7@shake'
+  puts "* Testing in the following RVM environments: #{envs.gsub(',', ', ')}"
+  system "rvm #{envs} rake test"
+end
+
+
 task :default => :test

data/lib/shake.rb

@@ -1,7 +1,7 @@
 require 'ostruct'
 
 class Shake
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 
   Abort = Class.new(StandardError)
 
@@ -164,14 +164,16 @@ class Shake
         err "Usage: #{executable} <command>"
         err
         err "Commands:"
-        tasks.each { |name, task| err "  %-20s %s" % [ name, task.description ] }
+        tasks.each { |name, task| err "  %-20s %s" % [ task.usage || name, task.description ] }
       }
 
       to.task(:help).description = "Shows a list of commands"
 
       to.invalid {
         if task(command)
+          usage = task(command).usage
           err "Invalid usage."
+          err "Usage: `#{executable} #{usage}`\n"  if usage
           err "See `#{executable} help` for more info."
         else
           err "Unknown command: #{command}"

data/shake.gemspec

@@ -0,0 +1,12 @@
+require "./lib/shake"
+Gem::Specification.new do |s|
+  s.name = "shake"
+  s.version = Shake::VERSION
+  s.summary = %{Simple command line runner.}
+  s.description = %Q{Shake is a simple replacement for Thor/Rake.}
+  s.authors = ["Rico Sta. Cruz"]
+  s.email = ["rico@sinefunc.com"]
+  s.homepage = "http://github.com/rstacruz/shake"
+  s.files = `git ls-files`.strip.split("\n")
+  s.executables = Dir["bin/*"].map { |f| File.basename(f) }
+end

data/test/mock.rb

@@ -6,4 +6,8 @@ class Shake
   def self.err(str='')
     $err << "#{str}\n"
   end
+
+  def self.executable
+    "shake"
+  end
 end

data/test/unit/help_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class HelpTest < Test::Unit::TestCase
+  class Bake < ::Shake
+    include Shake::Defaults
+
+    task :build do
+      wrong_usage
+      puts "work!"
+    end
+
+    task.usage = "build SOMETHING"
+    task.description = "Builds."
+
+    task :destroy do
+      wrong_usage
+      puts "die!"
+    end
+  end
+
+  test 'help' do
+    Bake.run 'help'
+    assert cout == ""
+    assert cerr.include? "build SOMETHING"
+    assert cerr.include? "Builds."
+    assert cerr.include? "destroy"
+  end
+
+  test 'wrong_usage' do
+    Bake.run 'build'
+
+    assert ! cout.include?("work!")
+    assert cerr.include?("Invalid usage")
+    assert cerr.include?("shake build SOMETHING")
+  end
+
+  test 'wrong_usage 2' do
+    Bake.run 'destroy'
+
+    assert ! cout.include?("die!")
+    assert cerr.include?("Invalid usage")
+    assert ! cerr.include?("shake destroy")
+  end
+end

metadata

@@ -1,69 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: shake
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.3
   prerelease: 
-  version: 0.1.2
 platform: ruby
-authors: 
+authors:
 - Rico Sta. Cruz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-20 00:00:00 +08:00
+date: 2011-08-31 00:00:00.000000000 +08:00
 default_executable: 
 dependencies: []
-
 description: Shake is a simple replacement for Thor/Rake.
-email: 
+email:
 - rico@sinefunc.com
-executables: 
+executables:
 - shake
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gems
+- .gitignore
+- HISTORY.md
+- README.md
+- Rakefile
+- bin/shake
+- examples/example
+- examples/example2
 - lib/shake.rb
+- shake.gemspec
 - test/mock.rb
 - test/test_helper.rb
+- test/unit/help_test.rb
 - test/unit/params_test.rb
 - test/unit/shakefile_test.rb
 - test/unit/subclass_test.rb
 - test/unit/traverse_test.rb
-- examples/example
-- examples/example2
-- HISTORY.md
-- README.md
-- Rakefile
-- bin/shake
 has_rdoc: true
 homepage: http://github.com/rstacruz/shake
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple command line runner.
 test_files: []
-