tumbler 0.0.6 → 0.0.8

data/.gitignore

@@ -1 +1,2 @@
 .bundle
+pkg/*

data/CHANGELOG

@@ -1,3 +1,21 @@
+== 0.0.8
+
+* Removed junk (Joshua Hull, 887166c)
+* Cleanup whitespace (Nathan Esquenazi, 3e9b6c1)
+* clean up whitespace (Nathan Esquenazi, 536f32e)
+* reorder methods in gem.rb to put built_gem_path first (Nathan Esquenazi, 5d3f248)
+
+== 0.0.7
+
+* Moves successful generation message into CLI (Nathan Esquenazi, 2ce281f)
+* Output a success message in tumbler binary (Nathan Esquenazi, f6403e6)
+* Build gems into pkg sub directory and install from there (Nathan Esquenazi, 35140d4)
+* Ignore files in pkg directory (Nathan Esquenazi, 4c20085)
+* Tone down Github requirement in README (since its not necessary) (Nathan Esquenazi, 325716a)
+* Added rubyforge_project to gemspec by default to remove warning (Nathan Esquenazi, 9b35929)
+* Cleaned up README (Nathan Esquenazi, 02221fe)
+* removed old changelog crap (Joshua Hull, b8632d4)
+
 == 0.0.6
 
 * corrected docs. correct version (Joshua Hull, a3ee9bc)
@@ -9,29 +27,3 @@
 
 * remove push task (Joshua Hull, b85b730)
 
-== 0.0.4
-
-
-
-== 0.0.3
-
-
-
-== 0.0.2
-
-
-
-== 0.0.1
-
-* added current directory to load path (Joshua Hull, 45c5db5)
-
-== 0.0.1
-
-* rollback version (Joshua Hull, 5c14fd9)
-
-== 0.0.1
-
-* reset version, changelog (Joshua Hull, 09e19dc)
-* Updated changelog (Joshua Hull, 161da98)
-* Bumped version from 0.0.0 to 0.0.1 (Joshua Hull, 654eb14)
-

data/README.rdoc

@@ -1,81 +1,111 @@
 = Tumbler
 
-Let's make gem development fun and not at all repetitive! A set of common tasks which should save you a fair bit of typing and give you more time for doing
-useful things with your life.
+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!
 
-== The pattern
+== Gem Guidelines
 
-Typically I want to make a gem, host it on github and tag versions. I want to use git as my source control, and use git to create sets of files. As well, I want to use Bundler to specify my dependencies, and then, I want those dependencies to automatically be in my gemspec. As well, I want to be a good citizen, and use gemspec's directly, instead of generating my gemspec from something.
+Tumbler was built to help developers create and manage gems using a common set of 'best practices' out of the box. Tumbler also makes a number of assumptions about your workflow:
+
+* Gem uses directly edited dynamic gemspecs
+* Gem uses Git to manage code source (perhaps on Github)
+* Git tags are created for each new version
+* Gem dependencies are defined using a Gemfile through Bundler
+
+If your gem can follow these guidelines, then Tumbler will automate the entirety of this process for you into rake tasks.
 
 == Using Tumbler
 
-=== For pre-existing projects
+=== Creating Gems
 
-If you have a pre-existing project, and want to use Tumbler, you have to a do a few things. If you're starting from scratch, you can skip this section.
+To generate a brand new gem from scratch, execute the following:
+
+  $ tumbler your_gem_name
+  
+This will generate a skeleton of your gem that you can then easily configure and start building awesome.
 
-For existing projects, you need to configure it to tell Tumbler to do its work. This is all done from a file at the root of your project called <tt>Tumbler</tt>. A typical <tt>Tumbler</tt> file will look something like this:
+=== Existing Gems
 
-  # Names the gem
+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:
+
+  # Names your gem
   gem_name 'my_awesome_gem'
   
-  # Use this file to track the version
+  # Use this file to track the version number
   version_file 'lib/my_awesome_gem/version.rb'
 
-  # Use this file to hang onto your changelog
+  # Use this file for your changelog
   changelog_file 'CHANGELOG'
 
-Your version number has to only be something parsable by Versionomy. The changelog will automatically be updated when you do releases.
+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:
 
-As well, in your +Rakefile+, add the following:
+  # lib/awesome_gem/version.rb
+  module AwesomeGem #:nodoc
+    VERSION = '0.0.1'
+  end
+
+Next, in your +Rakefile+, add the following to get access to Tumbler tasks:
 
   require 'tumbler'
   Tumbler.use_rake_tasks
 
-Alternately, you can have Tumbler do all the work for you. If you install Tumbler to your system gems, you can say:
+Alternatively, you can have Tumbler do all this work for you. If you install Tumbler into your system gems, you can simply execute:
 
   tumbler . -u --name gem_name
   
-From inside your project directory, and it will take care of all these details for you.
-
-=== Generating an application from scratch
+From inside the gem's root directory and this will take care of all these details for you.
 
-To generate an application from scratch, run the following:
-
-  tumbler your_gem_name
-  
-This will give you a skeleton of an application that you can fill out and make awesome.
+=== Available Rake Tasks
 
-=== Day to day life with Tumbler as your friend
-
-Once you've got Tumbler up and running, you'll have access to the following tasks:
+Once you've got Tumbler up and running in your gem, you will have access to the following tasks:
 
   rake gem:build              # Build the gem
   rake gem:install            # Install the gem
   rake gem:push               # Push the gem
   rake version:major:bump     # Bump version from 0.2.12 ->  1.0.0
-  rake version:major:release  # Bump version from 0.2.12 ->  1.0.0 and push
   rake version:minor:bump     # Bump version from 0.2.12 ->  0.3.0
+  rake version:tiny:bump      # Bump version from 0.2.12 ->  0.2.13
+  rake version:major:release  # Bump version from 0.2.12 ->  1.0.0 and push
   rake version:minor:release  # Bump version from 0.2.12 ->  0.3.0 and push
+  rake version:tiny:release   # Bump version from 0.2.12 ->  0.2.13 and push
   rake version:push           # Push current version into git
   rake version:tag            # Tag current version into git
-  rake version:tiny:bump      # Bump version from 0.2.12 ->  0.2.13
-  rake version:tiny:release   # Bump version from 0.2.12 ->  0.2.13 and push
 
-Let's take a look a some common workflow:
-
-==== Releasing a new Gem
+==== Releasing your Gem
 
 You can either do
 
   rake version:(tiny|minor|major):release
   
-Which 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 or you can do it in two steps:
+which 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 or you can do it in two separate steps:
 
   rake version:(tiny|minor|major):bump
-  rake version:release
+  rake version:push
+
+This will give you the chance to review the changelog and do anything else you'd like before taking the final release plunge.
+
+=== Common Workflow
 
-This gives you a chance to review the changelog and do anything else you'd like to do before taking the plunge.
+Here is an example of a common usage for Tumbler. Let's say I want to create a new gem. Let's walk through the process:
+
+  $ tumbler your_gem_name
+  $ cd your_gem_name
+  
+This will generate the basic gem structure. Now we need to configure the 'your_gem_name.gemspec' with gem details and configure 'Gemfile' with the external dependencies. That's all you need to get started! From here, simply implement your gem. When ready for your first release you should first test locally:
+
+  # test your gem locally
+  $ rake gem:install
+  
+When you feel confident and you are ready to push your first version to git and rubygems, simply invoke:
+
+  # releases your gem
+  $ rake version:tiny:release
+  
+and that does it! Your gem is now released onto the world.
 
 == What's next?
 
-I'm sure there are bugs and other common workflows that I will add/document, but basically, I just wanna type a lot less when I bump a gem, and get things done.
+I'm sure there are bugs and other common workflows that I will add and/or document, but basically, I just wanna type a lot less when I bump a gem, and get more things done.

data/lib/template/Tumbler.erb

@@ -1,9 +1,9 @@
-gem_name <%=@name.inspect%>
+gem_name <%= @name.inspect %>
 
 <% if @version %>
-version_file 'lib/<%=@name%>/version.rb'
+version_file 'lib/<%= @name %>/version.rb'
 <% end %>
 
 <% if @changelog %>
-changelog_file <%=@changelog.inspect%>
+changelog_file <%= @changelog.inspect %>
 <% end %>

data/lib/template/generic.gemspec.erb

@@ -3,16 +3,17 @@
 require 'tumbler/gemspec'
 
 Gem::Specification.new do |s|
-  s.name = <%=@name.inspect%>
+  s.name = <%= @name.inspect %>
   s.version = Tumbler::Gemspec.version
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = <%= @name.inspect %>
   s.authors = <%=[git_name].inspect%>
   s.date = Tumbler::Gemspec.date
   s.description = %q{Description}
   s.email = <%=git_email.inspect%>
   s.files = Tumbler::Gemspec.files
-  # s.homepage = %q{http://github.com/<%=github_user%>/<%=@name%>}
+  # s.homepage = %q{http://github.com/<%= github_user %>/<%= @name %>}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/lib/tumbler/cli.rb

@@ -12,7 +12,7 @@ module Tumbler
       }
       parser.parse!(args)
     end
-    
+
     def parser
       OptionParser.new do |opts|
         opts.banner = "Usage: tumbler name [options]"
@@ -47,9 +47,8 @@ module Tumbler
         opts.on_tail("-h", "--help", "Show this help message.") { puts opts; exit }
       end
     end
-    
+
     def run
-      puts @options.inspect
       app_name = ARGV.first
 
       if app_name.nil?
@@ -62,7 +61,9 @@ module Tumbler
         FileUtils.mkdir_p(app_name)
         Tumbler::Generate.app(app_name, app_name, @options).write
       end
+
+      puts "Gem '#{app_name}' generated successfully!"
     end
-    
+
   end
 end

data/lib/tumbler/gem.rb

@@ -10,18 +10,18 @@ module Tumbler
       @manager.base
     end
 
+    def built_gem_path
+      "#{@manager.name}-#{@manager.version.to_s}.gem"
+    end
+
     def push
       build
       sh("gem push #{built_gem_path}")
     end
 
-    def built_gem_path
-      "#{@manager.name}-#{@manager.version.to_s}.gem"
-    end
-
     def install
       build
-      exec("sudo gem install #{built_gem_path}")
+      exec("sudo gem install pkg/#{built_gem_path}")
     end
 
     def spec_path
@@ -30,6 +30,8 @@ module Tumbler
 
     def build
       sh("bundle exec gem build #{spec_path}")
+      sh("mkdir -p pkg")
+      sh("mv -f #{built_gem_path} pkg/")
     end
   end
 end

data/lib/tumbler/gemspec_helper.rb

@@ -35,4 +35,4 @@ module Tumbler
       Time.new.strftime("%Y-%m-%d")
     end
   end
-end
+end

data/lib/tumbler/generate.rb

@@ -3,9 +3,9 @@ require 'erb'
 
 module Tumbler
   class Generate
-    
+
     include Runner
-    
+
     def self.app(dir, name, opts = {})
       generator = Generate.new(dir, name)
       generator.version = opts[:version] if opts[:version]
@@ -26,7 +26,7 @@ module Tumbler
 
     attr_reader :development_dependencies, :dependencies, :base
     attr_accessor :version, :changelog
-    
+
     def initialize(dir, name)
       @base = dir
       @name = name
@@ -70,11 +70,11 @@ module Tumbler
       FileUtils.mkdir_p(File.dirname(version_path))
       File.open(version_path, 'w') {|f| f << generate_version(version) }
     end
-    
+
     def version_path
       File.join(@base, 'lib', @name, 'version.rb')
     end
-    
+
     def write_gemfile
       File.open(gemfile_file, 'w') {|f| f << generate_gemfile }
     end

data/lib/tumbler/manager.rb

@@ -152,10 +152,10 @@ module Tumbler
     end
 
     private
-    def initialize(base)
-      @base = base
-      reload
-      @noop = true if ENV['DRY'] == '1'
-    end
+      def initialize(base)
+        @base = base
+        reload
+        @noop = true if ENV['DRY'] == '1'
+      end
   end
 end

data/lib/tumbler/manager/version.rb

@@ -21,7 +21,7 @@ module Tumbler
 
       def reload
         @version = Versionomy.parse(File.exist?(file) ? extract : '0.0.0')
-      end  
+      end
 
       def extract
         File.read(@file)[/Version\s*=\s*['"](.*?)['"]/i, 1]
@@ -53,11 +53,11 @@ module Tumbler
           reload
         end
       end
-    
+
       def commit(from)
         sh "git commit #{@basefile} -m'Bumped version from #{from} to #{to_s}'"
       end
-    
+
       def base
         @manager.base
       end

data/lib/tumbler/updater.rb

@@ -94,4 +94,4 @@ raise # (see below)
       File.join(@dir, 'Gemfile')
     end
   end
-end
+end

data/lib/tumbler/version.rb

@@ -1,3 +1,3 @@
 module Tumbler
-  VERSION = '0.0.6'
-end
+  VERSION = '0.0.8'
+end

data/spec/tasks_spec.rb

@@ -19,7 +19,7 @@ describe Tumbler do
   it "should gem.build" do
     create_app do |app|
       app.gem.build
-      File.exist?("#{app.base}/test-0.0.0.gem").should be_true
+      File.exist?("pkg/#{app.base}/test-0.0.0.gem").should be_true
     end
   end
 

data/tumbler.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |s|
   s.version = Tumbler::Gemspec.version
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = Tumbler::Gemspec.name
   s.authors = ["Joshua Hull"]
   s.date = Tumbler::Gemspec.date
   s.description = %q{Description}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tumbler
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Joshua Hull
@@ -160,9 +160,6 @@ files:
 - spec/tasks_spec.rb
 - spec/updater_spec.rb
 - spec/version_spec.rb
-- test1
-- thinking.txt
-- thinking2.txt
 - tumbler.gemspec
 has_rdoc: true
 homepage: http://github.com/joshbuddy/tumbler
@@ -193,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: tumbler
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3

data/thinking.txt

@@ -1,54 +0,0 @@
-I want ... 
-
-* version management
-* changelog generation
-* dependancy management from bundler to gemspec
-
-Tumbler
-for_version do
-  format "#.#.#"
-  filename "VERSION"
-end
-
-for_changelog do
-  filename "CHANGELOG.txt"
-  format "#{line} (#{author})"
-end
-
-rake version:bump:patch
-rake version:bump:minor
-rake version:bump:major
-rake version:tag
-rake changelog:regenerate
-rake changelog:update
-rake gem:push
-rake gem:register
-rake gem:build
-rake gem:install
-rake gemspec:skeleton
-
-rake patch:release -> version:bump:patch changelog:update version:tag rake gem:push
-rake minor:release -> version:bump:patch changelog:update version:tag rake gem:push
-rake major:release -> version:bump:patch changelog:update version:tag rake gem:push
-
-gemspec ...
-  files from git
-  version from file
-  deps from bundler
-
-version bump
-  update version file
-  commit result
-  
-version tag
-  create git tag
-  commit result (?)
-
-changelog update
-  since last release ... get all tags, get all change lines, build file
-
-gem push
-gem register
-
-gemspec skel
-  .gemspec

data/thinking2.txt

@@ -1,72 +0,0 @@
-You left the chat by being disconnected from the server.
-[4:53pm] You were promoted to operator by ChanServ.
-[4:53pm] You rejoined the room.
-[4:53pm] nesquena: the issue is that when using :git => "xxx" in gemfile, bundler is relying on the dynamic gemspec directly
-[4:53pm] nesquena: but its not clear to me why this causes everything to break hard
-[4:54pm] You left the chat by being disconnected from the server.
-[4:54pm] calvino.freenode.net: [freenode-info] channel flooding and no channel staff around to help? Please check with freenode support: http://freenode.net/faq.shtml#gettinghelp
-[4:54pm] You rejoined the room.
-[4:54pm] You were promoted to operator by ChanServ.
-[4:55pm] nesquena: joshbuddy: i noticed tumbler relies on a VERSION file similar to jeweler. for some reason i have heard multiple people recommend using a version.rb file with a GemName::Version syntax instead. have you ever heard that before?
-[4:55pm] nesquena: heres where padrino moved from VERSION to a version.rb: http://github.com/padrino/padrino-framework/issuesearch?state=closed&q=version#issue/88
-[4:55pm] nesquena: and where sinatra did: http://github.com/sinatra/sinatra/commit/e1638a43ad3a5c5ea70db56944a5230cc86e537a
-[4:55pm] achiu joined the chat room.
-[4:55pm] achiu was promoted to operator by ChanServ.
-[4:55pm] joshbuddy: nesquena: oh, well, i'll just follow that then
-[4:55pm] joshbuddy: should be easy to change
-[4:56pm] nesquena: joshbuddy: yea seems like it has partially to do with rip only taking the lib folder
-[4:56pm] joshbuddy: not sure why its best practice though
-[4:56pm] nesquena: joshbuddy: so any attempt to read version fails miserably
-[4:56pm] joshbuddy: oh, i suppose thats valid
-[4:56pm] joshbuddy: i'll fix that, thanks!
-[4:56pm] nesquena: joshbuddy: sure, they sort of discuss it in the comments here: http://github.com/sinatra/sinatra/commit/e1638a43ad3a5c5ea70db56944a5230cc86e537a
-[4:56pm] nesquena: joshbuddy: isnt a big deal but thot id let you know since id like padrino to use tumbler too!
-[4:57pm] joshbuddy: well, i'd like to follow the current state of the art
-[4:57pm] nesquena: joshbuddy: yea i figured as much. tumbler is looking awesome
-[4:58pm] joshbuddy: thanks! just wanna finish it already!
-[4:58pm] nesquena: joshbuddy: and i would love to put it into padrino for 0.9.12
-[4:58pm] joshbuddy: uup
-[4:58pm] joshbuddy: thats the goal
-[4:58pm] joshbuddy: and raise everyone's boats
-[4:59pm] nesquena: joshbuddy: yea i can easily see it taking over for jeweler once the kinks are worked out
-[4:59pm] joshbuddy: yeah, exactly.
-[4:59pm] joshbuddy: but i don't want to release until it does what it minimially promises
-[4:59pm] nesquena: joshbuddy: we should definately put it on rubyflow, im even down to write a padrino blog post about it or you are welcome to also
-[4:59pm] nesquena: joshbuddy: yea definately
-[4:59pm] joshbuddy: and the key there, is really really good testing
-[4:59pm] joshbuddy: yup
-[5:01pm] nesquena: joshbuddy: in padrino the way we update version is just to gsub it into the version.rb file:
-[5:01pm] nesquena: version_text = File.read(version_path).sub(/VERSION = '[\d\.]+'/, "VERSION = '#{args.version}'")
-[5:01pm] nesquena: not sure its the best but it gets the job done
-[5:01pm] joshbuddy: i'll do something like it for now ..
-[5:02pm] nesquena: joshbuddy: yea you can even keep the sytax
-[5:03pm] nesquena: use_version do
-[5:03pm] nesquena:     filename 'padrino-core/lib/version.rb'
-[5:03pm] nesquena:   end
-[5:03pm] joshbuddy: thats exactly what i'm thinkin' 
-[5:03pm] RichGuk: Man you guys talk to quick.
-[5:03pm] RichGuk: *reads up*
-[5:03pm] nesquena: joshbuddy: although im not sure thats better than version_file 'padrino-core/lib/version.rb'
-[5:03pm] nesquena: more dsl declarative
-[5:04pm] joshbuddy: well, i suspect there are other version options ..
-[5:04pm] joshbuddy: in fact, there are ..
-[5:04pm] joshbuddy: its not documented yet, but you can have fields in there..
-[5:04pm] joshbuddy: to indicate which version fields you want to be able to act one
-[5:04pm] joshbuddy: on
-[5:06pm] nesquena: joshbuddy: what do you mean which to act on? like major, tiny, minor?
-[5:06pm] nesquena: what about something like: joshbuddy: i was
-[5:06pm] nesquena: http://gist.github.com/441270
-[5:06pm] joshbuddy: nesquena: exactly
-[5:06pm] nesquena: joshbuddy: ok not a big deal, works either way
-[5:06pm] joshbuddy: oh, thats nicer!
-[5:06pm] joshbuddy: but _file ..
-[5:07pm] joshbuddy: seems odd ..
-[5:07pm] nesquena: joshbuddy: yea because i think in the 80% case it will be much cleaner
-[5:07pm] joshbuddy: when changelog doesn't get it too
-[5:07pm] nesquena: joshbuddy: ok just version then
-[5:07pm] joshbuddy: nono, i'm thinking changelog_file
-[5:07pm] joshbuddy:
-[5:07pm] nesquena: http://gist.github.com/441270
-[5:07pm] nesquena: oh
-[5:07pm] nesquena: haha
-[5:07pm] nesquena: yea that makes sense. i think that looks pretty clean