jeweler 1.1.0 → 1.2.0

data/ChangeLog.markdown

@@ -1,3 +1,9 @@
+# jeweler 1.2.0 2009-08-06
+ * Generator now adds development dependencies appropriate to your testing framework
+ * Added check_dependencies tasks for verifying gem dependencies are installed
+ * Fixed typo in generated yard task
+ * Fixed generator from having a lot of extra newlines
+
 # jeweler 1.1.0 2009-08-05
 
  * Support for generating a project that uses yard instead of rdoc

data/Rakefile

@@ -96,31 +96,6 @@ else
   task :default => :test
 end
 
-namespace :development_dependencies do
-  task :check do
-    missing_dependencies = Rake.application.jeweler.gemspec.development_dependencies.select do |dependency|
-      begin
-        Gem.activate dependency.name, dependency.version_requirements.to_s
-        false
-      rescue LoadError => e
-        true
-      end
-    end
-
-    #require 'ruby-debug'; breakpoint
-
-    if missing_dependencies.empty?
-      puts "Development dependencies seem to be installed."
-    else
-      puts "Missing some dependencies. Install them with the following commands:"
-      missing_dependencies.each do |dependency|
-        puts %Q{\tgem install #{dependency.name} --version "#{dependency.version_requirements}"}
-      end
-      abort "Run the specified gem commands before trying to run this again: #{$0} #{ARGV.join(' ')}"
-    end
-
-  end
-end
 
-task :test => 'development_dependencies:check'
-task :features => 'development_dependencies:check'
+task :test => :check_dependencies
+task :features => :check_dependencies

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:major: 1
 :patch: 0
-:minor: 1
+:major: 1
+:minor: 2

data/jeweler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jeweler}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nichols"]
-  s.date = %q{2009-08-05}
+  s.date = %q{2009-08-06}
   s.default_executable = %q{jeweler}
   s.description = %q{Simple and opinionated helper for creating Rubygem projects on GitHub}
   s.email = %q{josh@technicalpickles.com}
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
      "lib/jeweler.rb",
      "lib/jeweler/commands.rb",
      "lib/jeweler/commands/build_gem.rb",
+     "lib/jeweler/commands/check_dependencies.rb",
      "lib/jeweler/commands/install_gem.rb",
      "lib/jeweler/commands/release.rb",
      "lib/jeweler/commands/release_to_rubyforge.rb",
@@ -70,9 +71,11 @@ Gem::Specification.new do |s|
      "lib/jeweler/generator/micronaut_mixin.rb",
      "lib/jeweler/generator/minitest_mixin.rb",
      "lib/jeweler/generator/options.rb",
+     "lib/jeweler/generator/rdoc_mixin.rb",
      "lib/jeweler/generator/rspec_mixin.rb",
      "lib/jeweler/generator/shoulda_mixin.rb",
      "lib/jeweler/generator/testunit_mixin.rb",
+     "lib/jeweler/generator/yard_mixin.rb",
      "lib/jeweler/rubyforge_tasks.rb",
      "lib/jeweler/specification.rb",
      "lib/jeweler/tasks.rb",

data/lib/jeweler.rb

@@ -129,6 +129,12 @@ class Jeweler
     Jeweler::Commands::SetupRubyforge.build_for(self).run
   end
 
+  def check_dependencies(type = nil)
+    command = Jeweler::Commands::CheckDependencies.build_for(self)
+    command.type = type
+
+    command.run
+  end
 
   def in_git_repo?
     File.exists?(File.join(self.base_dir, '.git'))

data/lib/jeweler/commands.rb

@@ -1,5 +1,6 @@
 require 'jeweler/commands/build_gem'
 require 'jeweler/commands/install_gem'
+require 'jeweler/commands/check_dependencies'
 require 'jeweler/commands/release'
 require 'jeweler/commands/release_to_rubyforge'
 require 'jeweler/commands/setup_rubyforge'

data/lib/jeweler/commands/check_dependencies.rb

@@ -0,0 +1,52 @@
+class Jeweler
+  module Commands
+    class CheckDependencies
+      class MissingDependenciesError < RuntimeError
+        attr_accessor :dependencies, :type
+      end
+
+      attr_accessor :gemspec, :type
+
+      def run
+        missing_dependencies = dependencies.select do |dependency|
+          begin
+            Gem.activate dependency.name, dependency.version_requirements.to_s
+            false
+          rescue LoadError => e
+            true
+          end
+        end
+
+        if missing_dependencies.empty?
+          puts "#{type || 'All'} dependencies seem to be installed."
+        else
+          puts "Missing some dependencies. Install them with the following commands:"
+          missing_dependencies.each do |dependency|
+            puts %Q{\tgem install #{dependency.name} --version "#{dependency.version_requirements}"}
+          end
+          
+          abort "Run the specified gem commands before trying to run this again: #{$0} #{ARGV.join(' ')}"
+        end
+        
+      end
+
+      def dependencies
+        case type
+        when :runtime, :development
+          gemspec.send("#{type}_dependencies")
+        else
+          gemspec.dependencies
+        end
+        
+      end
+
+      def self.build_for(jeweler)
+        command = new
+
+        command.gemspec = jeweler.gemspec
+
+        command
+      end
+    end
+  end
+end

data/lib/jeweler/generator.rb

@@ -11,6 +11,9 @@ require 'jeweler/generator/rspec_mixin'
 require 'jeweler/generator/shoulda_mixin'
 require 'jeweler/generator/testunit_mixin'
 
+require 'jeweler/generator/rdoc_mixin'
+require 'jeweler/generator/yard_mixin'
+
 class Jeweler
   class NoGitUserName < StandardError
   end
@@ -29,12 +32,12 @@ class Jeweler
 
   class Generator    
     attr_accessor :target_dir, :user_name, :user_email, :summary,
-                  :project_name, :github_username, :github_token,
+                  :description, :project_name, :github_username, :github_token,
                   :repo, :should_create_repo, 
                   :testing_framework, :documentation_framework,
                   :should_use_cucumber, :should_setup_rubyforge,
                   :should_use_reek, :should_use_roodi,
-                  :description
+                  :development_dependencies
 
     DEFAULT_TESTING_FRAMEWORK = :shoulda
     DEFAULT_DOCUMENTATION_FRAMEWORK = :rdoc
@@ -44,6 +47,8 @@ class Jeweler
         raise NoGitHubRepoNameGiven
       end
 
+      self.development_dependencies = []
+
       self.project_name   = project_name
 
       self.testing_framework  = (options[:testing_framework] || DEFAULT_TESTING_FRAMEWORK).to_sym
@@ -56,6 +61,14 @@ class Jeweler
         raise ArgumentError, "Unsupported testing framework (#{testing_framework})"
       end
 
+      begin
+        generator_mixin_name = "#{self.documentation_framework.to_s.capitalize}Mixin"
+        generator_mixin = self.class.const_get(generator_mixin_name)
+        extend generator_mixin
+      rescue NameError => e
+        raise ArgumentError, "Unsupported documentation framework (#{documentation_framework})"
+      end
+
 
       self.target_dir             = options[:directory] || self.project_name
 
@@ -67,6 +80,8 @@ class Jeweler
       self.should_use_roodi       = options[:use_roodi]
       self.should_setup_rubyforge = options[:rubyforge]
 
+      development_dependencies << "cucumber" if should_use_cucumber
+
       use_user_git_config
       
     end
@@ -131,14 +146,6 @@ class Jeweler
       File.join(features_dir, 'step_definitions')
     end
 
-    def doc_task
-      case documentation_framework
-      when :yard then "yardoc"
-      else
-        documentation_framework.to_s
-      end
-    end
-
   protected
 
     # This is in a separate method so we can stub it out during testing
@@ -214,7 +221,7 @@ class Jeweler
       template_contents = File.read(File.join(template_dir, source))
       template = ERB.new(template_contents, nil, '<>')
 
-      template_result = template.result(binding)
+      template_result = template.result(binding).gsub(/\n\n\n+/, "\n\n")
 
       File.open(final_destination, 'w') {|file| file.write(template_result)}
 

data/lib/jeweler/generator/bacon_mixin.rb

@@ -2,6 +2,10 @@ class Jeweler
   class Generator
     module BaconMixin
 
+      def self.extended(generator)
+        generator.development_dependencies << "bacon"
+      end
+
       def default_task
         'spec'
       end

data/lib/jeweler/generator/micronaut_mixin.rb

@@ -1,6 +1,9 @@
 class Jeweler
   class Generator
     module MicronautMixin
+      def self.extended(generator)
+        generator.development_dependencies << "spicycode-micronaut"
+      end
       
       def default_task
         'examples'

data/lib/jeweler/generator/minitest_mixin.rb

@@ -1,6 +1,9 @@
 class Jeweler
   class Generator
     module MinitestMixin
+      def self.extended(generator)
+        generator.development_dependencies << "minitest"
+      end
 
       def default_task
         'test'

data/lib/jeweler/generator/rdoc_mixin.rb

@@ -0,0 +1,9 @@
+class Jeweler
+  class Generator
+    module RdocMixin
+      def doc_task
+        'rdoc'
+      end
+    end
+  end
+end

data/lib/jeweler/generator/rspec_mixin.rb

@@ -1,6 +1,9 @@
 class Jeweler
   class Generator
     module RspecMixin
+      def self.extended(generator)
+        generator.development_dependencies << "rspec"
+      end
 
       def default_task
         'spec'

data/lib/jeweler/generator/shoulda_mixin.rb

@@ -1,6 +1,9 @@
 class Jeweler
   class Generator
     module ShouldaMixin
+      def self.extended(generator)
+        generator.development_dependencies << "thoughtbot-shoulda"
+      end
 
       def default_task
         'test'

data/lib/jeweler/generator/yard_mixin.rb

@@ -0,0 +1,14 @@
+class Jeweler
+  class Generator
+    module YardMixin
+      def self.extended(generator)
+        generator.development_dependencies << "yard"
+      end
+      
+      def doc_task
+        'yardoc'
+      end
+    end
+  end
+end
+

data/lib/jeweler/tasks.rb

@@ -111,6 +111,24 @@ class Jeweler
       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

data/lib/jeweler/templates/Rakefile

@@ -12,10 +12,12 @@ begin
     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_rubyforge %>
   Jeweler::RubyforgeTasks.new do |rubyforge|
     rubyforge.doc_task = "<%= doc_task %>"
@@ -75,10 +77,14 @@ rescue LoadError
 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"
@@ -138,7 +144,7 @@ begin
   YARD::Rake::YardocTask.new
 rescue LoadError
   task :yardoc do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
 end
 <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeweler
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Josh Nichols
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-05 00:00:00 -04:00
+date: 2009-08-06 00:00:00 -04:00
 default_executable: jeweler
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -124,6 +124,7 @@ files:
 - lib/jeweler.rb
 - lib/jeweler/commands.rb
 - lib/jeweler/commands/build_gem.rb
+- lib/jeweler/commands/check_dependencies.rb
 - lib/jeweler/commands/install_gem.rb
 - lib/jeweler/commands/release.rb
 - lib/jeweler/commands/release_to_rubyforge.rb
@@ -143,9 +144,11 @@ files:
 - lib/jeweler/generator/micronaut_mixin.rb
 - lib/jeweler/generator/minitest_mixin.rb
 - lib/jeweler/generator/options.rb
+- lib/jeweler/generator/rdoc_mixin.rb
 - lib/jeweler/generator/rspec_mixin.rb
 - lib/jeweler/generator/shoulda_mixin.rb
 - lib/jeweler/generator/testunit_mixin.rb
+- lib/jeweler/generator/yard_mixin.rb
 - lib/jeweler/rubyforge_tasks.rb
 - lib/jeweler/specification.rb
 - lib/jeweler/tasks.rb