rufus-dollar 1.0.2 → 1.0.3

data/CHANGELOG.txt

@@ -1,6 +1,12 @@
 
 = rufus-dollar CHANGELOG.txt
 
+
+== rufus-dollar - 1.0.3    released 2010/12/22
+
+- ${'key} and ${"key} produce '"value"'
+
+
 == rufus-dollar - 1.0.2    released 2009/02/04
 
 - code cleanup

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2006-2008, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2006-2011, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.txt

@@ -6,7 +6,7 @@ A one-method library for substituting ${stuff} in text strings.
 
 == getting it
 
-  sudo gem install rufus-dollar
+  gem install rufus-dollar
 
 or at
 
@@ -33,6 +33,11 @@ http://rubyforge.org/frs/?group_id=4812
   puts Rufus::dsub "${${left}${right}}", h
     # => "${name}" => "Fred Brooks"
 
+  # prefixing the key with a ' or a " makes it quotable
+
+  puts Rufus::dsub "${name} wrote ${'title}", h
+    # => 'Fred Brooks wrote "Silver Bullet"'
+
 
 == dependencies
 

data/Rakefile

@@ -0,0 +1,85 @@
+
+$:.unshift('.') # 1.9.2
+
+require 'rubygems'
+
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+
+
+#
+# clean
+
+CLEAN.include('pkg', 'rdoc')
+
+
+#
+# test / spec
+
+#task :spec => :check_dependencies do
+task :spec do
+  sh 'rspec spec/'
+end
+task :test => :spec
+
+task :default => :spec
+
+
+#
+# gem
+
+GEMSPEC_FILE = Dir['*.gemspec'].first
+GEMSPEC = eval(File.read(GEMSPEC_FILE))
+GEMSPEC.validate
+
+
+desc %{
+  builds the gem and places it in pkg/
+}
+task :build do
+
+  sh "gem build #{GEMSPEC_FILE}"
+  sh "mkdir pkg" rescue nil
+  sh "mv #{GEMSPEC.name}-#{GEMSPEC.version}.gem pkg/"
+end
+
+desc %{
+  builds the gem and pushes it to rubygems.org
+}
+task :push => :build do
+
+  sh "gem push pkg/#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+
+#
+# rdoc
+#
+# make sure to have rdoc 2.5.x to run that
+
+Rake::RDocTask.new do |rd|
+
+  rd.main = 'README.txt'
+  rd.rdoc_dir = 'rdoc'
+
+  rd.rdoc_files.include('README.txt', 'CHANGELOG.txt', 'lib/**/*.rb')
+
+  rd.title = "#{GEMSPEC.name} #{GEMSPEC.version}"
+end
+
+
+#
+# upload_rdoc
+
+desc %{
+  upload the rdoc to rubyforge
+}
+task :upload_rdoc => [ :clean, :rdoc ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = "/var/www/gforge-projects/rufus"
+
+  sh "rsync -azv -e ssh rdoc/#{GEMSPEC.name} #{account}:#{webdir}/"
+end
+

data/lib/rufus/dollar.rb

@@ -1,6 +1,5 @@
-#
 #--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2006-2011, John Mettraux, jmettraux@gmail.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,76 +19,93 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 
 module Rufus
 
-  #
   # Performs 'dollar substitution' on a piece of text with a given
   # dictionary.
   #
-  #   require 'rubygems'
-  #   require 'rufus/dollar'
-  #
-  #   h = {
-  #     "name" => "Fred Brooke",
-  #     "title" => "Silver Bullet"
-  #   }
+  # Please use Rufus::Dollar.dsub instead, this Rufus.dsub is kept
+  # for backward compatibility.
   #
-  #   puts Rufus::dsub "${name} wrote '${title}'", h
-  #     # => "Fred Brooke wrote 'Silver Bullet'"
-  #
-  def self.dsub (text, dict, offset=nil)
+  def self.dsub(text, dict)
 
-    text = text.to_s
+    Rufus::Dollar.dsub(text, dict)
+  end
 
-    j = text.index('}', offset || 0)
+  module Dollar
 
-    return text unless j
+    VERSION = '1.0.3'
 
-    t = text[0, j]
+    # Performs 'dollar substitution' on a piece of text with a given
+    # dictionary.
+    #
+    #   require 'rubygems'
+    #   require 'rufus/dollar'
+    #
+    #   h = {
+    #     "name" => "Fred Brooke",
+    #     "title" => "Silver Bullet"
+    #   }
+    #
+    #   puts Rufus::Dollar.dsub "${name} wrote '${title}'", h
+    #     # => "Fred Brooke wrote 'Silver Bullet'"
+    #
+    # == ${'key} or ${"key}
+    #
+    #   puts Rufus::Dollar.dsub "${name} wrote ${title}", h
+    #     # => "Fred Brooke wrote Silver Bullet"
+    #
+    #   puts Rufus::Dollar.dsub "${name} wrote ${'title}", h
+    #     # => 'Fred Brooke wrote "Silver Bullet"'
+    #
+    def self.dsub(text, dict, offset=nil)
 
-    i = t.rindex('${')
-    ii = t.rindex("\\${")
+      text = text.to_s
 
-    iii = t.rindex('{')
-    iii = nil if offset
+      j = text.index('}', offset || 0)
 
-    return text unless i
-    return dsub(text, dict, j+1) if (iii) and (iii-1 > i)
+      return text unless j
 
-    return unescape(text) if (i) and (i != 0) and (ii == i-1)
-      #
-      # found "\${"
+      t = text[0, j]
 
-    key = text[i+2..j-1]
+      i = t.rindex('${')
+      ii = t.rindex("\\${")
 
-    value = dict[key]
+      iii = t.rindex('{')
+      iii = nil if offset
 
-    value = if value
-      value.to_s
-    else
-      dict.has_key?(key) ? 'false' : ''
-    end
+      return text unless i
+      return dsub(text, dict, j+1) if (iii) and (iii-1 > i)
 
-    pre = (i > 0) ? text[0..i-1] : ''
+      return unescape(text) if (i) and (i != 0) and (ii == i-1)
+        #
+        # found "\${"
 
-    dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
-  end
+      key = text[i+2..j-1]
+      quote = false
 
-  private
+      if m = key.match(/^['"](.+)$/)
+        key = m[1]
+        quote = true
+      end
 
-  def self.unescape (text)
+      value = dict[key]
+      value = value.nil? ? '' : value.to_s
+      value = value.inspect if quote
 
-    text.gsub("\\\\\\$\\{", "\\${")
-  end
+      pre = (i > 0) ? text[0..i-1] : ''
+
+      dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
+    end
 
+    private
+
+    def self.unescape(text)
+
+      text.gsub("\\\\\\$\\{", "\\${")
+    end
+  end
 end
 

data/rufus-dollar.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+
+  s.name = 'rufus-dollar'
+  s.version = File.read('lib/rufus/dollar.rb').match(/VERSION = '([^']+)'/)[1]
+  s.platform = Gem::Platform::RUBY
+  s.authors = [ 'John Mettraux' ]
+  s.email = [ 'jmettraux@gmail.com' ]
+  s.homepage = 'http://rufus.rubyforge.org'
+  s.rubyforge_project = 'rufus'
+  s.summary = '${xxx} substitutions'
+  s.description = %{
+${xxx} substitutions
+  }
+
+  #s.files = `git ls-files`.split("\n")
+  s.files = Dir[
+    'Rakefile',
+    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    '*.gemspec', '*.txt', '*.rdoc', '*.md'
+  ]
+
+  #s.add_runtime_dependency 'rufus-json', '>= 0.2.5'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', ">= 2.0"
+
+  s.require_path = 'lib'
+end
+

data/spec/dollar_spec.rb

@@ -0,0 +1,118 @@
+
+#
+# Specifying rufus-dollar
+#
+# Tue Dec 21 15:48:43 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'spec_base')
+
+
+describe Rufus::Dollar do
+
+  context 'simple usage' do
+
+    let(:dict) do
+      {
+        'renard' => 'goupil',
+        'cane' => 'oie',
+        'oie blanche' => 'poule',
+        'x' => 'y'
+      }
+    end
+
+    describe '.dsub' do
+
+      it "doesn't substitute if there are no ${}" do
+
+        dsub("le petit renard").should == "le petit renard"
+      end
+
+      it "doesn't substitute if there is only {}" do
+
+        dsub("le petit {renard}").should == "le petit {renard}"
+      end
+
+      it "substitutes at the end" do
+
+        dsub("le petit ${renard}").should == "le petit goupil"
+      end
+
+      it "substitutes in the middle" do
+
+        dsub("le petit ${renard} noir").should == "le petit goupil noir"
+      end
+
+      it "substitutes when there are two ${}" do
+
+        dsub("le ${renard} et la ${cane}").should == "le goupil et la oie"
+          # excuse my french
+      end
+
+      it "doesn't substitute when escaped \\\\${renard}" do
+
+        dsub("le petit \\${renard} noir").should == "le petit \\${renard} noir"
+      end
+
+      it "leaves \\n untouched" do
+
+        dsub("\n").should == "\n"
+      end
+
+      it "substitutes to a blank when there is no entry in the dict" do
+
+        dsub("le petit ${chien} suisse").should == "le petit  suisse"
+      end
+    end
+  end
+
+  #def test_0
+  #  dotest " ${a${b}e} ", {}, "  "
+  #  dotest " ${a{b}e} ", {}, "  "
+  #  dotest "${a{b}e}", {}, ""
+  #  dotest " \\${a{b}e} ", {}, " \\${a{b}e} "
+  #  dotest "{a${b}c}", { "b" => 2 }, "{a2c}"
+  #end
+    # no need to integrate that for now
+
+  context 'nested brackets' do
+
+    let(:dict) do
+      {
+        'B' => 'b',
+        'ab' => 'ok'
+      }
+    end
+
+    describe '.dsub' do
+
+      it 'substitutes successively' do
+
+        dsub("${a${B}}").should == 'ok'
+      end
+    end
+  end
+
+  context 'dollar bracket double-quote' do
+
+    let(:dict) do
+      {
+        'renard' => 'goupil',
+      }
+    end
+
+    describe '.dsub' do
+
+      it 'encloses in double-quotes when ${\'renard}' do
+
+        dsub("${'renard}").should == '"goupil"'
+      end
+
+      it 'encloses in double-quotes when ${"renard}' do
+
+        dsub('${"renard}').should == '"goupil"'
+      end
+    end
+  end
+end
+

data/spec/spec_base.rb

@@ -0,0 +1,15 @@
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rufus-dollar'
+
+
+#
+# rspec helpers
+
+Dir[File.join(File.dirname(__FILE__), 'support/*.rb')].each { |f| require(f) }
+
+RSpec.configure do |config|
+  config.include DollarHelper
+end
+

data/spec/support/dollar_helper.rb

@@ -0,0 +1,9 @@
+
+module DollarHelper
+
+  def dsub(template)
+
+    Rufus::Dollar.dsub(template, dict)
+  end
+end
+

metadata

@@ -1,64 +1,97 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-dollar
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  prerelease: false
+  segments: 
+    - 1
+    - 0
+    - 3
+  version: 1.0.3
 platform: ruby
 authors: 
-- John Mettraux
+  - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-04 00:00:00 +09:00
+date: 2010-12-22 00:00:00 +09:00
 default_executable: 
-dependencies: []
-
-description: 
-email: jmettraux@gmail.com
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+            version: "2.0"
+    type: :development
+    version_requirements: *id002
+description: "\n\
+  ${xxx} substitutions\n  "
+email: 
+  - jmettraux@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.txt
-- CHANGELOG.txt
-- LICENSE.txt
+extra_rdoc_files: []
+
 files: 
-- lib/rufus
-- lib/rufus/dollar.rb
-- lib/rufus-dollar.rb
-- test/dollar_test.rb
-- test/nested_test.rb
-- test/test.rb
-- test/test_base.rb
-- README.txt
-- CHANGELOG.txt
-- LICENSE.txt
+  - Rakefile
+  - lib/rufus-dollar.rb
+  - lib/rufus/dollar.rb
+  - spec/dollar_spec.rb
+  - spec/spec_base.rb
+  - spec/support/dollar_helper.rb
+  - rufus-dollar.gemspec
+  - CHANGELOG.txt
+  - LICENSE.txt
+  - README.txt
 has_rdoc: true
-homepage: http://rufus.rubyforge.org/rufus-dollar
+homepage: http://rufus.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.1
+rubyforge_project: rufus
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: ${xxx} substitutions
-test_files: 
-- test/test.rb
+test_files: []
+

data/test/dollar_test.rb

@@ -1,80 +0,0 @@
-
-#
-# Testing rufus-dollar
-#
-# John Mettraux at openwfe.org
-#
-# Mon Oct  9 22:19:44 JST 2006
-#
-
-require 'test/unit'
-require File.dirname(__FILE__) + '/test_base'
-
-
-class DollarTest < Test::Unit::TestCase
-  include TestBase
-
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
-  def test_0
-
-    dict = {}
-
-    dict['renard'] = 'goupil'
-    dict['cane'] = 'oie'
-    dict['oie blanche'] = 'poule'
-
-    dotest "le petit renard", dict, "le petit renard"
-    dotest "le petit {renard}", dict, "le petit {renard}"
-    dotest "le petit ${renard}", dict, "le petit goupil"
-    dotest "le petit ${renard} noir", dict, "le petit goupil noir"
-
-    dotest "la grande ${${cane} blanche}", dict, "la grande poule"
-
-    dotest "le ${renard} et la ${cane}", dict, "le goupil et la oie"
-      #
-      # excuse my french...
-
-    dotest "le \\${renard} encore", dict, "le \\${renard} encore"
-
-    dotest "", dict, ""
-
-    dotest("""
-""", dict, """
-""")
-    dotest(""" 
-""", dict, """ 
-""")
-  end
-
-  def test_1
-
-    dict = {}
-    dict['x'] = 'y'
-
-    dotest "${x}", dict, "y"
-    dotest "\\${x}", dict, "\\${x}"
-  end
-
-  def test_2
-
-    dict = {}
-    dict['A'] = 'a'
-    dict['B'] = 'b'
-    dict['ab'] = 'ok'
-
-    dotest "${${A}${B}}", dict, "ok"
-  end
-
-  #def test_3
-  #  assert_equal OpenWFE.unescape("toto and ${toto}"), "toto and ${toto}"
-  #  assert_equal OpenWFE.unescape("toto & \${toto}"), "toto & ${toto}"
-  #  assert_equal "toto & \\${toto}", "toto & ${toto}"
-  #  #assert_equal OpenWFE.unescape('toto & \${toto}'), "toto & ${toto}"
-  #end
-
-end

data/test/nested_test.rb

@@ -1,30 +0,0 @@
-
-#
-# Testing rufus-dollar
-#
-# John Mettraux at openwfe.org
-#
-# Mon Feb 18 23:32:12 JST 2008
-#
-
-require File.dirname(__FILE__) + '/test_base'
-
-
-class NestedTest < Test::Unit::TestCase
-  include TestBase
-
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
-  def test_0
-
-    dotest " ${a${b}e} ", {}, "  "
-    dotest " ${a{b}e} ", {}, "  "
-    dotest "${a{b}e}", {}, ""
-    dotest " \\${a{b}e} ", {}, " \\${a{b}e} "
-    dotest "{a${b}c}", { "b" => 2 }, "{a2c}"
-  end
-end

data/test/test.rb

@@ -1,4 +0,0 @@
-
-require File.dirname(__FILE__) + '/dollar_test'
-require File.dirname(__FILE__) + '/nested_test'
-

data/test/test_base.rb

@@ -1,27 +0,0 @@
-
-#
-# Testing rufus-dollar
-#
-# John Mettraux at openwfe.org
-#
-# Mon Feb 18 23:30:37 JST 2008
-#
-
-$:.unshift File.dirname(__FILE__) + '/../lib/'
-
-require 'test/unit'
-require 'rufus/dollar'
-
-
-module TestBase
-
-  protected
-
-  def dotest (text, dict, target)
-
-    result = Rufus.dsub(text, dict)
-
-    assert_equal target, result
-  end
-end
-