hcl-checker 1.4.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 195128a0325ac3b7fa3add01a739dbe3ce0aeb5b3314edfc74d195caa3a0aa61
-  data.tar.gz: ab84f84386083bdbb9aaea917716ea7e8462eaed2b89a2ab4f887fb4c3b2ee93
+  metadata.gz: e385b2693e62154b496432fb0baf5022d64fdc0827b5703d33be6a05dbfb50c6
+  data.tar.gz: 931d2e6fe0348c24164bfc17d6686ebd6b64ac41e2acb9884af1d51c189764c1
 SHA512:
-  metadata.gz: b53587ad90fa9ed3cf6c2fbfd5cad15f6b526e62e5c63298fbd963a1629d6283a0bac0ab7276674acba8a1d67e38bc2118fe8f9a0a11a5d362afef4957cc745a
-  data.tar.gz: 4d908d23f548138a2e4e876709cda19321650203d13219f8ac8fe3748cd1427e628f9cb834f80bf684252a7d06d9a97d72663f3ac6c19699a0149593e3450a0d
+  metadata.gz: c23f7d1562b29c3523de8be84d57a7690ff5c1f7680a368df049b7c21dd4b3246f2417a79df09f797ad00bd2743ec218effe67ffd020132174a79c5dd2ccaf4a
+  data.tar.gz: 8874919303dad9cbb0285fa69a042ddb4a444df7c71d76c41d8cb39639e333fddcdec13768cedb4fffcde4fdabcc3f9c70e805b89c5744cf643b0e267dd7b449

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - lib/hcl/lexer.rb
+    - lib/hcl/parser.rb
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # This is needed due https://nvd.nist.gov/vuln/detail/CVE-2018-14404
 # A NULL pointer dereference vulnerability exists in the xpath.c:xmlXPathCompOpEval()
@@ -7,10 +7,9 @@ source "https://rubygems.org"
 # with the use of the libxml2 library may be vulnerable to a denial of service attack due
 # to a crash of the application.
 # Nokogiri >= 1.8.5 solves this problem
-gem "nokogiri", ">= 1.10.8"
+gem 'nokogiri', '>= 1.11.4'
 
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in hcl-checker.gemspec
 gemspec

data/Gemfile.lock

@@ -1,20 +1,19 @@
 PATH
   remote: .
   specs:
