relish 0.0.8 → 0.0.9

data/features/help.feature

@@ -0,0 +1,37 @@
+@announce
+Feature: Help
+  
+  The `relish help` command displays all available commands
+  along with a description of each.
+  
+  The `relish help:<command>` option will display help text
+  for that particular command.
+  
+  Scenario: View all available commands with the help command
+    When I successfully run "relish help"
+    Then the output should contain exactly:
+      """
+      === Available Commands
+
+      help                                                  # show this usage
+      config                                                # display the contents of your options file
+      config:show                                           # display the contents of your options file
+      config:add --<option> <value>                         # add a configuration option to your options file
+      projects                                              # list your projects
+      projects:list                                         # list your projects
+      projects:add <org_or_user_handle>/<project_handle>    # add a project
+      projects:remove <org_or_user_handle>/<project_handle> # remove a project
+      push                                                  # push features to relishapp.com
+      
+      """
+      
+  Scenario: Specifying no command runs the help command
+    When I successfully run "relish"
+    Then the output should contain "=== Available Commands"
+    
+  Scenario: Specifying an unknown command gives an error message
+    When I run "relish baloney"
+    Then it should fail with:
+      """
+      Unknown command. Run 'relish help' for usage information.
+      """

data/features/push.feature

@@ -9,4 +9,4 @@ Feature: Push
   
   Scenario: Specify everything at the command-line
     When I run relish push --host localhost:1234 --project p
-    Then it should POST to "http://localhost:1234/api/pushes?project_id=p&api_token=1234"
+    Then it should POST to "http://localhost:1234/api/pushes?project_id=p"

data/lib/relish/command.rb

@@ -1,4 +1,5 @@
 require 'relish'
+require 'relish/helpers'
 require 'relish/commands/base'
 require 'relish/commands/push'
 require 'relish/commands/config'
@@ -8,14 +9,31 @@ require 'relish/commands/help'
 module Relish
   module Command
     
-    def self.run(command, args)
-      command_class, method = get_command_and_method(command, args)      
-      command_class.new(args).send(method)
-    end
+    class << self
+      include Relish::Helpers
+      
+      def run(command, args)
+        command_class, method = get_command_and_method(command, args)      
+        command_class.new(args).send(method)
+      end
+    
+      def get_command_and_method(command, args)
+        command_class, method = command.split(':')
+        return get_command(command_class.capitalize), get_method(method)
+      rescue NameError
+        error "Unknown command. Run 'relish help' for usage information."
+      end
+      
+    private
     
-    def self.get_command_and_method(command, args)
-      command_class, method = command.split(':')
-      return Relish::Command.const_get(command_class.capitalize), (method || :default)
+      def get_command(command)
+        Relish::Command.const_get(command)
+      end
+      
+      def get_method(method)
+        method || :default
+      end
+      
     end
     
   end

data/lib/relish/commands/base.rb

@@ -57,19 +57,13 @@ module Relish
       end
       
       def valid_option_names
-        self.class.option_names
-      end
-      
-      def option_names_to_display
-        self.class.option_names_to_display
+        Dsl::Option.names
       end
       
       def validate_cli_options
         @cli_options.keys.each do |option|
           unless valid_option_names.include?(option.to_s)
-            puts "#{option} is not a valid option.\n" +
-                 "Valid options are: #{option_names_to_display.sort.join(', ')}"
-                  
+            puts "#{option} is not a valid option."
             exit 1
           end
         end

data/lib/relish/commands/config.rb

@@ -2,11 +2,12 @@ module Relish
   module Command
     class Config < Base
       
-      def default
-        show
-      end
+      desc    'display the contents of your options file'
+      command :default => :show
       
-      def show
+      usage   'config:show'
+      desc    'display the contents of your options file'
+      command :show do
         puts(if File.exists?(Relish.local_options_file)
           IO.read(Relish.local_options_file)
         else
@@ -14,7 +15,9 @@ module Relish
         end)
       end
       
-      def add
+      usage   'config:add --<option> <value>'
+      desc    'add a configuration option to your options file'
+      command :add do
         OptionsFile.new(Relish.local_options_file).store(@cli_options)
       end
       

data/lib/relish/commands/dsl/base.rb

