clamp 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ea677c27d0df2e7b29b4423234f6095c1aafb8b
-  data.tar.gz: a98836b37b03bd4d72e3fe77ac292be2dda6bb14
+  metadata.gz: 4bd2b8653f1a6c24e26a9ec5d84f655721cecdee
+  data.tar.gz: 776fa8ff95cf73971de85be5e6f30915bd40df09
 SHA512:
-  metadata.gz: f39366b518b4705bf367f7403ff1b5837c7eb984325b96029bb14737b9c02cbcea754abe39c934fc0967de2b4e6cc46516fba66ff5ab4da9493f3627d0bb939b
-  data.tar.gz: b75b6fcda33eb33fec53153c255d8166b3ca131afc7fae36b1a8ecf172633f8bef03583ff55d4a58913ee779f01d03e497572f6528a40410169329f3eef9814a
+  metadata.gz: 51397540a6660a9f10bd1fae184b16d3cac69a64ce17a5f65d4e5bc3d9f3c60140f7a16ae868393372f541c147a1459ef78eaa402a65203e77833ae829d54051
+  data.tar.gz: 27c409d2ebbe33d768b884cff979d33df4099008506c24dbe0080249466610928cd705b88a7f7b76dc10eb4ed7cf2fc2e5be0f2e8919ff74ce8015f2403965d1

data/.rubocop.yml

@@ -0,0 +1,60 @@
+Eval:
+  Exclude:
+    - "Rakefile"
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+  Exclude:
+    - "spec/**/*"
+
+Style/Documentation:
+  Exclude:
+    - "lib/**/version.rb"
+    - "spec/**/*"
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+  Enabled: true
+
+Style/FileName:
+  Exclude:
+    - "bin/*"
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Lambda:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-  - 2.3.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.1
 before_install:
   - gem update --system
   - gem install bundler

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0 (2016-10-17)
+
+* Add `#subcommand_missing`.
+* Fix issue#66: pass parameter values down to nested subcommands.
+* Drop support for Ruby 1.9 and 2.0.
+
 ## 1.0.1 (2016-10-01)
 
 * Minor bug-fixes.

data/Gemfile

@@ -6,9 +6,10 @@ group :development do
   gem "guard-rspec", "~> 4.6.5", :require => false
   gem "listen", "~> 3.0.2"
   gem "rake", "~> 10.4"
+  gem "rubocop", "~> 0.43.0", :require => false
 end
 
 group :test do
-  gem "rspec", "~> 3.1.0"
-  gem "rr", "~> 1.1.2"
+  gem "rspec", "~> 3.5.0"
+  gem "rr", "~> 1.2.0"
 end

data/Guardfile

@@ -24,7 +24,7 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
+guard :rspec, :cmd => "bundle exec rspec" do
   require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -137,7 +137,7 @@ Clamp will handle both "`--force`" and "`--no-force`" options, setting the value
 
 ### Required options
 
-Although 'required option' is a an oxymoron, Clamp lets you mark an option as required, and will verify that a value is provided:
+Although "required option" is an oxymoron, Clamp lets you mark an option as required, and will verify that a value is provided:
 
 ```ruby
 option "--password", "PASSWORD", "the secret password", :required => true
@@ -365,6 +365,19 @@ Options are inheritable, so any options declared for a command are supported by
 
 Note that, if a subcommand accepts options, they must be specified on the command-line _after_ the subcommand name.
 
+You can define a `subcommand_missing` method that is called when user tries to run an unknown subcommand:
+
+```ruby
+Clamp do
+  def subcommand_missing(name)
+    if name == "foo"
+      return Object.const_get(:FooPlugin) if Object.const_defined?(:FooPlugin)
+      abort "Subcommand 'foo' requires plugin X"
+    end
+  end
+end
+```
+
 Getting help
 ------------
 

data/Rakefile

@@ -1,4 +1,4 @@
-require 'bundler'
+require "bundler"
 
 Bundler::GemHelper.install_tasks
 
@@ -7,6 +7,6 @@ require "rspec/core/rake_task"
 task "default" => "spec"
 
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+  t.pattern = "spec/**/*_spec.rb"
   t.rspec_opts = ["--colour", "--format", "documentation"]
 end

data/clamp.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
 require "clamp/version"
 
 Gem::Specification.new do |s|
@@ -11,9 +10,9 @@ Gem::Specification.new do |s|
   s.email         = "mdub@dogbiscuit.org"
   s.homepage      = "http://github.com/mdub/clamp"
 
-  s.license       = 'MIT'
+  s.license       = "MIT"
 
-  s.summary       = %q{a minimal framework for command-line utilities}
+  s.summary       = "a minimal framework for command-line utilities"
   s.description   = <<EOF
 Clamp provides an object-model for command-line utilities.
 It handles parsing of command-line options, and generation of usage help.

data/examples/defaulted

@@ -20,7 +20,7 @@ Clamp do
   private
 
   def default_password
-    terminal.ask("Password [#{user}]: ") { |q| q.echo = '*' }
+    terminal.ask("Password [#{user}]: ") { |q| q.echo = "*" }
   end
 
   def terminal

data/examples/scoop

@@ -7,8 +7,8 @@ require "clamp"
 Clamp do
 
   option ["-f", "--flavour"], "FLAVOUR", "flavour",
-    :multivalued => true, :default => ['chocolate'],
-    :attribute_name => :flavours
+         :multivalued => true, :default => ["chocolate"],
+         :attribute_name => :flavours
 
   def execute
     puts "one #{flavours.join(' and ')} ice-cream"

data/examples/speak

@@ -6,9 +6,9 @@ require "clamp"
 
 Clamp do
 
-  banner %{
+  banner %(
     Say something.
-  }
+  )
 
   option "--loud", :flag, "say it loud"
   option ["-n", "--iterations"], "N", "say it N times", :default => 1 do |s|
@@ -18,14 +18,12 @@ Clamp do
   parameter "WORDS ...", "the thing to say", :attribute_name => :words
 
   def execute
-
     the_truth = words.join(" ")
     the_truth.upcase! if loud?
 
     iterations.times do
       puts the_truth
     end
-
   end
 
 end

data/examples/subcommand_missing

@@ -0,0 +1,18 @@
+#! /usr/bin/env ruby
+
+require "clamp"
+
+Clamp do
+
+  subcommand "hello", "Say hello" do
+    def execute
+      puts "Hello"
+    end
+  end
+
+  def subcommand_missing(name)
+    abort "Install bye plugin first" if name == "bye"
+    super
+  end
+
+end

data/lib/clamp.rb

@@ -1,6 +1,6 @@
-require 'clamp/version'
+require "clamp/version"
 
-require 'clamp/command'
+require "clamp/command"
 
 def Clamp(&block)
   Class.new(Clamp::Command, &block).run

data/lib/clamp/attribute/declaration.rb

@@ -5,7 +5,7 @@ module Clamp
 
       protected
 
-      def define_accessors_for(attribute, &block)
+      def declare_attribute(attribute, &block)
         define_reader_for(attribute)
         define_default_for(attribute)
         if attribute.multivalued?
@@ -16,6 +16,8 @@ module Clamp
         end
       end
 
+      private
+
       def define_reader_for(attribute)
         define_method(attribute.read_method) do
           attribute.of(self)._read

data/lib/clamp/attribute/definition.rb

@@ -1,4 +1,4 @@
-require 'clamp/attribute/instance'
+require "clamp/attribute/instance"
 
 module Clamp
   module Attribute
@@ -6,18 +6,14 @@ module Clamp
     class Definition
 
       def initialize(options)
-        if options.has_key?(:attribute_name)
+        if options.key?(:attribute_name)
           @attribute_name = options[:attribute_name].to_s
         end
-        if options.has_key?(:default)
-          @default_value = options[:default]
-        end
-        if options.has_key?(:environment_variable)
+        @default_value = options[:default] if options.key?(:default)
+        if options.key?(:environment_variable)
           @environment_variable = options[:environment_variable]
         end
-        if options.has_key?(:hidden)
-          @hidden = options[:hidden]
-        end
+        @hidden = options[:hidden] if options.key?(:hidden)
       end
 
       attr_reader :description, :environment_variable
@@ -47,9 +43,7 @@ module Clamp
       end
 
       def append_method
-        if multivalued?
-          "append_to_#{attribute_name}"
-        end
+        "append_to_#{attribute_name}" if multivalued?
       end
 
       def multivalued?

data/lib/clamp/attribute/instance.rb

@@ -63,7 +63,7 @@ module Clamp
       def default_from_environment
         return if self.defined?
         return if attribute.environment_variable.nil?
-        return unless ENV.has_key?(attribute.environment_variable)
+        return unless ENV.key?(attribute.environment_variable)
         # Set the parameter value if it's environment variable is present
         value = ENV[attribute.environment_variable]
         begin

data/lib/clamp/command.rb

@@ -1,12 +1,12 @@
-require 'clamp/messages'
-require 'clamp/errors'
-require 'clamp/help'
-require 'clamp/option/declaration'
-require 'clamp/option/parsing'
-require 'clamp/parameter/declaration'
-require 'clamp/parameter/parsing'
-require 'clamp/subcommand/declaration'
-require 'clamp/subcommand/parsing'
+require "clamp/messages"
+require "clamp/errors"
+require "clamp/help"
+require "clamp/option/declaration"
+require "clamp/option/parsing"
+require "clamp/parameter/declaration"
+require "clamp/parameter/parsing"
+require "clamp/subcommand/declaration"
+require "clamp/subcommand/parsing"
 
 module Clamp
 
@@ -25,12 +25,9 @@ module Clamp
     # @param [String] invocation_path the path used to invoke the command
     # @param [Hash] context additional data the command may need
     #
-    def initialize(invocation_path, context = {}, parent_attribute_values = {})
+    def initialize(invocation_path, context = {})
       @invocation_path = invocation_path
       @context = context
-      parent_attribute_values.each do |attribute, value|
-        attribute.of(self).set(value)
-      end
     end
 
     # @return [String] the path used to invoke this command
@@ -39,9 +36,7 @@ module Clamp
 
     # @return [Array<String>] unconsumed command-line arguments
     #
-    def remaining_arguments
-      @remaining_arguments
-    end
+    attr_reader :remaining_arguments
 
     # Parse command-line arguments.
     #
@@ -82,6 +77,13 @@ module Clamp
       self.class.help(invocation_path)
     end
 
+    # Abort with subcommand missing usage error
+    #
+    # @ param [String] name subcommand_name
+    def subcommand_missing(name)
+      signal_usage_error(Clamp.message(:no_such_subcommand, :name => name))
+    end
+
     include Clamp::Option::Parsing
     include Clamp::Parameter::Parsing
     include Clamp::Subcommand::Parsing
@@ -91,9 +93,7 @@ module Clamp
     attr_accessor :context
 
     def handle_remaining_arguments
-      unless remaining_arguments.empty?
-        signal_usage_error Clamp.message(:too_many_arguments)
-      end
+      signal_usage_error Clamp.message(:too_many_arguments) unless remaining_arguments.empty?
     end
 
     private
@@ -128,22 +128,20 @@ module Clamp
       # @param [Array<String>] arguments command-line arguments
       # @param [Hash] context additional data the command may need
       #
-      def run(invocation_path = File.basename($0), arguments = ARGV, context = {})
-        begin
-          new(invocation_path, context).run(arguments)
-        rescue Clamp::UsageError => e
-          $stderr.puts "ERROR: #{e.message}"
-          $stderr.puts ""
-          $stderr.puts "See: '#{e.command.invocation_path} --help'"
-          exit(1)
-        rescue Clamp::HelpWanted => e
-          puts e.command.help
-        rescue Clamp::ExecutionError => e
-          $stderr.puts "ERROR: #{e.message}"
-          exit(e.status)
-        rescue SignalException => e
-          exit(128 + e.signo)
-        end
+      def run(invocation_path = File.basename($PROGRAM_NAME), arguments = ARGV, context = {})
+        new(invocation_path, context).run(arguments)
+      rescue Clamp::UsageError => e
+        $stderr.puts "ERROR: #{e.message}"
+        $stderr.puts ""
+        $stderr.puts "See: '#{e.command.invocation_path} --help'"
+        exit(1)
+      rescue Clamp::HelpWanted => e
+        puts e.command.help
+      rescue Clamp::ExecutionError => e
+        $stderr.puts "ERROR: #{e.message}"
+        exit(e.status)
+      rescue SignalException => e
+        exit(128 + e.signo)
       end
 
     end