lab42_options 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d60b9c90244ebc315786a02ad9273611b52169a9
-  data.tar.gz: 4c27dddfa798d3765a7edba5463c055cbcc9a88a
+  metadata.gz: d7cc89febbade4730d1c7112704d5655af6d9cd5
+  data.tar.gz: 5de219eff28bf69199cdb5c1c59ef157eed0efd9
 SHA512:
-  metadata.gz: c75abdec7ecb175a6cbf31ea4c1b64b5e3450a4702f419a9cc1abad731d508d4bfe63663f596a8c46d90ecbb63b15f320a5a7188934cbaec39a85686f08e3581
-  data.tar.gz: 5f1f185f3203293be14cb4cb2a9c3c989d57c77875c00a3bd21408baaee517ef2d591c3e072c092e0fde33118dd18abdc8aa5f5792c57ec2b8538763ccaeb9b1
+  metadata.gz: 1dc5104a71fbe2ca6572fdebb57b88d22215086fb2f8d69b020f49fc9d52f75aeae2c012d590ba20096dc48da311b69eb6478600f079b40b6992fcb9e5c3ce67
+  data.tar.gz: 3fdaf3fcd7413022e98b1e322c4ded53296bc0005547a49aa492dac0a12ad9bf41e91f27a9cb922633ec60b9ff547c6b2ddab9995dcae2de7e3e0c0952396bdd

data/README.md

@@ -53,6 +53,24 @@ will parse as follows:
     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

data/lib/lab42/options/parser.rb

@@ -1,16 +1,31 @@
+require 'yaml'
 module Lab42
   class Options
     class Parser
-      attr_accessor :data, :kwds, :positionals
-      def parse args
+      attr_accessor :data, :defaults, :kwds, :positionals, :yaml_file
+      def parse options, args
+        self.yaml_file = options.yaml_file 
         self.data = {to_a: args}
         self.kwds = {}
         self.positionals = []
         parse_all args
-        data.merge kwds: OpenStruct.new(kwds), args: positionals
+        # read_yaml file might need the args parsed
+        defaults = read_yaml_file
+        data.merge kwds: OpenStruct.new(defaults.merge(kwds)), args: positionals
       end
 
       private
+      def convert_hash hs
+        return hs unless Hash === hs
+        hs.keys.inject Hash.new do |h, k|
+          if String === k
+            h.merge k.to_sym => convert_hash( hs[k] )
+          else
+            h.merge k => convert_hash( hs[k] )
+          end
+        end
+      end
+
       def parse_all args
         e = (args[0..-1] || []).enum_for :each
         loop do
@@ -25,6 +40,24 @@ module Lab42
         end
       end
 
+      def read_yaml_file
+        read_yaml_file!
+      rescue Errno::ENOENT
+        {}
+      end
+
+      def read_yaml_file!
+        case yaml_file
+        when Hash
+          file = kwds.fetch( yaml_file.keys.first, yaml_file.values.first )
+          file ? convert_hash( YAML.load File.read file ) : {}
+        when String
+          convert_hash YAML.load File.read yaml_file
+        else
+          {}
+        end
+      end
+
       def update_value key, val 
         kwds.merge! key => val do |k, oldv, newv|
           Array( oldv ) << newv

data/lib/lab42/options/version.rb

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

data/lib/lab42/options.rb

@@ -4,9 +4,11 @@ require_relative './options/forwarder'
 
 module Lab42
   class Options
+    attr_reader :yaml_file
+
     def parse *args
       args = args.first if Array === args.first
-      @parsed = Lab42::Options::Parser.new.parse( args )
+      @parsed = Lab42::Options::Parser.new.parse( self, args )
       set_defaults
       check_required
       issue_errors!
@@ -14,6 +16,17 @@ module Lab42
       result.forwarding_to :kwds
     end
 
+    def read_from file_sym_or_hash
+      case file_sym_or_hash
+      when String
+        read_from_file file_sym_or_hash
+      when Symbol
+        read_from_parameterized_file file_sym_or_hash => nil
+      else
+        read_from_parameterized_file file_sym_or_hash
+      end
+    end
+
     private
     def initialize options={}
       @registered = {}
@@ -42,6 +55,15 @@ module Lab42
       @registered[k] = v
     end
 
+    def read_from_file file
+      @yaml_file = file
+    end
+
+    def read_from_parameterized_file params
+      raise ArgumentError, "#{params} is not a Hash" unless Hash === params
+      @yaml_file = params
+    end
+
     def required_options
       @__required_options__ ||=
         @registered.select{|_,v| v == :required}.keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_options
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry