pawnee 0.0.5 → 0.0.6

data/README.md

@@ -33,6 +33,7 @@ This system will:
 	- and just overwrite it so files get copied to remote destinations if needed
 
 
+A note on idempotence.  Being idempotent is a big selling point for chef.  Pawnee strives for idempotence but provides it in different ways.  For example, where chef would provide a more dsl like way to declare what to do when changes are made, pawnee tries to avoid too much DSL, so the recipe developer will need to be aware that the task may be run multiple times.  We find that either way the recipe developer needs to understand this situation, and with the Pawnee way, its made clearer in the code.
 
 ## Installation
 

data/docs/GUIDE.md

@@ -6,7 +6,7 @@ Pawnee tries to make it very easy to create recipes for setting up things on rem
 
 		pawnee gem [gemname]
 
-This will generate files for a gem in the current directory.  The word Recipe is used to refer to these pawnee gems (since it is a standard term in the provisioning world.)
+This will generate files for a gem in the current directory.  All pawnee gems will be automatically prefixed with pawnee- so that they can be easily identified.  The word Recipe is used to refer to these pawnee gems (since it is a standard term in the provisioning world.)
 
 ## base.rb
 
@@ -83,6 +83,8 @@ Pawnee also provides its own set of actions for common server tasks.
 
 install_package, remove_package, compile, create_user, delete_user
 
+For more info see [the docs on pawnee actions](...)
+
 ## Options
 
 Pawnee also uses thor's option system.  This means your tasks should use thor's #desc and #method_option.  ([Read more here](https://github.com/wycats/thor/wiki/Getting-Started) and [here](https://github.com/wycats/thor/wiki/Method-Options))  This allows for an easily defined set of options for any task.  This also allows anyone to see what options the tasks take:

data/docs/TODO.md

@@ -8,3 +8,17 @@ TODO: Add a as_user('user') do .. end option
 TODO: Need to make a clear way for pawnee gems (and recipes) to provide actions (example, git gem provides git actions)
 TODO: Run actions in threads (across multiple servers)
 TODO: Test to make sure arguments work directly as well (they probably don't right now)
+TODO: System to check for and register updates/modifications
+
+
+def setup
+	install_package('build-essential')
+	
+	modify_block do
+		install_package('nginx')
+
+		if modified?
+			invoke Pawnee::Nginx::Base restart
+		end
+	end
+end

data/lib/pawnee/pawnee/actions.rb

@@ -10,7 +10,7 @@ module Pawnee
     # This is copied in from thor/actions.rb#initialize, 
     # we can't extend from a module, so we just move this setup
     # to a method
-    def pawnee_setup_actions(args=[], options={}, config={})
+    def pawnee_setup_actions(args=[], options={}, config={}) #:nodoc:
       self.behavior = case config[:behavior].to_s
         when "force", "skip"
           _cleanup_options_and_set(options, config[:behavior])

data/lib/pawnee/pawnee/base.rb

@@ -23,8 +23,7 @@ module Pawnee
     
     attr_accessor :server
     
-    # Calls the thor initializers, then if :server is passed in as 
-    # an option, it will set it up
+    # Creates an instance of the pawnee recipe
     #
     # ==== Parameters
     # args<Array[Object]>:: An array of objects. The objects are applied to their
@@ -97,8 +96,8 @@ module Pawnee
     
     desc "setup", 'setup on the destination server'
     # All recipies should subclass Pawnee::Base and implement setup to
-    # install everything needed for the gem
-    # setup should be able to be called multiple times
+    # install everything needed for the gem.
+    # Setup should be able to be called multiple times
     def setup
       raise 'this gem does not implement the setup method'
     end
@@ -112,7 +111,7 @@ module Pawnee
 
     # Guess the gem name based on the class name
     def self.gem_name
-      self.name.gsub(/[:][:][^:]+$/, '').gsub(/^[^:]+[:][:]/, '').gsub('::', '-').downcase
+      self.name.gsub(/[:][:]Base$/, '').gsub(/^[^:]+[:][:]/, '').gsub('::', '-').downcase
     end
     
     no_tasks {
@@ -127,7 +126,11 @@ module Pawnee
           # Setup the server connections before we run the task
           servers = options[:servers] || options['servers']
 
-          if !servers || self.class == Pawnee::CLI
+          # Don't run multiple times if:
+          # 1. they don't have any servers (then run locally)
+          # 2. the call is coming from the main CLI
+          # 3. they are calling a help task
+          if !servers || self.class == Pawnee::CLI || task.name == 'help'
             # No servers, just run locally
             task.run(self, *args)
           else

data/lib/pawnee/pawnee/version.rb

@@ -1,3 +1,3 @@
 module Pawnee
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/base_spec.rb

@@ -33,7 +33,7 @@ describe Pawnee::Base do
   end
   
 
-  class Dep
+  class Dep #:nodoc:
     attr_accessor :name
     
     def initialize(name)
@@ -45,9 +45,9 @@ describe Pawnee::Base do
     Pawnee::Base.recipes.should == nil
 
     # These will persist between tests
-    module Pawnee
-      module Red
-        class Base < Pawnee::Base
+    module Pawnee #:nodoc:
+      module Red #:nodoc:
+        class Base < Pawnee::Base #:nodoc:
           desc "setup", "setup"
           def setup
             puts "SETUP RED"
@@ -55,8 +55,8 @@ describe Pawnee::Base do
         end
       end
 
-      module Blue
-        class Base < Pawnee::Base
+      module Blue #:nodoc:
+        class Base < Pawnee::Base #:nodoc:
           desc "setup", "setup"
           def setup
             puts "SETUP BLUE"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pawnee
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 Z
+date: 2012-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -301,7 +301,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1925107233539140142
+      hash: -3877937215280368330
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -310,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1925107233539140142
+      hash: -3877937215280368330
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.22