chemtrail 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b55d85bd6bb36bc1f6b169a3806544b9df96db28
-  data.tar.gz: 1f2537d1b31d10f54e32d3d2391d64f774939ec8
+  metadata.gz: e54ce07e90240967020fa7a8dc856b944338f78e
+  data.tar.gz: 132975f191f9df48d66606e27648852cb29a8608
 SHA512:
-  metadata.gz: 27c03f23e82d4429bee7cac5ccb464e408ba7b6a6d7d146bfde9c46557785e677509c66757162317a31bbc55926b138ea075f1e513f3ab54fb54ad4f953362d5
-  data.tar.gz: 312879ef2f152e0b9a92eaf5f28bb874065749cb20ff2808e219421da935b77b7d1767663053eab9125c0e0061a89afdc50f5f13ed097ab8bd5b5a90dd9f2806
+  metadata.gz: 0cd2a647db49fb8ecef0863955670ea9dadbec2087e68a561376fbd2c4ca5ea3e55eb883fa404a8d17e2f1b180c5dfbc12d49e42b6d1f5d87e88bdf37f541c25
+  data.tar.gz: 22f400b9b20b389bec87ba1951f374cb37cd16a5c72359c8debe4913db6d7528cd3106477fb9ea659873cee5d270d06bd9a18d757a6e6155f2dbf57a73a078d0

data/bin/chemtrail

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chemtrail"
+require "chemtrail/cli"
+Chemtrail::Cli.start

data/lib/chemtrail/class_name_inflector.rb

@@ -0,0 +1,14 @@
+class Chemtrail::ClassNameInflector
+  attr_reader :class_name
+
+  def initialize(class_name)
+    @class_name = class_name.to_s.dup
+  end
+
+  def underscore
+    class_name.gsub(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+              .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+              .gsub(/::/,':')
+              .downcase
+  end
+end

data/lib/chemtrail/cli.rb

@@ -0,0 +1,34 @@
+require "thor"
+require "json"
+
+class Chemtrail::Cli < Thor
+  default_task :list
+
+  desc "list", "Lists all available templates"
+  method_option :path, :default => File.expand_path("lib/templates")
+  def list
+    require_templates_from(options[:path])
+    Chemtrail::Template.subclass_map.keys.each { |k| Kernel.puts(k) }
+  end
+
+  desc "build TEMPLATE", "Builds the selected template"
+  method_option :path, :default => File.expand_path("lib/templates")
+  def build(template_name)
+    require_templates_from(options[:path])
+    template_class = fetch_template_class_named(template_name)
+    template_json = JSON.pretty_generate(template_class.new.to_hash)
+    Kernel.puts(template_json)
+  end
+
+  protected
+
+  def require_templates_from(path)
+    Dir.glob(File.expand_path("**/*_template.rb", path)).each { |t| require t }
+  end
+
+  def fetch_template_class_named(name)
+    template = Chemtrail::Template.subclass_map[name]
+    raise Thor::Error.new("Template #{name} does not exist") if template.nil?
+    template
+  end
+end

data/lib/chemtrail/mapping.rb

@@ -12,13 +12,7 @@ class Chemtrail::Mapping
   end
 
   def find(top_level, second_level)
-    {
-      "Fn::FindInMap" => [
-        id,
-        Chemtrail::ReferencePresenter.new(top_level).to_parameter,
-        Chemtrail::ReferencePresenter.new(second_level).to_parameter
-      ]
-    }
+    Chemtrail::Function.new("Fn::FindInMap", id, top_level, second_level).to_hash
   end
 
   def to_hash

data/lib/chemtrail/output.rb

@@ -12,11 +12,9 @@ class Chemtrail::Output
   end
 
   def description_hash
-    if description.nil?
-      {}
-    else
-      {"Description" => description}
-    end
+    hash = {}
+    hash["Description"] = description unless description.nil?
+    hash
   end
 
   def to_hash

data/lib/chemtrail/{declaration.rb → parameter.rb}

@@ -1,4 +1,4 @@
-class Chemtrail::Declaration
+class Chemtrail::Parameter
   attr_reader :id, :type
 
   def initialize(id, type, specifications = {})

data/lib/chemtrail/section_presenter.rb

@@ -0,0 +1,16 @@
+class Chemtrail::SectionPresenter
+  attr_reader :name, :entries
+
+  def initialize(name, entries)
+    @name = name
+    @entries = entries
+  end
+
+  def to_hash
+    if entries.empty?
+      {}
+    else
+      {name => entries.map(&:to_hash).reduce(Hash.new, :merge)}
+    end
+  end
+end

data/lib/chemtrail/template.rb

@@ -1,36 +1,69 @@
-require "chemtrail/section"
+require "chemtrail/section_presenter"
+require "chemtrail/class_name_inflector"
 
 class Chemtrail::Template
+  class << self
+    def subclass_map
+      @subclass_map ||= {}
+    end
+
+    def inherited(subclass)
+      subclass_map[Chemtrail::ClassNameInflector.new(subclass).underscore] = subclass
+    end
+  end
+
   attr_reader :description
 
-  def initialize(description)
+  def initialize(description = nil)
     @description = description
   end
 
   def parameters
-    @parameters ||= Chemtrail::Section.new
+    []
   end
 
   def mappings
-    @mappings ||= Chemtrail::Section.new
+    []
   end
 
   def resources
-    @resources ||= Chemtrail::Section.new
+    []
   end
 
   def outputs
-    @outputs ||= Chemtrail::Section.new
+    []
   end
 
   def to_hash
-    {
-      "AWSTemplateFormatVersion" => "2010-09-09",
-      "Description" => description,
-      "Parameters" => parameters.to_hash,
-      "Mappings" => mappings.to_hash,
-      "Resources" => resources.to_hash,
-      "Outputs" => outputs.to_hash
-    }
+    version_hash = {"AWSTemplateFormatVersion" => "2010-09-09"}
+    version_hash.merge(description_hash)
+                .merge(parameters_hash)
+                .merge(mappings_hash)
+                .merge(resources_hash)
+                .merge(outputs_hash)
+  end
+
+  protected
+
+  def description_hash
+    hash = {}
+    hash["Description"] = description unless description.nil?
+    hash
+  end
+
+  def parameters_hash
+    Chemtrail::SectionPresenter.new("Parameters", parameters).to_hash
+  end
+
+  def mappings_hash
+    Chemtrail::SectionPresenter.new("Mappings", mappings).to_hash
+  end
+
+  def resources_hash
+    Chemtrail::SectionPresenter.new("Resources", resources).to_hash
+  end
+
+  def outputs_hash
+    Chemtrail::SectionPresenter.new("Outputs", outputs).to_hash
   end
 end

data/lib/chemtrail/version.rb

@@ -1,3 +1,3 @@
 module Chemtrail
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/chemtrail.rb

@@ -1,6 +1,6 @@
 require "chemtrail/version"
 require "chemtrail/template"
-require "chemtrail/declaration"
+require "chemtrail/parameter"
 require "chemtrail/mapping"
 require "chemtrail/resource"
 require "chemtrail/output"

data/spec/lib/chemtrail/class_name_inflector_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Chemtrail::ClassNameInflector do
+  subject(:inflector) { Chemtrail::ClassNameInflector.new(class_name) }
+
+  describe "#underscore" do
+    context "with a normal name" do
+      let(:class_name) { "Tacos" }
+
+      its(:underscore) { should == "tacos" }
+    end
+
+    context "with a normal camelcase name" do
+      let(:class_name) { "ZapZap" }
+
+      its(:underscore) { should == "zap_zap" }
+    end
+
+    context "with a slightly abnormal camelcase name" do
+      let(:class_name) { "DSLAreGreat" }
+
+      its(:underscore) { should == "dsl_are_great" }
+    end
+
+    context "with a namespace" do
+      let(:class_name) { "Geese::Adorable" }
+
+      its(:underscore) { should == "geese:adorable" }
+    end
+  end
+end

data/spec/lib/chemtrail/cli_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Chemtrail::Cli do
+  subject(:cli) { Chemtrail::Cli.new }
+
+  describe "#list" do
+    it "lists available templates" do
+      Kernel.should_receive(:puts).with("tacos")
+      cli.list
+    end
+  end
+
+  describe "#build" do
+    it "builds the specified template" do
+      Kernel.should_receive(:puts).with(JSON.pretty_generate(Tacos.new.to_hash))
+      cli.build("tacos")
+    end
+
+    context "when the template does not exist" do
+      it "blows up" do
+        expect { cli.build("house of cards") }.to raise_error(Thor::Error)
+      end
+    end
+  end
+end

data/spec/lib/chemtrail/{declaration_spec.rb → parameter_spec.rb}

@@ -1,7 +1,7 @@
 require "spec_helper"
 
-describe Chemtrail::Declaration do
-  subject(:declaration) { Chemtrail::Declaration.new("parmesan", "String") }
+describe Chemtrail::Parameter do
+  subject(:parameter) { Chemtrail::Parameter.new("parmesan", "String") }
 
   describe "#specifications" do
     context "when there are no specifications" do
@@ -9,7 +9,7 @@ describe Chemtrail::Declaration do
     end
 
     context "when a specification has been passed into the initializer" do
-      subject(:declaration) { Chemtrail::Declaration.new("parmesan", "String", ok: "great") }
+      subject(:parameter) { Chemtrail::Parameter.new("parmesan", "String", ok: "great") }
 
       its(:specifications) { should == {ok: "great"} }
     end
@@ -21,12 +21,12 @@ describe Chemtrail::Declaration do
 
   describe "#to_hash" do
     its(:to_hash) { should have_key "parmesan" }
-    specify { declaration.to_hash["parmesan"].should include("Type" => "String") }
+    specify { parameter.to_hash["parmesan"].should include("Type" => "String") }
 
     context "when there is a specification" do
-      before { declaration.specifications[:ducks] = "amazing" }
+      before { parameter.specifications[:ducks] = "amazing" }
 
-      specify { declaration.to_hash["parmesan"].should include(ducks: "amazing") }
+      specify { parameter.to_hash["parmesan"].should include(ducks: "amazing") }
     end
   end
 end

data/spec/lib/chemtrail/section_presenter_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Chemtrail::SectionPresenter do
+  let(:entry) { double(:entry, to_hash: {tacos: "great"}) }
+  let(:entries) { [] }
+
+  subject(:section) { Chemtrail::SectionPresenter.new("Socks", entries) }
+
+  describe "#to_hash" do
+    context "when there are no entries" do
+      let(:entries) { [] }
+
+      its(:to_hash) { should == {} }
+    end
+
+    context "when there is an entry" do
+      let(:entries) { [entry] }
+
+      its(:to_hash) { should == {"Socks" => {tacos: "great"}} }
+    end
+  end
+end

data/spec/lib/chemtrail/template_spec.rb

@@ -6,86 +6,75 @@ describe Chemtrail::Template do
   let(:fake_parameter) { double(:parameter, to_hash: {"parameter" => "json"}) }
   let(:fake_resource) { double(:resource, to_hash: {"resource" => "json"}) }
 
-  subject(:template) { Chemtrail::Template.new("wat") }
+  subject(:template) { Chemtrail::Template.new }
 
-  describe "#parameters" do
-    context "when the template has parameters" do
-      before { template.parameters << fake_parameter }
-
-      its(:parameters) { should =~ [fake_parameter] }
-    end
-
-    context "when the template does not have parameters" do
-      its(:parameters) { should be_empty }
-    end
-  end
-
-  describe "#mappings" do
-    context "when the template has mappings" do
-      before { template.mappings << fake_mapping }
-
-      its(:mappings) { should == [fake_mapping] }
-    end
-
-    context "when the template does not have mappings" do
-      its(:mappings) { should be_empty }
-    end
-  end
-
-  describe "#resources" do
-    context "when the template has resources" do
-      before { template.resources << fake_resource }
-
-      its(:resources) { should == [fake_resource] }
-    end
+  describe "#to_hash" do
+    its(:to_hash) { should include("AWSTemplateFormatVersion" => "2010-09-09") }
+    its(:to_hash) { should_not have_key "Parameters" }
+    its(:to_hash) { should_not have_key "Mappings" }
+    its(:to_hash) { should_not have_key "Resources" }
+    its(:to_hash) { should_not have_key "Outputs" }
 
-    context "when the template does not have resources" do
-      its(:resources) { should be_empty }
+    context "when the description is not set" do
+      its(:to_hash) { should_not have_key "Description" }
     end
-  end
 
-  describe "#outputs" do
-    context "when the template has outputs" do
-      before { template.outputs << fake_output }
-
-      its(:outputs) { should == [fake_output] }
-    end
+    context "when the description is set" do
+      subject(:template) { Chemtrail::Template.new("super great") }
 
-    context "when the template does not have outputs" do
-      its(:outputs) { should be_empty }
+      its(:to_hash) { should include("Description" => "super great") }
     end
-  end
-
-  describe "#to_hash" do
-    its(:to_hash) { should include("AWSTemplateFormatVersion" => "2010-09-09") }
-    its(:to_hash) { should include("Description" => "wat") }
-    its(:to_hash) { should have_key "Parameters" }
-    its(:to_hash) { should have_key "Mappings" }
-    its(:to_hash) { should have_key "Resources" }
-    its(:to_hash) { should have_key "Outputs" }
 
     context "when the template has parameters" do
-      before { template.parameters << fake_parameter }
+      before { template.stub(parameters: [fake_parameter]) }
 
       its(:to_hash) { should include("Parameters" => {"parameter" => "json"}) }
     end
 
     context "when the template has mappings" do
-      before { template.mappings << fake_mapping }
+      before { template.stub(mappings: [fake_mapping]) }
 
       its(:to_hash) { should include("Mappings" => {"mapping" => "json"}) }
     end
 
     context "when the template has resources" do
-      before { template.resources << fake_resource }
+      before { template.stub(resources: [fake_resource]) }
 
       its(:to_hash) { should include("Resources" => {"resource" => "json"}) }
     end
 
     context "when the template has outputs" do
-      before { template.outputs << fake_output }
+      before { template.stub(outputs: [fake_output]) }
 
       its(:to_hash) { should include("Outputs" => {"output" => "json"}) }
     end
   end
+
+  describe ".inherited" do
+    before { Chemtrail::Template.stub(subclass_map: {}) }
+
+    it "adds subclasses to the template map" do
+      expect {
+        Chemtrail::Template.send(:inherited, Object)
+      }.to change {
+        Chemtrail::Template.subclass_map
+      }.from({}).to("object" => Object)
+    end
+
+    it "adds namespaced subclasses to the template map" do
+      expect {
+        Chemtrail::Template.send(:inherited, Chemtrail::Template)
+      }.to change {
+        Chemtrail::Template.subclass_map
+      }.from({}).to("chemtrail:template" => Chemtrail::Template)
+    end
+
+    it "adds camelcased subclasses to the template map as snakecase" do
+      expect {
+        Chemtrail::Template.send(:inherited, Chemtrail::PropertyList)
+      }.to change {
+        Chemtrail::Template.subclass_map
+      }.from({}).to("chemtrail:property_list" => Chemtrail::PropertyList)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
 require "chemtrail"
+require "chemtrail/cli"
+
+Dir.glob(File.expand_path("../support/**/*.rb", __FILE__)).each { |f| require f }
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/support/fixtures/fixture_template.rb

@@ -0,0 +1,2 @@
+class Tacos < Chemtrail::Template
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chemtrail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Doc Ritezel
@@ -83,7 +83,8 @@ dependencies:
 description: Seed your CloudFormation stack
 email:
 - pair+doc@ministryofvelocity.com
-executables: []
+executables:
+- chemtrail
 extensions: []
 extra_rdoc_files: []
 files:
@@ -96,29 +97,35 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
+- bin/chemtrail
 - chemtrail.gemspec
 - lib/chemtrail.rb
-- lib/chemtrail/declaration.rb
+- lib/chemtrail/class_name_inflector.rb
+- lib/chemtrail/cli.rb
 - lib/chemtrail/function.rb
 - lib/chemtrail/mapping.rb
 - lib/chemtrail/output.rb
+- lib/chemtrail/parameter.rb
 - lib/chemtrail/property_list.rb
 - lib/chemtrail/reference_presenter.rb
 - lib/chemtrail/resource.rb
-- lib/chemtrail/section.rb
+- lib/chemtrail/section_presenter.rb
 - lib/chemtrail/template.rb
 - lib/chemtrail/version.rb
 - script/ci.sh
-- spec/lib/chemtrail/declaration_spec.rb
+- spec/lib/chemtrail/class_name_inflector_spec.rb
+- spec/lib/chemtrail/cli_spec.rb
 - spec/lib/chemtrail/function_spec.rb
 - spec/lib/chemtrail/mapping_spec.rb
 - spec/lib/chemtrail/output_spec.rb
+- spec/lib/chemtrail/parameter_spec.rb
 - spec/lib/chemtrail/property_list_spec.rb
 - spec/lib/chemtrail/reference_presenter_spec.rb
 - spec/lib/chemtrail/resource_spec.rb
-- spec/lib/chemtrail/section_spec.rb
+- spec/lib/chemtrail/section_presenter_spec.rb
 - spec/lib/chemtrail/template_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/fixture_template.rb
 homepage: https://github.com/minifast/chemtrail
 licenses:
 - MIT
@@ -144,13 +151,16 @@ signing_key:
 specification_version: 4
 summary: Build, create and maintain your CloudFormation stack
 test_files:
-- spec/lib/chemtrail/declaration_spec.rb
+- spec/lib/chemtrail/class_name_inflector_spec.rb
+- spec/lib/chemtrail/cli_spec.rb
 - spec/lib/chemtrail/function_spec.rb
 - spec/lib/chemtrail/mapping_spec.rb
 - spec/lib/chemtrail/output_spec.rb
+- spec/lib/chemtrail/parameter_spec.rb
 - spec/lib/chemtrail/property_list_spec.rb
 - spec/lib/chemtrail/reference_presenter_spec.rb
 - spec/lib/chemtrail/resource_spec.rb
-- spec/lib/chemtrail/section_spec.rb
+- spec/lib/chemtrail/section_presenter_spec.rb
 - spec/lib/chemtrail/template_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/fixture_template.rb

data/lib/chemtrail/section.rb

@@ -1,5 +0,0 @@
-class Chemtrail::Section < Array
-  def to_hash
-    map(&:to_hash).reduce(Hash.new, :merge)
-  end
-end

data/spec/lib/chemtrail/section_spec.rb

@@ -1,13 +0,0 @@
-require "spec_helper"
-
-describe Chemtrail::Section do
-  let(:entry) { double(:entry, to_hash: {tacos: "great"}) }
-
-  subject(:section) { Chemtrail::Section.new }
-
-  describe "#to_hash" do
-    before { section << entry }
-
-    its(:to_hash) { should == {tacos: "great"} }
-  end
-end