bueller 0.0.1

data/ChangeLog.markdown

@@ -0,0 +1,141 @@
+# bueller 1.4.0 2009-11-19
+
+ * Generator now adds gemcutter support by default. Disable it with --no-gemcutter
+ * Generator now creates a reek task that works with the latest reek. If you have a previously generated project using it, you may need to change the require line to: require 'reek/adapters/rake_task'
+ * Generator now exits with the correct exit code
+ * `rake install` no longer uses `sudo` to install. If your ruby configuration needs sudo to install, use `sudo rake install` instead.
+ * `rake install` now correctly installs dependencies as well
+ * `rake install` should correctly figure out which `gem` binary to invoke now
+ * `rake build` now will regenerate the gemspec as well
+ * `rake gemspec` now eliminates duplicates for gemspec.files, gemspec.rdoc_files, etc
+ * `rake gemspec` now automatically populates gemspec.extensions with any extconf.rb files you have in `ext`
+ * Releasing to Rubyforge is now deprecated in favor of Gemcutter.
+
+# bueller 1.3.0
+
+ * Now supports an additional version type, build. This can be used to add a fourth segment of the version that's arbitrary. One example use is having prereleases.
+ * Jeweler now lazily loads, to avoid causing side-effects when running other rake tasks
+ * Version can now be set explicitly on the gemspec, rather than relying on a VERSION file
+ * Rubyforge and Gemcutter support now hooks into `rake release`
+ * `rake build` now uses an in-memory copy of the gemspec, rather than the filesystem persisted one
+ * Rubyforge support no longer forces the uploading of documentation
+ * Generator:
+  * Allow arbitrary homepage and git remotes, to decouple a bit from GitHub
+  * Support for the riot testing framework: http://github.com/thumblemonks/riot/
+  * Support for test/spec
+  * .gitignore now ignores emacs temporary files
+  * rspec support now creates a spec.opts with support for color and other stuff
+  * Updated minitest support (formally miniunit)
+  * Improved support for autotest
+
+# bueller 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
+
+# bueller 1.1.0 2009-08-05
+
+ * Support for generating a project that uses yard instead of rdoc
+ * Generated gemspec now includes comments about it being generated by bueller
+ * Only use sudo for installing on non-windows platforms [#1]
+ * Fixed rake release to be repeatable on the same version [#16]
+ * Fixed rake rubyforge:setup to not create duplicate packages
+ * Use a more recent version of ruby-git
+  * Fixes various issues with reading values out of ~/.gitconfig [#26] [#21] [#19]
+ * Experimenting with a rake task to check development time dependencies [#22]
+ * Fixed generated rdoc task to load from VERSION instead of VERSION.yml
+
+# bueller 1.0.2 2009-07-29
+
+ * Don't include git ignored files for default gemspec's files and test_files
+ * Fixed rspec generator to allow specs to be run directly
+ * Removed misleading docstring for version_required rake task [#17]
+ * Includes some notes about contributed in generated README
+ * Added support for generating a project to use reek and roodi
+
+# bueller 1.0.1 2009-05-15
+
+# bueller 0.11.1
+
+ * Lots of internal refactorings to how project generation happens
+ * Fixed missing dependency on rubyforge
+ * Depend on a recent version of schacon-git which works on ruby 1.9
+ * Updated cucumber support for 0.3.x
+ * Tested on Ruby 1.9
+
+# bueller 0.11.0 2009-04-05
+
+ * generator will respect JEWELER_OPTS, as a way to provide default options
+ (pat-maddox)
+ * Include 'examples' and 'rails' directories by default in gemspec files
+ * generated gemspec now will only include files (not directories). also, they are listed one per line, and sorted.
+ * Jeweler::Tasks's intializer has been improved:
+  * You can now pass it an existing gemspec (othewise a new one will be created)
+  * Jeweler sets its defaults before yielding the gemspec to you. This allows you to append to its defaults, so you aren't forced to entirely overwrite them just to add one value.
+ * Managing a gemspec's files, test_files, and extra_rdoc_files is now more flexible. They are now wrapped in a FileList, so you can easily 'include' or 'exclude' patterns.
+
+# bueller 0.10.2 2009-03-26
+
+ * 'rake install' now will 'rake build' first
+ * Support for releasing to RubyForge, thanks to jtrupiano
+ * Steps towards Ruby 1.9 support, thanks to rsanheim
+
+# bueller 0.9.1 2009-03-05
+
+ * Tasks:
+  * Fixed populating default spec's extra_rdoc_files
+  * Removed redundant gem building/installing tasks. Use rake build and rake install
+ * Generator:
+  * Added support for micronaut
+  * Generate nicer block variable names in Rakefile
+  * Cucumber generation now places steps in features/step_features, to follow cucumber standards
+
+  * shoulda and test/unit test_helpers no longer require mocha
+  * Rakefile uses more readable block variable names
+  * .gitignore now includes pkg and coverage directories
+  * Avoid puts'ing in Rakefile when LoadError occurs. Instead, define a task that aborts with instructions to install.
+  * Cucumber is now optional. Generate stories using --cucumber
+  * Bacon's 'test' task is now 'spec'
+  * Generate README.rdoc instead of just a plain text README
+  * Updated year in README.rdoc and COPYRIGHT to be based on the current year instead of hardcoded
+
+# bueller 0.8.1 2009-02-03
+
+ * Fixed minitest generator
+
+# bueller 0.8.0 2009-02-03
+
+ * Generator:
+  * Supports these new testing frameworks:
+   * test/unit
+   * minitest
+   * rspec
+  * Added support for cucumber
+  * Creating a new gem is now more verbose, and will show files/directories created
+ * Binaries will now be automatically detected in 'bin'
+
+# bueller 0.7.2 2009-01-29
+
+ * Added rake task 'version:bump' which is shorthand for 'version:bump:patch'
+ * Generated projects no longer assume RCov is installed.
+
+# bueller 0.7.1 2009-01-26
+
+ * Fixed yaml not being required
+ * Automatically add files in bin as executables in gemspec
+
+# bueller 0.7.0 2009-01-19
+
+ * Added support to generator for specifying a description
+ * Condensed README.markdown to be less novel-like
+ * RDoc is now included in your gemspec
+ * Rescue errors that raise in the generator, and display better error message, and exit with a non-zero exit status
+
+# bueller 0.6.5 2009-01-14
+
+ * `bueller --create-repo foo` now enables gem creation in addition to creating the repository
+
+# bueller 0.6.4 2009-01-13
+
+ * Added tasks `build` and `install` as shortcuts for `gem:build` and `gem:install`

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Josh Nichols
+
+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/README.markdown

@@ -0,0 +1,182 @@
+# Bueller: Craft the absolute perfect RubyGem
+
+Bueller provides two things:
+
+ * Rake tasks for managing gems and versioning of a <a href="http://github.com">GitHub</a> project
+ * A generator for creating/kickstarting a new project
+
+## Quick Links
+
+ * [Wiki](http://wiki.github.com/dkastner/bueller)
+ * [Bugs](http://github.com/dkastner/bueller/issues)
+
+## Installing
+
+# Install the gem:
+    gem install bueller
+
+## Using in an existing project
+
+Since bueller uses your existing gemspec, simply add the bueller tasks to your Rakefile:
+
+    begin
+      require 'bueller'
+      Bueller::Tasks.new
+    rescue LoadError
+      puts "Bueller not available. Install it with: gem install bueller"
+    end
+
+## Using to start a new project
+
+Bueller provides a generator. It requires you to [setup your name and email for git](http://help.github.com/git-email-settings/) and [your username and token for GitHub](http://github.com/guides/local-github-config).
+
+    bueller the-perfect-gem
+
+This will prepare a project in the 'the-perfect-gem' directory, setup to use Bueller.
+
+It supports a number of options. Here's a taste, but `bueller --help` will give you the most up-to-date listing:
+
+ * --create-repo: in addition to preparing a project, it create an repo up on GitHub and enable RubyGem generation
+ * --testunit: generate test_helper.rb and test ready for test/unit
+ * --minitest: generate test_helper.rb and test ready for minitest
+ * --shoulda: generate test_helper.rb and test ready for shoulda
+ * --rspec: generate spec_helper.rb and spec ready for rspec (this is the default)
+ * --bacon: generate spec_helper.rb and spec ready for bacon
+ * --gemcutter: setup releasing to gemcutter
+ * --rubyforge: setup releasing to rubyforge
+
+### Default options
+
+Bueller respects the BUELLER_OPTS environment variable. Want to always use Test::Unit, and you're using bash? Add this to ~/.bashrc:
+
+    export BUELLER_OPTS="--testunit"
+
+## Gemspec
+
+Bueller leaves the task of defining a clean gemspec to you. However, it does offer a method to bump version numbers via rake tasks.
+
+    rake version:bump:minor
+
+When starting from scratch, bueller will create a skeleton gemspec for you.
+
+## Gem
+
+Bueller gives you tasks for building and installing your gem.
+
+    rake install
+
+To build the gem (which will end up in `pkg`), run:
+
+    rake build
+
+To install the gem (and build if necessary), i.e. using gem install, run:
+
+    rake install
+
+Note, this does not use `sudo` to install it, so if your ruby setup needs that, you should prefix it with sudo:
+
+    sudo rake install
+
+## Versioning
+
+Bueller tracks the version of your project. It assumes you will be using a version in the format `x.y.z`. `x` is the 'major' version, `y` is the 'minor' version, and `z` is the patch version.
+
+Initially, your project starts out at 0.0.0. Bueller provides Rake tasks for bumping the version:
+
+    rake version:bump:major
+    rake version:bump:minor
+    rake version:bump:patch
+
+You can also programmatically set the version if you wish. Typically, you use this to have a module with the version info so clients can access it. The only downside here is you no longer can use the version:bump tasks.
+
+    Gem::Specification.new do |s|
+       s.version = MyProject::VERSION
+       # more stuff
+    end
+
+### Prerelease versioning
+
+Major, minor, and patch versions have a distant cousin: build. You can use this to add an arbitrary (or you know, regular type) version. This is particularly useful for prereleases.
+
+You have two ways of doing this:
+
+ * Use `version:write` and specify `BUILD=pre1`
+
+Bueller does not provide a `version:bump:build` because the build version can really be anything, so it's hard to know what should be the next bump.
+
+## Releasing
+
+Bueller handles releasing your gem into the wild:
+
+    rake release
+
+It does the following for you:
+
+ * git pushes to origin/master branch
+ * git tags the version and pushes to the origin remote
+
+As is though, it doesn't actually get your gem anywhere. To do that, you'll need to use rubyforge or gemcutter.
+
+### Releasing to Gemcutter
+
+Bueller can also handle releasing to [Gemcutter](http://gemcutter.org). There are a few steps you need to do before doing any Gemcutter releases with Bueller:
+
+ * [Create an account on Gemcutter](http://gemcutter.org/sign_up)
+ * Install the Gemcutter gem: gem install gemcutter
+ * Run 'gem tumble' to set up RubyGems to use gemcutter as the default source if you haven't already
+ * Update your Rakefile to make an instance of `Bueller::GemcutterTasks`
+
+
+A Rakefile setup for gemcutter would include something like this:
+
+    begin
+      require 'bueller'
+      Bueller::Tasks.new
+      Bueller::GemcutterTasks.new
+    rescue LoadError
+      puts "Bueller (or a dependency) not available. Install it with: gem install bueller"
+    end
+
+
+After you have configured this, `rake release` will now also release to Gemcutter.
+
+If you need to release it without the rest of the release task, you can run:
+
+    $ rake gemcutter:release
+
+### Releasing to RubyForge
+
+Bueller can also handle releasing to [RubyForge](http://rubyforge.org). There are a few steps you need to do before doing any RubyForge releases with Bueller:
+
+ * [Create an account on RubyForge](http://rubyforge.org/account/register.php)
+ * Request a project on RubyForge.
+ * Install the RubyForge gem: gem install rubyforge
+ * Run 'rubyforge setup' and fill in your username and password for RubyForge
+ * Run 'rubyforge config' to pull down information about your projects
+ * Run 'rubyforge login' to make sure you are able to login
+ * In Bueller::Tasks, you must set `rubyforge_project` to the project you just created
+ * Add Bueller::RubyforgeTasks to bring in the appropriate tasks.
+ * Note, using `bueller --rubyforge` when generating the project does this for you automatically.
+
+A gemspec setup for rubyforge would include something like this:
+
+    Gem::Specification.new do |s|
+      # ommitted for brevity
+      gemspec.rubyforge_project = 'the-perfect-gem' # This line would be new
+    end
+
+Now you must initially create a 'package' for your gem in your RubyForge 'project':
+
+    $ rake rubyforge:setup
+
+After you have configured this, `rake release` will now also release to RubyForge.
+
+If you need to release it without the rest of the release task, you can run:
+
+    $ rake rubyforge:release
+
+## Development and Release Workflow
+
+ * Hack, commit, hack, commit, etc, etc
+ * `rake version:bump:patch release` to do the actual version bump and release
+ * Have a delicious beverage (I suggest port)

data/bin/bueller

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'bueller/generator'
+
+exit Bueller::Generator::Application.run!(*ARGV)

data/lib/bueller/commands/build_gem.rb

@@ -0,0 +1,50 @@
+class Bueller
+  module Commands
+    class BuildGem
+      def self.run_for(bueller)
+        command = new bueller
+        command.run
+        command
+      end
+
+      attr_reader :bueller
+
+      def initialize(bueller)
+        @bueller = bueller
+      end
+
+      def base_dir
+        bueller.base_dir
+      end
+      def gemspec_helper
+        bueller.gemspec_helper
+      end
+      def version_helper
+        bueller.version_helper
+      end
+
+      def run
+        make_package_directory
+        move_gem_file
+      end
+
+      def pkg_dir
+        @pkg_dir ||= File.join(base_dir, 'pkg')
+      end
+
+      def make_package_directory
+        FileUtils.mkdir_p pkg_dir
+      end
+
+      def build_gem
+        Gem::Builder.new(gemspec_helper.spec).build
+      end
+
+      def move_gem_file
+        gem_file_name = build_gem
+        gem_file_path = File.join(base_dir, gem_file_name)
+        FileUtils.mv gem_file_path, pkg_dir
+      end
+    end
+  end
+end

data/lib/bueller/commands/git_tag_release.rb

@@ -0,0 +1,63 @@
+class Bueller
+  module Commands
+    class GitTagRelease
+      def self.run_for(bueller)
+        command = new bueller
+        command.run
+        command
+      end
+
+      attr_accessor :repo, :output
+      attr_reader :bueller
+
+      def initialize(bueller, attributes = {})
+        self.output = $stdout
+        @bueller = bueller
+
+        attributes.each_pair do |key, value|
+          send("#{key}=", value)
+        end
+      end
+
+      def base_dir; bueller.base_dir; end
+      def version; bueller.version; end
+      def repo; bueller.repo; end
+
+      def run
+        raise "Hey buddy, try committing them files first" unless clean_staging_area?
+
+        repo.checkout('master')
+        repo.push
+        
+        unless release_tagged?
+          output.puts "Tagging #{release_tag}"
+          repo.add_tag(release_tag)
+
+          output.puts "Pushing #{release_tag} to origin"
+          repo.push('origin', release_tag)
+        end
+      end 
+
+      def clean_staging_area?
+        status.added.empty? && status.deleted.empty? && status.changed.empty?
+      end
+
+      def status
+        repo.status
+      end
+
+      def release_tag
+        "v#{version}"
+      end
+
+      def release_tagged?
+        begin
+          repo.tag(release_tag)
+          false
+        rescue 
+          true
+        end
+      end
+    end
+  end
+end