map 4.2.0 → 4.3.0

data/LICENSE

@@ -0,0 +1 @@
+same as ruby's

data/README

@@ -139,3 +139,7 @@ DESCRIPTION
 
 USAGE
   see lib/map.rb and test/map_test.rb
+
+HISTORY
+  4.3.0:
+    - support for dot keys. map.set('a.b.c' => 42) #=> {'a'=>{'b'=>{'c'=>42}}}

data/Rakefile

@@ -3,6 +3,9 @@ This.author = "Ara T. Howard"
 This.email = "ara.t.howard@gmail.com"
 This.homepage = "https://github.com/ahoward/#{ This.lib }"
 
+task :license do
+  open('LICENSE', 'w'){|fd| fd.puts "same as ruby's"}
+end
 
 task :default do
   puts((Rake::Task.tasks.map{|task| task.name.gsub(/::/,':')} - ['default']).sort)
@@ -26,11 +29,10 @@ def run_tests!(which = nil)
         
   div = ('=' * 119)
   line = ('-' * 119)
-  helper = "-r ./test/helper.rb" if test(?e, "./test/helper.rb")
 
   test_rbs.each_with_index do |test_rb, index|
     testno = index + 1
-    command = "#{ This.ruby } -I ./lib -I ./test/lib #{ helper } #{ test_rb }"
+    command = "#{ This.ruby } -I ./lib -I ./test/lib #{ test_rb }"
 
     puts
     say(div, :color => :cyan, :bold => true)

data/a.rb

@@ -0,0 +1,7 @@
+require 'map'
+
+m = Map.new
+
+m.default = []
+
+m.get(:a, :b)

data/lib/map.rb

@@ -1,5 +1,5 @@
 class Map < Hash
-  Version = '4.2.0' unless defined?(Version)
+  Version = '4.3.0' unless defined?(Version)
   Load = Kernel.method(:load) unless defined?(Load)
 
   class << Map
@@ -184,6 +184,8 @@ class Map < Hash
       when 1
         first = args.first
         case first
+          when nil, false
+            nil
           when Hash
             initialize_from_hash(first)
           when Array
@@ -227,9 +229,16 @@ class Map < Hash
     klass.map_for(hash)
   end
 
+=begin
   def self.convert_key(key)
     key.kind_of?(Symbol) ? key.to_s : key
   end
+=end
+
+  def self.convert_key(key)
+    key = key.kind_of?(Symbol) ? key.to_s : key
+  end
+
   def convert_key(key)
     if klass.respond_to?(:convert_key)
       klass.convert_key(key)
@@ -312,11 +321,13 @@ class Map < Hash
   alias_method 'store', '[]='
 
   def [](key)
-    __get__(convert_key(key))
+    key = convert_key(key)
+    __get__(key)
   end
 
   def fetch(key, *args, &block)
-    super(convert_key(key), *args, &block)
+    key = convert_key(key)
+    super(key, *args, &block)
   end
 
   def key?(key)
@@ -553,19 +564,11 @@ class Map < Hash
     hash
   end
 
-  def as_hash
-    @class = Hash
-    yield
-  ensure
-    @class = nil
-  end
-
-  def class
-    @class || super
-  end
-
-  def to_yaml(*args, &block)
-    as_hash{ super }
+  def to_yaml( opts = {} )
+    map = self
+    YAML.quick_emit(self.object_id, opts){|out|
+      out.map('!omap'){|m| map.each{|k,v| m.add(k, v)}}
+    }
   end
 
   def to_array
@@ -625,8 +628,14 @@ class Map < Hash
 # support for compound key indexing and depth first iteration
 #
   def get(*keys)
-    keys = keys.flatten
-    return self[keys.first] if keys.size <= 1
+    keys = key_for(keys)
+    if keys.size <= 1
+      if !self.has_key?(keys.first) && block_given?
+        return yield
+      else
+        return self[keys.first] 
+      end
+    end
     keys, key = keys[0..-2], keys[-1]
     collection = self
     keys.each do |k|
@@ -634,11 +643,17 @@ class Map < Hash
       collection = collection[k]
       return collection unless collection.respond_to?('[]')
     end
-    collection[alphanumeric_key_for(key)]
+    alphanumeric_key = alphanumeric_key_for(key)
+
+    if !collection_has_key?(collection, alphanumeric_key) && block_given?
+      yield
+    else
+      collection[alphanumeric_key]
+    end
   end
 
   def has?(*keys)
-    keys = keys.flatten
+    keys = key_for(keys)
     collection = self
     return collection_has_key?(collection, keys.first) if keys.size <= 1
     keys, key = keys[0..-2], keys[-1]
@@ -695,6 +710,9 @@ class Map < Hash
       keys = Array(keys).flatten
 
       collection = self
+
+      keys = key_for(keys)
+
       if keys.size <= 1
         key = keys.first
         collection[key] = value
