flexmls_gems 0.2.1

data/.gitignore

@@ -0,0 +1,13 @@
+*.DS_Store
+log/
+._*
+spec/reports/
+.bundle/ruby
+coverage
+vendor/bundle/
+vendor/cache/
+pkg/
+doc/
+tmp/*
+.buildpath
+.project

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in flexmls_gems.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    flexmls_gems (0.2.0)
+      grit (~> 2.4.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    ci_reporter (1.6.5)
+      builder (>= 2.1.2)
+    diff-lcs (1.1.2)
+    grit (2.4.1)
+      diff-lcs (~> 1.1)
+      mime-types (~> 1.15)
+    mime-types (1.16)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ci_reporter (~> 1.6.3)
+  flexmls_gems!
+  rake
+  rcov (~> 0.9.9)
+  rspec (~> 2.3.0)

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2011 Financial Business Systems, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/README.md

@@ -0,0 +1,32 @@
+flexmls Gems
+=====================
+Library and rake tasks for gem management 
+
+Documentation
+-------------
+Moving from tools like Jeweler and Hoe that manage gemspecs in some abstracted manner that requires 
+constant regeneration, this project relies on gems using "the Bundler way" of gemspec driven gem 
+development, but adds some of the nice other tools that Jeweler provides to dry up Rakefiles. This
+project is so dry, it uses itself to build itself!
+
+Installation
+------------------------
+    gem install flexmls_gems
+
+Usage Examples
+------------------------
+
+#### Rakefile
+    # Default gem tasks
+    require 'flexmls_gems/tasks'
+    # Enable rspec test tasks
+    require 'flexmls_gems/tasks/spec'
+    # Enable rdoc tasks
+    require 'flexmls_gems/tasks/rdoc'
+    
+TODO (and warning)
+------------------------
+This project is just getting started, and is predominantly focused on solving my immediate gem 
+pain points. Use at your own risk. I would love to make the library more pluggable (like hoe) 
+to extract any non generic code, but for the time being it will all be stuffed into one gem.
+

data/Rakefile

@@ -0,0 +1,5 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "bundler/gem_tasks"
+require 'flexmls_gems/tasks'
+require 'flexmls_gems/tasks/spec'
+require 'flexmls_gems/tasks/rdoc'

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/flexmls_gems.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "flexmls_gems/version"
+
+Gem::Specification.new do |s|
+  s.name        = "flexmls_gems"
+  s.version     = FlexmlsGems::VERSION
+  s.authors     = ["Wade McEwen"]
+  s.email       = ["wade@fbsdata.com"]
+  s.homepage    = ""
+  s.summary     = %q{Gem to manange common gem tasks}
+  s.description = %q{This gem is set of tasks to aid gems and tasks that largely reflect a gem run with bundler}
+
+  s.rubyforge_project = "flexmls_gems"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "grit", '~> 2.4.1'
+  s.add_development_dependency "rake"  
+  s.add_development_dependency 'rspec', '~> 2.3.0'
+  s.add_development_dependency 'ci_reporter', '~> 1.6.3'
+  s.add_development_dependency 'rcov', '~> 0.9.9'
+end

data/lib/flexmls_gems.rb

@@ -0,0 +1,8 @@
+require "flexmls_gems/version"
+require "flexmls_gems/version_helper"
+require "flexmls_gems/git_helper"
+require "flexmls_gems/task_helper"
+
+module FlexmlsGems
+  # Your code goes here...
+end

data/lib/flexmls_gems/git_helper.rb

@@ -0,0 +1,93 @@
+require 'grit'
+
+module FlexmlsGems
+  class GitError < StandardError ; end
+
+  class GitHelper
+    include Grit
+    attr_reader :pwd, :version
+    
+    def initialize(dir, version)
+      @pwd = dir
+      @version = version
+    end
+    
+    def check_status
+      changes = cmd_changes
+      raise GitError, "There are #{changes} outstanding changes in the repository.  Run 'git status' to address before tagging" if changes > 0
+    end
+    
+    def check_remote
+      if cmd_remote_list.include? "origin"
+        matches = cmd_ls_remote
+        if matches != ""
+          raise GitError, "Git tag #{tag} already exists on the origin remote repository"
+        end
+      else
+        raise GitError, "Git origin is missing, have you setup a remote repository?"
+      end
+    end
+    
+    def tag
+      "v#{version.chomp}"
+    end
+
+    def check_tags
+      if cmd_tags.include? tag
+        raise GitError, "The tag #{tag} already exists locally"
+      end
+    end
+    
+    def release
+      check_status 
+      check_remote 
+      check_tags
+      cmd_add_tag
+      cmd_push_master      
+      cmd_push_tags
+    end
+    
+    def commit_version
+      cmd_add "VERSION"
+      raise GitError, "Some uncommitted files are in the folder" unless cmd_changes == 1 
+      cmd_commit "Bumped version #{tag}" 
+    end
+    
+    def git
+      @git = Repo.new(pwd) if @git.nil?
+      return @git
+    end
+
+    def cmd_add(file)
+      git.add(file)
+    end
+    def cmd_commit(message)
+      git.commit_index(message)
+    end
+    def cmd_changes
+      s = git.status
+      changes = s.changed.count + s.added.count + s.deleted.count
+    end
+    def cmd_tags
+      git.tags
+    end
+    def cmd_ls_remote
+      `git ls-remote --tags origin #{tag}`
+    end
+    def cmd_add_tag
+      `git tag -a #{tag} -m "Adding new tag '#{tag}'for release"`
+    end
+    def cmd_push_master
+      raise GitError, "HEAD is not on the master branch" unless git.head.name == "master" 
+      `git push origin master`
+    end
+    def cmd_push_tags
+      `git push origin --tags`
+    end
+    def cmd_remote_list
+      git.remote_list
+    end
+    
+  end
+end
+

data/lib/flexmls_gems/task_helper.rb

@@ -0,0 +1,78 @@
+require 'rubygems/indexer'
+
+module FlexmlsGems
+  class TaskHelper
+    include Rake::DSL if defined? Rake::DSL
+    
+    attr_reader :pwd, :gemspec, :name, :version, :release_dir
+    
+    def initialize(opts={})
+      @pwd = opts[:dir] || Dir.pwd
+      gemspecs = opts[:name] ? [File.join(pwd, "#{opts[:name]}.gemspec")] : Dir[File.join(pwd, "*.gemspec")]
+      raise("FlexmlsGems expects one and only one gemspec in the root of the project.") unless gemspecs.size == 1
+      @gemspec = gemspecs.first
+      @name = opts[:name] || File.basename(gemspec, '.gemspec')
+      @version = Gem::Specification::load(gemspec).version
+      @release_dir = opts[:release] || '/opt/gems/dev'
+    end
+    
+    def setup
+      namespace :flexmls do
+        desc "Release the gem internally"
+        task :release do
+          gems = Dir[File.join("#{pwd}/pkg", "#{name}-#{version}.gem")]
+          raise "No gems built, run rake build to create" if gems.empty?
+          FileUtils.cp gems, "#{release_dir}/gems"
+          i=Gem::Indexer.new release_dir
+          i.generate_index
+        end
+      end
+      namespace :version do
+        namespace :bump do
+          desc "Bump the major version [#{version}] by 1"
+          task :major => [:version] do
+            version_helper.bump_major.save
+            git_helper.commit_version
+            $stdout.puts "Updated version to #{version_helper}"
+          end
+          desc "Bump the a minor version [#{version}]  by 1"
+          task :minor => [:version] do
+            version_helper.bump_minor.save
+            git_helper.commit_version
+            $stdout.puts "Updated version to #{version_helper}"
+          end
+          desc "Bump the patch version by [#{version}] 1"
+          task :patch => [:version] do
+            version_helper.bump_patch.save
+            git_helper.commit_version
+            $stdout.puts "Updated version to #{version_helper}"
+          end
+        end
+      end
+      task :version do
+        $stdout.puts "The current version is #{version_helper}"
+      end
+      namespace :git do
+        desc "Tag and release v#{version} to git"
+        task :release do
+          git_helper.release
+          $stdout.puts "Released #{version}"
+        end
+      end
+    end
+    
+    private 
+    def version_helper
+      return @version_helper unless @version_helper.nil?
+      @version_helper = VersionHelper.new(pwd)
+      @version_helper.load
+      @version_helper
+    end
+    def git_helper
+      return @git_helper unless @git_helper.nil?
+      @git_helper = GitHelper.new(pwd, version_helper.to_s)
+    end
+    
+  end
+end
+

data/lib/flexmls_gems/tasks.rb

@@ -0,0 +1,4 @@
+require "flexmls_gems"
+# By default we load in the tasks for typical gem projects
+require "flexmls_gems/tasks/gems"
+

data/lib/flexmls_gems/tasks/gems.rb

@@ -0,0 +1,3 @@
+require "flexmls_gems"
+require "bundler/gem_tasks"
+FlexmlsGems::TaskHelper.new.setup

data/lib/flexmls_gems/tasks/rdoc.rb

@@ -0,0 +1,12 @@
+require 'rake/rdoctask'
+
+helper = FlexmlsGems::TaskHelper.new
+
+Rake::RDocTask.new do |rdoc|
+  files =['lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.md" # page to start on
+  rdoc.title = "#{helper.name} #{helper.version} Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end

data/lib/flexmls_gems/tasks/spec.rb

@@ -0,0 +1,10 @@
+require 'ci/reporter/rake/rspec'
+require "rspec"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress"]
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rcov = true
+  t.rcov_opts = %w{--exclude /usr/local/rvm/gems/,bundle,spec}
+end

data/lib/flexmls_gems/version.rb

@@ -0,0 +1,3 @@
+module FlexmlsGems
+  VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").chomp
+end

data/lib/flexmls_gems/version_helper.rb

@@ -0,0 +1,66 @@
+
+module FlexmlsGems
+  class VersionHelper
+    
+    def initialize(pwd=Dir.pwd)
+      @pwd = pwd
+      reset
+    end
+    
+    attr_reader :major, :minor, :patch, :build
+    
+    def load
+      parse(File.read(path))
+    end
+    
+    def parse(string)
+      version_string = string.chomp
+      if version_string =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+        reset($1.to_i, $2.to_i, $3.to_i, $4)
+      end
+    end
+    
+    def path
+      File.join(@pwd,'VERSION')
+    end
+    
+    def bump_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+      @build = nil
+      self
+    end
+    
+    def bump_minor
+      @minor += 1
+      @patch = 0
+      @build = nil
+      self
+    end
+    
+    def bump_patch
+      @patch += 1
+      @build = nil
+      self
+    end
+    
+    def reset(major=0, minor=0, patch=0, build=nil)
+      @major = major
+      @minor = minor
+      @patch = patch
+      @build = build
+      self
+    end
+    
+    def to_s
+      [major,minor,patch,build].compact.join('.')
+    end
+    
+    def save
+      File.open(path,'w') { |f| f.write to_s }
+    end
+    
+  end
+
+end

data/spec/git_helper_spec.rb

@@ -0,0 +1,54 @@
+require './spec/spec_helper'
+
+TEST_VERSION = "1.0.0"
+describe FlexmlsGems::GitHelper do
+  subject { FlexmlsGems::GitHelper.new("",TEST_VERSION) }
+  it "should tag the release in the remote repository" do
+    subject.stub(:cmd_changes){ 0 }
+    subject.stub(:cmd_tags){ [] }
+    subject.stub(:cmd_ls_remote){ "" }
+    subject.stub(:cmd_add_tag)
+    subject.stub(:cmd_push_master)
+    subject.stub(:cmd_push_tags)
+    subject.stub(:cmd_remote_list){ ["origin"] }
+    
+    subject.should_receive(:cmd_add_tag).once
+    subject.should_receive(:cmd_push_master).once
+    subject.should_receive(:cmd_push_tags).once
+    
+    subject.release
+  end
+  
+  it "should halt release when there are status changes" do
+    subject.stub(:cmd_changes){ 1 }
+    expect {subject.release}.to raise_error(FlexmlsGems::GitError)
+  end
+  it "should halt release when the is already a matching #{TEST_VERSION} tag" do
+    subject.stub(:cmd_changes){ 0 }
+    subject.stub(:cmd_tags){ ["v#{TEST_VERSION}"] }
+    expect {subject.release}.to raise_error(FlexmlsGems::GitError)
+  end
+  it "should halt release when the origin already has the #{TEST_VERSION} tag" do
+    subject.stub(:cmd_changes){ 0 }
+    subject.stub(:cmd_tags){ [] }
+    subject.stub(:cmd_ls_remote){ "OMGIHAVEATAGALREADY" }
+    subject.stub(:cmd_remote_list){ ["origin"] }
+    expect {subject.release}.to raise_error(FlexmlsGems::GitError)
+  end
+  it "should halt release when there is no origin remote" do
+     subject.stub(:cmd_changes){ 0 }
+     subject.stub(:cmd_tags){ [] }
+     subject.stub(:cmd_ls_remote){ "" }
+     subject.stub(:cmd_remote_list){ ["someotherplace"] }
+     expect {subject.release}.to raise_error(FlexmlsGems::GitError)
+  end
+
+  it "should commit the git version" do
+    subject.stub(:cmd_changes){ 1 }
+    subject.should_receive(:cmd_add).with("VERSION").once
+    subject.should_receive(:cmd_commit).with("Bumped version v#{TEST_VERSION}").once
+    subject.commit_version
+  end
+  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "rspec"
+
+begin require "redgreen" unless ENV['TM_CURRENT_LINE']; rescue LoadError; end
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+
+require 'flexmls_gems'
+

data/spec/version_helper_spec.rb

@@ -0,0 +1,39 @@
+require './spec/spec_helper'
+
+
+describe FlexmlsGems::VersionHelper do
+  let(:old_version) { described_class.new.reset(1,2,3) } 
+  let(:pre_version) { described_class.new.reset(1,2,3,"pre") } 
+  context "increment" do
+    it "should bump the major version" do
+      subject.bump_major.to_s().should eq("1.0.0")
+      old_version.bump_major.to_s().should eq("2.0.0")
+      pre_version.bump_major.to_s().should eq("2.0.0")
+    end
+    it "should bump the minor version" do
+      subject.bump_minor.to_s().should eq("0.1.0")
+      old_version.bump_minor.to_s().should eq("1.3.0")
+      pre_version.bump_minor.to_s().should eq("1.3.0")
+    end
+    it "should bump the patch version" do
+      subject.bump_patch.to_s().should eq("0.0.1")
+      old_version.bump_patch.to_s().should eq("1.2.4")
+      pre_version.bump_patch.to_s().should eq("1.2.4")
+    end
+  end
+  context "File IO"
+    it "should save a new version" do
+      Dir.mktmpdir do |dir|
+        file = "#{dir}/VERSION"
+        File.open(file,"w") {|f| f.write "1.2.3" }
+        helper = FlexmlsGems::VersionHelper.new(dir)
+        helper.load
+        helper.major.should eq(1)
+        helper.minor.should eq(2)
+        helper.patch.should eq(3)
+        helper.bump_major.save
+        File.read(file).chomp.should eq "2.0.0"
+      end
+    end
+  
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: flexmls_gems
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Wade McEwen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 4
+        - 1
+        version: 2.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ci_reporter
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 6
+        - 3
+        version: 1.6.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  type: :development
+  version_requirements: *id005
+description: This gem is set of tasks to aid gems and tasks that largely reflect a gem run with bundler
+email: 
+- wade@fbsdata.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- flexmls_gems.gemspec
+- lib/flexmls_gems.rb
+- lib/flexmls_gems/git_helper.rb
+- lib/flexmls_gems/task_helper.rb
+- lib/flexmls_gems/tasks.rb
+- lib/flexmls_gems/tasks/gems.rb
+- lib/flexmls_gems/tasks/rdoc.rb
+- lib/flexmls_gems/tasks/spec.rb
+- lib/flexmls_gems/version.rb
+- lib/flexmls_gems/version_helper.rb
+- spec/git_helper_spec.rb
+- spec/spec_helper.rb
+- spec/version_helper_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: flexmls_gems
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Gem to manange common gem tasks
+test_files: 
+- spec/git_helper_spec.rb
+- spec/spec_helper.rb
+- spec/version_helper_spec.rb