rake_factory 0.0.1

data/go

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+[ -n "$GO_DEBUG" ] && set -x
+set -e
+
+project_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+verbose="no"
+skip_checks="no"
+offline="no"
+
+missing_dependency="no"
+
+[ -n "$GO_DEBUG" ] && verbose="yes"
+[ -n "$GO_SKIP_CHECKS" ] && skip_checks="yes"
+[ -n "$GO_OFFLINE" ] && offline="yes"
+
+
+if [[ "$skip_checks" = "no" ]]; then
+    echo "Checking for system dependencies."
+    ruby_version="$(cat "$project_dir"/.ruby-version)"
+    if ! type ruby >/dev/null 2>&1 || ! ruby -v | grep -q "$ruby_version"; then
+        echo "This codebase requires Ruby $ruby_version."
+        missing_dependency="yes"
+    fi
+
+    if [[ "$missing_dependency" = "yes" ]]; then
+        echo "Please install missing dependencies to continue."
+        exit 1
+    fi
+
+    echo "All system dependencies present. Continuing."
+fi
+
+if [[ "$offline" = "no" ]]; then
+    echo "Installing bundler."
+    if [[ "$verbose" = "yes" ]]; then
+        gem install --no-document bundler
+    else
+        gem install --no-document bundler > /dev/null
+    fi
+
+    echo "Installing ruby dependencies."
+    if [[ "$verbose" = "yes" ]]; then
+        bundle install
+    else
+        bundle install > /dev/null
+    fi
+fi
+
+echo "Starting rake."
+if [[ "$verbose" = "yes" ]]; then
+    time bundle exec rake --verbose "$@"
+else
+    time bundle exec rake "$@"
+fi

data/lib/rake_factory/actions.rb

@@ -0,0 +1,11 @@
+module RakeFactory
+  module Actions
+    def actions
+      @actions ||= []
+    end
+
+    def action(&action_block)
+      actions << action_block
+    end
+  end
+end

data/lib/rake_factory/defaults.rb

@@ -0,0 +1,56 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require_relative 'parameters'
+
+module RakeFactory
+  module Defaults
+    include Parameters
+
+    def inherited(inheritor)
+      super(inheritor)
+      inheritor.class_eval do
+        parameter(:name,
+            configurable: false,
+            transform: lambda { |n| n.to_sym })
+        parameter(:argument_names,
+            configurable: false,
+            default: [])
+        parameter(:prerequisites,
+            configurable: false,
+            default: [])
+        parameter(:order_only_prerequisites,
+            configurable: false,
+            default: [])
+        parameter(:description,
+            configurable: false)
+
+        unless inheritor.name.nil?
+          default_name inheritor.name.demodulize.underscore
+        end
+      end
+    end
+
+    def default_name(name)
+      parameter_set.update_default_for(:name, name)
+    end
+
+    def default_argument_names(argument_names)
+      parameter_set.update_default_for(:argument_names, argument_names)
+    end
+
+    def default_prerequisites(prerequisites)
+      parameter_set.update_default_for(:prerequisites, prerequisites)
+    end
+
+    def default_order_only_prerequisites(order_only_prerequisites)
+      parameter_set
+          .update_default_for(
+              :order_only_prerequisites, order_only_prerequisites)
+    end
+
+    def default_description(description)
+      parameter_set.update_default_for(:description, description)
+    end
+  end
+end

data/lib/rake_factory/exceptions.rb

@@ -0,0 +1,4 @@
+module RakeFactory
+  class RequiredParameterUnset < ::StandardError
+  end
+end

data/lib/rake_factory/parameter.rb

@@ -0,0 +1,61 @@
+module RakeFactory
+  class Parameter
+    attr_reader(
+        :name,
+        :default,
+        :required,
+        :configurable,
+        :transform)
+    attr_writer(:default)
+
+    def initialize(name, options)
+      @name = name
+      @default = options[:default] || nil
+      @required = options[:required] || false
+      @configurable =
+          options[:configurable].nil? ? true : !!options[:configurable]
+      @transform = options[:transform] || lambda { |x| x }
+    end
+
+    def writer_method
+      "#{name}="
+    end
+
+    def reader_method
+      name
+    end
+
+    def instance_variable
+      "@#{name}"
+    end
+
+    def define_on(klass)
+      parameter = self
+      klass.class_eval do
+        attr_reader parameter.reader_method
+        define_method parameter.writer_method do |value|
+          instance_variable_set(
+              parameter.instance_variable,
+              parameter.transform.call(value))
+        end
+      end
+    end
+
+    def apply_default_to(instance)
+      instance.send(writer_method, @default) unless @default.nil?
+    end
+
+    def configurable?
+      @configurable
+    end
+
+    def dissatisfied_by?(instance)
+      value = instance.send(reader_method)
+      @required && value.nil?
+    end
+
+    def satisfied_by?(instance)
+      !dissatisfied_by?(instance)
+    end
+  end
+end

data/lib/rake_factory/parameter_set.rb

@@ -0,0 +1,48 @@
+require_relative 'parameter'
+require_relative 'exceptions'
+
+module RakeFactory
+  class ParameterSet
+    def initialize
+      @parameter_set = {}
+    end
+
+    def add(name, options)
+      parameter = Parameter.new(name, options)
+      @parameter_set[parameter.name] = parameter
+      parameter
+    end
+
+    def find(name)
+      @parameter_set[name.to_sym]
+    end
+
+    def each(&block)
+      @parameter_set.values.each(&block)
+    end
+
+    def update_default_for(name, value)
+      find(name).default = value
+    end
+
+    def apply_defaults_to(instance)
+      @parameter_set.values.each do |parameter|
+        parameter.apply_default_to(instance)
+      end
+    end
+
+    def enforce_requirements_on(instance)
+      dissatisfied = @parameter_set.values.reject do |parameter|
+        parameter.satisfied_by?(instance)
+      end
+      unless dissatisfied.empty?
+        names = dissatisfied.map(&:name)
+        names_string = names.join(',')
+        pluralisation_string = names.length > 1 ? 's' : ''
+
+        raise RequiredParameterUnset,
+            "Required parameter#{pluralisation_string} #{names_string} unset."
+      end
+    end
+  end
+end

data/lib/rake_factory/parameter_view.rb

@@ -0,0 +1,21 @@
+module RakeFactory
+  class ParameterView
+    attr_reader(:task)
+
+    def initialize(task)
+      self.instance_eval do
+        task.class.parameter_set.each do |parameter|
+          define_singleton_method parameter.reader_method do
+            task.send(parameter.reader_method)
+          end
+
+          if parameter.configurable?
+            define_singleton_method parameter.writer_method do |value|
+              task.send(parameter.writer_method, value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rake_factory/parameters.rb

@@ -0,0 +1,14 @@
+require_relative 'parameter_set'
+
+module RakeFactory
+  module Parameters
+    def parameter_set
+      @parameter_set ||= ParameterSet.new
+    end
+
+    def parameter(name, options = {})
+      parameter = parameter_set.add(name, options)
+      parameter.define_on(self)
+    end
+  end
+end

data/lib/rake_factory/task.rb

@@ -0,0 +1,85 @@
+require 'rake/tasklib'
+
+require_relative 'parameters'
+require_relative 'parameter_view'
+require_relative 'actions'
+require_relative 'defaults'
+
+module RakeFactory
+  class Task < ::Rake::TaskLib
+    extend Parameters
+    extend Actions
+    extend Defaults
+
+    attr_accessor(:configuration_block)
+
+    def self.inherited(inheritor)
+      super(inheritor)
+      inheritor.singleton_class.class_eval do
+        define_method :define do |*args, &block|
+          inheritor.new(*args, &block).define_on(Rake.application)
+        end
+      end
+    end
+
+    def initialize(*args, &configuration_block)
+      setup_parameter_defaults
+      process_arguments(args)
+      process_configuration_block(configuration_block)
+    end
+
+    def setup_parameter_defaults
+      self.class.parameter_set.apply_defaults_to(self)
+    end
+
+    def process_arguments(args)
+      opts = args.first || {}
+      opts.each { |key, value| set_if_value_present(key, value) }
+    end
+
+    def process_configuration_block(configuration_block)
+      set_if_value_present(:configuration_block, configuration_block)
+    end
+
+    def invoke_configuration_block(args)
+      if configuration_block
+        view = ParameterView.new(self)
+        configuration_block.call(
+            *[view, args].slice(0, configuration_block.arity))
+      end
+    end
+
+    def check_parameter_requirements
+      self.class.parameter_set.enforce_requirements_on(self)
+    end
+
+    def invoke_actions(args)
+      self.class.actions.each do |action|
+        action.call(*[self, args].slice(0, action.arity))
+      end
+    end
+
+    def define_on(application)
+      task = application.define_task(
+          Rake::Task,
+          name,
+          argument_names => prerequisites,
+          order_only: order_only_prerequisites
+      ) do |_, args|
+        invoke_configuration_block(args)
+        check_parameter_requirements
+        invoke_actions(args)
+      end
+      task.add_description(description)
+      self
+    end
+
+    private
+
+    def set_if_value_present(key, value)
+      if self.respond_to?("#{key}=") && !value.nil?
+        self.send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/rake_factory/version.rb

@@ -0,0 +1,3 @@
+module RakeFactory
+  VERSION = '0.0.1'
+end

data/lib/rake_factory.rb

@@ -0,0 +1,5 @@
+require 'rake_factory/version'
+require 'rake_factory/task'
+
+module RakeFactory
+end

data/rake_factory.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake_factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rake_factory'
+  spec.version = RakeFactory::VERSION
+  spec.authors = ['Toby Clemson']
+  spec.email = ['tobyclemson@gmail.com']
+
+  spec.summary =
+      'Base classes and modules to aid in creating custom rake tasks.'
+  spec.description =
+      'Provides base classes and modules to allow declarative definition of ' +
+          'rake tasks.'
+  spec.homepage = 'https://github.com/infrablocks/rake_factory'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.5.1'
+
+  spec.add_dependency 'rake', '~> 13.0'
+  spec.add_dependency 'activesupport', '~> 5.2'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'gem-release', '~> 2.0'
+  spec.add_development_dependency 'fakefs', '~> 0.18'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/scripts/ci/common/configure-git.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+git config --global user.email "circleci@infrablocks.io"
+git config --global user.name "Circle CI"

data/scripts/ci/common/configure-rubygems.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PROJECT_DIR="$( cd "$SCRIPT_DIR/../../.." && pwd )"
+
+cd "$PROJECT_DIR"
+
+git crypt unlock
+
+mkdir -p ~/.gem
+cp config/secrets/rubygems/credentials ~/.gem/credentials
+chmod 0600 ~/.gem/credentials

data/scripts/ci/common/install-git-crypt.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+apt-get update
+apt-get install -y --no-install-recommends git ssh git-crypt

data/scripts/ci/common/install-gpg-key.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PROJECT_DIR="$( cd "$SCRIPT_DIR/../../.." && pwd )"
+
+cd "$PROJECT_DIR"
+
+set +e
+openssl version
+openssl aes-256-cbc \
+    -d \
+    -md sha1 \
+    -in ./.circleci/gpg.private.enc \
+    -k "${ENCRYPTION_PASSPHRASE}" | gpg --import -
+set -e

data/scripts/ci/steps/prerelease.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PROJECT_DIR="$( cd "$SCRIPT_DIR/../../.." && pwd )"
+
+cd "$PROJECT_DIR"
+
+./go version:bump[pre]
+./go release
+
+git status
+git push

data/scripts/ci/steps/release.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PROJECT_DIR="$( cd "$SCRIPT_DIR/../../.." && pwd )"
+
+cd "$PROJECT_DIR"
+
+git pull
+
+./go version:bump[minor]
+./go release
+
+git status
+git push

data/scripts/ci/steps/test.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+[ -n "$DEBUG" ] && set -x
+set -e
+set -o pipefail
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PROJECT_DIR="$( cd "$SCRIPT_DIR/../../.." && pwd )"
+
+cd "$PROJECT_DIR"
+
+./go spec