bbservices 0.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03479ca02ab6eaffed82c33de851d1ccdf9dba180bbdc714714d87d310a32fbc'
-  data.tar.gz: d6b34a3997176265f292a1ab7a506913b3847aca362480336fda7c564b1344bf
+  metadata.gz: eb139ce38f9275e297b0b15a40f27e64fb88d7fe5f63255f095ffe9ab2e19814
+  data.tar.gz: 590919391b918930ceaa0a6968f8fbead4d334d23fe5a2aabe3260a590a4ea5b
 SHA512:
-  metadata.gz: eb16aea144f7309b73fd3c39474af38be7ef273d0c48cc617ca76c3e164cab7ca0f900a38dfb73988b520cf7c37e16ed84baad7267b2d8111eaabd3084b3bcd5
-  data.tar.gz: 941725e415c5a6c7809494851af8e69a5ddd78f8965afbc148bad2f9454d28d3f459b355d0f33b94284d78b29bd8a9dd48b450e45bb61339bdda9a7475bff9af
+  metadata.gz: 5197a6279cf2f38a87b42530d5a63f0990f38b9f19a3492f0157ff27bca43121f76fd4d231c22e6318672d6b62ddaa62c77388e5e3f4e7be6d52dc52f1734c73
+  data.tar.gz: 73ce49c4123c57aa057176c407e45daaeb4dec8c7f9f5c67cffcfd0aeefcb8134eac5fc4c25afae1474bf48d022c64919749597ab334330dca94ab8a40b71f14

data/lib/bbservices.rb

@@ -1,6 +1,2 @@
-require_relative "base/service"
-require_relative "rails/service"
-require_relative "rails/new"
-require_relative "rails/destroy"
-require_relative "rails/create"
-require_relative "rails/create_transactioned"
+require_relative 'bbservices/service'
+require_relative 'bbservices/service_provider'

data/lib/bbservices/service.rb

@@ -0,0 +1,198 @@
+
+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,42 @@
+
+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,33 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: bbservices
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Stuart Farnaby, Big Bear Studios
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: 
+date: 2021-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/base/service.rb
 - lib/bbservices.rb
-- lib/rails/create.rb
-- lib/rails/create_transactioned.rb
-- lib/rails/destroy.rb
-- lib/rails/new.rb
-- lib/rails/service.rb
+- lib/bbservices/service.rb
+- lib/bbservices/service_provider.rb
 homepage: https://gitlab.com/big-bear-studios-open-source/bbservices
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,7 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.1
-signing_key: 
+signing_key:
 specification_version: 4
-summary: A simple service library for Ruby / Rails
+summary: A simple service library for Ruby. Please see BBActiveRecordServices for
+  a Rails / AR service library
 test_files: []

data/lib/base/service.rb

@@ -1,147 +0,0 @@
-module BBServices
-
-  ##
-  # This class handles the building of a basic / generic service
-  class Service
-
-    def self.service_class(klass)
-      @service_class = klass
-    end
-
-    def initialize
-
-      @object = nil
-
-      @successful = false
-
-      @errors = nil
-
-      @service_class = nil
-    end
-
-    def service_class=(klass)
-      @service_class = klass
-    end
-
-    def service_class
-      @service_class ? @service_class : self.class.instance_variable_get(:@service_class)
-    end
-
-    def run(&block)
-      begin
-        initialize_service
-        run_service
-      rescue StandardError => e
-        set_successful(false)
-        set_error(e)
-      ensure
-        call_block(&block)
-      end
-    end
-
-    def run!(&block)
-      begin
-        initialize_service
-        run_service!
-      rescue StandardError => e
-        set_successful(false)
-        set_error(e)
-        raise e
-      end
-    end
-
-    def params=(params)
-      @params = params
-    end
-
-    def associated_params=(params)
-      @associated_params = params
-    end
-
-    def params
-      @params
-    end
-
-    def associated_params
-      @associated_params
-    end
-
-    def param_for(key)
-      if @params
-        @params[key]
-      end
-    end
-
-    def associated_param_for(key)
-      if @associated_params
-        @associated_params[key]
-      end
-    end
-
-    def succeeded?
-      (@successful && !has_errors? )
-    end
-
-    def failed?
-      !succeeded?
-    end
-
-    def success(&block)
-      if succeeded?
-        yield
-      end
-    end
-
-    def failure(&block)
-      if failed?
-        yield
-      end
-    end
-
-    def object
-      @object
-    end
-
-    def errors
-      @errors
-    end
-
-    def has_errors?
-      @errors && @errors.length > 0
-    end
-
-    protected
-
-    def initialize_service
-
-    end
-
-    def run_service
-      @successful = true
-    end
-
-    def run_service!
-      @successful = true
-    end
-
-    def set_error(error)
-      if !@errors
-        @errors = []
-      end
-
-      @errors << error
-    end
-
-    def set_successful(successful = true)
-      @successful = successful
-    end
-
-    private
-
-    def call_block(&block)
-      if block_given?
-        yield(self)
-      end
-    end
-  end
-end

data/lib/rails/create.rb

@@ -1,55 +0,0 @@
-module BBServices
-  module Rails
-
-    ##
-    # This class handles the creation of a resource with the purpose of being
-    # used in a 'create' controller action
-    class Create < New
-
-      protected
-
-      ##
-      # Allows functionality to be added before the save of the object
-      def before_save
-
-      end
-
-      ##
-      # Saves the object. When overridden should save the @object to the database
-      def save
-        @successful = @object.save
-        @errors = @object.errors
-      end
-
-      def save!
-        @successful = @object.save!
-      end
-
-      def after_save(success)
-
-      end
-
-      ##
-      # Runs the service. This involves calling internal_build, before_save,
-      # save, after_save
-      def run_service
-        internal_save {
-          save
-        }
-      end
-
-      def run_service!
-        internal_save {
-          save!
-        }
-      end
-
-      def internal_save
-        internal_build
-        before_save
-        yield
-        after_save(@successful)
-      end
-    end
-  end
-end

data/lib/rails/create_transactioned.rb

@@ -1,26 +0,0 @@
-module BBServices
-  module Rails
-    class CreateTransactioned < Create
-
-      ##
-      #
-      def run_service
-        service_class.transaction {
-          internal_save {
-            save
-          }
-        }
-      end
-
-      ##
-      #
-      def run_service!
-        service_class.transaction {
-          internal_save {
-            save!
-          }
-        }
-      end
-    end
-  end
-end

data/lib/rails/new.rb

@@ -1,45 +0,0 @@
-module BBServices
-  module Rails
-
-    ##
-    # This class handles the building of a resource with the purpose of being
-    # used in a 'new' controller action
-    class New < Service
-
-      protected
-
-      def initialize_service
-        @object = service_class.new
-      end
-
-      def before_build
-
-      end
-
-      def build
-        if @params
-          @object.assign_attributes(@params)
-        end
-      end
-
-      def after_build
-
-      end
-
-      def run_service
-        internal_build
-        @successful = true
-      end
-
-      def run_service!
-        run_service
-      end
-
-      def internal_build
-        before_build
-        build
-        after_build
-      end
-    end
-  end
-end

data/lib/rails/service.rb

@@ -1,13 +0,0 @@
-module BBServices
-  module Rails
-
-    ##
-    # This class acts as the base class for all Rails / ActiveRecord variants
-    # of the Service Class
-    class Service < BBServices::Service
-      def resource
-        @object
-      end
-    end
-  end
-end