deprec-core 3.1.5 → 3.1.6

data/CHANGELOG

@@ -1,7 +1,16 @@
 deprec-core changelog
 =====================
 
+= 3.1.6  (Jul 22, 2011)
+
+  * Added TEMPLATE_LOAD_PATH
+    
+    deprec-core will search this path for the template it's asked
+    to render.
+    
+  * Did some reorganization of files.
+
 = 3.1.5  (Jul 17, 2011)
 
-* Extracted the guts of deprec into this gem
+  * Extracted the guts of deprec into this gem
 

data/lib/deprec-core/canonical.rb

@@ -8,6 +8,46 @@
 # stubs are so they'll be included in the output of "cap -T"
 #
 Capistrano::Configuration.instance(:must_exist).load do 
+
+  # deprec defines some generic recipes for common services
+  # including ruby interpreter, web, app and database servers
+  #
+  # They default to my current favourites which you can over ride
+  #  
+  # Service options
+  CHOICES_RUBY_VM   = [:mri, :ree]
+  CHOICES_WEBSERVER = [:apache, :none] # :nginx not recipes out of date
+  CHOICES_APPSERVER = [:passenger, :none] # any colour you like guys
+  CHOICES_DATABASE  = [:mysql, :postgresql, :sqlite, :none]
+  # 
+  # Service defaults
+  _cset :ruby_vm_type,    :mri
+  _cset :web_server_type, :apache
+  _cset :app_server_type, :passenger
+  _cset :db_server_type,  :mysql
+
+  # Connect deprec:db to deprec:mysql, deprec:web to deprec:apache, etc
+  on :load, 'deprec:connect_canonical_tasks'
+
+  namespace :deprec do
+    task :connect_canonical_tasks do
+      # link application specific recipes into canonical task names
+      # e.g. deprec:web:restart => deprec:nginx:restart 
+
+
+      namespaces_to_connect = { :web => :web_server_type,
+                                :app => :app_server_type,
+                                :db  => :db_server_type,
+                                :ruby => :ruby_vm_type
+                              }
+      namespaces_to_connect.each do |server, choice|
+        server_type = send(choice).to_sym
+        if server_type != :none && deprec.respond_to?(server_type)
+          namespaces[server] = deprec.send(server_type)
+        end
+      end
+    end
+  end
   
   %w(ruby).each do |package|
     namespace "deprec:#{package}" do

data/lib/deprec-core/capistrano_extensions.rb

@@ -3,6 +3,11 @@ require 'capistrano'
 require 'fileutils'
 
 module Deprec2
+
+  # Run rake task on remote server(s)
+  def rake_remote(task_name)
+      run "cd #{current_path} && RAILS_ENV=#{rails_env} #{rake} #{task_name}"
+  end
   
   # Temporarily modify ROLES if HOSTS not set
   # Capistrano's default behaviour is for HOSTS to override ROLES
@@ -12,10 +17,6 @@ module Deprec2
     yield
     ENV['ROLES'] = old_roles.to_s unless ENV['HOSTS']
   end
-
-  def rake_remote(task_name)
-      run "cd #{current_path} && RAILS_ENV=#{rails_env} #{rake} #{task_name}"
-  end
   
   # Temporarily ignore ROLES and HOSTS
   def ignoring_roles_and_hosts
@@ -28,7 +29,6 @@ module Deprec2
     ENV['HOSTS'] = old_hosts
   end
   
-  DEPREC_TEMPLATES_BASE = File.join(File.dirname(__FILE__), 'templates')
 
   # Render template (usually a config file) 
   # 
@@ -61,15 +61,16 @@ module Deprec2
     # If you don't specify the location with the local_template_dir option
     # it defaults to config/templates.
     # e.g. config/templates/nginx/nginx.conf.erb
