scripting 0.1.2 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/examples/command.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../lib/scripting', __FILE__)
+
+my_app = Scripting::create_application do
+  plugin Scripting::AppDefaults
+  plugin Scripting::Commands
+
+  options do
+  end
+
+  switches do
+    self.banner = "Usage: #{File.basename(__FILE__)} [opts] command [args]"
+  end
+
+  command :echo do
+    description "Echo arguments to stdout"
+    work do |*args|
+      puts args.join(' ')
+    end
+  end
+
+  command :add do
+    description "Add two arguments"
+    work do |a, b|
+      puts a.to_f + b.to_f
+    end
+  end
+
+  command :sum do
+    description "Sum all arguments"
+    work do |*args|
+      puts args.collect(&:to_f).inject(&:+)
+    end
+  end
+
+  command :avg do
+    description "Average of all arguments"
+    work do |*args|
+      count = args.length
+      puts args.collect(&:to_f).inject(&:+) / count
+    end
+  end
+end
+
+my_app.run! ARGV if $0 == __FILE__

data/examples/simple.rb

@@ -1,6 +1,6 @@
 require File.expand_path('../../lib/scripting', __FILE__)
 
-MyApp = Scripting::create_application do
+my_app = Scripting::create_application do
   plugin Scripting::AppDefaults
 
   options do
@@ -24,9 +24,9 @@ MyApp = Scripting::create_application do
   end
 
   work do
-    STDERR.puts options.message if options.stderr
-    STDOUT.puts options.message if options.stdout
+    $stderr.puts options.message if options.stderr?
+    $stdout.puts options.message if options.stdout?
   end
 end
 
-MyApp.run! ARGV
+my_app.run! ARGV if $0 == __FILE__

data/lib/scripting/app_defaults.rb

@@ -18,8 +18,8 @@ module Scripting
           end
 
           on_tail('-h', '--help', "Help text") do
-            STDERR.puts self
             context.clear_work!
+            context.help!
             terminate
           end
         end

data/lib/scripting/application.rb

@@ -2,6 +2,7 @@ require File.expand_path('../pluggable', __FILE__)
 require File.expand_path('../parser', __FILE__)
 require File.expand_path('../options', __FILE__)
 require File.expand_path('../app_defaults', __FILE__)
+require File.expand_path('../commands', __FILE__)
 
 module Scripting
   class Application
@@ -11,6 +12,7 @@ module Scripting
       clear_switches!
       clear_options!
       clear_work!
+      clear_help!
     end
 
     def context
@@ -49,6 +51,19 @@ module Scripting
       @work
     end
 
+    def clear_help!
+      @help = [lambda { $stderr.puts @switches }]
+    end
+
+    def help &blk
+      @help << blk if block_given?
+      @help
+    end
+
+    def help!
+      @help.each(&:call)
+    end
+
     def parse! args
       switches.parse! args
       args
@@ -63,6 +78,30 @@ module Scripting
     end
   end
 
+  # Creates a new Scripting::Application class instance receiving a block
+  # used to describe options, command line switches, and other traits.
+  #
+  #   my_app = Scripting::create_application do
+  #     plugin Scripting::AppDefaults
+  #
+  #     options do
+  #       message = "Hello World"
+  #       stderr = false
+  #       stdout = true
+  #     end
+  #
+  #     switches do
+  #       on('--message=TEXT (default: #{options.message})') { |opt| options.message = opt }
+  #       on('--[no]-stderr') { |opt| options.stderr = opt }
+  #       on('--[no]-stdout') { |opt| options.stdout = opt }
+  #     end
+  #
+  #     work do
+  #       $stderr.puts options.message if options.stderr?
+  #       $stdout.puts options.message if options.stdout?
+  #     end
+  #   end
+  #
   def self.create_application &blk
     app = Class.new(Application).new
     app.describe &blk

data/lib/scripting/commands.rb

@@ -0,0 +1,69 @@
+module Scripting
+  module Commands
+
+    class Command
+      attr_reader :name
+
+      def initialize name
+        @name = name.to_s.downcase.to_sym
+        @description = nil
+        @work = lambda {} # noop by default
+      end
+
+      def describe &blk
+        instance_eval &blk if block_given?
+        self
+      end
+
+      def description desc=nil
+        unless desc.nil?
+          @description = desc
+        end
+        @description
+      end
+
+      def work &blk
+        @work = blk if block_given?
+        @work
+      end
+
+      def run! *args
+        @work.call(*args)
+      end
+    end
+
+    def self.instance_init(instance, *args)
+      instance.instance_eval do
+        options do
+          commands Hash.new
+        end
+
+        help do
+          $stderr.puts "\nAvailable commands:"
+          max_width = options.commands.keys.collect(&:length).max
+          options.commands.each do |k,v|
+            $stderr.puts sprintf("  %*s: %s", max_width, k, v.description)
+          end
+        end
+
+        work do |*args|
+          name = args.shift.downcase.to_sym rescue nil
+          command = options.commands[name]
+          if command.nil?
+            help!
+            puts "\nCommand: #{name} is not known"
+            exit
+          end
+
+          command.run! *args
+        end
+      end
+    end
+
+    module InstanceMethods
+      def command name, &blk
+        options.commands[name] = Command.new(name).describe(&blk)
+      end
+    end
+  end
+end

data/lib/scripting/options.rb

@@ -19,14 +19,23 @@ module Scripting
       instance_variable_set(ivar, value)
     end
 
-    def method_missing(name, value = nil, &blk)
+    def method_missing(name, *args, &blk)
       name = name.to_s
-      name.chop! if name =~ /=$/
+
+      # predicate?
+      if name =~/\?$/
+        return !!self[name.chop]
+      end
+
+      # assignment=
+      if name =~ /=$/
+        name.chop!
+      end
 
       if block_given?
         self[name] = blk
