necktie 1.0.0 → 1.0.1

data/CHANGELOG

@@ -0,0 +1,6 @@
+1.0.1 (2009-10-16)
+* Improvements to RDoc.
+* Necktie module helps with documentation and usage.
+
+1.0.0 (2009-10-16)
+* First stable release.

data/README.rdoc

@@ -34,7 +34,7 @@ At the base of your Necktie project there's a file called Necktie (or necktie,
 or necktie.rb), with a list of tasks. For example:
 
   file "/var/myapp" do
-    append "/etc/fstab", "\n/mnt/myapp /var/myapp none bind" unless read("/etc/fstab")["/mnt/myapp"]
+    append "/etc/fstab", "/mnt/myapp /var/myapp none bind\n" unless read("/etc/fstab")["/mnt/myapp"]
     mkdir_p "/var/myapp/"
     sh "mount /var/myapp"
   end
@@ -55,7 +55,7 @@ or necktie.rb), with a list of tasks. For example:
   end
 
   desc "Setup and start Unicorn"
-  task :unicorn=>[:rubygems] do
+  task :unicorn=>[:rubygems, "/var/myapp"] do
     cp "etc/init.d/unicorn", "/etc/init.d/"
     chmod 0750, "/etc/init.d/unicorn"
   end
@@ -100,9 +100,11 @@ Upgrading running instances with new configuration:
 
 Necktie includes Rush, so you can write tasks like this:
 
-  unless processes.find { |p| p.cmdline[/memcached\s.*-l\s0.0.0.0/] }
-    box["/etc/memcached.conf"].replace_contents! /^-l 127.0.0.1/, "-l 0.0.0.0"
-    services.start "memcached"
+  task :memcached do
+    unless processes.find { |p| p.cmdline[/memcached\s.*-l\s0.0.0.0/] }
+      box["/etc/memcached.conf"].replace_contents! /^-l 127.0.0.1/, "-l 0.0.0.0"
+      services.start "memcached"
+    end
   end
 
 You can learn more about Rush here: http://rush.heroku.com
@@ -110,9 +112,11 @@ You can learn more about Rush here: http://rush.heroku.com
 Of course, there's also FileUtils, system and sh (courtesy of Rake), so you can
 also:
 
-  cp "etc/init.d/unicorn", "/etc/init.d"
-  chmod 0755, "/etc/init.d/unicorn"
-  sh "service start unicorn"
+  # Update whenever we have a newer config file.
+  file "/etc/nginx/nginx.conf"=>"etc/nginx.conf" do
+    cp "etc/nginx.conf", "/etc/nginx/nginx.conf"
+    sh "service nginx restart"
+  end
 
 The current directory (Dir.pwd and launch_dir) is the root directory of your
 Necktie repository. You can depend on relative paths when accessing files in
@@ -165,8 +169,10 @@ to upgrade.
 Since install_gem will only install the same gem/version once, a run-always
 rubygems.rb task is all you need:
 
-  FileUtils["gems/*.gem"].each do |gem|
-    install_gem gem
+  task :rubygems do
+    Dir["gems/*.gem"].each do |gem|
+      install_gem gem
+    end
   end
 
 

data/lib/necktie/files.rb

@@ -1,42 +1,46 @@
-# Return the contents of the file (same as File.read).
-def read(name)
-  File.read(name)
-end
-
-# Writes contents to a new file, or overwrites existing file.
-# Takes string as second argument, or yields to block. For example:
-#   write "/etc/mailname", "example.com"
-#   write("/var/run/bowtie.pid") { Process.pid }
-def write(name, contents = nil)
-  contents ||= yield
-  File.open name, "w" do |f|
-    f.write contents
+module Necktie::Files
+  # Return the contents of the file (same as File.read).
+  def read(name)
+    File.read(name)
   end
-end
 
-# Append contents to a file, creating it if necessary.
-# Takes string as second argument, or yields to block. For example:
-#   append "/etc/fstab", "/dev/sdh /vol xfs\n" unless read("/etc/fstab")["/dev/sdh "]
-def append(name, contents = nil)
-  contents ||= yield
-  File.open name, "a" do |f|
-    f.write contents
+  # Writes contents to a new file, or overwrites existing file.
+  # Takes string as second argument, or yields to block. For example:
+  #   write "/etc/mailname", "example.com"
+  #   write("/var/run/bowtie.pid") { Process.pid }
+  def write(name, contents = nil)
+    contents ||= yield
+    File.open name, "w" do |f|
+      f.write contents
+    end
   end
-end
 
-# Updates a file: read contents, substitue and write it back.
-# Takes two arguments for substitution, or yields to block.
-# These two are equivalent:
-#   update "/etc/memcached.conf", /^-l 127.0.0.1/, "-l 0.0.0.0"
-#   update("/etc/memcached.conf") { |s| s.sub(/^-l 127.0.0.1/, "-l 0.0.0.0") }
-def update(name, from = nil, to = nil)
-  contents = File.read(name)
-  if from && to
-    contents = contents.sub(from, to)
-  else
-    contents = yield(contents)
+  # Append contents to a file, creating it if necessary.
+  # Takes string as second argument, or yields to block. For example:
+  #   append "/etc/fstab", "/dev/sdh /vol xfs\n" unless read("/etc/fstab")["/dev/sdh "]
+  def append(name, contents = nil)
+    contents ||= yield
+    File.open name, "a" do |f|
+      f.write contents
+    end
   end
-  File.open name, "w" do |f|
-    f.write contents
+
+  # Updates a file: read contents, substitue and write it back.
+  # Takes two arguments for substitution, or yields to block.
+  # These two are equivalent:
+  #   update "/etc/memcached.conf", /^-l 127.0.0.1/, "-l 0.0.0.0"
+  #   update("/etc/memcached.conf") { |s| s.sub(/^-l 127.0.0.1/, "-l 0.0.0.0") }
+  def update(name, from = nil, to = nil)
+    contents = File.read(name)
+    if from && to
+      contents = contents.sub(from, to)
+    else
+      contents = yield(contents)
+    end
+    File.open name, "w" do |f|
+      f.write contents
+    end
   end
 end
+
+include Necktie::Files

data/lib/necktie/gems.rb

@@ -1,18 +1,22 @@
 require "rubygems/dependency_installer"
 
-# Installs the specified gem, if not already installed. First argument is the
-# name of the gem, or file containing the gem. Second argument is version requirement.
-# For example:
-#   install_gem "unicorn", "~>0.93"
-#
-#   Dir["gems/*.gem"].each do |gem|
-#     install_gem gem
-#   end
-def install_gem(name, version = nil)
-  installer = Gem::DependencyInstaller.new
-  spec = installer.find_spec_by_name_and_version(name, version).first.first
-  if Gem::SourceIndex.from_installed_gems.find_name(spec.name, spec.version).empty?
-    puts " ** Installing the gem #{spec.name} #{spec.version}"
-    installer.install name, version
+module Necktie::Gems
+  # Installs the specified gem, if not already installed. First argument is the
+  # name of the gem, or file containing the gem. Second argument is version requirement.
+  # For example:
+  #   install_gem "unicorn", "~>0.93"
+  #
+  #   Dir["gems/*.gem"].each do |gem|
+  #     install_gem gem
+  #   end
+  def install_gem(name, version = nil)
+    installer = Gem::DependencyInstaller.new
+    spec = installer.find_spec_by_name_and_version(name, version).first.first
+    if Gem::SourceIndex.from_installed_gems.find_name(spec.name, spec.version).empty?
+      puts " ** Installing the gem #{spec.name} #{spec.version}"
+      installer.install name, version
+    end
   end
 end
+
+include Necktie::Gems

data/lib/necktie/rush.rb

@@ -1,7 +1,7 @@
 require "rush"
 include Rush
 
-class Object #:nodoc:
+class Object
   include Rush
   Rush.methods(false).each do |method|
     define_method method do |*args|

data/lib/necktie/services.rb

@@ -1,54 +1,56 @@
-class Services
-  # Enables service to run after boot and starts it. Same as:
-  #   update_rc.d <name> defaults
-  #   service <name> start
-  def start(name)
-    puts " ** Starting service #{name}"
-    system "update-rc.d #{name} defaults" and
-      system "service #{name} start" or
-      fail "failed to start #{name}"
-  end
+module Necktie
+  class Services
+    # Enables service to run after boot and starts it. Same as:
+    #   update_rc.d <name> defaults
+    #   service <name> start
+    def start(name)
+      puts " ** Starting service #{name}"
+      system "update-rc.d #{name} defaults" and
+        system "service #{name} start" or
+        fail "failed to start #{name}"
+    end
 
-  # Enables service to run after boot.
-  def enable(name)
-    system "update-rc.d #{name} defaults" or "cannot enable #{name}"
-  end
+    # Enables service to run after boot.
+    def enable(name)
+      system "update-rc.d #{name} defaults" or "cannot enable #{name}"
+    end
 
-  # Disables service and stops it. Same as:
-  #   service <name> stop
-  #   update_rc.d <name> remove
-  def stop(name)
-    puts " ** Stopping service #{name}"
-    system "service #{name} stop" and
-    system "update-rc.d -f #{name} remove" or
-      fail "failed to stop #{name}"
-  end
+    # Disables service and stops it. Same as:
+    #   service <name> stop
+    #   update_rc.d <name> remove
+    def stop(name)
+      puts " ** Stopping service #{name}"
+      system "service #{name} stop" and
+      system "update-rc.d -f #{name} remove" or
+        fail "failed to stop #{name}"
+    end
 
-  # Disables service from running after boot.
-  def disable(name)
-    system "update-rc.d -f #{name} remove" or fail "cannot disable #{name}"
-  end
+    # Disables service from running after boot.
+    def disable(name)
+      system "update-rc.d -f #{name} remove" or fail "cannot disable #{name}"
+    end
 
-  # Restart service. Same as:
-  #   service <name> restart
-  def restart(name)
-    puts " ** Restarting service #{name}"
-    system "service #{name} restart" or fail "failed to restart #{name}"
-  end
+    # Restart service. Same as:
+    #   service <name> restart
+    def restart(name)
+      puts " ** Restarting service #{name}"
+      system "service #{name} restart" or fail "failed to restart #{name}"
+    end
 
-  # Checks if service is running. Returns true or false based on the outcome
-  # of service <name> status, and nil if service doesn't have a status command.
-  # (Note: Not all services report their running state, or do so reliably)
-  def running?(name)
-    status = File.read("|service --status-all 2>&1")[/^ \[ (.) \]  #{Regexp.escape name}$/,1]
-    status == "+" ? true : status == "-" ? false : nil
+    # Checks if service is running. Returns true or false based on the outcome
+    # of service <name> status, and nil if service doesn't have a status command.
+    # (Note: Not all services report their running state, or do so reliably)
+    def running?(name)
+      status = File.read("|service --status-all 2>&1")[/^ \[ (.) \]  #{Regexp.escape name}$/,1]
+      status == "+" ? true : status == "-" ? false : nil
+    end
   end
 end
 
-# Returns Services object. Examples:
+# Returns Necktie::Services object. Examples:
 #   services.restart "nginx"
 #   services.start "mysql" unless services.running?("mysql")
 #   services.enable "memcached" # but don't start yet
 def services
-  @services ||= Services.new
+  @services ||= Necktie::Services.new
 end

data/lib/necktie.rb

@@ -3,3 +3,11 @@ require "necktie/files"
 require "necktie/gems"
 require "necktie/services"
 require "necktie/rush"
+
+# Includes all methods from Necktie::Files and Necktie::Gems methods.
+#
+# Includes Rake DSL, see http://rake.rubyforge.org for more details.
+#
+# Includes Rush, see http://rush.heroku.com for more details.
+class Object
+end

data/necktie.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = "necktie"
-  spec.version        = "1.0.0"
+  spec.version        = "1.0.1"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://github.com/assaf/necktie"
@@ -9,4 +9,9 @@ Gem::Specification.new do |spec|
 
   spec.files          = Dir["{bin,lib,vendor,example}/**/*", "*.{gemspec,rdoc}"]
   spec.executable     = "necktie"
+
+  spec.has_rdoc         = true
+  spec.extra_rdoc_files = 'README.rdoc', 'CHANGELOG'
+  spec.rdoc_options     = '--title', 'Necktie', '--main', 'README.rdoc',
+                          '--webcvs', 'http://github.com/assaf/necktie'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: necktie
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -19,8 +19,9 @@ executables:
 - necktie
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG
 files: 
 - bin/necktie
 - lib/necktie/application.rb
@@ -246,13 +247,19 @@ files:
 - example/tasks/db.rb
 - necktie.gemspec
 - README.rdoc
+- CHANGELOG
 has_rdoc: true
 homepage: http://github.com/assaf/necktie
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- Necktie
+- --main
+- README.rdoc
+- --webcvs
+- http://github.com/assaf/necktie
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement