flo 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b84be555cacd1fd27392d83cd39e89c19e9dafd4
+  data.tar.gz: 9cd073f4e4c9ab0da1ea2b816b2cb1e90a579441
+SHA512:
+  metadata.gz: 43b7d50133307857e6a656d5ef99b0c9b8c0e99030541b7c890086d3903e4ca6b4387ea624d060e17d02384b6d6b1e9c0dbad5c22d44809b4f324b920881fd43
+  data.tar.gz: e8ad9ceec8b76344fa641774919a41d38298f2c50d122668e64935175a0c4e61b657a95233746ee8c36cb8f491cd07919a5ec1fc7536f434981396a43664f31b

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg
+tmp
+.yardoc/
+coverage
+doc

data/Gemfile

@@ -0,0 +1,9 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2017, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,105 @@
+# Flo
+[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate) [![Build Status](https://semaphoreci.com/api/v1/justinpowers/flo/branches/master/shields_badge.svg)](https://semaphoreci.com/justinpowers/flo)
+
+
+Flo is a local workflow automation tool that helps you get things done.  This gem contains the core functionality for Flo, plugins for interacting with various systems can be found in separate provider gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```shell
+gem 'flo'
+```
+And then execute:
+
+```shell
+$ bundle
+```
+Or install it yourself as:
+
+```shell
+$ gem install flo
+```
+
+## Documentation
+https://www.rubydoc.info/github/salesforce/flo/
+
+## Usage
+
+### Command line usage
+
+COMING SOON!
+A command line parser has not yet been added.  If you require a script that can be invoked from the command line, you can create a ruby script that creates and runs a `Flo::Runner` instance.  See [Ruby script usage](#Ruby_script_usage) for more details.
+
+### Ruby script usage
+
+Flo has been built with the intention of being easy to use within ruby scripts.  `Flo::Runner` is responsible for parsing your custom configuration and invoking the commands.  See the following example:
+
+```ruby
+require 'flo'
+
+runner = Flo::Runner.new
+
+# Load your custom command configurations (see .flo file section for more details)
+runner.load_config_file(File.join(__dir__,'.flo'))
+
+# Run the something:useful command defined in the .flo file
+response = runner.execute([:something, :useful], id: '123')
+```
+
+
+## .flo configuration file
+
+Flo makes very few assumptions about what you want to use it for, or how you want to use it.  In order for you to use it for anything useful, you will need to provide it some configuration.  This is accomplished by loading one or more .flo configuration files.  See [Ruby script usage](#Ruby_script_usage) for an example of how to load the file.  The .flo file is evaluated in ruby in a cleanroom environment (see the [cleanroom gem](https://github.com/sethvargo/cleanroom) for more information), so you can require any gems or modules needed to accomplish the functionality you are looking for.  There are two required sections:
+* configuration
+* command registration
+
+### Configuration
+
+Before you can do anything useful in your .flo file, you have to declare providers.  You can do so using a config block, for example:
+
+```ruby
+config do |cfg|
+  cfg.provider :developer, {configuration_option: 'value' }
+end
+```
+
+### Command registration
+
+You can register any number of commands.  Commands are namespaced to make it easier to group together similar commands.  Within a command declaration you declare a set of tasks that will be executed in order when the command is invoked.  Here is an overly simple example for starting a feature branch that only uses a single provider.  In typical usage you would likely utilize multiple providers within a single command.
+
+```ruby
+# Registers a command for starting a feature - feature:start.  This command has
+# one required argument: 'feature_name'.  Note that in order for this to work,
+# you will need to declare the git_flo provider in the config section.
+register_command([:feature, :start]) do |feature_name: nil|
+
+  # During command execution, perform the :check_out_or_create_branch method on
+  # the git_flo provider, passing in the :from and :name arguments
+  perform :git_flo, :check_out_or_create_branch, { from: 'master', name: feature_name }
+end
+```
+
+## Contributing
+
+1. Fork it (http://github.com/your-github-username/flo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+>Copyright (c) 2017, Salesforce.com, Inc.
+>All rights reserved.
+>
+>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+>
+>* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+>
+>* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+>
+>* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+>
+>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,13 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/flo.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flo"
+  spec.version       = Flo::VERSION
+  spec.authors       = ["Justin Powers"]
+  spec.email         = ["justinspowers@gmail.com"]
+  spec.summary       = %q{Simple developer workflow automation}
+  spec.description   = %q{Flo is a local workflow automation tool that helps you get things done.  This gem contains the core functionality for Flo, plugins for interacting with various systems can be found in separate provider gems.}
+  spec.homepage      = "https://github.com/salesforce/flo"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cleanroom"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+end

data/lib/flo/command.rb

@@ -0,0 +1,115 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'cleanroom'
+
+module Flo
+
+  # Definition of a single command.  In general you should not call {#initialize Command.new}
+  # directly, but instead define the command using {Runner#register_command}.
+  #
+  # When a command is generated using {Runner#register_command} (typically in a
+  # flo configuration file), only the DSL methods will be available
+  #
+  class Command
+
+    include Cleanroom
+
+    # Creates a new command instance
+    # @option  opts [Hash] providers ({}) Providers that the command will need
+    #   access to
+    #
+    # @yield [args*]The block containing the definition for the command.
+    #   Arguments passed into {#call} are available within the block
+    #
+    def initialize(opts={}, &blk)
+      raise ArgumentError.new('.new must be called with a block defining the command') unless blk
+      @state_class = opts[:state_class] || Flo::State
+      @task_class = opts[:task_class] || Flo::Task
+      @providers = opts[:providers] || {}
+      @tasks = []
+      @definition_lambda = convert_block_to_lambda(blk)
+    end
+
+    # @api dsl
+    # DSL method: Define a task that will be performed during the execution stage when
+    # {#call} is invoked.
+    # @param provider_sym [Symbol] The provider to send the message to
+    # @param method_sym [Symbol] The method you wish to call on the provider
+    # @param provider_options [Hash] A hash of options to be passed when
+    #   invoking the method on the provider.  Any lambda values will be called
+    #   during the execution stage when #{#call} is invoked
+    #
+    def perform(provider_sym, method_sym, provider_options={})
+      tasks << @task_class.new(providers[provider_sym], method_sym, provider_options)
+    end
+    expose :perform
+
+    alias :validate :perform
+    expose :validate
+
+    # @api dsl
+    # DSL method: Returns an object representing the current state of the provider during
+    # the execution stage when {#call} is invoked.  Any methods called on the
+    # {State} instance will return a lambda.  This is intended to be used in the
+    # parameters passed to the {#perform} method, as you often want these
+    # parameters lazily evaluated during the execution stage, not when the
+    # definition is parsed.
+    # @param provider_sym [Symbol] The provider that you wish to query
+    #
+    # @return [State] An object that will return a lambda, delegating the method
+    #   call to the provider specified
+    #
+    def state(provider_sym)
+      state_class.new(providers[provider_sym])
+    end
+    expose :state
+
+    # Invoke the command that has already been defined.
+    #
+    # This will run the command, processing any tasks defined by {#perform} and
+    # {#validate} in order, stopping execution if any of the tasks fails.
+    # Arguments passed in here will be merged with the provider options defined
+    # in each task.
+    # @param args [Hash] arguments to be passed to each task
+    #
+    def call(args={})
+      evaluate_command_definition(args)
+      response = tasks.map do |task|
+
+        response = task.call(args)
+
+        # bail early if the task failed
+        return response unless response.success?
+        response
+      end.last
+    end
+
+    private
+
+    attr_reader :tasks, :definition_lambda, :providers, :state_class
+
+    def evaluate_command_definition(*args)
+      cleanroom.instance_exec(*args, &definition_lambda)
+    end
+
+    def convert_block_to_lambda(blk)
+      # jruby and rubinius can convert a proc directly into a lambda
+      if (converted_block = lambda(&blk)).lambda?
+        converted_block
+      else
+        # Otherwise, hacky method to take advantage of #define_method's automatic lambda conversion
+        cleanroom.define_singleton_method(:_command_definition, &blk)
+        cleanroom.method(:_command_definition).to_proc
+      end
+    end
+
+    def cleanroom
+      @cleanroom ||= self.class.send(:cleanroom).new(self)
+    end
+
+
+  end
+end

data/lib/flo/command_collection.rb

@@ -0,0 +1,24 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module Flo
+  CommandNotDefinedError = Class.new(StandardError)
+  class CommandCollection
+
+    def initialize
+      @commands = {}
+    end
+
+    def [](*key)
+      raise CommandNotDefinedError.new("#{key} command is not defined") unless @commands.has_key?(key)
+      @commands[key]
+    end
+
+    def []=(*key, command)
+      @commands[key] = command
+    end
+
+  end
+end

data/lib/flo/config.rb

@@ -0,0 +1,45 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module Flo
+  MissingRequireError = Class.new(StandardError)
+
+  # Instantiates and stores providers for use in command definitions
+  #
+  # @attr_reader providers [Hash] Hash of provider instances
+  #
+  class Config
+    attr_reader :providers
+
+    def initialize
+      @providers = {}
+    end
+
+    # Instantiate a provider and add it to the {#providers} collection
+    # @param provider_sym [Symbol]
+    # @param options [Hash] Options to be passed to provider initialization
+    # @yield Yields the block to the provider initializer, in case the provider
+    # accepts a block
+    #
+    def provider(provider_sym, options={}, &blk)
+      @providers[provider_sym] = provider_class(provider_sym).new(options, &blk)
+    end
+
+    private
+
+    def provider_class(provider_sym)
+      klass = camel_case(provider_sym.to_s)
+      klass_name = "Flo::Provider::#{klass}"
+      Object.const_get(klass_name)
+    rescue NameError => e
+      raise MissingRequireError.new("#{klass_name} is not loaded.  Please require the library before use")
+    end
+
+    def camel_case(str)
+      return str if str !~ /_/ && str =~ /[A-Z]+.*/
+      str.split('_').map{|e| e.capitalize}.join
+    end
+  end
+end

data/lib/flo/provider/developer.rb

@@ -0,0 +1,32 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'ostruct'
+
+module Flo
+  module Provider
+    Response = Struct.new(:success?)
+    class Developer
+
+      def initialize(options={})
+
+      end
+
+      def is_successful(opts={})
+        success = opts[:success].nil? ? true : opts[:success]
+        Flo::Provider::Response.new(success)
+      end
+
+      def return_true
+        true
+      end
+
+      def echo(opts={})
+        puts opts.inspect
+        Flo::Provider::Response.new(true)
+      end
+    end
+  end
+end

data/lib/flo/runner.rb

@@ -0,0 +1,94 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'flo'
+require 'flo/command'
+require 'flo/command_collection'
+require 'flo/state'
+require 'flo/config'
+require 'flo/task'
+require 'cleanroom'
+
+module Flo
+
+  # This is the main class for instantiating and performing Flo commands.  If
+  # you are wanting to interact with Flo via a ruby script, this is the class
+  # you want.  Utilizing Flo through the command line interface will invoke this
+  # class after all of the argument parsing is complete.
+  #
+  # @example
+  #     runner = Runner.new
+  #     runner.load_config_file('path/to/config/file')
+  #     runner.execute([:issue, :submit], id: '1234', submitter: 'John Doe')
+  #
+  # @attr_reader commands [CommandCollection] List of commands currently defined
+  #
+  class Runner
+    include Cleanroom
+
+    attr_reader :commands
+
+    # Creates a new runner.  This object is generally useless until you load
+    # some configuration into it, typically using {#load_config_file}
+    #
+    def initialize(opts={})
+      @config = opts[:config] || Flo::Config.new
+      @command_class = opts[:command_class] || Flo::Command
+      @commands = opts[:command_collection] || Flo::CommandCollection.new
+    end
+
+    # Open and parse a file containing flo configuration.  This file is
+    # evaluated within a cleanroom.  See the {https://github.com/sethvargo/cleanroom cleanroom gem}
+    # for more information.
+    # @param config_file [String] path to the flo configuration file
+    #
+    def load_config_file(config_file)
+      evaluate_file(config_file)
+    end
+
+    # Executes the command specified, with the arguments specified
+    # @param command_namespace [Array<Symbol>] An array containing the name of
+    #   the command as a symbol, including the namespace.  For example, the
+    #   command "issue submit" would become [:issue, :submit]
+    # @param args={} [Hash] Options that will get passed to the command
+    #
+    def execute(command_namespace, args={})
+      commands[command_namespace].call(args)
+    end
+
+    # @api dsl
+    # DSL method: Returns the instance of {Config} associated with this runner.  Exposes the
+    # {Config} instance if a block is used
+    #
+    # @yield [Config]
+    #
+    # @return [Config]
+    #
+    def config
+      yield(@config) if block_given?
+      @config
+    end
+    expose :config
+
+    # @api dsl
+    # DSL method: Creates and defines a {Command}, adding it to the command collection.
+    # Definition for the command should happen inside of the required block.
+    # See {Command} for methods available within the block.
+    # @param command_namespace [Array<Symbol>] Array of symbols representing the
+    #   command including the namespace
+    # @yield [args*]The block containing the definition for the command.
+    #   Arguments passed into {#execute} are available within the block
+    #
+    def register_command(command_namespace, &blk)
+      commands[command_namespace] = command_class.new(providers: config.providers, &blk)
+    end
+    expose :register_command
+
+    private
+
+    attr_reader :command_class
+
+  end
+end

data/lib/flo/state.rb

@@ -0,0 +1,23 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module Flo
+  class State
+
+    def initialize(provider)
+      @provider = provider
+    end
+
+    def method_missing(meth_sym, *args)
+      lambda do
+        provider.method(meth_sym).call(*args)
+      end
+    end
+
+    private
+
+    attr_reader :provider
+  end
+end

data/lib/flo/task.rb

@@ -0,0 +1,53 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module Flo
+
+  # Definition of a task performed by a {Command}.
+  #
+  class Task
+
+    # Creates a new Task instance
+    #
+    # @param [Provider] provider The provider to send the message to
+    # @param [Symbol] The method you wish to call on the provider
+    # @param [Hash] provider_options={} A hash of options to be passed when
+    #   invoking the method on the provider.  Any lambda values will be called
+    #   during the execution stage when {#call} is invoked
+    #
+    def initialize(provider, method_sym, provider_options={})
+      @provider = provider
+      @method_sym = method_sym
+
+      raise ArgumentError.new("Expected provider_options to be a hash") unless provider_options.is_a? Hash
+      @provider_options = provider_options
+    end
+
+    # Call invokes the task on the provider instance.  Additional parameters can be
+    # passed in that are merged into the parameters that were provided in {initialize}.
+    # Proc values will be evaluated before being passed to the provider.
+    #
+    # @param [Hash] args={} Additional arguments to pass to the provider method
+    # @return [#success?] Response of the provider's method
+    def call(args={})
+      @provider.public_send(method_sym, merged_evaluated_args(args))
+    end
+
+    private
+    attr_reader :provider, :method_sym, :provider_options
+
+    def merged_evaluated_args(args)
+      evaluate_proc_values(provider_options.merge args)
+    end
+
+    def evaluate_proc_values(args={})
+      hsh = {}
+      args.each do |k, v|
+        hsh[k] = v.is_a?(Proc) ? v.call : v
+      end
+      hsh
+    end
+  end
+end

data/lib/flo/version.rb

@@ -0,0 +1,8 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module Flo
+  VERSION = "0.0.2"
+end

data/lib/flo.rb

@@ -0,0 +1,14 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require "flo/version"
+require "flo/runner"
+
+# Parent module for all Flo related functionality.  Should not be used directly.
+# See {file:README.md} or {Runner} for information on overall usage.
+#
+module Flo
+
+end

data/test/fixtures/basic_setup.rb

@@ -0,0 +1,14 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'flo/provider/developer'
+
+config do |cfg|
+  cfg.provider :developer
+end
+
+register_command([:task, :start]) do |success: true|
+  perform :developer, :is_successful, { success: state(:developer).return_true }
+end

data/test/fixtures/one_config_call.rb

@@ -0,0 +1,8 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+config do |cfg|
+  cfg.provider :developer
+end

data/test/flo/command_collection_test.rb

@@ -0,0 +1,45 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/command_collection'
+
+module Flo
+  class CommandCollectionTest < Flo::UnitTest
+
+    def subject
+      @subject ||= Flo::CommandCollection.new
+    end
+
+    def test_a_single_symbol_can_be_used_as_a_storage_key
+      command = Object.new
+      subject[:command_name] = command
+      assert_same command, subject[:command_name]
+    end
+
+    def test_an_array_of_symbols_can_be_used_as_a_storage_key
+      command = Object.new
+      subject[:name, :spaced, :command] = command
+      assert_same command, subject[:name, :spaced, :command]
+    end
+
+    def test_properly_selects_correct_command
+      command1 = Object.new
+      command2 = Object.new
+      subject[:name, :spaced, :command1] = command1
+      subject[:name, :spaced, :command2] = command2
+
+      assert_same command1, subject[:name, :spaced, :command1]
+      assert_same command2, subject[:name, :spaced, :command2]
+    end
+
+    def test_selecting_a_command_that_doesnt_exist_raises_error
+      assert_raises(Flo::CommandNotDefinedError) do
+        subject[:undefined_command]
+      end
+    end
+
+  end
+end

data/test/flo/command_test.rb

@@ -0,0 +1,95 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/command'
+require 'ostruct'
+
+module Flo
+  class CommandTest < Flo::UnitTest
+
+    def subject
+      @subject_block ||= lambda { }
+      @providers ||= { mocked_provider: mock }
+      @state_class_mock ||= Object
+      @subject ||= Flo::Command.new(
+        providers: @providers,
+        state_class: @state_class_mock,
+        task_class: MockTask,
+        &@subject_block
+      )
+    end
+
+    def mock
+      @mock ||= MockProvider.new
+    end
+
+    def performer_class_mock
+      @performer_class_mock ||= begin
+        mock = Minitest::Mock.new
+        mock.expect(:new, performer_obj, [Symbol, Symbol, {}, Hash])
+      end
+    end
+
+    def performer_obj
+      @performer_obj ||= lambda { }
+    end
+
+    def test_new_raises_if_no_block_provided
+      assert_raises(ArgumentError) do
+        Flo::Command.new(:foo)
+      end
+    end
+
+    def test_task_called_with_args
+      @subject_block = lambda do |*args|
+        perform :mocked_provider, :provider_method, baz: 2
+      end
+
+      result = subject.call(bar: 1)
+
+      assert_equal([{ bar: 1 }], result.args_passed)
+      assert_equal({ baz: 2 }, result.args_initialized.last)
+    end
+
+    def test_call_stops_and_returns_failure_early_if_task_is_not_successful
+      @subject_block = lambda do |*args|
+        perform :mocked_provider, :failed_provider_method, {success: false}
+        perform :mocked_provider, :provider_method, {fail: true}
+      end
+
+      refute subject.call.success?
+    end
+
+    def test_state_is_not_invoked_during_configuration_phase
+      @state_class_mock = Minitest::Mock.new
+      state_mock = Minitest::Mock.new
+      @state_class_mock.expect(:new, state_mock, [mock])
+
+      state_mock.expect(:state_method, lambda { raise "This should never be evaluated" }, [] )
+      subject.perform :mocked_provider, :provider_method, {evaluated_later: subject.state(:mocked_provider).state_method }
+    end
+
+    class MockProvider
+      attr_reader :args, :state_method_called
+
+      def state_method
+        @state_method_called = true
+      end
+    end
+
+    class MockTask
+      def initialize(*args)
+        @initial_args = args
+      end
+
+      def call(*args)
+        fail("This task should never have been called") if @initial_args.last.fetch(:fail, false)
+        success = @initial_args.last.fetch(:success, true)
+        OpenStruct.new(success?: success, args_passed: args, args_initialized: @initial_args)
+      end
+    end
+  end
+end

data/test/flo/config_test.rb

@@ -0,0 +1,35 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/config'
+
+module Flo
+  class ConfigTest < Flo::UnitTest
+
+    def subject
+      @subject ||= Flo::Config.new
+    end
+
+    def test_provider_instantiates_new_provider
+      assert_equal({}, subject.providers)
+      subject.provider(:mock_provider)
+      assert_kind_of Flo::Provider::MockProvider, subject.providers[:mock_provider]
+    end
+
+    def test_raises_helpful_error_if_provider_not_required
+      assert_raises(Flo::MissingRequireError) do
+        subject.provider :doesnt_exist
+      end
+    end
+
+  end
+  module Provider
+    class MockProvider
+      def initialize(args={})
+      end
+    end
+  end
+end

data/test/flo/flo_test.rb

@@ -0,0 +1,16 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo'
+require 'flo/provider/developer'
+
+class FloTest < Flo::UnitTest
+
+  def subject
+    @subject = Flo
+  end
+
+end

data/test/flo/runner_integration_test.rb

@@ -0,0 +1,35 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/runner'
+require 'flo/config'
+
+module Flo
+  class RunnerIntegrationTest < Flo::UnitTest
+
+    def subject
+      @subject ||= begin
+        subj = Flo::Runner.new
+        subj.load_config_file(File.join(FIXTURES_ROOT, 'basic_setup.rb'))
+        subj
+      end
+    end
+
+    def test_execute_returns_success
+      response = subject.execute([:task, :start])
+
+      assert_equal true, response.success?
+    end
+
+    def test_execute_success_is_false_when_perform_fails
+      response = subject.execute([:task, :start], success: false)
+
+      assert_equal false, response.success?
+    end
+
+  end
+end
+

data/test/flo/runner_test.rb

@@ -0,0 +1,100 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/runner'
+
+module Flo
+  class RunnerTest < Flo::UnitTest
+
+    def subject
+      @subject ||= Flo::Runner.new(
+        config: config_mock,
+        command_class: command_class_mock,
+        command_collection: command_collection_mock
+      )
+    end
+
+    def config_mock
+      @config_mock ||= Minitest::Mock.new
+    end
+
+    def command_class_mock
+      @command_class_mock ||= Minitest::Mock.new
+    end
+
+    def command_collection_mock
+      @command_collection_mock ||= {}
+    end
+
+    def config_file_fixture
+      @config_file_fixture ||= File.expand_path(File.join(FIXTURES_ROOT, 'basic_setup.rb'))
+    end
+
+    def test_config_returns_config_instance
+      # Minitest::Mock undefines #equal?, which causes #assert_same to raise
+      assert_equal config_mock.object_id, subject.config.object_id
+    end
+
+    def test_passing_block_to_config_yields_config_to_block
+      config_mock.expect(:foo, true)
+
+      subject.config do |cfg|
+        cfg.foo
+      end
+
+      config_mock.verify
+    end
+
+    def test_register_command_adds_new_command_to_collection
+      new_command = Object.new
+      command_class_mock.expect(:new, new_command, [{ providers: {} }])
+
+      config_mock.expect(:providers, {})
+
+      subject.register_command(:foo) { }
+
+      assert_equal new_command, subject.commands[:foo]
+
+      command_class_mock.verify
+    end
+
+    def test_register_command_namespaced_adds_new_command_to_collection
+      config_mock.expect(:providers, {})
+      new_command = Object.new
+      command_class_mock.expect(:new, new_command, [{ providers: {} }])
+
+      @command_collection_mock = {}
+
+      subject.register_command([:foo, :bar]) { }
+
+      assert_equal(new_command, subject.commands[[:foo, :bar]])
+
+      command_class_mock.verify
+    end
+
+    def test_execute_calls_command_with_args
+      args = {foo: :bar}
+      providers_hash = Object.new
+      new_command = lambda { |args| true }
+
+      command_class_mock.expect(:new, new_command, [{ providers: providers_hash }])
+      config_mock.expect(:providers, providers_hash)
+
+      subject.register_command(:foo)
+
+      subject.execute(:foo, args)
+    end
+
+    def test_load_config_file_evals_file
+      config_mock.expect(:provider, true, [:developer])
+      subject.load_config_file(File.join(FIXTURES_ROOT, 'one_config_call.rb'))
+
+      config_mock.verify
+    end
+
+
+  end
+end

data/test/flo/state_test.rb

@@ -0,0 +1,41 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/state'
+
+module Flo
+  class StateTest < Flo::UnitTest
+
+    def subject
+      @mock_provider ||= MockProvider.new
+      @subject ||= Flo::State.new(@mock_provider)
+    end
+
+    def test_meth_missing_returns_lambda
+      assert_kind_of Proc, subject.existing_method
+    end
+
+    def test_arguments_are_passed_into_returned_lambda
+      subject.existing_method(:method_arguments).call
+
+      assert_equal([:method_arguments], @mock_provider.args)
+    end
+
+    def test_provider_method_is_called_when_lambda_is_invoked
+      subject.existing_method.call
+
+      assert @mock_provider.existing_method_called
+    end
+
+    class MockProvider
+      attr_reader :args, :existing_method_called
+      def existing_method(*args)
+        @existing_method_called = true
+        @args = args
+      end
+    end
+  end
+end

data/test/flo/task_test.rb

@@ -0,0 +1,63 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/task'
+require 'ostruct'
+
+module Flo
+  class TaskTest < Flo::UnitTest
+    def subject
+      @method_sym ||= :foo
+      @provider_options ||= {}
+      @subject ||= Flo::Task.new(
+        provider,
+        @method_sym,
+        @provider_options
+      )
+    end
+
+    def provider
+      @provider ||= Minitest::Mock.new
+    end
+
+    def test_calls_method_on_provider
+      provider.expect(:foo, true, [{}])
+      subject.call()
+      provider.verify
+    end
+
+    def test_passes_on_args
+      provider.expect(:foo, true, [{ bar: 1 }])
+      subject.call(bar: 1)
+      provider.verify
+    end
+
+    def test_merges_args_with_provider_options
+      @provider_options = { baz: 2 }
+      provider.expect(:foo, true, [{ bar: 1, baz: 2 }])
+      subject.call(bar: 1)
+      provider.verify
+    end
+
+    def test_should_raise_if_provider_options_is_not_a_hash
+      @provider_options = :bar
+      assert_raises(ArgumentError) { subject.call(baz: 1) }
+    end
+
+    def test_called_args_override_provider_options
+      @provider_options = { bar: 2 }
+      provider.expect(:foo, true, [{ bar: 1 }])
+      subject.call(bar: 1)
+      provider.verify
+    end
+
+    def test_procs_in_options_are_evaluated_before_provider_method_is_called
+      @provider_options = { baz: Proc.new { 2 }}
+      provider.expect(:foo, true, [{ bar: 1, baz: 2 }])
+      subject.call(bar: Proc.new { 1 })
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,25 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'simplecov'
+SimpleCov.start
+
+SimpleCov.configure do
+  add_filter "/test/"
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+TEST_ROOT = File.dirname(__FILE__)
+FIXTURES_ROOT = File.expand_path('../fixtures', __FILE__)
+ENV["MT_NO_SKIP_MSG"] = "true"
+
+require 'minitest/autorun'
+require 'pry'
+
+module Flo
+  class UnitTest < Minitest::Test
+    self.parallelize_me!
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: flo
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Justin Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cleanroom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Flo is a local workflow automation tool that helps you get things done.  This
+  gem contains the core functionality for Flo, plugins for interacting with various
+  systems can be found in separate provider gems.
+email:
+- justinspowers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flo.gemspec
+- lib/flo.rb
+- lib/flo/command.rb
+- lib/flo/command_collection.rb
+- lib/flo/config.rb
+- lib/flo/provider/developer.rb
+- lib/flo/runner.rb
+- lib/flo/state.rb
+- lib/flo/task.rb
+- lib/flo/version.rb
+- test/fixtures/basic_setup.rb
+- test/fixtures/one_config_call.rb
+- test/flo/command_collection_test.rb
+- test/flo/command_test.rb
+- test/flo/config_test.rb
+- test/flo/flo_test.rb
+- test/flo/runner_integration_test.rb
+- test/flo/runner_test.rb
+- test/flo/state_test.rb
+- test/flo/task_test.rb
+- test/minitest_helper.rb
+homepage: https://github.com/salesforce/flo
+licenses:
+- BSD-3-Clause
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Simple developer workflow automation
+test_files:
+- test/fixtures/basic_setup.rb
+- test/fixtures/one_config_call.rb
+- test/flo/command_collection_test.rb
+- test/flo/command_test.rb
+- test/flo/config_test.rb
+- test/flo/flo_test.rb
+- test/flo/runner_integration_test.rb
+- test/flo/runner_test.rb
+- test/flo/state_test.rb
+- test/flo/task_test.rb
+- test/minitest_helper.rb