relish 0.1.0 → 0.1.1

data/features/help.feature

@@ -8,22 +8,32 @@ Feature: Help
     When I successfully run "relish help"
     Then the output should contain exactly:
       """
+      A <project> can be scoped by an organization or user handle. For
+      example, if an organiztion (rspec) has a project (rspec-core), then
+      the <project> would be `rspec/rspec-core`. If a user (justin) has a
+      project (my-project), then <project> would be `justin/my-project`.
+
+      If you leave off the organization or user handle, then it defaults
+      to the user (you).
+      
       === Available Commands
 
-      help                                                                               # show this usage
-      config                                                                             # display the contents of your options file
-      config:add --<option> <value>                                                      # add a configuration option to your options file
-      projects                                                                           # list your projects
-      projects:add <org_or_user_handle>/<project_handle>                                 # add a project
-                                                                                         # append :private to make the project private
-                                                                                         # example: relish projects:add rspec/rspec-core:private
-      projects:remove <org_or_user_handle>/<project_handle>                              # remove a project
-      push                                                                               # push features to relishapp.com
-      collab                                                                             # list the collaborators for a project
-      collab:add <org_or_user_handle>/<project_handle>:<collaborator_handle_or_email>    # add a collaborator to a project
-                                                                                         # example: relish collab:add rspec/rspec-core:justin
-      collab:remove <org_or_user_handle>/<project_handle>:<collaborator_handle_or_email> # remove a collaborator from a project
-                                                                                         # example: relish collab:remove rspec/rspec-core:justin
+      help                                                   # show this usage
+      config                                                 # display the contents of your options file
+      config:add <option>:<value>                            # add a configuration option to your options file
+                                                             # example: relish config:add project:rspec-core
+                                                             # valid configuration options: project
+      projects                                               # list your projects
+      projects:add <org_or_user_handle>/<project_handle>     # add a project
+                                                             # append :private to make the project private
+                                                             # example: relish projects:add rspec/rspec-core:private
+      projects:remove <org_or_user_handle>/<project_handle>  # remove a project
+      push <project>                                         # push features to relishapp.com
+      collab                                                 # list the collaborators for a project
+      collab:add <project>:<collaborator_handle_or_email>    # add a collaborator to a project
+                                                             # example: relish collab:add rspec/rspec-core:justin
+      collab:remove <project>:<collaborator_handle_or_email> # remove a collaborator from a project
+                                                             # example: relish collab:remove rspec/rspec-core:justin
       
       """
       

data/lib/relish.rb

@@ -1,5 +1,3 @@
-require 'relish/core_ext'
-
 module Relish
   class << self
     

data/lib/relish/commands/base.rb

@@ -1,15 +1,17 @@
 require 'yaml'
 require 'json'
 require 'relish/ui'
+require 'relish/helpers'
 require 'relish/options_file'
 require 'relish/commands/dsl'
+require 'relish/commands/param_methods'
 
 module Relish
   module Command
     class Base
+      include Relish::Helpers
       extend Dsl
       
-      option :project
       option :api_token, :default => lambda { get_and_store_api_token }
       option :host,      :default => lambda { Relish.default_host }, :display => false
       
@@ -18,7 +20,7 @@ module Relish
             
       def initialize(args = [])
         @args = clean_args(args)
-        @param = get_param
+        @param = get_param.extend(ParamMethods)
         @cli_options = Hash[*@args]
 
         validate_cli_options
@@ -33,6 +35,10 @@ module Relish
       end
 
     private
+    
+      def project
+        merged_options['project'] || error('You must specify a project.')
+      end
 
       def get_and_store_api_token
         api_token = get_api_token
@@ -62,14 +68,17 @@ module Relish
       end
       
       def validate_cli_options
-        @cli_options.keys.each do |option|
+        cli_options.keys.each do |option|
           unless valid_option_names.include?(option.to_s)
-            puts "#{option} is not a valid option."
-            exit 1
+            error "'#{option}' is not a valid option."
           end
         end
       end
       
+      def merged_options
+        @merged_options ||= global_options_file.merge(local_options_file)
+      end
+      
       def global_options_file
         @global_options ||= OptionsFile.new(Relish.global_options_file)
       end

data/lib/relish/commands/collab.rb

@@ -4,29 +4,35 @@ module Relish
       
       desc    'list the collaborators for a project'
       command :default do
-        puts format(resource[resource_path].get(:accept => :json))
+        puts format(resource[resource_path_for_no_option].get(:accept => :json))
       end
       
-      usage   'collab:add <org_or_user_handle>/<project_handle>:' +
-              '<collaborator_handle_or_email>'
+      usage   'collab:add <project>:<collaborator_handle_or_email>'
       desc    ['add a collaborator to a project',
-               'example: relish collab:add rspec/rspec-core:justin'].join("\n")
+               'example: relish collab:add rspec/rspec-core:justin']
       command :add do
-        puts resource[resource_path].post(:handle_or_email => handle_or_email)
+        puts resource[resource_path_for_option].post(:handle_or_email => handle_or_email)
       end
       
