erbextensions 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0.0 / 2008-06-26
+Initial release of erbextensions.  This release includes support for:
+* Returning the processed contents of a named erb file
+  (ERB.process_file).  This makes it very easy to include one erb file
+  within another erb file.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Designing Patterns
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,11 @@
+Manifest.txt
+LICENSE
+History.txt
+README.txt
+Rakefile
+examples/template.erb
+examples/template_wrapper.erb
+lib/erbextensions.rb
+test/test_erbextensions.rb
+test/test2.erb
+test/test.erb

data/README.txt

@@ -0,0 +1,120 @@
+= erbextensions
+* Project Page: http://rubyforge.org/projects/erbextensions/
+* Documentation: http://erbextensions.rubyforge.org/
+
+== DESCRIPTION:
+This package enhances the Standard ERB library, including providing:
+* A method for returning the processed contents of a named erb file
+  (ERB.process_file).  This makes it very easy to include one erb file
+  within another erb file.
+
+== PROBLEMS:
+None (known).
+
+== SYNOPSIS:
+======+examples/template_wrapper.erb+:
+ <%=
+    require 'rubygems'
+    require 'erbextensions'
+ 
+    $recipient = "Dr. Frankenstein"
+    $position  = "assistant"
+    $source    = "Mad Scientist Monthly"
+    $field     = "resurrection science"
+    $skill     = "restraining experimental subjects"
+ 
+    #
+    # This call would be much cleaner with the 'relative' gem:
+    # ERB::process_file(PathRelativeToCaller.new("template.erb"))
+    #
+    ERB::process_file(File.join(File.dirname(__FILE__), "template.erb"))
+ %>
+
+======+examples/template.erb+:
+ Dear <%= $recipient %>,
+   I am writing to be considered for the <%= $position %> position that
+ you recently advertised in <%= $source %>.  I possess a keen interest
+ in <%= $field %> and am eager to apply my deep skills in 
+ <%= $skill %>.  I have enclosed my resume for
+ your consideration.
+ 
+ Sincerely,
+ Igor
+
+The example consists of a cover letter that is templated on a few variables
+in order to adjust the letter's pitch to match the job being sought.
+After the template variables are initialized in +template_wrapper.erb+, an
+ERB.process_file call includes the expanded contents of +template.erb+.
+On the command line, run:
+ erb examples/template_wrapper.erb
+to produce:
+======The output of <code>erb examples/template_wrapper.erb</code>:
+ Dear Dr. Frankenstein,
+   I am writing to be considered for the assistant position that
+ you recently advertised in Mad Scientist Monthly.  I possess a keen interest
+ in resurrection science and am eager to apply my deep skills in 
+ restraining experimental subjects.  I have enclosed my resume for
+ your consideration.
+ 
+ Sincerely,
+ Igor
+
+== RECOMMENDED
+This gem best is used with the relative gem (http://relative.rubyforge.org).
+The relative gem upgrades the Ruby core and standard libraries to handle
+paths relative to source files, which makes referencing a file within an erb
+file much easier (see the comment in +examples/template_wrapper.erb+ for
+a demonstration)
+
+== REQUIREMENTS:
+Hoe is required but only for running the tests.
+
+== INSTALL:
+ sudo gem install erbextensions
+
+== AUTHORS:
+=== Designing Patterns
+* Homepage: http://www.designingpatterns.com
+* Blogs: http://blogs.designingpatterns.com
+
+== SUPPORT
+Please post questions, concerns, or requests for enhancement to the forums on
+the project page.  Alternatively, direct contact information for
+Designing Patterns can be found on the project page for this gem.
+
+== ENHANCEMENTS
+Please feel free to contact us with any ideas; we will try our best to
+enhance the software and respond to user requests.  Of course, we are more
+likely to work on a particular enhancement if we know that there are users
+who want it.  Designing Patterns provides contracting and consulting services,
+so if there is an enhancement that *must* get done (and in a specified time
+frame), please inquire about retaining our services!
+
+== LICENSE:
+The license text can be found in the +LICENSE+ file at the root of the
+distribution.
+
+This  package is licensed with an MIT license:
+
+Copyright (c) 2008 Designing Patterns
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== SHARE AND ENJOY!

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+$LOAD_PATH.unshift("lib")
+
+require 'rubygems'
+require 'hoe'
+
+$stderr = STDERR
+
+Hoe.new('erbextensions', "1.0.0") do |p|
+  p.remote_rdoc_dir = ''
+  p.developer('DesigningPatterns', 'technical.inquiries@designingpatterns.com')
+end
+
+# vim: syntax=Ruby

data/examples/template.erb

@@ -0,0 +1,9 @@
+Dear <%= $recipient %>,
+  I am writing to be considered for the <%= $position %> position that
+you recently advertised in <%= $source %>.  I possess a keen interest
+in <%= $field %> and am eager to apply my deep skills in 
+<%= $skill %>.  I have enclosed my resume for
+your consideration.
+
+Sincerely,
+Igor

data/examples/template_wrapper.erb

@@ -0,0 +1,16 @@
+<%=
+   require 'rubygems'
+   require 'erbextensions'
+
+   $recipient = "Dr. Frankenstein"
+   $position  = "assistant"
+   $source    = "Mad Scientist Monthly"
+   $field     = "resurrection science"
+   $skill     = "restraining experimental subjects"
+
+   #
+   # This call would be much cleaner with the 'relative' gem:
+   # ERB::process_file(PathRelativeToCaller.new("template.erb"))
+   #
+   ERB::process_file(File.join(File.dirname(__FILE__), "template.erb"))
+%>

data/lib/erbextensions.rb

@@ -0,0 +1,37 @@
+require 'erb'
+
+class ERB
+  # 
+  # ====Description:
+  # This method returns the contents of file_name, after expanding
+  # all embedded Ruby in the file with ERB.  This can be used to
+  # "include" an erb file from within another erb file.
+  # 
+  # ====Parameters:
+  # [file_name]
+  #      The name of the file to process
+  # 
+  # ====Returns:
+  # The contents of file_name, after expanding all embedded Ruby in the
+  # file with ERB.
+  # 
+  def self.process_file(file_name)
+    #
+    # ERB does not handle being invoked from within an ERB instance well.
+    # In order to make this work,
+    # 1.) Pass binding() into result(), in order that the new ERB
+    #     instance will create a local variable binding for 'erbout'
+    #     rather than using a top-level binding (which would lead to its
+    #     clearing any existing text already expanded by ancestor ERB
+    #     instances).  This also could be accomplished by using a
+    #     unique name instead of 'erbout' (something like Common LISP's
+    #     gensym).
+    # 2.) Set erb's filename member, so that paths relative to calling files
+    #     (the relative gem) will work properly; this also ensures that
+    #     stack trace looks reasonable.
+    #
+    erb = ERB.new(IO.read(file_name), nil, nil, 'erbout')
+    erb.filename = file_name
+    return erb.result(binding())
+  end
+end

data/test/test.erb

@@ -0,0 +1,9 @@
+Hello, world!
+
+<%=
+  require 'rubygems'
+  require 'erbextensions'
+  ERB::process_file(File.join(File.dirname(__FILE__), 'test2.erb'))
+%>
+
+Goodbye!

data/test/test2.erb

@@ -0,0 +1 @@
+<%= (0..10).map { |value| "#{value}" }.join(" ") %>

data/test/test_erbextensions.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'erbextensions'
+
+require 'test/unit'
+
+class ERBExtensionsTest < Test::Unit::TestCase
+  def test_process_file
+    expected_contents = ""
+    expected_contents << "Hello, world!\n\n"
+    expected_contents << "0 1 2 3 4 5 6 7 8 9 10\n\n\n"
+    expected_contents << "Goodbye!\n"
+
+    assert_equal(expected_contents,
+                 ERB::process_file(File.join(File.dirname(__FILE__), 'test.erb')))
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: erbextensions
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- DesigningPatterns
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-27 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+    version: 
+description: "This package enhances the Standard ERB library, including providing: * A method for returning the processed contents of a named erb file (ERB.process_file).  This makes it very easy to include one erb file within another erb file."
+email: 
+- technical.inquiries@designingpatterns.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- History.txt
+- README.txt
+files: 
+- Manifest.txt
+- LICENSE
+- History.txt
+- README.txt
+- Rakefile
+- examples/template.erb
+- examples/template_wrapper.erb
+- lib/erbextensions.rb
+- test/test_erbextensions.rb
+- test/test2.erb
+- test/test.erb
+has_rdoc: true
+homepage: "Project Page: http://rubyforge.org/projects/erbextensions/"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: erbextensions
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "This package enhances the Standard ERB library, including providing: * A method for returning the processed contents of a named erb file (ERB.process_file)"
+test_files: 
+- test/test_erbextensions.rb