string_enumerator 0.0.1 → 0.1.0

data/README.rdoc

@@ -1,19 +1,9 @@
 =string_enumerator
 
-You provide a list of replacements ("replace [color] with red and blue"):
+You provide a list of replacements ("replace [color] with red and blue") and then call the <tt>#enumerate</tt> method on a <tt>String</tt>:
 
-    require 'string_enumerator'
-    class ColorEnumerator < StringEnumerator
-      # Interface to StringEnumerator
-      def replacements
-        { :color => [ 'red', 'blue' ] }
-      end
-    end
-
-Then you call the <tt>#enumerate</tt> method on a <tt>String</tt>:
-
-    ?> u = ColorEnumerator.new
-    => #<ColorEnumerator...>
+    ?> u = StringEnumerator.new(:color => [ 'red', 'blue' ])
+    => #<StringEnumerator...>
     ?> u.enumerate 'http://example.com/[color]'
     => [ 'http://example.com/blue', 'http://example.com/red' ]
 
@@ -23,21 +13,13 @@ The start and end of placeholders are marked with "[" and "]" (although you can
 
 You can define as many replacements as you want, which will exponentially increase the final number of enumerations
 
-    require 'string_enumerator'
-    class ColorAndTasteEnumerator < StringEnumerator
-      def replacements
-        {
-          :color => [ 'red', 'blue' ],
-          :taste => [ 'savory', 'sweet' ]
-        }
-      end
-    end
-
-Then you'll get
-
-    ?> u2 = ColorAndTasteEnumerator.new
-    => #<ColorAndTasteEnumerator...>
+    ?> u2 = StringEnumerator.new(:color => [ 'red', 'blue' ], :taste => [ 'savory', 'sweet' ])
+    => #<StringEnumerator...>
     ?> u2.enumerate 'http://example.com/[color]/[taste]'
     => [ 'http://example.com/blue/savory', 'http://example.com/blue/sweet', 'http://example.com/red/savory', 'http://example.com/red/sweet' ]
 
+==Thanks to
+
+* https://github.com/trans for https://github.com/seamusabshere/string_enumerator/issues/1
+
 Copyright 2011 Seamus Abshere

data/lib/string_enumerator.rb

@@ -1,53 +1,43 @@
 require "string_enumerator/version"
 
 class StringEnumerator
+  def initialize(replacements)
+    @replacements = replacements.inject({}) do |memo, (k, v)|
+      memo[k.to_s] = v
+      memo
+    end
+  end
+
+  attr_reader :replacements
+  
+  attr_writer :start_mark
+  def start_mark
+    @start_mark || '['
+  end
+  
+  attr_writer :end_mark
+  def end_mark
+    @end_mark || ']'
+  end
+  
   # Get all the possible enumerations of <tt>str</tt> given the <tt>replacements</tt> you defined
   def enumerate(str)
     enumerations = [str] # seed it
     str.scan(pattern) do |placeholder|
       placeholder = placeholder[0]
-      if r = stringified_replacements[placeholder]
+      if r = replacements[placeholder]
+        # "recursion"
         enumerations = enumerations.map do |e|
-          r.map { |replacement| e.gsub(%{[#{placeholder}]}, replacement) }
+          r.map { |replacement| e.gsub(%{#{start_mark}#{placeholder}#{end_mark}}, replacement) }
         end.flatten
       end
     end
     enumerations
   end
   
-  # Your class should override this
-  #
-  # For example:
-  #     class ColorAndTasteEnumerator < StringEnumerator
-  #       def replacements
-  #         {
-  #           :color => [ 'red', 'blue' ],
-  #           :taste => [ 'savory', 'sweet' ]
-  #         }
-  #       end
-  #     end
-  def replacements
-    raise "[StringEnumerator] Override this method with your replacements"
-  end
-  
   private
-  
-  def stringified_replacements
-    @stringified_replacements ||= replacements.inject({}) do |memo, (k, v)|
-      memo[k.to_s] = v
-      memo
-    end
-  end
-  
+
   def pattern
     @pattern ||= /#{::Regexp.escape(start_mark)}([^#{::Regexp.escape(end_mark)}]+)#{::Regexp.escape(end_mark)}/
   end
-  
-  def start_mark
-    '['
-  end
-  
-  def end_mark
-    ']'
-  end
 end

data/lib/string_enumerator/version.rb

@@ -1,3 +1,3 @@
 class StringEnumerator
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/test_string_enumerator.rb

@@ -2,21 +2,14 @@ require 'helper'
 require 'brighter_planet_metadata'
 require 'active_support/core_ext'
 
-class UrlFiller < StringEnumerator
-  # this has to return a Hash of placeholder => replacement pairs
-  def replacements
-    {
+class TestStringEnumerator < Test::Unit::TestCase
+  def setup
+    @f = StringEnumerator.new({
       :certified_emitter_underscore_plural  => BrighterPlanet.metadata.certified_emitters.map { |emitter| emitter.underscore.pluralize },
       :emission_estimate_service_color      => %w{red blue},
       :emitter_underscore_plural            => BrighterPlanet.metadata.emitters.map { |emitter| emitter.underscore.pluralize },
       :resource_underscore                  => BrighterPlanet.metadata.resources.map { |resource| resource.underscore }
-    }
-  end
-end
-
-class TestStringEnumerator < Test::Unit::TestCase
-  def setup
-    @f = UrlFiller.new
+    })
   end
   
   def test_001_enumerates_emitters
@@ -50,4 +43,10 @@ class TestStringEnumerator < Test::Unit::TestCase
     enumerated = @f.enumerate("http://carbon.brighterplanet.com/[]/options.html")
     assert_equal ["http://carbon.brighterplanet.com/[]/options.html"], enumerated
   end
+  
+  def test_005_different_start_mark
+    @f.start_mark = 'BOOYAH'
+    enumerated = @f.enumerate("http://carbon.brighterplanet.com/BOOYAHemitter_underscore_plural]/options.html")
+    assert enumerated.include?("http://carbon.brighterplanet.com/flights/options.html")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: string_enumerator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-06-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2155467220 !ruby/object:Gem::Requirement
+  requirement: &2161206980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155467220
+  version_requirements: *2161206980
 - !ruby/object:Gem::Dependency
   name: brighter_planet_metadata
-  requirement: &2155466800 !ruby/object:Gem::Requirement
+  requirement: &2161206560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155466800
+  version_requirements: *2161206560
 description: Fill strings that have placeholders like [color], possibly returning
   multiple results.
 email: