cli-modular_options 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b7e5cd4033fe5f65cc4058d851f2b37ecac55bf
-  data.tar.gz: 76f08750cf87f2ffa3834bfc9b09639a6783780b
+  metadata.gz: 9fdfcca3fd228a169b7669cd3d1d8a9986666ee8
+  data.tar.gz: 6341000ce95609c8645400b39f811bba59dad387
 SHA512:
-  metadata.gz: 79a6af03599049f0210d6156facac70150d4c07b77354795ae12c868e2e4680afb9a436abb49dc4ea00a0bac45ca62620b910a58959556202ab75114fda4cb11
-  data.tar.gz: d05bfefea65b7bed219f580b6deaee53dd667fd1ddb6ca284eda58ba2233150fedb279d5565b22cd809e9320cd72eebc07adbae146d9166242c77ae88aa5ee1f
+  metadata.gz: fad47704255b557d790e4aef075f016f95dfc7f95c9eeaafff5337c397b10ffa174f55ae30a1123698686a20a82dfb755a298de5772e817459e26e38739c0287
+  data.tar.gz: 8ef35d3e81a23410240e673b4215d623b51155036b942b979d8b9090b23b3b94b4cfe3546ff6114a3fca98fe81442d4749184db795d4760dc8874ef35d733a7d

data/README.md

@@ -6,7 +6,6 @@ options in the context of a class or module and consume them in the context of
 an object instance using conventional ruby inheritance semantics.
 
 ### Install:
-
     gem install cli-modular_options
 
 ### Example:
@@ -19,11 +18,11 @@ module DatabaseStuff
   # Your mixin methods might go here
   
   cli_options do |parser|
-    p.separator 'Database Options:'
-    p.on '--db-user', 'Database username' do |v|
+    parser.separator 'Database Options:'
+    parser.on '--db-user', 'Database username' do |v|
       cli_opts[:db_user] = v
     end
-    p.on '--db-pass', 'Database password' do |v|
+    parser.on '--db-pass', 'Database password' do |v|
       cli_opts[:db_pass] = v
     end
   end
@@ -32,7 +31,7 @@ end
 module StandardOptions
   extend CLI::WithOptions
   cli_options do |parser|
-    p.on_head '-h', '--help', 'Display help' do
+    parser.on_head '-h', '--help', 'Display help' do
       cli_opts[:show_help] = true
       cli_opts[:parser] = parser
     end
@@ -44,14 +43,17 @@ class MyApp
   include DatabaseStuff
   include StandardOptions
   
+  def cli_opts
+    @cli_opts ||= Hash.new
+  end
+  
   def show_help
     puts cli_opts[:parser]
     Process.exit 0
   end
   
   def initialize( argv = ARGV.map(&:dup) )
-    parse_options! argv
-    # Your options are available in cli_opts
+    cli_opts[:positional] = new_cli_parser.parse! argv
     show_help if cli_opts[:show_help]
   end
 end