-    hcl-checker (1.4.0)
+    hcl-checker (1.6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     filesize (0.2.0)
     jsobfu (0.4.2)
       rkelly-remix
-    json (2.3.1)
-    metasm (1.0.4)
-    mini_portile2 (2.4.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    json (2.6.1)
+    metasm (1.0.5)
+    nokogiri (1.13.6-arm64-darwin)
+      racc (~> 1.4)
     racc (1.5.0)
     rake (12.3.3)
     rb-readline (0.5.5)
@@ -27,27 +26,27 @@ GEM
       rb-readline (~> 0)
     rexical (1.0.7)
     rkelly-remix (0.0.7)
-    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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
+  bundler (~> 2.3.13)
   hcl-checker!
-  nokogiri (>= 1.10.8)
+  nokogiri (>= 1.11.4)
   racc (= 1.5.0)
   rake (~> 12.3.3)
   rex (= 2.0.12)
@@ -55,4 +54,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.3.13

data/README.md

@@ -47,21 +47,21 @@ You can validate the `hcl_string` contents with `valid?` method. This will
 return `true` if is a valid HCL or `false` if not.
 
 ```
-2.3.2 :014 > HCL1::Checker.valid? hcl_string
+2.3.2 :014 > HCL::Checker.valid? hcl_string
  => true
 ```
 
 You can parse the `hcl_string` into a `Hash` with `parse` method.
 
 ```
-2.3.2 :015 > HCL1::Checker.parse(hcl_string)
+2.3.2 :015 > HCL::Checker.parse(hcl_string)
  => {"provider"=>{"aws"=>{"region"=>"${var.aws_region}", "access_key"=>"${var.aws_access_key}", "secret_key"=>"${var.aws_secret_key}"}}, "resource"=>{"aws_vpc"=>{"default"=>{"cidr_block"=>"10.0.0.0/16", "enable_dns_hostnames"=>true, "tags"=>{"Name"=>"Event Store VPC"}}}}}
 ```
 
 If after a `parse` you got `false` you can check `last_error` with:
 
 ```
-2.4.2 :063 > HCL1::Checker.last_error
+2.4.2 :063 > HCL::Checker.last_error
  => "Parse error at  \"eec8b16c-ee89-4ea0-bdcc-d094300a42e8\" , (invalid token: ,)"
 ```
 

data/Rakefile

@@ -1,19 +1,18 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new do |c|
-  options = ["--color"]
-  options += ["--format", "documentation"]
+  options = ['--color']
+  options += ['--format', 'documentation']
   c.rspec_opts = options
 end
 
-desc "Generate Grammar files for HCL"
+desc 'Generate Grammar files for HCL'
 task :build_grammar do
   print 'Building Lexer'
-  `rex  ./assets/lexer.rex -o ./lib/hcl/lexer.rb`
+  `rex ./assets/lexer.rex -o ./lib/hcl/checker/lexer.rb`
   print "....done\n"
   print 'Building Parser'
-  `racc ./assets/parse.y -o ./lib/hcl/parser.rb`
+  `racc ./assets/parse.y -o ./lib/hcl/checker/parser.rb`
   print "....done\n\n"
 end
-

data/assets/lexer.rex

@@ -1,8 +1,7 @@
-
-class HCLLexer
+class HCL::Checker::Lexer
 option
   independent
-  
+
 macro
   NEWLINE               \n|\r
   BLANK                 \s+
@@ -20,6 +19,8 @@ macro
   RIGHTBRACE            \}
   LEFTBRACKET           \[
   RIGHTBRACKET          \]
+  LEFTPARENTHESES       \(
+  RIGHTPARENTHESES      \)
   HEREDOCUMENT          \<<\-?
 
 rule
@@ -36,37 +37,39 @@ rule
                 {QUOTE}                   { [:STRING,       consume_string(text)] }
                 {HEREDOCUMENT}            { [:STRING,       consume_heredoc] }
 #-------------------------------------------------------------------------------
-                {LEFTBRACE}               { [:LEFTBRACE,    text]}
-                {RIGHTBRACE}              { [:RIGHTBRACE,   text]}
-                {LEFTBRACKET}             { [:LEFTBRACKET,  text]}
-                {RIGHTBRACKET}            { [:RIGHTBRACKET, text]}
+                {LEFTBRACE}               { [:LEFTBRACE,        text]}
+                {RIGHTBRACE}              { [:RIGHTBRACE,       text]}
+                {LEFTBRACKET}             { [:LEFTBRACKET,      text]}
+                {RIGHTBRACKET}            { [:RIGHTBRACKET,     text]}
+                {LEFTPARENTHESES}         { [:LEFTPARENTHESES,  text]}
+                {RIGHTPARENTHESES}        { [:RIGHTPARENTHESES, text]}
 #-------------------------------------------------------------------------------
                 {COMMA}                   { [:COMMA,        text]}
                 {IDENTIFIER}              { [:IDENTIFIER,   text]}
                 {EQUAL}                   { [:EQUAL,        text]}
                 {MINUS}                   { [:MINUS,        text]}
 
-
 inner
-
   def lex(input)
     scan_setup(input)
     tokens = []
     while token = next_token
       tokens << token
     end
+
     tokens
   end
 
 
   def to_boolean(input)
-    input =
-      if input =~ /true/
-        true
-      elsif input =~ /false/
-        false
-      end
-    return input
+    case input
+    when /true/
+      true
+    when /false/
+      false
+    else
+      raise "Invalid value for `to_boolean`, expected true/false got #{input}"
+    end
   end
 
 
@@ -90,19 +93,21 @@ inner
     result = ''
     nested = 0
 
-    begin
+    loop do
       case(text = @ss.scan_until(%r{\"|\$\{|\}|\\}))
       when %r{\$\{\z}
         nested += 1
       when %r{\}\z}
-        nested -= 1 if nested > 0
+        nested -= 1 if nested.positive?
       when %r{\\\z}
         result += text.chop + @ss.getch
         next
       end
 
       result += text.to_s
-    end until nested == 0 && text =~ %r{\"\z}
+
+      break if nested.zero? && text =~ %r{\"\z}
+    end
 
     result.chop
   end

data/assets/parse.y

@@ -1,4 +1,4 @@
-class HCLParser
+class HCL::Checker::Parser
 token BOOL
       FLOAT
       NUMBER
@@ -12,6 +12,8 @@ token BOOL
       RIGHTBRACE
       LEFTBRACKET
       RIGHTBRACKET
+      LEFTPARENTHESES
+      RIGHTPARENTHESES
       PERIOD
       EPLUS
       EMINUS
@@ -24,7 +26,6 @@ rule
   |  objectlist
   ;
 
-
   objectlist:
      objectitem COMMA
        { result = [val[0]] }
@@ -40,7 +41,7 @@ rule
      LEFTBRACE objectlist RIGHTBRACE
        { result = flatten_objectlist(val[1]) }
   |  LEFTBRACE RIGHTBRACE
-       { return }
+       { return {} }
   ;
 
   objectkey:
@@ -61,6 +62,10 @@ rule
        { result = val[0], val[2] }
   |  objectkey EQUAL list
        { result = val[0], val[2] }
+  |  objectkey EQUAL IDENTIFIER LEFTPARENTHESES IDENTIFIER RIGHTPARENTHESES
+       { result = val[0], "#{val[2]}(#{val[4]})" }
+  |  objectkey EQUAL IDENTIFIER
+       { result = val[0], val[2] }
   |  block
        { result = val[0] }
   ;
@@ -83,7 +88,7 @@ rule
      LEFTBRACKET listitems RIGHTBRACKET
        { result = val[1] }
   |  LEFTBRACKET RIGHTBRACKET
-       { return }
+       { return [] }
   ;
 
   listitems:
@@ -117,7 +122,7 @@ rule
 end
 
 ---- header
-require_relative './lexer'
+require_relative 'lexer'
 
 ---- inner
   #//
@@ -125,19 +130,31 @@ require_relative './lexer'
   #//       keys are encountered.
   #//
   #//       from decoder.go: if we're at the root or we're directly within
-  #//                        a list, decode  to hashes, otherwise lists
+  #//                        a list, decode to hashes, otherwise lists
   #//
   #//       from object.go:  there is a flattened list structure
   #//
+  #//       if @duplicate_mode is set:
+  #//         - :array then duplicates will be appended to an array
+  #//         - :merge then duplicates will be deep merged into a hash
+  #//
   def flatten_objectlist(list)
     (list || {}).each_with_object({}) do |a, h|
-      h[a.first] =
-        case a.last
-        when Hash
+      if h.keys.include?(a.first)
+        case @duplicate_mode
+        when :array
+          if h[a.first].is_a?(Array)
+            h[a.first].push(a.last)
+          else
+            h[a.first] = [ h[a.first], a.last ]
+          end
+        when :merge
           deep_merge(h[a.first] || {}, a.last)
-        else
-          h[a.first] = a.last
+        else raise ArgumentError
         end
+      else
+        h[a.first] = a.last
+      end
     end
   end
 
@@ -149,10 +166,12 @@ require_relative './lexer'
   end
 
 
-  def parse(input)
-    @lexer = HCLLexer.new.lex(input)
+  def parse(input, duplicate_mode = :array)
+    @duplicate_mode = duplicate_mode
+    @lexer = HCL::Checker::Lexer.new.lex(input)
     do_parse
-    return @result
+
+    @result
   end
 
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "hcl/checker"
+require 'bundler/setup'
+require 'hcl/checker'
 
 # 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.
@@ -10,5 +10,5 @@ require "hcl/checker"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/hcl-checker.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hcl/checker/version'
 
@@ -17,36 +17,20 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.1.4'
-  spec.add_development_dependency 'rake', '~> 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 2.3.13'
   spec.add_development_dependency 'racc', '1.5.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rex', '2.0.12'
   spec.add_development_dependency 'rexical', '>= 1.0.7'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.post_install_message = %q{
-Hello, I am updating this Gem to support version 2.0 of the HCL.
-
-In the meantime, it is important that you know that there will be a
-compatibility break with the current version, for Gem to support both
-versions.
-
-Therefore, instead of using just HCL::Checker you must tell which
-version you are using, like this:
-
-HCL1::Checker
-
-Or
-
-HCL2::Checker
-
-At the moment both HCL::Checker and HCL1::Checker will work, but with
-the release of support for version 2 the HCL::Checker syntax will no
-longer work.
+  spec.post_install_message = '
+Hello, me again. This version fixes:
 
-So, update your code.
+- Update dependencies due security issues
 
 Thank you :)
-}
+'
 end

data/lib/hcl/{lexer.rb → checker/lexer.rb}

@@ -4,8 +4,7 @@
 # from lexical definition file "./assets/lexer.rex".
 #++
 
-
-class HCLLexer
+class HCL::Checker::Lexer
       require 'strscan'
 
       class ScanError < StandardError ; end
@@ -85,16 +84,22 @@ class HCLLexer
                      action { [:STRING,       consume_heredoc] }
 
                   when (text = @ss.scan(/\{/))
-                     action { [:LEFTBRACE,    text]}
+                     action { [:LEFTBRACE,        text]}
 
                   when (text = @ss.scan(/\}/))
-                     action { [:RIGHTBRACE,   text]}
+                     action { [:RIGHTBRACE,       text]}
 
                   when (text = @ss.scan(/\[/))
-                     action { [:LEFTBRACKET,  text]}
+                     action { [:LEFTBRACKET,      text]}
 
                   when (text = @ss.scan(/\]/))
-                     action { [:RIGHTBRACKET, text]}
+                     action { [:RIGHTBRACKET,     text]}
+
+                  when (text = @ss.scan(/\(/))
+                     action { [:LEFTPARENTHESES,  text]}
+
+                  when (text = @ss.scan(/\)/))
+                     action { [:RIGHTPARENTHESES, text]}
 
                   when (text = @ss.scan(/\,/))
                      action { [:COMMA,        text]}
@@ -129,13 +134,14 @@ class HCLLexer
     tokens
   end
   def to_boolean(input)
-    input =
-      if input =~ /true/
-        true
-      elsif input =~ /false/
-        false
-      end
-    return input
+    case input
+    when /true/
+      true
+    when /false/
+      false
+    else
+      raise "Invalid value for `to_boolean`, expected true/false got #{input}"
+    end
   end
   def consume_comment(input)
     nested = 1
@@ -153,18 +159,19 @@ class HCLLexer
   def consume_string(input)
     result = ''
     nested = 0
-    begin
+    loop do
       case(text = @ss.scan_until(%r{\"|\$\{|\}|\\}))
       when %r{\$\{\z}
         nested += 1
       when %r{\}\z}
-        nested -= 1 if nested > 0
+        nested -= 1 if nested.positive?
       when %r{\\\z}
         result += text.chop + @ss.getch
         next
       end
       result += text.to_s
-    end until nested == 0 && text =~ %r{\"\z}
+      break if nested.zero? && text =~ %r{\"\z}
+    end
     result.chop
   end
   def consume_heredoc