shadow_puppet 0.3.3 → 0.4.0.beta1

data/IsolateScenarios

@@ -0,0 +1,10 @@
+baseline do
+  gem 'rspec', '~> 1.3.0'
+end
+
+gem_version_scenario 'activesupport',
+  '3.0.0.rc',
+  '3.0.0.beta4',
+  '2.2.3',
+  '2.3.5',
+  '2.3.8'

data/README.rdoc

@@ -9,3 +9,10 @@ ShadowPuppet::Manifest.
 
 A binary[http://railsmachine.github.com/shadow_puppet/files/bin/shadow_puppet.html] is provided to parse and execute a
 ShadowPuppet::Manifest.
+
+== Running the Test Suite
+
+    $ gem install rspec isolate-scenarios
+    $ rake spec
+    # To test against all supported versions of ActiveSupport:
+    $ isolate-scenarios rake spec

data/Rakefile

@@ -8,9 +8,9 @@ Jeweler::Tasks.new do |gem|
   gem.email = "jesse@railsmachine.com"
   gem.homepage = "http://railsmachine.github.com/shadow_puppet"
   gem.rubyforge_project = "moonshine"
-  gem.authors = ["Jesse Newland", "Josh Nichols"]
+  gem.authors = ["Jesse Newland", "Josh Nichols", "Eric Lindvall", "Lee Jones", "dreamcat4", "Patrick Schless", "Ches Martin", "Rob Lingle", "Scott Fleckenstein"]
 
-  gem.version = "0.3.3"
+  gem.version = "0.4.0.beta1"
 
   gem.add_dependency('puppet', ["= 0.24.8"])
   gem.add_dependency('facter', [">= 1.5.4"])
@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.rdoc_options << '--inline-source' << '--webcvs=http://github.com/railsmachine/shadow_puppet/tree/master/'
 
   gem.add_development_dependency "rspec", ">= 0"
+  gem.add_development_dependency "isolate-scenarios", ">= 0"
 
   # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
 end

data/bin/shadow_puppet

@@ -29,84 +29,121 @@
 #ShadowPuppet::Manifest. An instance of this class is created, and the
 #<tt>execute</tt> method is called. All output is printed to the console.
 
-begin
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
 
+begin
   require 'optparse'
+
+  ShadowPuppetOptions = Struct.new(:graph, :noop)
+  options = ShadowPuppetOptions.new
+
   opts = OptionParser.new do |opts|
-    opts.banner = <<-EOF
-    NAME
-      Shadow Puppet
+    opts.banner = "Usage: shadow_puppet [options] <manifest>"
+
+    opts.separator ""
+    opts.separator "Specific options:"
+
+    opts.on("--tutorial", "A simple tutorial for usage") do
+      puts unindent(<<-EOF)
+        NAME
+          Shadow Puppet
+
+        AUTHOR
+          Jesse Newland
+          jesse@railsmachine.com
+
+        DESCRIPTION
+          A Ruby DSL for puppet
+
+        EXAMPLES
+          Sample manifest:
 
-    AUTHOR
-      Jesse Newland
-      jesse@railsmachine.com
+            # foo.rb
+            class Foo < ShadowPuppet::Manifest
+              recipe :foo
 
-    DESCRIPTION
-      A Ruby DSL for puppet
+              def foo
+                exec :foo, :command => 'echo "foo" > /tmp/foo.txt'
+                file '/tmp/example.txt', :ensure => :present, :content => Facter.to_hash.inspect
+              end
+            end
 
-    EXAMPLES
-      Sample manifest:
+          Executing this manifest:
 
-        #foo.rb
-        class Foo < ShadowPuppet::Manifest
-          recipe :foo
+            $ shadow_puppet foo.rb
+            notice: /shadow_puppet:19861340/Exec[foo]/returns: executed successfully
+            $
 
-          def foo
-            exec :foo, :command => 'echo "foo" > /tmp/foo.txt'
-            file '/tmp/example.txt', :ensure => :present, :content => Facter.to_hash.inspect
-          end
-        end
+          The shadow_puppet binary parses the given ruby code, which is
+          expected to contain a class named Foo that inherits from
+          ShadowPuppet::Manifest. An instance of this class is created, and the
+          execute method is called. All output is printed to the console.
+      EOF
 
-      Executing this manifest:
+      exit(1)
+    end
 
-        $ shadow_puppet foo.rb
-        notice: /shadow_puppet:19861340/Exec[foo]/returns: executed successfully
-        $
+    opts.on("-g", "--graph=[FILE]", "File to write graph .dot to") do |graph|
+      options.graph = graph
+    end
 
-      The shadow_puppet binary parses the given ruby code, which is
-      expected to contain a class named Foo that inherits from
-      ShadowPuppet::Manifest. An instance of this class is created, and the
-      execute method is called. All output is printed to the console.
-  EOF
+    opts.on("-n", "--noop", "Run in a no-op or dry-run mode") do
+      options.noop = true
+    end
 
+    opts.on_tail("-h", "--help", "Show this message") do
+      puts opts
+      exit
+    end
   end
 
   opts.parse!
 
-  require 'rubygems'
-
-  # hack around absurd number of deprecation warnings from puppet
-  # using `metaclass`
-  require 'active_support/core_ext/module/attribute_accessors'
-  require 'active_support/core_ext/kernel/reporting'
-  require 'active_support/deprecation'
-  ActiveSupport::Deprecation.silenced = true
-
-  require 'shadow_puppet'
-  require 'active_support/inflector'
-  require 'active_support/core_ext/string/inflections'
-  unless String.included_modules.include?(ActiveSupport::CoreExtensions::String::Inflections)
-    String.send :include, ActiveSupport::CoreExtensions::String::Inflections
+  unless filename = ARGV[0]
+    puts "Error: Manifest filename must be provided\n\n"
+    puts opts
+    exit(1)
+    # Take any variables set on the command line and update ENV
+    ARGV.delete_if do |arg|
+      next unless arg =~ /^(\w+)=(.*)$/
+      ENV[$1] = $2
+    end
   end
+
+  require 'rubygems'
+  require 'shadow_puppet/core_ext'
   require 'fileutils'
 
-  filename = ARGV[0]
-  raise ArgumentError unless filename
+  if options.noop
+    Puppet[:noop] = true
+    Puppet[:show_diff] = true
+  end
 
   klass = File.basename(filename, ".rb")
   require filename
-  manifest = klass.classify.constantize.new
-  manifest.execute! && exit(0)
+  manifest = klass.camelize.constantize.new
+
+  if options.graph
+    manifest.graph_to(klass.classify, options.graph)
+  else
+    if manifest.execute!
+      exit(0)
+    else
+      exit(1)
+    end
+  end
+
 rescue Errno::EACCES
   puts "Please run shadow_puppet as root"
 rescue Exception => e
   if e.instance_of?(SystemExit)
     raise
   else
-    puts 'Uncaught exception'
-    puts e.class
-    puts e.message
-    puts e.backtrace.join("\n")
+    puts "Uncaught exception: #{e.class}: #{e.message}"
+    puts "\t#{e.backtrace.join("\n\t")}"
     exit(1)
   end
 end

data/lib/shadow_puppet/core_ext.rb

@@ -1,29 +1,35 @@
 require 'active_support/version'
-
 require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/array'
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/inflector'
 require 'active_support/core_ext/class/inheritable_attributes'
 
+# zomg epic hax
 if ActiveSupport::VERSION::MAJOR < 3
+  if ActiveSupport::VERSION::TINY > 5
+    # hack around absurd number of deprecation warnings from puppet
+    # using `metaclass`
+    require 'active_support/core_ext/kernel/reporting'
+    require 'active_support/core_ext/module/attribute_accessors'
+    require 'active_support/deprecation'
+    ActiveSupport::Deprecation.silenced = true
+  end
+  require 'active_support/core_ext/string/inflections'
+  unless String.included_modules.include?(ActiveSupport::CoreExtensions::String::Inflections)
+    String.send :include, ActiveSupport::CoreExtensions::String::Inflections
+  end
   require 'active_support/core_ext/duplicable'
+  class Hash #:nodoc:
+    include ActiveSupport::CoreExtensions::Hash::DeepMerge
+    include ActiveSupport::CoreExtensions::Hash::IndifferentAccess
+  end
 else
   require 'active_support/core_ext/object/duplicable'
 end
 
 class Hash #:nodoc:
-  def deep_merge(other_hash)
-    self.merge(other_hash) do |key, oldval, newval|
-      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
-      newval = newval.to_hash if newval.respond_to?(:to_hash)
-      oldval.is_a?(Hash) && newval.is_a?(Hash) ? oldval.deep_merge(newval) : newval
-    end
-  end
-
-  def deep_merge!(other_hash)
-    replace(deep_merge(other_hash))
-  end
-  
   def deep_symbolize_keys
     self.inject({}) { |result, (key, value)|
       value = value.deep_symbolize_keys if value.is_a?(Hash)

data/lib/shadow_puppet/manifest.rb

@@ -119,7 +119,18 @@ module ShadowPuppet
       end
     end
 
-    # A hash describing any configuration that has been
+    # Access to a recipe of the class of this instance.
+    #
+    #   class SampleManifest < ShadowPuppet::Manifest
+    #     def my_recipe
+    #       recipe :other_recipe
+    #     end
+    #   end
+    def recipe(*methods)
+      self.class.recipe *methods
+    end
+
+    # A HashWithIndifferentAccess describing any configuration that has been
     # performed on the class. Modify this hash by calling configure:
     #
     #   class SampleManifest < ShadowPuppet::Manifest
@@ -128,13 +139,11 @@ module ShadowPuppet
     #
     #   >> SampleManifest.configuration
     #   => {:name => 'test'}
-    #
-    # All keys on this hash are coerced into symbols for ease of access.
-    #
+    #    #
     # Subclasses of the Manifest class properly inherit the parent classes'
     # configuration.
     def self.configuration
-      __config__.deep_symbolize_keys
+      __config__.with_indifferent_access
     end
 
     # Access to the configuration of the class of this instance.
@@ -160,13 +169,11 @@ module ShadowPuppet
     #
     #   >> SampleManifest.configuration
     #   => {:name => 'test'}
-    #
-    # All keys on this hash are coerced into symbols for ease of access.
-    #
+    #    #
     # Subsequent calls to configure perform a deep_merge of the provided
     # <tt>hash</tt> into the pre-existing configuration.
     def self.configure(hash)
-      __config__.deep_merge!(hash)
+      __config__.replace(__config__.deep_symbolize_keys.deep_merge(hash.deep_symbolize_keys))
     end
 
     # Update the configuration of this manifest instance's class.
@@ -258,6 +265,27 @@ module ShadowPuppet
       @executed = true
     end
 
+    def graph_to(name, destination)
+      evaluate_recipes
+
+      bucket             = export()
+      catalog            = bucket.to_catalog
+      relationship_graph = catalog.relationship_graph
+
+      graph = relationship_graph.to_dot_graph("name" => "#{name} Relationships".gsub(/\W+/, '_'))
+      graph.options['label'] = "#{name} Relationships"
+
+      # The graph ends up having all of the edges backwards
+      graph.each_node do |node|
+        next unless node.is_a?(DOT::DOTEdge)
+        node.to, node.from = node.from, node.to
+      end
+
+      File.open(destination, "w") { |f|
+          f.puts graph.to_s
+      }
+    end
+
     protected
 
     #Has this manifest instance been executed?

data/shadow_puppet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shadow_puppet}
-  s.version = "0.3.3"
+  s.version = "0.4.0.beta1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jesse Newland", "Josh Nichols"]
-  s.date = %q{2010-06-29}
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jesse Newland", "Josh Nichols", "Eric Lindvall", "Lee Jones", "dreamcat4", "Patrick Schless", "Ches Martin", "Rob Lingle", "Scott Fleckenstein"]
+  s.date = %q{2010-08-18}
   s.default_executable = %q{shadow_puppet}
   s.description = %q{A Ruby Puppet DSL}
   s.email = %q{jesse@railsmachine.com}
