gem_polish 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12cf40e16b83b5a99a5780f3abbc210e07d614fc
-  data.tar.gz: 925342a186338c06f0d15260ab317c28b3237006
+  metadata.gz: 4c31a47f214bd4cbda2e76e059444aafa3adbb0d
+  data.tar.gz: 4cb8604e6284d299348292047c7338b121a089a1
 SHA512:
-  metadata.gz: 92775a78eb91009b6924ce2aaa0be9f7984e32ec3346b39d8d92f2781bad8424244e0802ed2ad708d018748d4e93fe44e783d27e6f008631fb06a884ace2f1fb
-  data.tar.gz: ca72d0ca25e930adbfd17bbf05858abb8577f40dcc3dc8afa92ed864881f9b85e2c7551f47142bb9b5c1d5d576b516833dbf2397cf3287c345dbdb96a9ff1544
+  metadata.gz: ba2e88c89011f2461ffb435f551d4933a9a6e5759dc7e9ddbe0cef7de50c97d186a2d366407206f20324e52509b301cec4d2680691339a68e4eef04606541a3a
+  data.tar.gz: 2f998d5155526a21c6aa83f51a48ebad07d88d000f9836a048ac32558b6d6f1ba595e0238f02d9c4eef78e95a8c038ab624f575d0245f3f9212c3812926677d2

data/README.md

@@ -1,6 +1,7 @@
 # GemPolish
 
-Further polishes your Bundler gem skeleton.
+Command line tool to help with gem creation and maintenance. Is meant to be used in
+addition to `bundler`'s `gem` command.
 
 ## Installation
 
@@ -8,9 +9,9 @@ Further polishes your Bundler gem skeleton.
 
 ## Usage
 
-Provides two executables to improve your Bundler gem skeleton.
+Provides the executable `gem_polish`, which boasts the following subcommands:
 
-- polish_gem
+- __polish__
 
 Is meant to be used inside the directory a newly created gem (`bundle gem GEM_NAME`)
 Available options:
@@ -32,27 +33,35 @@ for gem polishing. Check the `examples` folder for its formatting.
 Here's an example of the syntax:
 ```
 # inside a new gem called test
-polish_gem -nc -d 'a test gem' -t 1.9.3 jruby-1.7.8 -b travis coveralls
+gem_polish polish -nc -d 'a test gem' -t 1.9.3 jruby-1.7.8 -b travis coveralls
 ```
 This would polish the test gem with coveralls support,
 circumventing the `.gem_polish.yml` file, adding a description,
 using two ruby versions for travis and adding two badges to the
 README file. 
 
+For ease of use you can issue `polish_gem` instead of `gem_polish
+polish` directly on the command line.
 
-* create_gem
-
-Combines gem creation and polishing:
+The additional executable `create_gem` combines gem creation and polishing:
 ``` 
 create_gem my_new_gem
 ```
-This will create the new gem `my_new_gem`. Arguments of `polish_gem` can be passed to override defaults or provide a description.
+This will create the new gem `my_new_gem`. Arguments of `polish_gem` can
+be passed to override defaults or to provide a description.
 ```
 create_gem my_new_gem -d 'Does nothing so far'
 ```
 At the moment he `bundle gem` command is invoked with `-t rspec` to
 provide the `rspec` test framework by default.
 
+- __version__
+
+Provides a version reader and a version bumper. Call `gem_polish
+version` to learn about its usage. Also includes support to commit your
+version bump directly through `git`.
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/LFDM/gem_polish/fork )

data/bin/gem_polish

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gem_polish'
+GemPolish::CLI.start

data/gem_polish.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = GemPolish::VERSION
   spec.authors       = ["LFDM"]
   spec.email         = ["1986gh@gmail.com"]
-  spec.summary       = %q{Further polishes your bundler gem skeleton}
-  spec.description   = %q{Adds code coverage tools, badges in README, more ruby versions in travis etc.}
+  spec.summary       = %q{Command line tool to help with gem creation and maintenance}
+  spec.description   = %q{Adds code coverage tools, badges in README, help with travis, gem versioning etc.}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/gem_polish/cli/versioner.rb

@@ -0,0 +1,78 @@
+module GemPolish
+  class CLI::Versioner
+    def initialize(thor)
+      @thor = thor
+      @version = extract_from_version_file
+    end
+
+    def extract_from_version_file
+      file_contents.match(regexp)
+      numbers = $1.split('.').map(&:to_i)
+      Hash[%w{ major minor revision}.zip(numbers)]
+    end
+
+    def to_version(hsh = @version)
+      hsh.values.join('.')
+    end
+
+    def substitute_version(v)
+      version = v.kind_of?(String) ? v : to_version(v)
+      @thor.gsub_file(file, regexp, insertion(version))
+      @thor.say_status(:bumped_version, "#{to_version} => #{version}")
+    end
+
+    def update_version(bumper)
+      set_back = false
+      @version.each_with_object({}) do |(level, number), h|
+        nl = if set_back
+               0
+             else
+               if level == bumper
+                 set_back = true
+                 number + 1
+               else
+                 number
+               end
+             end
+        h[level] = nl
+      end
+    end
+
+    def commit_version_bump(message)
+      if staged_files_present?
+        raise StandardError.new, "Commit aborted: Staged files present"
+      else
+        `git add #{file}`
+        `git commit -m "#{message}"`
+        sha = `git rev-parse --short HEAD`.chomp
+        @thor.say_status(:commited, %{#{sha} "#{message}"})
+      end
+    end
+
+    private
+
+    def gem_name
+      File.basename(Dir.pwd)
+    end
+
+    def file_contents
+      File.read(file)
+    end
+
+    def file
+      "lib/#{gem_name}/version.rb"
+    end
+
+    def regexp
+      /VERSION = "(.*?)"/
+    end
+
+    def insertion(version)
+      %{VERSION = "#{version}"}
+    end
+
+    def staged_files_present?
+      system('git status --porcelain | grep -o "^\w" >/dev/null')
+    end
+  end
+end

data/lib/gem_polish/cli.rb

@@ -3,16 +3,25 @@ require 'yaml'
 
 module GemPolish
   class CLI < Thor
+
+    require 'gem_polish/cli/versioner'
     include Thor::Actions
 
-    desc "polish", "polishes your gem"
-    method_option :badges, type: :array, aliases: '-b'
-    method_option :git_user, type: :string, aliases: '-g'
-    method_option :description, aliases: '-d'
-    method_option :coverage, aliases: '-c'
-    method_option :rspec_conf, aliases: '-r'
-    method_option :travis, type: :array, aliases: '-t'
-    method_option :no_default, aliases: '-n'
+    desc "polish", "Polishes your gem skeleton"
+    method_option :badges, type: :array, aliases: '-b',
+      desc: 'Adds badges to your README. Takes one or more of: badge_fury, gemnasium, travis, coveralls and code_climate'
+    method_option :git_user, type: :string, aliases: '-g',
+      desc: 'Git user to be used for badge links. Defaults to your .gitconfig information'
+    method_option :description, aliases: '-d',
+      desc: 'Adds a descriptopn to the gemspec and the README'
+    method_option :coverage, aliases: '-c',
+      desc: 'Adds coveralls coverage'
+    method_option :rspec_conf, aliases: '-r',
+      desc: 'Adds additional rspec configuration'
+    method_option :travis, type: :array, aliases: '-t',
+      desc: 'Adds ruby versions to travis'
+    method_option :no_default, aliases: '-n',
+      desc: 'Bypasses ~/.gem_polish.yml. Defaults to false'
     def polish(name = '.')
       inside name do
         default = options.has_key?('no_default') ? {} : def_conf
@@ -30,6 +39,34 @@ module GemPolish
       end
     end
 
+    desc 'version OPTION', 'Reads and writes the version file of your gem'
+    method_option :read, type: :boolean, aliases: '-r',
+      desc: 'Print current version number'
+    method_option :bump, aliases: '-b', lazy_default: 'revision',
+      desc: 'Bumps the version number (revision [default], minor or major)'
+    method_option :version, aliases: '-v',
+      desc: 'Specify the new version number directly'
+    method_option :commit, aliases: '-c', lazy_default: 'Bump version',
+      desc: 'Creates a git commit of a bump, takes a message, defaults to "Bump version"'
+    def version(name = '.')
+      inside name do
+        return help(:version) if options.empty?
+        v = Versioner.new(self)
+
+        if specified_version = options[:version]
+          v.substitute_version(specified_version)
+        elsif options[:read]
+          puts v.to_version
+        elsif bump = options[:bump]
+          updated = v.update_version(bump)
+          v.substitute_version(updated)
+          if message = options[:commit]
+            v.commit_version_bump(message)
+          end
+        end
+      end
+    end
+
     no_commands do
       def parse_opt(opt, opts, default)
         opts[opt] || default[opt]

data/lib/gem_polish/version.rb

@@ -1,3 +1,3 @@
 module GemPolish
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/gem_polish/cli/versioner_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe GemPolish::CLI::Versioner do
+  let(:versioner) { GemPolish::CLI::Versioner.new('') }
+  let(:version_file) do
+    <<-FILE
+    module Dummy
+      VERSION = "2.1.3"
+    end
+    FILE
+  end
+  let(:version_hash) do
+    {
+      'major' => 2,
+      'minor' => 1,
+      'revision' => 3,
+    }
+  end
+
+  describe "#extract_from_version_file" do
+    it "returns current version as a hash" do
+      versioner.stub(:file_contents) { version_file }
+      versioner.extract_from_version_file.should == version_hash
+    end
+  end
+
+  describe "#to_version" do
+    it "converts a given version hash to a string" do
+      versioner.to_version(version_hash).should == "2.1.3"
+    end
+
+    it "returns current version when no version hash is given" do
+      versioner.stub(:file_contents) { version_file }
+      versioner.instance_variable_set(:@version, versioner.extract_from_version_file)
+      versioner.to_version.should == "2.1.3"
+    end
+  end
+
+  describe "#update_version" do
+    before(:each) do
+      versioner.stub(:file_contents) { version_file }
+      versioner.instance_variable_set(:@version, versioner.extract_from_version_file)
+    end
+
+    describe "#returns an updated version hash for the given bumper" do
+      it "bumps revision" do
+        res = {
+          'major' => 2,
+          'minor' => 1,
+          'revision' => 4,
+        }
+        versioner.update_version('revision').should == res
+      end
+
+      it "bumps minor version" do
+        res = {
+          'major' => 2,
+          'minor' => 2,
+          'revision' => 0,
+        }
+        versioner.update_version('minor').should == res
+      end
+
+      it "bumps major version" do
+        res = {
+          'major' => 3,
+          'minor' => 0,
+          'revision' => 0,
+        }
+        versioner.update_version('major').should == res
+      end
+    end
+  end
+
+  describe "#commit_version_bump" do
+    it "raises an error when staged files are present" do
+      versioner.stub(:staged_files_present?) { true }
+      expect { versioner.commit_version_bump('') }.to raise_error StandardError, /aborted/
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_polish
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - LFDM
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,12 +66,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds code coverage tools, badges in README, more ruby versions in travis
+description: Adds code coverage tools, badges in README, help with travis, gem versioning
   etc.
 email:
 - 1986gh@gmail.com
 executables:
 - create_gem
+- gem_polish
 - polish_gem
 extensions: []
 extra_rdoc_files: []
@@ -84,16 +85,19 @@ files:
 - README.md
 - Rakefile
 - bin/create_gem
+- bin/gem_polish
 - bin/polish_gem
 - examples/.gem_polish.yml
 - gem_polish.gemspec
 - gem_polish.thor
 - lib/gem_polish.rb
 - lib/gem_polish/cli.rb
+- lib/gem_polish/cli/versioner.rb
 - lib/gem_polish/version.rb
 - lib/templates/coveralls.template
 - lib/templates/rspec_configuration.template
 - spec/gem_polish_spec.rb
+- spec/lib/gem_polish/cli/versioner_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -118,7 +122,8 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Further polishes your bundler gem skeleton
+summary: Command line tool to help with gem creation and maintenance
 test_files:
 - spec/gem_polish_spec.rb
+- spec/lib/gem_polish/cli/versioner_spec.rb
 - spec/spec_helper.rb