vagrant-config_builder 0.2.0 → 0.3.0

data/CHANGELOG

@@ -1,6 +1,23 @@
 CHANGELOG
 =========
 
+0.3.0
+-----
+
+This is a backwards compatible bugfix and feature release
+
+### User notes
+
+#### Enhancements
+
+  * (GH-6) New filter: `boxes`
+  * box_url is now a supported vm attribute
+
+#### Bugfixes
+
+  * Better error handling when no configuration is set
+  * Add missing variable when raising ClassRegistry::DuplicateEntry error
+
 0.2.0
 -----
 

data/lib/config_builder/class_registry.rb

@@ -29,6 +29,7 @@ module ConfigBuilder
     def register(identifier, klass)
       if @klasses[identifier]
         raise DuplicateEntry, :registry => @name,
+                              :identifier => identifier.inspect,
                               :identifiers => @klasses.keys
       else
         @klasses[identifier] = klass

data/lib/config_builder/filter.rb

@@ -1,5 +1,6 @@
 module ConfigBuilder
   module Filter
     require 'config_builder/filter/roles'
+    require 'config_builder/filter/boxes'
   end
 end

data/lib/config_builder/filter/boxes.rb

@@ -0,0 +1,22 @@
+class ConfigBuilder::Filter::Boxes
+
+  attr_reader :boxes
+
+  def set_config(root_config)
+    @root_config = root_config
+    @boxes       = (@root_config.delete('boxes') || {})
+  end
+
+  def run
+    return @root_config if @root_config['vms'].nil?
+
+    @root_config['vms'].each { |vm_hash| filter_vm(vm_hash) }
+    @root_config
+  end
+
+  def filter_vm(vm_hash)
+    if (box_name = vm_hash['box'])
+      vm_hash['box_url'] ||= @boxes[box_name]
+    end
+  end
+end

data/lib/config_builder/filter/roles.rb

@@ -12,7 +12,7 @@
 # the order of declaration of roles does not matter.
 #
 # @example
-#   >> hash_config
+#   >> run()
 #   =>  {
 #         'roles' => {
 #           'webserver' => {
@@ -37,19 +37,29 @@
 #
 class ConfigBuilder::Filter::Roles
 
-  def run(hash_config)
-    @roles = hash_config.delete('roles')
+  # @!attribute [r] roles
+  #   @return [Hash<String, Object>]
+  attr_reader :roles
 
-    hash_config['vms'].map! { |vm_hash| filter_vm(vm_hash) }
-
-    hash_config
+  def set_config(root_config)
+    @root_config = root_config
+    @roles       = @root_config.delete('roles')
+    @vms         = @root_config.delete('vms')
   end
 
-  private
+  def run
+    return @root_config if @vms.nil?
 
+    @root_config['vms'] = @vms.map { |vm_hash| filter_vm(vm_hash) }
+    @root_config
+  end
+
+  # @param vm_hash [Hash]
+  #
+  # @return [Hash] The filtered VM
   def filter_vm(old_vm)
     role_list  = old_vm.delete('roles')
-    node_stack = roles_for_vm(role_list)
+    node_stack = roles_by_name(role_list)
 
     node_stack << old_vm
 
@@ -60,25 +70,45 @@ class ConfigBuilder::Filter::Roles
     new_vm
   end
 
+  # Fetch the role associated with the given name
+  #
+  # @param role_name [String]
+  #
+  # @return [Hash<String, Object>]
+  def role(name)
+    if (retval = @roles[name])
+      retval
+    else
+      raise ArgumentError, "Requested role #{name.inspect} is not defined, available roles: #{@roles.keys}."
+    end
+  end
+
+  # @overload roles_by_name(name)
+  #   @param name [String] A single role name
+  #   @return [Array<Hash>] An array containing the requested role
+  #
+  # @overload roles_by_name(names)
+  #   @param names [Array<String>] A list of role names
+  #   @return [Array<Hash>] An array containing all of the requested roles in the
+  #                         order requested.
+  #
+  # @overload roles_by_name(nothing)
+  #   @param nothing [NilClass] nil
+  #   @return [Array<>] An empty array
+  #
   # @return [Array]
-  def roles_for_vm(role_field)
+  def roles_by_name(field)
 
-    case role_field
-    when Array    then names = role_field
-    when String   then names = [role_field]
+    case field
+    when Array    then names = field
+    when String   then names = [field]
     when NilClass then names = []
     end
 
-    names.map { |name| role_definition(name) }
+    names.map { |name| role(name) }
   end
 
-  def role_definition(name)
-    if (defn = @roles[name])
-      defn
-    else
-      raise "Couldn't find role named #{name.inspect} in roles #{@roles.keys.inspect}"
-    end
-  end
+  private
 
   # Merge two node hash structures, with values in `right` overwriting values
   # in `left`.

data/lib/config_builder/filter_stack.rb

@@ -13,18 +13,24 @@ module ConfigBuilder
     def filter(input)
       set_filters(input.delete(:filters))
 
-      @filter_stack.inject(input) do |current_input, filter|
-        filter.run(current_input)
+      output = @filter_stack.inject(input) do |current_input, filter|
+        filter.set_config(current_input)
+        filter.run
       end
+
+      output
     end
 
     private
 
+    # @note The implementation of this method is not final, use at your own peril.
+    # @api private
     def set_filters(list)
       if list.nil?
         @filter_stack << ConfigBuilder::Filter::Roles.new
+        @filter_stack << ConfigBuilder::Filter::Boxes.new
       else
-        raise NotImplementedError, "Custom lists of filters not implemented."
+        @filter_stack = list
       end
     end
   end

data/lib/config_builder/loader/yaml.rb

@@ -13,7 +13,12 @@ class ConfigBuilder::Loader::YAML
     rv = {}
     Dir.glob(glob_path).each do |file|
       contents = ::YAML.load_file(file)
-      rv.merge!(contents)
+
+      if contents.is_a? Hash
+        rv.merge! contents
+      else
+        # TODO warn on non-hash YAML
+      end
     end
 
     rv

data/lib/config_builder/model/vm.rb

@@ -66,6 +66,10 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
   #   @return [String] The name of the Vagrant box to instantiate for this VM
   def_model_attribute :box
 
+  # @!attribute [rw] box_url
+  #   @return [String] The source URL for the Vagrant box associated with this VM
+  def_model_attribute :box
+
   # @!attribute [rw] name
   #   @return [String] The name of the instantiated box in this environment
   def_model_attribute :name
@@ -89,6 +93,7 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
         vm_config = config.vm
 
         vm_config.box = attr(:box) if defined? attr(:box)
+        vm_config.box_url = attr(:box_url) if defined? attr(:box_url)
         vm_config.hostname = attr(:hostname) if defined? attr(:hostname)
 
         eval_models(vm_config)

data/lib/config_builder/version.rb

@@ -1,3 +1,3 @@
 module ConfigBuilder
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/config_builder/filter/boxes_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe ConfigBuilder::Filter::Boxes do
+
+  def dup(o)
+    Marshal.load(Marshal.dump(o))
+  end
+
+  let(:boxes) do
+    {
+      'first_box'  => 'http://box_host/first_box.box',
+      'second_box' => 'http://box_host/second_box.box',
+      'third_box'  => 'http://box_host/third_box.box',
+    }
+  end
+
+  let(:vms) do
+    [
+      {'name' => 'one',  'box'  => 'first_box'},
+      {'name' => 'two',  'box'  => 'second_box'},
+      {'name' => 'four', 'box'  => 'fourth_box'},
+      {
+        'name'    => 'five',
+        'box'     => 'fifth_box',
+        'box_url' => 'https://another_box_host/fifth_box.box',
+      },
+    ]
+  end
+
+  describe 'without a boxes key' do
+    let(:config) do
+      {
+        'vms' => vms,
+      }
+    end
+
+    before { subject.set_config(config) }
+
+    it "doesn't modify any boxes" do
+      input = dup(config)
+      output = subject.run
+      expect(output).to eq config
+    end
+  end
+
+  describe 'when the boxes key is given' do
+    let(:config) do
+      {
+        'boxes' => boxes,
+        'vms'   => vms,
+      }
+    end
+
+    before { subject.set_config(config) }
+
+    it "removes the 'boxes' key" do
+      output = subject.run
+      expect(output).to_not have_key 'boxes'
+    end
+
+    it "adds the 'box_url' to VMs whose 'box' value is in the 'boxes' list" do
+      output = subject.run
+      vms    = output['vms']
+
+      expect(vms[0]['box_url']).to eq 'http://box_host/first_box.box'
+      expect(vms[1]['box_url']).to eq 'http://box_host/second_box.box'
+    end
+
+    describe "if the VM 'box' value doesn't have a match in the box list" do
+      it "doesn't modify the 'box_url'" do
+        output = subject.run
+        vms    = output['vms']
+
+        expect(vms[2]['box_url']).to be_nil
+      end
+    end
+
+    describe "if the VM 'box_url' is already set" do
+      it "doesn't modify the 'box_url'" do
+        output = subject.run
+        vms    = output['vms']
+
+        expect(vms[3]['box_url']).to eq 'https://another_box_host/fifth_box.box'
+      end
+    end
+  end
+end

data/spec/config_builder/filter/roles_spec.rb

@@ -53,9 +53,13 @@ describe ConfigBuilder::Filter::Roles do
       {'vms' => vms}
     end
 
+    before do
+      subject.set_config(dup(config))
+    end
+
     it "doesn't alter the structure" do
       input  = dup(config)
-      output = subject.run(input)
+      output = subject.run
 
       expect(output).to eq config
     end
@@ -69,8 +73,12 @@ describe ConfigBuilder::Filter::Roles do
       }
     end
 
+    before do
+      subject.set_config(dup(config))
+    end
+
     it 'strips out the roles key' do
-      output = subject.run(config)
+      output = subject.run
       expect(output).to_not have_key 'roles'
     end
   end
@@ -85,9 +93,12 @@ describe ConfigBuilder::Filter::Roles do
       }
     end
 
+    before do
+      subject.set_config(dup(config))
+    end
+
     it "doesn't alter the vm" do
-      input  = dup(config)
-      output = subject.run(input)
+      output = subject.run
       expect(output['vms']).to eq vms
     end
   end
@@ -103,8 +114,12 @@ describe ConfigBuilder::Filter::Roles do
         }
       end
 
+      before do
+        subject.set_config(dup(config))
+      end
+
       let(:filtered_vm) do
-        output = subject.run(config)
+        output = subject.run
         output['vms'][0]
       end
 
@@ -137,8 +152,12 @@ describe ConfigBuilder::Filter::Roles do
         }
       end
 
+      before do
+        subject.set_config(dup(config))
+      end
+
       let(:filtered_vm) do
-        output = subject.run(config)
+        output = subject.run
         output['vms'][0]
       end
 
@@ -180,8 +199,12 @@ describe ConfigBuilder::Filter::Roles do
       }
     end
 
+    before do
+      subject.set_config(dup(config))
+      end
+
     let(:filtered_vms) do
-      output = subject.run(config)
+      output = subject.run
       output['vms']
     end
 
@@ -237,8 +260,12 @@ describe ConfigBuilder::Filter::Roles do
         'roles' => {'yep' => {'box' => 'moxxi'}}
       }
 
+      before do
+        subject.set_config(dup(config))
+      end
+
       it 'raises an error' do
-        expect { subject.run(config) }.to raise_error, /Couldn't find role named .*nope.*/
+        expect { subject.run }.to raise_error, /Couldn't find role named .*nope.*/
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-config_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,6 +44,7 @@ files:
 - lib/config_builder/class_registry.rb
 - lib/config_builder/extension_handler.rb
 - lib/config_builder/filter.rb
+- lib/config_builder/filter/boxes.rb
 - lib/config_builder/filter/roles.rb
 - lib/config_builder/filter_stack.rb
 - lib/config_builder/loader.rb
@@ -65,6 +66,7 @@ files:
 - lib/config_builder/runner.rb
 - lib/config_builder/version.rb
 - lib/vagrant-config_builder.rb
+- spec/config_builder/filter/boxes_spec.rb
 - spec/config_builder/filter/roles_spec.rb
 - spec/spec_helper.rb
 - templates/locales/en.yml