rake-n-bake 1.0.0

data/lib/dependency_checker.rb

@@ -0,0 +1,26 @@
+require 'term/ansicolor'
+
+class RakeNBake
+  class DependencyChecker
+    include Term::ANSIColor
+
+    def initialize dependencies
+      @dependencies = Array(dependencies)
+    end
+
+    def check silent = false
+      @results = @dependencies.each_with_object({}) do |dep, results|
+        results[dep] = system "which #{dep} >/dev/null"
+        unless silent
+          results[dep] ? print(".".green) : print("F".red)
+        end
+      end
+    end
+
+    def missing
+      @results ||= check(true)
+      @results.select{|_, present| present == false}.keys
+    end
+
+  end
+end

data/lib/rake_n_bake.rb

@@ -0,0 +1,9 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rake'
+
+lib = File.expand_path("../lib", File.dirname(__FILE__))
+Dir.glob("#{lib}/*.rb").each{|l| require l}
+
+dir = File.expand_path("../tasks", File.dirname(__FILE__))
+Dir.glob("#{dir}/*.rake").each { |r| import r}

data/lib/semver_versioning.rb

@@ -0,0 +1,62 @@
+require 'semver'
+class RakeNBake
+  class SemverVersioning
+    def self.current_version
+      if File.exist? SemVer.file_name
+        SemVer.find
+      else
+        version = SemVer.new
+        version.save SemVer.file_name
+        version
+      end
+    end
+
+    def self.inc_major
+      v = current_version
+      v.major = v.major.to_i + 1
+      v.minor = '0'
+      v.patch = '0'
+      v.save
+    end
+
+    def self.inc_minor
+      v = current_version
+      v.minor = v.minor.to_i + 1
+      v.patch = '0'
+      v.save
+    end
+
+    def self.inc_patch
+      v = current_version
+      v.patch = v.patch.to_i + 1
+      v.save
+    end
+
+    def self.prerelease s
+      v = current_version
+      v.special = s
+      v.save
+    end
+
+    def self.inc_prerelease s
+      inc_major
+      v = current_version
+      v.special = s
+      v.save
+    end
+
+    def self.release
+      v = current_version
+      v.special = ''
+      v.save
+    end
+
+    def self.tag
+      v = current_version.to_s
+      `git add .semver && git commit -m 'Increment version to #{v}' && git tag #{v}`
+      branch = `git symbolic-ref HEAD`[%r{.*/(.*)}, 1]
+      puts "To push the new tag, use 'git push origin #{branch} --tags'"
+    end
+  end
+end
+

data/lib/version.rb

@@ -0,0 +1,64 @@
+class RakeNBake
+  class Version
+    HISTORY_FILE = "history.rdoc"
+    def self.current_history history_file
+      unless File.exists? history_file
+         File.open history_file, "w" do |f|
+           f.puts "== 0.0.0 (#{Time.now.strftime "%d %B %Y"})"
+         end
+      end
+      File.read history_file
+    end
+
+    def self.latest_version
+      latest_version_string = current_history(HISTORY_FILE)[/== ([\d\.]*)/, 1] || "0.0.0"
+      @latest_version ||= latest_version_string.split(".").map(&:to_i)
+      def @latest_version.to_s
+        join "."
+      end
+      @latest_version
+    end
+
+    def self.update_to version
+      add_history_header version
+      update_gem version if gem?
+      commit version
+      tag version
+      branch = `git symbolic-ref HEAD`[%r{.*/(.*)}, 1]
+      puts "To push the new tag, use 'git push origin #{branch} --tags'"
+    end
+
+    def self.add_history_header(version, history_file = HISTORY_FILE)
+      history = current_history history_file
+      File.open history_file, "w" do |f|
+        f.puts "== #{version} (#{Time.now.strftime "%d %B %Y"})"
+        f.puts
+        f.print history
+      end
+      puts "Added version to history.rdoc"
+    end
+
+    def self.update_gem version
+      path = Dir.glob('*.gemspec').first
+      text = File.read path
+      File.open(path, "w") do |file|
+        file.puts text.sub(/(.*version\s*=\s*)(['|"].*['|"])/, "\\1'#{version}'")
+      end
+      puts "Added version to .gemfile"
+    end
+
+    def self.commit version
+      `git add . && git commit -m 'increment version to #{version}'`
+      puts "Committed change"
+    end
+
+    def self.tag version
+      `git tag #{version}`
+      puts "Tagged with #{version}"
+    end
+
+    def self.gem?
+      !Dir.glob('*.gemspec').empty?
+    end
+  end
+end

data/rake-n-bake.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rake-n-bake"
+  spec.version       = '1.0.0'
+  spec.authors       = ["Richard Vickerstaff", "Adam Whittingham"]
+  spec.email         = ["m3akq@btinternet.com", "adam.whittingham@gmail.com"]
+  spec.description   = "Common rake tasks, baked to perfection and ready to serve!"
+  spec.summary       = "Common rake tasks, baked to perfection and ready to serve!"
+  spec.homepage      = "https://github.com/RichardVickerstaff/rake-n-bake"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib","tasks"]
+
+  spec.add_runtime_dependency "rake", "~> 10"
+  spec.add_runtime_dependency "term-ansicolor", "~> 1.3"
+end

data/spec/dependency_checker_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'term/ansicolor'
+include Term::ANSIColor
+
+describe RakeNBake::DependencyChecker do
+
+  # Note that this test will fail if you, somehow, have this insane string define on your path
+  let(:missing) {'jajfjfjosojfnbje3nknq'}
+  let(:present) {'rspec'}
+  let(:list){ [present, missing] }
+
+  subject{RakeNBake::DependencyChecker.new list}
+
+  describe '#check' do
+    before { $stdout = StringIO.new }
+
+    it 'returns a hash of dependencies => presence' do
+      result = subject.check
+      expect(result).to eq({present => true, missing => false})
+    end
+
+    it 'prints a dot for dependencies which are present' do
+      expect{subject.check}.to output(/\./).to_stdout
+    end
+
+    it 'prints a F for missing dependencies' do
+      expect{subject.check}.to output(/F/).to_stdout
+    end
+
+    it 'can be run without printing anything out' do
+      expect{subject.check(true)}.to_not output.to_stdout
+    end
+  end
+
+  describe '#missing_from' do
+    it 'returns only missing dependencies' do
+      expect(subject.missing).to eq [missing]
+    end
+  end
+
+end

data/spec/semver_versioning_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+require 'yaml'
+
+describe RakeNBake::SemverVersioning do
+  let(:version) {
+    {
+      major: '1',
+      minor: '2',
+      patch: '3',
+      special: '',
+      metadata: ''
+    }
+  }
+  before(:all) do
+    if File.exist? File.join(File.dirname(__FILE__), '../.semver')
+      @current_semver_file = File.read(File.join(File.dirname(__FILE__), '../.semver'), force: true)
+    end
+  end
+
+  after(:all) do
+    if @current_semver_file
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), @current_semver_file, force: true)
+    end
+  end
+  before do
+    FileUtils.rm(File.join(File.dirname(__FILE__), '../.semver'), force: true)
+  end
+  after do
+    FileUtils.rm(File.join(File.dirname(__FILE__), '../.semver'), force: true)
+  end
+  describe '#current_version' do
+    context 'when there is no .semver file' do
+      it 'returns the current version' do
+        expect(described_class.current_version.to_s).to eq 'v0.0.0'
+      end
+    end
+
+    context 'when there is a .semver file' do
+      before do
+        File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+      end
+
+      it 'returns the current version' do
+        expect(described_class.current_version.to_s).to eq 'v1.2.3'
+      end
+    end
+  end
+
+  describe 'inc_major' do
+    before do
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+    end
+    it 'increases major and resets minor and patch' do
+      described_class.inc_major
+      expect(described_class.current_version.to_s).to eq 'v2.0.0'
+    end
+  end
+
+  describe 'inc_minor' do
+    before do
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+    end
+    it 'increases minor and resets patch' do
+      described_class.inc_minor
+      expect(described_class.current_version.to_s).to eq 'v1.3.0'
+    end
+  end
+
+  describe 'inc_patch' do
+    before do
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+    end
+    it 'increases minor and resets patch' do
+      described_class.inc_patch
+      expect(described_class.current_version.to_s).to eq 'v1.2.4'
+    end
+  end
+
+  describe 'prerelease' do
+    before do
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+    end
+    it 'sets the prerelease to the supplied string' do
+      described_class.prerelease 'something'
+      expect(described_class.current_version.to_s).to eq 'v1.2.3-something'
+    end
+  end
+
+  describe 'inc_prerelease' do
+    before do
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+    end
+    it 'increments major version and sets the prerelease to the supplied string' do
+      described_class.inc_prerelease 'something'
+      expect(described_class.current_version.to_s).to eq 'v2.0.0-something'
+    end
+  end
+
+  describe 'release' do
+    before do
+      v = version
+      v[:special] = "a string"
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(v))
+    end
+    it 'removes the prerelease' do
+      described_class.release
+      expect(described_class.current_version.to_s).to eq 'v1.2.3'
+    end
+  end
+
+  describe 'tag' do
+    before do
+      File.write(File.join(File.dirname(__FILE__), '../.semver'), YAML.dump(version))
+    end
+    it 'tags with the curren semver release and outputs push instructions' do
+      expect(Object).to receive(:`).with("git add .semver && git commit -m 'Increment version to v1.2.3' && git tag v1.2.3")
+      expect(Object).to receive(:`).with('git symbolic-ref HEAD').and_return 'refs/heads/master'
+      expect(Object).to receive(:puts).with("To push the new tag, use 'git push origin master --tags'")
+      described_class.tag
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'timecop'
+require 'tempfile'
+
+SimpleCov.start do
+  add_filter '/vendor/'
+  add_filter '/spec/'
+  coverage_dir 'log/coverage/spec'
+end
+
+require_relative '../lib/rake_n_bake'

data/spec/version_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe RakeNBake::Version do
+  before do
+    allow(described_class).to receive(:`)
+    allow(described_class).to receive(:puts)
+  end
+
+  describe '.current_history' do
+    let(:tmp_file) { Tempfile.new(['history','.rdoc']) }
+
+    context 'when there is a history file' do
+      before do
+        allow(File).to receive(:read).and_return 'history'
+        allow(File).to receive(:exists?).and_return true
+      end
+
+      it 'returns the current history file' do
+        expect(described_class.current_history(tmp_file.path)).to eq 'history'
+      end
+    end
+
+    context 'when there is no history file' do
+      before do
+        allow(File).to receive(:exists?).and_return false
+      end
+
+      it 'creates a history file at version 0.0.0' do
+        expect(described_class.current_history(tmp_file.path)).to match(/\= 0.0.0 /)
+      end
+    end
+  end
+
+  describe '.latest_version' do
+    before do
+      allow(File).to receive(:read).and_return "== 1.2.3 (16 July 2014)\n * Change version tack so it can update gem version"
+    end
+
+    context 'there is no version'do
+      it 'returns a version of [0,0,0]' do
+        allow(File).to receive(:read).and_return ""
+        expect(described_class.latest_version).to eq [1,2,3]
+      end
+    end
+
+    context 'there is a version' do
+      it 'returns the latest version' do
+        expect(described_class.latest_version).to eq [1,2,3]
+      end
+    end
+
+    it 'defines the .to_s of the latest version'do
+      expect(described_class.latest_version.to_s).to eq "1.2.3"
+    end
+  end
+
+  describe '.gem?' do
+    context 'the project is a gem' do
+      before do
+        allow(Dir).to receive(:glob).and_return ['a gem spec']
+      end
+
+      it 'returns true' do
+        expect(described_class.gem?).to eq true
+      end
+    end
+
+    context 'the project is not a gem' do
+      before do
+        allow(Dir).to receive(:glob).and_return []
+      end
+
+      it 'returns false' do
+        expect(described_class.gem?).to eq false
+      end
+    end
+  end
+
+  describe '.update_gem' do
+    let(:tmp_file) { Tempfile.new(['rake-n-bake','.gemspec']) }
+
+    before do
+      gemspec = <<-GEM
+        Gem::Specification.new do |spec|
+          spec.name          = "rake-n-bake"
+          spec.version       = '0.0.5'
+          spec.authors       = ["Richard Vickerstaff", "Adam Whittingham"]
+        end
+      GEM
+      tmp_file.write gemspec
+      tmp_file.rewind
+      allow(Dir).to receive(:glob).and_return [tmp_file.path]
+    end
+
+    it 'updates the gem version' do
+      t = Time.local(2014, 7, 16)
+      Timecop.travel(t) do
+        described_class.update_gem 'foo'
+        expect(File.read(tmp_file)).to match(/.*version\s*= 'foo'/)
+      end
+    end
+
+    it 'outputs a message to the user' do
+      expect(described_class).to receive(:puts).with 'Added version to .gemfile'
+      described_class.update_gem 'foo'
+    end
+  end
+
+  describe '.update_to' do
+    before do
+      allow(described_class).to receive(:`).and_return "refs/heads/master"
+    end
+
+    it 'updates the version' do
+      expect(described_class).to receive(:add_history_header).with 'foo'
+      expect(described_class).to receive(:update_gem).with 'foo'
+      expect(described_class).to receive(:commit).with 'foo'
+      expect(described_class).to receive(:tag).with 'foo'
+      expect(described_class).to receive(:`).with 'git symbolic-ref HEAD'
+      expect(described_class).to receive(:puts).with "To push the new tag, use 'git push origin master --tags'"
+      described_class.update_to 'foo'
+    end
+  end
+
+  describe '.add_history_header' do
+    let(:tmp_file) { Tempfile.new('foo').path }
+
+    it 'adds the new headre to the history.rdoc' do
+      t = Time.local(2014, 7, 16)
+      Timecop.travel(t) do
+        described_class.add_history_header 'foo', tmp_file
+        expect(File.read tmp_file).to eq "== foo (16 July 2014)\n\n"
+      end
+    end
+
+    it 'outputs a message to the user' do
+      expect(described_class).to receive(:puts).with 'Added version to history.rdoc'
+      described_class.add_history_header 'foo', tmp_file
+    end
+  end
+
+  describe '.commit' do
+    it 'commits all changes' do
+      expect(described_class).to receive(:`).with "git add . && git commit -m 'increment version to foo'"
+      described_class.commit 'foo'
+    end
+
+    it 'outputs a message to the user' do
+      expect(described_class).to receive(:puts).with 'Committed change'
+      described_class.commit 'foo'
+    end
+  end
+
+  describe '.tag' do
+    it 'it tags the commit with the new version' do
+      expect(described_class).to receive(:`).with 'git tag foo'
+      described_class.tag 'foo'
+    end
+
+    it 'outputs a message to the user' do
+      expect(described_class).to receive(:puts).with 'Tagged with foo'
+      described_class.tag 'foo'
+    end
+  end
+end