gemmer 0.0.8

data/README.rdoc

@@ -0,0 +1,109 @@
+= gemmer
+
+Author::    Thomas Kadauke  - tkadauke (at) imedo.de
+Copyright:: Copyright (c) 2010 Thomas Kadauke
+Licence::   MIT
+Git::       http://github.com/tkadauke/gemmer
+
+Simplify rake tasks for Rubygems. It is a little bit like jeweler, but less complicated and it allows you to distribute your gem to your internal servers. In contrast to jeweler, it is really just a way to keep your Rakefile DRY, without taking control over your whole gem.
+
+== Dependencies
+
+* rubygems
+* active_support
+
+== Installation
+
+Install from rubygems.org:
+
+  sudo gem install gemmer
+
+Install from source
+
+  git clone git://github.com/tkadauke/gemmer
+  cd gemmer
+  sudo rake install
+
+== Usage
+
+Add the following code to your gem's Rakefile
+
+  begin
+    require 'gemmer'
+  
+    Gemmer::Tasks.new('my_gem')
+  rescue LoadError
+    puts "Gemmer not available. Install it with: gem install gemmer"
+  end
+
+replace 'my_gem' with the name of your gem. If you want to release your gem to the public and/or on private internal machines, you can easily define release tasks like so:
+
+  Gemmer::Tasks.new('my_gem') do |t|
+    # to release the gem to rubygems.org
+    t.release_via :rubygems
+    # to release the gem to a remote machine
+    t.release_via :ssh, :to => 'some_host', :username => 'me', :use_sudo => true
+  end
+
+Gemmer will then define tasks to build your gem, install/uninstall it locally, and in the latter case release them to rubygems.org, and via SSH to host 'some_host'.
+
+== Building / Installing
+
+Used to its bare minimum, gemmer defines tasks to build and install your gem:
+
+  rake build
+  rake install
+  rake uninstall
+  rake reinstall
+
+Note that the install tasks might require root privileges, so prefix them with sudo:
+
+  sudo rake install
+  sudo rake uninstall
+  sudo rake reinstall
+
+== Releasing
+
+There are several ways to release a gem using gemmer. You can specify multiple release targets. Each will get its own task in the release namespace. To release to every target at once, use
+
+  rake release
+
+=== Release on rubygems.org
+
+To release on rubygems.org, use gemmer like this in your Rakefile:
+
+  Gemmer::Tasks.new('my_gem') do |t|
+    t.release_via :rubygems
+  end
+
+Then, gemmer generates the task
+
+  rake release:rubygems
+
+=== Release via SSH on a remote machine
+
+This is where gemmer really shines. It allows you to release a gem to a remote machine (possibly an internal server), so gemmer is perfectly suitable for handling and distributing your internal or private gems. Use like this in your Rakefile:
+
+  Gemmer::Tasks.new('my_gem') do |t|
+    t.release_via :ssh, :to => 'my_host', :username => 'me', :use_sudo => true
+  end
+
+And you will get the task
+
+  rake release:my_host
+
+=== Release via Scatter to a group of hosts
+
+Scatter is a tool to distribute gems on internal and/or production servers. Once configured, you can push any gem to an unlimited number of servers. Scatter uses host names and host groups as targets for your gem. With gemmer, just specify the target name, and you're good to go:
+
+  Gemmer::Tasks.new('my_gem') do |t|
+    t.release_via :scatter, :to => 'my_host_group'
+  end
+
+Then, release with
+
+  rake release:my_host_group
+
+== TODO
+
+- Release to rubyforge

data/src/gemmer.rb

@@ -0,0 +1,179 @@
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'active_support'
+
+# Deprecated. Don't use.
+def gemmer(gem_name)
+  puts "WARNING: the gemmer method is deprecated. Use Gemmer::Tasks.new(gem_name) instead"
+  
+  Gemmer::Tasks.new(gem_name)
+end
+
+module Gemmer #:nodoc:
+  # Defines a couple of convenient tasks to build, install and release gems.
+  #
+  # Complete usage example:
+  #
+  #   Gemmer::Tasks.new('my_gem') do |t|
+  #     t.gemspec_file = 'my_gem.gemspec' # <- this is the default
+  #     t.gemspec_erb_file = 'my_gem.gemspec.erb' # <- this is the default
+  #     t.package_path = 'pkg' # <- this is the default
+  #
+  #     t.release_via :rubygems
+  #     t.release_via :ssh, :to => 'some_host', :username => 'me', :use_sudo => true
+  #     t.release_via :ssh, :to => 'production', :host => 'some_other_hostname', :username => 'me', :use_sudo => false
+  #     t.release_via :scatter, :to => 'my_host_group'
+  #   end
+  class Tasks
+    attr_accessor_with_default(:gemspec_file) { "#{@gem_name}.gemspec" }
+    attr_accessor_with_default(:gemspec_erb_file) { "#{gemspec_file}.erb" }
+    attr_accessor_with_default :package_path, "pkg"
+    
+    # contains the Gem::Specification instance
+    attr_reader :spec
+    
+    # Define gem tasks. The only argument is the name of the gem. Yields itself to a block
+    # if given.
+    #
+    # The following writer methods are defined on the yielded object:
+    #
+    # gemspec_file:: relative path to the gemspec file. Defaults to <gem_name>.gemspec
+    # gemspec_erb_file:: relative path of an erb template for generating the gemspec file. Use this only if you need to (e.g. Github did not allow Dir.glob in gemspec files, so a workaround was to use an erb file to glob for the files locally and generate the gemspec file from that.)
+    # package_path:: relative path under which the built gem is stored. Defaults to pkg
+    def initialize(gem_name)
+      @gem_name = gem_name
+      @release_destinations = {}
+      yield self if block_given?
+      define
+    end
+    
+    # Add another release method. Available release methods are:
+    #
+    # - rubygems: Release the gem to rubygems.org
+    # - ssh:      Release the gem to another computer via scp / ssh. Options are:
+    #   - :to - Symbolic name and/or host name for the target machine. Required.
+    #   - :host - Host name of the target machine. If not specified, the :to option is used.
+    #   - :username - SSH user name
+    #   - :use_sudo - Whether to use sudo for installing the gem on the remote machine.
+    # - scatter:  Release the gem using scatter. Options are:
+    #   - :to - Name of target host / group
+    def release_via(release_method, options = nil)
+      @release_destinations[release_method] = options
+    end
+    
+  protected
+    def define
+      @spec = eval(File.read(gemspec_file))
+      @file_name = "#{@gem_name}-#{@spec.version}.gem"
+      @package = File.join(package_path, @file_name)
+      
+      define_gem_tasks
+      define_install_tasks
+      define_release_tasks
+      define_rdoc_tasks
+    end
+    
+    def define_gem_tasks
+      Rake::GemPackageTask.new(@spec) do |pkg|
+        pkg.need_tar = true
+      end
+      
+      desc "Build gem"
+      task :build => @package do
+        puts "generated latest version"
+      end
+
+      desc "Generate .gemspec file from .gemspec.erb file"
+      task :gemspec do
+        require 'erb'
+        File.open("#{gemspec_file}", 'w') do |file|
+          file.puts ERB.new(File.read("#{gemspec_erb_file}")).result
+        end
+      end
+    end
+    
+    def define_install_tasks
+      desc "Install gem locally (use sudo rake install if you need privileges)"
+      task :install => @package do
+        system "gem install #{@package}"
+      end
+
+      desc "Uninstall gem (use sudo rake uninstall if you need privileges)"
+      task :uninstall do
+        system "gem uninstall #{@gem_name}"
+      end
+
+      desc "Reinstall gem (use sudo rake reinstall if you need privileges)"
+      task :reinstall => [:uninstall, :install]
+    end
+    
+    def define_rdoc_tasks
+      desc "Generate documentation for #{@gem_name}."
+      Rake::RDocTask.new(:rdoc) do |rdoc|
+        rdoc.rdoc_dir = 'rdoc'
+        rdoc.title    = @gem_name
+        rdoc.options << '--line-numbers' << '--inline-source'
+        rdoc.rdoc_files.include(spec.files.sort)
+      end
+    end
+    
+    def define_release_tasks
+      task_names = @release_destinations.collect do |release_method, options|
+        define_release_task(release_method, options)
+      end
+      
+      unless task_names.empty?
+        desc "Release #{@gem_name} to all destinations"
+        task :release => task_names
+      end
+    end
+    
+    def define_release_task(release_method, options)
+      case release_method.to_s.downcase
+      when 'rubygems'
+        define_rubygems_release_task
+      when 'ssh'
+        define_ssh_release_task(options)
+      when 'scatter'
+        define_scatter_release_task(options)
+      else
+        raise "Unknown release method #{release_method}"
+      end
+    end
+    
+    def define_rubygems_release_task
+      namespace :release do
+        desc "Release #{@gem_name} to rubygems.org"
+        task :rubygems do
+          sh "gem push #{@package}"
+        end
+      end
+      
+      "release:rubygems"
+    end
+    
+    def define_ssh_release_task(options)
+      namespace :release do
+        desc "Release #{@gem_name} to #{options[:to]} via SSH"
+        task options[:to] do
+          ssh_string = "#{options[:username]}@#{options[:host] || options[:to]}"
+          sh "scp #{@package} #{ssh_string}:/tmp/"
+          sh "ssh #{ssh_string} #{options[:use_sudo]} gem install /tmp/#{@file_name}"
+        end
+      end
+      
+      "release:#{options[:to]}"
+    end
+    
+    def define_scatter_release_task(options)
+      namespace :release do
+        desc "Release #{@gem_name} to #{options[:to]} via scatter"
+        task options[:to] do
+          sh "scatter push #{@package} #{options[:to]}"
+        end
+      end
+      
+      "release:#{options[:to]}"
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: gemmer
+version: !ruby/object:Gem::Version 
+  version: 0.0.8
+platform: ruby
+authors: 
+- Thomas Kadauke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-10 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tkadauke@imedo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- src/gemmer.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://www.imedo.de/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- src
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Simple rake tasks for gems
+test_files: []
+