bozo 0.3.2 → 0.3.3

data/lib/bozo/runner.rb

@@ -0,0 +1,58 @@
+module Bozo
+
+  # Module mixed into the all Bozo executors that provides functionality for
+  # command execution and logging.
+  module Runner
+
+    include Bozo::Logging
+
+    # Returns the global parameters.
+    attr_accessor :global_params
+
+    # Returns the command parameters.
+    attr_accessor :params
+
+    # Returns the environment variables.
+    attr_accessor :env
+
+    # Returns the build configuration.
+    attr_accessor :build_configuration
+
+    # Returns whether the build is being run on a build server.
+    def build_server?
+      global_params[:build_server]
+    end
+
+    # Returns the environment the build is being execute in.
+    def environment
+      global_params[:environment]
+    end
+
+    # Executes a command line tool.
+    #
+    # Raises a `Bozo::ExecutionError` if the command responds with a non-zero
+    # exit code.
+    #
+    # @param [Symbol] tool
+    #     A friendly identifier for the tool.
+    # @param [Array] args
+    #     An array of arguments making up the command to execute.
+    def execute_command(tool, args)
+      args.flatten!
+
+      executable = File.basename(args.first)
+      arguments = args[1..-1].join(' ')
+
+      log_info "  #{tool} - #{executable} #{arguments}"
+
+      raise Bozo::ExecutionError.new(tool, args, $?.exitstatus) unless system args.join ' '
+    end
+
+    # Returns the build version.
+    def version
+      build_configuration.version
+    end
+
+  end
+
+end

data/lib/bozo/versioning/version.rb

@@ -0,0 +1,87 @@
+module Bozo::Versioning
+
+  class Version
+
+    # @param major [Integer]
+    # @param minor [Integer]
+    # @param patch [Integer]
+    def initialize(major, minor, patch)
+      @major = major
+      @minor = minor
+      @patch = patch
+    end
+
+    # Loads the version from the VERSION file
+    def self.load_from_file
+      raise no_version_file unless File.exist? 'VERSION'
+      version = File.read('VERSION').strip
+      raise no_version if version.empty?
+      parse version
+    end
+
+    # Parses a version string to create a Version instance
+    #
+    # @param version [String]
+    def self.parse(version)
+      major, minor, patch = *version.split('.').map(&:to_i)
+      Version.new major, minor, patch
+    end
+
+    def major
+      @major
+    end
+
+    def minor
+      @minor
+    end
+
+    def patch
+      @patch
+    end
+
+    # Writes the version from the VERSION file
+    def write_to_file
+      File.open("VERSION", 'w') { |f| f << to_s }
+    end
+
+    # Bumps the part of the version
+    #
+    # @param part [Symbol]
+    def bump(part)
+      send "bump_#{part}".to_sym
+    end
+
+    def to_s
+      "#{@major}.#{@minor}.#{@patch}"
+    end
+
+    private
+
+    def bump_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+    end
+
+    def bump_minor
+      @minor += 1
+      @patch = 0
+    end
+
+    def bump_patch
+      @patch += 1
+    end
+
+    # Error if no version has been specified
+    def self.no_version
+      Bozo::ConfigurationError.new 'No version specified'
+    end
+
+    # Error if the version file could not be found
+    def self.no_version_file
+      Bozo::ConfigurationError.new "VERSION file could not be found in project #{Dir.pwd}"
+    end
+
+  end
+
+end

data/lib/bozo/versioning/version_bump_error.rb

@@ -0,0 +1,30 @@
+module Bozo::Versioning
+
+  # Error raised when a runner or hook finds the configuration or build in an
+  # unexpected state.
+  class VersionBumpError < StandardError
+
+    # The code the program should exit with upon handling this error.
+    attr_reader :exit_code
+
+    # A message explaining the corrective actions someone can take to avoid the
+    # error.
+    attr_reader :message
+
+    # Creates a new instance.
+    #
+    # @param [String] message
+    #     A message explaining the corrective actions someone can take to avoid
+    #     the error.
+    def initialize(message)
+      @message = message
+      @exit_code = -1
+    end
+
+    def inspect
+      "Version bump error: #{message}"
+    end
+
+  end
+
+end

data/lib/bozo/versioning/version_bumper.rb

