cfndsl 0.4.4 → 0.5.0.pre

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzQ4YjE4ZmUwOWU1ODIwY2UzYzYwZDdjZDU2M2Q2MmI2ODA2OTViMg==
-  data.tar.gz: !binary |-
-    MmNiN2IyZjZiMTFhOWFmYmIxZWJkNjExZTFiZDdkNjhkNWIxYjMxYw==
+SHA1:
+  metadata.gz: 0c3d2ac765697ae526e12354216d7c45845e07b0
+  data.tar.gz: 7ea0a5bb2eb5d16a611165bde335400d6fbdf29b
 SHA512:
-  metadata.gz: !binary |-
-    YjFiMmU4OTY3NzlhNzJlMjMwN2Y0Yjc4MzEwNGVmYmQzYmJkZGI2ZjJhODMz
-    NjJmNWU3MDc5ZjZiOWRhY2I2OWVjN2U1NjMzOGVkNWZjNzY1ZDVkZjNlZWJk
-    ZTlkMDg3NjVlMDI4MmYzYzdlNjhjODNhNzA5Y2FjNGQ1NWVjZWE=
-  data.tar.gz: !binary |-
-    MzQyNDEzZDliYjEwZTc4ZWMwYjkzNjczZTkyNzBlYTk5MjM4YTIyNGI3NTEw
-    NTgwMjY2MTI4OWQ4MWVhZmNiMzNmMWYyMTk2ODZiOTY3OWNlNGE1MmZhODc3
-    YTc2YTY2MmI1ZDkyZWYzZmZlZDkxOTU2ZmQzNjZkMjVmNWRmMjA=
+  metadata.gz: efac56f41113e2ba016d176eeb23c5bf177d57c2ec22008eb029adea4f990d0ddcc975d13e87277efb07d192e227e76559b2bf567f04408e9641a432ba60c753
+  data.tar.gz: 27ed0952f74bf9841485d5236208b4315820bee91e737bbfa55d823281bc543245cb77e2ff6bd7f7a4fabb18f5472c6d13a0d023235da86d6677baa49958b340

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Metrics/LineLength:
+  Max: 160
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 25
+
+# Due to our @Properties style instance names
+Style/VariableName:
+  Enabled: false
+
+# We are a DSL
+Style/MethodName:
+  Enabled: false
+
+# Lone String
+Lint/Void:
+  Enabled: false

data/Gemfile

@@ -4,6 +4,10 @@ gemspec
 
 gem 'json'
 
+group :development, :test do
+  gem 'rubocop', require: false
+end
+
 group :test do
   gem 'rake'
   gem 'rspec'

data/Rakefile

@@ -1,24 +1,26 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "cfndsl/version"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cfndsl/version'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
 
-task default: [:spec]
+task default: [:spec, :rubocop]
 
-task :bump, :type do |t, args|
+task :bump, :type do |_, args|
   type = args[:type].downcase
-  version_path = "lib/cfndsl/version.rb"
+  version_path = 'lib/cfndsl/version.rb'
 
-  types = %w[major minor patch]
+  types = %w(major minor patch)
 
-  fail unless types.include? type
+  raise unless types.include?(type)
 
-  if `git rev-parse --abbrev-ref HEAD`.strip != "master"
-    fail "Looks like you're trying to create a release in a branch, you can only create one in 'master'"
+  if `git rev-parse --abbrev-ref HEAD`.strip != 'master'
+    raise "Looks like you're trying to create a release in a branch, you can only create one in 'master'"
   end
 
-  version_segments = CfnDsl::VERSION.split(".").map(&:to_i)
+  version_segments = CfnDsl::VERSION.split('.').map(&:to_i)
 
   segment_index = types.find_index type
 
@@ -26,7 +28,7 @@ task :bump, :type do |t, args|
                      [version_segments.at(segment_index).succ] +
                      [0] * version_segments.drop(segment_index.succ).count
 
-  version = version_segments.join(".")
+  version = version_segments.join('.')
 
   puts "Bumping gem from version #{CfnDsl::VERSION} to #{version} as a '#{type.capitalize}' release"
 
@@ -34,18 +36,18 @@ task :bump, :type do |t, args|
   updated_contents = contents.gsub(/([0-9\.]+)/, version)
   File.write(version_path, updated_contents)
 
