trick_bag 0.41.0 → 0.42.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDVjMzY3ZGQ2ODZhM2MxOTZkMGQ2NmYyMWQ4NGIzMzQzYTFjZmQ2Mw==
+    OWFkZGQzZWE1N2RmY2RhNTNiZmMyZTMyODEzNWRlYjkzNTcwNDNmOA==
   data.tar.gz: !binary |-
-    YzNiNzBkMWVjMjVlZjI5NWFhZTRkMDQ4ODY0OTY1YjdhMGFhZGU5OQ==
+    MWVmNTRlYzRhOTA3MWY1YWZmNWYxN2EzM2FjZmVkZDM4OTNmYjQ5Zg==
 SHA512:
   metadata.gz: !binary |-
-    MjEyNzc0NjBiNGJlODYzY2ZkZGJhMjRiNGU2OWNkMzI0YjBhNjE3NjdjYTIy
-    ZjQwMjBlYTQwN2FjZDg4NTAyMzVmNWEyODJkOTY0OWZjYmZhYmMyYWJjYjc0
-    YjIxMzliZTczZjA5NDZlMTNkYjk3YjlkMDU4MTBlM2IzN2M1ZmM=
+    MTNjZjZlYzA3N2YyZDA1ZWNjODdiZWIwOThjNjk0MTkxMzljMDA4MGY1NTQ0
+    NjBjMWVlNDkwOGU3ZjkzODdhZTE1NTc2NzNmYzIyMGQ4ZWFlNjkxOGU4YmJh
+    NDIxZDk4NTUzNTAzZjc0MGEyNjhiOGMwYjJmY2Y5ZWZkMjFjOGY=
   data.tar.gz: !binary |-
-    MmI0NWNiMjM4MDkxMmI3MzBmMTdhODYwYTM4OGM5ZTJmYTBkOGVmMDczMDVi
-    YzJjNjBlYTM3NTViNjBmODFhNzg3NTY0ODg1MWUyYmQ5NTkxYjA5MWE2MzE3
-    Mjk5ZTVhYzU2MjY3YjUyNGFiMmU2MDlhMTNmNTRhOWIwNjRiZmM=
+    MGFhMDBjZWQ2MTVmNDIzYTY1YzY4ODE1ZjRiMzZlMWRmNWM2ZDg2OGQzMjgy
+    ZGRhYWUyNDE0MGU2YzYxZTkxZDZiNDAzMGM0NDM2ZjNlNDRkMjIzY2UwNzU0
+    OGIxODhmODA1MThkNzRiYjY0YWJkZWMwMmI3NTc3NDVmMDI1YmM=

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v0.42.0
+
+* Added ErbRenderer class, which functions as a bag of values for ERB rendering.
+
+
 ## v0.41.0
 
 *  Added Timing.benchmark().

data/lib/trick_bag/formatters/erb_renderer.rb

@@ -0,0 +1,38 @@
+module TrickBag
+
+# ERB requires a binding from which it gets its values for substituting
+# in its generated output. Often the current binding is used,
+# but this often exposes far more to the template than it needs, 
+# and can potentially expose the running program to security risks.
+#
+# Please see the unit tests for examples.
+#
+# This class functions as a bag of values that can be passed to ERB
+# for its substitutions. It subclasses OpenStruct, 
+# so it can be instantiated with a hash, and arbitrary new
+# setter methods can be called to add new values.
+#
+# In the template, these values can be accessed by their method/attribute names.
+#
+# The 'keys' method is added as a convenience, so that you can see the
+# names of the attributes in the 'bag'.  It is unfortunate the OpenStruct
+# doesn't have something like this already...or does it?
+#
+# A 'render' method is provided that calls ERB and passes the instance's binding, 
+# which will contain the attributes.
+
+# Render strategy taken from 
+# http://stackoverflow.com/questions/8954706/render-an-erb-template-with-values-from-a-hash
+class ErbRenderer < OpenStruct
+
+  def render(template)
+    ERB.new(template).result(binding)
+  end
+
+  # Useful for seeing what values are stored in the OpenStruct.
+  def keys
+    @table.keys.clone
+  end
+end
+
+end

data/lib/trick_bag/timing/timing.rb

@@ -52,13 +52,13 @@ module Timing
   # Returns the passed block's return value.
   #
   # e.g.   benchmark('time to loop 1,000,000 times') { 1_000_000.times { 42 }; 'hi' }
-  # outputs to the specified output stream the following string:
+  # outputs the following string:
   #   0.050000   0.000000   0.050000 (  0.042376): time to loop 1,000,000 times
   #  and returns: 42
   #
   # @param caption the text fragment to print after the timing data
   # @param out_stream object responding to << that will get the output string
-  #   @default $stdout
+  #   defaults to $stdout
   # @block the block to execute and benchmark
   def benchmark(caption, out_stream = $stdout, &block)
     return_value = nil

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = "0.41.0"
+  VERSION = "0.42.0"
 end

data/spec/trick_bag/formatters/erb_renderer_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../../spec_helper'
+
+require 'trick_bag/formatters/erb_renderer'
+
+module TrickBag
+
+describe ErbRenderer do
+
+  specify 'it can be instantiated with a hash' do
+    expect(TrickBag::ErbRenderer.new(color: 'blue').color).to eq('blue')
+  end
+
+  specify 'it can substitute a simple value' do
+    expect(TrickBag::ErbRenderer.new(x: 3).render("[<%= x %>]")).to eq('[3]')
+  end
+
+  specify 'the template cannot see local variables' do
+    x = 3
+    expect(TrickBag::ErbRenderer.new.render("<%= x %>")).to be_empty
+  end
+
+  specify 'the template cannot see instance variables of other classes' do
+    @x = 3
+    expect(TrickBag::ErbRenderer.new.render("<%= @x %>")).to be_empty
+  end
+
+  specify 'it works when a value is added after instantiation' do
+    renderer = ErbRenderer.new
+    renderer.fruit = 'mango'
+    expect(renderer.render("<%= fruit %>")).to eq('mango')
+  end
+
+end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.41.0
+  version: 0.42.0
 platform: ruby
 authors:
 - Keith Bennett
@@ -116,6 +116,7 @@ files:
 - lib/trick_bag/enumerables/endless_last_enumerable.rb
 - lib/trick_bag/enumerables/file_line_reader.rb
 - lib/trick_bag/enumerables/filtered_enumerable.rb
+- lib/trick_bag/formatters/erb_renderer.rb
 - lib/trick_bag/formatters/formatters.rb
 - lib/trick_bag/io/temp_files.rb
 - lib/trick_bag/io/text_mode_status_updater.rb
@@ -138,6 +139,7 @@ files:
 - spec/trick_bag/enumerables/endless_last_enumerable_spec.rb
 - spec/trick_bag/enumerables/file_line_reader_spec.rb
 - spec/trick_bag/enumerables/filtered_enumerable_spec.rb
+- spec/trick_bag/formatters/erb_renderer_spec.rb
 - spec/trick_bag/formatters/formatters_spec.rb
 - spec/trick_bag/io/temp_files_spec.rb
 - spec/trick_bag/io/text_mode_status_updater_spec.rb
@@ -185,6 +187,7 @@ test_files:
 - spec/trick_bag/enumerables/endless_last_enumerable_spec.rb
 - spec/trick_bag/enumerables/file_line_reader_spec.rb
 - spec/trick_bag/enumerables/filtered_enumerable_spec.rb
+- spec/trick_bag/formatters/erb_renderer_spec.rb
 - spec/trick_bag/formatters/formatters_spec.rb
 - spec/trick_bag/io/temp_files_spec.rb
 - spec/trick_bag/io/text_mode_status_updater_spec.rb