@@ -0,0 +1,36 @@
+module Bozo::Versioning
+
+  class VersionBumper
+
+    include Bozo::Logging
+
+    def bump(part)
+      unless can_be_bumped?
+        raise VersionBumpError.new "State of the repository means the version can't be bumped. Ensure the staging index is empty."
+      end
+
+      version = Version.load_from_file
+      original_version = version.to_s
+
+      version.bump part
+      version.write_to_file
+
+      commit_version original_version, version
+
+      log_info "Bumped #{original_version} to #{version}"
+    end
+
+    private
+
+    def can_be_bumped?
+      `git diff --cached --name-only`.length == 0
+    end
+
+    def commit_version(original, new)
+      `git add VERSION`
+      `git commit -m "Bumped #{original} to #{new}."`
+    end
+
+  end
+
+end

data/lib/bozo.rb

@@ -0,0 +1,131 @@
+$:.push File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rainbow'
+require 'rainbow/ext/string'
+require 'gli'
+require 'gli_version'
+require 'bozo/bozo'
+require 'bozo/class_name_helpers'
+require 'bozo/logging'
+require 'bozo/runner'
+require 'bozo/executor'
+require 'bozo/bozo_configuration'
+require 'bozo/configuration_error'
+require 'bozo/execution_error'
+require 'bozo/versioning/version'
+require 'bozo/versioning/version_bumper'
+require 'bozo/versioning/version_bump_error'
+
+include GLI
+
+# Set the location of the bozo runtime configuration file
+config_file '.bozorc'
+
+version Bozo::VERSION
+
+desc 'Run as a build server, allows more destructive actions'
+switch 'build-server'
+
+default_config_file = 'bozorc.rb'
+
+desc "The build configuration file (defaults to #{default_config_file})"
+default_value default_config_file
+arg_name 'path'
+flag 'config-file'
+
+default_environment = 'development'
+
+desc "The build environment (defaults to #{default_environment})"
+default_value default_environment
+arg_name 'name'
+flag :environment
+
+pre do |global_options, command, options, arguments|
+  # Load the configuration file.
+  config = Bozo::BozoConfiguration.new
+  config.load global_options[:'config-file']
+
+  puts "Building #{config.version} using Bozo #{Bozo::VERSION}"
+  puts ''
+
+  # Initialize the executor.
+  @executor = Bozo::Executor.new config, global_options
+
+  true
+end
+
+# Helper method for defining a command that invokes a bozo task.
+#
+# The first provided name will be passed on to bozo.
+#
+# Takes an optional block for defining command-specific flags and switches.
+#
+# @param [Symbol] command_names
+#     The names to give the command.
+def bozo_command(*command_names)
+  command_name = command_names.first
+  command command_names do |c|
+    yield c if block_given?
+    c.action do |global_options, options, arguments|
+      @executor.execute command_name, options, ENV.to_hash
+    end
+  end
+end
+
+desc 'Remove bozo and all its artifacts'
+bozo_command :uninstall
+
+desc 'Remove all build artifacts'
+bozo_command :clean
+
+desc 'Retrieve all project dependencies'
+bozo_command :dependencies
+
+desc 'Prepare the project'
+bozo_command :prepare
+
+desc 'Compile the project'
+bozo_command :compile, :c
+
+desc 'Run the tests for the project'
+bozo_command :test, :t
+
+desc 'Create a package'
+bozo_command :package, :p do |c|
+  c.desc 'Force a pre-release package to be created'
+  c.switch 'pre-release'
+end
+
+desc 'Publish a package'
+bozo_command :publish do |c|
+  c.desc 'Force a pre-release package to be published'
+  c.switch 'pre-release'
+end
+
+desc 'Bump the version number'
+long_desc <<EOS
+  Specify either 'major', 'minor' or 'patch' as an argument. For example: `bozo bump major`
+EOS
+command :bump do |c|
+  c.action do |global_options, options, args|
+    if args.empty?
+      puts "Specify either 'major', 'minor' or 'patch' as an argument"
+    else
+      version_bumper = Bozo::Versioning::VersionBumper.new
+      version_bumper.bump args[0].to_sym
+    end
+  end
+end
+
+on_error do |exception|
+  puts exception.inspect.color(:red).bright
+
+  if exception.kind_of? Bozo::ExecutionError or exception.kind_of? Bozo::ConfigurationError
+    false
+  else
+    puts ''
+    puts exception.backtrace.join("\n").color(:red)
+    true
+  end
+end

data/test/bozo_configuration_version_tests.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class BozoConfigurationVersion < Test::Unit::TestCase
+
+  include FileUtils
+
+  def setup
+    @original_path = Dir.pwd
+    @temp_dir = File.expand_path File.join(@original_path, 'temp')
+    rm_rf @temp_dir if Dir.exist? @temp_dir
+    mkdir_p @temp_dir
+    Dir.chdir @temp_dir
+  end
+
+  def teardown
+    Dir.chdir @original_path
+    rm_rf @temp_dir
+  end
+
+  def test_loads_version
+    File.open("VERSION", 'w') { |f| f << '1.2.3' }
+
+    configuration = Bozo::BozoConfiguration.new
+    assert_equal configuration.version.to_s, '1.2.3'
+  end
+
+  def test_version_file_does_not_exist
+    # ensure the VERSION file doesn't exist
+    rm 'VERSION' if File.exist? 'VERSION'
+
+    configuration = Bozo::BozoConfiguration.new
+    assert_raise(Bozo::ConfigurationError) { configuration.version }
+  end
+
+  def test_no_version
+    touch 'VERSION'
+
+    configuration = Bozo::BozoConfiguration.new
+    assert_raise(Bozo::ConfigurationError) { configuration.version }
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/bozo'

data/test/version_bumper_tests.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class VersionBumperTests < Test::Unit::TestCase
+
+  include FileUtils
+
+  def setup
+    @original_path = Dir.pwd
+    @temp_dir = File.expand_path File.join(@original_path, 'temp')
+    rm_rf @temp_dir if Dir.exist? @temp_dir
+    mkdir_p @temp_dir
+    Dir.chdir @temp_dir
+  end
+
+  def teardown
+    Dir.chdir @original_path
+    rm_rf @temp_dir
+  end
+
+  def test_bumps_version_file
+    git_init_and_commit_initial
+    File.open("VERSION", 'w') { |f| f << '1.1.1' }
+
+    version_bumper = Bozo::Versioning::VersionBumper.new
+    version_bumper.bump :major
+
+    assert_equal File.read('VERSION').strip, '2.0.0'
+  end
+
+  def test_bump_commits_file
+    git_init_and_commit_initial
+    File.open("VERSION", 'w') { |f| f << '1.1.1' }
+
+    version_bumper = Bozo::Versioning::VersionBumper.new
+    version_bumper.bump :major
+
+    assert_true `git log -1 --oneline`.include?('Bumped 1.1.1 to 2.0.0')
+  end
+
+  def test_git_staging_pending_stops_bump
+    git_init_and_commit_initial
+
+    touch 'tempfile2'
+    `git add tempfile2` # add file to staging to block bump
+
+    File.open("VERSION", 'w') { |f| f << '1.1.1' }
+
+    version_bumper = Bozo::Versioning::VersionBumper.new
+
+    assert_raise(Bozo::Versioning::VersionBumpError) { version_bumper.bump :major }
+  end
+
+  private
+
+  def git_init_and_commit_initial
+    touch 'tempfile'
+    `git init`
+    `git add tempfile`
+    `git commit -m "initial commit"`
+  end
+
+end

data/test/version_tests.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class VersionTests < Test::Unit::TestCase
+
+  def test_bumps_major
+    version = Bozo::Versioning::Version.parse '1.1.1'
+    version.bump :major
+
+    assert_equal version.to_s, '2.0.0'
+  end
+
+  def test_bumps_minor
+    version = Bozo::Versioning::Version.parse '1.1.1'
+    version.bump :minor
+
+    assert_equal version.to_s, '1.2.0'
+  end
+
+  def test_bumps_patch
+    version = Bozo::Versioning::Version.parse '1.1.1'
+    version.bump :patch
+
+    assert_equal version.to_s, '1.1.2'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bozo
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Garry Shutler
@@ -62,6 +62,24 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/bozo/bozo.rb
+- lib/bozo/bozo_configuration.rb
+- lib/bozo/class_name_helpers.rb
+- lib/bozo/configuration_error.rb
+- lib/bozo/execution_error.rb
+- lib/bozo/executor.rb
+- lib/bozo/logging.rb
+- lib/bozo/runner.rb
+- lib/bozo/versioning/version.rb
+- lib/bozo/versioning/version_bumper.rb
+- lib/bozo/versioning/version_bump_error.rb
+- lib/bozo.rb
+- README.md
+- VERSION
+- test/bozo_configuration_version_tests.rb
+- test/test_helper.rb
+- test/version_bumper_tests.rb
+- test/version_tests.rb
 - bin/bozo
 homepage: https://github.com/zopaUK/bozo
 licenses: []
@@ -86,4 +104,8 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Zopa build system
-test_files: []
+test_files:
+- test/bozo_configuration_version_tests.rb
+- test/test_helper.rb
+- test/version_bumper_tests.rb
+- test/version_tests.rb