-  puts "Commiting version update"
+  puts 'Commiting version update'
   `git add #{version_path}`
   `git commit --message='#{type.capitalize} release #{version}'`
 
-  puts "Tagging release"
+  puts 'Tagging release'
   `git tag -a v#{version} -m 'Version #{version}'`
 
-  puts "Pushing branch"
+  puts 'Pushing branch'
   `git push origin master`
 
-  puts "Pushing tag"
+  puts 'Pushing tag'
   `git push origin v#{version}`
 
-  puts "All done, travis should pick up and release the gem now!"
+  puts 'All done, travis should pick up and release the gem now!'
 end

data/bin/cfndsl

@@ -6,51 +6,51 @@ require 'json'
 
 options = {}
 
-optparse = OptionParser.new do|opts|
-  opts.banner = "Usage: cfndsl [options] FILE"
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: cfndsl [options] FILE'
 
   # Define the options, and what they do
   options[:output] = '-'
-  opts.on( '-o', '--output FILE', 'Write output to file' ) do |file|
+  opts.on('-o', '--output FILE', 'Write output to file') do |file|
     options[:output] = file
   end
 
   options[:extras] = []
-  opts.on( '-y', '--yaml FILE', 'Import yaml file as local variables' ) do |file|
-    options[:extras].push([:yaml,File.expand_path(file)])
+  opts.on('-y', '--yaml FILE', 'Import yaml file as local variables') do |file|
+    options[:extras].push([:yaml, File.expand_path(file)])
   end
 
-  opts.on( '-r', '--ruby FILE', 'Evaluate ruby file before template' ) do |file|
-    options[:extras].push([:ruby,File.expand_path(file)])
+  opts.on('-r', '--ruby FILE', 'Evaluate ruby file before template') do |file|
+    options[:extras].push([:ruby, File.expand_path(file)])
   end
 
-  opts.on( '-j', '--json FILE', 'Import json file as local variables' ) do |file|
-    options[:extras].push([:json,File.expand_path(file)])
+  opts.on('-j', '--json FILE', 'Import json file as local variables') do |file|
+    options[:extras].push([:json, File.expand_path(file)])
   end
 
-  opts.on( '-p', '--pretty', 'Pretty-format output JSON') do
+  opts.on('-p', '--pretty', 'Pretty-format output JSON') do
     options[:pretty] = true
   end
 
-  opts.on( '-D', '--define "VARIABLE=VALUE"', 'Directly set local VARIABLE as VALUE' ) do |file|
-    options[:extras].push([:raw,file])
+  opts.on('-D', '--define "VARIABLE=VALUE"', 'Directly set local VARIABLE as VALUE') do |file|
+    options[:extras].push([:raw, file])
   end
 
   options[:verbose] = false
-  opts.on('-v', '--verbose', "Turn on verbose ouptut") do
+  opts.on('-v', '--verbose', 'Turn on verbose ouptut') do
     options[:verbose] = true
   end
 
   # This displays the help screen, all programs are
   # assumed to have this option.
-  opts.on( '-h', '--help', 'Display this screen' ) do
+  opts.on('-h', '--help', 'Display this screen') do
     puts opts
     exit
   end
 end
 
 optparse.parse!
-unless ARGV[0] then
+unless ARGV[0]
   puts optparse.help
   exit(1)
 end
@@ -58,14 +58,14 @@ end
 filename = File.expand_path(ARGV[0])
 verbose = options[:verbose] && STDERR
 
-model = CfnDsl::eval_file_with_extras(filename, options[:extras], verbose)
+model = CfnDsl.eval_file_with_extras(filename, options[:extras], verbose)
 
 output = STDOUT
-if options[:output] != '-' then
+if options[:output] != '-'
   verbose.puts("Writing to #{options[:output]}") if verbose
-  output = File.open( File.expand_path(options[:output]), "w")
-else
-  verbose.puts("Writing to STDOUT") if verbose
+  output = File.open(File.expand_path(options[:output]), 'w')
+elsif verbose
+  verbose.puts('Writing to STDOUT')
 end
 
 output.puts options[:pretty] ? JSON.pretty_generate(model) : model.to_json

data/cfndsl.gemspec

@@ -1,21 +1,22 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cfndsl/version"
+require 'cfndsl/version'
 
 Gem::Specification.new do |s|
-  s.name                    = "cfndsl"
-  s.version                 = CfnDsl::VERSION
-  s.summary                 = "AWS Cloudformation DSL"
-  s.description             = "DSL for creating AWS Cloudformation templates"
-  s.authors                 = ["Steven Jack", "Chris Howe"]
-  s.email                   = ["stevenmajack@gmail.com", "chris@howeville.com"]
-  s.files                   = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  s.executables             << "cfndsl"
-  s.homepage                = "https://github.com/stevenjack/cfndsl"
-  s.license                 = "MIT"
-  s.test_files              = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths           = ["lib"]
+  s.name          = 'cfndsl'
+  s.version       = CfnDsl::VERSION
+  s.summary       = 'AWS Cloudformation DSL'
+  s.description   = 'DSL for creating AWS Cloudformation templates'
+  s.authors       = ['Steven Jack', 'Chris Howe']
+  s.email         = ['stevenmajack@gmail.com', 'chris@howeville.com']
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.homepage      = 'https://github.com/stevenjack/cfndsl'
+  s.license       = 'MIT'
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "bundler"
+  s.executables << 'cfndsl'
+
+  s.add_development_dependency 'bundler'
 end

data/lib/cfndsl.rb

@@ -1,70 +1,64 @@
-require 'json';
+require 'json'
 
 require 'cfndsl/module'
-require 'cfndsl/Errors'
-require 'cfndsl/RefCheck'
-require 'cfndsl/JSONable'
-require 'cfndsl/Types'
-require 'cfndsl/Properties'
-require 'cfndsl/UpdatePolicy'
-require 'cfndsl/CreationPolicy'
-require 'cfndsl/Conditions'
-require 'cfndsl/Mappings'
-require 'cfndsl/Resources'
-require 'cfndsl/Metadata'
-require 'cfndsl/Parameters'
-require 'cfndsl/Outputs'
-require 'cfndsl/CloudFormationTemplate'
+require 'cfndsl/errors'
+require 'cfndsl/ref_check'
+require 'cfndsl/jsonable'
+require 'cfndsl/properties'
+require 'cfndsl/update_policy'
+require 'cfndsl/creation_policy'
+require 'cfndsl/conditions'
+require 'cfndsl/mappings'
+require 'cfndsl/resources'
+require 'cfndsl/metadata'
+require 'cfndsl/parameters'
+require 'cfndsl/outputs'
+require 'cfndsl/aws/cloud_formation_template'
+require 'cfndsl/os/heat_template'
 
+# CfnDsl
 module CfnDsl
+  # This function handles the eval of the template file and returns the
+  # results. It does this with a ruby "eval", but it builds up a customized
+  # binding environment before it calls eval. The environment can be
+  # customized by passing a list of customizations in the extras parameter.
+  #
+  # These customizations are expressed as an array of pairs of
+  # (type,filename). They are evaluated in the order they appear in the
+  # extras array. The types are as follows
+  #
+  # :yaml - the second element is treated as a file name, which is loaded
+  #         as a yaml file. The yaml file should contain a top level
+  #         dictionary. Each of the keys of the top level dictionary is
+  #         used as a local variable in the evalation context.
+  #
+  # :json - the second element is treated as a file name, which is loaded
+  #         as a json file. The yaml file should contain a top level
+  #         dictionary. Each of the keys of the top level dictionary is
+  #         used as a local variable in the evalation context.
+  #
+  # :ruby - the second element is treated as a file name which is evaluated
+  #         as a ruby file. Any assigments (or other binding affecting
+  #         side effects) will persist into the context where the template
+  #         is evaluated
+  #
+  # :raw  - the seccond elements is treated as a ruby statement and is
+  #         evaluated in the binding context, similar to the contents of
+  #         a ruby file.
+  #
+  # Note that the order is important, as later extra sections can overwrite
+  # or even undo things that were done by earlier sections.
   def self.eval_file_with_extras(filename, extras = [], logstream = nil)
-    # This function handles the eval of the template file and returns the
-    # results. It does this with a ruby "eval", but it builds up a customized
-    # binding environment before it calls eval. The environment can be
-    # customized by passing a list of customizations in the extras parameter.
-    #
-    # These customizations are expressed as an array of pairs of
-    # (type,filename). They are evaluated in the order they appear in the
-    # extras array. The types are as follows
-    #
-    # :yaml - the second element is treated as a file name, which is loaded
-    #         as a yaml file. The yaml file should contain a top level
-    #         dictionary. Each of the keys of the top level dictionary is
-    #         used as a local variable in the evalation context.
-    #
-    # :json - the second element is treated as a file name, which is loaded
-    #         as a json file. The yaml file should contain a top level
-    #         dictionary. Each of the keys of the top level dictionary is
-    #         used as a local variable in the evalation context.
-    #
-    # :ruby - the second element is treated as a file name which is evaluated
-    #         as a ruby file. Any assigments (or other binding affecting
-    #         side effects) will persist into the context where the template
-    #         is evaluated
-    #
-    # :raw  - the seccond elements is treated as a ruby statement and is
-    #         evaluated in the binding context, similar to the contents of
-    #         a ruby file.
-    #
-    # Note that the order is important, as later extra sections can overwrite
-    # or even undo things that were done by earlier sections.
-
     b = binding
     extras.each do |pair|
-      type,file = pair
+      type, file = pair
       case type
-      when :yaml
-        logstream.puts("Loading YAML file #{file}") if logstream
-        parameters = YAML.load(File.read(file))
-        parameters.each do |k,v|
-          logstream.puts("Setting local variable #{k} to #{v}") if logstream
-          b.eval("#{k} = #{v.inspect}")
-        end
-
-      when :json
-        logstream.puts("Loading YAML file #{file}") if logstream
-        parameters = JSON.load(File.read(file))
-        parameters.each do |k,v|
+      when :yaml, :json
+        klass_name = type.to_s.upcase
+        klass = Object.const_get(klass_name)
+        logstream.puts("Loading #{klass_name} file #{file}") if logstream
+        parameters = klass.load(File.read(file))
+        parameters.each do |k, v|
           logstream.puts("Setting local variable #{k} to #{v}") if logstream
           b.eval("#{k} = #{v.inspect}")
         end
@@ -75,23 +69,24 @@ module CfnDsl
 
       when :raw
         logstream.puts("Running raw ruby code #{file}") if logstream
-        b.eval(file, "raw code")
+        b.eval(file, 'raw code')
       end
     end
 
     logstream.puts("Loading template file #{filename}") if logstream
     model = b.eval(File.read(filename), filename)
-    return model
+
+    model
   end
 end
 
 def CloudFormation(&block)
   x = CfnDsl::CloudFormationTemplate.new
   x.declare(&block)
-  invalid_references = x.checkRefs()
-  if( invalid_references ) then
+  invalid_references = x.check_refs
+  if invalid_references
     abort invalid_references.join("\n")
-  elsif( CfnDsl::Errors.errors? ) then
+  elsif CfnDsl::Errors.errors?
     abort CfnDsl::Errors.errors.join("\n")
   else
     return x
@@ -101,13 +96,12 @@ end
 def Heat(&block)
   x = CfnDsl::HeatTemplate.new
   x.declare(&block)
-  invalid_references = x.checkRefs()
-  if( invalid_references ) then
+  invalid_references = x.check_refs
+  if invalid_references
     abort invalid_references.join("\n")
-  elsif( CfnDsl::Errors.errors? ) then
+  elsif CfnDsl::Errors.errors?
     abort CfnDsl::Errors.errors.join("\n")
   else
     return x
   end
 end
-

data/lib/cfndsl/aws/cloud_formation_template.rb

@@ -0,0 +1,16 @@
+require 'cfndsl/orchestration_template'
+
+module CfnDsl
+  # Cloud Formation Templates
+  class CloudFormationTemplate < OrchestrationTemplate
+    def self.template_types
+      CfnDsl::AWS::Types::Types_Internal
+    end
+
+    def self.type_module
+      CfnDsl::AWS::Types
+    end
+
+    create_types
+  end
+end

data/lib/cfndsl/aws/types.rb

@@ -0,0 +1,12 @@
+require 'cfndsl/types'
+
+module CfnDsl
+  module AWS
+    # Cloud Formation Types
+    module Types
+      TYPE_PREFIX = 'aws'.freeze
+      class Type < JSONable; end
+      include CfnDsl::Types
+    end
+  end
+end