text-interpolator 1.0.5 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjVjNjkyZGJhOTY1MWYwMTNhYzc0NzkyNzQzODE4YTBlZDlhY2IxMQ==
+    MGI1Y2YyNjFlYzEwZDEzNTJiMDhjNDNiNGJjNzBkYjI5N2M3OGVjYQ==
   data.tar.gz: !binary |-
-    NmI4OTA5MDAxOGNjYTQ2ZjVkYjY4ZWJhM2NkZGRkMTdlNzllY2U2Mw==
+    YzgyYzU5Zjc4MDQzZWFkZjBkYTUxZGNmZTExZmM5YjU2MjJjOGE3Mw==
 SHA512:
   metadata.gz: !binary |-
-    OTI4NWQxNzkxYzE1NjRiOTgzOTZkNDU1ZDQ2MDlkMmNjZTZhZjhjMDhmODRh
-    NDkzOTE4NWY3MDcxYjgxYThiZTJmNGY1ZDAyOGMxZjFkZGFhZDhjZmMzNThj
-    MmVhZDY3MGQ3MDdlNjNkYTRmOTM1MTg2N2IwZTNkMjJhZDQ2YWE=
+    MzU2YjQ5MGQ2YWY4MWU2NTY3ZDg4ZWM4OTQ3MjUwZGRhMDc4ODE2ZGQwZGQ0
+    YzY0Y2ZmNTc0ZmU4YTg1MjI2NzhmOTMyMDFkM2QyZDE5YTYyZGI2YWE5ZmQz
+    NmQ2ZmVhOTQwMGU4NjE3NzIxZmIzYTNjYzc1MTE2N2E3ODY1N2Q=
   data.tar.gz: !binary |-
-    NTBhNGExODJkMDZjNjc3MDM2NWFjMjkxYmM4Njg0NGQzNjZkNTVmYjNlZTVk
-    ZjBiYjE4YjhkMWMyMDNhNDcyNjk0NTU3YzE3YTIxZjc3YzEzZDY2ZGU4NGI3
-    NWY4ZTUyN2RlYzhjNjc3OWFhYmU1NDcyOTgxYTI0ODQ2YTQ3Njg=
+    ZGU0YzEyNTFhNmJmMzQxYWI0NTUzZmI1MzA0ZWJlOGZhMjBjNGMxOWE3MTBm
+    ODA1MDE0ZDI1ZTU0MGVkMTM2OGU3YmE4ZjE1NmEwOGFkYjkxMmI3NzQ0NDMy
+    YjQ0N2U2MjIzYzM2ZmI1ZGQ2ZjZkOGViOTFlOTQyMzNkNjdiOWQ=

data/.idea/codeStyleSettings.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectCodeStyleSettingsManager">
+    <option name="PER_PROJECT_SETTINGS">
+      <value>
+        <XML>
+          <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" />
+        </XML>
+      </value>
+    </option>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="alex" />
+  </component>
+</project>
+

data/CHANGES

@@ -22,4 +22,8 @@
 
 == Version 1.0.5
 
-* Bug fix.
+* Bug fix.
+
+== Version 1.1.0
+
+* Adding qualified variable names.

data/README.md

@@ -4,7 +4,7 @@
 
 You have few options in ruby for variables interpolation:
 
-- interpolation inside string:
+- interpolation inside the string:
 
 ```ruby
 var1 = 'some value 1'
@@ -36,9 +36,9 @@ 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.
+This library can be used for **interpolation inside file with string syntax**.
 
-In order to achieve it uses this ruby trick:
+In order to achieve it library uses this ruby trick:
 
 ```ruby
 env = {var1: 'some value 1', var2: 'some value 2'}
@@ -58,12 +58,20 @@ It's straightforward:
 # some_template.txt
 
 We have var1: #{var1} and var2:  #{var2}.
+We have var3: #{settings.var3} and var4:  #{settings.var4}.
 
 # test.rb
 
 require 'text_interpolator'
 
-env ={var1: 'some value 1', var2: 'some value 2'}
+env = {
+  var1: 'some value 1',
+  var2: 'some value 2',
+  settings: {
+    var3: 'some value 3',
+    var4: 'some value 4'
+  }
+}
 
 template = File.read("some_template.txt")
 
@@ -72,4 +80,5 @@ text_interpolator = TextInterpolator.new
 result = text_interpolator.interpolate template, env
 
 puts result # We have var1: some value 1 and var2: some value 2.
+            # We have var3: some value 3 and var4: some value 4.
 ```

data/lib/text_interpolator/hash_processor.rb

@@ -0,0 +1,125 @@
+require 'singleton'
+
+class HashProcessor
+  include Singleton
+
+  def process hash
+    errors = {}
+
+    content = interpolate_system_variables(hash)
+
+    var_table = build_variables_table(content)  # one-dimensional collection of variables
+
+    result = interpolate_variables(content, var_table, errors)
+
+    [result, errors]
+  end
+
+  private
+
+  def interpolate_system_variables hash
+    content = {}
+
+    hash.each do |key, value|
+      if value.kind_of? String
+        new_value = interpolate_system_variable value
+
+        content[key] = new_value if new_value
+      elsif value.kind_of? Hash
+        content[key] = interpolate_system_variables value
+      else
+        content[key] = value
+      end
+    end
+
+    content
+  end
+
+  def interpolate_system_variable value
+    new_value = value
+
+    while new_value.index('ENV[')
+      index1 = new_value.index("ENV[")
+      index2 = new_value.index("]")
+
+      name = new_value[index1+5..index2-2]
+
+      left = (index1 == 0) ? '' : new_value[0..index1-1]
+      right = new_value[index2+1..-1]
+
+      new_value = left + ENV[name] + right
+    end
+
+    new_value
+  end
+
+  def build_variables_table content
+    var_table = {}
+
+    content.each do |key, value|
+      build_variable(var_table, key, key, value)
+    end
+
+    var_table
+  end
+
+  def build_variable(var_table, compound_key, key, value)
+    if value.kind_of? String
+      var_table[key] = value
+    elsif value.kind_of? Hash
+      build_hash var_table, compound_key, value
+    end
+  end
+
+  def build_hash var_table, compound_key, hash
+    hash.each do |key, value|
+      new_compound_key = "#{compound_key}.#{key}"
+
+      if value.kind_of? Hash
+        build_variable(var_table, new_compound_key, key, value)
+      else
+        var_table[new_compound_key.to_sym] = value
+      end
+    end
+  end
+
+  def interpolate_variables content, env, errors
+    hash = {}
+
+    begin
+      substitutions = false
+
+      content.each do |key, value|
+        new_value = value
+        substitutions = false
+
+        if value.kind_of? String
+          if value.index(/\#\{/)
+            substitutions = true
+
+            new_value = value.gsub(/\#{/, '%{')
+
+            begin
+              new_value = StringIO.new(new_value).read % env
+            rescue KeyError => e
+              substitutions = false
+
+              errors << e.message
+            end
+          end
+        elsif value.kind_of? Hash
+          new_value = interpolate_variables value, env, errors
+        end
+
+        if hash[key] == new_value
+          substitutions = false
+        else
+          hash[key] = new_value
+        end
+      end
+    end while substitutions
+
+    hash
+  end
+
+end

data/lib/text_interpolator/text_interpolator.rb

@@ -1,7 +1,10 @@
 require 'stringio'
+require 'text_interpolator/hash_processor'
 
 class TextInterpolator
 
+  attr_reader :errors
+
   def interpolate object, env={}
     if object.kind_of? String
       interpolate_string object, env
@@ -33,59 +36,9 @@ class TextInterpolator
   end
 
   def interpolate_hash hash
-    hash.each do |key, value|
-      new_value = interpolate_env_vars value
-
-      hash[key] = new_value if new_value
-    end
-
-    env = hash.reduce({}) do |result, value|
-      result[value[0]] = value[1]
-
-      result
-    end
+    result, @errors = *HashProcessor.instance.process(hash)
 
-    begin
-      substitutions = false
-
-      hash.each do |key, value|
-        if value.kind_of? String
-          if value.index(/\#\{/)
-            substitutions = true
-
-            value = value.gsub(/\#{/, '%{')
-
-            hash[key] = StringIO.new(value).read % env
-          end
-        end
-      end
-    end while substitutions
-
-    hash
-  end
-
-  private
-
-  def interpolate_env_vars value
-    if value.kind_of? String
-      while value.index('ENV[')
-        value = interpolate_env_var value
-      end
-    end
-
-    value
-  end
-
-  def interpolate_env_var value
-    index1 = value.index("ENV[")
-    index2 = value.index("]")
-
-    name = value[index1+5..index2-2]
-
-    left = (index1 == 0) ? '' : value[0..index1-1]
-    right = value[index2+1..-1]
-
-    left + ENV[name] + right
+    result
   end
 
 end

data/lib/text_interpolator/version.rb

@@ -1,3 +1,3 @@
 class TextInterpolator
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/spec/text_interpolator_spec.rb

@@ -1,6 +1,5 @@
 require File.expand_path('spec_helper', File.dirname(__FILE__))
 
-require 'json'
 require 'text_interpolator'
 
 describe TextInterpolator do
@@ -52,21 +51,15 @@ describe TextInterpolator do
   end
 
   describe "#interpolate_hash" do
-    it "interpolates hash" do
-      config =
-        '{' +
-        '"user": "ENV[\'USER\']",' +
-
-        '"oracle_base": "/usr/local/oracle",' +
-        '"oracle_version": "11.2.0.4.0",'+
-
-        '"src_dir": "#{user}/downloads",' +
-        '"dest_dir": "#{oracle_base}/instantclient_11_2",' +
-
-        '"basic_zip": "#{src_dir}/instantclient-basic-macos.x64-#{oracle_version}.zip"' +
-        '}'
-
-      hash = JSON.parse(config, :symbolize_names => true)
+    it "interpolates simple hash" do
+      hash = {
+        user: ENV['USER'],
+        oracle_base: '/usr/local/oracle',
+        oracle_version: '11.2.0.4.0',
+        src_dir: '#{user}/downloads',
+        dest_dir: '#{oracle_base}/instantclient_11_2',
+        basic_zip: '#{src_dir}/instantclient-basic-macos.x64-#{oracle_version}.zip'
+      }
 
       result = subject.interpolate_hash hash
 
@@ -75,5 +68,39 @@ describe TextInterpolator do
       expect(result[:dest_dir]).to eq '/usr/local/oracle/instantclient_11_2'
       expect(result[:basic_zip]).to eq ENV['USER'] + '/downloads/instantclient-basic-macos.x64-11.2.0.4.0.zip'
     end
+
+    it "interpolates multi-level hash" do
+      hash = {
+        host: 'localhost',
+        user: ENV['USER'],
+        home: ENV['HOME'],
+
+        credentials: {
+          user: "some_user",
+          password: "some_password",
+
+          settings: {
+            user: "some_user2"
+          }
+        },
+
+        postgres: {
+          hostname: '#{host}',
+          user: '#{credentials.user}',
+          password: 'postgres'
+        },
+
+        mysql: {
+          user: '#{credentials.settings.user}',
+        }
+      }
+
+      result = subject.interpolate_hash hash
+
+      expect(result[:postgres][:user]).to eq hash[:credentials][:user]
+      expect(result[:mysql][:user]).to eq hash[:credentials][:settings][:user]
+
+      expect(subject.errors).to be_empty
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text-interpolator
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-03 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemspec_deps_gen
@@ -45,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .idea/codeStyleSettings.xml
 - .ruby-gemset
 - .ruby-version
 - CHANGES
@@ -53,6 +54,7 @@ files:
 - README.md
 - Rakefile
 - lib/text_interpolator.rb
+- lib/text_interpolator/hash_processor.rb
 - lib/text_interpolator/text_interpolator.rb
 - lib/text_interpolator/version.rb
 - spec/spec_helper.rb