commandable 0.2.0.beta2 → 0.2.0.rc1

data/.gemrc

@@ -0,0 +1,8 @@
+test_options:
+    auto_test_on_install: false 
+    test_on_install: true 
+    install_development_dependencies: true
+    test_development_dependencies: false
+    upload_results: true
+    force_install: false
+    force_uninstall_on_failure: false

data/.gitignore

@@ -5,4 +5,5 @@ pkg/*
 .DS_Store
 doc/**/*
 rdoc/**/*
-vendor/**/*
+vendor/**/*
+tmp/**/*

data/README.markdown

@@ -16,11 +16,12 @@ You can now "use your words" to let people interact with your apps in a natural
 
 ## Status
 
-2011-03-18 - Final testing and building the example app. I'd wait to use it till I finish the example app. I'm finding new use cases as I do this and correcting some omissions of logic.
+2011-03-21 - Release Cadidate: 0.2.0.rc1
+
 
 ## Principle of Least Surprise
 
-I've tried to honestly follow the theory of the principle of least surprise so it should just work like you would expect it to.
+I've tried to follow the principle of least surprise so Commandable should just work like you would expect it to. As long as you expect it to work the same way as I do.
 
 ## Requirements ##
 
@@ -171,23 +172,23 @@ One of the great features of **Commandable** is that it will automatically creat
 
 A typical help output looks something like this:  
 
-    Commandable - The easiest way to add command line control to your app.
-    Copyrighted free software - Copyright (c) 2011 Mike Bethany.
-    Version: 0.2.0.beta01
+  Commandable - The easiest way to add command line control to your app.
+  Copyrighted free software - Copyright (c) 2011 Mike Bethany.
+  Version: 0.2.0
 
-    Usage: commandable <command> [parameters] [<command> [parameters]...]
+  Usage: commandable <command> [parameters] [<command> [parameters]...]
 
-    Command Parameters Description
-      error            : Will raise a programmer error, not a user error
-                          so you see what happens when you have bad code
-   examples [path]     : Copies the test classes to a folder so
-                          you can see a bunch of small examples
-     readme            : displays the readme file (default)
-          v            : <xor> Application Version
-    version            : <xor> Application Version
-     widget [path]     : Copies a fully working app demonstrating how
-                          to use **Commandable** with RSpec and Cucumber
-       help            : you're looking at it now
+  Command Parameters Description
+    error            : Will raise a programmer error, not a user error
+                       so you see what happens when you have bad code
+ examples [path]     : Copies the test classes to a folder so
+                       you can see a bunch of small examples
+   readme            : displays the readme file (default)
+        v            : <xor> Application Version
+  version            : <xor> Application Version
+   widget [path]     : Copies a fully working app demonstrating how
+                       to use Commandable with RSpec and Cucumber
+     help            : you're looking at it now
 
 
 
@@ -198,7 +199,7 @@ For a fully working example with RSpec and Cucumber tests run this command:
 
 If you would like to see a bunch of simple classes that demonstrate its uses run:
 
-    $ commandable example [path]
+    $ commandable examples [path]
 
 ### Commandable Options
 
@@ -251,8 +252,8 @@ Then you can do something like this:
 ###Color options 
 
 **Commandable.color\_output**  
-_default = false_  
-Set to true to enable colorized help/usage instructions.
+_default = true_  
+Set to false to disable colorized help/usage instructions. You might find it really, really annoying...
 
 **Commandable.color\_app\_info**  
 _default = intense\_white_ + bold  
@@ -347,7 +348,7 @@ If you need a little more control:
       
     end
     
-### The easiest way
+### The even easier way
 
 **Commandable.execute(ARGV)**
 
@@ -363,7 +364,6 @@ Simply configure your bin file to run `Commandable#execute`:
 
     #!/usr/bin/env ruby
     $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
-    require 'yourappname'
     require 'commandable'
     Commandable.verbose_parameters = false
     Commandable.color_output = true
@@ -373,6 +373,11 @@ Simply configure your bin file to run `Commandable#execute`:
       My App - It does stuff and things!
       Copyright (c) 2011 Acme Inc.
     """
+
+    # Make sure you require your app after Commandable, or use
+    # a configuration file to load the settings then your app
+    # See the Widget app for an example of this.
+    require 'yourappname'
     return_values = Commandable.execute(ARGV)
     # do stuff
 
@@ -383,18 +388,16 @@ I actually prefer to create a separate file for my **Commandable** configuration
 
 One really cool thing about this design is you can extend another app and add your own command line controls without having to crack open their code. The other app doesn't even have to use **Commandable**. You can just write your own methods that call the methods of the original program.
 
-I should also say the code is really, really ugly right now. Thats the very next thing I will be working on for this project. This is the "rough draft" version that works perfectly well but is very ugly code-wise. I needed to use it right now so am putting it out in beta.
+I should also say the code is really, really ugly right now. Thats the very next thing I will be working on for this project. This is the "rough draft" version that works perfectly well but is very ugly code-wise. I needed to use it right now so am putting it out as is.
 
 If you have any questions about how the code works I've tried to give as much info in these docs as possible but I am also an OCD level commenter so you should be able to find fairly good explanations of what I'm doing in the code.
 
-Most of all it should be simple to use so if you have any problems please drop me a line. Also if you make any changes please send me a pull request. I hate people that don't respond to them, even to deny them, so I'm pretty good about that sort of thing.
+Most of all it should be simple to use so if you have any problems please drop me a line. Also if you make any changes please send me a pull request. I when people that don't respond to them, even to deny them, so I'm pretty good about that sort of thing.
 
 
 ## To Do
 
-Still working on for this version:
-
-* Finish **Widget** example app. It will be in the release version but I want to release a beta so I can test the gem via RubyGems.
+Done with 0.2.0. Release to final beta.
 
 ###Next version:
 

data/Rakefile

@@ -1,29 +1,39 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require "rake"
-require "rake/rdoctask"
-require "rspec/core/rake_task"
+require 'rake'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 
 desc "Run all examples"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w[--color]
-  t.verbose = false
+  t.verbose = true
 end
 
-task :default => [:spec, :build]
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = %w{--tags ~@jruby} unless defined?(JRUBY_VERSION)
+end
+
+task :default => [:test, :build]
+task :test =>[:cucumber, :spec]
 
 task :clobber do
   rm_rf 'pkg'
   rm_rf 'tmp'
   rm_rf 'coverage'
+  rm_rf 'rdoc'
 end
 
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "commandable #{Commandable::VERSION}"
+  rdoc.title = "Commandable #{Commandable::VERSION}"
   rdoc.rdoc_files.exclude('autotest/*')
+  rdoc.rdoc_files.exclude('features/*')
+  rdoc.rdoc_files.exclude('pkg/*')
   rdoc.rdoc_files.exclude('spec/**/*')
+  rdoc.rdoc_files.exclude('vendor/*')
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/bin/commandable

@@ -8,7 +8,7 @@ Commandable.app_info =
 """
   \e[92mCommandable\e[0m - The easiest way to add command line control to your app.
   Copyrighted free software - Copyright (c) 2011 Mike Bethany.
-  Version: #{Commandable::VERSION}
+  Version: #{Commandable::VERSION::STRING}
 """
 
 # App controller has to be loaded after commandable settings

data/commandable.gemspec

@@ -5,18 +5,21 @@ require "commandable/version"
 Gem::Specification.new do |s|
   s.name                    = "commandable"
   s.required_ruby_version   = "~>1.9.2"
-  s.version                 = Commandable::VERSION
+  s.version                 = Commandable::VERSION::STRING
   s.platform                = Gem::Platform::RUBY
+  s.required_ruby_version   = '>= 1.9.2'
   s.authors                 = ["Mike Bethany"]
   s.email                   = ["mikbe.tk@gmail.com"]
   s.homepage                = "http://mikbe.tk"
   s.summary                 = %q{The easiest way to add command line control to your app.}
   s.description             = %q{The easiest way to add command line control to your app.\nAdding command line control to your app is as easy as putting 'command "this command does xyz"' above a method.\nParameter lists and a help command are automatically built for you.}
+  s.license = 'MIT'
 
   s.add_dependency("term-ansicolor-hi", "~>1.0.7")
   
   s.add_development_dependency("rspec", "~>2.5")
-  s.add_development_dependency("cucumber")
+  s.add_development_dependency("cucumber", "~>0.10")
+  s.add_development_dependency("aruba", "~>0.3")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,autotest}/*`.split("\n")

data/features/copy_examples.feature

@@ -0,0 +1,13 @@
+Feature: Copy Examples
+  In order to learn how to use Commandable
+  As a developer
+  I want to look at some example files
+
+  Scenario: Copy example files from specs into the default directory
+    When I run `commandable examples`
+    Then a directory named "examples" should exist 
+  
+  Scenario: Copy example files from specs into a specified directory
+    When I run `commandable examples shazam`
+    Then a directory named "shazam" should exist 
+  

data/features/download_widget.feature

@@ -0,0 +1,18 @@
+Feature: Download widget
+  In order to learn how to use Commandable by looking at a fully functional application
+  As a developer
+  I want to download the latest source code for Widget from Github
+
+  Background:
+    Given Git is installed
+
+  @download_widget
+  Scenario: Download widget from github into the default directory
+    When I run `commandable widget`
+    Then a directory named "widget" should exist 
+
+  @download_widget
+  Scenario: Download widget from github into a specified directory
+    When I run `commandable widget potato`
+    Then a directory named "potato" should exist 
+  

data/features/setup/env.rb

@@ -1,3 +1,5 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'rspec/expectations'
+require 'aruba/cucumber'
+require 'fileutils'
 require 'commandable'

data/features/step-definitions/step-definitions.rb

@@ -1,7 +1,15 @@
+Before do
+  @aruba_timeout_seconds = 30
+end
+
 When /^I run cucumber$/ do
-  true.should be_true
+  # These are just to see color output is working
 end
 
 Then /^it doesn't give an error$/ do
-  true.should be_true
+  # These are just to see color output is working
 end
+
+Given /^Git is installed$/ do
+  raise Exception, "\n#{"ATTENION! " * 5}\nYou need git installed to run the Cucumber tests!\n\n" if `which git`.empty?
+end

data/lib/commandable/app_controller.rb

@@ -2,7 +2,8 @@ module Commandable
   
   # A helper to display the read me file and generate an example app
   class AppController
-    
+    WIDGET_GITHUB ||= "://github.com/mikbe/widget"
+
     class << self
       extend Commandable
  
@@ -15,12 +16,33 @@ module Commandable
       command "Copies a fully working app demonstrating how\nto use Commandable with RSpec and Cucumber"
       # Creates a simple example app demonstrating a fully working app
       def widget(path="./widget")
-        puts "This feature hasn't been added yet. I'm working on it now and it will be in the release version."
+        # Test for Git
+        unless git_installed?
+          puts "Git must be installed to download Widget (You're a developer and you don't have Git installed?)"
+          return
+        end
+        # Git already has all of it's own error trapping 
+        # it would be horrible coupling and duplication
+        # of effort to do anything on my end for failures.
+        puts "\nUnable to download Widget. You can find the souce code here:\nhttps#{WIDGET_GITHUB}" unless download_widget(path) == 0
+      end
+
+      # Downloads Widget from the git repository
+      # This is external to the widget command so it can be stubbed for testing
+      def download_widget(path)
+        `git clone git#{WIDGET_GITHUB}.git #{path}`
+        $?.exitstatus
+      end
+
+      # Checks to see if Git is installed
+      # This is external to the widget command so it can be stubbed for testing
+      def git_installed?
+        !`git --version`.chomp.match(/^git version/i).nil?
       end
       
       command "Copies the test classes to a folder so\nyou can see a bunch of small examples"
       # Copies the test classes to a folder so you can see a bunch of small examples
-      def examples(path="./example_classes")
+      def examples(path="./examples")
         FileUtils.copy_dir(File.expand_path(File.dirname(__FILE__) + '/../../spec/source_code_examples'),path)
       end
 

data/lib/commandable/commandable.rb

@@ -222,9 +222,9 @@ module Commandable
     # Set colors to their default values
     def reset_colors
       # Colors - off by default
-      @color_output      ||= false
+      @color_output      ||= true
       # Build the default colors
-      Term::ANSIColorHI.coloring = true
+      Term::ANSIColorHI.coloring = color_output
       c = Term::ANSIColorHI
       @color_app_info           = c.intense_white  + c.bold
       @color_app_name           = c.intense_green  + c.bold

data/lib/commandable/version.rb

@@ -1,4 +1,12 @@
 module Commandable
-  # The application's version number
-  VERSION = "0.2.0.beta2"
-end
+  module VERSION # :nodoc:
+    MAJOR  = 0
+    MINOR  = 2
+    TINY   = 0
+    PRE    = "rc1"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+
+    SUMMARY = "Commandable #{STRING}"
+  end
+end

data/spec/commandable/app_controller_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Commandable do
+
+  before(:each) {
+    Commandable.reset_all
+    Commandable.color_output = true
+    Commandable.verbose_parameters = false
+    Commandable.app_name = "commandable"
+    Commandable.app_info =  
+    """
+      \e[92mCommandable\e[0m - The easiest way to add command line control to your app.
+      Copyrighted free software - Copyright (c) 2011 Mike Bethany.
+      Version: #{Commandable::VERSION::STRING}
+    """
+
+    # App controller has to be loaded after commandable settings
+    # or it won't be able to use the settings
+    load 'commandable/app_controller.rb'
+  }
+  
+  context "when running the widget command" do
+    
+    context "when git isn't installed" do
+      
+      it "should inform them they need Git" do
+        Commandable::AppController.stub(:git_installed?){false}
+        execute_output_s(["widget"]).should match(/Git must be installed/)
+      end
+    
+    end
+    context "when git is installed" do
+      
+      context "and it's able to install the files" do
+        it "should download Widget from github" do
+          Commandable::AppController.stub(:download_widget){0}
+          execute_output_s(["widget"]).should_not include("Unable to download")
+        end
+      end
+      
+      context "but it's not able to install the files" do
+        it "should download Widget from github" do
+          Commandable::AppController.stub(:download_widget){1}
+          execute_output_s(["widget"]).should include("Unable to download")
+        end
+      end
+
+    
+    end
+
+    
+  end
+
+end

data/spec/commandable/command_line_execution_spec.rb

@@ -6,10 +6,10 @@ describe Commandable do
     Commandable.reset_all
     Commandable.app_name = "mycoolapp"
     Commandable.app_info = 
-    """
-      My Cool App - It does stuff and things!
-      Copyright (c) 2011 Acme Inc.
-    """
+"""
+  My Cool App - It does stuff and things!
+  Copyright (c) 2011 Acme Inc.
+"""
 
     load 'parameter_class.rb'
   }

data/spec/commandable/help_generator_spec.rb

@@ -49,6 +49,7 @@ describe Commandable do
     end
 
     it "adds the application name to the help output if it's given" do
+      Commandable.color_output = false
       load 'parameter_class.rb'
       Commandable.app_name = "mycoolapp"
       Commandable.help.to_s.should match(/Usage: mycoolapp <command>/)

data/spec/spec_helper.rb

@@ -5,8 +5,10 @@ $:.unshift File.expand_path(File.dirname(__FILE__))
 
 require 'pp'
 require 'term/ansicolor'
+require 'rspec/mocks'
 require 'rspec'
 require 'commandable'
+#require 'commandable/app_controller'
 
 # A note on the specs:
 # Since Commandable uses singletons the tests sometimes get confused about their state.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commandable
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta2
+  version: 0.2.0.rc1
   prerelease: 6
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor-hi
-  requirement: &2154879100 !ruby/object:Gem::Requirement
+  requirement: &2156630780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2154879100
+  version_requirements: *2156630780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154878600 !ruby/object:Gem::Requirement
+  requirement: &2156630320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,18 +33,29 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *2154878600
+  version_requirements: *2156630320
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2154878200 !ruby/object:Gem::Requirement
+  requirement: &2156629860 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: *2156629860
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &2156629400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *2154878200
+  version_requirements: *2156629400
 description: The easiest way to add command line control to your app.\nAdding command
   line control to your app is as easy as putting 'command "this command does xyz"'
   above a method.\nParameter lists and a help command are automatically built for
@@ -56,17 +67,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gemrc
+- .gemtest
 - .gitignore
 - BUGS.txt
 - Gemfile
 - LICENCE
 - README.markdown
 - Rakefile
-- _testing/alias_trap.rb
 - autotest/discover.rb
 - bin/commandable
 - commandable.gemspec
 - features/ansicolor.feature
+- features/copy_examples.feature
+- features/download_widget.feature
 - features/setup/env.rb
 - features/step-definitions/step-definitions.rb
 - lib/commandable.rb
@@ -75,6 +89,7 @@ files:
 - lib/commandable/exceptions.rb
 - lib/commandable/version.rb
 - lib/monkey_patch/file_utils.rb
+- spec/commandable/app_controller_spec.rb
 - spec/commandable/command_line_execution_spec.rb
 - spec/commandable/commandable_spec.rb
 - spec/commandable/help_generator_spec.rb
@@ -104,7 +119,8 @@ files:
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://mikbe.tk
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,7 +128,7 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ~>
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -129,6 +145,7 @@ specification_version: 3
 summary: The easiest way to add command line control to your app.
 test_files:
 - autotest/discover.rb
+- spec/commandable/app_controller_spec.rb
 - spec/commandable/command_line_execution_spec.rb
 - spec/commandable/commandable_spec.rb
 - spec/commandable/help_generator_spec.rb

data/_testing/alias_trap.rb

@@ -1,14 +0,0 @@
-require 'pp'
-# hash1 = {
-#   :c=>{:foo=>"a c command", :description=>"c description"},
-#   :a=>{:foo=>"z a command", :description=>"c description"}, 
-#   :b=>{:foo=>" buh command", :description=>"c description"}
-# }
-
-hash1 = [
-  {:foo=>"a c command", :description=>"c description"},
-  {:foo=>"z a command", :description=>"c description"}, 
-  {:foo=>" buh command", :description=>"c description"}
-]
-
-puts hash1.shift[:foo]