-      usage   'collab:remove <org_or_user_handle>/<project_handle>:' +
-              '<collaborator_handle_or_email>'
+      usage   'collab:remove <project>:<collaborator_handle_or_email>'
       desc    ['remove a collaborator from a project',
-               'example: relish collab:remove rspec/rspec-core:justin'].join("\n")
+               'example: relish collab:remove rspec/rspec-core:justin']
       command :remove do
-        puts resource["#{resource_path}/#{handle_or_email}"].delete
+        puts resource["#{resource_path_for_option}/#{handle_or_email}"].delete
       end
       
     private
-    
-      def resource_path
-        "projects/#{@param.remove_option}/memberships"
+      
+      def resource_path_for_no_option
+        resource_path(@param || project)
+      end
+      
+      def resource_path_for_option
+        resource_path(@param.extract_project_handle || project)
+      end
+      
+      def resource_path(project)
+        "projects/#{project}/memberships"
       end
       
       def handle_or_email

data/lib/relish/commands/config.rb

@@ -2,6 +2,26 @@ module Relish
   module Command
     class Config < Base
       
+      class Option
+        VALID_OPTIONS = %w(project)
+        
+        def initialize(param)
+          @option, @value = param.split(':')
+          validate_option
+        end
+        
+        def validate_option
+          unless VALID_OPTIONS.include?(@option)
+            Relish::Helpers.error "'#{@option}' is not a valid option." +
+                                  " Valid options: #{VALID_OPTIONS.join(', ')}"
+          end
+        end
+        
+        def to_hash
+          {@option => @value}
+        end
+      end
+
       desc    'display the contents of your options file'
       command :default do
         puts(if File.exists?(Relish.local_options_file)
@@ -11,10 +31,13 @@ module Relish
         end)
       end
       
-      usage   'config:add --<option> <value>'
-      desc    'add a configuration option to your options file'
+      usage   'config:add <option>:<value>'
+      desc    ['add a configuration option to your options file',
+               'example: relish config:add project:rspec-core',
+               "valid configuration options: #{Option::VALID_OPTIONS.join(', ')}"]
       command :add do
-        OptionsFile.new(Relish.local_options_file).store(@cli_options)
+        option = Option.new(@param)
+        OptionsFile.new(Relish.local_options_file).store(option.to_hash)
       end
       
     end

data/lib/relish/commands/dsl.rb

@@ -12,12 +12,13 @@ module Relish
         Option.names << name.to_s
       end
       
-      def usage(str)
-        HelpText.next_usage = str
+      def usage(text)
+        HelpText.next_usage = text
       end
       
-      def desc(str)
-        HelpText.next_description = str
+      def desc(text)
+        text = text.join("\n") if text.is_a?(Array)
+        HelpText.next_description = text
       end
       
       def command(arg, &block)

data/lib/relish/commands/help.rb

@@ -4,6 +4,16 @@ module Relish
       
       desc 'show this usage'
       command :default do
+        puts <<-TEXT
+A <project> can be scoped by an organization or user handle. For
+example, if an organiztion (rspec) has a project (rspec-core), then
+the <project> would be `rspec/rspec-core`. If a user (justin) has a
+project (my-project), then <project> would be `justin/my-project`.
+
+If you leave off the organization or user handle, then it defaults
+to the user (you).
+
+        TEXT
         puts "=== Available Commands\n\n"
         Dsl::HelpText.commands.each do |command, list|
           list.each {|hash| Formatter.new(command, hash).format }

data/lib/relish/commands/param_methods.rb

@@ -0,0 +1,23 @@
+module Relish
+  module Command
+    module ParamMethods
+      
+      def extract_option
+        include?(':') ? split(':')[1] : self
+      end
+
+      def without_option
+        split(':')[0]
+      end
+
+      def has_option?
+        include?(':')
+      end
+      
+      def extract_project_handle
+        self && (has_option? ? true : nil) && without_option
+      end
+      
+    end
+  end
+end   

data/lib/relish/commands/projects.rb

@@ -10,7 +10,7 @@ module Relish
       usage   'projects:add <org_or_user_handle>/<project_handle>'
       desc    ['add a project',
                'append :private to make the project private',
-               'example: relish projects:add rspec/rspec-core:private'].join("\n")
+               'example: relish projects:add rspec/rspec-core:private']
       command :add do
         puts resource['projects'].post(:handle => handle, :private => private?)
       end
@@ -31,7 +31,7 @@ module Relish
       end
       
       def handle
-        @param.remove_option
+        @param.without_option
       end
       
       def private?

data/lib/relish/commands/push.rb

@@ -8,6 +8,7 @@ module Relish
     class Push < Base
       option :version
       
+      usage   'push <project>'
       desc    'push features to relishapp.com'
       command :default do
         post files_as_tar_gz
@@ -28,6 +29,10 @@ module Relish
         end
       end
       
+      def project
+        @param || super()
+      end
+      
       def files_as_tar_gz
         stream = StringIO.new
         begin

data/lib/relish/helpers.rb

@@ -5,6 +5,7 @@ module Relish
       $stderr.puts(message)
       exit 1
     end
+    module_function :error
     
   end
 end

data/lib/relish/options_file.rb

@@ -28,6 +28,10 @@ module Relish
       options == other
     end
     
+    def merge(other)
+      options.merge(other.options)
+    end
+    
     # Stored options as a hash
     def options
       @options ||= current_options

data/relish.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = "relish"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = '>= 1.3.5'
   s.authors = ["Matt Wynne", "Justin Ko"]
-  s.date = "2010-11-13"
+  s.date = "2010-11-15"
   s.description = %q{Client gem for http://relishapp.com}
   s.email = "jko170@gmail.com"
 

data/spec/relish/commands/base_spec.rb

@@ -3,40 +3,6 @@ require 'spec_helper'
 module Relish
   module Command
     describe Base do
-    
-      describe "#project" do
-        context 'passed in command line' do
-          let(:base) { described_class.new(["--project", 'rspec-core']) }
-        
-          it 'returns the value' do
-            base.project.should eq('rspec-core')
-          end
-        end
-        
-        context 'contained in the local options file' do
-          let(:base) { described_class.new }
-          
-          before do
-            OptionsFile.stub(:new).with(
-              Relish.local_options_file
-            ).and_return({'project' => 'rspec-core'})
-          end
-          
-          it 'returns the value' do
-            base.project.should eq('rspec-core')
-          end
-        end
-      
-        context 'not passed in command line' do
-          let(:base) { described_class.new }
-        
-          context 'and options file does not exist' do
-            it 'returns nil' do
-              base.project.should be_nil
-            end
-          end
-        end
-      end
       
       describe '#url' do
         context 'host passed in command line' do

data/spec/relish/commands/param_methods_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Relish
+  module Command
+    describe ParamMethods do
+      
+      let(:foo_bar) { 'foo:bar'.extend(described_class) }
+      let(:foo) { 'foo'.extend(described_class) }
+      
+      describe '#extract_option' do
+        specify { foo_bar.extract_option.should eq('bar') }
+        specify { foo.extract_option.should eq('foo') }
+      end
+
+      describe '#without_option' do
+        specify { foo_bar.without_option.should eq('foo') }
+        specify { foo.without_option.should eq('foo') }
+      end
+
+      describe '#has_option?' do
+        specify { foo_bar.has_option?.should be_true }
+        specify { foo.has_option?.should be_false }
+      end
+      
+      describe '#extract_project_handle' do
+        specify { foo_bar.extract_project_handle.should eq('foo') }
+        specify { foo.extract_project_handle.should be_nil }
+      end
+      
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: relish
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Matt Wynne
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 -07:00
+date: 2010-11-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -181,7 +181,6 @@ files:
 - cucumber.yml
 - features/help.feature
 - features/projects.feature
-- features/push.feature
 - features/step_definitions/aruba.rb
 - features/step_definitions/fake_web_steps.rb
 - features/step_definitions/relish_steps.rb
@@ -197,9 +196,9 @@ files:
 - lib/relish/commands/dsl/help_text.rb
 - lib/relish/commands/dsl/option.rb
 - lib/relish/commands/help.rb
+- lib/relish/commands/param_methods.rb
 - lib/relish/commands/projects.rb
 - lib/relish/commands/push.rb
-- lib/relish/core_ext.rb
 - lib/relish/helpers.rb
 - lib/relish/options_file.rb
 - lib/relish/ui.rb
@@ -210,9 +209,9 @@ files:
 - 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/param_methods_spec.rb
 - spec/relish/commands/projects_spec.rb
 - spec/relish/commands/push_spec.rb
-- spec/relish/core_ext_spec.rb
 - spec/relish/options_file_spec.rb
 - spec/relish_spec.rb
 - spec/spec_helper.rb
@@ -256,7 +255,6 @@ summary: Client gem for http://relishapp.com
 test_files: 
 - features/help.feature
 - features/projects.feature
-- features/push.feature
 - features/step_definitions/aruba.rb
 - features/step_definitions/fake_web_steps.rb
 - features/step_definitions/relish_steps.rb
@@ -267,9 +265,9 @@ test_files:
 - 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/param_methods_spec.rb
 - spec/relish/commands/projects_spec.rb
 - spec/relish/commands/push_spec.rb
-- spec/relish/core_ext_spec.rb
 - spec/relish/options_file_spec.rb
 - spec/relish_spec.rb
 - spec/spec_helper.rb

data/features/push.feature

@@ -1,12 +0,0 @@
-@announce
-Feature: Push
-  In order to send my features to relishapp.com
-  As a Relish user dev
-  I want a push command
-  
-  Background:
-    Given my API token "1234" is stored
-  
-  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"

data/lib/relish/core_ext.rb

@@ -1,15 +0,0 @@
-module Relish
-  module StringExtensions
-    def extract_option
-      split(':')[1]
-    end
-    
-    def remove_option
-      split(':')[0]
-    end
-  end
-end
-
-class String
-  include Relish::StringExtensions
-end

data/spec/relish/core_ext_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe String do
-  describe '#extract_option' do
-    specify { 'foo:bar'.extract_option.should eq('bar') }
-  end
-  
-  describe '#remove_option' do
-    specify { 'foo:bar'.remove_option.should eq('foo') }
-  end
-end