string_enumerator 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+rdoc/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in string_enumerator.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,43 @@
+=string_enumerator
+
+You provide a list of replacements ("replace [color] with red and blue"):
+
+    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.enumerate 'http://example.com/[color]'
+    => [ 'http://example.com/blue', 'http://example.com/red' ]
+
+The start and end of placeholders are marked with "[" and "]" (although you can override this if you want, see the tests.)
+
+==Multiple placeholders per string
+
+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.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' ]
+
+Copyright 2011 Seamus Abshere

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'string_enumerator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/lib/string_enumerator/version.rb

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

data/lib/string_enumerator.rb

@@ -0,0 +1,53 @@
+require "string_enumerator/version"
+
+class StringEnumerator
+  # 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]
+        enumerations = enumerations.map do |e|
+          r.map { |replacement| e.gsub(%{[#{placeholder}]}, 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/string_enumerator.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "string_enumerator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "string_enumerator"
+  s.version     = StringEnumerator::VERSION
+  s.authors     = ["Seamus Abshere"]
+  s.email       = ["seamus@abshere.net"]
+  s.homepage    = "https://github.com/seamusabshere/string_enumerator"
+  s.summary     = %q{Given a string containing placeholders (like [color]), enumerate all of the possible strings resulting from filling those placeholders with replacements (like red, blue).}
+  s.description = %q{Fill strings that have placeholders like [color], possibly returning multiple results.}
+
+  s.rubyforge_project = "string_enumerator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'brighter_planet_metadata'
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'test/unit'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'string_enumerator'
+class Test::Unit::TestCase
+end

data/test/test_string_enumerator.rb

@@ -0,0 +1,53 @@
+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
+    {
+      :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
+    automatically_enumerated = @f.enumerate("http://carbon.brighterplanet.com/[emitter_underscore_plural]/options.html")
+    manually_enumerated = BrighterPlanet.metadata.emitters.map do |emitter|
+      "http://carbon.brighterplanet.com/#{emitter.underscore.pluralize}/options.html"
+    end
+    assert_equal automatically_enumerated.sort, manually_enumerated.sort
+  end
+
+  def test_002_enumerates_emitters_and_colors
+    automatically_enumerated = @f.enumerate("http://cm1-production-[emission_estimate_service_color].carbon.brighterplanet.com/[emitter_underscore_plural]/options.html")
+    manually_enumerated = BrighterPlanet.metadata.emitters.map do |emitter|
+      %w{red blue}.map do |color|
+        "http://cm1-production-#{color}.carbon.brighterplanet.com/#{emitter.underscore.pluralize}/options.html"
+      end
+    end.flatten
+    assert_equal automatically_enumerated.sort, manually_enumerated.sort
+  end
+  
+  # sanity check, we'd never do this
+  def test_003_enumerates_emitters_and_colors_and_resources
+    enumerated = @f.enumerate("http://cm1-production-[emission_estimate_service_color].carbon.brighterplanet.com/[emitter_underscore_plural]/options.html?foobar=[resource_underscore]")
+    assert enumerated.include?("http://cm1-production-red.carbon.brighterplanet.com/flights/options.html?foobar=flight_segment")
+    assert enumerated.include?("http://cm1-production-blue.carbon.brighterplanet.com/flights/options.html?foobar=flight_segment")
+    assert enumerated.include?("http://cm1-production-red.carbon.brighterplanet.com/automobile_trips/options.html?foobar=flight_segment")
+    assert enumerated.include?("http://cm1-production-blue.carbon.brighterplanet.com/automobile_trips/options.html?foobar=flight_segment")
+  end
+  
+  def test_004_edge_case_empty_placeholder
+    enumerated = @f.enumerate("http://carbon.brighterplanet.com/[]/options.html")
+    assert_equal ["http://carbon.brighterplanet.com/[]/options.html"], enumerated
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: string_enumerator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2155467220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155467220
+- !ruby/object:Gem::Dependency
+  name: brighter_planet_metadata
+  requirement: &2155466800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155466800
+description: Fill strings that have placeholders like [color], possibly returning
+  multiple results.
+email:
+- seamus@abshere.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/string_enumerator.rb
+- lib/string_enumerator/version.rb
+- string_enumerator.gemspec
+- test/helper.rb
+- test/test_string_enumerator.rb
+homepage: https://github.com/seamusabshere/string_enumerator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: string_enumerator
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Given a string containing placeholders (like [color]), enumerate all of the
+  possible strings resulting from filling those placeholders with replacements (like
+  red, blue).
+test_files:
+- test/helper.rb
+- test/test_string_enumerator.rb