bosh_common 0.5.0 → 0.5.1

data/lib/common/properties/errors.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Common
+
+  class TemplateEvaluationFailed < StandardError; end
+
+  class UnknownProperty < StandardError
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      super("Can't find property `#{name}'")
+    end
+  end
+
+end

data/lib/common/properties/property_helper.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Common
+  module PropertyHelper
+    # Copies property with a given name from src to dst.
+    # @param [Hash] dst Property destination
+    # @param [Hash] src Property source
+    # @param [String] name Property name (dot-separated)
+    # @param [Object] default Default value (if property is not in src)
+    def copy_property(dst, src, name, default = nil)
+      keys = name.split(".")
+      src_ref = src
+      dst_ref = dst
+
+      keys.each do |key|
+        src_ref = src_ref[key]
+        break if src_ref.nil? # no property with this name is src
+      end
+
+      keys[0..-2].each do |key|
+        dst_ref[key] ||= {}
+        dst_ref = dst_ref[key]
+      end
+
+      dst_ref[keys[-1]] ||= {}
+      dst_ref[keys[-1]] = src_ref || default
+    end
+
+    # @param [Hash] collection Property collection
+    # @param [String] name Dot-separated property name
+    def lookup_property(collection, name)
+      keys = name.split(".")
+      ref = collection
+
+      keys.each do |key|
+        ref = ref[key]
+        return nil if ref.nil?
+      end
+
+      ref
+    end
+  end
+end

data/lib/common/properties/template_evaluation_context.rb

@@ -0,0 +1,86 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh::Common
+  # Helper class to evaluate templates. Used by Director, CLI and Agent.
+  class TemplateEvaluationContext
+    include PropertyHelper
+
+    # @return [String] Template name
+    attr_reader :name
+
+    # @return [Integer] Template instance index
+    attr_reader :index
+
+    # @return [Hash] Template properties
+    attr_reader :properties
+
+    # @return [Hash] Template spec
+    attr_reader :spec
+
+    # @param [Hash] spec Template spec
+    def initialize(spec)
+      unless spec.is_a?(Hash)
+        raise TemplateEvaluationFailed,
+              "Invalid spec provided for template evaluation context, " +
+              "Hash expected, #{spec.class} given"
+      end
+
+      if spec["job"].is_a?(Hash)
+        @name = spec["job"]["name"]
+      else
+        @name = nil
+      end
+
+      @index = spec["index"]
+      @spec = openstruct(spec)
+      @raw_properties = spec["properties"] || {}
+      @properties = openstruct(@raw_properties)
+    end
+
+    # @return [Binding] Template binding
+    def get_binding
+      binding.taint
+    end
+
+    # Property lookup helper
+    # @param [String] name Property name
+    # @param [optional, Object] default Default value
+    # @return [Object] Property value
+    def p(name, default = nil)
+      result = lookup_property(@raw_properties, name)
+      if result.nil?
+        return default if default
+        raise UnknownProperty.new(name)
+      end
+      result
+    end
+
+    # Run a block of code if all given properties are defined
+    # @param [Array<String>] names Property names
+    # @yield [Object] property values
+    def if_p(*names)
+      values = names.map do |name|
+        value = lookup_property(@raw_properties, name)
+        return if value.nil?
+        value
+      end
+
+      yield *values
+    end
+
+    # @return [Object] Object representation where all hashes are unrolled
+    #   into OpenStruct objects. This exists mostly for backward
+    #   compatibility, as it doesn't provide good error reporting.
+    def openstruct(object)
+      case object
+        when Hash
+          mapped = object.inject({}) { |h, (k,v)| h[k] = openstruct(v); h }
+          OpenStruct.new(mapped)
+        when Array
+          object.map { |item| openstruct(item) }
+        else
+          object
+      end
+    end
+  end
+end

data/lib/common/properties.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+require "ostruct"
+require "common/properties/errors"
+require "common/properties/property_helper"
+require "common/properties/template_evaluation_context"

data/lib/common/version.rb

@@ -2,6 +2,6 @@
 
 module Bosh
   module Common
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
   end
 end

data/spec/unit/properties/property_helper_spec.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2012 VMware, Inc.
+
+require "spec_helper"
+require "common/properties"
+
+describe Bosh::Common::PropertyHelper do
+
+  before(:each) do
+    @helper = Object.new
+    @helper.extend(Bosh::Common::PropertyHelper)
+  end
+
+  it "can copy named property from one collection to another" do
+    dst = {}
+    src = {"foo" => {"bar" => "baz", "secret" => "zazzle"}}
+
+    @helper.copy_property(dst, src, "foo.bar")
+    dst.should == {"foo" => {"bar" => "baz"}}
+
+    @helper.copy_property(dst, src, "no.such.prop", "default")
+    dst.should == {
+      "foo" => {"bar" => "baz"},
+      "no" => {
+        "such" => {"prop" => "default"}
+      }
+    }
+  end
+
+  it "can lookup the property in a Hash using dot-syntax" do
+    properties = {
+      "foo" => {"bar" => "baz"},
+      "router" => {"token" => "foo"}
+    }
+
+    @helper.lookup_property(properties, "foo.bar").should == "baz"
+    @helper.lookup_property(properties, "router").should == {"token" => "foo"}
+    @helper.lookup_property(properties, "no.prop").should be_nil
+  end
+end

data/spec/unit/properties/template_evaluation_context_spec.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2012 VMware, Inc.
+
+require "spec_helper"
+require "common/properties"
+
+describe Bosh::Common::TemplateEvaluationContext do
+
+  def eval_template(erb, context)
+    ERB.new(erb).result(context.get_binding)
+  end
+
+  def make(spec)
+    Bosh::Common::TemplateEvaluationContext.new(spec)
+  end
+
+  before(:each) do
+    @spec = {
+      "job" => {
+        "name" => "foobar"
+      },
+      "properties" => {
+        "foo" => "bar",
+        "router" => {"token" => "zbb"}
+      },
+      "index" => 0,
+    }
+
+    @context = make(@spec)
+  end
+
+  it "unrolls properties into OpenStruct" do
+    eval_template("<%= properties.foo %>", @context).should == "bar"
+  end
+
+  it "supports looking up template index" do
+    eval_template("<%= spec.index %>", @context).should == "0"
+  end
+
+  it "supports 'p' helper" do
+    eval_template("<%= p('router.token') %>", @context).should == "zbb"
+    expect {
+      eval_template("<%= p('bar.baz') %>", @context)
+    }.to raise_error(Bosh::Common::UnknownProperty)
+
+    eval_template("<%= p('bar.baz', 22) %>", @context).should == "22"
+  end
+
+  it "supports 'if_p' helper" do
+    template = <<-TMPL
+      <% if_p("router.token") do |token| %>
+      <%= token %>
+      <% end %>
+    TMPL
+
+    eval_template(template, @context).strip.should == "zbb"
+
+    template = <<-TMPL
+      <% if_p("router.token", "foo") do |token, foo| %>
+      <%= token %>, <%= foo %>
+      <% end %>
+    TMPL
+
+    eval_template(template, @context).strip.should == "zbb, bar"
+
+    template = <<-TMPL
+      <% if_p("router.token", "no.such.prop") do |token, none| %>
+      test output
+      <% end %>
+    TMPL
+
+    eval_template(template, @context).strip.should == ""
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bosh_common
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies: []
 description: BOSH common
 email: support@vmware.com
@@ -21,6 +21,10 @@ files:
 - lib/common/exec.rb
 - lib/common/exec/error.rb
 - lib/common/exec/result.rb
+- lib/common/properties.rb
+- lib/common/properties/errors.rb
+- lib/common/properties/property_helper.rb
+- lib/common/properties/template_evaluation_context.rb
 - lib/common/thread_formatter.rb
 - lib/common/thread_pool.rb
 - lib/common/version.rb
@@ -31,6 +35,8 @@ files:
 - spec/spec_helper.rb
 - spec/unit/common_spec.rb
 - spec/unit/exec_spec.rb
+- spec/unit/properties/property_helper_spec.rb
+- spec/unit/properties/template_evaluation_context_spec.rb
 - spec/unit/thread_pool_spec.rb
 homepage: http://www.vmware.com
 licenses: []
@@ -46,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 852108980354805257
+      hash: -411355085407901587
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -55,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 852108980354805257
+      hash: -411355085407901587
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -68,5 +74,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/common_spec.rb
 - spec/unit/exec_spec.rb
+- spec/unit/properties/property_helper_spec.rb
+- spec/unit/properties/template_evaluation_context_spec.rb
 - spec/unit/thread_pool_spec.rb
 has_rdoc: