magical-service 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a040a05f30209e49ae39fbc07f975b38e8bb3338b8a6bdbfd689fc26ed3a79d
+  data.tar.gz: ec7f416f17be7b1ac1ebf10a67f845c7237833e94783a6148125d9a204c2b571
+SHA512:
+  metadata.gz: bcac906045a938dfbf05247eb15e65f1c883c52063ac7b5f7e80d48469084a98f5cfc3a0677a3a0fb45a5dbfaa9c0149eff315b12ef1c818e3d7a8ad93d3f400
+  data.tar.gz: 79791bca59bb5bbd285e588d316b6bab96d983568b491f23af6087f826e21c8e9c53af3129bd5e6a5084f110834a5cc1b4033814af88a2f496e04c3465d7927b

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright 2018 Magica Azula
+
+MIT License
+
+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/lib/magical/service.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'magical/service/action_service'

data/lib/magical/service/action_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'action_service/base'
+
+# action service module
+module ActionService
+  # # a service example:
+  #
+  # class BarService < ActionService::Base
+  #   before_confection do
+  #     define_params :default_param # optional
+  #     define_options :default_option # optional
+  #     define_stages %i[one two three] # optional
+  #     define_delivery :four
+  #   end
+  #
+  #   stage :one do
+  #     # body omitted
+  #   end
+  #
+  #   stage :two do
+  #     stage_helper(foo, bar)
+  #     # body omitted
+  #   end
+  #
+  #   stage :three do
+  #     # body omitted
+  #     stage_helper2(baz)
+  #   end
+  #
+  #   stage :four do
+  #     # body omitted
+  #   end
+  #
+  #   # one-line support action
+  #   mainstay(:stage_helper) { |foo, bar| # body omitted }
+  #
+  #   # multi-line support action
+  #   mainstay(:stage_helper2) do |baz|
+  #     # body omitted
+  #   end
+  # end
+end

data/lib/magical/service/action_service/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'magical/service/core/gears'
+require 'magical/service/core/machinery'
+
+module ActionService
+  # Service base conveniences for your service objects.
+  #
+  # This class allows you to define services based on a
+  # suggested convention, with will execute through a single action.
+  # Then your service can define stages of forced void return and a
+  # delivery method, which will process data and return it
+  #
+  #   class MyService < ActionService::Base
+  #     before_confection do
+  #       define_stages %i[one two] # optional
+  #       define_delivery :three
+  #     end
+  #
+  #     stage :one do { # body omitted }
+  #     stage :two do { # body omitted }
+  #     stage :three do { # body omitted }
+  #   end
+  #
+  # Then your service can do all the process by simply calling:
+  #
+  #   MyService.provide(params: {}, options: {})
+  #
+  class Base
+    extend Core::Gears
+    extend Core::Machinery
+  end
+end

data/lib/magical/service/core/gears.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'gears/control_panel'
+require_relative 'gears/no_assignment_error'
+
+module Core
+  # service gears
+  module Gears
+    def provide(params: {}, options: {})
+      validates_confection do
+        @params = params unless default_attribute?(:params, params)
+        @options = options unless default_attribute?(:options, options)
+      end
+
+      chain do
+        clear_virtual_instance_variables
+      end
+    end
+
+    def before_confection(&block)
+      config.instance_eval(&block)
+    end
+
+    def chain
+      config.stages.each { |method| send(*method) } if stages?
+
+      result = send(*config.delivery)
+      yield
+      result
+    end
+
+    def clear_virtual_instance_variables
+      remove_instance_variable(:@params) if defined?(@params)
+      remove_instance_variable(:@options) if defined?(@options)
+    end
+
+    def config
+      @config ||= ControlPanel.new
+    end
+
+    def default_attribute?(attribute, value)
+      !config.send(attribute).nil? && value.is_a?(Hash) && value.empty?
+    end
+
+    def defined_stages?
+      config.stages.all? { |phase| respond_to?(phase) }
+    end
+
+    def delivery?
+      defined?(@config) && !config.delivery.nil? && respond_to?(config.delivery)
+    end
+
+    def not_defined_error(action)
+      NoAssignmentError.new(action, self)
+    end
+
+    def options
+      defined?(@options) ? @options : (@options = config.options)
+    end
+
+    def params
+      defined?(@params) ? @params : (@params = config.params)
+    end
+
+    def stages?
+      defined?(@config) && !config.stages.nil?
+    end
+
+    def validates_confection
+      raise not_defined_error('some :stages') if stages? && !defined_stages?
+      raise not_defined_error(':delivery') unless delivery?
+
+      yield
+    end
+  end
+end

data/lib/magical/service/core/gears/control_panel.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Core
+  module Gears
+    # Gears Control Panel which handles the basic services configuration
+    class ControlPanel
+      ATTRIBUTES = %i[stages delivery params options].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      ATTRIBUTES.each do |attr|
+        define_method attr do
+          instance_variable_get("@#{attr}")
+        end
+
+        define_method "define_#{attr}" do |value|
+          instance_variable_set("@#{attr}", value)
+        end
+      end
+    end
+  end
+end

data/lib/magical/service/core/gears/no_assignment_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Core
+  module Gears
+    # error of action not assigned
+    class NoAssignmentError < StandardError
+      def initialize(action, service)
+        super("#{action} wasn't assign for the service: #{service}")
+      end
+    end
+  end
+end

data/lib/magical/service/core/machinery.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Core
+  # Machinery which possibility the services stages attribution
+  module Machinery
+    def stage(name)
+      define_singleton_method(name, &Proc.new)
+    end
+
+    alias mainstay stage
+  end
+end

data/lib/magical/service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Magical
+  module Service
+    VERSION = '0.0.0'
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: magical-service
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Heirian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: Magical Service is an experiment that aims to assist the construction
+  of service objects through stages as a single action.
+email: shinkcc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/magical/service.rb
+- lib/magical/service/action_service.rb
+- lib/magical/service/action_service/base.rb
+- lib/magical/service/core/gears.rb
+- lib/magical/service/core/gears/control_panel.rb
+- lib/magical/service/core/gears/no_assignment_error.rb
+- lib/magical/service/core/machinery.rb
+- lib/magical/service/version.rb
+homepage: https://github.com/magica-azula/magical-service
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Magical Service helps build a service object through a single action
+test_files: []