shelly 0.1.23 → 0.1.24.pre

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+* [feature] Option --help [-h] added to all tasks
+
 ## 0.1.23 / 2012-08-08
 
 * Don't display mail server IP address in shelly info

data/README.md

@@ -13,7 +13,3 @@
 ## Running tests
 
     bundle exec rake
-
-or
-
-    guard

data/lib/shelly/app.rb

@@ -9,8 +9,7 @@ module Shelly
     SERVER_SIZES = %w(small large)
 
     attr_accessor :code_name, :databases, :ruby_version, :environment,
-      :git_url, :domains, :web_server_ip, :mail_server_ip, :size, :thin,
-      :redeem_code
+      :git_url, :domains, :web_server_ip, :size, :thin, :redeem_code
 
     def initialize(code_name = nil)
       self.code_name = code_name

data/lib/shelly/cli/backup.rb

@@ -32,7 +32,7 @@ module Shelly
 
           say "Available backups:", :green
           say_new_line
-          print_table(to_display, :ident => 2)
+          print_table(to_display, :indent => 2)
         else
           say "No database backups available"
         end

data/lib/shelly/cli/command.rb

@@ -4,13 +4,21 @@ require "thor/thor"
 require "thor/group"
 require "thor/options"
 require "thor/arguments"
-require "thor/basic"
 
 module Shelly
   module CLI
     class Command < Thor
       include Helpers
       class_option :debug, :type => :boolean, :desc => "Show debug information"
+      class_option :help, :type => :boolean, :aliases => "-h", :desc => "Describe available tasks or one specific task"
+
+      def initialize(*)
+        super
+        if options[:help]
+          help(self.class.send(:retrieve_task_name, ARGV.dup))
+          exit(0)
+        end
+      end
     end
   end
 end

data/lib/shelly/cli/config.rb

@@ -79,8 +79,7 @@ module Shelly
       end
 
       desc "delete PATH", "Delete configuration file"
-      def delete(path = nil)
-        say_error "No configuration file specified" unless path
+      def delete(path)
         app = multiple_clouds(options[:cloud], "delete #{path}")
         answer = yes?("Are you sure you want to delete 'path' (yes/no): ")
         if answer

data/lib/shelly/cli/main.rb

@@ -19,7 +19,6 @@ module Shelly
 
       check_unknown_options!(:except => :rake)
 
-      # FIXME: it should be possible to pass single symbol, instead of one element array
       before_hook :logged_in?, :only => [:add, :status, :list, :start, :stop, :logs, :delete, :info, :ip, :logout, :execute, :rake, :setup, :console, :dbconsole]
       before_hook :inside_git_repository?, :only => [:add, :setup, :check]
 
@@ -134,7 +133,7 @@ module Shelly
             end
             [app["code_name"], "|  #{state.humanize}#{msg}"]
           end
-          print_table(apps_table, :ident => 2)
+          print_table(apps_table, :indent => 2)
         else
           say "You have no clouds yet", :green
         end
@@ -149,22 +148,21 @@ module Shelly
           " (deployment log: `shelly deploys show last -c #{app}`)"
         end
         say "Cloud #{app}:", msg.present? ? :red : :green
-        print_wrapped "State: #{app.state}#{msg}", :ident => 2
+        print_wrapped "State: #{app.state}#{msg}", :indent => 2
         say_new_line
-        print_wrapped "Deployed commit sha: #{app.git_info["deployed_commit_sha"]}", :ident => 2
-        print_wrapped "Deployed commit message: #{app.git_info["deployed_commit_message"]}", :ident => 2
-        print_wrapped "Deployed by: #{app.git_info["deployed_push_author"]}", :ident => 2
+        print_wrapped "Deployed commit sha: #{app.git_info["deployed_commit_sha"]}", :indent => 2
+        print_wrapped "Deployed commit message: #{app.git_info["deployed_commit_message"]}", :indent => 2
+        print_wrapped "Deployed by: #{app.git_info["deployed_push_author"]}", :indent => 2
         say_new_line
-        print_wrapped "Repository URL: #{app.git_info["repository_url"]}", :ident => 2
-        print_wrapped "Web server IP: #{app.web_server_ip}", :ident => 2
-        print_wrapped "Mail server IP: #{app.mail_server_ip}", :ident => 2
+        print_wrapped "Repository URL: #{app.git_info["repository_url"]}", :indent => 2
+        print_wrapped "Web server IP: #{app.web_server_ip}", :indent => 2
         say_new_line
         if app.statistics.present?
-          print_wrapped "Statistics:", :ident => 2
+          print_wrapped "Statistics:", :indent => 2
           app.statistics.each do |stat|
-            print_wrapped "#{stat['name']}:", :ident => 4
-            print_wrapped "Load average: 1m: #{stat['load']['avg01']}, 5m: #{stat['load']['avg05']}, 15m: #{stat['load']['avg15']}", :ident => 6
-            print_wrapped "CPU: #{stat['cpu']['wait']}%, MEM: #{stat['memory']['percent']}%, SWAP: #{stat['swap']['percent']}%", :ident => 6
+            print_wrapped "#{stat['name']}:", :indent => 4
+            print_wrapped "Load average: 1m: #{stat['load']['avg01']}, 5m: #{stat['load']['avg05']}, 15m: #{stat['load']['avg15']}", :indent => 6
+            print_wrapped "CPU: #{stat['cpu']['wait']}%, MEM: #{stat['memory']['percent']}%, SWAP: #{stat['swap']['percent']}%", :indent => 6
           end
         end
       rescue Client::GatewayTimeoutException

data/lib/shelly/version.rb

@@ -1,3 +1,3 @@
 module Shelly
-  VERSION = "0.1.23"
+  VERSION = "0.1.24.pre"
 end

data/lib/thor/options.rb

@@ -1,11 +1,10 @@
 class Thor
   class Options < Arguments
-
     def check_unknown!
+      unknown = @extra.select { |str| str =~ /^--?(?:(?!--).)*$/ }
       raise UnknownArgumentError, "shelly: unrecognized option '#{@unknown.join(', ')}'\n" +
         "Usage: shelly [COMMAND]... [OPTIONS]\n" +
-        "Try 'shelly --help' for more information" unless @unknown.empty?
+        "Try 'shelly --help' for more information" unless unknown.empty?
     end
-
   end
 end

data/lib/thor/thor.rb

@@ -2,7 +2,7 @@ class Thor
   class << self
     def before_hook(method, options = {})
       @hook = {} unless @hook
-      @hook[method] = options
+      @hook[method] = {:only => Array(options[:only])}
     end
 
     def hooks
@@ -12,9 +12,9 @@ class Thor
     def send(*args)
       if args.first == :dispatch && !args[2].empty?
         running_task = args[2].first
-
+        help = args[2].include?('--help') || args[2].include?('-h')
         @hook.each do |method, options|
-          if options[:only].include?(running_task.to_sym)
+          if options[:only].include?(running_task.to_sym) && !help
             new.send(method)
           end
         end
@@ -28,12 +28,46 @@ class Thor
     rescue Thor::Error => e
       ENV["THOR_DEBUG"] == "1" ? (raise e) : config[:shell].error(e.message)
       exit(1) if exit_on_failure?
+    rescue Errno::EPIPE
+      # This happens if a thor task is piped to something like `head`,
+      # which closes the pipe when it's done reading. This will also
+      # mean that if the pipe is closed, further unnecessary
+      # computation will not occur.
+      exit(0)
     end
 
-    # We overwrite this method so namespace is show
+    # We overwrite this method so namespace is shown
     # shelly *backup* restore FILENAME