-      elsif !value.nil?
-        self[name] = value
+      elsif args.length > 0
+        self[name] = args.first
       else
         self[name]
       end

data/scripting.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{scripting}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["sdeming"]
-  s.date = %q{2011-03-09}
+  s.date = %q{2011-03-28}
   s.description = %q{Simplified command line scripting tool}
   s.email = %q{sdeming@makefile.com}
   s.extra_rdoc_files = [
@@ -23,16 +23,19 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "examples/command.rb",
     "examples/simple.rb",
     "lib/scripting.rb",
     "lib/scripting/app_defaults.rb",
     "lib/scripting/application.rb",
+    "lib/scripting/commands.rb",
     "lib/scripting/options.rb",
     "lib/scripting/parser.rb",
     "lib/scripting/pluggable.rb",
     "scripting.gemspec",
     "spec/app_defaults_spec.rb",
     "spec/application_spec.rb",
+    "spec/commands_spec.rb",
     "spec/options_spec.rb",
     "spec/pluggable_spec.rb",
     "spec/spec_helper.rb"
@@ -40,19 +43,20 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/sdeming/scripting}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{Simplified command line scripting tool}
   s.test_files = [
+    "examples/command.rb",
     "examples/simple.rb",
     "spec/app_defaults_spec.rb",
     "spec/application_spec.rb",
+    "spec/commands_spec.rb",
     "spec/options_spec.rb",
     "spec/pluggable_spec.rb",
     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/spec/commands_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Scripting::Commands do
+  it "should symbolize and downcase the command name" do
+    Scripting::Commands::Command.new(:testing).name.should == :testing
+    Scripting::Commands::Command.new(:Testing).name.should == :testing
+    Scripting::Commands::Command.new('testing').name.should == :testing
+    Scripting::Commands::Command.new("Testing").name.should == :testing
+    Scripting::Commands::Command.new("TESTING").name.should == :testing
+  end
+end
+
+describe Scripting::Commands::Command do
+  before :each do
+    @stdout = ''
+    STDOUT.stub(:write) { |*args| @stdout << args.join }
+
+    @stderr = ''
+    STDERR.stub(:write) { |*args| @stderr << args.join }
+
+    @app = Scripting::create_application do
+      plugin Scripting::Commands
+
+      command :answer do
+        description "The answer to life, the universe, and everything"
+        work { puts 42 }
+      end
+
+      command :echo do
+        description "Echo args"
+        work { |*args| puts args.join(" ") }
+      end
+
+      command :add do
+        description "Add two numbers"
+        work { |a,b| puts a.to_f + b.to_f }
+      end
+    end
+  end
+
+  it "should populate the help text with details for each command" do
+    @app.help!
+    @stderr.should include("answer: The answer to life, the universe, and everything")
+    @stderr.should include("echo: Echo args")
+    @stderr.should include("add: Add two numbers")
+  end
+
+  it "should run the specified command" do
+    @app.run! 'answer'
+    @stdout.should include("42")
+  end
+
+  it "should send arguments to the specified command" do
+    @app.run! %w{add 4 8}
+    @stdout.should include("12")
+  end
+
+  it "should run the specified command as well as other work items" do
+    @app.describe do
+      work { puts "Hello world!" }
+    end
+    @app.run! %w{echo to infinity and beyond!}
+    @stdout.should include("to infinity and beyond!")
+    @stdout.should include("Hello world!")
+  end
+
+end

data/spec/options_spec.rb

@@ -35,7 +35,24 @@ describe Scripting::Options do
     opts.fourth.should == "4"
   end
 
-  it "should assign blocks and call for each visit" do
+  it "should treat predicates as truthy" do
+    opts = Scripting::Options.new
+    opts.a_true = true
+    opts.a_false = false
+    opts.a_nil = nil
+    opts.a_forty_two = 42
+    opts.a_hello = "hello"
+    opts.a_colon_hello = :hello
+
+    opts.a_true?.should be_true
+    opts.a_false?.should be_false
+    opts.a_nil?.should be_false
+    opts.a_forty_two?.should be_true
+    opts.a_hello?.should be_true
+    opts.a_colon_hello?.should be_true
+  end
+
+  it "should assign blocks and call the block for each visit" do
     opts = Scripting::Options.new
     opts.block { true }
     opts.block.should be_true

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: scripting
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - sdeming
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 -05:00
+date: 2011-03-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,10 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 5
-        - 0
         version: 2.5.0
   type: :development
   prerelease: false
@@ -39,10 +31,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 2
         version: 1.5.2
   type: :development
   prerelease: false
@@ -54,8 +42,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -76,16 +62,19 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/command.rb
 - examples/simple.rb
 - lib/scripting.rb
 - lib/scripting/app_defaults.rb
 - lib/scripting/application.rb
+- lib/scripting/commands.rb
 - lib/scripting/options.rb
 - lib/scripting/parser.rb
 - lib/scripting/pluggable.rb
 - scripting.gemspec
 - spec/app_defaults_spec.rb
 - spec/application_spec.rb
+- spec/commands_spec.rb
 - spec/options_spec.rb
 - spec/pluggable_spec.rb
 - spec/spec_helper.rb
@@ -103,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4157022527390188045
+      hash: 913442681717536161
       segments: 
       - 0
       version: "0"
@@ -112,20 +101,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Simplified command line scripting tool
 test_files: 
+- examples/command.rb
 - examples/simple.rb
 - spec/app_defaults_spec.rb
 - spec/application_spec.rb
+- spec/commands_spec.rb
 - spec/options_spec.rb
 - spec/pluggable_spec.rb
 - spec/spec_helper.rb