@@ -21,12 +21,12 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      ".gitmodules",
+     "IsolateScenarios",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "bin/shadow_puppet",
      "examples/foo.rb",
-     "ginger_scenarios.rb",
      "lib/shadow_puppet.rb",
      "lib/shadow_puppet/core_ext.rb",
      "lib/shadow_puppet/manifest.rb",
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8", "--inline-source", "--webcvs=http://github.com/railsmachine/shadow_puppet/tree/master/"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{moonshine}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby Puppet DSL}
   s.test_files = [
     "spec/fixtures/manifests.rb",
@@ -58,13 +58,14 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<puppet>, ["= 0.24.8"])
       s.add_runtime_dependency(%q<facter>, [">= 1.5.4"])
       s.add_runtime_dependency(%q<highline>, [">= 1.5.0"])
       s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.0.0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<isolate-scenarios>, [">= 0"])
     else
       s.add_dependency(%q<puppet>, ["= 0.24.8"])
       s.add_dependency(%q<facter>, [">= 1.5.4"])
@@ -72,6 +73,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<builder>, [">= 2.1.2"])
       s.add_dependency(%q<activesupport>, [">= 2.0.0"])
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<isolate-scenarios>, [">= 0"])
     end
   else
     s.add_dependency(%q<puppet>, ["= 0.24.8"])
@@ -80,6 +82,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<builder>, [">= 2.1.2"])
     s.add_dependency(%q<activesupport>, [">= 2.0.0"])
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<isolate-scenarios>, [">= 0"])
   end
 end
 

data/spec/fixtures/manifests.rb

@@ -16,7 +16,7 @@ end
 class RequiresMetViaMethods < ShadowPuppet::Manifest
   recipe :foo, :bar
 
-  configure({ :foo => :bar , :nested_hash => { :nested_foo => :bar } })
+  configure({ :foo => :bar , :nested_hash => { :nested_foo => :bar }, 'string' => 'value' })
 
   def foo
     exec('foo', :command => 'true')
@@ -37,6 +37,18 @@ class RequiresMetViaMethodsSubclass < RequiresMetViaMethods
   end
 end
 
+# Requirements can be handled by other recipes in the class
+class RequiresMetViaRecipeFromClassOfInstance < ShadowPuppet::Manifest
+  def bar
+    # other recipe stuff
+  end
+  
+  def foo
+    recipe :bar
+  end
+  recipe :foo
+end
+
 #requirements can also be handled by functions in external modules
 class ProvidedViaModules < ShadowPuppet::Manifest
   module FooRecipe
@@ -92,4 +104,4 @@ class TestHelpers < ShadowPuppet::Manifest
     file('baz', :content => 'bar',:mode => '644',:owner => 'rails')
   end
 
-end
+end

data/spec/manifest_spec.rb

@@ -94,6 +94,17 @@ describe "A manifest" do
       @manifest.configuration[:foo].should == :bar
     end
 
+    it "can access configurations configured using symbols with symbols or strings" do
+      @manifest.configuration[:foo].should == :bar
+      @manifest.configuration['foo'].should == :bar
+    end
+
+
+    it "can access configurations configured using strings with symbols or strings" do
+      @manifest.configuration['string'].should == 'value'
+      @manifest.configuration[:string].should == 'value'
+    end
+
     it "has a name" do
       @manifest.name.should == "#{@manifest.class}##{@manifest.object_id}"
     end
@@ -188,6 +199,7 @@ describe "A manifest" do
     it "deep_merges it's configuration with that of the parent" do
       @manifest.class.configuration[:nested_hash][:nested_baz].should == :bar
       @manifest.class.configuration[:nested_hash][:nested_foo].should == :bar
+      @manifest.class.configuration['nested_hash']['nested_foo'].should == :bar
     end
 
     it "is able to add configuration parameters on the instance" do
@@ -197,5 +209,13 @@ describe "A manifest" do
     end
 
   end
+  describe "that has recipes called from other recipes" do
+    before(:each) do
+      @manifest = RequiresMetViaRecipeFromClassOfInstance.new
+    end
 
-end
+    it "is able to call a recipe of the class of this instance" do
+      @manifest.execute.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 require 'rubygems'
-require 'ginger'
+require 'isolate/scenarios/now'
 gem 'rspec'
 require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'shadow_puppet', 'core_ext.rb')
 require File.join(File.dirname(__FILE__), '..', 'lib', 'shadow_puppet.rb')
 require File.join(File.dirname(__FILE__), '..', 'lib', 'shadow_puppet', 'test.rb')
 Dir.glob(File.join(File.dirname(__FILE__), 'fixtures', '*.rb')).each do |manifest|

metadata

@@ -1,30 +1,41 @@
 --- !ruby/object:Gem::Specification 
 name: shadow_puppet
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: -1848230035
+  prerelease: true
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  - beta1
+  version: 0.4.0.beta1
 platform: ruby
 authors: 
 - Jesse Newland
 - Josh Nichols
+- Eric Lindvall
+- Lee Jones
+- dreamcat4
+- Patrick Schless
+- Ches Martin
+- Rob Lingle
+- Scott Fleckenstein
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-06-29 00:00:00 -04:00
+date: 2010-08-18 00:00:00 -04:00
 default_executable: shadow_puppet
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: puppet
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 111
         segments: 
         - 0
         - 24
@@ -36,9 +47,11 @@ dependencies:
   name: facter
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
         - 5
@@ -50,9 +63,11 @@ dependencies:
   name: highline
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 1
         - 5
@@ -64,9 +79,11 @@ dependencies:
   name: builder
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 1
@@ -78,9 +95,11 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 0
@@ -92,14 +111,30 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: isolate-scenarios
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: A Ruby Puppet DSL
 email: jesse@railsmachine.com
 executables: 
@@ -112,12 +147,12 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - .gitmodules
+- IsolateScenarios
 - LICENSE
 - README.rdoc
 - Rakefile
 - bin/shadow_puppet
 - examples/foo.rb
-- ginger_scenarios.rb
 - lib/shadow_puppet.rb
 - lib/shadow_puppet/core_ext.rb
 - lib/shadow_puppet/manifest.rb
@@ -141,23 +176,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: moonshine
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby Puppet DSL

data/ginger_scenarios.rb

@@ -1,23 +0,0 @@
-require 'ginger'
-
-def create_scenario(version)
-  scenario = Ginger::Scenario.new("Rails #{version}")
-  scenario[/^activesupport$/] = version
-  scenario[/^activerecord$/] = version
-  scenario[/^actionpack$/] = version
-  scenario[/^actioncontroller$/] = version
-  scenario
-end
-
-Ginger.configure do |config|
-  config.aliases["rails"] = "rails"
-  
-  rails_2_3_5 = create_scenario('2.3.5')
-  rails_2_3_8 = create_scenario('2.3.8')
-
-  rails_3_0_0_beta = create_scenario('3.0.0.beta')
-  rails_3_0_0_beta3 = create_scenario('3.0.0.beta3')
-  
-  config.scenarios << rails_2_3_5 << rails_2_3_8 << rails_3_0_0_beta << rails_3_0_0_beta3
-end
-