gem_polisher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6d7b3ec998e563cd973f180ccc292198d08709f
+  data.tar.gz: 570221fd0fcf51c0bc410a163d5764c8724a2f2e
+SHA512:
+  metadata.gz: 2b87621abf6c71a8abe889609f9b23c9b241f3a190a9eeaa41a8b09de084ab914832695b6611140fdc032968d744efed323750ebb095db2e5afc081823cc2b16
+  data.tar.gz: 1b403ece4ee9e436872cf8525835d9961e1e690f9593757965773a8d008230d58b6a0110664fb4f3fedcb645b5793fb6325d9ad8d937e7b42be0d9b4d9181072

data/README.md

@@ -0,0 +1,8 @@
+# gem_polisher
+
+* Home: [https://github.com/fornellas/gem_polisher/](https://github.com/fornellas/gem_polisher/)
+* Bugs: [https://github.com/fornellas/gem_polisher/issues](https://github.com/fornellas/gem_polisher/issues)
+
+## Description
+
+This Gem provides Rake tasks to assist Ruby Gem development workflow.

data/lib/gem_polisher.rb

@@ -0,0 +1,59 @@
+require 'rake'
+require 'agita'
+require_relative 'gem_polisher/gem_info'
+require_relative 'gem_polisher/task'
+Dir.glob(File.dirname(__FILE__)+ '/gem_polisher/*_task.rb').each do |task|
+  require_relative task
+end
+
+# Provides Rake tasks to assist Ruby Gem development workflow.
+class GemPolisher
+
+  extend Forwardable
+
+  # GemInfo instance
+  attr_reader :gem_info
+
+  def_delegators :gem_info,
+    :gemspec_path,
+    :gem_name,
+    :gem_require,
+    :gem_main_constant_s
+
+  # Command used to publish Gem.
+  attr_reader :gem_publish_command
+
+  # Hash with all created Rake tasks
+  attr_reader :rake_tasks
+
+  # Agita instance
+  attr_reader :agita
+
+
+  # This should be called from within Rakefile. It will create necessary Rake tasks.
+  # Optionally, a Hash can be passed with:
+  # +:gem_publish_command+:: Command to use to publish your gem (eg. "gem inabox"). Default: "gem push".
+  # This Hash is also passed to GemPolisher::GemInfo#initialize, so same options are valid here.
+  def initialize opts={}
+    unless ENV["BUNDLE_GEMFILE"]
+      raise RuntimeError.new("#{self.class.to_s} should not be called outside Bundler environment. Try calling rake with 'bundle exec rake'")
+    end
+    @gem_info = GemInfo.new(opts)
+    @gem_publish_command = opts.fetch(:gem_publish_command) { 'gem push' }
+    @agita = Agita.new
+    @rake_tasks = []
+    define_rake_tasks
+  end
+
+  private
+
+  # Defire Rake tasks
+  def define_rake_tasks
+    # For each *Task class...
+    self.class.constants.keep_if{|c| c.match(/.Task$/)}.each do |constant|
+      # ...initialize it
+      @rake_tasks << self.class.const_get(constant).send(:new, self)
+    end
+  end
+
+end

data/lib/gem_polisher/gem_info.rb

@@ -0,0 +1,100 @@
+require 'semantic'
+
+class GemPolisher
+  # Extracts information from Gem at current directory.
+  class GemInfo
+
+    # String representing Gem's main constant.
+    attr_reader :gem_main_constant_s
+
+    # Optin Hash can be passed with:
+    # +:gem_main_constant_s+:: By default, conventions documented at http://guides.rubygems.org/name-your-gem/ are followed to extract Gem's main constant name, but with strict camel case (eg: Rdoc no RDoc). Use this option case your gem does not follow strict camel case. Eg: for Gem named +net-http-persistent+, use +"Net::HTTP::Persistent"+ here.
+    def initialize opts={}
+      @gem_main_constant_s = opts.fetch(:gem_main_constant_s) do
+        default_gem_main_constant_s
+      end
+    end
+
+    # Return path to .gemspec file.
+    def gemspec_path
+      path = Dir.glob('*.gemspec').first
+      unless path
+        raise Errno::ENOENT.new('*.gemspec not found')
+      end
+      path
+    end
+
+    # Returns Gem name from #gemspec_path file.
+    def gem_name
+      gemspec_path.gsub(/\.gemspec$/, '')
+    end
+
+    # Argument to be used for #require for the gem.
+    def gem_require
+      gem_name.downcase.gsub(/-/, '/')
+    end
+
+    # Returns String with name of Gem's main constant, calculated from #gem_name, following conventions at: http://guides.rubygems.org/name-your-gem/
+    def default_gem_main_constant_s
+      const = gem_name
+        .capitalize
+        .split('_')
+        .map{|n| n.capitalize}
+        .join('')
+      if const.match(/-/)
+        const
+          .split('-')
+          .map do |n|
+             n[0].capitalize +
+              n[1, n.length]
+           end
+          .join('::')
+      else
+        const
+      end
+    end
+
+    # Returns value of Gem's main constant.
+    def gem_main_constant
+      gem_specification # avoid NameError if not loaded.
+      Object.const_get(gem_main_constant_s)
+    end
+
+    # Returns Gem::Specification object.
+    def gem_specification
+      # Avoids warning over redefined VERSION constant
+      version_const_str = '::' + gem_main_constant_s + "::VERSION"
+      if Object.const_defined?(version_const_str)
+        Object.const_get(gem_main_constant_s).send(:remove_const, :VERSION)
+      end
+      # Allow #gem_version_rb to be reloaded after changes
+      $LOADED_FEATURES.delete_if{|f| f == File.absolute_path(gem_version_rb)}
+      eval(File.open(gemspec_path, 'r').read, nil, gemspec_path)
+    end
+
+    # Returns a Semantic::Version instance
+    def semantic_version
+      Semantic::Version.new(gem_specification.version.to_s)
+    end
+
+    # Path to Gem's version.rb
+    def gem_version_rb
+      "lib/#{gem_name}/version.rb"
+    end
+
+    # Increment version at "lib/#{gem_name}/version.rb".
+    def inc_version! type
+      new_version = semantic_version.increment!(type)
+      const_class = gem_main_constant.class.to_s.downcase
+      const_name = gem_main_constant
+      ancestor_classes = gem_main_constant.ancestors.keep_if{|a| a.class == Class}
+      parent_class = ( parent = ancestor_classes[1] ) == Object ? nil : parent
+      File.open(gem_version_rb, 'w') do |io|
+        io.puts "#{const_class} #{const_name}#{" < #{parent_class}" if parent_class}"
+        io.puts "  VERSION = '#{new_version.to_s}'"
+        io.puts "end"
+      end
+      new_version
+    end
+  end
+end

data/lib/gem_polisher/release_task.rb

@@ -0,0 +1,80 @@
+class GemPolisher
+  # gem:release task
+  class ReleaseTask < Task
+
+    extend Forwardable
+
+    def_delegators :gem_polisher,
+      :agita,
+      :gem_info,
+      :gem_publish_command
+
+    def create_task
+      namespace :gem do
+        desc 'Update bundle, run tests, increment version, build and publish Gem; type can be major, minor or patch.'
+        task :release, [:type] do |t, args|
+          type = args[:type]
+          git_ensure_master_updated_clean
+          bundle_update
+          Rake::Task[:test].invoke
+          inc_version(type)
+          gem_build
+          gem_publish
+        end
+      end
+    end
+
+    private
+
+    # :section: Steps
+
+    # Make sure we are at master, updated and clean.
+    def git_ensure_master_updated_clean
+      agita.ensure_master_updated_clean
+    end
+
+    # bundle update
+    def bundle_update
+      run 'bundle update'
+      if agita.commit('Updated Bundle', 'Gemfile.lock')
+        unless File.basename($PROGRAM_NAME) == 'rake'
+          raise RuntimeError.new("Not executed by rake executable!")
+        end
+        exec 'bundle', *['exec', 'rake', *ARGV]
+      end
+    end
+
+    # Increment Gem version
+    def inc_version type
+      new_version = gem_info.inc_version!(type)
+      # This loop shouldn't be needed, but test fails without it. Bundler bug?
+      2.times{ run("bundle install") }
+      agita.commit("Increased #{type} version.", 'Gemfile.lock', gem_info.gem_version_rb)
+      agita.tag("v#{new_version.to_s}", "New #{type} version.")
+    end
+
+    # Build .gem
+    def gem_build
+      run("gem build #{gem_info.gem_name}.gemspec")
+    end
+
+    # Path to .gem
+    def gem_path
+      "#{gem_info.gem_name}-#{gem_info.semantic_version}.gem"
+    end
+
+    # Publishes .gem with gem_publish_command
+    def gem_publish
+      run("#{gem_publish_command} #{Shellwords.escape(gem_path)}")
+    end
+
+    # :section: Helpers
+
+    def run command
+      output = `#{command}`
+      raise "#{command} returned non-zero status:\n#{output}" unless $?.exitstatus == 0
+      output
+    end
+
+  end
+end

data/lib/gem_polisher/task.rb

@@ -0,0 +1,27 @@
+class GemPolisher
+  # Parent class that handles Rake tasks creation
+  class Task
+
+    include Rake::DSL
+
+    # GemPolisher instance
+    attr_reader :gem_polisher
+
+    extend Forwardable
+
+    def_delegators :gem_polisher,
+      :gem_info
+
+    # Receive a GemPolisher instance
+    def initialize gem_polisher
+      @gem_polisher = gem_polisher
+      create_task
+    end
+
+    # Creates Rake task (abstract method)
+    def create_task
+      raise "Not implemented!"
+    end
+
+  end
+end

data/lib/gem_polisher/test_task.rb

@@ -0,0 +1,9 @@
+class GemPolisher
+  # test task
+  class TestTask < Task
+    def create_task
+      desc 'Run all tests.'
+      task :test
+    end
+  end
+end

data/lib/gem_polisher/version.rb

@@ -0,0 +1,3 @@
+class GemPolisher
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: gem_polisher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Pugliese Ornellas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: agita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+description: This Gem provides Rake tasks to assist Ruby Gem development workflow.
+email: fabio.ornellas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/gem_polisher.rb
+- lib/gem_polisher/gem_info.rb
+- lib/gem_polisher/release_task.rb
+- lib/gem_polisher/task.rb
+- lib/gem_polisher/test_task.rb
+- lib/gem_polisher/version.rb
+homepage: https://github.com/fornellas/gem_polisher
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+- lib/
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: This Gem provides Rake tasks to assist Ruby Gem development workflow.
+test_files: []
+has_rdoc: