hcl_variables 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61566319d2d1b0a2282872cc396000b04641112f2e48bb39d9639334f30a53ee
+  data.tar.gz: e96020c4a988c14fbf9be62d9a058d04c1a4291c73e9e2fc562d838f795c3185
+SHA512:
+  metadata.gz: 4ad20f92693a1edd6fd99132b48d361f283b461901c41789dd11dad9fec9e30bae928c094fb2fa7776ada21a3ebf9b9b18d02cec700051c98abb1eb67846e0a3
+  data.tar.gz: 647ab5531e3649c817aa2b4a3fc314a5e2cd33d1326d825a54ee1280ac11dca189acc2f6dceb1920b7b33de6b01b6a78454b6685bebe8e4323cda26ee1db7443

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hcl_variables.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    hcl_variables (0.1.0)
+      rhcl
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rhcl (0.1.0)
+      deep_merge
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hcl_variables!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tung Nguyen
+
+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,45 @@
+# HclVariables
+
+Parse HCL Variables files. The scope of this library is to only handle `variables.tf` file.
+
+## Usage
+
+```ruby
+require "hcl_variables"
+code =<<EOL
+variable "project" {
+  description = "The name of the GCP Project"
+  default     = "test"
+  type        = "string"
+}
+variable "name_prefix" {
+  type        = "string"
+}
+EOL
+
+parser = HclVariables::Parser.new(code)
+parser.load
+# Returns =>
+#
+# {"variable"=>
+#   {"project"=>
+#     {"description"=>"The name of project",
+#      "default"=>"test",
+#      "type"=>"string"},
+#    "name_prefix"=>{"type"=>"string"}}}
+```
+
+## Installation
+
+```ruby
+gem 'hcl_variables'
+```
+
+## Notes
+
+* Tried a few different Ruby HCL parsers: [hcl-checker](https://github.com/mfcastellani/hcl-checker), [hcl-rb](https://github.com/Ruin0x11/hcl-rb), [rhcl](https://github.com/winebarrel/rhcl), [ruby-hcl](https://github.com/sikula/ruby-hcl). They all seem to have one issues or another.
+* This library preprocesses the text fed to the parser to workaround the parser issues. It's a workaround.
+* Able to handle simple variable types and most complex types.
+* Not able to handle multi-line complex variable types. There's a spec to document this.
+* Will have to fix one of these parsers or write a new one.
+* Open to PRs to help.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hcl_variables"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hcl_variables.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/hcl_variables/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hcl_variables"
+  spec.version       = HclVariables::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = "HCL Variables Parser"
+  spec.homepage      = "https://github.com/tongueroo/hcl_variables"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rhcl"
+
+  spec.add_development_dependency "rspec"
+end

data/lib/hcl_variables.rb

@@ -0,0 +1,13 @@
+require "hcl_variables/version"
+
+module HclVariables
+  class Error < StandardError; end
+
+  autoload :Parser, "hcl_variables/parser"
+
+  def load(code)
+    Parser.new(code).load
+  end
+
+  extend self
+end

data/lib/hcl_variables/parser.rb

@@ -0,0 +1,64 @@
+require "rhcl"
+
+module HclVariables
+  class Parser
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def load
+      return {} if empty? # Rhcl parser cannot handle empty file
+      Rhcl.parse(code)
+    end
+
+    # The parser being used cannot handle unquoted literal type values and comments.
+    # Hacking it and updating the raw code as a workaround.
+    # May have to fix the parser or write a new parser.
+    def code
+      return @code if @code
+      @code = fix_quotes(@raw)
+    end
+
+    def empty?
+      text = remove_comments(code)
+      lines = text.split("\n")
+      lines.reject! { |l| l.strip.empty? }
+      lines.empty?
+    end
+
+    COMMENT_REGEX = /^(^|\s)#/i
+    def remove_comments(raw)
+      lines = raw.split("\n")
+      # filter out commented lines
+      lines.reject! { |l| l =~ COMMENT_REGEX }
+      # filter out empty lines
+      lines.reject! { |l| l.strip.empty? }
+      lines.join("\n")
+    end
+
+    def fix_quotes(raw)
+      lines = raw.split("\n")
+      lines.map! do |l|
+        quote_line(l)
+      end
+      lines.join("\n")
+    end
+
+    def quote_line(l)
+      return "# " if l =~ COMMENT_REGEX # return empty comment so parser wont try to parse it
+      return l unless l =~ /type\s*=/ # just check for type
+      return l if l =~ /type\s*=\s*['"]([a-zA-Z0-9()]+)["']/ # check quotes in the type value
+
+      # Reaching here means there is probably a type value without quotes
+      # Try to capture unquoted value so we can add quotes
+      md = l.match(/type\s*=\s*([a-zA-Z0-9()]+)/)
+      if md
+        value = md[1]
+        %Q|type = "#{value}"|
+      else
+        # Example: type = "list(object({
+        l # unable to capture quotes, passthrough as fallback
+      end
+    end
+  end
+end

data/lib/hcl_variables/version.rb

@@ -0,0 +1,3 @@
+module HclVariables
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: hcl_variables
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rhcl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hcl_variables.gemspec
+- lib/hcl_variables.rb
+- lib/hcl_variables/parser.rb
+- lib/hcl_variables/version.rb
+homepage: https://github.com/tongueroo/hcl_variables
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tongueroo/hcl_variables
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: HCL Variables Parser
+test_files: []