wojtekmach-cli 0.0.1 → 0.1.0

data/.gitignore

@@ -1,3 +1,7 @@
-*.sw*
-pkg/
-*.gemspec
+*.gem
+.bundle
+Gemfile.lock
+.yardoc
+/pkg
+/doc
+*.*.sw*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=doc

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+
+  # Rails example
+  watch('spec/spec_helper.rb')                       { "spec" }
+  watch('config/routes.rb')                          { "spec/routing" }
+  watch('app/controllers/application_controller.rb') { "spec/controllers" }
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^app/(.+)\.rb})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+end

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011 Wojciech Mach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# CLI
+
+A CLI app framework
+
+## Setup
+
+    git clone /path/to/cli.git
+    cd cli
+    rake install
+
+## Example
+
+Let's say you have a file `hello.rb`:
+
+    #!/usr/bin/env ruby
+    require "rubygems"
+    require "cli"
+
+    CLI.app do
+      name    "hello"
+      version "0.0.1"
+
+      option "-m", "--message MSG" do |msg|
+        options[:msg] = msg
+      end
+
+      action "hi" do
+        puts "Hi, World!"
+      end
+
+      default do
+        str = options[:msg] || "Hello"
+        puts "#{str}, World!"
+      end
+    end
+
+You can now use it like this:
+
+    ruby hello.rb        # => Hello, World!
+    ruby hello.rb hi     # => Hi, World!
+    ruby hello.rb -m Bye # => Bye, World!
+
+## Licence
+
+CLI is Copyright (c) 2011 Wojciech Mach and distributed under the MIT license. See the LICENCE file for more info.

data/Rakefile

@@ -1,18 +1,3 @@
-require 'rubygems'  
-require 'rake'  
-  
-begin  
-  require 'jeweler'  
-  Jeweler::Tasks.new do |gemspec|  
-    gemspec.name = "wojtekmach-cli"  
-    gemspec.summary = "Create simple CLI apps"
-    gemspec.description = "Create simple CLI apps"
-    gemspec.email = "wojtekmach1@gmail.com"  
-    gemspec.authors = ["Wojtek Mach"]
-  end  
-  Jeweler::GemcutterTasks.new  
-rescue LoadError  
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
-end  
-  
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }  
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/cli.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cli/version"
+
+Gem::Specification.new do |s|
+  s.name        = "wojtekmach-cli"
+  s.version     = CLI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Wojciech Mach"]
+  s.email       = ["wojtekmach1@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "cli-#{s.version}"
+  s.description = %q{CLI apps framework.}
+
+  s.rubyforge_project = "cli"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/cli/app.rb

@@ -0,0 +1,92 @@
+require "optparse"
+
+module CLI
+  # An App
+  class App
+    attr_accessor :binary, :name, :version
+    attr_reader :proxy, :args, :opts, :options
+
+    def initialize(binary, &block)
+      @binary = binary
+      @name = binary
+      @actions = {}
+      @proxy = Proxy.new(self)
+      @args = []
+      @opts = OptionParser.new
+      @options = {}
+      proxy.instance_eval &block
+    end
+
+    # Hash of action_name => block to be executed
+    def actions
+      @actions
+    end
+
+    # Defines an action
+    def action(name, &block)
+      @actions[name] = block
+    end
+
+    # Runs an action
+    def run(action_name)
+      block = @actions[action_name]
+
+      unless block
+        raise ArgumentError, "action '#{action_name}' not found"
+      end
+
+      instance_eval &block
+    end
+
+    # Parses the arguments (with OptionParser) and runs
+    # specified or default action.
+    def run!(args)
+      @opts.parse!(args)
+      @args = args
+
+      begin
+        if args == []
+          run "default"
+        else
+          run args[0]
+        end
+      rescue => e
+        puts e.message.capitalize
+      end
+    end
+  end
+
+  # Proxy class is responsible for cool DSL inside CLI.app do ... end block
+  class Proxy
+    attr_reader :app
+
+    def initialize(app)
+      @app = app
+    end
+
+    # Sets the App name
+    def name(val)
+      app.name = val
+    end
+
+    # Sets the App version
+    def version(val)
+      app.version = val
+    end
+
+    # Defines the default action
+    def default(&block)
+      app.action("default", &block)
+    end
+
+    # Define option for OptionParser
+    def option(*args, &block)
+      app.opts.on(*args, &block)
+    end
+
+    # Delegates to App
+    def method_missing(name, *attrs, &block)
+      app.send(name, *attrs, &block)
+    end
+  end
+end

data/lib/cli/version.rb

@@ -0,0 +1,4 @@
+module CLI
+  # Current CLI version
+  VERSION = "0.1.0"
+end

data/lib/cli.rb

@@ -1,29 +1,10 @@
-require 'optparse'
+require "cli/app"
 
+# A CLI app framework
 module CLI
+  # Create a new App object with $0 as the binary name and runs it with ARGV
   def self.app(&block)
-    App.new(ARGV, &block)
-  end
-
-  class App
-    attr_reader :argv, :opts
-
-    def initialize(argv, &block)
-      @argv = argv
-      instance_eval(&block)
-    end
-    
-    def options(&block)
-      @opts = OptionParser.new
-      instance_eval(&block)
-      @opts.parse!
-    end
-
-    def run(&block)
-      instance_eval(&block)
-    end
-
-    def name(value) @name = value end
-    def version(value) @version = value end
+    @app = App.new($0, &block)
+    @app.run!(ARGV)
   end
 end

data/spec/cli/app_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+module CLI
+  describe App do
+    before do
+      @app = App.new("hello") do
+        name    "Hello"
+        version "0.0.1"
+
+        option "-m", "--message MESSAGE" do |msg|
+          options[:msg] = msg
+        end
+
+        action "hi" do
+          puts "Hi!"
+        end
+
+        default do
+          puts options[:msg] || "Hello, World!"
+        end
+      end
+    end
+
+    it "has a binary name" do
+      @app.binary.should eq("hello")
+    end
+
+    it "has a name" do
+      @app.name.should eq("Hello")
+    end
+
+    it "has a version" do
+      @app.version.should eq("0.0.1")
+    end
+
+    it "runs an action" do
+      $stdout.should_receive(:puts).with("Hi!")
+      @app.run("hi")
+    end
+
+    it "fails when action is not found" do
+      lambda do
+        @app.run("bad")
+      end.should raise_error(ArgumentError, "action 'bad' not found")
+    end
+
+    it "runs the default action" do
+      $stdout.should_receive(:puts).with("Hello, World!")
+      @app.run("default")
+    end
+
+    describe "#run!" do
+      describe "when arguments are empty" do
+        it "runs the default action" do
+          @app.should_receive(:run).with("default")
+          @app.run!([])
+        end
+      end
+
+      describe "when 1st argument is a valid action name" do
+        it "runs the action" do
+          @app.should_receive(:run).with("hi")
+          @app.run!(%w( hi ))
+        end
+      end
+
+      describe "when 1st argument is an invalid action name" do
+        it "prints error message" do
+          $stdout.should_receive(:puts).with("Action 'bad' not found")
+          @app.run!(%w( bad ))
+        end
+      end
+
+      describe "with a valid option" do
+        it "sets the option and runs the default action" do
+          $stdout.should_receive(:puts).with("Goodmorning!")
+          @app.run!(%w( -m Goodmorning! ))
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "cli"

metadata

@@ -1,25 +1,42 @@
 --- !ruby/object:Gem::Specification 
 name: wojtekmach-cli
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
-- Wojtek Mach
+- Wojciech Mach
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-09-15 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: Create simple CLI apps
-email: wojtekmach1@gmail.com
+date: 2011-06-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: CLI apps framework.
+email: 
+- wojtekmach1@gmail.com
 executables: []
 
 extensions: []
@@ -28,17 +45,25 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
 - Rakefile
-- VERSION
-- examples/rcat
+- cli.gemspec
 - lib/cli.rb
-has_rdoc: true
-homepage: 
+- lib/cli/app.rb
+- lib/cli/version.rb
+- spec/cli/app_spec.rb
+- spec/spec_helper.rb
+homepage: ""
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -46,23 +71,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: cli
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Create simple CLI apps
-test_files: []
-
+summary: cli-0.1.0
+test_files: 
+- spec/cli/app_spec.rb
+- spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.0.1

data/examples/rcat

@@ -1,20 +0,0 @@
-#!/usr/bin/env ruby
-$: << File.dirname(__FILE__) + "/../lib"
-
-require 'cli'
-
-CLI.app do
-  name    "rcat"
-  version "0.0.1"
-
-  options do
-    opts.on("-h", "--help") do
-      puts "rcat 0.0.1. See cat(1)"
-      exit
-    end
-  end
-
-  run do
-    puts ARGF.read
-  end
-end