bbservices 1.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee91579b2f457ed0687174765d23e878309fcd40547d011027fe26670318764
-  data.tar.gz: 97015a7d4a299974376dca8ce00bc5d1ab13b20d9f1f316b346ca1862174bde0
+  metadata.gz: 74f80a7b7e464af8acbd19ad5f6bf737841e8cdc3fde5b31bc7c95138a46d12e
+  data.tar.gz: 4cab521db2a3a0a63ef64db51619f7bb3510e029b7ff1dc7f8e6edac9daf6aab
 SHA512:
-  metadata.gz: 344df6233478ad174c3f328349b3b249bffcc3462e0b0ce600a9b375a0c403b52b71a27e6bd1638b781271e0e9d037d5b4b2bcc8528f82e110e69e413a5d87d4
-  data.tar.gz: 6350275bf4736f3538fbe271990730348d92cc62729d397782feb7b4b19530610b4dde4e9e072d1e9d39083f15e9bf520d6c6ebf042dbcd09b2c85dee865cc2e
+  metadata.gz: 2890f6338a834a268c8d335802a5eee320ca3aa72486738e1d9b371fe420fef5c774ffcd7d5531ebfb4390a2798a969d975bae6d8445230fc0a83899cbce895b
+  data.tar.gz: 84af48c5501e2eb40f82b8e6c15da273898da023b09713da5810c8cb7a2e96c241d2a439cda164d82f47caff8b5ddd9e959b774d073edcb7784b293b50890de4

data/lib/bbservices.rb

@@ -1,2 +1,4 @@
-require_relative 'service'
-require_relative 'service_provider'
+# frozen_string_literal: true
+
+require_relative 'bbservices/service'
+require_relative 'bbservices/service_provider'

data/lib/bbservices/service.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module BBServices
+  ##
+  # The base class for all services. Handles the basic run loop and general accessors
+  class Service
+    attr_reader :params, :object, :error
+
+    ##
+    # Creates a new service class, then calls run
+    def self.run(params = {}, &block)
+      self.new(params).tap do |service|
+        service.run(&block)
+      end
+    end
+
+    ##
+    # Creates a new service class, then calls run! 
+    def self.run!(params = {}, &block)
+      self.new(params).tap do |service|
+        service.run!(&block)
+      end
+    end
+
+    ##
+    # Sets the service class
+    def self.service_class(klass)
+      @service_class = klass
+    end
+
+    ##
+    # Gets the service class
+    def self.get_service_class
+      @service_class
+    end
+
+    def initialize(params = {})
+      ##
+      # The object which will be assigned to the service
+      @object = nil
+
+      ##
+      # The state of success, was the service successful
+      @successful = false
+
+      ##
+      # The state of the run, has the service being ran
+      @ran = false
+
+      ##
+      # The error that has been throw by the service
+      @error = nil
+
+      ##
+      # The service class stored on the instance. This will override the
+      # service class set statically
+      @service_class = nil
+
+      ##
+      # The params passed to the resource
+      @params = params
+    end
+
+    ##
+    # This runs the safe version of the service. E.g. Will rescue on exception
+    # and set the error attribute
+    def run(&block)
+      set_ran
+      begin
+        initialize_service
+        run_service
+      rescue => e
+        set_successful(false)
+        set_error(e)
+      ensure
+        call_block(&block)
+      end
+    end
+
+    ##
+    # This runs the unsafe version of the service. E.g. Exceptions will be thrown
+    def run!(&block)
+      set_ran
+      begin
+        initialize_service
+        run_service!
+        call_block(&block)
+      rescue => e
+        set_successful(false)
+        set_error(e)
+        raise e
+      end
+    end
+
+    def set_service_class(value)
+      @service_class = value
+    end
+
+    ##
+    # Sets the service_class instance variable
+    def service_class=(value)
+      set_service_class(value)
+    end
+
+    ##
+    # Gets the service_class. This will go instance first, then static
+    def service_class
+      @service_class || self.class.get_service_class
+    end
+
+    def set_params(value)
+      @params = value
+    end
+
+    def params=(value)
+      set_params(value)
+    end
+
+    def param_for(key)
+      param(key)
+    end
+
+    def param(key)
+      @params[key] if @params
+    end
+
+    def number_of_params
+      @params ? @params.length : 0
+    end
+
+    def ran?
+      @ran
+    end
+
+    def succeeded?
+      successful?
+    end
+
+    def successful?
+      @successful
+    end
+
+    def failed?
+      !succeeded?
+    end
+
+    def success(&block)
+      call_block(&block) if succeeded?
+    end
+
+    def failure(&block)
+      call_block(&block) if failed?
+    end
+
+    def error?
+      !!@error
+    end
+
+    def params?
+      !!@params
+    end
+
+    protected
+
+    def initialize_service() end
+
+    def run_service
+      set_successful
+      set_object(nil)
+    end
+
+    def run_service!
+      set_successful
+      set_object(nil)
+    end
+
+    def set_object(obj)
+      @object = obj
+    end
+
+    def set_error(error)
+      @error = error
+    end
+
+    def set_successful(successful = true)
+      @successful = successful
+    end
+
+    def set_ran(ran = true)
+      @ran = ran
+    end
+
+    private
+
+    def call_block
+      yield(self) if block_given?
+    end
+  end
+end

