sleeping_king_studios-tasks 0.1.0.rc.0

data/lib/sleeping_king_studios/tasks/process_runner.rb

@@ -0,0 +1,70 @@
+# lib/sleeping_king_studios/tasks/process_runner.rb
+
+require 'sleeping_king_studios/tasks'
+
+module SleepingKingStudios::Tasks
+  # Base class for helpers that execute a system process.
+  class ProcessRunner
+    # @param env [Hash] Environment variables to set for the RSpec process.
+    # @param options [Array] Options to pass to RSpec.
+    def initialize env: {}, options: []
+      @default_env     = env.dup
+      @default_options = options
+
+      return unless ENV['BUNDLE_GEMFILE']
+
+      @default_env[:bundle_gemfile] ||= ENV['BUNDLE_GEMFILE']
+    end # constructor
+
+    # @return [Hash] Environment variables to set for the RSpec process.
+    attr_reader :default_env
+
+    # @return [Array] Options to pass to RSpec.
+    attr_reader :default_options
+
+    private
+
+    def base_command
+      ':'
+    end # method base_command
+
+    def build_command **kwargs
+      env  = build_environment(kwargs)
+      opts = build_options(kwargs)
+
+      "#{env} #{base_command} #{opts}".strip
+    end # method build_command
+
+    def build_environment env:, **_kwargs
+      default_env.
+        merge(env).
+        map do |key, value|
+          key   = tools.string.underscore(key).upcase
+          value = %("#{value}") if value.is_a?(String)
+
+          "#{key}=#{value}"
+        end. # map
+        join ' '
+    end # method build_environment
+
+    def build_options files: [], options: [], **_kwargs
+      (Array(files) + default_options + options).join ' '
+    end # method build_options
+
+    def stream_process command
+      Bundler.with_clean_env do
+        IO.popen(command) do |io|
+          loop do
+            char = io.getc
+
+            char ? print(char) : break
+          end # loop
+        end # popen
+      end # with_clean_env
+    end # method stream_process
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.new
+    end # method tools
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/task.rb

@@ -0,0 +1,95 @@
+# lib/sleeping_king_studios/tasks/task.rb
+
+require 'thor'
+
+require 'sleeping_king_studios/tasks'
+
+module SleepingKingStudios::Tasks
+  # Encapsulates a Thor task as a class object.
+  class Task
+    include ::Thor::Shell
+
+    module ClassMethods # rubocop:disable Style/Documentation
+      # @return [String] The description of the task.
+      def description
+        'A non-descript task if ever there was one.'
+      end # method description
+
+      # Defines a permitted option for the task.
+      #
+      # @param option_name [String, Symbol] The name of the option.
+      # @param option_params [Hash] Additional params for the option.
+      #
+      # @see https://github.com/erikhuda/thor/wiki/Method-Options
+      def option option_name, option_params
+        options[option_name] = option_params
+
+        define_helpers option_name, option_params
+      end # method option
+
+      # @return [Hash] The permitted options for the task.
+      def options
+        @options ||= {}
+      end # method options
+
+      # @return [String] The name of the task.
+      def task_name
+        tools = SleepingKingStudios::Tools::Toolbelt.instance
+
+        tools.string.underscore(name.split('::').last).sub(/_task$/, '')
+      end # method task_name
+
+      private
+
+      def define_helpers option_name, option_params
+        tools = SleepingKingStudios::Tools::Toolbelt.instance
+        name  = tools.string.underscore option_name
+
+        define_method(name) { options[option_name.to_s] }
+
+        return unless option_params[:type] == :boolean
+
+        default = option_params.fetch(:default, false)
+        define_method(:"#{name}?") { options.fetch(option_name.to_s, default) }
+      end # method define_helpers
+    end # module
+    extend ClassMethods
+
+    # @param options [Hash] The command-line options passed in via Thor.
+    def initialize options
+      @options = options
+    end # constructor
+
+    # @return [Hash] The command-line options passed in via Thor.
+    attr_reader :options
+
+    # Performs the task with the given arguments. Overriden by subclasses.
+    def call *_args; end
+
+    # Mutes the task.
+    def mute!
+      @mute = true
+    end # method mute!
+
+    # @return [Boolean] True if the task has been muted, otherwise false.
+    def mute?
+      !!@mute
+    end # method mute?
+    alias_method :muted?, :mute?
+
+    # Prints the given message unless the task has been muted.
+    #
+    # @see Thor::Shell#say.
+    def say *args
+      return if mute?
+
+      super
+    end # method say
+
+    private
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end # method tools
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/task_group.rb

@@ -0,0 +1,37 @@
+# lib/sleeping_king_studios/tasks/task_group.rb
+
+require 'thor'
+
+require 'sleeping_king_studios/tasks'
+
+module SleepingKingStudios::Tasks
+  # Exposes a group of encapsulated tasks with a shared namespace to Thor.
+  class TaskGroup < ::Thor
+    module ClassMethods # rubocop:disable Style/Documentation
+      # Adds a task definition to the task group. The task name, description,
+      # and method options (if any) are resolved from the task class, and a
+      # wrapper method is defined for calling the task.
+      def task definition, options = {}
+        task_name = options.fetch(:as, definition.task_name)
+
+        desc(task_name, definition.description)
+
+        definition.options.each do |option_name, option_params|
+          method_option option_name, option_params
+        end # each
+
+        define_method(task_name) do |*args|
+          definition.new(self.options).call(*args)
+        end # define_method
+      end # class method task
+
+      # @return [Boolean] True.
+      def exit_on_failure?
+        # :nocov:
+        true
+        # :nocov:
+      end # class method exit_on_failure?
+    end # module
+    extend ClassMethods
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/version.rb

@@ -0,0 +1,58 @@
+# lib/sleeping_king_studios/tasks/version.rb
+
+module SleepingKingStudios
+  module Tasks
+    # @api private
+    #
+    # The current version of the gem.
+    #
+    # @see http://semver.org/
+    module Version
+      # Major version.
+      MAJOR = 0
+      # Minor version.
+      MINOR = 1
+      # Patch version.
+      PATCH = 0
+      # Prerelease version.
+      PRERELEASE = :rc
+      # Build metadata.
+      BUILD = 0
+
+      class << self
+        # Generates the gem version string from the Version constants.
+        #
+        # Inlined here because dependencies may not be loaded when processing a
+        # gemspec, which results in the user being unable to install the gem for
+        # the first time.
+        #
+        # @see SleepingKingStudios::Tools::SemanticVersion#to_gem_version
+        def to_gem_version
+          str = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+          prerelease = value_of(:PRERELEASE)
+          str << ".#{prerelease}" if prerelease
+
+          build = value_of(:BUILD)
+          str << ".#{build}" if build
+
+          str
+        end # class method to_version
+
+        private
+
+        def value_of constant
+          return nil unless const_defined?(constant)
+
+          value = const_get(constant)
+
+          return nil if value.respond_to?(:empty?) && value.empty?
+
+          value
+        end # method value_of
+      end # eigenclass
+    end # module
+
+    VERSION = Version.to_gem_version
+  end # module
+end # module

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification
+name: sleeping_king_studios-tasks
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc.0
+platform: ruby
+authors:
+- Rob "Merlin" Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: sleeping_king_studios-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-sleeping_king_studios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Toolkit providing an encapsulation layer around the Thor CLI library,
+  with predefined tasks for development and continuous integration.
+email:
+- merlin@sleepingkingstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DEVELOPMENT.md
+- LICENSE
+- README.md
+- lib/sleeping_king_studios/tasks.rb
+- lib/sleeping_king_studios/tasks/apps.rb
+- lib/sleeping_king_studios/tasks/apps/app_configuration.rb
+- lib/sleeping_king_studios/tasks/apps/applications_task.rb
+- lib/sleeping_king_studios/tasks/apps/bundle.rb
+- lib/sleeping_king_studios/tasks/apps/bundle/install_runner.rb
+- lib/sleeping_king_studios/tasks/apps/bundle/install_task.rb
+- lib/sleeping_king_studios/tasks/apps/bundle/update_runner.rb
+- lib/sleeping_king_studios/tasks/apps/bundle/update_task.rb
+- lib/sleeping_king_studios/tasks/apps/ci.rb
+- lib/sleeping_king_studios/tasks/apps/ci/results_reporter.rb
+- lib/sleeping_king_studios/tasks/apps/ci/rspec_task.rb
+- lib/sleeping_king_studios/tasks/apps/ci/rspec_wrapper.rb
+- lib/sleeping_king_studios/tasks/apps/ci/rubocop_task.rb
+- lib/sleeping_king_studios/tasks/apps/ci/rubocop_wrapper.rb
+- lib/sleeping_king_studios/tasks/apps/ci/simplecov_task.rb
+- lib/sleeping_king_studios/tasks/apps/ci/step_wrapper.rb
+- lib/sleeping_king_studios/tasks/apps/ci/steps_runner.rb
+- lib/sleeping_king_studios/tasks/apps/ci/steps_task.rb
+- lib/sleeping_king_studios/tasks/ci.rb
+- lib/sleeping_king_studios/tasks/ci/cucumber_parser.rb
+- lib/sleeping_king_studios/tasks/ci/cucumber_results.rb
+- lib/sleeping_king_studios/tasks/ci/cucumber_runner.rb
+- lib/sleeping_king_studios/tasks/ci/cucumber_task.rb
+- lib/sleeping_king_studios/tasks/ci/results_helpers.rb
+- lib/sleeping_king_studios/tasks/ci/rspec_each_results.rb
+- lib/sleeping_king_studios/tasks/ci/rspec_each_task.rb
+- lib/sleeping_king_studios/tasks/ci/rspec_results.rb
+- lib/sleeping_king_studios/tasks/ci/rspec_runner.rb
+- lib/sleeping_king_studios/tasks/ci/rspec_task.rb
+- lib/sleeping_king_studios/tasks/ci/rubocop_results.rb
+- lib/sleeping_king_studios/tasks/ci/rubocop_runner.rb
+- lib/sleeping_king_studios/tasks/ci/rubocop_task.rb
+- lib/sleeping_king_studios/tasks/ci/simplecov_results.rb
+- lib/sleeping_king_studios/tasks/ci/simplecov_task.rb
+- lib/sleeping_king_studios/tasks/ci/steps_runner.rb
+- lib/sleeping_king_studios/tasks/ci/steps_task.rb
+- lib/sleeping_king_studios/tasks/configuration.rb
+- lib/sleeping_king_studios/tasks/file.rb
+- lib/sleeping_king_studios/tasks/file/new_task.rb
+- lib/sleeping_king_studios/tasks/process_runner.rb
+- lib/sleeping_king_studios/tasks/task.rb
+- lib/sleeping_king_studios/tasks/task_group.rb
+- lib/sleeping_king_studios/tasks/version.rb
+homepage: http://sleepingkingstudios.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A tasks toolkit for rapid development.
+test_files: []