gem-this 0.1.3

data/Rakefile

@@ -0,0 +1,109 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+task :default => :package do
+  puts "Don't forget to write some tests!"
+end
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+  
+  # Change these as appropriate
+  s.name              = "gem-this"
+  s.version           = "0.1.3"
+  s.summary           = "Make existing code into a gem, without any fuss."
+  s.author            = "James Adam"
+  s.email             = "james@lazyatom.com"
+  s.homepage          = "http://github.com/lazyatom/gem-this"
+
+  s.has_rdoc          = true
+  # s.extra_rdoc_files  = %w(Readme.markdown)
+  # s.rdoc_options      = %w(--main Readme.markdown)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(Rakefile Readme.markdown Rakefile.erb) + Dir.glob("{bin}/**/*")
+  s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
+  s.require_paths     = ["bin"]
+  
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+  
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha")
+
+  # If you want to publish automatically to rubyforge, you'll may need
+  # to tweak this, and the publishing task below too.
+  s.rubyforge_project = "gem-this"
+end
+
+# This task actually builds the gem. We also regenerate a static 
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+  
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "Readme.markdown"
+  rd.rdoc_files.include("Readme.markdown", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end
+
+# If you want to publish to RubyForge automatically, here's a simple 
+# task to help do that. If you don't, just get rid of this.
+# Be sure to set up your Rubyforge account details with the Rubyforge
+# gem
+begin
+  require "rake/contrib/sshpublisher"
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Release a new version of this gem"
+      task :gem => [:package] do
+        require 'rubyforge'
+        rubyforge = RubyForge.new
+        rubyforge.configure
+        rubyforge.login
+        rubyforge.userconfig['release_notes'] = spec.summary
+        path_to_gem = File.join(File.dirname(__FILE__), "pkg", "#{spec.name}-#{spec.version}.gem")
+        puts "calling rubyforge.add_release(#{spec.rubyforge_project.inspect}, #{spec.name.inspect}, #{spec.version.to_s.inspect}, #{path_to_gem.inspect})"
+        rubyforge.add_release(spec.rubyforge_project, spec.name, spec.version.to_s, path_to_gem)
+      end
+      
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+ 
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/gem-this/" # Should be the same as the rubyforge project name
+        local_dir = 'rdoc'
+ 
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/Rakefile.erb

@@ -0,0 +1,130 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+<% if using_rspec? %>
+task :default => :spec
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+end
+<% elsif using_test_unit? %>
+task :default => :test
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+<% else %>
+task :default => :package do
+  puts "Don't forget to write some tests!"
+end
+<% end %>
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+  
+  # Change these as appropriate
+  s.name              = "<%= gem_name %>"
+  s.version           = "0.1.0"
+  s.summary           = "What this thing does"
+  s.author            = "Your name"
+  s.email             = "you@example.com"
+  s.homepage          = "http://example.com"
+
+  s.has_rdoc          = true
+<% if readme %>
+  s.extra_rdoc_files  = %w(<%= readme %>)
+  s.rdoc_options      = %w(--main <%= readme %>)
+
+  # Add any extra files to include in the gem
+<% else %>  
+  # You should probably have a README of some kind. Change the filename
+  # as appropriate
+  # s.extra_rdoc_files  = %w(README)
+  # s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem (like your README)
+<% end %>
+  s.files             = %w(<%= files_in_root %>) + Dir.glob("{<%= dirs_to_include %>}/**/*")
+<% if has_executables? %>
+  s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
+<% end %>   
+  s.require_paths     = ["lib"]
+  
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+  
+<% if using_rspec? %>
+  s.add_development_dependency("rspec") # add any other gems for testing/development
+<% else %>
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha")
+<% end %>
+
+  # If you want to publish automatically to rubyforge, you'll may need
+  # to tweak this, and the publishing task below too.
+  s.rubyforge_project = "<%= gem_name %>"
+end
+
+# This task actually builds the gem. We also regenerate a static 
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+  
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  <% if readme %>rd.main = "<%= readme %>"<% end %>
+  rd.rdoc_files.include(<%= %{"#{readme}", } if readme %>"lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end
+
+# If you want to publish to RubyForge automatically, here's a simple 
+# task to help do that. If you don't, just get rid of this.
+begin
+  require "rake/contrib/sshpublisher"
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+ 
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/<%= gem_name %>/" # Should be the same as the rubyforge project name
+        local_dir = 'rdoc'
+ 
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/Readme.markdown

@@ -0,0 +1,91 @@
+Most of the time, I don't set out to write a gem. 
+=================================================
+
+Perhaps I'm not audacious enough to consider every piece of code I write to be worthy of use by other developers. Perhaps.
+
+But, more likely than that, it's just that I don't think that far ahead. I'm more interested in playing with the idea at the start, rather than thinking about how other people are going to remember - nay, worship my name, years in the future.
+
+Anyway, sometimes - after a bit of tinkering and pondering - I do end up with a library that I consider gem-worthy and fit for consumption. But every time I look at the existing tools to build gems, I'm paralysed by the comprehensive nature of their function. 
+
+Often, they'll try to generate a particular directory structure, with test stubs and a website, which is fine in principle, but I've already got my code the way I want it; I'm not generating a new project.
+
+Even worse, sometimes they'll add themselves as dependencies for your gem! Yuck.
+
+I am not interested in that. I just want the simplest thing that could possibly work, to build my gem and make it available to the world. I will add any bells and whistles that I want later.
+
+And so:
+
+Gem This
+========
+
+The `gem-this` command expects to be run in the directory of your existing code:
+
+    $ cd my-project
+    $ mate lib/sweet_code.rb
+     ... hacking ...
+    $ gem-this
+  
+When you run `gem-this`, it will create a new `Rakefile` in your project directory. If you already had a `Rakefile`, it will append to the end of it, so your existing tasks are safe.
+
+    $ rake -T
+    rake clean                   # Clear out RDoc and generated packages
+    rake clobber_package         # Remove package products
+    rake clobber_rdoc            # Remove rdoc products
+    rake gem                     # Build the gem file gem-this-0.1.0.gem
+    rake package                 # Build all the packages
+    rake rdoc                    # Build the rdoc HTML Files
+    rake repackage               # Force a rebuild of the package files
+    rake rerdoc                  # Force a rebuild of the RDOC files
+    rake rubyforge:release       # Release gem and RDoc documentation to RubyForge
+    rake rubyforge:release:docs  # Publish RDoc to RubyForge.
+
+
+The simplest thing to do next is simply run `rake package`:
+
+    mkdir -p pkg
+      Successfully built RubyGem
+      Name: my-project
+      Version: 0.1.0
+      File: my-project-0.1.0.gem
+    mv my-project-0.1.0.gem pkg/my-project-0.1.0.gem
+    
+As you can tell, it's used the current directory name as the name of the gem. But, you can change any of that. Just open your `Rakefile` and edit the details.
+
+It tries to be a little bit clever, detecting the presence of a few directories (like `bin`, `test` and `spec`) and behave accordingly. If you're already using git, it will ignore the `rdoc` and `pkg` directories for you.
+
+What next?
+----------
+
+For the most part, `gem-this` simply sets up a good base for you to customise yourself, with as little fuss or overhead as possible. It's up to you if you want make it more sophisticated, but I trust you. 
+
+Don't worry; you'll be fine.
+
+
+Thanks
+======
+
+Inspiration, and sometimes code chunks, were taking from lots of the existing gem tools, but particularly 'gemify' (wish I could've used that name!) and 'simple-gem'.
+
+
+MIT License
+===========
+
+(c) James Adam 2009, or whatever
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/gem-this

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+args = ARGV.dup
+
+if args.first =~ /-?-h/
+  puts "Creates a Rakefile suitable for turning the current project into a gem."
+  puts "Usage: #{__FILE__} [-d -h] [gem name]"
+  puts "If a gem name is not given, the name of the current directory will be used as the gem"
+  puts "-h    help, prints out this message."
+  puts "-d    debug, only prints out the generated Rakefile."
+  exit(0)
+end
+
+debug = args.delete("-d")
+
+gem_name = args.first || File.basename(Dir.pwd)
+
+def using_rspec?
+  File.directory?('spec')
+end
+
+def using_test_unit?
+  File.directory?('test')
+end
+
+def has_executables?
+  File.directory?('bin')
+end
+
+def dirs_to_include
+  %w(bin test spec lib).select { |d| File.directory?(d) }.join(",")
+end
+
+def readme
+  Dir['*'].find { |f| f =~ /readme/i }
+end
+
+def files_in_root
+  Dir['*'].reject { |f| File.directory?(f) }.join(" ")
+end
+
+def using_git?
+  File.exist?(".git")
+end
+
+def add_to_gitignore
+  ignores = File.readlines(".gitignore") if File.exist?(".gitignore")
+  ignores += ["pkg", "rdoc"]
+  File.open(".gitignore", "w") { |f| f.write ignores.map { |l| l.strip }.uniq.join("\n") }
+end
+
+require 'erb'
+
+template = ERB.new File.read(File.join(File.dirname(__FILE__), '..', 'Rakefile.erb')), nil, '<>'
+rakefile = template.result(binding)
+
+if debug
+  puts rakefile
+  exit(0)
+else
+  if File.exist?('Rakefile')
+    puts "Appended to existing Rakefile"
+    File.open('Rakefile', 'a') { |f| 2.times { f.puts }; f.write rakefile }
+  else
+    puts "Writing new Rakefile"
+    File.open('Rakefile', 'w') { |f| f.write rakefile }
+  end
+  add_to_gitignore if using_git?
+end
+
+exit(0)

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: gem-this
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- James Adam
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-08 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james@lazyatom.com
+executables: 
+- gem-this
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- Readme.markdown
+- Rakefile.erb
+- bin/gem-this
+has_rdoc: true
+homepage: http://github.com/lazyatom/gem-this
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- bin
+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: gem-this
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Make existing code into a gem, without any fuss.
+test_files: []
+