sprinkle 0.7.1.1 → 0.7.2

data/.tm_properties

@@ -0,0 +1,7 @@
+projectDirectory = "$CWD"
+
+stockFiles = "{Gemfile.lock,test.rb}"
+
+excludeDirectories = "{rdoc,work}"
+# excludeInFolderSearch = "${excludeDirectories}"
+excludeFiles = "{*.gem,$stockFiles}"

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+*   Default package options (see Package docs)
+
+    *Koen Punt*
+    
+*   Add the file installer so we can stop doing templates with `transfer`
+
+    *Josh Goebel*
+
 *   Officially depreciate transfer :render and the ability to render just by passing
     a multi-line string as the transfer source.  If you want to render templates see the
     new `render()` and `template()` (rendering.rb) helpers and the `file` installer.

data/Gemfile

@@ -5,6 +5,9 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
+  gem 'railties'
+  gem 'rdoc', "3.10"
+  gem 'sdoc'
   gem 'pry'
   gem 'pry_debug'
   gem 'pry-rescue'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sprinkle (0.7)
+    sprinkle (0.7.1.1)
       activesupport (>= 2.0.2)
       capistrano (>= 2.5.5)
       erubis (>= 2.7.0)
@@ -11,9 +11,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
     activesupport (3.2.13)
       i18n (= 0.6.1)
       multi_json (~> 1.0)
+    builder (3.0.4)
     capistrano (2.15.4)
       highline
       net-scp (>= 1.0.0)
@@ -24,8 +38,10 @@ GEM
     diff-lcs (1.2.4)
     erubis (2.7.0)
     highline (1.6.19)
+    hike (1.2.3)
     i18n (0.6.1)
     interception (0.3)
+    journey (1.0.4)
     json (1.8.0)
     method_source (0.8.1)
     multi_json (1.7.7)
@@ -46,8 +62,22 @@ GEM
       pry
     pry_debug (0.1.0)
       pry (~> 0.9.0)
-    rake (10.0.4)
-    rdoc (4.0.1)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.10)
       json (~> 1.4)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
@@ -57,7 +87,17 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
+    sdoc (0.3.20)
+      json (>= 1.1.3)
+      rdoc (~> 3.10)
     slop (3.4.5)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
+    tilt (1.4.1)
 
 PLATFORMS
   ruby
@@ -66,7 +106,9 @@ DEPENDENCIES
   pry
   pry-rescue
   pry_debug
+  railties
   rake (>= 0.8.7)
-  rdoc (>= 3.12)
+  rdoc (= 3.10)
   rspec (>= 2.5)
+  sdoc
   sprinkle!

data/Rakefile

@@ -1,6 +1,9 @@
 require 'rubygems'
+require 'bundler/setup'
+
 require 'rake'
 require 'rspec/core/rake_task'
+require 'sdoc'
 require 'rdoc/task'
 require './lib/sprinkle/version'
 
@@ -24,11 +27,45 @@ RSpec::Core::RakeTask.new(:coverage) do |t|
   t.rcov_opts = ['--exclude', 'spec']
 end
 
+class RDoc::Comment
+  def gsub(*args)
+    @text.gsub(*args)
+  end
+end
+
 RDoc::Task.new do |rdoc|
   version = Sprinkle::Version
