Merge pull request #707 from cloudfoundry/add-ruby-workflow

Add Ruby workflow for embedded ruby code

Author: beyhan

.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Run Specs
+on: [push, pull_request]
+
+jobs:
+  test_embedded_ruby:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [ '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4', head]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+        working-directory: templatescompiler/erbrenderer/
+      - run: bundle exec rake
+        working-directory: templatescompiler/erbrenderer/
+        continue-on-error: ${{ matrix.ruby == 'head' }}

templatescompiler/erbrenderer/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

templatescompiler/erbrenderer/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+group :test do
+  gem "rake"
+  gem "rspec"
+  gem "standardrb"
+end

templatescompiler/erbrenderer/Rakefile

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:standard, :spec]

templatescompiler/erbrenderer/erb_renderer.rb

@@ -7,8 +7,8 @@
 
 class Hash
   def recursive_merge!(other)
-    self.merge!(other) do |_, old_value, new_value|
-      if old_value.class == Hash && new_value.class == Hash
+    merge!(other) do |_, old_value, new_value|
+      if old_value.class == Hash && new_value.class == Hash # rubocop:disable Style/ClassEqualityComparison
         old_value.recursive_merge!(new_value)
       else
         new_value
@@ -27,14 +27,14 @@ def initialize(spec)
     @name = spec["job"]["name"] if spec["job"].is_a?(Hash)
     @index = spec["index"]
 
-    if !spec['job_properties'].nil?
-      properties1 = spec['job_properties']
+    properties1 = if !spec["job_properties"].nil?
+      spec["job_properties"]
     else
-      properties1 = spec['global_properties'].recursive_merge!(spec['cluster_properties'])
+      spec["global_properties"].recursive_merge!(spec["cluster_properties"])
     end
 
     properties = {}
-    spec['default_properties'].each do |name, value|
+    spec["default_properties"].each do |name, value|
       copy_property(properties, properties1, name, value)
     end
 
@@ -66,7 +66,7 @@ def if_p(*names)
       value
     end
 
-    yield *values
+    yield(*values)
     InactiveElseBlock.new
   end
 
@@ -97,13 +97,15 @@ def copy_property(dst, src, name, default = nil)
 
   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
+    when Hash
+      mapped = object.each_with_object({}) { |(k, v), h|
+        h[k] = openstruct(v)
+      }
+      OpenStruct.new(mapped)
+    when Array
+      object.map { |item| openstruct(item) }
+    else
+      object
     end
   end
 
@@ -137,13 +139,14 @@ def else
       yield
     end
 
-    def else_if_p(*names, &block)
-      @context.if_p(*names, &block)
+    def else_if_p(*names, &block) # rubocop:disable Style/ArgumentsForwarding
+      @context.if_p(*names, &block) # rubocop:disable Style/ArgumentsForwarding
     end
   end
 
   class InactiveElseBlock
-    def else; end
+    def else
+    end
 
     def else_if_p(*names)
       InactiveElseBlock.new
@@ -153,7 +156,7 @@ def else_if_p(*names)
 
 # todo do not use JSON in releases
 class << JSON
-  alias dump_array_or_hash dump
+  alias_method :dump_array_or_hash, :dump
 
   def dump(*args)
     arg = args[0]
@@ -174,18 +177,16 @@ def render(src_path, dst_path)
     erb = ERB.new(File.read(src_path), trim_mode: "-")
     erb.filename = src_path
 
-    context_hash = JSON.load(File.read(@json_context_path))
+    # Note: JSON.load_file was added in v2.3.1: https://github.com/ruby/json/blob/v2.3.1/lib/json/common.rb#L286
+    context_hash = JSON.parse(File.read(@json_context_path))
     template_evaluation_context = TemplateEvaluationContext.new(context_hash)
 
-    File.open(dst_path, "w") do |f|
-      f.write(erb.result(template_evaluation_context.get_binding))
-    end
-
-  rescue Exception => e
+    File.write(dst_path, erb.result(template_evaluation_context.get_binding))
+  rescue Exception => e # rubocop:disable Lint/RescueException
     name = "#{template_evaluation_context&.name}/#{template_evaluation_context&.index}"
 
-    line_i = e.backtrace.index { |l| l.include?("#{erb&.filename}") }
-    line_num = line_i ? e.backtrace[line_i].split(':')[1] : "unknown"
+    line_i = e.backtrace.index { |l| l.include?(erb&.filename.to_s) }
+    line_num = line_i ? e.backtrace[line_i].split(":")[1] : "unknown"
     location = "(line #{line_num}: #{e.inspect})"
 
     raise("Error filling in template '#{src_path}' for #{name} #{location}")

templatescompiler/erbrenderer/spec/erb_renderer_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+require "erb_renderer"
+
+RSpec.describe "erb_renderer" do
+  describe "ERBRenderer" do
+    let(:test_tmpdir) { Dir.tmpdir }
+    let(:json_context_path) { File.join(test_tmpdir, "context.json") }
+
+    before do
+      File.write(json_context_path, context_hash.to_json)
+    end
+
+    after do
+      File.unlink(json_context_path) if File.exist?(json_context_path)
+    end
+
+    describe "#initialize" do
+      let(:context_hash) { {} }
+
+      it "does not raise an error" do
+        expect { ERBRenderer.new(json_context_path) }.not_to raise_error
+      end
+    end
+
+    describe "#render" do
+      let(:context_hash) do
+        {
+          index: 867_5309,
+          global_properties: {
+            property1: "global_value1"
+          },
+          cluster_properties: {
+            property2: "cluster_value1"
+          },
+          default_properties: {
+            property1: "default_value1",
+            property2: "default_value2",
+            property3: "default_value3"
+          }
+        }
+      end
+
+      let(:erb_template_path) { File.join(test_tmpdir, "template.yml.erb") }
+      let(:erb_content) do
+        <<~TEST_TEMPLATE
+          ---
+          property1: <%= p('property1') %>
+          property2: <%= p('property2') %>
+          property3: <%= p('property3') %>
+        TEST_TEMPLATE
+      end
+
+      let(:rendered_template_path) { File.join(test_tmpdir, "template.yml") }
+      let(:expected_template_content) do
+        <<~EXPECTED_TEMPLATE
+          ---
+          property1: global_value1
+          property2: cluster_value1
+          property3: default_value3
+        EXPECTED_TEMPLATE
+      end
+
+      let(:erb_renderer) { ERBRenderer.new(json_context_path) }
+
+      before do
+        File.write(erb_template_path, erb_content)
+      end
+
+      it "does not raise an error" do
+        expect { erb_renderer.render(erb_template_path, rendered_template_path) }.not_to raise_error
+      end
+
+      it "renders the expected content" do
+        erb_renderer.render(erb_template_path, rendered_template_path)
+        expect(File.read(rendered_template_path)).to eq(expected_template_content)
+      end
+    end
+  end
+end

templatescompiler/erbrenderer/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec"
+require "json"
+require "tmpdir"
+
+ERB_RENDERER_ROOT = File.expand_path("..", File.dirname(__FILE__))
+
+$LOAD_PATH.unshift(ERB_RENDERER_ROOT)