@@ -89,6 +91,9 @@ class MyQuietApp < MyVerboseApp
 end
 ```
 
+### Development:
+https://github.com/IronSavior/cli-modular_options
+
 ### Copyrights
 Copyright (C) 2014 Erik Elmore <erik@erikelmore.com>
 

data/lib/cli/modular_options.rb

@@ -2,43 +2,59 @@ require 'optparse'
 
 module CLI
   
+  # Use 'extend CLI::WithOptions' to declare OptionParser configuration blocks in your module.
   module WithOptions
+    # Used to declare a proc that can be used to configure an instance of OptionParser with a
+    # class or module.
     def cli_options( &block )
       raise ArgumentError, 'Block required but not given' unless block_given?
-      const_set :CLI_OPTS_HOOKS, Array.new unless const_defined? :CLI_OPTS_HOOKS, false
-      const_get(:CLI_OPTS_HOOKS) << block
+      (@cli_options_hooks ||= Array.new) << block
     end
   end # WithOptions
   
+  # Use 'include CLI::ModularOptions' in a class whose instances will consume procs declared
+  # using CLI::WithOptions#cli_options to configure instances of OptionParser.
   module ModularOptions
-    def cli_opts
-      @cli_opts ||= Hash.new
-    end
-    
-    def new_options_parser
+    # Constructs a new instance of OptionParser and configures it using the cli_options blocks
+    # declared in modules found in the inheritance chain of a class or module.  If a class or
+    # module is not specified, the class of self is assumed.
+    #
+    # @param mod [Class, Module] Optional, take cli_options from a different class
+    # @return [OptionParser] configured parser instance
+    def new_cli_parser( mod = self.class )
       OptionParser.new do |p|
-        self.class.cli_hooks.each{ |b| instance_exec p, cli_opts, &b }
+        configure_cli_parser p, CLI::ModularOptions.ancestral_hooks(mod)
       end
     end
     
-    def parse_options!( argv )
-      cli_opts[:positional] = new_options_parser.parse! argv
+    # Configures a given parser by passing it to the given hook procs, which are called in the
+    # context of self
+    #
+    # @param parser [OptionParser] the parser to be configured
+    # @param hooks [Array<Proc>] parser configuration procs declared with cli_options
+    def configure_cli_parser( parser, hooks )
+      hooks.each do |b|
+        instance_exec parser, &b
+      end
     end
     
-    def self.included( base )
-      base.extend ClassMethods
-      super
+    # Get parser configuration procs belonging to the specified modules.  Inheritance is not considered.
+    #
+    # @param modules list of classes and modules that may or may not have cli_options procs
+    # @return [Array<Proc>] all cli_options procs belonging to specified modules
+    def self.hooks_from( *modules )
+      modules.map{ |m|
+        m.instance_variable_get :@cli_options_hooks if m.instance_variable_defined? :@cli_options_hooks
+      }.flatten.compact
     end
     
-    module ClassMethods
-      def ancestors_with_cli_hooks
-        ancestors.select{ |m| m.const_defined? :CLI_OPTS_HOOKS, false }
-      end
-      
-      def cli_hooks
-        ancestors_with_cli_hooks.map{ |m| m::CLI_OPTS_HOOKS }.reverse.flatten
-      end
-    end # ClassMethods
+    # Get parser configuration procs belonging to or inherited by the specified class or module.
+    #
+    # @param mod [Class, Module]
+    # @return [Array<Proc>]
+    def self.ancestral_hooks( mod )
+      hooks_from(*mod.ancestors.uniq.reverse)
+    end
   end # ModularOptions
 
 end # CLI

data/spec/helpers/test_model.rb

@@ -4,7 +4,7 @@ module TestModel
   def self.new_cli_hook( mod, name )
     k = name.to_s.downcase.to_sym
     mod.instance_eval do
-      cli_options do |p, cfg|
+      cli_options do |p|
         cfg[:context]    << self.class
         cfg[:call_order] << name.to_s
         cfg[k] = false
@@ -38,10 +38,19 @@ module TestModel
     Class.new args[:base] {
       if args[:modular_options]
         include CLI::ModularOptions
+        
+        define_method :inherit_options_from do
+          args[:inherit_options_from] || self.class
+        end
+        
+        def cfg
+          @cfg ||= Hash.new
+        end
+        
         def initialize( argv = [] )
-          cli_opts[:context]    = Array.new
-          cli_opts[:call_order] = Array.new
-          parse_options! argv
+          cfg[:context]    = Array.new
+          cfg[:call_order] = Array.new
+          cfg[:positional] = new_cli_parser(inherit_options_from).parse! argv
         end
       end
       

data/spec/modular_options_spec.rb

@@ -3,16 +3,12 @@ require 'helpers/test_model'
 
 describe CLI::ModularOptions do
   shared_examples_for TestModel do
-    it 'Inherits included cli_hooks' do
-      expect(klass.cli_hooks.size).to be call_order.size
-    end
-    
     it 'Invokes cli_hooks in the context of self' do
-      expect(klass.new.cli_opts[:context]).to all be(klass)
+      expect(klass.new.cfg[:context]).to all be(klass)
     end
     
     it 'Invokes cli_hooks in the correct order' do
-      expect(klass.new.cli_opts[:call_order]).to eq call_order
+      expect(klass.new.cfg[:call_order]).to eq call_order
     end
   end
   
@@ -244,5 +240,15 @@ describe CLI::ModularOptions do
     ]}
     it_behaves_like TestModel
   end
+  
+  context 'When using options from non-ancestor modules' do
+    let(:klass){ TestModel.new_class(
+      :modular_options => true,
+      :inherit_options_from => TestModel.new_module(:name => 'Other'),
+      :feature_modules => ['One', 'Two', 'Three']
+    )}
+    let(:call_order){ ['Other'] }
+    it_behaves_like TestModel
+  end
 
 end

data/spec/with_options_spec.rb

@@ -4,8 +4,8 @@ require 'helpers/test_model'
 describe CLI::WithOptions do
   let(:mod){ TestModel.new_module :add_options => false }
   
-  it "Doesn't create CLI_OPTS_HOOKS until necessary" do
-    expect(mod.const_defined? :CLI_OPTS_HOOKS).to eq false
+  it "Doesn't create @cli_options_hooks until necessary" do
+    expect(mod.instance_variable_defined? :@cli_options_hooks).to eq false
   end
 
   it 'Requires a block to be given with cli_options' do
@@ -14,11 +14,11 @@ describe CLI::WithOptions do
 
   it 'Adds hooks to modules' do
     mod.cli_options do; end
-    expect(mod::CLI_OPTS_HOOKS).to be_an Array
+    expect(mod.instance_variable_get :@cli_options_hooks).to be_an Array
   end
   
   it 'Adds more hooks to modules' do
     5.times{ mod.cli_options do; end }
-    expect(mod::CLI_OPTS_HOOKS.size).to be 5
+    expect(mod.instance_variable_get(:@cli_options_hooks).size).to be 5
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-modular_options
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Erik Elmore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -39,7 +39,7 @@ files:
 - spec/modular_options_spec.rb
 - spec/spec_helper.rb
 - spec/with_options_spec.rb
-homepage: https://github.com/IronSavior/ModularOptions
+homepage: https://github.com/IronSavior/cli-modular_options
 licenses:
 - MIT
 metadata: {}
@@ -64,7 +64,7 @@ signing_key:
 specification_version: 4
 summary: Modular Command-Line Options
 test_files:
-- spec/spec_helper.rb
-- spec/modular_options_spec.rb
 - spec/helpers/test_model.rb
+- spec/modular_options_spec.rb
+- spec/spec_helper.rb
 - spec/with_options_spec.rb