tumbler 0.0.14 → 0.0.15

data/CHANGELOG

@@ -1,3 +1,13 @@
+== 0.0.15
+
+* Nicer output for generation and updating (Joshua Hull, ef03bbe)
+* Version constant can either be Version or VERSION (Joshua Hull, f5cf74e)
+* Make automatic case first. (Joshua Hull, db6454d)
+* Explain tumbler task namespacing (Joshua Hull, b39c0e2)
+* Update description/summary. (Joshua Hull, a972fd1)
+* Allow color to be enabled/disabled (Joshua Hull, 1e5f5ba)
+* Add colorful output (Joshua Hull, d626d17)
+
 == 0.0.14
 
 * Remove sudo on gem install. You have to sudo it yourself if you want that behaviour. (Joshua Hull, 1a244cc)

data/Gemfile

@@ -5,6 +5,7 @@ gem 'versionomy'
 gem 'bundler'
 gem 'json'
 gem 'thor', :require => 'thor/group'
+gem 'rainbow'
 
 group :development do
   gem 'rake'

data/README.rdoc

@@ -1,6 +1,6 @@
 = Tumbler
 
-Let's make gem development fun and remove all the repetition! Tumbler provides support for common gem management tasks which helps you spend less time dealing with gem releases and more time focusing on your gem functionality!
+Let's make gem development fun! Tumbler provides common gem management tasks using a common set of 'best practices' out of the box.
 
 == Gem Guidelines
 
@@ -27,7 +27,17 @@ This will generate a skeleton of your gem that you can then easily configure and
 
 If you have a pre-existing gem which could benefit from Tumbler, you have to a do a few things. Note that if you are generating a new gem using the tumbler command, this will be done for you automatically.
 
-For existing projects, you need to instruct Tumbler to manage the gem tasks. This is all handled by a file at the root of your project called <tt>Tumbler</tt>. A typical <tt>Tumbler</tt> file should look something like the following:
+==== Automatically
+
+To automatically setup your project to use tumbler, simply execute:
+
+  tumbler . -u --name gem_name
+  
+From inside the gem's root directory and this will take care of all the details for you. When it's done updating your gem, review and commit the changes.
+
+==== Manually
+
+Alternatively, for existing projects, you can set up all the bits needed to make Tumbler work with your gem. This is all handled by a file at the root of your project called <tt>Tumbler</tt>. A typical <tt>Tumbler</tt> file should look something like the following:
 
   # Names your gem
   gem_name 'my_awesome_gem'
@@ -40,7 +50,7 @@ For existing projects, you need to instruct Tumbler to manage the gem tasks. Thi
 
 Your version number can be anything parsable by Versionomy. The changelog will be automatically updated when a new version is released.
 
-The version file should have a constant <tt>VERSION</tt> which is set to the current version for your gem. A typical version file might look like the following:
+The version file should have a constant <tt>VERSION</tt> or <tt>Version</tt> which is set to the current version for your gem. A typical version file might look like the following:
 
   # lib/awesome_gem/version.rb
   module AwesomeGem #:nodoc
@@ -52,11 +62,9 @@ Next, in your +Rakefile+, add the following to get access to Tumbler tasks:
   require 'tumbler'
   Tumbler.use_rake_tasks
 
-Alternatively, you can have Tumbler do all this work for you. If you install Tumbler into your system gems, you can simply execute:
+If you'd prefer to have the tumbler tasks namespaced, provide use_rake_tasks with a string. For example:
 
-  tumbler . -u --name gem_name
-  
-From inside the gem's root directory and this will take care of all these details for you.
+  Tumbler.use_rake_tasks('tumbler')
 
 === Available Rake Tasks
 
@@ -88,12 +96,13 @@ If you do the following,
   
 you will bump the version, tag it in git, regenerate the changelog from your git commits and push the whole thing to rubygems and your remote.
 
-If you prefer you can do it in two steps (which give you a chance to edit the generated changelog)
+If you prefer you can do it in two steps (which gives you a chance to edit the generated changelog)
 
   rake version:(tiny|minor|major):bump
-  rake version:push
+  
+At this point, edit your changelog to reflect whatever comments or formatting you'd like. When you're done, run the following
 
-This will give you the chance to review the changelog and do anything else you'd like before taking the final release plunge.
+  rake version:push
 
 === Common Workflow
 

data/lib/template/Tumbler.erb

@@ -1,5 +1,7 @@
 gem_name <%= @name.inspect %>
 
+use_color true
+
 <% if @version %>
 version_file 'lib/<%= @name %>/version.rb'
 <% end %>

data/lib/tumbler.rb

@@ -1,6 +1,7 @@
 require 'callsite'
 require 'versionomy'
 require 'bundler'
+require 'rainbow'
 
 Callsite.activate_kernel_dir_methods
 

data/lib/tumbler/generate.rb

@@ -5,6 +5,7 @@ module Tumbler
   class Generate
 
     include Runner
+    include Informer
 
     def self.app(dir, name, opts = {})
       generator = Generate.new(dir, name)
@@ -43,18 +44,21 @@ module Tumbler
     end
 
     def write
-      write_gemspec
-      write_gemfile
-      write_version(@version)
-      write_file
-      write_changelog
-      write_rakefile
-      write_tumbler_config
-      sh 'git init'
-      initial_commit
+      inform "Generating gem #{name}" do
+        write_gemspec
+        write_gemfile
+        write_version(@version)
+        write_file
+        write_changelog
+        write_rakefile
+        write_tumbler_config
+        sh 'git init'
+        initial_commit
+      end
     end
 
     def initial_commit
+      inform "Performing initial commit"
       sh 'git init'
       sh 'git add .'
       sh 'git commit -a -m"Initial commit"'
@@ -82,10 +86,12 @@ module Tumbler
     end
     
     def write_changelog
+      inform "Writing changelog file"
       File.open(File.join(@base, @changelog), 'w') {|f| f << '' } if @changelog
     end
     
     def write_rakefile
+      inform "Writing Rakefile"
       FileUtils.cp(template_path('Rakefile'), @base)
     end
 
@@ -94,18 +100,22 @@ module Tumbler
     end
     
     def write_version(version)
+      inform "Writing version file"
       copy_template('version.rb.erb', :to => version_path, :binding => binding)
     end
 
     def write_gemfile
+      inform "Writing Gemfile"
       copy_template('Gemfile.erb', :to => gemfile_file)
     end
 
     def write_gemspec
+      inform "Writing #{name}.gemspec"
       copy_template('generic.gemspec.erb', :to => gemspec_file)
     end
 
     def write_tumbler_config
+      inform "Writing Tumbler config"
       copy_template('Tumbler.erb', :to => config_file)
     end
 

data/lib/tumbler/informer.rb

@@ -2,13 +2,16 @@ $informer_indent = 0
 
 module Tumbler
   module Informer
+    
+    Colors = [:green, :cyan, :blue, :magenta]
+    
     def inform(msg, &block)
-      $stderr.puts (' ' * $informer_indent << msg)
+      $stderr.puts (' ' * $informer_indent << msg.color(Colors[$informer_indent % Colors.size]))
       $informer_indent += 1
       begin
         block.call if block
       rescue Exception
-        $stderr.puts " #{msg} failed!"
+        $stderr.puts "#{msg} failed!".color(:red)
         raise
       ensure
         $informer_indent -= 1

data/lib/tumbler/manager.rb

@@ -51,6 +51,10 @@ module Tumbler
       @version
     end
 
+    def use_color(state = true)
+      Sickill::Rainbow.enabled = state
+    end
+
     def use_gem(&block)
       @gem.instance_eval(block)
     end

data/lib/tumbler/updater.rb

@@ -4,6 +4,9 @@ require 'json'
 
 module Tumbler
   class Updater
+    
+    include Informer
+    
     def initialize(dir, opts = nil)
       @dir = dir
       @name = opts && opts[:name] || File.basename(File.expand_path(dir))
@@ -11,56 +14,68 @@ module Tumbler
     end
 
     def update
-      upgrade_deps
-      upgrade_version
-      upgrade_changelog
-      upgrade_rakefile
-      upgrade_tumbler_config
+      inform "Updating gem '#{@name}' at #{@dir}" do
+        upgrade_deps
+        upgrade_version
+        upgrade_changelog
+        upgrade_rakefile
+        upgrade_tumbler_config
+      end
     end
 
     def upgrade_tumbler_config
-      unless File.exist?(tumbler_config_path)
-        Tumbler::Generate.app(@dir, @name).write_tumbler_config
+      inform "Examining Tumbler config" do
+        unless File.exist?(tumbler_config_path)
+          Tumbler::Generate.app(@dir, @name).write_tumbler_config
+        end
       end
     end
 
     def upgrade_deps
-      if File.exist?(gemfile_path)
-        gemspec = File.read(gemspec_path)
-        unless gemspec[/add_bundler_dependencies/] || gemspec[/inject_dependencies/]
-          @tainted_gemspec = true
-          File.open(gemspec_path, 'a') do |g|
-            g << <<-HERE_DOC
-raise # (see below)
+      inform "Examining dependency management" do
+        if File.exist?(gemfile_path)
+          gemspec = File.read(gemspec_path)
+          unless gemspec[/add_bundler_dependencies/] || gemspec[/inject_dependencies/]
+            @tainted_gemspec = true
+            File.open(gemspec_path, 'a') do |g|
+              g << <<-HERE_DOC
+  raise # (see below)
 
-# You probably want to use inject the dependencies using either
-# add_bundler_depenedencies or Tumbler::Gemspec.inject_dependencies(spec) (where spec is your Gemspec)
-            HERE_DOC
+  # You probably want to use inject the dependencies using either
+  # add_bundler_depenedencies or Tumbler::Gemspec.inject_dependencies(spec) (where spec is your Gemspec)
+              HERE_DOC
+            end
           end
         end
       end
     end
 
     def upgrade_version
-      unless File.exists?(version_path)
-        # go to rubygems and get it
-        gem_data = JSON.parse(Net::HTTP.get(URI.parse("http://rubygems.org/api/v1/gems/#{URI.escape(@name)}.json")))
-        version = gem_data['version']
-        Tumbler::Generate.app(@dir, @name).write_version(version)
+      inform "Examining version tracking" do
+        unless File.exists?(version_path)
+          # go to rubygems and get it
+          gem_data = JSON.parse(Net::HTTP.get(URI.parse("http://rubygems.org/api/v1/gems/#{URI.escape(@name)}.json")))
+          version = gem_data['version']
+          Tumbler::Generate.app(@dir, @name).write_version(version)
+        end
       end
     end
 
     def upgrade_changelog
-      unless File.exists?(changelog_path)
-        Tumbler::Generate.app(@dir, @name).write_changelog
+      inform "Examining changelog" do
+        unless File.exists?(changelog_path)
+          Tumbler::Generate.app(@dir, @name).write_changelog
+        end
       end
     end
 
     def upgrade_rakefile
-      create_rakefile and return if !File.exist?(rakefile_path)
-      rakefile = File.read(rakefile_path)
-      if rakefile !~ /Tumbler.use_rake_tasks/
-        File.open(rakefile_path, 'a') {|f| f.puts "\n\n# automatically added Tumbler tasks\n\nrequire 'tumbler'\nTumbler.use_rake_tasks"}
+      inform "Examining Rakefile" do
+        create_rakefile and return if !File.exist?(rakefile_path)
+        rakefile = File.read(rakefile_path)
+        if rakefile !~ /Tumbler.use_rake_tasks/
+          File.open(rakefile_path, 'a') {|f| f.puts "\n\n# automatically added Tumbler tasks\n\nrequire 'tumbler'\nTumbler.use_rake_tasks"}
+        end
       end
     end
 

data/lib/tumbler/version.rb

@@ -1,3 +1,3 @@
 module Tumbler
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/tumbler.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = Tumbler::Gemspec.name
   s.authors = ["Joshua Hull"]
   s.date = Tumbler::Gemspec.date
-  s.description = "Let's make gem development fun and remove all the repetition! Tumbler provides support for common gem management tasks which helps you spend less time dealing with gem releases and more time focusing on your gem functionality!"
+  s.description = "Let's make gem development fun! Tumbler provides common gem management tasks using a common set of 'best practices' out of the box."
   s.summary = "Common gem generation and management tasks"
   s.email = %q{joshbuddy@gmail.com}
   s.extra_rdoc_files = Tumbler::Gemspec.files('README.rdoc')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tumbler
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 15
+  version: 0.0.15
 platform: ruby
 authors: 
 - Joshua Hull
@@ -100,8 +100,8 @@ dependencies:
         - 0
         version: "0"
   requirement: *id006
-  type: :development
-  name: rake
+  type: :runtime
+  name: rainbow
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id007 !ruby/object:Gem::Requirement 
@@ -115,7 +115,7 @@ dependencies:
         version: "0"
   requirement: *id007
   type: :development
-  name: riot
+  name: rake
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id008 !ruby/object:Gem::Requirement 
@@ -129,7 +129,7 @@ dependencies:
         version: "0"
   requirement: *id008
   type: :development
-  name: fakeweb
+  name: riot
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id009 !ruby/object:Gem::Requirement 
@@ -143,7 +143,7 @@ dependencies:
         version: "0"
   requirement: *id009
   type: :development
-  name: mocha
+  name: fakeweb
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id010 !ruby/object:Gem::Requirement 
@@ -157,8 +157,22 @@ dependencies:
         version: "0"
   requirement: *id010
   type: :development
+  name: mocha
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id011
+  type: :development
   name: blockenspiel
-description: Let's make gem development fun and remove all the repetition! Tumbler provides support for common gem management tasks which helps you spend less time dealing with gem releases and more time focusing on your gem functionality!
+description: Let's make gem development fun! Tumbler provides common gem management tasks using a common set of 'best practices' out of the box.
 email: joshbuddy@gmail.com
 executables: 
 - tumbler