-
+  
+  rdoc.options << '-e' << 'UTF-8'
+  rdoc.options << '-f' << 'sdoc'
+  # rdoc.options << "-T" << "rails"
+  
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "sprinkle #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+STATS_DIRECTORIES = [
+  %w(Library            lib/sprinkle/),
+  %w(Specs              spec),
+].collect { |name, dir| [ name, "./#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+BROKEN = [
+  %w(Actors             lib/sprinkle/actors),
+  # %w(Errors             lib/sprinkle/errors),
+  # %w(Extensions         lib/sprinkle/extensions),
+  %w(Installers         lib/sprinkle/installers),
+  # %w(Utility            lib/sprinkle/utility),
+  %w(Package            lib/sprinkle/package),
+  %w(Verifiers          lib/sprinkle/verifiers),
+].collect { |name, dir| [ name, "./#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  require 'rails/code_statistics'
+  CodeStatistics::TEST_TYPES << "Specs"
+  cs=CodeStatistics.new(*BROKEN)
+  cs.instance_variable_set("@total",nil)
+  cs.to_s
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end

data/examples/rails/packages/database.rb

@@ -1,6 +1,13 @@
 package :mysql, :provides => :database do
   description 'MySQL Database'
   
+  defaults :innodb_file_per_table => true,
+    :innodb_buffer_pool_size => "512MB"
+    
+  file "/etc/my.cnf", 
+    :contents => render("mysql.cnf"),
+    :sudo => true
+  
   apt %w( mysql-server mysql-client )
 end
 

data/examples/rails/templates/mysql.cnf.erb

@@ -0,0 +1,3 @@
+[mysqld]
+<%= "innodb_file_per_table" if opts[:innodb_file_per_table] %>
+innodb_buffer_pool_size = <%= opts[:innodb_buffer_pool_size] %>

data/lib/sprinkle.rb

@@ -1,8 +1,6 @@
 require 'rubygems'
 require 'active_support/all'
 
-# Use active supports auto load mechanism
-require 'active_support/version'
 if ActiveSupport::VERSION::MAJOR > 2
   require 'active_support/dependencies'
   ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)
@@ -14,27 +12,24 @@ end
 #ActiveSupport::Dependencies::RAILS_DEFAULT_LOGGER = Logger.new($stdout)
 #ActiveSupport::Dependencies.log_activity = true
 
-require File.dirname(__FILE__) + "/sprinkle/version.rb"
+def require_all(*args) # :nodoc:
+  args.each { |f|
+    Dir[File.dirname(__FILE__) + "/sprinkle/#{f}"].each { |e| require e } }
+end
 
-# Load up extensions to existing classes
-Dir[File.dirname(__FILE__) + '/sprinkle/extensions/*.rb'].each { |e| require e }
-# Load up the verifiers so they can register themselves
-Dir[File.dirname(__FILE__) + '/sprinkle/verifiers/*.rb'].each { |e| require e }
-# Load up the installers so they can register themselves
-Dir[File.dirname(__FILE__) + '/sprinkle/installers/*.rb'].each { |e| require e }
+require_all "version.rb", "extensions/*.rb", "verifiers/*.rb", "installers/*.rb"
 
-# Configuration options
 module Sprinkle
+  # Configuration options
   OPTIONS = { :testing => false, :verbose => false, :force => false }
 end
 
-# Object is extended to Add the package and policy methods. To read about 
-# each method, see the corresponding module which is included.
+# Object is extended with a few helper methods.  Please see Sprinkle::Core.
 #--
 # Define a logging target and understand packages, policies and deployment DSL
 #++
 class Object
-  include Sprinkle::Package, Sprinkle::Policy
+  include Sprinkle::Package, Sprinkle::Core
 
   def logger # :nodoc:
     # ActiveSupport::BufferedLogger was deprecated and replaced by ActiveSupport::Logger in Rails 4.

data/lib/sprinkle/actors/actor.rb

@@ -1,22 +1,22 @@
 module Sprinkle
+  # = Actors
+  # 
+  # An actor is a method of command delivery to a remote machine. Actors are the
+  # layer setting between Sprinkle and the systems you and wanting to apply
+  # policies to.  
+  #
+  # Sprinkle ships with actors for Capistrano, Vlad, localhost and pure SSH.
   module Actors
-    # An actor is a method of command delivery to a remote machine. Actors are the
-    # layer setting between Sprinkle and the systems you and wanting to apply
-    # policies to.  All actors should inherit from Sprinkle::Actors::Actor. 
-    #
-    # Sprinkle ships with actors for Capistrano, Vlad, localhost and pure SSH.
-    # 99% of the time these should be sufficient but you can always write your 
-    # own actor otherwise. 
-    #
     # == Writing an actor
     #
-    # Actors must provide only 3 methods:
+    # All actors should inherit from Sprinkle::Actors::Actor.  Actors must provide the 
+    # following methods:
     # 
-    # * install (installer, roles, options)
-    # * verify (verifier, roles, options)
-    # * servers_for_role? (roles)
-    # * sudo?
-    # * sudo_command
+    # * #install (installer, roles, options)
+    # * #verify (verifier, roles, options)
+    # * #servers_for_role? (roles)
+    # * #sudo?
+    # * #sudo_command
     #
     # Hopefully these methods are kind of fairly obvious.  They should return true
     # to indicate success and false to indicate failure.
@@ -29,11 +29,11 @@ module Sprinkle
       # whether it should execute or not
       #
       # input: a single role or array of roles
-      def servers_for_role?(r)
+      def servers_for_role?(role)
         raise "please define servers_for_role?"
       end
       
-      def install(*args)
+      def install(installer, roles, options)
         raise "you must define install"
       end
       
@@ -50,7 +50,7 @@ module Sprinkle
         raise "you must define sudo_command"
       end
       
-      def verify(*args)
+      def verify(verifier, roles, options)
         raise "you must define verify"
       end
       

data/lib/sprinkle/actors/capistrano.rb

@@ -38,16 +38,16 @@ module Sprinkle
         end
       end
       
-      def sudo?
+      def sudo? #:nodoc:
         @config.fetch(:run_method, :run) == :sudo
       end
       
-      def sudo_command
+      def sudo_command #:nodoc:
         @config.sudo
       end
       
       # Determines if there are any servers for the given roles
-      def servers_for_role?(roles)
+      def servers_for_role?(roles) #:nodoc:
         roles=Array(roles)
         roles.any? { |r| @config.roles.keys.include?(r) }
       end

data/lib/sprinkle/actors/local.rb

@@ -18,14 +18,18 @@ module Sprinkle
     # local system was a member of all roles defined.
     class Local < Actor
       
-      class LocalCommandError < StandardError; end
       
-      def servers_for_role?(role)
+      class LocalCommandError < StandardError #:nodoc:
+      end
+      
+      def servers_for_role?(role) #:nodoc:
         true
       end
       
-      def sudo?; false; end
-      def sudo_command; nil; end
+      def sudo? #:nodoc:; 
+        false; end 
+      def sudo_command #:nodoc:; 
+        nil; end 
       
       def install(installer, roles, opts = {}) #:nodoc:
         # all local installer cares about is the commands
@@ -62,7 +66,7 @@ module Sprinkle
         return true
       end
       
-      def run_command(cmd)
+      def run_command(cmd) #:nodoc:
         @log_recorder.reset cmd
         pid, stdin, out, err = Open4.popen4(cmd)
         ignored, status = Process::waitpid2 pid
@@ -71,7 +75,7 @@ module Sprinkle
         @log_recorder.code = status.to_i
       end
       
-      def raise_error(e)
+      def raise_error(e) #:nodoc:
         raise Sprinkle::Errors::RemoteCommandFailure.new(@installer, @log_recorder.hash, e)
       end
       

data/lib/sprinkle/actors/ssh.rb

@@ -44,7 +44,7 @@ module Sprinkle
         attr_accessor :details
       end
       
-      class SSHConnectionCache
+      class SSHConnectionCache #:nodoc:
         def initialize; @cache={}; end
         def start(host, user, opts={})
           key="#{host}#{user}#{opts.to_s}"
@@ -64,12 +64,12 @@ module Sprinkle
       # Define a whole host of roles at once
       #
       # This is depreciated - you should be using role instead.
-      def roles(roles)
+      def roles(roles) #:nodoc:
         @roles = roles
       end
       
       # Determines if there are any servers for the given roles
-      def servers_for_role?(roles)
+      def servers_for_role?(roles) #:nodoc:
         roles=Array(roles)
         roles.any? { |r| @roles.keys.include? (r) }
       end
@@ -108,11 +108,11 @@ module Sprinkle
         @options[:use_sudo] = value
       end
       
-      def sudo?
+      def sudo? #:nodoc:
         @options[:use_sudo]
       end
       
-      def sudo_command
+      def sudo_command #:nodoc:
         "sudo"
       end
 
@@ -146,7 +146,7 @@ module Sprinkle
 
       protected
       
-        def raise_error(e)
+        def raise_error(e) #:nodoc:
           raise Sprinkle::Errors::RemoteCommandFailure.new(@installer, e.details, e)
         end
       
@@ -165,7 +165,7 @@ module Sprinkle
           end
         end
         
-        def prepare_commands(commands)
+        def prepare_commands(commands) #:nodoc:
           return commands unless sudo?
           commands.map do |command| 
             next command if command.is_a?(Symbol)
@@ -255,7 +255,7 @@ module Sprinkle
           end          
         end
         
-        def ssh_session(host)
+        def ssh_session(host) #:nodoc:
           if @gateway
             gateway.ssh(host, @options[:user])
           else

data/lib/sprinkle/actors/vlad.rb

@@ -23,17 +23,17 @@ module Sprinkle
         self.instance_eval &block if block
       end
       
-      def servers_for_role?
+      def servers_for_role? #:nodoc:
         raise "The vlad actor needs a maintainer.  "+
         "Please file an issue on github.com/sprinkle-tool/sprinkle if you can help."
       end
       
-      def sudo?
+      def sudo? #:nodoc:
         # TODO
         raise
       end
       
-      def sudo_command
+      def sudo_command #:nodoc:
         "sudo"
       end
 
@@ -53,7 +53,7 @@ module Sprinkle
         @loaded_recipes << name
       end
       
-      def install(installer, roles, opts={})
+      def install(installer, roles, opts={}) #:nodoc:
         @installer=installer
         if installer.install_sequence.include?(:TRANSFER)
           process_with_transfer(installer.package.name, installer.install_sequence, roles, opts)
@@ -67,7 +67,7 @@ module Sprinkle
         @installer = nil
       end
       
-      def verify(verifier, roles, opts={})
+      def verify(verifier, roles, opts={}) #:nodoc:
         process(verifier.package.name, commands, roles, 
           :suppress_and_return_failures => true)
       end
@@ -97,7 +97,7 @@ module Sprinkle
         invoke(task)
       end
       
-      def invoke(t)
+      def invoke(t) #:nodoc:
         t.invoke
         return true
       rescue ::Rake::CommandFailedError => e
@@ -108,7 +108,7 @@ module Sprinkle
 
       private
 
-        def task_sym(name)
+        def task_sym(name) #:nodoc:
           "install_#{name.to_task_name}".to_sym
         end
     end