lab42_options 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7cc89febbade4730d1c7112704d5655af6d9cd5
-  data.tar.gz: 5de219eff28bf69199cdb5c1c59ef157eed0efd9
+  metadata.gz: 591fe82bbd4733ef27af5cbf07d0dce041b4a40c
+  data.tar.gz: 2de9e059429417fe2dabe852aa306d318df8d721
 SHA512:
-  metadata.gz: 1dc5104a71fbe2ca6572fdebb57b88d22215086fb2f8d69b020f49fc9d52f75aeae2c012d590ba20096dc48da311b69eb6478600f079b40b6992fcb9e5c3ce67
-  data.tar.gz: 3fdaf3fcd7413022e98b1e322c4ded53296bc0005547a49aa492dac0a12ad9bf41e91f27a9cb922633ec60b9ff547c6b2ddab9995dcae2de7e3e0c0952396bdd
+  metadata.gz: 56f563ae9f2a64a2f9644143708f3048dc9bd3caa53347e7681217a07e5a967fb8a8e0c482de5de44adb40216bd6be7fac5a0feef0566babf53b20903c9199b5
+  data.tar.gz: 94b1247f81b98ab1dfaf6dfed7274c68b3b8e181368ab9ae42d8b120cfd996079a3abee26532c5119a1a90af67afee31e5fab730ddcb4652c66e482afecb13a7

data/README.md

@@ -2,82 +2,4 @@
 
 ## Options
 
-Lets us specify command line options with the same syntax as ruby parameters
-
-```
-    my_shiny_gem "hello"  "world"  :verbose  answer: 42
-```
-
-Will yield
-
-```ruby
-    require 'lab42/options'
-    
-    options = Lab42::Options.new.parse ARGV
-    options.args # --> %W{ hello world }
-    options.first # --> "hello"
-    options[:verbose] # --> true
-    options.verbose   # --> true
-    options[:answer]  # --> "42"
-    options.answer    # --> "42"
-```
-
-## Multiple values
-
-When providing the same key many times the options object will become an array
-
-```
-    my_even_shiner_gem 42 tag: cool :mixed tag: hot mixed: pickels
-```
-
-Will yield
-
-```ruby
-    
-    options.args  # --> %W{42}
-    options[:tag] # --> %W{cool hot}
-    options.mixed # --> [true, "pickels"]
-```
-
-## Required and Default Arguments
-
-```ruby
-  Lab42::Options.new greeting: "hello", target: :required
-```
-
-will parse as follows:
-
-```sh
-    greet target: "world"                     # target = "world", greeting = "hello"
-    greet target: "world" greeting: "cheerio" # target = "world", greeting = "cheerio"
-    greet greeting: "howdy"                   # error missing required argument :target"
-```
-
-## Reading from yaml files
-
-```ruby
-  options = Lab42::Options.new greeting: "hello", target: :required
-  options.read_from "./options.yml"
-  # or
-  options.read_from :load # read from file indicated by load: <file>
-  # or
-  options.read_from load: "./.default_options.yml" # read from file indicated by load: <file> 
-                                               # defaulting to "./.default_options.yml"
-```
-
-Although this allows for nested parameters, defaults and requirements for deeper levels are not implemented right now (and are maybe not in the scope of a parameter parser).
-
-Existence of the yaml file is not reenforced either but that might be a good enhancement for the near
-future.
-
-
-## Missing Features
-
-* Help Message Generation
-  
-    https://github.com/RobertDober/lab42_options/issues/3
-
-* Typed Arguments
-
-    https://github.com/RobertDober/lab42_options/issues/4
-
+Please see the demos for a description [here](https://github.com/RobertDober/lab42_options/tree/master/demo)

data/lib/lab42/options.rb

@@ -1,19 +1,55 @@
 require 'ostruct'
+require 'lab42/core/fn'
+require 'lab42/core/kernel'
+
 require_relative './options/parser'
 require_relative './options/forwarder'
+require_relative './options/validator'
+require_relative './options/error_issuer'
 
 module Lab42
   class Options
-    attr_reader :yaml_file
+    attr_reader :args, :strict_mode, :yaml_file
+
+    def define_help txt
+      @defined_help_text = txt
+      self
+    end
+
+    def defaults
+      @__defaults__ ||=
+        @registered.select{|_,v| v != :required}
+    end
+
+    def define_help_for opt, txt=nil, &blk
+      @help_text_for_option[opt] = txt||blk.(defaults.fetch(opt))
+      self
+    end
+
+    def get_help_text
+      (
+      [ @defined_help_text ] +
+      required_options.map do | ro |
+        "#{ro}: #{@help_text_for_option.fetch(ro, :required)}"
+      end +
+      defaults.map do | d,v | 
+        "#{d}: defaults to #{@help_text_for_option.fetch(d,v.inspect)}"
+      end
+      ).compact.join("\n")
+    end
 
     def parse *args
       args = args.first if Array === args.first
+      @args = args
       @parsed = Lab42::Options::Parser.new.parse( self, args )
+
+      return if help_asked?
+
+      validate!
+      
       set_defaults
-      check_required
-      issue_errors!
-      result = OpenStruct.new @parsed
-      result.forwarding_to :kwds
+      
+      OpenStruct.new( @parsed ).forwarding_to :kwds
     end
 
     def read_from file_sym_or_hash
@@ -27,30 +63,65 @@ module Lab42
       end
     end
 
+    def strict(new_mode=:errors)
+      @strict_mode = new_mode
+      self
+    end
+
+    def strict?; !!strict_mode end
+
+    def warning_mode?
+      strict? && /warnings\z/ === strict_mode
+    end
+
+    def error_mode?
+      strict? && !warning_mode?
+    end
     private
     def initialize options={}
       @registered = {}
-      @errors = []
+      @help_text_for_option = {}
+      @strict_mode = :errors
       options.each do | k, v |
         register_option k, v
       end
     end
 
-    def check_required
-      required_options.each do |ro|
-        @errors << "Required option #{ro} was not provided" unless @parsed[:kwds].to_h.has_key? ro
-      end
-    end
+    #     @spurious.each do | err |
+    #       $stderr.puts "invalid parameter #{err.inspect}"
+    #     end
+    #   else
+    #     raise ArgumentError, "invalid parameters: #{@spurious.map(&sendmsg(:inspect)).join(", ")}"
+    #   end
 
-    def defaults
-      @__defaults__ =
-        @registered.select{|_,v| v != :required}
+
+    def help_asked?
+      %w{-h --help :help}.any?( &@parsed[:to_a].fn.include? )
     end
 
-    def issue_errors!
-      return if @errors.empty?
+    #     @spurious.each do | err |
+    #       $stderr.puts "invalid parameter #{err.inspect}"
+    #     end
+    #   else
+    #     raise ArgumentError, "invalid parameters: #{@spurious.map(&sendmsg(:inspect)).join(", ")}"
+    #   end
+
+    def issue_errors validator
+      errors = "validator.missing"
       raise ArgumentError, @errors.join("\n")
     end
+
+    #     @spurious.each do | err |
+    #       $stderr.puts "invalid parameter #{err.inspect}"
+    #     end
+    #   else
+    #     raise ArgumentError, "invalid parameters: #{@spurious.map(&sendmsg(:inspect)).join(", ")}"
+    #   end
+
+    def issue_warnings validator
+      get_spurious
+      
+    end
     def register_option k, v
       @registered[k] = v
     end
@@ -74,5 +145,23 @@ module Lab42
         @parsed[:kwds][k] = dv unless @parsed[:kwds].to_h.has_key? k
       end
     end
+    def validate!
+      validator = Validator.new( @registered )
+      validator.validate @parsed[:kwds].to_h
+      return if validator.valid?
+      issuer = ErrorIssuer.new self, validator
+      issuer.handle_errors!
+    end
+  end
+
+  class PermissiveOptions < Options
+    def strict
+      raise NoMethodError, "strict message not understood in this object #{self}"
+    end
+    private
+    def initialize *args, **kwds
+      super(*args, **kwds)
+      @strict_mode = false
+    end
   end
 end

data/lib/lab42/options/array_helpers.rb

@@ -0,0 +1,18 @@
+require_relative 'hash_helper'
+module Lab42
+  class Options
+    Identity = ->(x){x}
+    
+    module ArrayHelpers
+
+      def counts
+        group_by(&Identity).map_values(&:size)
+      end
+
+      def flag_count
+        count{|x| x==true}
+      end
+      
+    end # module ArrayHelpers
+  end # class Options
+end # module Lab42

data/lib/lab42/options/auto_import.rb

@@ -0,0 +1,5 @@
+require_relative '../options'
+
+Options           = Lab42::Options
+PermissiveOptions = Lab42::PermissiveOptions
+ParameterError    = Lab42::Options::ParameterError

data/lib/lab42/options/core_extension.rb

@@ -0,0 +1,4 @@
+# This will die as soon as it goes into lab42_core
+module Lab42
+  Negate = -> (x){!x}
+end # module Lab42

data/lib/lab42/options/default_helpers.rb

@@ -0,0 +1,14 @@
+module Lab42
+  class Options
+    module DefaultHelpers
+
+      def counts
+        { self => 1 }
+      end
+      def flag_count 
+        self == true ? 1 : 0
+      end
+      
+    end # module DefaultHelpers
+  end # class Options
+end # module Lab42

data/lib/lab42/options/error_issuer.rb

@@ -0,0 +1,60 @@
+module Lab42
+  class Options
+    ParameterError = Class.new ArgumentError
+    class ErrorIssuer
+      Symbolize = -> (s){ s.to_sym.inspect }
+
+      attr_reader :options, :validator
+
+      def handle_errors!
+        
+        if options.error_mode?
+          raise_errors_for_missing true
+        elsif options.warning_mode?
+          warn_for_spurious
+          raise_errors_for_missing
+        else
+          raise_errors_for_missing
+        end
+      end
+
+      private
+      def format_error_message sp, missing
+        spm = if sp.empty?
+                nil
+              else
+                "unspecified parameters: #{sp.map(Symbolize).join(", ")}"
+              end
+        mm = if missing.empty?
+               nil
+             else
+               "missing required parameters: #{missing.map(Symbolize).join(", ")}"
+             end
+        [spm, mm].compact.join "\n"
+      end
+
+      def get_spurious_errors
+        validator.spurious.keys
+      end
+
+      def initialize options, validator
+        @options   = options
+        @validator = validator
+      end
+
+      def raise_errors_for_missing with_spurious_errors=false
+        spurious_errors = with_spurious_errors ? get_spurious_errors : []
+        missing_errors  = validator.missing.keys
+        
+        return if spurious_errors.empty? && missing_errors.empty?
+        raise ParameterError, format_error_message( spurious_errors, missing_errors )
+      end
+
+      def warn_for_spurious
+        validator.spurious.each do | k, v |
+          $stderr.puts "unspecified parameter passed: #{k}: #{v.inspect}"
+        end
+      end
+    end # class ErrorIssuer
+  end # class Options
+end # module Lab42

data/lib/lab42/options/hash_helper.rb

@@ -0,0 +1,8 @@
+class Hash
+  def map_values bhv=nil, &blk
+    bhv ||= blk
+    inject self.class.new do | h, (k,v) |
+      h.merge( k => bhv.(v) )
+    end
+  end
+end

data/lib/lab42/options/parser.rb

@@ -1,20 +1,39 @@
 require 'yaml'
+
+require_relative 'array_helpers'
+require_relative 'default_helpers'
+
 module Lab42
   class Options
     class Parser
       attr_accessor :data, :defaults, :kwds, :positionals, :yaml_file
-      def parse options, args
-        self.yaml_file = options.yaml_file 
+
+      def parse option, args
+        self.yaml_file = option.yaml_file 
         self.data = {to_a: args}
-        self.kwds = {}
-        self.positionals = []
         parse_all args
         # read_yaml file might need the args parsed
-        defaults = read_yaml_file
-        data.merge kwds: OpenStruct.new(defaults.merge(kwds)), args: positionals
+        defaults = read_yaml_file || option.defaults
+        merged = defaults.merge kwds
+        merged = extend_values merged
+        result = data.merge kwds: OpenStruct.new( merged ), args: positionals
+        check_for_errors option, args if option.strict_mode
+        result
       end
 
+      def errors; @errors.dup end
+
       private
+      def initialize
+        @errors = []
+        self.kwds = {}
+        self.positionals = []
+      end
+
+      def check_for_errors options, args
+        
+      end
+
       def convert_hash hs
         return hs unless Hash === hs
         hs.keys.inject Hash.new do |h, k|
@@ -26,6 +45,16 @@ module Lab42
         end
       end
 
+      def extend_values kwds
+        kwds.map_values do | val|
+          if Array === val
+            val.extend Lab42::Options::ArrayHelpers
+          else
+            val.extend Lab42::Options::DefaultHelpers rescue val
+          end
+        end
+      end
+
       def parse_all args
         e = (args[0..-1] || []).enum_for :each
         loop do
@@ -43,7 +72,7 @@ module Lab42
       def read_yaml_file
         read_yaml_file!
       rescue Errno::ENOENT
-        {}
+        nil
       end
 
       def read_yaml_file!
@@ -54,7 +83,7 @@ module Lab42
         when String
           convert_hash YAML.load File.read yaml_file
         else
-          {}
+          nil
         end
       end
 

data/lib/lab42/options/validator.rb

@@ -0,0 +1,35 @@
+require 'set'
+require 'forwarder'
+require_relative './core_extension'
+
+module Lab42
+  class Options
+    class Validator
+      attr_reader :missing, :spurious
+      extend Forwarder
+
+      forward :missing?, to: :missing, as: :empty?, after: Lab42::Negate
+      forward :spurious?, to: :spurious, as: :empty?, after: Lab42::Negate
+
+      def valid?
+        missing.empty? && spurious.empty?
+      end
+
+      def validate parsed
+        parsed.each do | key, value |
+          @spurious.update key => value unless @allowed.include? key
+          @missing.delete key if @missing.include? key
+        end
+      end
+
+      private
+      def initialize registered
+        @spurious = {}
+        @missing   = Hash[
+          *registered.select{ |_,v| v == :required }.map{ |k,| [k => true] }.flatten
+        ]
+        @allowed  = Set.new registered.keys
+      end 
+    end # class Validator
+  end # class Options
+end # module Lab42

data/lib/lab42/options/version.rb

@@ -1,5 +1,5 @@
 module Lab42
   class Options
-    VERSION = "0.4.0"
+    VERSION = "0.5.3"
   end
 end

metadata

@@ -1,55 +1,174 @@
 --- !ruby/object:Gem::Specification
 name: lab42_options
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lab42_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: forwarder2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Specify command line arguments with Ruby Syntax
 email: robert.dober@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/lab42/options.rb
-- lib/lab42/options/parser.rb
+- lib/lab42/options/array_helpers.rb
+- lib/lab42/options/auto_import.rb
+- lib/lab42/options/core_extension.rb
+- lib/lab42/options/default_helpers.rb
+- lib/lab42/options/error_issuer.rb
 - lib/lab42/options/forwarder.rb
+- lib/lab42/options/hash_helper.rb
+- lib/lab42/options/parser.rb
+- lib/lab42/options/validator.rb
 - lib/lab42/options/version.rb
-- LICENSE
-- README.md
 homepage: https://github.com/RobertDober/lab42_options
 licenses:
 - MIT
@@ -60,17 +179,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Command Lines the Ruby Way