cfn-model 0.1.28 → 0.1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b793b08c7374b3d4b6278501a083db2e33e2a43c7d57127d5c536c3a0502743
-  data.tar.gz: 74b42b3c781f10adb4d177d0498cb0e79ad8ce8c45db20561e9e10db21bb130c
+  metadata.gz: d727b122287e1f97d8c2f75323e7ab57553b8265cff424a06abd8127e4cc5893
+  data.tar.gz: ff0dd5f3e93115b884a4e217366688d960025b0ed54355a9a0a092d8e5de121b
 SHA512:
-  metadata.gz: 39cebcc2c3d32eff01af5c361f32ef4f4f877aa2d4533131099e3cb0707e22582e8612b3ac85a4e8a96f28b3a469f325bf5df02530ee5f7bb9a3ae8d7ce9ab27
-  data.tar.gz: 67c0fbbf7cb12f52d00556daeedf6982ec5cf5397fab89b4903dc501b47981b865b9941337ed9d2f2fef39d09ec49f9af9545f99311019216639f29c47dbd981
+  metadata.gz: 0c2a43026c14efb0de73770172ea6d1f89f3ee2c96b9f69ee19dd6ffa58b4e7f41d7b8854540d3c27c0e476bde42738b50a3a63d1adbdc60066edbbf368f3a55
+  data.tar.gz: b4e3e37b0b8176d28d67dde05b0860104aa19ec1828f753737047f8290efe320e1f46dbc7a257bec6a5db29375b500282b63af74478fe92f1e40cba947379b17

data/bin/cfn_parse

@@ -4,5 +4,5 @@ require 'cfn-model'
 puts '======'
 puts ARGV[0]
 puts '======'
-cfn_model = CfnParser.new.parse IO.read(ARGV[0])
+cfn_model = CfnParser.new.parse IO.read(ARGV[0]), nil, true
 puts cfn_model

data/lib/cfn-model/model/cfn_model.rb

@@ -1,7 +1,7 @@
 require_relative 'references'
 
 class CfnModel
-  attr_reader :resources, :parameters
+  attr_reader :resources, :parameters, :line_numbers
 
   ##
   # if you really want it, here it is - the raw Hash from YAML.load.  you'll have to mess with structural nits of
@@ -13,6 +13,7 @@ class CfnModel
     @parameters = {}
     @resources = {}
     @raw_model = nil
+    @line_numbers = {}
   end
 
   ##
@@ -78,4 +79,4 @@ class CfnModel
   def to_s
     @resources.to_s
   end
-end
+end

data/lib/cfn-model/monkey_patches/psych/nodes/node.rb

@@ -0,0 +1,5 @@
+# Psych's first step is to parse the Yaml into an AST of Node objects
+# so we open the Node class and add a way to track the line.
+class Psych::Nodes::Node
+  attr_accessor :line
+end

data/lib/cfn-model/parser/cfn_parser.rb

@@ -1,8 +1,12 @@
 require 'yaml'
+require 'psych'
 require 'json'
 require 'cfn-model/parser/transform_registry'
 require 'cfn-model/validator/cloudformation_validator'
 require 'cfn-model/validator/reference_validator'
+require 'cfn-model/psych/handlers/line_number_handler'
+require 'cfn-model/psych/visitors/to_ruby_with_line_numbers'
+require 'cfn-model/monkey_patches/psych/nodes/node'
 require_relative 'parser_registry'
 require_relative 'parameter_substitution'
 require_relative 'parser_error'
@@ -32,18 +36,31 @@ class CfnParser
   ##
   # Given raw json/yml CloudFormation template, returns a CfnModel object
   # or raise ParserErrors if something is amiss with the format
-  def parse(cloudformation_yml, parameter_values_json=nil)
-    cfn_model = parse_without_parameters(cloudformation_yml)
+  def parse(cloudformation_yml, parameter_values_json=nil, with_line_numbers=false)
+    cfn_model = parse_without_parameters(cloudformation_yml, with_line_numbers)
 
     apply_parameter_values(cfn_model, parameter_values_json)
 
     cfn_model
   end
 
-  def parse_without_parameters(cloudformation_yml)
+  def parse_with_line_numbers(cloudformation_yml)
+    handler = LineNumberHandler.new
+    parser =  Psych::Parser.new(handler)
+    handler.parser = parser
+    parser.parse(cloudformation_yml)
+    ToRubyWithLineNumbers.create.accept(handler.root).first
+  end
+
+  def parse_without_parameters(cloudformation_yml, with_line_numbers=false)
     pre_validate_model cloudformation_yml
 
-    cfn_hash = YAML.load cloudformation_yml
+    cfn_hash =
+      if with_line_numbers
+        parse_with_line_numbers(cloudformation_yml)
+      else
+        YAML.load cloudformation_yml
+      end
 
     # Transform raw resources in template as performed by
     # transforms
@@ -55,7 +72,11 @@ class CfnParser
     cfn_model.raw_model = cfn_hash
 
     # pass 1: wire properties into ModelElement objects
-    transform_hash_into_model_elements cfn_hash, cfn_model
+    if with_line_numbers
+      transform_hash_into_model_elements_with_numbers cfn_hash, cfn_model
+    else
+      transform_hash_into_model_elements cfn_hash, cfn_model
+    end
     transform_hash_into_parameters cfn_hash, cfn_model
 
     # pass 2: tie together separate resources only where necessary to make life easier for rule logic
@@ -103,6 +124,23 @@ class CfnParser
     cfn_model
   end
 
+  def transform_hash_into_model_elements_with_numbers(cfn_hash, cfn_model)
+    cfn_hash['Resources'].each do |resource_name, resource|
+      resource_class = class_from_type_name resource['Type']['value']
+
+      resource_object = resource_class.new(cfn_model)
+      resource_object.logical_resource_id = resource_name
+      resource_object.resource_type = resource['Type']['value']
+      resource_object.metadata = resource['Metadata']
+
+      assign_fields_based_upon_properties resource_object, resource
+
+      cfn_model.resources[resource_name] = resource_object
+      cfn_model.line_numbers[resource_name] = resource['Type']['line']
+    end
+    cfn_model
+  end
+
   def transform_hash_into_parameters(cfn_hash, cfn_model)
     return cfn_model unless cfn_hash.has_key?('Parameters')
 

data/lib/cfn-model/psych/handlers/line_number_handler.rb

@@ -0,0 +1,18 @@
+# We need to provide a handler that will add the line to the node
+# as it is parsed. TreeBuilder is the "usual" handler, that
+# creates the AST.
+class LineNumberHandler < Psych::TreeBuilder
+
+  # The handler needs access to the parser in order to call mark
+  attr_accessor :parser
+
+  # We are only interested in scalars, so here we override
+  # the method so that it calls mark and adds the line info
+  # to the node.
+  def scalar value, anchor, tag, plain, quoted, style
+    mark = parser.mark
+    node = super
+    node.line = mark.line
+    node
+  end
+end

data/lib/cfn-model/psych/visitors/to_ruby_with_line_numbers.rb

@@ -0,0 +1,18 @@
+class ToRubyWithLineNumbers < Psych::Visitors::ToRuby
+  def revive_hash hash, o
+    o.children.each_slice(2) { |k,v|
+      key = accept(k)
+      val = accept(v)
+      line = v.respond_to?(:line) ? v.line : v.start_line
+
+      # This is the important bit. If the value is a scalar,
+      # we replace it with the desired hash.
+      if v.is_a?(::Psych::Nodes::Scalar) && key == 'Type'
+        val = { "value" => val, "line" => line + 1} # line is 0 based, so + 1
+      end
+
+      hash[key] = val
+    }
+    hash
+  end
+end

data/lib/cfn-model/validator/cloudformation_validator.rb

@@ -9,4 +9,4 @@ class CloudFormationValidator
 
     validator.validate(YAML.load(cloudformation_string))
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-model
 version: !ruby/object:Gem::Version
-  version: 0.1.28
+  version: 0.1.29
 platform: ruby
 authors:
 - Eric Kascic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -70,6 +70,7 @@ files:
 - lib/cfn-model/model/security_group_ingress.rb
 - lib/cfn-model/model/statement.rb
 - lib/cfn-model/model/topic_policy.rb
+- lib/cfn-model/monkey_patches/psych/nodes/node.rb
 - lib/cfn-model/parser/cfn_parser.rb
 - lib/cfn-model/parser/ec2_instance_parser.rb
 - lib/cfn-model/parser/ec2_network_interface_parser.rb
@@ -85,6 +86,8 @@ files:
 - lib/cfn-model/parser/security_group_parser.rb
 - lib/cfn-model/parser/transform_registry.rb
 - lib/cfn-model/parser/with_policy_document_parser.rb
+- lib/cfn-model/psych/handlers/line_number_handler.rb
+- lib/cfn-model/psych/visitors/to_ruby_with_line_numbers.rb
 - lib/cfn-model/schema/AWS_CloudFront_Distribution.yml
 - lib/cfn-model/schema/AWS_EC2_Instance.yml
 - lib/cfn-model/schema/AWS_EC2_NetworkInterface.yml