@@ -0,0 +1,23 @@
+module Relish
+  module Command
+    module Dsl
+      class Base
+        
+        attr_reader :context
+        
+        def initialize(context)
+          @context = context
+        end
+        
+        def context_eval(&block)
+          context.class_eval(&block)
+        end
+        
+        def context_name
+          context.name.split('::').last.downcase
+        end
+        
+      end
+    end
+  end
+end

data/lib/relish/commands/dsl/command.rb

@@ -0,0 +1,23 @@
+module Relish
+  module Command
+    module Dsl
+      class Command < Base
+        
+        def define(name, &block)
+          context_eval do
+            define_method(name) do
+              begin
+                instance_exec(&block)
+              rescue RestClient::Exception => exception
+                warn exception.response
+                exit 1
+              end
+            end
+          end
+          HelpText.add(name, context_name)
+        end
+        
+      end
+    end
+  end
+end

data/lib/relish/commands/dsl/help_text.rb

@@ -0,0 +1,42 @@
+module Relish
+  module Command
+    module Dsl
+      class HelpText
+        
+        class << self
+          attr_accessor :current_command, :next_usage, :next_description
+        
+          def add(name, command)
+            self.current_command = name
+            commands[command] = [] unless commands.key?(command)
+            commands[command].push(get_next_usage => get_next_description)
+            reset_accessors
+          end
+        
+          def get_next_usage
+            next_usage or current_command.to_s
+          end
+        
+          def get_next_description
+            next_description || raise(
+              "please set a description for #{current_command.inspect}"
+            )
+          end
+        
+          def commands
+            @commands ||= {}
+          end
+        
+          def reset_accessors
+            self.current_command = self.next_usage = self.next_description = nil
+          end
+          
+          def clear_commands
+            @commands = {}
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/relish/commands/dsl/option.rb

@@ -0,0 +1,27 @@
+module Relish
+  module Command
+    module Dsl
+      class Option < Base
+        
+        def define(name, options = {})
+          name = name.to_s
+          default_proc = options[:default] || Proc.new {}
+
+          context_eval do
+            define_method(name) do
+              cli_options[name] ||
+              local_options_file[name] ||
+              global_options_file[name] ||
+              instance_exec(&default_proc)
+            end
+          end
+        end
+        
+        def self.names
+          @@names ||= []
+        end
+        
+      end
+    end
+  end
+end

data/lib/relish/commands/dsl.rb

@@ -1,28 +1,37 @@
+require 'relish/commands/dsl/base'
+require 'relish/commands/dsl/option'
+require 'relish/commands/dsl/command'
+require 'relish/commands/dsl/help_text'
+
 module Relish
   module Command
     module Dsl
       
       def option(name, options = {})
-        name = name.to_s
-        default_proc = options[:default] || Proc.new {}
-        
-        define_method(name) do
-          cli_options[name] ||
-          local_options_file[name] ||
-          global_options_file[name] ||
-          instance_exec(&default_proc)
-        end
-        
-        option_names << name
-        option_names_to_display << name unless options[:display] == false
+        Option.new(self).define(name, options)
+        Option.names << name.to_s
       end
       
-      def option_names
-        @@option_names ||= []
+      def usage(str)
+        HelpText.next_usage = str
       end
       
-      def option_names_to_display
-        @@option_names_to_display ||= []
+      def desc(str)
+        HelpText.next_description = str
+      end
+      
+      def command(arg, &block)
+        case arg
+        when Hash
+          name, alias_target = arg.to_a.flatten
+          block = lambda { self.send(alias_target) }
+        when Symbol
+          name = arg
+        else
+          raise ArgumentError
+        end
+        
+        Command.new(self).define(name, &block)
       end
       
     end

data/lib/relish/commands/help.rb

@@ -3,29 +3,26 @@ require 'yaml'
 module Relish
   module Command
     class Help < Base
-      class << self
-        def for_command(command, help)
-          command_help[command] = help
-        end
-        
-        def command_help
-          @command_help ||= {}
-        end
-      end
       
-      def default
-        puts "This is the prefunctory help message for the relish gem."
+      desc    'show this usage'
+      command :default do
+        puts "=== Available Commands\n\n"
 
-        puts "Commands:"
-        Help.command_help.each do |command, help|
-          message = "relish #{command}".ljust(max_command_length) + 
-                    " # " + help
-          puts message
+        Dsl::HelpText.commands.each do |command, list|
+          list.each do |hash|
+            usage, description = *hash.to_a.flatten
+            usage = command if usage == 'default'
+            puts "#{usage.ljust(max_command_length)} # #{description}"
+          end
         end
       end
       
+    private
+      
       def max_command_length
-        Help.command_help.keys.map { |c| c.to_s.length }.max
+        Dsl::HelpText.commands.values.map {|v|
+          v.map {|v| v.keys.to_s.length }.max
+        }.max
       end
     end
   end

data/lib/relish/commands/projects.rb

@@ -5,30 +5,26 @@ module Relish
   module Command
     class Projects < Base
       
-      def default; list end
+      desc    'list your projects'
+      command :default => :list
       
-      def list
-        response = resource['projects'].get(
-          :params => {:api_token => api_token}, :accept => :json
-        )
+      usage   'projects:list'
+      desc    'list your projects'
+      command :list do
+        response = resource['projects'].get(:accept => :json)
         puts format(response)
-      rescue RestClient::Exception => exception
-        warn exception.response
-        exit exception.http_code
       end
       
-      def add
+      usage   'projects:add <org_or_user_handle>/<project_handle>'
+      desc    'add a project'
+      command :add do
         puts resource['projects'].post(:handle => @param)
-      rescue RestClient::Exception => exception
-        warn exception.response
-        exit 1
       end
       
-      def remove
+      usage   'projects:remove <org_or_user_handle>/<project_handle>'
+      desc    'remove a project'
+      command :remove do
         puts resource["projects/#{@param}"].delete
-      rescue RestClient::Exception => exception
-        warn exception.response
-        exit 1
       end
       
     private

data/lib/relish/commands/push.rb

@@ -6,26 +6,21 @@ require 'rest_client'
 require 'relish/commands/help'
 
 module Relish
-  module Command
-    Help.for_command(:push, "push your features to relishapp.com")
-    
+  module Command    
     class Push < Base
-      
       option :version
       
-      def default; run end
-      
-      def run
+      desc    'push features to relishapp.com'
+      command :default do
         post files_as_tar_gz
       end
+      
+    private
           
       def post(tar_gz_data)
         resource["pushes?#{parameters}"].post(tar_gz_data,
           :content_type => 'application/x-gzip')
         puts "sent:\n#{files.join("\n")}"
-      rescue RestClient::Exception => exception
-        warn exception.response
-        exit 1
       end
       
       def parameters

data/lib/relish/helpers.rb

@@ -0,0 +1,10 @@
+module Relish
+  module Helpers
+    
+    def error(message)
+      $stderr.puts(message)
+      exit 1
+    end
+    
+  end
+end

data/relish.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "relish"
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = '>= 1.3.5'
   s.authors = ["Matt Wynne", "Justin Ko"]

data/spec/relish/commands/dsl/base_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Relish
+  module Command
+    module Dsl
+      describe Base do
+        
+        describe '#context_eval' do
+          let(:context_class) { Class.new }
+          let(:base) { described_class.new(context_class) }
+          let(:the_block) { Proc.new { "Hi, I'm a block" } }
+          
+          it 'calls class_eval on the context_class with the given block' do
+            context_class.should_receive(:class_eval).with(&the_block)
+            base.context_eval(&the_block)
+          end
+        end
+        
+        describe '#context_name' do
+          let(:context_class) { Class.new }
+          let(:base) { described_class.new(context_class) }
+          before { context_class.should_receive(:name).and_return('::Dog') }
+          
+          it 'returns the class name downcased' do
+            base.context_name.should eq('dog')
+          end
+        end
+        
+      end
+    end
+  end
+end

data/spec/relish/commands/dsl/command_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Relish
+  module Command
+    module Dsl
+      describe Command do
+        
+        describe '#define' do
+          let(:context_class) { Class.new }
+          let(:command) { described_class.new(context_class) }
+          let(:the_instance) { context_class.new }
+          
+          before do
+            context_class.should_receive(:name).and_return('::Dog')
+            HelpText.stub(:add)
+          end
+          
+          it 'defines an instance method on the context class' do
+            command.define(:my_command) {}
+            the_instance.should respond_to(:my_command)
+          end
+          
+          context 'the instance method' do
+            
+            it 'evaluates the block' do
+              command.define(:my_command) { 'my command value' }
+              the_instance.my_command.should eq('my command value')
+            end
+            
+            it 'rescues RestClient::Exception' do
+              command.define(:my_command) do
+                raise RestClient::Exception.new('uh oh an exception')
+              end
+              the_instance.should_receive(:warn).with('uh oh an exception')
+              the_instance.should_receive(:exit).with(1)
+              the_instance.my_command
+            end
+              
+          end
+          
+        end
+        
+      end
+    end
+  end
+end

data/spec/relish/commands/dsl/help_text_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+module Relish
+  module Command
+    module Dsl
+      describe HelpText do
+        
+        describe '.add' do
+                    
+          it 'adds a command to the hash of commands' do
+            HelpText.clear_commands
+            
+            HelpText.should_receive(:get_next_usage).and_return('usage')
+            HelpText.should_receive(:get_next_description).and_return('description')
+            HelpText.should_receive(:reset_accessors)
+            
+            HelpText.add(:my_command, 'projects')
+            HelpText.commands.should eq(
+              {'projects' => [{'usage' => 'description'}]}
+            )
+          end
+          
+        end
+        
+        describe '.get_next_usage' do
+          
+          context 'with next_usage set' do
+            before { HelpText.next_usage = 'foo' }
+            
+            it 'returns next_usage' do
+              HelpText.get_next_usage.should eq('foo')
+            end
+          end
+          
+          context 'without next_usage set' do
+            before do
+              HelpText.next_usage = nil
+              HelpText.current_command = 'bar'
+            end
+            
+            it 'returns current_command' do
+              HelpText.get_next_usage.should eq('bar')
+            end
+          end
+          
+        end
+        
+        describe '.get_next_description' do
+          
+          context 'with next_description set' do
+            before { HelpText.next_description = 'foo' }
+            
+            it 'returns next_description' do
+              HelpText.get_next_description.should eq('foo')
+            end
+          end
+          
+          context 'without next_description set' do
+            before do
+              HelpText.current_command = :bar
+              HelpText.next_description = nil
+            end
+            
+            it 'raises an exception' do
+              expect { HelpText.get_next_description }.to raise_exception(
+                'please set a description for :bar'
+              )
+            end
+          end
+        
+        end
+        
+        describe '.reset_accessors' do
+          before do
+            HelpText.current_command  = 'foo'
+            HelpText.next_usage       = 'foo'
+            HelpText.next_description = 'foo'
+          end
+          
+          it 'sets all accessors to nil' do
+            HelpText.current_command.should eq('foo')
+            HelpText.next_usage.should eq('foo')
+            HelpText.next_description.should eq('foo')
+            
+            HelpText.reset_accessors
+            
+            HelpText.current_command.should be_nil
+            HelpText.next_usage.should be_nil
+            HelpText.next_description.should be_nil
+          end
+        end
+          
+      end
+    end
+  end
+end

data/spec/relish/commands/dsl/option_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module Relish
+  module Command
+    module Dsl
+      describe Option do
+        
+        describe '#define' do
+          let(:context_class) { Class.new }
+          let(:option) { described_class.new(context_class) }
+          let(:the_instance) { context_class.new }
+          
+          before do
+            option.define(:my_option, :default => lambda { "I'm a proc!" })
+          end
+          
+          it 'defines an instance method on the context class' do
+            the_instance.should respond_to(:my_option)
+          end
+          
+          context 'the instance method' do
+            
+            it 'calls on #cli_options' do
+              the_instance.should_receive(:cli_options).and_return(
+                'my_option' => 'a_cli_option_value'
+              )
+              the_instance.my_option.should eq('a_cli_option_value')
+            end
+            
+            it 'calls on #local_options_file' do
+              the_instance.should_receive(:cli_options).and_return({})
+              the_instance.should_receive(:local_options_file).and_return(
+                'my_option' => 'a_local_option_value'
+              )
+              the_instance.my_option.should eq('a_local_option_value')
+            end
+            
+            it 'calls on #global_options_file' do
+              the_instance.should_receive(:cli_options).and_return({})
+              the_instance.should_receive(:local_options_file).and_return({})
+              the_instance.should_receive(:global_options_file).and_return(
+                'my_option' => 'a_global_option_value'
+              )
+              the_instance.my_option.should eq('a_global_option_value')
+            end
+            
+            it 'calls the :default proc' do
+              the_instance.should_receive(:cli_options).and_return({})
+              the_instance.should_receive(:local_options_file).and_return({})
+              the_instance.should_receive(:global_options_file).and_return({})
+              the_instance.my_option.should eq("I'm a proc!")
+            end
+              
+          end
+          
+        end
+        
+        describe '.names' do
+          specify { described_class.should_not have(0).names }
+        end
+        
+      end
+    end
+  end
+end

data/spec/relish/commands/push_spec.rb

@@ -7,56 +7,12 @@ module Relish
       describe '#default' do
         let(:push) { described_class.new }
         
-        it 'calls #run' do
-          push.should_receive(:run)
+        it 'calls #post' do
+          push.should_receive(:post)
           push.default
         end
       end
       
-      describe '#parameters' do
-        before { push.should_receive(:project).and_return('rspec') }
-        
-        context 'without version' do 
-          let(:push) { described_class.new }
-          
-          specify do
-            push.parameters.should eq("project_id=rspec")
-          end
-        end
-        
-        context 'with version' do
-          let(:push) { described_class.new(['--version', 'one']) }
-          
-          specify do
-            push.parameters.should eq("project_id=rspec&version_id=one")
-          end
-        end
-      end
-      
-      describe '#version' do
-        context 'with --version passed in command line' do
-          let(:push) { described_class.new(['--version', 'one']) }
-          specify { push.version.should eq('one') }
-        end
-        
-        context 'with --version not passed in command line' do
-          let(:push) { described_class.new }
-          specify { push.version.should be_nil }
-        end
-      end
-      
-      describe '#files_as_tar_gz' do
-        let(:push) { described_class.new }
-        specify { expect { push.files_as_tar_gz }.to_not raise_exception }
-        specify { push.files_as_tar_gz.should be_a(String) }
-      end
-      
-      describe '#files' do
-        let(:push) { described_class.new }
-        specify { expect { push.files }.to_not raise_exception }
-        specify { push.files.should be_a(Array) }
-      end
-      
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: relish
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Matt Wynne
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 +01:00
+date: 2010-09-23 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -179,6 +179,7 @@ files:
 - Rakefile
 - bin/relish
 - cucumber.yml
+- features/help.feature
 - features/projects.feature
 - features/push.feature
 - features/step_definitions/aruba.rb
@@ -190,15 +191,24 @@ files:
 - lib/relish/commands/base.rb
 - lib/relish/commands/config.rb
 - lib/relish/commands/dsl.rb
+- lib/relish/commands/dsl/base.rb
+- lib/relish/commands/dsl/command.rb
+- lib/relish/commands/dsl/help_text.rb
+- lib/relish/commands/dsl/option.rb
 - lib/relish/commands/help.rb
 - lib/relish/commands/projects.rb
 - lib/relish/commands/push.rb
+- lib/relish/helpers.rb
 - lib/relish/options_file.rb
 - lib/relish/ui.rb
 - relish.gemspec
 - spec/relish/command_spec.rb
 - spec/relish/commands/base_spec.rb
 - spec/relish/commands/config_spec.rb
+- spec/relish/commands/dsl/base_spec.rb
+- spec/relish/commands/dsl/command_spec.rb
+- spec/relish/commands/dsl/help_text_spec.rb
+- spec/relish/commands/dsl/option_spec.rb
 - spec/relish/commands/projects_spec.rb
 - spec/relish/commands/push_spec.rb
 - spec/relish/options_file_spec.rb
@@ -241,6 +251,7 @@ signing_key:
 specification_version: 3
 summary: Client gem for http://relishapp.com
 test_files: 
+- features/help.feature
 - features/projects.feature
 - features/push.feature
 - features/step_definitions/aruba.rb
@@ -250,6 +261,10 @@ test_files:
 - spec/relish/command_spec.rb
 - spec/relish/commands/base_spec.rb
 - spec/relish/commands/config_spec.rb
+- spec/relish/commands/dsl/base_spec.rb
+- spec/relish/commands/dsl/command_spec.rb
+- spec/relish/commands/dsl/help_text_spec.rb
+- spec/relish/commands/dsl/option_spec.rb
 - spec/relish/commands/projects_spec.rb
 - spec/relish/commands/push_spec.rb
 - spec/relish/options_file_spec.rb