gem-this 0.2.1 → 0.3.0

data/Rakefile

@@ -2,8 +2,13 @@ require "rubygems"
 require "rake/gempackagetask"
 require "rake/rdoctask"
 
-task :default => :package do
-  puts "Don't forget to write some tests!"
+task :default => :test
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs = [File.expand_path("lib"), "test"]
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
 end
 
 # This builds the actual gem. For details of what all these options
@@ -12,10 +17,10 @@ end
 #   http://rubygems.org/read/chapter/20
 #
 spec = Gem::Specification.new do |s|
-  
+
   # Change these as appropriate
   s.name              = "gem-this"
-  s.version           = "0.2.1"
+  s.version           = "0.3.0"
   s.summary           = "Make existing code into a gem, without any fuss."
   s.author            = "James Adam"
   s.email             = "james@lazyatom.com"
@@ -29,28 +34,30 @@ spec = Gem::Specification.new do |s|
   s.files             = %w(Rakefile Readme.markdown Rakefile.erb) + Dir.glob("{bin,lib}/**/*")
   s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
   s.require_paths     = ["bin", "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 your tests use any gems, include them here
-  # s.add_development_dependency("mocha")
+  s.add_development_dependency("shoulda")
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("cucumber")
 
   # 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"
-  
+
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3")
 end
 
-# This task actually builds the gem. We also regenerate a static 
+# 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 }
@@ -68,7 +75,7 @@ task :clean => [:clobber_rdoc, :clobber_package] do
   rm "#{spec.name}.gemspec"
 end
 
-# If you want to publish to RubyForge automatically, here's a simple 
+# 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; you'll need to run `rubyforge setup` and `rubyforge config` at
@@ -76,10 +83,10 @@ end
 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
@@ -92,17 +99,17 @@ begin
         puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
         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

data/Rakefile.erb

@@ -3,8 +3,6 @@ require "rake/gempackagetask"
 require "rake/rdoctask"
 
 <% if using_rspec? %>
-task :default => :spec
-
 require "spec"
 require "spec/rake/spectask"
 Spec::Rake::SpecTask.new do |t|
@@ -12,18 +10,28 @@ Spec::Rake::SpecTask.new do |t|
   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 %>
+<% end %>
+
+<% if using_cucumber? %>
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new('features') do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+<% end %>
+
+<% if default_tasks.empty? %>
 task :default => :package do
   puts "Don't forget to write some tests!"
 end
+<% else %>
+task :default => <%= default_tasks.inspect %>
 <% end %>
 
 # This builds the actual gem. For details of what all these options
@@ -32,7 +40,7 @@ end
 #   http://rubygems.org/read/chapter/20
 #
 spec = Gem::Specification.new do |s|
-  
+
   # Change these as appropriate
   s.name              = "<%= name %>"
   s.version           = "0.1.0"
@@ -47,7 +55,7 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options      = %w(--main <%= readme %>)
 
   # Add any extra files to include in the gem
-<% else %>  
+<% else %>
   # You should probably have a README of some kind. Change the filename
   # as appropriate
   # s.extra_rdoc_files  = %w(README)
@@ -55,21 +63,34 @@ spec = Gem::Specification.new do |s|
 
   # Add any extra files to include in the gem (like your README)
 <% end %>
-  s.files             = %w(<%= files_in_root %>) + Dir.glob("{<%= dirs_to_include %>}/**/*")
+  s.files             = %w(<%= files_in_root %>) + Dir.glob("{<%= dirs_to_include_glob %>}")
 <% if has_executables? %>
   s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
-<% end %>   
+<% end %>
+<% if has_lib_directory? %>
   s.require_paths     = ["lib"]
-  
+<% else %>
+
+  # You need to put your code in a directory which can then be added to
+  # the $LOAD_PATH by rubygems. Typically this is lib, but you don't seem
+  # to have that directory. You'll need to set the line below to whatever
+  # directory your code is in. Rubygems is going to assume lib if you leave
+  # this blank.
+  #
+  # s.require_paths = ["lib"]
+<% end %>
+
   # 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")
+<% if development_dependencies.any? %>
+<% development_dependencies.each do |dependency| %>
+  s.add_development_dependency("<%= dependency %>")
+<% end %>
+<% else %>
+  # s.add_development_dependency("mocha") # for example
 <% end %>
 
   # If you want to publish automatically to rubyforge, you'll may need
@@ -77,13 +98,13 @@ spec = Gem::Specification.new do |s|
   s.rubyforge_project = "<%= name %>"
 end
 
-# This task actually builds the gem. We also regenerate a static 
+# 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 }
@@ -101,7 +122,7 @@ task :clean => [:clobber_rdoc, :clobber_package] do
   rm "#{spec.name}.gemspec"
 end
 
-# If you want to publish to RubyForge automatically, here's a simple 
+# 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; you'll need to run `rubyforge setup` and `rubyforge config` at
@@ -109,10 +130,10 @@ end
 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
@@ -125,21 +146,21 @@ begin
         puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
         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/<%= 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
+end

data/bin/gem-this

@@ -15,6 +15,6 @@ end
 
 debug = args.delete("-d")
 
-GemThis.new(args.first || File.basename(Dir.pwd), debug).create_rakefile
+GemThis.new(args.first || File.basename(Dir.pwd), :debug => debug).create_rakefile
 
 exit

data/lib/gem_this.rb

@@ -4,14 +4,16 @@ require 'etc'
 class GemThis
   SUMMARY = "Creates a Rakefile suitable for turning the current project into a gem."
   DEBUG_MESSAGE = "debug, only prints out the generated Rakefile."
-  
+
   attr_reader :name, :debug
-  
-  def initialize(name, debug)
+
+  def initialize(name, options={})
     @name = name
-    @debug = debug
+    options = {:default => false, :silent => false}.update(options)
+    @debug = options[:debug]
+    @silent = options[:silent]
   end
-  
+
   def create_rakefile
     template = ERB.new File.read(File.join(File.dirname(__FILE__), '..', 'Rakefile.erb')), nil, '<>'
     rakefile = template.result(binding)
@@ -20,18 +22,26 @@ class GemThis
       puts rakefile
     else
       if File.exist?('Rakefile')
-        puts "Appended to existing Rakefile"
+        log "Appended to existing Rakefile"
         File.open('Rakefile', 'a') { |f| 2.times { f.puts }; f.write rakefile }
       else
-        puts "Writing new Rakefile"
+        log "Writing new Rakefile"
         File.open('Rakefile', 'w') { |f| f.write rakefile }
       end
       add_to_gitignore if using_git?
     end
+    unless has_lib_directory?
+      log "You don't see to have a lib directory - please edit the Rakefile to set where your code is."
+      false
+    end
   end
-  
+
   private
-  
+
+  def log(message)
+    puts(message) unless @silent
+  end
+
   def author_name
     Etc.getpwnam(ENV['USER']).gecos rescue ENV['USER'] # for Windows
   end
@@ -48,6 +58,10 @@ class GemThis
     File.directory?('spec')
   end
 
+  def using_cucumber?
+    File.directory?('features')
+  end
+
   def using_test_unit?
     File.directory?('test')
   end
@@ -56,8 +70,17 @@ class GemThis
     File.directory?('bin')
   end
 
-  def dirs_to_include
-    %w(bin test spec lib).select { |d| File.directory?(d) }.join(",")
+  def has_lib_directory?
+    File.directory?("lib")
+  end
+
+  def dirs_to_include_glob
+    dirs = %w(bin test spec lib).select { |d| File.directory?(d) }
+    if dirs.any?
+      dirs.join(",") + "/**/*"
+    else
+      "**/*"
+    end
   end
 
   def readme
@@ -72,10 +95,25 @@ class GemThis
     File.exist?(".git")
   end
 
+  def default_tasks
+    tasks = []
+    tasks << "test" if using_test_unit?
+    tasks << "spec" if using_rspec?
+    tasks << "features" if using_cucumber?
+    tasks
+  end
+
+  def development_dependencies
+    deps = []
+    deps << "rspec" if using_rspec?
+    deps << "cucumber" if using_cucumber?
+    deps
+  end
+
   def add_to_gitignore
     return unless File.exist?(".gitignore")
     ignores = File.readlines(".gitignore")
     ignores += ["pkg", "rdoc"]
     File.open(".gitignore", "w") { |f| f.write ignores.map { |l| l.strip }.uniq.join("\n") }
   end
-end
+end

data/lib/rubygems_plugin.rb

@@ -15,7 +15,7 @@ class Gem::Commands::ThisCommand < Gem::Command
   end
   
   def execute
-    GemThis.new(options[:args].first || File.basename(Dir.pwd), options[:debug]).create_rakefile
+    GemThis.new(options[:args].first || File.basename(Dir.pwd), options).create_rakefile
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gem-this
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - James Adam
@@ -9,10 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 +01:00
+date: 2009-12-22 00:00:00 +00:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: 
 email: james@lazyatom.com
 executables: 
@@ -53,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gem-this
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Make existing code into a gem, without any fuss.