match_map 1.1.0 → 2.0.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+bundler_args: --without documentation
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - jruby-18mode
+  - rbx-18mode

data/CHANGES

@@ -1,3 +1,7 @@
+2.0.0 !!!! THIS IS  A BIG, BACKWARDS-INCOMPATIBLE CHANGE !!!!
+      MatchMap now always returns an array (possibly empty) 
+      Changed to use 1.8/1.9 specific code to simplify things;
+1.1.1 Fixed Proc; removed dependence on 1.9
 1.1.0 Add a different optimize method and benchmarking code; now 1.9 only
 1.0.0 Improve documentation and bump version to 1.0.0
 0.5.0 Change underlying structures so return order is guaranteed; lost optimize in the process

data/Gemfile

@@ -6,11 +6,24 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 
+if RUBY_VERSION =~ /^1.8/
+  gem 'hashery'
+end
+
+
+group :documentation do
+  gem "yard", "~> 0.6.0"
+end  
 
 group :development do
   gem "minitest", ">= 0"
-  gem "yard", "~> 0.6.0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1"
   gem "jeweler", "~> 1.6.4"
-  gem 'turn', '>=0.9.3'
 end
+
+# Don't require 'turn' to format tests, but use it if you have it
+# begin
+#   require 'turn'
+#   gem 'turn', '>=0.9.3'
+# rescue LoadError
+# end

data/README.md

@@ -16,7 +16,7 @@ mm['aa']  #=> ['apat']
 mm['b']   #=> ['bpat1', 'bpat2']
 mm['cob']  #=> ['bpat1', 'bpat2', 'bpat3'] # flattened one level!!!
 mm['cab']  #=> ['apat', 'bpat1', 'bpat2', 'bpat3']
-mm['c']    #=> nil # no match
+mm['c']    #=> [] # no match
 
 
 # Change the default miss value to ease some processing forms
@@ -38,7 +38,7 @@ mm = MatchMap.new
 mm[/ab/] = "AB"
 
 # first, without echo
-mm['miss'] = nil
+mm['miss'] = []
 mm['cab']  = ['AB']
 
 #...then with echo = :always
@@ -60,6 +60,7 @@ end
 
 A MatchMap is a hash-like with the following properties:
 
+* The return value is always a (possibly empty) array
 * keys can be anything that responds to '==' (e.g., strings) or regular expressions
 * keys cannot be repeated (mirroring how a hash works, but see below about multiple values)
 * arguments are compared to non-pattern keys based on ==
@@ -120,9 +121,11 @@ Here's a quick example to show how it works
 
 You can also use a Proc object as a value. It must:
 
-* take a single argument; the match variable
+* take a single argument; the match variable (if your key was a Regexp) or the string matched
 * return a (possibly empty) _array of values_
 
+It doesn't make a lot of sense to use a Proc value if your key is just a scalar, but it's possible.
+
 This can be abused, of course, but can be useful. Here's a simple example that reverses the order of a comma-delimited duple. 
 
 ```ruby
@@ -175,7 +178,7 @@ Obviously, only call `#optimize!` when you're sure you won't be modifying the ma
 ## Gotchas
 
 * Like a hash, repeated assignment to the same key results in a replacement. So `mm[/a/] = 'a'; mm[/a/] = 'A'` will give `mm['a'] #=> ['A']`
-* Return values are flattened one level. So, a => 1 and b => [2,3], the something that matches both will return [1,2,3]. If you really want to return an array, you need to do something like `m['a'] = [[1,2]]`
+* Return values are flattened one level. So, /a/ => 1 and b => [2,3], the something that matches both will return [1,2,3]. If you really want to return an array, you need to do something like `m['a'] = [[1,2]]`
   
 
 ## Contributing to MatchMap

data/Rakefile

@@ -14,7 +14,6 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.required_ruby_version = '>= 1.9.0' # due to use of define_singleton_method in optimize
   gem.name = "match_map"
   gem.homepage = "http://github.com/billdueber/match_map"
   gem.license = "MIT"
@@ -43,5 +42,3 @@ end
 
 task :default => :test
 
-require 'yard'
-YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-1.1.0
+2.0.0

data/lib/match_map/match_map_18.rb

@@ -0,0 +1,15 @@
+# In ruby 1.8x, the Hashes are not ordered, so we fall back on 
+# the hashery ordered_hash
+
+require 'hashery/ordered_hash'
+
+module MatchMapIncludes
+  module OnePointEight
+    # 1.8 setup
+    def setup h
+      singleton_class = class << self; self; end
+      singleton_class.send(:define_method, :inner_get, method(:normal_inner_get))
+      @map = OrderedHash.new
+    end
+  end
+end

data/lib/match_map/match_map_19.rb

@@ -0,0 +1,12 @@
+# The 1.9 hash is already ordered; just use it
+
+module MatchMapIncludes
+  module OnePointNine
+    
+    # 1.9 setup
+    def setup h
+      @map = {}
+      define_singleton_method :inner_get, method(:normal_inner_get)
+    end
+  end
+end

data/lib/match_map.rb

@@ -4,21 +4,45 @@
 
 class MatchMap
 
-  # 
   attr_accessor :default
   attr_reader   :echo
 
+  if RUBY_VERSION =~ /^1\.9/
+    require 'match_map/match_map_19'
+    include MatchMapIncludes::OnePointNine
+  else 
+    require 'match_map/match_map_18'    
+    include MatchMapIncludes::OnePointEight
+  end
+  
+  def initialize h = {}
+    @default = nil # default miss value is nil
+    @attrs = {}
+    # Set up the appripriate @map and define which inner_get to use
+    self.setup h
+    
+    # Initialize with the given hash
+    h.each_pair do |k, v| 
+      self[k] = v
+    end  
+    
+  end
 
-  def echo= arg
-    raise RuntimeError.new, "echo value must be :onmiss or :always" unless [:onmiss, :always].include? arg
-    @echo = arg
+  def delete key
+    @map.delete(key)
   end
 
+
   def []= key, val
     @map[key] = val
-    @keys.push key unless @keys.include? key
     set_attrs key, val
   end
+
+  def echo= arg
+    raise RuntimeError.new, "echo value must be :onmiss or :always" unless [:onmiss, :always].include? arg
+    @echo = arg
+  end
+
   
   def set_attrs key, val
     @attrs[key] = {:regexkey => (key.is_a? Regexp), :procval => (val.is_a? Proc)}
@@ -39,7 +63,7 @@ class MatchMap
       if @echo == :onmiss
         return [*arg]
       else
-        return @default
+        return [@default].compact
       end
     end
     return rv
@@ -51,7 +75,7 @@ class MatchMap
 
   def normal_inner_get arg
     rv = []
-    @keys.each do |k|
+    @map.keys.each do |k|
       if k.is_a? Regexp
         m = k.match arg.to_s
       else
@@ -74,29 +98,17 @@ class MatchMap
     @map.has_key? key
   end
 
-  def delete key
-    @map.delete(key)
-    @keys.delete(key)
-  end
 
-  def initialize hash = {}
-    @default = nil # default miss value is nil
-    @echo = echo
-    @keys = hash.keys
-    @map = hash
-    @attrs = {}
-    @map.each_pair {|k, v| set_attrs k, v}
-    define_singleton_method :inner_get, method(:normal_inner_get)
-  end
 
   def optimize!
+    singleton_class = class << self; self; end
     @map.each_pair do |k,v|
       if k.is_a? Regexp or v.is_a? Proc
-        define_singleton_method :inner_get, method(:normal_inner_get)
+        singleton_class.send(:define_method, :inner_get, method(:normal_inner_get))
         return
       end
     end
-    define_singleton_method :inner_get, method(:optimized_inner_get)
+    singleton_class.send(:define_method, :inner_get, method(:optimized_inner_get))
   end
 
 end

data/test/helper.rb

@@ -9,7 +9,14 @@ rescue Bundler::BundlerError => e
 end
 require 'minitest/spec'
 require 'minitest/benchmark'
-begin; require 'turn'; rescue LoadError; end
+# if RUBY_VERSION =~ /^1.9/
+#   begin
+#     require 'turn/autorun'
+#     # f = ENV['format'] ||  'progress'
+#     # Turn.config.format = f.to_sym if f
+#   rescue LoadError
+#   end
+# end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/test/test_match_map.rb

@@ -8,13 +8,13 @@ describe MatchMap do
    
   describe "when empty" do
         
-    it "should return nil (default)" do
-      @h['a'].must_equal nil
+    it "should return empty array (default)" do
+      @h['a'].must_equal []
     end
     
     it 'should allow set of default' do
       @h.default = 'def'
-      @h['a'].must_equal 'def'
+      @h['a'].must_equal ['def']
     end
     
   end
@@ -25,9 +25,9 @@ describe MatchMap do
       @h['a'].must_equal [3]
     end
         
-    it 'should still return default' do
+    it 'should still return default in an array ([] if default is nil)' do
       @h['a'] = 3
-      @h['c'].must_equal @h.default
+      @h['c'].must_equal []
     end
     
     it 'should reset a value' do
@@ -52,7 +52,7 @@ describe MatchMap do
       @h.has_key?('c').must_equal false
       @h.delete('a')
       @h.has_key?('a').must_equal false
-      @h['a'].must_equal @h.default
+      @h['a'].must_equal []
     end
   end
   
@@ -68,8 +68,8 @@ describe MatchMap do
     
     it "uses a single pattern" do
       @h[/.+a/] = 1
-      @h['b'].must_equal @h.default
-      @h['a'].must_equal @h.default
+      @h['b'].must_equal []
+      @h['a'].must_equal []
       @h['aa'].must_equal [1]
       @h['era'].must_equal [1]
     end
@@ -119,10 +119,13 @@ describe MatchMap do
       mm['Dueber, Bill'].must_equal ["Bill Dueber"]
     end
     
-    it "calls the Proc for string argument, even though that kind of an abuse" do
+    it "calls the Proc for string argument, even though that is kind of an abuse" do
       mm = MatchMap.new
-      mm['a'] = Proc.new {|m| [m[0] + 'bbb']}
+      mm['a'] = Proc.new {|m| [(m + 'bbb')]}
       mm['a'].must_equal ['abbb']
+      
+      mm[/b(.*)/] = Proc.new {|m| [m[1]]}
+      mm['b123'].must_equal ['123']
     end
   end
   
@@ -132,7 +135,7 @@ describe MatchMap do
     end
     
     it "echos when empty" do
-      @j['miss'].must_equal @h.default # no echoing
+      @j['miss'].must_equal [] # no echoing
       
       @j.echo = :always
       @j['miss'].must_equal ['miss']
@@ -144,7 +147,7 @@ describe MatchMap do
     it "echos when not empty" do
       @j[/a/] = 'hello'
       
-      @j['miss'].must_equal @j.default
+      @j['miss'].must_equal []
       
       @j.echo = :always
       @j['miss'].must_equal ['miss']
@@ -183,7 +186,7 @@ describe MatchMap do
     end
     
     it 'misses hard' do
-      @h[[1,2,3]].must_equal nil
+      @h[[1,2,3]].must_equal []
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: match_map
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000 Z
+date: 2012-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70104080307140 !ruby/object:Gem::Requirement
+  requirement: &2168628360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,32 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70104080307140
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &70104080321880 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *70104080321880
+  version_requirements: *2168628360
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70104080321120 !ruby/object:Gem::Requirement
+  requirement: &2168624380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1'
   type: :development
   prerelease: false
-  version_requirements: *70104080321120
+  version_requirements: *2168624380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70104080320260 !ruby/object:Gem::Requirement
+  requirement: &2168621520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,18 +43,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70104080320260
-- !ruby/object:Gem::Dependency
-  name: turn
-  requirement: &70104080319220 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-  type: :development
-  prerelease: false
-  version_requirements: *70104080319220
+  version_requirements: *2168621520
 description: ! "MatchMap is a map representing key=>value pairs but where \n    (a)
   a query argument can match more than one key, and (b) the argument is compraed to
   the key\n    such that you can use regex patterns as keys"
@@ -77,6 +55,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .document
+- .travis.yml
 - CHANGES
 - Gemfile
 - LICENSE.txt
@@ -85,6 +64,8 @@ files:
 - VERSION
 - bench/bench.rb
 - lib/match_map.rb
+- lib/match_map/match_map_18.rb
+- lib/match_map/match_map_19.rb
 - test/helper.rb
 - test/test_match_map.rb
 homepage: http://github.com/billdueber/match_map
@@ -99,7 +80,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: '0'
+      segments:
+      - 0
+      hash: 2828716471477841812
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: