flow 0.3.0 → 0.9.0

data/lib/generators/flow/application_operation/application_operation_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Flow
+  module Generators
+    class ApplicationOperationGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_application_operation
+        template "application_operation.rb", File.join("app/operations/application_operation.rb")
+      end
+    end
+  end
+end

data/lib/generators/flow/application_operation/templates/application_operation.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class ApplicationOperation < OperationBase; end

data/lib/generators/flow/application_state/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Create the ApplicationState and test.
+
+Example:
+    `rails generate flow:application_state`
+
+    Generates:
+      State: app/states/application_state.rb
+       Test: spec/states/application_state_spec.rb

data/lib/generators/flow/application_state/application_state_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Flow
+  module Generators
+    class ApplicationStateGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_application_state
+        template "application_state.rb", File.join("app/states/application_state.rb")
+      end
+    end
+  end
+end

data/lib/generators/flow/application_state/templates/application_state.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class ApplicationState < StateBase; end

data/lib/generators/flow/flow_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Flow
+  module Generators
+    class FlowGenerator < Rails::Generators::NamedBase
+      class_option :state, type: :boolean, default: true
+
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :state, as: "flow:state"
+      hook_for :test_framework
+
+      def create_application_flow
+        template "flow.rb.erb", File.join("app/flows/", class_path, "#{file_name}_flow.rb")
+      end
+    end
+  end
+end

data/lib/generators/flow/install/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Creates ApplicationFlow, ApplicationOperation, and ApplicationState with tests.
+
+Example:
+    `rails generate flow:install`
+
+    Generates:
+       Flow: app/flows/application_flow.rb
+  Operation: app/operations/application_operation.rb
+      State: app/states/application_state.rb
+       Test: spec/flows/application_flow_spec.rb
+       Test: spec/operations/application_operation_spec.rb
+       Test: spec/states/application_state_spec.rb

data/lib/generators/flow/install/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Flow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def run_other_generators
+        generate "flow:application_flow"
+        generate "flow:application_operation"
+        generate "flow:application_state"
+      end
+    end
+  end
+end

data/lib/generators/flow/operation/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Stub a Operation with test.
+
+Example:
+    `rails generate operation foo`
+
+    Generates:
+  Operation: app/operations/foo.rb
+       Test: spec/operations/foo_spec.rb

data/lib/generators/flow/operation/operation_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Flow
+  module Generators
+    class OperationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_application_state
+        template "operation.rb.erb", File.join("app/operations/", class_path, "#{file_name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/flow/operation/templates/operation.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < ApplicationOperation
+  def execute
+    # state.foo.blah!
+  end
+end

data/lib/generators/flow/state/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Stub a State with test.
+
+Example:
+    `rails generate state foo`
+
+    Generates:
+      State: app/states/foo_state.rb
+       Test: spec/states/foo_state_spec.rb

data/lib/generators/flow/state/state_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Flow
+  module Generators
+    class StateGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      hook_for :test_framework
+
+      def create_application_state
+        template "state.rb.erb", File.join("app/states/", class_path, "#{file_name}_state.rb")
+      end
+    end
+  end
+end

data/lib/generators/flow/state/templates/state.rb.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class <%= class_name %>State < ApplicationState
+  # argument :required_input
+  # option :optional_input
+  # option :option_with_default, default: :default_static_value
+  # option(:option_with_default_from_block) { required_input.default_dynamic_value }
+end

data/lib/generators/flow/templates/flow.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Flow < ApplicationFlow
+  # operations SomeOperation, SomeOtherOperation
+end

data/lib/generators/rspec/application_flow/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create ApplicationFlow test.
+
+Example:
+    `rails generate rspec:application_flow`
+
+    Generates:
+      Test: spec/flows/application_flow_spec.rb

data/lib/generators/rspec/application_flow/application_flow_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class ApplicationFlowGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "application_flow_spec.rb", File.join("spec/flows/application_flow_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/application_flow/templates/application_flow_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ApplicationFlow, type: :flow do
+  it { is_expected.to inherit_from FlowBase }
+end

data/lib/generators/rspec/application_operation/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create ApplicationOperation test.
+
+Example:
+    `rails generate rspec:application_operation`
+
+    Generates:
+      Test: spec/operations/application_operation_spec.rb

data/lib/generators/rspec/application_operation/application_operation_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class ApplicationOperationGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "application_operation_spec.rb", File.join("spec/operations/application_operation_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/application_operation/templates/application_operation_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ApplicationOperation, type: :operation do
+  subject { described_class.new(state) }
+
+  let(:state) { double }
+
+  it { is_expected.to inherit_from OperationBase }
+end

data/lib/generators/rspec/application_state/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create ApplicationState test.
+
+Example:
+    `rails generate rspec:application_state`
+
+    Generates:
+      Test: spec/states/application_state_spec.rb

data/lib/generators/rspec/application_state/application_state_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class ApplicationStateGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "application_state_spec.rb", File.join("spec/states/application_state_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/application_state/templates/application_state_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ApplicationState, type: :state do
+  it { is_expected.to inherit_from StateBase }
+end

data/lib/generators/rspec/flow/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Stub a Flow test.
+
+Example:
+    `rails generate rspec:flow foo`
+
+    Generates:
+      Test: spec/flows/foo_flow_spec.rb

data/lib/generators/rspec/flow/flow_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class FlowGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "flow_spec.rb.erb", File.join("spec/flows/", class_path, "#{file_name}_flow_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/flow/templates/flow_spec.rb.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>Flow, type: :flow do
+  subject(:flow) { described_class.new(**input) }
+
+  let(:input) do
+    {}
+  end
+
+  it { is_expected.to inherit_from ApplicationFlow }
+  # it { is_expected.to use_operations ExampleOperation }
+end

data/lib/generators/rspec/operation/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Stub an Operation test.
+
+Example:
+    `rails generate rspec:operation foo`
+
+    Generates:
+      Test: spec/operations/foo_spec.rb

data/lib/generators/rspec/operation/operation_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class OperationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "operation_spec.rb.erb", File.join("spec/operations/", class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/operation/templates/operation_spec.rb.erb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>, type: :operation do
+  subject(:operation) { described_class.new(state) }
+
+  let(:state) { example_state_class.new(**state_input) }
+  let(:example_state_class) do
+    Class.new(ApplicationState) do
+      # argument :foo
+      # option :bar
+    end
+  end
+  let(:state_input) do
+    {}
+  end
+
+  it { is_expected.to inherit_from ApplicationOperation }
+
+  describe "#execute" do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+end

data/lib/generators/rspec/state/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Stub a State test.
+
+Example:
+    `rails generate rspec:state foo`
+
+    Generates:
+      Test: spec/states/foo_state_spec.rb

data/lib/generators/rspec/state/state_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class StateGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_spec_file
+        template "state_spec.rb.erb", File.join("spec/states/", class_path, "#{file_name}_state_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/state/templates/state_spec.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>State, type: :state do
+  subject(:state) { described_class.new(**input) }
+
+  let(:input) do
+    {}
+  end
+
+  it { is_expected.to inherit_from ApplicationState }
+  # it { is_expected.to define_argument :foo }
+  # it { is_expected.to define_option(:foo) }
+  # it { is_expected.to define_option(:foo).with_default_value(:bar) }
+  # it { is_expected.to define_option(:foo).with_default_value_block }
+  # it { is_expected.to validate_presence_of ... }
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: flow
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.1
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -164,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: rspice
   requirement: !ruby/object:Gem::Requirement
@@ -203,10 +231,33 @@ files:
 - LICENSE.txt
 - README.md
 - lib/flow.rb
+- lib/flow/concerns/transaction_wrapper.rb
+- lib/flow/custom_matchers.rb
+- lib/flow/custom_matchers/define_argument.rb
+- lib/flow/custom_matchers/define_option.rb
+- lib/flow/custom_matchers/use_operations.rb
+- lib/flow/flow/callbacks.rb
+- lib/flow/flow/core.rb
+- lib/flow/flow/ebb.rb
+- lib/flow/flow/errors/state_invalid.rb
+- lib/flow/flow/flux.rb
+- lib/flow/flow/operations.rb
+- lib/flow/flow/revert.rb
+- lib/flow/flow/status.rb
+- lib/flow/flow/transactions.rb
+- lib/flow/flow/trigger.rb
 - lib/flow/flow_base.rb
+- lib/flow/operation/callbacks.rb
 - lib/flow/operation/core.rb
+- lib/flow/operation/error_handler.rb
 - lib/flow/operation/execute.rb
+- lib/flow/operation/failures.rb
+- lib/flow/operation/rewind.rb
+- lib/flow/operation/status.rb
+- lib/flow/operation/transactions.rb
 - lib/flow/operation_base.rb
+- lib/flow/shoulda_matcher_helper.rb
+- lib/flow/spec_helper.rb
 - lib/flow/state/arguments.rb
 - lib/flow/state/attributes.rb
 - lib/flow/state/callbacks.rb
@@ -215,6 +266,44 @@ files:
 - lib/flow/state/string.rb
 - lib/flow/state_base.rb
 - lib/flow/version.rb
+- lib/generators/flow/USAGE
+- lib/generators/flow/application_flow/USAGE
+- lib/generators/flow/application_flow/application_flow_generator.rb
+- lib/generators/flow/application_flow/templates/application_flow.rb
+- lib/generators/flow/application_operation/USAGE
+- lib/generators/flow/application_operation/application_operation_generator.rb
+- lib/generators/flow/application_operation/templates/application_operation.rb
+- lib/generators/flow/application_state/USAGE
+- lib/generators/flow/application_state/application_state_generator.rb
+- lib/generators/flow/application_state/templates/application_state.rb
+- lib/generators/flow/flow_generator.rb
+- lib/generators/flow/install/USAGE
+- lib/generators/flow/install/install_generator.rb
+- lib/generators/flow/operation/USAGE
+- lib/generators/flow/operation/operation_generator.rb
+- lib/generators/flow/operation/templates/operation.rb.erb
+- lib/generators/flow/state/USAGE
+- lib/generators/flow/state/state_generator.rb
+- lib/generators/flow/state/templates/state.rb.erb
+- lib/generators/flow/templates/flow.rb.erb
+- lib/generators/rspec/application_flow/USAGE
+- lib/generators/rspec/application_flow/application_flow_generator.rb
+- lib/generators/rspec/application_flow/templates/application_flow_spec.rb
+- lib/generators/rspec/application_operation/USAGE
+- lib/generators/rspec/application_operation/application_operation_generator.rb
+- lib/generators/rspec/application_operation/templates/application_operation_spec.rb
+- lib/generators/rspec/application_state/USAGE
+- lib/generators/rspec/application_state/application_state_generator.rb
+- lib/generators/rspec/application_state/templates/application_state_spec.rb
+- lib/generators/rspec/flow/USAGE
+- lib/generators/rspec/flow/flow_generator.rb
+- lib/generators/rspec/flow/templates/flow_spec.rb.erb
+- lib/generators/rspec/operation/USAGE
+- lib/generators/rspec/operation/operation_generator.rb
+- lib/generators/rspec/operation/templates/operation_spec.rb.erb
+- lib/generators/rspec/state/USAGE
+- lib/generators/rspec/state/state_generator.rb
+- lib/generators/rspec/state/templates/state_spec.rb.erb
 homepage: http://www.freshly.com
 licenses:
 - MIT