rao-service_chain 0.0.32.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 187d7fe20ee4289c8658dbe126437830c9597f9b0f5c3c2f1ddac1debb83f405
+  data.tar.gz: fa4fdbfd74b2483bb44b7ee841c4862aa18545a78022b27cffbf14caffcc1654
+SHA512:
+  metadata.gz: 582b57d52ed71d38a76f14fe65dbcadb9895ef05ed702036c864de89255cd09e75203d70d6ba72accbc26647b1049bdc4aaed1f88ef92b6ed260ce4436b47232
+  data.tar.gz: 60a7ae46d160c9b8515889fdd9b9719bb805c79803aaf830474f7658e83f995155b74b9adc7930cd8a547123376546cd580f449fe3c71aef351578467513eb42

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Roberto Vasquez Angel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Rails Add-Ons Service Chain
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rao-service_chain'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rao-service_chain
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Add-Ons Service chain'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'

data/app/assets/stylesheets/rao/service_chain/application/wizard.css

@@ -0,0 +1,34 @@
+.wizard {
+  padding-top: 1rem;
+  padding-bottom: 1rem;
+  position: relative;
+  display: flex;
+}
+
+.wizard .wizard-track {
+  position: absolute;
+  top: 1.8rem;
+  width: 100%;
+  height: 5px;
+}
+
+.wizard .wizard-step {
+  position: relative;
+  width: 100%;
+  font-size: 12px;
+  text-align: center;
+}
+
+.wizard .wizard-step:last-child:after {
+  display: none;
+}
+
+.wizard .wizard-step-marker {
+  width: 2rem;
+  height: 2rem;
+  display: flex;      
+  margin: 0 auto;
+  margin-bottom: 0.25rem;
+  justify-content: center; /* center items vertically, in this case */
+  align-items: center;     /* center items horizontally, in this case */
+}

data/app/assets/stylesheets/rao/service_chain/application.css

@@ -0,0 +1,3 @@
+/*
+ *= require_tree ./application
+ */

data/app/assets/stylesheets/rao-service_chain.css

@@ -0,0 +1,3 @@
+/*
+ *= require rao/service_chain/application
+ */

data/app/concerns/rao/service/chain/controller_concern.rb

@@ -0,0 +1,70 @@
+module Rao
+  module Service
+    module Chain
+      # Usage:
+      #
+      #     # app/service_chains/checkout_service_chain.rb
+      #     class CheckoutServiceChain < Rao::Service::Chain::Base
+      #       def steps
+      #         [
+      #           wrap(CartService, completed_if: ->(service) { service.new.valid? }),
+      #           wrap(PaymentOptionsService, completed_if: ->(service) { service.new.valid? }),
+      #           wrap(DeliveryAddressService, completed_if: ->(service) { service.new.valid? }),
+      #           wrap(ConfirmationService, completed_if: ->(service) { service.new.valid? }),
+      #           wrap(ResultService, completed_if: ->(service) { service.new.valid? }),
+      #         ]
+      #       end
+      #     end
+      #
+      #     # app/controllers/checkout_services_controller/base.rb
+      #     module CheckoutServicesController
+      #       class Base < Rao::ServiceController::Base
+      #         include Rao::Service::Chain::ControllerConcern
+      #
+      #         def self.service_chain_class
+      #           CheckoutServiceChain
+      #         end
+      #
+      #         private
+      #
+      #         def after_sucess_location
+      #           next_step_url
+      #         end
+      #       end
+      #     end
+      #
+      module ControllerConcern
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :load_service_chain#
+          helper_method :service_chain
+        end
+
+        class_methods do
+          def service_chain_class
+            raise "Child class responsibilty"
+          end
+        end
+        
+        private
+
+        def service_chain
+          @service_chain
+        end
+
+        def service_chain_class
+          self.class.service_chain_class
+        end
+
+        def load_service_chain
+          @service_chain = service_chain_class.new(actual_step: self.service_class)
+        end
+
+        def next_step_url
+          @service_chain.next_step_url(context: self)
+        end
+      end
+    end
+  end
+end

data/app/install_generator.rb

@@ -0,0 +1,15 @@
+module Rao
+  module ServiceChain
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Generates the initializer'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def generate_initializer
+          template 'initializer.rb', 'config/initializers/rao-service_chain.rb'
+        end
+      end
+    end
+  end
+end

data/app/service_chains/rao/service_chain/base.rb

@@ -0,0 +1,93 @@
+module Rao
+  module ServiceChain
+    	class Base
+  		attr_accessor :steps
+  		attr_accessor :actual_step
+
+  		def initialize(options = {})
+  			options.each do |key, value|
+  				self.send("#{key}=", value)
+  			end
+        wrap_actual_step! if @actual_step.present?
+  		end
+
+      def wrap_actual_step!
+        @actual_step = wrap(@actual_step)
+      end
+
+  		def steps=(steps)
+  			@steps = steps.map { |s| wrap(s) }
+			end
+
+  		def steps
+  			raise "Child class responsiblity"
+  		end
+
+  		def actual_step_index
+        self.steps.map(&:service).index(self.actual_step.try(:service))
+      end
+
+      def step_count
+        self.steps.size
+      end
+
+      def previous_step_index
+      	self.steps.map(&:service).index(self.previous_step.try(:service))
+      end
+
+      def next_step_index
+      	self.steps.map(&:service).index(self.next_step.try(:service))
+      end
+
+      def previous_step
+        return nil if self.actual_step_index.nil?
+      	return nil if self.actual_step_index - 1 < 0
+      	self.steps[self.actual_step_index - 1]
+      end
+
+      def next_step
+        return nil if self.actual_step_index.nil?
+      	return nil if self.actual_step_index + 1 >= self.step_count
+      	self.steps[self.actual_step_index + 1]
+      end
+
+      def next_step?
+      	!!next_step
+      end
+
+      def previous_step?
+      	!!previous_step
+      end
+
+      def next_step_url(options = {})
+      	context = options.delete(:context)
+      	self.next_step.url(context)
+      end
+
+      def steps_with_urls(context)
+        self.steps.map { |s| s.url(context); s }
+      end
+
+      def to_hash(context = nil)
+      	{
+      		actual_step: self.actual_step.to_hash(context),
+      		steps: self.steps.map { |s| s.to_hash(context) }
+      	}
+      end
+
+      def completed_steps
+        self.steps.collect { |s| s.completed? ? s : nil }.compact
+      end
+
+      def pending_steps
+        self.steps.collect { |s| s.pending? ? s : nil }.compact
+      end
+
+      private
+
+      def wrap(service, options = {})
+      	Rao::ServiceChain::Step::Base.new(options.merge(service: service, chain: self))
+      end
+  	end
+  end
+end

data/app/service_steps/rao/service_chain/step/base.rb

@@ -0,0 +1,53 @@
+module Rao
+	module ServiceChain
+		module Step
+			class Base
+				attr_accessor :service, :service_name, :label, :chain
+
+				def initialize(options = {})
+					@service = options.delete(:service)
+					@chain = options.delete(:chain)
+					@completed_if = options.delete(:completed_if)
+					@service_name = @service.try(:name)
+					@label = service.try(:model_name).try(:human)
+				end
+
+				def url(context = nil)
+					return nil if context.nil?
+					@url ||= context.url_for([:new, @service, only_path: true])
+				end
+
+				def completed?
+					return nil unless @completed_if.respond_to?(:call)
+					@chain.instance_exec(@service, &@completed_if)
+				end
+
+				def pending?
+					!completed?
+				end
+
+				def completion_status
+					completed? ? :completed : :pending
+				end
+
+				def actual?
+					return false if @chain.actual_step.nil?
+					@chain.actual_step.service == @service
+				end
+
+				def to_hash(context = nil)
+					{
+						service: service,
+						service_name: service.name,
+						label: label,
+						completed: completed?,
+						pending: pending?,
+						completion_status: completion_status,
+						actual: actual?,
+						url: url(context)
+					}
+				end
+			end
+		end
+	end
+end

data/app/view_helpers/rao/service_chain/application_view_helper.rb

@@ -0,0 +1,28 @@
+module Rao
+  module ServiceChain
+    # Usage:
+    #
+    #     # app/controllers/application_controller.rb
+    #     class ApplicationController < ActionController::Base
+    #       view_helper Rao::Service::Chain::ApplicationViewHelper, as: :service_chain_helper
+    #     end
+    #
+    class ApplicationViewHelper < Rao::ViewHelper::Base
+      # Usage:
+      #
+      #     # app/views/layouts/application.html.haml
+      #     !!!
+      #     %html{ lang: I18n.locale }
+      #       %head
+      #         /...
+      #       %body
+      #         = service_chain_helper(self).render_progress(@service_chain)
+      #
+      def render_progress(service_chain, options = {})
+        options.reverse_merge!(theme: :bootstrap4)
+        theme = options.delete(:theme)
+        c.render partial: "rao/service_chain/application_view_helper/render_progress/#{theme}", locals: { service_chain: service_chain }
+      end
+    end
+  end
+end

data/app/views/rao/service_chain/application_view_helper/render_progress/_bootstrap4.html.haml

@@ -0,0 +1,17 @@
+.service-chain
+  .wizard
+    .wizard-track.bg-light
+    - service_chain.steps.each_with_index do |step, index|
+      .wizard-step{ class: [step.completion_status, (step.actual? ? :actual : nil)].compact.join(" "), id: "step#{index + 1}" }
+        - if step.actual?
+          %span.wizard-step-marker.rounded-circle.bg-primary.text-white
+            %i.fas.fa-play
+          = step.label
+        - else
+          - if step.completed?
+            %span.wizard-step-marker.rounded-circle.bg-success.text-white
+              %i.fas.fa-check
+          - else
+            %span.wizard-step-marker.rounded-circle.bg-secondary.text-white
+              %i.fas.fa-circle
+          = link_to(step.label, [:new, step.service])

data/lib/generators/rao/service_chain/templates/initializer.rb

@@ -0,0 +1,2 @@
+Rao::ServiceChain.configure do |config|
+end

data/lib/rao/service_chain/configuration.rb

@@ -0,0 +1,12 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Rao
+  module ServiceChain
+    module Configuration
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/rao/service_chain/engine.rb

@@ -0,0 +1,7 @@
+module Rao
+  module ServiceChain
+    class Engine < ::Rails::Engine
+      isolate_namespace Rao::ServiceChain
+    end
+  end
+end

data/lib/rao/service_chain/version.rb

@@ -0,0 +1,7 @@
+require 'rao/version'
+
+module Rao
+  module ServiceChain
+    VERSION = ::Rao::VERSION
+  end
+end

data/lib/rao/service_chain.rb

@@ -0,0 +1,11 @@
+require "rao/service_chain/version"
+require "rao/service_chain/configuration"
+require "rao/service_chain/engine"
+
+module Rao
+  module ServiceChain
+    extend Configuration
+  end
+end
+
+Rao.configure { |c| c.register_configuration(:service_chain, Rao::ServiceChain) }

data/lib/rao-service_chain.rb

@@ -0,0 +1,7 @@
+require "haml-rails"
+
+require "rao"
+require "rao-view_helper"
+require "rao-service"
+
+require "rao/service_chain"

data/lib/tasks/rao-service_chain_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rao_service_chain do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: rao-service_chain
+version: !ruby/object:Gem::Version
+  version: 0.0.32.pre
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rao-service
+  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: rao-view_helper
+  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: haml-rails
+  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: 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: rspec-rails
+  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: guard-rspec
+  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: guard-bundler
+  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: capybara
+  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: 
+email:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rao-service_chain.css
+- app/assets/stylesheets/rao/service_chain/application.css
+- app/assets/stylesheets/rao/service_chain/application/wizard.css
+- app/concerns/rao/service/chain/controller_concern.rb
+- app/install_generator.rb
+- app/service_chains/rao/service_chain/base.rb
+- app/service_steps/rao/service_chain/step/base.rb
+- app/view_helpers/rao/service_chain/application_view_helper.rb
+- app/views/rao/service_chain/application_view_helper/render_progress/_bootstrap4.html.haml
+- lib/generators/rao/service_chain/templates/initializer.rb
+- lib/rao-service_chain.rb
+- lib/rao/service_chain.rb
+- lib/rao/service_chain/configuration.rb
+- lib/rao/service_chain/engine.rb
+- lib/rao/service_chain/version.rb
+- lib/tasks/rao-service_chain_tasks.rake
+homepage: https://github.com/rao
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Service Chains for Ruby on Rails.
+test_files: []