-    def handle_argument_error(task, error)
-      raise InvocationError, "#{task.name.inspect} was called incorrectly. Call as #{self.banner(task, nil, self.to_s != 'Shelly::CLI::Main').inspect}."
+    def handle_argument_error(task, error, arity = nil)
+      banner = self.banner(task, nil, self.to_s != 'Shelly::CLI::Main')
+      raise InvocationError, "#{task.name.inspect} was called incorrectly. Call as `#{banner}`"
+    end
+
+    protected
+    # this has to overwritten so that in tests args are passed correctly
+    # only change is the commented line
+    # its for some edge cases when boolean options are passed in some
+    # strange order
+    def dispatch(meth, given_args, given_opts, config) #:nodoc:
+      meth ||= retrieve_task_name(given_args)
+      task = all_tasks[normalize_task_name(meth)]
+
+      if task
+        args, opts = Thor::Options.split(given_args)
+      else
+        args, opts = given_args, nil
+        task = Thor::DynamicTask.new(meth)
+      end
+
+      opts = given_opts || opts || []
+      config.merge!(:current_task => task, :task_options => task.options)
+
+      instance = new(args, opts, config)
+      yield instance if block_given?
+      # args = instance.args
+      trailing = args[Range.new(arguments.size, -1)]
+
+      instance.invoke_task(task, trailing || [])
     end
   end
 end

data/shelly.gemspec

@@ -14,8 +14,6 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "shelly"
   s.add_development_dependency "rspec", "~> 2.11.0"
   s.add_development_dependency "rake"
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-rspec"
   s.add_development_dependency "simplecov"
   if RUBY_PLATFORM =~ /darwin/
     s.add_development_dependency "ruby_gntp"
@@ -23,7 +21,7 @@ Gem::Specification.new do |s|
   end
   s.add_development_dependency "fakefs"
   s.add_development_dependency "fakeweb"
-  s.add_runtime_dependency "wijet-thor", "~> 0.14.7"
+  s.add_runtime_dependency "thor", "~> 0.15.4"
   s.add_runtime_dependency "rest-client"
   s.add_runtime_dependency "json"
   s.add_runtime_dependency "progressbar"

data/spec/shelly/cli/files_spec.rb

@@ -29,7 +29,6 @@ describe Shelly::CLI::Files do
 
     it "should exit if rsync isn't installed" do
       FakeFS::File.stub(:executable?).and_return(false)
-
       $stdout.should_receive(:puts).with(red "You need to install rsync in order to upload and download files")
       lambda { invoke(@cli_files, :upload, "some/path") }.should raise_error(SystemExit)
     end

data/spec/shelly/cli/main_spec.rb

@@ -25,38 +25,34 @@ describe Shelly::CLI::Main do
 
   describe "#help" do
     it "should display available commands" do
-      expected = <<-OUT
-Tasks:
-  shelly add                # Add a new cloud
-  shelly backup <command>   # Manage database backups
-  shelly check              # Check if application fulfills Shelly Cloud requirements
-  shelly config <command>   # Manage application configuration files
-  shelly console            # Open application console
-  shelly dbconsole          # Run rails dbconsole
-  shelly delete             # Delete the cloud
-  shelly deploys <command>  # View deploy logs
-  shelly files <command>    # Upload and download files to and from persistent storage
-  shelly help [TASK]        # Describe available tasks or one specific task
-  shelly info               # Show basic information about cloud
-  shelly list               # List available clouds
-  shelly login [EMAIL]      # Log into Shelly Cloud
-  shelly logout             # Logout from Shelly Cloud
-  shelly logs               # Show latest application logs
-  shelly open               # Open application page in browser
-  shelly rake TASK          # Run rake task
-  shelly redeploy           # Redeploy application
-  shelly register [EMAIL]   # Register new account
-  shelly setup              # Set up git remotes for deployment on Shelly Cloud
-  shelly start              # Start the cloud
-  shelly stop               # Shutdown the cloud
-  shelly user <command>     # Manage collaborators
-  shelly version            # Display shelly version
-
-Options:
-  [--debug]  # Show debug information
-OUT
       out = IO.popen("bin/shelly --debug").read.strip
-      out.should == expected.strip
+      out.should include("Tasks:")
+      out.should include("shelly add                # Add a new cloud")
+      out.should include("shelly backup <command>   # Manage database backups")
+      out.should include("shelly check              # Check if application fulfills Shelly Cloud requirements")
+      out.should include("shelly config <command>   # Manage application configuration files")
+      out.should include("shelly console            # Open application console")
+      out.should include("shelly dbconsole          # Run rails dbconsole")
+      out.should include("shelly delete             # Delete the cloud")
+      out.should include("shelly deploys <command>  # View deploy logs")
+      out.should include("shelly files <command>    # Upload and download files to and from persistent storage")
+      out.should include("shelly help [TASK]        # Describe available tasks or one specific task")
+      out.should include("shelly info               # Show basic information about cloud")
+      out.should include("shelly list               # List available clouds")
+      out.should include("shelly login [EMAIL]      # Log into Shelly Cloud")
+      out.should include("shelly logout             # Logout from Shelly Cloud")
+      out.should include("shelly logs               # Show latest application logs")
+      out.should include("shelly open               # Open application page in browser")
+      out.should include("shelly rake TASK          # Run rake task")
+      out.should include("shelly redeploy           # Redeploy application")
+      out.should include("shelly register [EMAIL]   # Register new account")
+      out.should include("shelly setup              # Set up git remotes for deployment on Shelly Cloud")
+      out.should include("shelly start              # Start the cloud")
+      out.should include("shelly stop               # Shutdown the cloud")
+      out.should include("shelly user <command>     # Manage collaborators")
+      out.should include("Options")
+      out.should include("[--debug]  # Show debug information")
+      out.should include("-h, [--help]   # Describe available tasks or one specific task")
     end
 
     it "should display options in help for logs" do
@@ -68,6 +64,14 @@ OUT
       out.should include("[--from=FROM]      # Time from which to find the logs")
       out.should include("[--debug]          # Show debug information")
     end
+
+    it "should display help when user is not logged in" do
+      out = IO.popen("bin/shelly list --help").read.strip
+      out.should include("Usage:")
+      out.should include("shelly list")
+      out.should include("List available clouds")
+      out.should_not include("You are not logged in. To log in use: `shelly login`")
+    end
   end
 
   describe "#register" do
@@ -848,7 +852,7 @@ We have been notified about it. We will be adding new resources shortly")
           "repository_url" => "git@winniecloud.net:example-cloud",
           "deployed_push_author" => "megan@example.com"
         },
-        "web_server_ip" => "22.22.22.22" }.merge(options)
+        "web_server_ip" => "22.22.22.22"}.merge(options)
     end
   end
 

data/spec/spec_helper.rb

@@ -23,4 +23,4 @@ class FakeFS::File
   def self.executable?(file)
     true
   end
-end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shelly
 version: !ruby/object:Gem::Version
-  version: 0.1.23
-  prerelease: 
+  version: 0.1.24.pre
+  prerelease: 7
 platform: ruby
 authors:
 - Shelly Cloud team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,38 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -156,13 +124,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: wijet-thor
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.7
+        version: 0.15.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,7 +138,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.7
+        version: 0.15.4
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +247,6 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
-- Guardfile
 - README.md
 - Rakefile
 - bin/shelly
@@ -307,7 +274,6 @@ files:
 - lib/shelly/user.rb
 - lib/shelly/version.rb
 - lib/thor/arguments.rb
-- lib/thor/basic.rb
 - lib/thor/options.rb
 - lib/thor/thor.rb
 - scrolls/shellycloud.rb
@@ -346,9 +312,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: shelly
 rubygems_version: 1.8.24

data/Guardfile

@@ -1,6 +0,0 @@
-guard 'rspec', :cli => '--color --format doc' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch('lib/shelly/helpers.rb') { "spec" }
-  watch(%r{^lib/shelly/(.+)\.rb$})     { |m| "spec/shelly/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/lib/thor/basic.rb

@@ -1,9 +0,0 @@
-class Thor
-  module Shell
-
-    def print_wrapped(*args)
-      shell.print_wrapped(*args)
-    end
-
-  end
-end