map 1.4.0 → 1.5.0

data/README

@@ -5,6 +5,12 @@ SYNOPSIS
   the ruby container you've always wanted: a string/symbol indifferent ordered
   hash that works in all rubies
 
+  maps are rad ordered hashes that are both ordered, string/symbol
+  indifferent, and have all sorts of sweetness like recursive convertsion,
+  more robust implementation than HashWithIndifferentAccess, support for
+  struct like (map.foo) access, and support for option/keyword access which
+  avoids several nasty classes of errors in many ruby libraries
+
 INSTALL
   gem install map
 
@@ -13,8 +19,8 @@ URI
 
 DESCRIPTION
 
-# maps are ordered.  constructing them in an ordered fashion builds them that
-# way
+# maps are always ordered.  constructing them in an ordered fashion builds
+# them that way, although the normal hash contructor is also supported
 #
   m = Map[:k, :v, :key, :val]
   m = Map(:k, :v, :key, :val)
@@ -51,5 +57,35 @@ DESCRIPTION
   s = m.struct
   p s.foo.bar #=> 42
 
+# because option parsing is such a common use case for needing string/symbol
+# indifference map.rb comes out of the box for option support
+#
+  def foo(*args, &block)
+    opts = Map.options(args)
+    a = opts.getopt(:a)
+    b = opts.getopt(:b, :default => false)
+  end
+
+
+  opts = Map.options(:a => 42, :b => nil, :c => false)
+  opts.getopt(:a)                    #=> 42
+  opts.getopt(:b)                    #=> nil
+  opts.getopt(:b, :default => 42)    #=> 42 
+  opts.getopt(:c)                    #=> false
+  opts.getopt(:d, :default => false) #=> false
+
+# this avoids such bugs as
+#  
+  options = {:read_only => true}
+  read_only = options[:read_only] || true  # should be false but is true
+
+# with options this becomes
+#
+  options = Map.options(:read_only => true)
+  read_only = options.getopt(:read_only, :default => false) #=> true
+
+# tons more goodness, see test/map_test.rb
+#
+
 USAGE
-  test/map_test.rb
+  again, see test/map_test.rb

data/lib/map.rb

@@ -1,5 +1,5 @@
 class Map < Hash
-  Version = '1.4.0' unless defined?(Version)
+  Version = '1.5.0' unless defined?(Version)
   Load = Kernel.method(:load) unless defined?(Load)
 
   class << Map
@@ -452,3 +452,4 @@ private
 end
 
 Map.load('struct.rb')
+Map.load('options.rb')

data/lib/map/options.rb

@@ -0,0 +1,151 @@
+class Map
+  module Options
+    class << Options
+      def for(arg)
+        hash =
+          case arg
+            when Hash
+              arg
+            when Array
+              parse(arg)
+            when String, Symbol
+              {arg => true}
+            else
+              raise(ArgumentError, arg.inspect) unless arg.respond_to?(:to_hash)
+              arg.to_hash
+          end
+        map = Map.coerce(hash)
+      ensure
+        map.extend(Options) unless map.is_a?(Options)
+      end
+
+      def parse(arg)
+        case arg
+          when Array
+            arg.extend(Arguments) unless arg.is_a?(Arguments)
+            arg.options
+          when Hash
+            Options.for(arg)
+          else
+            raise(ArgumentError, "`arg` should be an Array or Hash")
+        end
+      end
+    end
+
+    attr_accessor :arguments
+
+    %w( to_options stringify_keys ).each do |method|
+      module_eval <<-__, __FILE__, __LINE__
+        def #{ method }() dup end
+        def #{ method }!() self end
+      __
+    end
+
+    def get_opt(opts, options = {})
+      options = Map.for(options.is_a?(Hash) ? options : {:default => options})
+      default = options[:default]
+      [ opts ].flatten.each do |opt|
+        return fetch(opt) if has_key?(opt)
+      end
+      default
+    end
+    alias_method('getopt', 'get_opt')
+
+    def get_opts(*opts)
+      opts.flatten.map{|opt| getopt(opt)}
+    end
+    alias_method('getopts', 'get_opts')
+
+    def has_opt(opts)
+      [ opts ].flatten.each do |opt|
+        return true if has_key?(opt)
+      end
+      false
+    end
+    alias_method('hasopt', 'has_opt')
+    alias_method('hasopt?', 'has_opt')
+    alias_method('has_opt?', 'has_opt')
+
+    def has_opts(*opts)
+      opts.flatten.all?{|opt| hasopt(opt)}
+    end
+    alias_method('hasopts?', 'has_opts')
+    alias_method('has_opts?', 'has_opts')
+
+    def del_opt(opts)
+      [ opts ].flatten.each do |opt|
+        return delete(opt) if has_key?(opt)
+      end
+      nil
+    end
+    alias_method('delopt', 'del_opt')
+
+    def del_opts(*opts)
+      opts.flatten.map{|opt| delopt(opt)}
+      opts
+    end
+    alias_method('delopts', 'del_opts')
+    alias_method('delopts!', 'del_opts')
+
+    def set_opt(opts, value = nil)
+      [ opts ].flatten.each do |opt|
+        return self[opt]=value
+      end
+      return value
+    end
+    alias_method('setopt', 'set_opt')
+    alias_method('setopt!', 'set_opt')
+
+    def set_opts(opts)
+      opts.each{|key, value| setopt(key, value)}
+      opts
+    end
+    alias_method('setopts', 'set_opts')
+    alias_method('setopts!', 'set_opts')
+
+    def pop
+      pop! unless popped?
+      self
+    end
+
+    def popped?
+      defined?(@popped) and @popped
+    end
+
+    def pop!
+      if arguments.last.is_a?(Hash)
+        @popped = arguments.pop
+      else
+        @popped = true
+      end
+    end
+  end
+
+  module Arguments
+    def options
+      @options ||= Options.for(last.is_a?(Hash) ? last : {})
+    ensure
+      @options.arguments = self
+    end
+
+    class << Arguments
+      def for(args)
+        args.extend(Arguments) unless args.is_a?(Arguments)
+        args
+      end
+
+      def parse(args)
+        [args, Options.parse(args)]
+      end
+    end
+  end
+end
+
+
+def Map.options(*args, &block)
+  Map::Options.for(*args, &block)
+end
+
+def Map.opts(*args, &block)
+  Map::Options.for(*args, &block)
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: map
 version: !ruby/object:Gem::Version 
-  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 4
+  - 5
   - 0
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-21 00:00:00 -06:00
+date: 2010-10-28 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +28,7 @@ extra_rdoc_files: []
 
 files: 
 - a.rb
+- lib/map/options.rb
 - lib/map/struct.rb
 - lib/map.rb
 - Rakefile
@@ -50,7 +50,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -59,7 +58,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"