hcl2-rb 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73d51dffee490023cce7a09c6ddec262ea198ef287e24d4e8ea536335ca1c37a
+  data.tar.gz: cbcc946ca6cd61ada79732035840fd768dda94546e55fbe030c2c0a203d9e606
+SHA512:
+  metadata.gz: 3a71b1889c3bdfb4ce20b6634a5d5b2ece063b87d82c5c1f90dbe68c8c31615e736cfd18bef16a5c1d676af2c5fbadee4a77f99f02682c795ef69dff2212e60e
+  data.tar.gz: 55d7a452386ab3c8146afc4feddf9aee1b95ba0f51e7b450afc3adb801d36b8b47c8a6d31ed95fad82bb6008aeee5bd8abae397f6aa73f3bdddf5c5a269b9b9f

data/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 iveahugeship
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# hcl2-rb
+
+Ruby common data types formatter to HCL2.
+
+Using this tool you can format general Ruby data types to HCL2.
+Execute .to_hcl2 method, get the string and write it to a file
+
+## Example
+
+It's very simple! You have the Hash:
+
+```
+vault_config = {
+  ui: true,
+  listener: {
+    tcp: {
+      address: '127.0.0.1:8200'
+    },
+    unix: {
+      address: '/run/vault.sock'
+    }
+  },
+  telemetry: {
+    statsite_address: 'statsite.company.local:8125'
+  }
+}
+```
+
+Now format it to HCL2:
+
+```
+>> puts vault_config.to_hcl2
+ui = true
+
+listener "tcp" {
+  address = "127.0.0.1:8200"
+
+}
+
+listener "unix" {
+  address = "/run/vault.sock"
+
+}
+
+telemetry {
+  statsite_address = "statsite.company.local:8125"
+
+}
+```
+
+## Contributing
+
+Create a PR or a simple issue c:
+
+Before PR creating, please, execute `rspec` and `rubocop`.

data/lib/hcl2-rb/formatter.rb

@@ -0,0 +1,76 @@
+class Hash
+  def has_child?
+    return false if empty?
+
+    each do |_k, v|
+      return false unless v.is_a?(Hash)
+    end
+
+    true
+  end
+
+  def to_hcl2(level: 0, spaces: 2)
+    hcl2 = []
+
+    each do |k, v|
+      case v
+      when Numeric, String, TrueClass, FalseClass, Array
+        hcl2.push("#{k} = #{v.to_hcl2}\n")
+      when Hash
+        labels = HCL2::Helpers.dfs(v)
+        labels.each do |label|
+          # It creates a label string and we shouldn't
+          # forget about addition space before this one
+          n = label.empty? ? nil : label.map { |l| l&.to_hcl2 }.join('').prepend(' ') # It creates label string
+
+          # We should go deeper to format child attributes
+          c = label.empty? ? v : v.dig(*label)
+
+          hcl2.push("#{k}#{n} {")
+          hcl2.push(c.to_hcl2(level: level + 1))
+          hcl2.push("}\n")
+        end
+      else
+        raise "#{v.class.name} can't be formatted to HCL2"
+      end
+    end
+
+    hcl2.map { |v| v.prepend(' ' * (spaces * level)) }.join("\n")
+  end
+end
+
+class Numeric
+  def to_hcl2
+    to_s
+  end
+end
+
+class String
+  def to_hcl2
+    inspect
+  end
+end
+
+class Symbol
+  def to_hcl2
+    to_s.to_hcl2
+  end
+end
+
+class TrueClass
+  def to_hcl2
+    to_s
+  end
+end
+
+class FalseClass
+  def to_hcl2
+    to_s
+  end
+end
+
+class Array
+  def to_hcl2
+    to_s
+  end
+end

data/lib/hcl2-rb/helpers.rb

@@ -0,0 +1,28 @@
+# rubocop:disable Naming/MethodParameterName, Lint/NestedMethodDefinition
+module HCL2
+  module Helpers
+    # This is just the Deep Find Search algorithm
+    # using to flatten Hash like it make HCL2
+    def self.dfs(g)
+      def self.f(g, r, c)
+        unless g.has_child?
+          r.push(c.flatten)
+          return
+        end
+
+        g.each do |k, v|
+          c.push(k)
+          f(v, r, c)
+          c.delete(k)
+        end
+      end
+
+      res = []
+      cur = []
+      f(g, res, cur)
+
+      res
+    end
+  end
+end
+# rubocop:enable Naming/MethodParameterName, Lint/NestedMethodDefinition

data/lib/hcl2-rb.rb

@@ -0,0 +1,2 @@
+require 'hcl2-rb/formatter'
+require 'hcl2-rb/helpers'

data/spec/formatter_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe Numeric do
+  it 'format Numeric to_hcl2' do
+    expect(12_345.to_hcl2).to eq('12345')
+  end
+end
+
+RSpec.describe String do
+  it 'format String to_hcl2' do
+    expect('string'.to_hcl2).to eq('"string"')
+  end
+end
+
+RSpec.describe Symbol do
+  it 'format Symbol to_hcl2' do
+    expect(:symbol.to_hcl2).to eq('"symbol"')
+  end
+end
+
+RSpec.describe TrueClass do
+  it 'format TrueClass to_hcl2' do
+    expect(true.to_hcl2).to eq('true')
+  end
+end
+
+RSpec.describe FalseClass do
+  it 'format FalseClass to_hcl2' do
+    expect(false.to_hcl2).to eq('false')
+  end
+end
+
+RSpec.describe Array do
+  it 'format Array to_hcl2' do
+    expect([1, 2, 'three'].to_hcl2).to eq('[1, 2, "three"]')
+  end
+end
+
+RSpec.describe Hash do
+  fix = {
+    ui: true,
+    listener: {
+      tcp: {
+        address: '127.0.0.1:8200'
+      },
+      unix: {
+        address: '/run/vault.sock'
+      }
+    },
+    telemetry: {
+      statsite_address: 'statsite.company.local:8125'
+    },
+    advanced: {
+      foo: {
+        bar: {
+          bim: 'bam'
+        }
+      },
+      it: 'works?'
+    }
+  }
+
+  it 'has child' do
+    expect(fix.has_child?).to eq(false)
+    expect(fix[:listener].has_child?).to eq(true)
+  end
+
+  it 'format Hash to_hcl2' do
+    exp = <<~EXP
+      ui = true
+
+      listener "tcp" {
+        address = "127.0.0.1:8200"
+
+      }
+
+      listener "unix" {
+        address = "/run/vault.sock"
+
+      }
+
+      telemetry {
+        statsite_address = "statsite.company.local:8125"
+
+      }
+
+      advanced {
+        foo "bar" {
+          bim = "bam"
+
+        }
+
+        it = "works?"
+
+      }
+    EXP
+
+    expect(fix.to_hcl2).to eq(exp)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'hcl2-rb'
+
+RSpec.configure do |c|
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: hcl2-rb
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- iveahugeship
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-30 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Ruby common data types formatter to HCL2.
+
+      Using this tool you can format general Ruby data types to HCL2.
+      Execute .to_hcl2 method, get the string and write it to a file.
+email:
+- iveahugeship@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/hcl2-rb.rb
+- lib/hcl2-rb/formatter.rb
+- lib/hcl2-rb/helpers.rb
+- spec/formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iveahugeship/hcl2-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Ruby common data types formatter to HCL2
+test_files: []