text-interpolator 1.0.3 → 1.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODdkZGQ4MzYzNThlNTM4ZjRjODA2MWRmOTM1NGQzZDEwMTQ0OTgxNg==
+    ODM0ODQ3YjQ2OTBkYjIyMjkxMzFkMGNhMGI1NmQ4Y2FhODIwNjdlYw==
   data.tar.gz: !binary |-
-    NjRiMTllODBjZWRlOTU4NjBjYWM2MWM5MWQ3NGVhZTJkNWQ5MjM1Ng==
+    NmQ4ZGRiZDAxZGQ1MDIwZmI3ZTA1NjE1ZjVhNmQ0NmZhZTlkMWU2NA==
 SHA512:
   metadata.gz: !binary |-
-    OWMxYWM1ZTczN2ZkMjE0MTY4MDk4YzRjMjhmYjIxOTMwZTBjODZhNzZlNjYx
-    NGYwNDg2NjJmM2QwMTNlMzNjYzdiMmJmNzU4NWExZTc1NWQ4NjE3NzExYjM4
-    ZTRhZjhlZGE0ZjgwOTU0ZTE0ODAxNDdkMGIzOWIwMDcwNjU4OTE=
+    YjYxZWFjZWM2OWZjNzhmZThkNTY5MmMzZjk2NzQ2MWUwYTc3ZmE0MjNjYmFi
+    ZWEzNGVhN2U3YWM2OTkyMmVlOGZlYjFjNzg1Y2Y1NzEzNTNiMTg2OTQ0NDVm
+    Njc0N2ZjMDIyMDkwNmVlOWNiYTExYWFmZjlmZDg2YWM3YjBlYWM=
   data.tar.gz: !binary |-
-    NzRkZDA1NmYzMTc0N2U4NjgyZDVmODBiNWYzYjVjZmNkMThjYmQ1MDdjMjgz
-    ZDU1MDcyZmVhN2JhMWNmYzdhMWNjMjdlMTFmZjdlNzMyYjgwZDk5YWE5NzJi
-    ZTZkZDkxMDBjYmFlNDI5MzA3MGQ2MGM5ZjViN2FlZDczMTI5MTg=
+    ZjkwNWViYTdjNjU1YWJiYmVhNjQzMjMyYmVlZmRmYzI1YzgwMzg2MGY4MGY0
+    NmRiN2VlNTA0OGQ5ZDY0MzU0OWMyMTQ0M2VmNGU1ZmUyNmZjYmYxYmQ5MWNh
+    NDdiNWZhYzgxNmRmOGJhODc5NmZlYmI4ZDNkNGUxODU3NWRlYmM=

data/CHANGES

@@ -14,4 +14,8 @@
 
 == Version 1.0.3
 
-* Bug fix.
+* Bug fix.
+
+== Version 1.0.4
+
+* Bug fix, writing documentation.

data/README.md

@@ -1,4 +1,75 @@
-text-interpolator
-=================
+# Text Interpolator - Simple library for interpolation of variables inside the text.
 
-Simple library for interpolation of variables inside the text.
+## Introduction
+
+You have few options in ruby for variables interpolation:
+
+- interpolation inside string:
+
+```ruby
+var1 = 'some value 1'
+var2 = 'some value 2'
+
+result = "We have var1: #{var1} and var2: #{var2}."
+
+puts result # We have var1: some value 1 and var2: some value 2.
+```
+
+- interpolation inside file (with embedded ruby -  erb):
+
+```ruby
+# some_template.erb
+
+We have var1: <%= var1 %> and var2:  <%= var2%>.
+
+# test.rb
+
+require 'erb'
+
+var1 = 'some value 1'
+var2 = 'some value 2'
+
+template = ERB.new(File.read("some_template.erb"))
+
+result = template.result(binding)
+
+puts result # We have var1: some value 1 and var2: some value 2.
+```
+
+This library can be used for interpolation inside file with string syntax.
+
+In order to achieve it uses this ruby trick:
+
+```ruby
+env = {var1: 'some value 1', var2: 'some value 2'}
+
+template = "We have var1: %{var1} and var2: %{var2}."
+
+result = template % env
+
+puts result # We have var1: some value 1 and var2: some value 2.
+```
+
+## Usage
+
+It's straightforward:
+
+```ruby
+# some_template.txt
+
+We have var1: #{var1} and var2:  #{var2}.
+
+# test.rb
+
+require 'text_interpolator'
+
+env ={var1: 'some value 1', var2: 'some value 2'}
+
+template = File.read("some_template.txt")
+
+text_interpolator = TextInterpolator.new
+
+result = text_interpolator.interpolate template, env
+
+puts result # We have var1: some value 1 and var2: some value 2.
+```

data/lib/text_interpolator/text_interpolator.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+
 class TextInterpolator
 
   def interpolate object, env={}

data/lib/text_interpolator/version.rb

@@ -1,3 +1,3 @@
 class TextInterpolator
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text-interpolator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemspec_deps_gen