-    local_template = File.join(local_template_dir, app.to_s, template)
-    if File.exists?(local_template)
-      puts
-      puts "Using local template (#{local_template})"
-      template = ERB.new(IO.read(local_template), nil, '-')
-    else
-      template = ERB.new(IO.read(File.join(DEPREC_TEMPLATES_BASE, app.to_s, template)), nil, '-')
+    template_path = ''
+    TEMPLATE_LOAD_PATH.each do |dir|
+      template_path = File.join(dir, app.to_s, template)
+      if File.exists?(template_path)
+        template = ERB.new(IO.read(template_path), nil, '-')
+        break
+      end
     end
     rendered_template = template.result(binding)
+    puts "Using #{template_path}"
   
     if remote 
       # render to remote machine
@@ -209,35 +210,29 @@ module Deprec2
     switches += " --shell=#{options[:shell]} " if options[:shell]
     switches += ' --create-home ' unless options[:homedir] == false
     switches += " --gid #{options[:group]} " unless options[:group].nil?
-    invoke_command "grep '^#{user}:' /etc/passwd || #{sudo} /usr/sbin/useradd #{switches} #{user}", 
-    :via => run_method
+    run "grep '^#{user}:' /etc/passwd || #{sudo} /usr/sbin/useradd #{switches} #{user}" 
   end
 
   # create a new group on target system
   def groupadd(group, options={})
-    via = options.delete(:via) || run_method
     # XXX I don't like specifying the path to groupadd - need to sort out paths before long
-    invoke_command "grep '#{group}:' /etc/group || #{sudo} /usr/sbin/groupadd #{group}", :via => via
+    run "grep '#{group}:' /etc/group || #{sudo} /usr/sbin/groupadd #{group}"
   end
 
   # add group to the list of groups this user belongs to
   def add_user_to_group(user, group)
-    invoke_command "groups #{user} | grep ' #{group} ' || #{sudo} /usr/sbin/usermod -G #{group} -a #{user}",
-    :via => run_method
+    run "groups #{user} | grep ' #{group} ' || #{sudo} /usr/sbin/usermod -G #{group} -a #{user}"
   end
 
   # create directory if it doesn't already exist
   # set permissions and ownership
   # XXX move mode, path and
   def mkdir(path, options={})
-    via = options.delete(:via) || :run
-    # XXX need to make sudo commands wrap the whole command (sh -c ?)
-    # XXX removed the extra 'sudo' from after the '||' - need something else
-    invoke_command "test -d #{path} || #{sudo if via == :sudo} mkdir -p #{path}"
-    invoke_command "chmod #{sprintf("%3o",options[:mode]||0755)} #{path}", :via => via if options[:mode]
-    invoke_command "chown -R #{options[:owner]} #{path}", :via => via if options[:owner]
-    groupadd(options[:group], :via => via) if options[:group]
-    invoke_command "chgrp -R #{options[:group]} #{path}", :via => via if options[:group]
+    run "test -d #{path} || #{sudo} mkdir -p #{path}"
+    run "chmod #{sprintf("%3o",options[:mode]||0755)} #{path}" if options[:mode]
+    run "chown -R #{options[:owner]} #{path}" if options[:owner]
+    groupadd(options[:group]) if options[:group]
+    run "chgrp -R #{options[:group]} #{path}" if options[:group]
   end
   
   def create_src_dir
@@ -270,7 +265,6 @@ module Deprec2
       when :http
         # ensure wget is installed
         apt.install( {:base => %w(wget)}, :stable )
-        # XXX replace with invoke_command
         run "cd #{src_dir} && test -f #{src_pkg[:filename]} #{md5_clause} || #{sudo} wget --quiet --timestamping #{src_pkg[:url]}"
 
       when :deb
@@ -375,7 +369,7 @@ module Deprec2
   end
 
   def invoke_with_input(shell_command, input_query=/^Password/, response=nil)
-    handle_command_with_input(run_method, shell_command, input_query, response)
+    handle_command_with_input(:sudo, shell_command, input_query, response)
   end
 
   ##

data/lib/deprec-core/defaults.rb

@@ -0,0 +1,60 @@
+# Copyright 2006-2011 by Mike Bailey. All rights reserved.
+Capistrano::Configuration.instance(:must_exist).load do 
+
+  # Bundler's Capistrano tasks update this
+  # Call rake within tasks using #{rake}
+  _cset :rake, 'rake'
+  
+  # Deprec checks here for local versions of config templates before it's own
+  _cset :local_template_dir, File.join('config','templates')
+  
+  # Prompt user for missing values if not supplied
+  _cset(:application) do
+    Capistrano::CLI.ui.ask "Enter name of project(no spaces)" do |q|
+      q.validate = /^[0-9a-z_]*$/
+    end
+  end 
+
+  _cset(:domain) do
+    Capistrano::CLI.ui.ask "Enter domain name for project" do |q|
+      q.validate = /^[0-9a-z_\.]*$/
+    end
+  end
+
+  _cset(:repository) do
+    Capistrano::CLI.ui.ask "Enter repository URL for project" do |q|
+      # q.validate = //
+    end
+  end
+
+  _cset :backup_dir, '/var/backups'  
+
+  # XXX We *probably* want these set
+  # Must be set for the password prompt from git to work
+  # default_run_options[:pty] = true  
+  # ssh_options[:forward_agent] = true
+
+  # SCM
+  _cset :scm, "git"
+  _cset :user, "deploy" 
+  _cset :deploy_via, :remote_cache
+  _cset :branch, "master"
+
+  # XXX rails deploy stuff
+  _cset :apps_root,    '/srv'  # parent dir for apps
+  _cset(:deploy_to)    { File.join(apps_root, application) } # dir for current app
+  _cset(:current_path) { File.join(deploy_to, "current") }
+  _cset(:shared_path)  { File.join(deploy_to, "shared") }
+
+  # XXX more rails deploy stuff?
+
+  _cset :group, 'deploy'           # deployment group
+  _cset(:group_src) { group }      # group ownership for src dir
+  _cset :src_dir, '/usr/local/src' # 3rd party src on servers lives here
+  _cset(:web_server_aliases) { domain.match(/^www/) ? [] : ["www.#{domain}"] }    
+
+  # It can be useful to know the user running this command
+  # even when USER is set to someone else. Sorry windows!
+  _cset :current_user, `whoami`.chomp
+
+end

data/lib/deprec-core/deprec.rb

@@ -1,9 +1,6 @@
 # Copyright 2006-2011 by Mike Bailey. All rights reserved.
 Capistrano::Configuration.instance(:must_exist).load do 
 
-  # Connect deprec:db to deprec:mysql, deprec:web to deprec:apache, etc
-  on :load, 'deprec:connect_canonical_tasks' 
-
   # Set the value if not already set
   # This method is accessible to all recipe files
   # Defined and used by capistrano/deploy tasks
@@ -16,11 +13,6 @@ Capistrano::Configuration.instance(:must_exist).load do
   # deprecated
   alias :default :_cset
 
-  _cset :rake, 'rake'
-  
-  # Deprec checks here for local versions of config templates before it's own
-  _cset :local_template_dir, File.join('config','templates')
-  
   # The following two Constants contain details of the configuration 
   # files used by each service. They're used when generating config
   # files from templates and when configs files are pushed out to servers.
@@ -34,159 +26,4 @@ Capistrano::Configuration.instance(:must_exist).load do
   # to configure, build and install the service
   SRC_PACKAGES = {} unless defined?(SRC_PACKAGES)
 
-  # deprec defines some generic recipes for common services
-  # including ruby interpreter, web, app and database servers
-  #
-  # They default to my current favourites which you can over ride
-  #  
-  # Service options
-  CHOICES_RUBY_VM   = [:mri, :ree]
-  CHOICES_WEBSERVER = [:apache, :none] # :nginx not recipes out of date
-  CHOICES_APPSERVER = [:passenger, :none] # any colour you like guys
-  CHOICES_DATABASE  = [:mysql, :postgresql, :sqlite, :none]
-  # 
-  # Service defaults
-  _cset :ruby_vm_type,    :mri
-  _cset :web_server_type, :apache
-  _cset :app_server_type, :passenger
-  _cset :db_server_type,  :mysql
-
-  # Prompt user for missing values if not supplied
-  _cset(:application) do
-    Capistrano::CLI.ui.ask "Enter name of project(no spaces)" do |q|
-      q.validate = /^[0-9a-z_]*$/
-    end
-  end 
-
-  _cset(:domain) do
-    Capistrano::CLI.ui.ask "Enter domain name for project" do |q|
-      q.validate = /^[0-9a-z_\.]*$/
-    end
-  end
-
-  _cset(:repository) do
-    Capistrano::CLI.ui.ask "Enter repository URL for project" do |q|
-      # q.validate = //
-    end
-  end
-
-  _cset :backup_dir, '/var/backups'  
-
-  # XXX We *probably* want these set
-  # Must be set for the password prompt from git to work
-  # default_run_options[:pty] = true  
-  # ssh_options[:forward_agent] = true
-
-  # SCM
-  _cset :scm, "git"
-  _cset :user, "deploy" 
-  _cset :deploy_via, :remote_cache
-  _cset :branch, "master"
-
-  # XXX rails deploy stuff
-  _cset :apps_root,    '/srv'  # parent dir for apps
-  _cset(:deploy_to)    { File.join(apps_root, application) } # dir for current app
-  _cset(:current_path) { File.join(deploy_to, "current") }
-  _cset(:shared_path)  { File.join(deploy_to, "shared") }
-
-  # XXX more rails deploy stuff?
-
-  _cset :group, 'deploy'           # deployment group
-  _cset(:group_src) { group }      # group ownership for src dir
-  _cset :src_dir, '/usr/local/src' # 3rd party src on servers lives here
-  _cset(:web_server_aliases) { domain.match(/^www/) ? [] : ["www.#{domain}"] }    
-
-  # It can be useful to know the user running this command
-  # even when USER is set to someone else. Sorry windows!
-  _cset :current_user, `whoami`.chomp
-
-  namespace :deprec do
-    
-    task :connect_canonical_tasks do      
-      # link application specific recipes into canonical task names
-      # e.g. deprec:web:restart => deprec:nginx:restart 
-      
-      
-      namespaces_to_connect = { :web => :web_server_type,
-                                :app => :app_server_type,
-                                :db  => :db_server_type,
-                                :ruby => :ruby_vm_type
-                              }
-      namespaces_to_connect.each do |server, choice|
-        server_type = send(choice).to_sym
-        if server_type != :none
-          namespaces[server] = deprec.send(server_type)          
-        end
-      end
-    end
-
-    task :dump do
-      require 'yaml'
-      y variables
-    end
-    
-    task :setup_src_dir do
-      deprec2.groupadd(group_src)
-      deprec2.add_user_to_group(user, group_src)
-      deprec2.create_src_dir
-    end
-    
-    # Download all packages used by deprec to your local host.
-    # You can then push them to /usr/local/src on target hosts
-    # to save time and bandwidth rather than repeatedly downloading
-    # from the distribution sites.
-    task :update_src do
-      SRC_PACKAGES.each{|key, src_package| 
-        current_dir = Dir.pwd
-        system "cd src/ && test -f #{src_package[:filename]} || wget --quiet --timestamping #{src_package[:url]}"
-        system "cd #{current_dir}"
-      }
-    end
-    
-    # todo
-    #
-    # Copy files from src/ to /usr/local/src/ on remote hosts
-    task :push_src do
-      SRC_PACKAGES.each do |key, src_package| 
-        deprec2.set_package_defaults(src_package)
-        file = File.join('src', src_package[:filename])
-        if File.exists?(file)
-          std.su_put(File.read(file), "#{src_dir}/#{src_package[:filename]}", '/tmp/')
-        end
-      end
-    end
-    
-    task :list_src do
-      # XXX ugly line - look away
-      max_key_size = SRC_PACKAGES.keys.max{|a,b| a.to_s.size <=> b.to_s.size}.to_s.size
-      SRC_PACKAGES.each{|key, src_package| 
-        deprec2.set_package_defaults(src_package)
-        puts "#{key}#{' '*(max_key_size+1-key.to_s.size)}: #{src_package[:url]}"
-      }
-    end
-    
-    task :find_src do
-      # XXX ugly line - look away
-      max_key_size = SRC_PACKAGES.keys.max{|a,b| a.to_s.size <=> b.to_s.size}.to_s.size
-      SRC_PACKAGES.each{|key, src_package| 
-        deprec2.set_package_defaults(src_package)
-        puts "#{key}#{' '*(max_key_size+1-key.to_s.size)}: #{src_package[:url]}"
-        puts `find . -name #{src_package[:filename]}`
-        puts
-      }
-    end
-    
-    task :recover_src do
-      # XXX ugly line - look away
-      max_key_size = SRC_PACKAGES.keys.max{|a,b| a.to_s.size <=> b.to_s.size}.to_s.size
-      SRC_PACKAGES.each{|key, src_package| 
-        puts "#{key}#{' '*(max_key_size+1-key.to_s.size)}: #{src_package[:url]}"
-        file = `find . -name #{src_package[:filename]}`.split[0]
-        `cp #{file} src/` if file
-        puts
-      }
-    end
-     
-  end
-  
 end

data/lib/deprec-core/version.rb

@@ -1,5 +1,5 @@
 module Deprec
   module Core
-    VERSION = "3.1.5"
+    VERSION = "3.1.6"
   end
 end

data/lib/deprec-core.rb

@@ -1,10 +1,11 @@
 require "deprec-core/version"
 
 if defined?(Capistrano)
-  require "deprec-core/capistrano_extensions"
   require "vmbuilder_plugins/all"
-  require "deprec-core/canonical"
   require "deprec-core/deprec"
+  require "deprec-core/defaults"
+  require "deprec-core/capistrano_extensions"
+  require "deprec-core/canonical"
 elsif defined?(rake)
   # pass
 end

metadata

@@ -1,28 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: deprec-core
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 3.1.6
   prerelease: 
-  version: 3.1.5
 platform: ruby
-authors: 
+authors:
 - Mike Bailey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-16 00:00:00 Z
+date: 2011-07-22 00:00:00.000000000 +10:00
+default_executable: 
 dependencies: []
-
-description: deprec-core was extracted from the popular deprec gem to make it easier for people to publish Capistrano and Rake task gems
-email: 
+description: deprec-core was extracted from the popular deprec gem to make it easier
+  for people to publish Capistrano and Rake task gems
+email:
 - mike@bailey.net.au
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG
 - Gemfile
@@ -32,6 +29,7 @@ files:
 - lib/deprec-core.rb
 - lib/deprec-core/canonical.rb
 - lib/deprec-core/capistrano_extensions.rb
+- lib/deprec-core/defaults.rb
 - lib/deprec-core/deprec.rb
 - lib/deprec-core/version.rb
 - lib/vmbuilder_plugins/all.rb
@@ -39,32 +37,29 @@ files:
 - lib/vmbuilder_plugins/emerge.rb
 - lib/vmbuilder_plugins/gem.rb
 - lib/vmbuilder_plugins/std.rb
-homepage: ""
+has_rdoc: true
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: deprec-core
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: deprec-core provides extensions to Capistrano
 test_files: []
-