data/lib/bbservices/service_provider.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BBServices 
+  ##
+  # 
+  module ServiceProvider
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+
+        ##
+        # Creates a brand new service of a given type
+        def service(service_type, service_params = {})
+          service_type.new.tap do |service|
+            service.set_params(service_params)
+          end
+        end
+
+        ##
+        # Creates and runs a brand new service using the safe method
+        def run_service(service_type, service_params = {}, &block)
+          service(service_type, service_params).tap do |service|
+            service.set_service_class(service_type)
+            service.run(&block)
+          end
+        end
+
+        ##
+        # Creates and runs a brand new service using the unsafe method
+        def run_service!(service_type, service_params = {}, &block)
+          service(service_type, service_params).tap do |service|
+            service.set_service_class(service_type)
+            service.run!(&block)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bbservices
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Stuart Farnaby, Big Bear Studios
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2021-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,8 +59,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/bbservices.rb
-- lib/service.rb
-- lib/service_provider.rb
+- lib/bbservices/service.rb
+- lib/bbservices/service_provider.rb
 homepage: https://gitlab.com/big-bear-studios-open-source/bbservices
 licenses:
 - MIT

data/lib/service.rb

@@ -1,197 +0,0 @@
-##
-# The base class for all services. Handles the basic run loop and general accessors
-class Service
-  attr_reader :params, :object, :errors
-
-  ##
-  # Creates a new service class, then calls run
-  def self.run(params = nil, &block)
-    self.new(params).tap do |service|
-      service.run(&block)
-    end
-  end
-
-  ##
-  # Creates a new service class, then calls run! 
-  def self.run!(params = nil, &block)
-    self.new(params).tap do |service|
-      service.run!(&block)
-    end
-  end
-
-  def self.service_class(klass)
-    @service_class = klass
-  end
-
-  def self.get_service_class
-    @service_class
-  end
-
-  def initialize(params = nil)
-    ##
-    # The object which will be assigned to the service
-    @object = nil
-
-    ##
-    # The state of success, was the service successful
-    @successful = false
-
-    ##
-    # The state of the run, has the service being ran
-    @ran = false
-
-    ##
-    # The errors which are returned by the service
-    @errors = nil
-
-    ##
-    # The service class stored on the instance. This will override the
-    # service class set statically
-    @service_class = nil
-
-    ##
-    # The params passed to the resource
-    @params = params
-  end
-
-  ##
-  # This runs the safe version of the service. E.g. Will rescue on exception
-  def run(&block)
-    set_ran
-    begin
-      initialize_service
-      internal_validation
-      run_service
-    rescue StandardError => e
-      set_successful(false)
-      set_error(e)
-    ensure
-      call_block(&block)
-    end
-  end
-
-  ##
-  # This runs the unsafe version of the service. E.g. Exceptions will be thrown
-  def run!(&block)
-    set_ran
-    begin
-      initialize_service
-      internal_validation
-      run_service!
-      call_block(&block)
-    rescue StandardError => e
-      set_successful(false)
-      set_error(e)
-      raise e
-    end
-  end
-
-  def set_service_class(value)
-    @service_class = value
-  end
-
-  ##
-  # Sets the service_class instance variable
-  def service_class=(value)
-    set_service_class(value)
-  end
-
-  ##
-  # Gets the service_class. This will go instance first, then static
-  def service_class
-    @service_class || self.class.get_service_class
-  end
-
-  def set_params(value)
-    @params = value
-  end
-
-  def params=(value)
-    set_params(value)
-  end
-
-  def param_for(key)
-    param(key)
-  end
-
-  def param(key)
-    @params[key] if @params
-  end
-
-  def ran?
-    @ran
-  end
-
-  def succeeded?
-    (@successful && !errors?)
-  end
-
-  def successful?
-    (@successful && !errors?)
-  end
-
-  def failed?
-    !succeeded?
-  end
-
-  def success(&block)
-    call_block(&block) if succeeded?
-  end
-
-  def failure(&block)
-    call_block(&block) if failed?
-  end
-
-  def errors?
-    !!(@errors && @errors.length.positive?)
-  end
-
-  def params?
-    !!@params
-  end
-
-  protected
-
-  def initialize_service() end
-
-  def run_service
-    set_successful
-    set_object(nil)
-  end
-
-  def run_service!
-    set_successful
-    set_object(nil)
-  end
-
-  def set_object(obj)
-    @object = obj
-  end
-
-  def set_error(error)
-    set_errors([]) unless @errors
-    @errors << error
-  end
-
-  def set_errors(errors)
-    @errors = errors
-  end
-
-  def set_successful(successful = true)
-    @successful = successful
-  end
-
-  def set_ran(ran = true)
-    @ran = ran
-  end
-
-  private
-
-  def internal_validation
-    set_params({}) unless params?
-  end
-
-  def call_block
-    yield(self) if block_given?
-  end
-end

data/lib/service_provider.rb

@@ -1,33 +0,0 @@
-module ServiceProvider
-  def self.included(base)
-    base.extend ClassMethods
-    base.class_eval do
-
-      ##
-      # Creates a brand new service of a given type
-      def service(service_type, service_params = {})
-        service_type.new.tap do |service|
-          service.set_params(service_params)
-        end
-      end
-
-      def run_service(service_type, service_params = {}, &block)
-        service(service_type, service_params).tap do |service|
-          service.set_service_class(service_type)
-          service.run(&block)
-        end
-      end
-
-      def run_service!(service_type, service_params = {}, &block)
-        service(service_type, service_params).tap do |service|
-          service.set_service_class(service_type)
-          service.run!(&block)
-        end
-      end
-    end
-  end
-
-  module ClassMethods
-    
-  end
-end