mcornick-jeweler 1.2.0

data/lib/jeweler/generator/application.rb

@@ -0,0 +1,54 @@
+class Jeweler
+  class Generator
+    class Application
+      class << self
+        def run!(*arguments)
+          env_opts = if ENV['JEWELER_OPTS']
+            Jeweler::Generator::Options.new(ENV['JEWELER_OPTS'].split(' '))
+          end
+          options = Jeweler::Generator::Options.new(arguments)
+          options = options.merge(env_opts) if env_opts
+
+          if options[:invalid_argument]
+            $stderr.puts options[:invalid_argument]
+            options[:show_help] = true
+          end
+
+          if options[:show_help]
+            $stderr.puts options.opts
+            return 1
+          end
+
+          unless arguments.size == 1
+            $stderr.puts options.opts
+            return 1
+          end
+
+          project_name = arguments.first
+
+          begin
+            generator = Jeweler::Generator.new(project_name, options)
+            generator.run
+            return 0
+          rescue Jeweler::NoGitUserName
+            $stderr.puts %Q{No user.name found in ~/.gitconfig. Please tell git about yourself (see http://github.com/guides/tell-git-your-user-name-and-email-address for details). For example: git config --global user.name "mad voo"}
+            return 1
+          rescue Jeweler::NoGitUserEmail
+            $stderr.puts %Q{No user.email found in ~/.gitconfig. Please tell git about yourself (see http://github.com/guides/tell-git-your-user-name-and-email-address for details). For example: git config --global user.email mad.vooo@gmail.com}
+            return 1
+          rescue Jeweler::NoGitHubUser
+            $stderr.puts %Q{No github.user found in ~/.gitconfig. Please tell git about your GitHub account (see http://github.com/blog/180-local-github-config for details). For example: git config --global github.user defunkt}
+            return 1
+          rescue Jeweler::NoGitHubToken
+            $stderr.puts %Q{No github.token found in ~/.gitconfig. Please tell git about your GitHub account (see http://github.com/blog/180-local-github-config for details). For example: git config --global github.token 6ef8395fecf207165f1a82178ae1b984}
+            return 1
+          rescue Jeweler::FileInTheWay
+            $stderr.puts "The directory #{project_name} already exists. Maybe move it out of the way before continuing?"
+            return 1
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/jeweler/generator/bacon_mixin.rb

@@ -0,0 +1,43 @@
+class Jeweler
+  class Generator
+    module BaconMixin
+
+      def self.extended(generator)
+        generator.development_dependencies << "bacon"
+      end
+
+      def default_task
+        'spec'
+      end
+
+      def feature_support_require
+        'test/unit/assertions'
+      end
+
+      def feature_support_extend
+        'Test::Unit::Assertions' # NOTE can't use bacon inside of cucumber actually
+      end
+
+      def test_dir
+        'spec'
+      end
+
+      def test_task
+        'spec'
+      end
+
+      def test_pattern
+        'spec/**/*_spec.rb'
+      end
+
+      def test_filename
+        "#{require_name}_spec.rb"
+      end
+
+      def test_helper_filename
+        "spec_helper.rb"
+      end
+
+    end
+  end
+end

data/lib/jeweler/generator/micronaut_mixin.rb

@@ -0,0 +1,41 @@
+class Jeweler
+  class Generator
+    module MicronautMixin
+      def self.extended(generator)
+        generator.development_dependencies << "spicycode-micronaut"
+      end
+      
+      def default_task
+        'examples'
+      end
+
+      def feature_support_require
+        'micronaut/expectations'
+      end
+
+      def feature_support_extend
+        'Micronaut::Matchers'
+      end
+
+      def test_dir
+        'examples'
+      end
+
+      def test_task
+        'examples'
+      end
+
+      def test_pattern
+        'examples/**/*_example.rb'
+      end
+
+      def test_filename
+        "#{require_name}_example.rb"
+      end
+
+      def test_helper_filename
+        "example_helper.rb"
+      end
+    end
+  end
+end

data/lib/jeweler/generator/minitest_mixin.rb

@@ -0,0 +1,42 @@
+class Jeweler
+  class Generator
+    module MinitestMixin
+      def self.extended(generator)
+        generator.development_dependencies << "minitest"
+      end
+
+      def default_task
+        'test'
+      end
+
+      def feature_support_require
+        'mini/test'
+      end
+
+      def feature_support_extend
+        'Mini::Test::Assertions'
+      end
+
+      def test_dir
+        'test'
+      end
+
+      def test_task
+        'test'
+      end
+
+      def test_pattern
+        'test/**/*_test.rb'
+      end
+
+      def test_filename
+        "#{require_name}_test.rb"
+      end
+
+      def test_helper_filename
+        "test_helper.rb"
+      end
+
+    end
+  end
+end

data/lib/jeweler/generator/options.rb

@@ -0,0 +1,102 @@
+class Jeweler
+  class Generator
+    class Options < Hash
+      attr_reader :opts, :orig_args
+
+      def initialize(args)
+        super()
+
+        @orig_args = args.clone
+        self[:testing_framework]       = :shoulda
+        self[:documentation_framework] = :rdoc
+
+        @opts = OptionParser.new do |o|
+          o.banner = "Usage: #{File.basename($0)} [options] reponame\ne.g. #{File.basename($0)} the-perfect-gem"
+
+          o.on('--bacon', 'generate bacon specifications') do
+            self[:testing_framework] = :bacon
+          end
+
+          o.on('--shoulda', 'generate shoulda tests') do
+            self[:testing_framework] = :shoulda
+          end
+
+          o.on('--testunit', 'generate test/unit tests') do
+            self[:testing_framework] = :testunit
+          end
+
+          o.on('--minitest', 'generate minitest tests') do
+            self[:testing_framework] = :minitest
+          end
+
+          o.on('--rspec', 'generate rspec code examples') do
+            self[:testing_framework] = :rspec
+          end
+
+          o.on('--micronaut', 'generate micronaut examples') do
+            self[:testing_framework] = :micronaut
+          end
+
+          o.on('--cucumber', 'generate cucumber stories in addition to the other tests') do
+            self[:use_cucumber] = true
+          end
+
+          o.on('--reek', 'generate rake task for reek') do
+            self[:use_reek] = true
+          end
+
+          o.on('--roodi', 'generate rake task for roodi') do
+            self[:use_roodi] = true
+          end
+
+          o.on('--create-repo', 'create the repository on GitHub') do
+            self[:create_repo] = true
+          end
+
+          o.on('--gemcutter', 'setup project for gemcutter') do
+            self[:gemcutter] = true
+          end
+
+          o.on('--rubyforge', 'setup project for rubyforge') do
+            self[:rubyforge] = true
+          end
+
+          o.on('--summary [SUMMARY]', 'specify the summary of the project') do |summary|
+            self[:summary] = summary
+          end
+
+          o.on('--description [DESCRIPTION]', 'specify a description of the project') do |description|
+            self[:description] = description
+          end
+
+          o.on('--directory [DIRECTORY]', 'specify the directory to generate into') do |directory|
+            self[:directory] = directory
+          end
+
+          o.on('--yard', 'use yard for documentation') do
+            self[:documentation_framework] = :yard
+          end
+
+          o.on('--rdoc', 'use rdoc for documentation') do
+            self[:documentation_framework] = :rdoc
+          end
+
+          o.on_tail('-h', '--help', 'display this help and exit') do
+            self[:show_help] = true
+          end
+        end
+
+        begin
+          @opts.parse!(args)
+        rescue OptionParser::InvalidOption => e
+          self[:invalid_argument] = e.message
+        end
+      end
+
+      def merge(other)
+        self.class.new(@orig_args + other.orig_args)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+class Jeweler
+  class Generator
+    module RspecMixin
+      def self.extended(generator)
+        generator.development_dependencies << "rspec"
+      end
+
+      def default_task
+        'spec'
+      end
+
+      def feature_support_require
+        'spec/expectations'
+      end
+
+      def feature_support_extend
+        nil # Cucumber is smart enough extend Spec::Expectations on its own
+      end
+
+      def test_dir
+        'spec'
+      end
+
+      def test_task
+        'spec'
+      end
+
+      def test_pattern
+        'spec/**/*_spec.rb'
+      end
+
+      def test_filename
+        "#{require_name}_spec.rb"
+      end
+
+      def test_helper_filename
+        "spec_helper.rb"
+      end
+
+    end
+  end
+end

data/lib/jeweler/generator/shoulda_mixin.rb

@@ -0,0 +1,42 @@
+class Jeweler
+  class Generator
+    module ShouldaMixin
+      def self.extended(generator)
+        generator.development_dependencies << "thoughtbot-shoulda"
+      end
+
+      def default_task
+        'test'
+      end
+
+      def feature_support_require
+        'test/unit/assertions'
+      end
+
+      def feature_support_extend
+        'Test::Unit::Assertions'
+      end
+
+      def test_dir
+        'test'
+      end
+
+      def test_task
+        'test'
+      end
+
+      def test_pattern
+        'test/**/*_test.rb'
+      end
+
+      def test_filename
+        "#{require_name}_test.rb"
+      end
+
+      def test_helper_filename
+        "test_helper.rb"
+      end
+
+    end
+  end
+end

data/lib/jeweler/generator/testunit_mixin.rb

@@ -0,0 +1,39 @@
+class Jeweler
+  class Generator
+    module TestunitMixin
+
+      def default_task
+        'test'
+      end
+
+      def feature_support_require
+        'test/unit/assertions'
+      end
+
+      def feature_support_extend
+        'Test::Unit::Assertions'
+      end
+
+      def test_dir
+        'test'
+      end
+
+      def test_task
+        'test'
+      end
+
+      def test_pattern
+        'test/**/*_test.rb'
+      end
+
+      def test_filename
+        "#{require_name}_test.rb"
+      end
+
+      def test_helper_filename
+        "test_helper.rb"
+      end
+
+    end
+  end
+end

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/rubyforge_tasks.rb

@@ -0,0 +1,98 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rake/contrib/sshpublisher'
+
+
+class Jeweler
+  # Rake tasks for putting a Jeweler gem on Rubyforge.
+  #
+  # Jeweler::Tasks.new needs to be used before this.
+  #
+  # Basic usage:
+  #
+  #     Jeweler::RubyforgeTasks.new
+  #
+  # Easy enough, right?
+  # 
+  # There are a few options you can tweak:
+  #
+  #  * project: the rubyforge project to operate on. This defaults to whatever you specified in your gemspec. Defaults to your gem name.
+  #  * remote_doc_path: the place to upload docs to on Rubyforge under /var/www/gforge-projects/#{project}/
+  #
+  class RubyforgeTasks < ::Rake::TaskLib
+    # The RubyForge project to interact with. Defaults to whatever is in your jeweler gemspec.
+    attr_accessor :project
+    # The path to upload docs to. It is relative to /var/www/gforge-projects/#{project}/, and defaults to your gemspec's name
+    attr_accessor :remote_doc_path
+    # Task to be used for generating documentation, before they are uploaded. Defaults to rdoc.
+    attr_accessor :doc_task
+
+    attr_accessor :jeweler
+
+    def initialize
+      yield self if block_given?
+
+      self.jeweler = Rake.application.jeweler
+
+      self.remote_doc_path ||= jeweler.gemspec.name
+      self.project ||= jeweler.gemspec.rubyforge_project
+      self.doc_task ||= :rdoc
+
+      define
+    end
+
+    def define
+      namespace :rubyforge do
+
+        desc "Release gem and RDoc documentation to RubyForge"
+        task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+        namespace :release do
+          desc "Release the current gem version to RubyForge."
+          task :gem => [:gemspec, :build] do
+            begin
+              jeweler.release_gem_to_rubyforge
+            rescue NoRubyForgeProjectInGemspecError => e
+              abort "Setting up RubyForge requires that you specify a 'rubyforge_project' in your Jeweler::Tasks declaration"
+            rescue MissingRubyForgePackageError => e
+              abort "Rubyforge reported that the #{e.message} package isn't setup. Run rake rubyforge:setup to do so."
+            rescue RubyForgeProjectNotConfiguredError => e
+              abort "RubyForge reported that #{e.message} wasn't configured. This means you need to run 'rubyforge setup', 'rubyforge login', and 'rubyforge configure', or maybe the project doesn't exist on RubyForge"
+            end
+          end
+
+          desc "Publish docs to RubyForge."
+          task :docs => doc_task do
+            config = YAML.load(
+              File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+            )
+
+            host = "#{config['username']}@rubyforge.org"
+            remote_dir = "/var/www/gforge-projects/#{project}/#{remote_doc_path}"
+
+            local_dir = case self.doc_task.to_sym
+                        when :rdoc then 'rdoc'
+                        when :yardoc then 'doc'
+                        else
+                          raise "Unsure what to run to generate documentation. Please set doc_task and re-run."
+                        end
+
+            sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+          end
+        end
+
+        desc "Setup a rubyforge project for this gem"
+        task :setup do
+          begin 
+            jeweler.setup_rubyforge
+          rescue NoRubyForgeProjectInGemspecError => e
+            abort "Setting up RubyForge requires that you specify a 'rubyforge_project' in your Jeweler::Tasks declaration"
+          rescue RubyForgeProjectNotConfiguredError => e
+            abort "The RubyForge reported that #{e.message} wasn't configured. This means you need to run 'rubyforge setup', 'rubyforge login', and 'rubyforge configure', or maybe the project doesn't exist on RubyForge"
+          end
+        end
+
+      end
+    end
+  end
+end