tfdsl 0.1.11 → 0.2.0

data/lib/terraform_dsl/resource.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  class Resource < Block
+    KEYWORD = 'resource'
+  end
+end

data/lib/terraform_dsl/stack.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  # A collection of top level terraform blocks, rendered as one .tf file.
+  class Stack
+    BLOCKS = {
+      terraform: Terraform, provider: Provider, variable: Variable, locals: Locals,
+      tfmodule: TFModule, datasource: DataSource, resource: Resource, output: Output,
+      moved: Moved, import: Import, removed: Removed, check: Check,
+      ephemeral: Ephemeral, action: Action
+    }.freeze
+
+    def initialize(&block)
+      @objects = []
+      instance_eval(&block) if block
+    end
+
+    BLOCKS.each do |name, cls|
+      define_method(name) do |type = nil, *labels, &block|
+        @objects << cls.new(type, *labels, &block)
+        @objects.last
+      end
+    end
+    alias data datasource
+
+    def to_s
+      @objects.map(&:to_tf).join("\n")
+    end
+
+    def to_h
+      @objects.each_with_object({}) do |block, hash|
+        JsonSyntax.insert(hash, [block.class::KEYWORD, block.__type__, *block.__labels__].compact, block.to_h)
+      end
+    end
+
+    def to_json(*)
+      JSON.pretty_generate(to_h)
+    end
+  end
+end

data/lib/terraform_dsl/template.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  # Renders Ruby values as HCL values.
+  #
+  #   String  -> "quoted"  (heredoc when it ends with a newline)
+  #   Symbol  -> raw expression, e.g. :'aws_vpc.main.id' or :string
+  #   Numeric, true, false -> as is
+  #   nil     -> null
+  #   Array   -> [ ... ]
+  #   Hash    -> { key = value }
+  module Template
+    module_function
+
+    IDENTIFIER = /\A[A-Za-z_][\w-]*\z/.freeze
+    ESCAPES = { '"' => '\"', '\\' => '\\\\', "\n" => '\n', "\r" => '\r', "\t" => '\t' }.freeze
+
+    def value(value, depth = 0)
+      case value
+      when Hash then map(value, depth)
+      when Array then list(value, depth)
+      when String then string(value, depth)
+      when nil then 'null'
+      else value.to_s # Symbol (raw expression), Numeric, true, false
+      end
+    end
+
+    def string(str, depth = 0)
+      return heredoc(str, depth) if str.end_with?("\n")
+
+      %("#{str.gsub(/["\\\n\r\t]/, ESCAPES)}")
+    end
+
+    def heredoc(str, depth)
+      pad = INDENT * depth
+      "<<-EOT\n#{str.gsub(/^(?!$)/, pad + INDENT)}#{pad}EOT"
+    end
+
+    def list(array, depth)
+      return '[]' if array.empty?
+
+      pad = INDENT * depth
+      items = array.map { |v| "#{pad}#{INDENT}#{value(v, depth + 1)}" }
+      "[\n#{items.join(",\n")}\n#{pad}]"
+    end
+
+    def map(hash, depth)
+      return '{}' if hash.empty?
+
+      pad = INDENT * depth
+      items = hash.map { |k, v| [key(k), value(v, depth + 1)] }
+      "{\n#{assignments(items, pad + INDENT).join("\n")}\n#{pad}}"
+    end
+
+    # Renders [name, value] pairs as "name = value" lines, aligning the equals
+    # signs the way terraform fmt does: consecutive single-line values share a
+    # column, a multi-line value ({ or [) breaks the run and is not aligned.
+    def assignments(pairs, pad)
+      pairs.slice_when { |a, b| multiline?(a[1]) || multiline?(b[1]) }.flat_map do |run|
+        width = run.map { |name, _| name.size }.max
+        run.map { |name, value| "#{pad}#{name.ljust(width)} = #{value}" }
+      end
+    end
+
+    def multiline?(value)
+      value.start_with?("{\n", "[\n")
+    end
+
+    def key(key)
+      key = key.to_s
+      key.match?(IDENTIFIER) ? key : string(key)
+    end
+  end
+end

data/lib/terraform_dsl/terraform.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  class Terraform < Block
+    KEYWORD = 'terraform'
+  end
+end

data/lib/terraform_dsl/tfmodule.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  class TFModule < Block
+    KEYWORD = 'module'
+  end
+end

data/lib/terraform_dsl/variable.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  class Variable < Block
+    KEYWORD = 'variable'
+    STATIC_REFS = (Block::STATIC_REFS + %w[type]).freeze
+  end
+end

data/lib/terraform_dsl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TerraformDSL
+  VERSION = '0.2.0'
+end

data/lib/terraform_dsl.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'terraform_dsl/version'
+
+# A Chef like DSL that renders Terraform (HCL) configuration.
+module TerraformDSL
+  INDENT = '  '
+
+  require_relative 'terraform_dsl/template'
+  require_relative 'terraform_dsl/json_syntax'
+  require_relative 'terraform_dsl/formatter'
+  require_relative 'terraform_dsl/block'
+  require_relative 'terraform_dsl/terraform'
+  require_relative 'terraform_dsl/provider'
+  require_relative 'terraform_dsl/variable'
+  require_relative 'terraform_dsl/locals'
+  require_relative 'terraform_dsl/tfmodule'
+  require_relative 'terraform_dsl/data_source'
+  require_relative 'terraform_dsl/resource'
+  require_relative 'terraform_dsl/output'
+  require_relative 'terraform_dsl/moved'
+  require_relative 'terraform_dsl/import'
+  require_relative 'terraform_dsl/removed'
+  require_relative 'terraform_dsl/check'
+  require_relative 'terraform_dsl/ephemeral'
+  require_relative 'terraform_dsl/action'
+  require_relative 'terraform_dsl/stack'
+
+  # Shortcut for Stack.new
+  def self.stack(&block)
+    Stack.new(&block)
+  end
+end

data/lib/tfdsl.rb

@@ -1,31 +1,7 @@
-require 'tfdsl/version'
-require 'yaml'
-require 'erb'
+# frozen_string_literal: true
 
-# Terraform DSL
-module TFDSL
-  module_function
+# Entry point for the tfdsl gem. TFDSL is kept as an alias for code written
+# against tfdsl 0.1.x.
+require_relative 'terraform_dsl'
 
-  LIB_DIR = "#{__dir__}/tfdsl/".freeze
-
-  require "#{LIB_DIR}/template"
-  require "#{LIB_DIR}/data_formatter"
-  require "#{LIB_DIR}/kind_translator"
-  require "#{LIB_DIR}/formatter"
-  require "#{LIB_DIR}/block"
-  require "#{LIB_DIR}/resource"
-  require "#{LIB_DIR}/variable"
-  require "#{LIB_DIR}/output"
-  require "#{LIB_DIR}/data_source"
-  require "#{LIB_DIR}/provider"
-  require "#{LIB_DIR}/tfmodule"
-  require "#{LIB_DIR}/locals"
-  require "#{LIB_DIR}/terraform"
-  require "#{LIB_DIR}/stack"
-
-  def stack(&block)
-    Stack.new do
-      instance_eval(&block) if block_given?
-    end
-  end
-end
+TFDSL = TerraformDSL

data/tfdsl.gemspec

@@ -1,43 +1,24 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tfdsl/version'
+require 'terraform_dsl/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'tfdsl'
-  spec.version       = TFDSL::VERSION
+  spec.version       = TerraformDSL::VERSION
   spec.authors       = ['Tiago Lopo']
   spec.email         = ['tlopo@github.com']
 
   spec.summary       = 'A chef like DSL for terraform'
-  spec.description   = 'A chef like DSL for terraform'
-  spec.homepage      = 'https://github.com/tlopo-ruby/tfdsl.git'
+  spec.description   = 'A Ruby DSL that renders Terraform (HCL) configuration'
+  spec.homepage      = 'https://github.com/tlopo-ruby/terraform-dsl'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|\.github)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
-  spec.add_dependency 'deep_merge', '~> 1.2'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'pry', '~> 0.12'
-  spec.add_development_dependency 'pry-coolline', '~> 0.2'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 0.63'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

metadata

@@ -1,142 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: tfdsl
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Tiago Lopo
-autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: deep_merge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: pry-coolline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.63'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.63'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-description: A chef like DSL for terraform
+date: 2026-10-11 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby DSL that renders Terraform (HCL) configuration
 email:
 - tlopo@github.com
 executables: []
@@ -145,37 +18,42 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/terraform_dsl.rb
+- lib/terraform_dsl/action.rb
+- lib/terraform_dsl/block.rb
+- lib/terraform_dsl/check.rb
+- lib/terraform_dsl/data_source.rb
+- lib/terraform_dsl/ephemeral.rb
+- lib/terraform_dsl/formatter.rb
+- lib/terraform_dsl/import.rb
+- lib/terraform_dsl/json_syntax.rb
+- lib/terraform_dsl/locals.rb
+- lib/terraform_dsl/moved.rb
+- lib/terraform_dsl/output.rb
+- lib/terraform_dsl/provider.rb
+- lib/terraform_dsl/removed.rb
+- lib/terraform_dsl/resource.rb
+- lib/terraform_dsl/stack.rb
+- lib/terraform_dsl/template.rb
+- lib/terraform_dsl/terraform.rb
+- lib/terraform_dsl/tfmodule.rb
+- lib/terraform_dsl/variable.rb
+- lib/terraform_dsl/version.rb
 - lib/tfdsl.rb
-- lib/tfdsl/block.rb
-- lib/tfdsl/data_formatter.rb
-- lib/tfdsl/data_source.rb
-- lib/tfdsl/formatter.rb
-- lib/tfdsl/kind_translator.rb
-- lib/tfdsl/locals.rb
-- lib/tfdsl/output.rb
-- lib/tfdsl/provider.rb
-- lib/tfdsl/resource.rb
-- lib/tfdsl/stack.rb
-- lib/tfdsl/template.rb
-- lib/tfdsl/terraform.rb
-- lib/tfdsl/tfmodule.rb
-- lib/tfdsl/variable.rb
-- lib/tfdsl/version.rb
 - tfdsl.gemspec
-homepage: https://github.com/tlopo-ruby/tfdsl.git
+homepage: https://github.com/tlopo-ruby/terraform-dsl
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -183,15 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A chef like DSL for terraform
 test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - "2.6.0"
-sudo: false
-cache: bundler
-script: bundle exec rake $TASK
-env:
- - TASK=test_with_coveralls

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tfdsl (0.1.11)
-      deep_merge (~> 1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    coderay (1.1.2)
-    coolline (0.5.0)
-      unicode_utils (~> 1.4)
-    coveralls (0.8.22)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
-      tins (~> 1.6)
-    deep_merge (1.2.1)
-    docile (1.3.1)
-    jaro_winkler (1.5.2)
-    json (2.1.0)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    parallel (1.13.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-coolline (0.2.5)
-      coolline (~> 0.5)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rubocop (0.63.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    term-ansicolor (1.7.1)
-      tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.20.2)
-    unicode-display_width (1.4.1)
-    unicode_utils (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  coveralls (~> 0.8)
-  minitest (~> 5.0)
-  pry (~> 0.12)
-  pry-coolline (~> 0.2)
-  rake (~> 13.0)
-  rubocop (~> 0.63)
-  simplecov (~> 0.16)
-  tfdsl!
-
-BUNDLED WITH
-   1.17.2

data/lib/tfdsl/block.rb

@@ -1,88 +0,0 @@
-module TFDSL
-  # This class is the representation of terraform configuration block
-  # https://www.terraform.io/docs/configuration/
-  class Block
-    attr_reader :__type__, :__labels__
-    @@formatter = Formatter.new
-    def initialize(&block)
-      @__blocks__ = []
-      instance_eval(&block) if block_given?
-    end
-
-    def method_missing(method_name, *args, &block)
-      super if [:respond_to_missing?].include? method_name
-      return method_missing_handler(method_name, *args, &block)
-    end
-
-    def method_missing_handler(method_name, *args, &block)
-      method = method_name.to_s.gsub(/=$/, '')
-
-      if block_given?
-        r = Block.new
-        r.__type__ = method
-        r.__labels__ = args
-        @__blocks__ << r
-        return r.instance_eval(&block)
-      end
-
-      return instance_variable_set "@#{method}", *args unless args.empty?
-      return instance_variable_get "@#{method}" if args.empty?
-    end
-
-    def timeout(*args, &block)
-      method_missing_handler :timeout, *args,  &block
-    end
-
-    def respond_to_missing?(_method_name, _include_private = true)
-      true
-    end
-
-    def to_tf
-      @@formatter.format self
-    end
-
-    def to_str
-      to_tf
-    end
-
-    def to_s
-      to_tf
-    end
-
-    def to_json_repr(depth = 0)
-      block = { 'tmp' => {} }
-
-      ref = block['tmp']
-
-      labels = __labels__.dup
-      labels = [__type__] + labels if !__type__.empty? && depth.zero?
-
-      labels.each do |l|
-        ref[l] = {} if ref[l].nil?
-        ref = ref[l]
-      end
-
-      instance_variables.each do |var|
-        var_name = var.to_s.gsub(/^@/, '')
-        next if var_name =~ /^__/
-
-        ref[var_name] = send var_name
-      end
-
-      __blocks__.each do |b|
-        json = b.to_json_repr depth + 1
-        if b.__labels__.empty?
-          if ref[b.__type__].nil?
-            ref[b.__type__] = json
-          else
-            ref[b.__type__] = [ref[b.__type__], json].flatten
-          end
-        else
-          ref[b.__type__] = [] if ref[b.__type__].nil?
-          ref[b.__type__] << json
-        end
-      end
-      block['tmp']
-    end
-  end
-end