@@ -789,6 +807,51 @@ class Map < Hash
     Map.alphanumeric_key_for(key)
   end
 
+## key path support
+#
+  def self.dot_key_for(*keys)
+    dot = keys.compact.flatten.join('.')
+    dot.split(%r/\s*[,.:_-]\s*/).map{|part| part =~ %r/^\d+$/ ? Integer(part) : part}
+  end
+
+  def self.dot_keys
+    @@dot_keys = {} unless defined?(@@dot_keys)
+    @@dot_keys
+  end
+
+  def self.dot_keys?
+    ancestors.each do |ancestor|
+      return dot_keys[ancestor] if dot_keys.has_key?(ancestor)
+    end
+    false
+  end
+
+  def dot_keys?
+    @dot_keys = false unless defined?(@dot_keys)
+    @dot_keys
+  end
+
+  def self.dot_keys!(boolean = true)
+    dot_keys[self] = !!boolean
+  end
+
+  def dot_keys!(boolean = true)
+    @dot_keys = !!boolean
+  end
+
+  def self.key_for(*keys)
+    return keys.flatten unless dot_keys?
+    self.dot_key_for(*keys)
+  end
+
+  def key_for(*keys)
+    if dot_keys?
+      self.class.dot_key_for(*keys)
+    else
+      self.class.key_for(*keys)
+    end
+  end
+
 ## TODO - technically this returns only leaves so the name isn't *quite* right.  re-factor for 3.0
 #
   def Map.depth_first_each(enumerable, path = [], accum = [], &block)

data/map.gemspec

@@ -3,15 +3,17 @@
 
 Gem::Specification::new do |spec|
   spec.name = "map"
-  spec.version = "4.2.0"
+  spec.version = "4.3.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "map"
   spec.description = "description: map kicks the ass"
 
   spec.files =
-["README",
+["LICENSE",
+ "README",
  "Rakefile",
  "TODO",
+ "a.rb",
  "lib",
  "lib/map",
  "lib/map.rb",

data/test/lib/testing.rb

@@ -6,7 +6,7 @@
     Class.new(Test::Unit::TestCase) do
       eval("This=self")
 
-      def This.slug_for(*args)
+      def self.slug_for(*args)
         string = args.flatten.compact.join('-')
         words = string.to_s.scan(%r/\w+/)
         words.map!{|word| word.gsub %r/[^0-9a-zA-Z_-]/, ''}

data/test/map_test.rb

@@ -24,6 +24,11 @@ Testing Map do
     assert{ Map.new(*array) }
   end
 
+  testing 'that the constructor does not die when passed nil or false' do
+    assert{ Map.new(nil) }
+    assert{ Map.new(false) }
+  end
+
   testing 'that the contructor accepts an even sized array' do
     arrays = [
       [ %w( k v ), %w( key val ) ],
@@ -327,6 +332,35 @@ Testing Map do
     assert{ m[:x][:y][:z] == 42.0 }
   end
 
+  testing 'that maps can support compound key/val setting via key.dot notation' do
+    m = Class.new(Map){ dot_keys! }.new
+    assert{ m.set('a.b.c', 42) }
+    assert{ m[:a][:b][:c] == 42 }
+    assert{ m.get('a.b.c') == 42 }
+    assert{ m.set('x.y.z' => 42.0, 'A.2' => 'forty-two') }
+    assert{ m[:A].is_a?(Array) }
+    assert{ m[:A].size == 3}
+    assert{ m[:A][2] == 'forty-two' }
+    assert{ m[:x][:y].is_a?(Hash) }
+    assert{ m[:x][:y][:z] == 42.0 }
+    assert{ m.has?('a.b.c') }
+    assert{ m.has?('x.y.z') }
+    assert{ m.has?('A.2') }
+  end
+
+  testing 'that Map#get supports providing a default value in a block' do
+    m = Map.new
+    m.set(:a, :b, :c, 42)
+    m.set(:z, 1)
+    
+    assert { m.get(:x) {1} == 1 }
+    assert { m.get(:z) {2} == 1 }
+    assert { m.get(:a, :b, :d) {1} == 1 }
+    assert { m.get(:a, :b, :c) {1} == 42 }
+    assert { m.get(:a, :b) {1} == Map.new({:c => 42}) }
+    assert { m.get(:a, :aa) {1} == 1 }
+  end
+
   testing 'that setting a sub-container does not eff up the container values' do
     m = Map.new
     assert{ m.set(:array => [0,1,2]) }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: map
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 51
   prerelease: 
   segments: 
   - 4
-  - 2
+  - 3
   - 0
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 -06:00
+date: 2011-08-17 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -28,9 +28,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- LICENSE
 - README
 - Rakefile
 - TODO
+- a.rb
 - lib/map.rb
 - lib/map/options.rb
 - lib/map/struct.rb