mcornick-jeweler 1.2.0

data/lib/jeweler/specification.rb

@@ -0,0 +1,66 @@
+require 'rubygems/specification'
+
+class Jeweler
+  # Extend a Gem::Specification instance with this module to give it Jeweler
+  # super-cow powers.
+  module Specification
+
+    def self.filelist_attribute(name)
+      code = %{
+        def #{name}
+          @#{name} ||= FileList[]
+        end
+        def #{name}=(value)
+          @#{name} = FileList[value]
+        end
+      }
+
+      module_eval code, __FILE__, __LINE__ - 9
+    end
+
+    filelist_attribute :files
+    filelist_attribute :test_files
+    filelist_attribute :extra_rdoc_files
+
+
+    # Assigns the Jeweler defaults to the Gem::Specification
+    def set_jeweler_defaults(base_dir)
+      Dir.chdir(base_dir) do
+        if blank?(files) && File.directory?(File.join(base_dir, '.git'))
+          repo = Git.open(base_dir)
+          self.files = repo.ls_files.keys - repo.lib.ignored_files
+        end
+
+        if blank?(test_files) && File.directory?(File.join(base_dir, '.git'))
+          repo = Git.open(base_dir)
+          self.test_files = FileList['{spec,test,examples}/**/*.rb'] - repo.lib.ignored_files
+        end
+
+        if blank?(executables)
+          self.executables = Dir["bin/*"].map { |f| File.basename(f) }
+        end
+
+        self.has_rdoc = true
+        rdoc_options << '--charset=UTF-8'
+
+        if blank?(extra_rdoc_files)
+          self.extra_rdoc_files = FileList["README*", "ChangeLog*", "LICENSE*"]
+        end
+      end
+    end
+
+    # Used by Specification#to_ruby to generate a ruby-respresentation of a Gem::Specification
+    def ruby_code(obj)
+      case obj
+      when Rake::FileList then obj.to_a.inspect
+      else super
+      end
+    end
+
+    private
+
+    def blank?(value)
+      value.nil? || value.empty?
+    end
+  end
+end

data/lib/jeweler/tasks.rb

@@ -0,0 +1,135 @@
+require 'rake'
+require 'rake/tasklib'
+
+class Rake::Application
+  attr_accessor :jeweler
+end
+
+class Jeweler
+  # Rake tasks for managing your gem.
+  #
+  # Here's a basic example of using it:
+  #
+  #   Jeweler::Tasks.new do |gem|
+  #     gem.name = "jeweler"
+  #     gem.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  #     gem.email = "josh@technicalpickles.com"
+  #     gem.homepage = "http://github.com/technicalpickles/jeweler"
+  #     gem.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  #     gem.authors = ["Josh Nichols"]
+  #   end
+  #
+  # The block variable gem is actually a Gem::Specification, so you can do anything you would normally do with a Gem::Specification. For more details, see the official gemspec reference: http://docs.rubygems.org/read/chapter/20
+  #
+  # Jeweler fills in a few reasonable defaults for you:
+  #
+  # [gem.files] a Rake::FileList of anything that is in git and not gitignored. You can include/exclude this default set, or override it entirely
+  # [gem.test_files] Similar to gem.files, except it's only things under the spec, test, or examples directory.
+  # [gem.extra_rdoc_files] a Rake::FileList including files like README*, ChangeLog*, and LICENSE*
+  # [gem.executables] uses anything found in the bin/ directory. You can override this.
+  #
+  class Tasks < ::Rake::TaskLib
+    attr_accessor :gemspec, :jeweler
+
+    def initialize(gemspec = nil, &block)
+      @gemspec = gemspec || Gem::Specification.new
+      @jeweler = Jeweler.new(@gemspec)
+      yield @gemspec if block_given?
+
+      Rake.application.jeweler = @jeweler
+      define
+    end
+
+  private
+    def define
+      task :version_required do
+        unless jeweler.version_exists?
+          abort "Expected VERSION or VERSION.yml to exist. See version:write to create an initial one."
+        end
+      end
+
+      desc "Build gem"
+      task :build do
+        jeweler.build_gem
+      end
+
+      desc "Install gem using sudo"
+      task :install => :build do
+        jeweler.install_gem
+      end
+
+      desc "Generate and validates gemspec"
+      task :gemspec => ['gemspec:generate', 'gemspec:validate']
+
+      namespace :gemspec do
+        desc "Validates the gemspec"
+        task :validate => :version_required do
+          jeweler.validate_gemspec
+        end
+
+        desc "Generates the gemspec, using version from VERSION"
+        task :generate => :version_required do
+          jeweler.write_gemspec
+        end
+      end
+
+      desc "Displays the current version"
+      task :version => :version_required do
+        $stdout.puts "Current version: #{jeweler.version}"
+      end
+
+      namespace :version do
+        desc "Writes out an explicit version. Respects the following environment variables, or defaults to 0: MAJOR, MINOR, PATCH"
+        task :write do
+          major, minor, patch = ENV['MAJOR'].to_i, ENV['MINOR'].to_i, ENV['PATCH'].to_i
+          jeweler.write_version(major, minor, patch, :announce => false, :commit => false)
+          $stdout.puts "Updated version: #{jeweler.version}"
+        end
+
+        namespace :bump do
+          desc "Bump the gemspec by a major version."
+          task :major => [:version_required, :version] do
+            jeweler.bump_major_version
+            $stdout.puts "Updated version: #{jeweler.version}"
+          end
+
+          desc "Bump the gemspec by a minor version."
+          task :minor => [:version_required, :version] do
+            jeweler.bump_minor_version
+            $stdout.puts "Updated version: #{jeweler.version}"
+          end
+
+          desc "Bump the gemspec by a patch version."
+          task :patch => [:version_required, :version] do
+            jeweler.bump_patch_version
+            $stdout.puts "Updated version: #{jeweler.version}"
+          end
+        end
+      end
+
+      desc "Release the current version. Includes updating the gemspec, pushing, and tagging the release"
+      task :release do
+        jeweler.release
+      end
+
+      desc "Check that runtime and development dependencies are installed" 
+      task :check_dependencies do
+        jeweler.check_dependencies
+      end
+
+      namespace :check_dependencies do
+        desc "Check that runtime dependencies are installed"
+        task :runtime  do
+          jeweler.check_dependencies(:runtime)
+        end
+
+        desc"Check that development dependencies are installed"
+        task :development do
+          jeweler.check_dependencies(:development)
+        end
+
+      end
+      
+    end
+  end
+end

data/lib/jeweler/templates/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/lib/jeweler/templates/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/lib/jeweler/templates/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 <%= user_name %>
+
+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/lib/jeweler/templates/README.rdoc

@@ -0,0 +1,18 @@
+= <%= project_name %>
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) <%= Time.now.year %> <%= user_name %>. See LICENSE for details.

data/lib/jeweler/templates/Rakefile

@@ -0,0 +1,153 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "<%= project_name %>"
+    gem.summary = %Q{<%= summary %>}
+    gem.description = %Q{<%= description %>}
+    gem.email = "<%= user_email %>"
+    gem.homepage = "<%= project_homepage %>"
+    gem.authors = ["<%= user_name %>"]
+<% if should_setup_rubyforge %>
+    gem.rubyforge_project = "<%= project_name %>"
+<% end %>
+<% development_dependencies.each do |dependency| %>
+    gem.add_development_dependency "<%= dependency %>"
+<% end %>
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+<% if should_setup_gemcutter %>
+  Jeweler::GemcutterTasks.new
+<% end %>
+<% if should_setup_rubyforge %>
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "<%= doc_task %>"
+  end
+<% end %>
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+<% case testing_framework %>
+<% when :rspec %>
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:<%= test_task %>) do |<%= test_task %>|
+  <%= test_task %>.libs << 'lib' << '<%= test_dir %>'
+  <%= test_task %>.spec_files = FileList['<%= test_pattern %>']
+end
+<% when :micronaut %>
+require 'micronaut/rake_task'
+Micronaut::RakeTask.new(<%= test_task %>) do |<%= test_task %>|
+  <%= test_task %>.pattern = '<%= test_pattern %>'
+  <%= test_task %>.ruby_opts << '-Ilib -I<%= test_dir %>'
+end
+<% else %>
+require 'rake/testtask'
+Rake::TestTask.new(:<%= test_task %>) do |<%= test_task %>|
+  <%= test_task %>.libs << 'lib' << '<%= test_dir %>'
+  <%= test_task %>.pattern = '<%= test_pattern %>'
+  <%= test_task %>.verbose = true
+end
+<% end %>
+
+<% case testing_framework %>
+<% when :rspec %>
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = '<%= test_pattern %>'
+  spec.rcov = true
+end
+<% when :micronaut %>
+Micronaut::RakeTask.new(:rcov) do |examples|
+  examples.pattern = '<%= test_pattern %>'
+  examples.rcov_opts = '-Ilib -I<%= test_dir %>'
+  examples.rcov = true
+end
+<% else %>
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |<%= test_task %>|
+    <%= test_task %>.libs << '<%= test_dir %>'
+    <%= test_task %>.pattern = '<%= test_pattern %>'
+    <%= test_task %>.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+<% end %>
+
+task :<%= test_task %> => :check_dependencies
+
+<% if should_use_cucumber %>
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+<% end %>
+
+<% if should_use_reek %>
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+<% end %>
+
+<% if should_use_roodi %>
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+<% end %>
+
+task :default => :<%= default_task %>
+
+<% case documentation_framework %>
+<% when :rdoc %>
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "<%= project_name %> #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+<% when :yard %>
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+<% end %>

data/lib/jeweler/templates/bacon/flunking.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "<%= constant_name %>" do
+  it "fails" do
+    should.flunk "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/lib/jeweler/templates/bacon/helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bacon'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require '<%= require_name %>'
+
+Bacon.summary_on_exit

data/lib/jeweler/templates/features/default.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/jeweler/templates/features/support/env.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require '<%= require_name %>'
+
+require '<%= feature_support_require %>'
+<% if feature_support_extend %>
+
+World(<%= feature_support_extend %>)
+<% end %>