methodist 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1231c5c1338d3a4f5c7db47db5ab36cdd4d032f4eb97ad10e50798397e4580
-  data.tar.gz: 9c1afa1729571899206394d775f96ba25366f5c9565b43d55fe80c9c3f7f8edf
+  metadata.gz: 8909b4add4a45e3fda7ea10e4cd92ab6a503cbda5e3397a0a1b912e4aeae32a8
+  data.tar.gz: 6c1e6d01009d2994e9c1cd924dda27e5fea0f27110d80b483d8dc1f79cef7193
 SHA512:
-  metadata.gz: 9fcb1943a5af08b284ab7fc16c74d78949a466f2e1a8dca4f910ca8d8c2e883848137e9fbe2d6cf04ee55148b36efced176770f68dc9a0ef120f63b11c95fe26
-  data.tar.gz: 1d09ecd42b89e86c0c7362987ee23809100e9c70e9d83fd7cac1e4bea4963493db50bb50573ab118ae150f843cebe55fd6b3d64eb4a1c73ee0fdd4b6a360d2af
+  metadata.gz: 8880e409b413e2e723d4a5cfb5a6dd8c74ced275b5f2be74134e47a79d7f5b76472248f35d94ccf3e8089b9a2d19b023de59a4d24e4b194a62f08d1431a3db22
+  data.tar.gz: 2863ebad51d939d3116f13c6075a7960201206609787b1e9c87aef7d8141608bfcac7d8ab9d18cfd38c0fede351e26b9fa04f4f30065fbee7e00fc7fed9defcb

data/README.md

@@ -6,10 +6,15 @@
 Methodist - a gem for Ruby on Rails created to stop chaos in your buisness logic.
 This gem adds generators to your rails application using some patterns:
 
-- __Interactor__: a class for doing some complex job.
+- __Interactor__: a class for doing some complex job step by step.
 - __Observer__: notifies one part of an application about changes in another part of an application.
 - __Builder__: is used to create an object with complex configuration (including your business logic, validation etc.)
-- __Service__: a class with collection of methods. Useful when using internal services.
+- __Client__: a class with implements methods for external services (databases, APIs and etc). 
+For example, class called TelegramApiClient will implements methods for HTTP requests to 
+telegram API.
+- __Service__: a class which encapsulates some business logic in semantic module. 
+For example, class called NotificationService - implement methods for notifications. 
+Or CacheService - implement methods for caching. 
 
 
 ## Installation

data/lib/generators/client/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generator for creating a Client class based on Methodist::Client
+
+Example:
+    rails generate client Client
+
+    This will create:
+        app/clients/client.rb
+        spec/clients/client_spec.rb

data/lib/generators/client/client_generator.rb

@@ -0,0 +1,28 @@
+require_relative '../methodist_generator'
+
+class ClientGenerator < MethodistGenerator
+  desc 'Create client'
+  source_root File.expand_path('templates', __dir__)
+
+  PATTERN_FOLDER     = 'clients'.freeze
+  TEMPLATE_FILE      = 'client.erb'.freeze
+  TEMPLATE_SPEC_FILE = 'client_spec.erb'.freeze
+
+  class_option 'path',  type: :string,  desc: "Parent module for a new client", default: PATTERN_FOLDER
+
+  def generate
+    template(
+      TEMPLATE_FILE,
+      "#{filename_with_path}_client.rb"
+    )
+  end
+
+  def generate_spec
+    return unless rspec_used?
+    template(
+      TEMPLATE_SPEC_FILE,
+      "#{filename_with_path(prefix: 'spec')}_client_spec.rb"
+    )
+  end
+end
+

data/lib/generators/client/templates/client.erb

@@ -0,0 +1,10 @@
+<%- unless options['clean'] -%>
+# See docs to learn how to use client:
+# https://github.com/QNester/methodist/tree/master/docs/client.md
+<% end -%>
+class <%= name.camelcase %>Client < Methodist::Client
+  <%- unless options['clean'] -%>
+  # Use the `client` method to define your client.
+  # Example: client Redis.new(Settings.redis.to_hash)
+  <%- end -%>
+end

data/lib/generators/client/templates/client_spec.erb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= name.camelcase %>Client do
+  it 'test your client'
+end

data/lib/generators/service/USAGE

@@ -1,9 +1,9 @@
 Description:
-    Generator for creating a Service class based on Methodist::Service
+    Generator for creating a Client class based on Methodist::Client
 
 Example:
-    rails generate builder Service
+    rails generate client Client
 
     This will create:
-        app/builders/service.rb
-        spec/builders/service_spec.rb
+        app/clients/client.rb
+        spec/clients/client_spec.rb

data/lib/generators/service/templates/service.erb

@@ -1,8 +1,8 @@
 <%- unless options['clean'] -%>
-# See docs to learn how to use service:
-# https://github.com/QNester/methodist/tree/master/docs/service.md
+# See docs to learn how to use client:
+# https://github.com/QNester/methodist/tree/master/docs/client.md
 <% end -%>
-class <%= name.camelcase %>Service < Methodist::Service
+class <%= name.camelcase %>Client < Methodist::Client
   <%- unless options['clean'] -%>
   # Use the `client` method to define your client.
   # Example: client Redis.new(Settings.redis.to_hash)

data/lib/generators/service/templates/service_spec.erb

@@ -1,5 +1,5 @@
 require 'rails_helper'
 
-RSpec.describe <%= name.camelcase %>Service do
-  it 'test your service'
+RSpec.describe <%= name.camelcase %>Client do
+  it 'test your client'
 end

data/lib/methodist.rb

@@ -4,7 +4,7 @@ require 'methodist/pattern'
 require 'methodist/interactor'
 require 'methodist/observer'
 require 'methodist/builder'
-require 'methodist/service'
+require 'methodist/client'
 
 module Methodist
 end

data/lib/methodist/client.rb

@@ -0,0 +1,27 @@
+require_relative 'pattern'
+
+##
+# == Methodist::Observer
+# Base class for Methodist clients
+#
+#
+class Methodist::Client < Methodist::Pattern
+  attr_reader :client
+
+  class << self
+    attr_reader :base_client
+
+    def client(base_client)
+      @base_client = base_client
+    end
+  end
+
+  ##
+  # Instance method use to get defined client
+  ##
+  def client
+    @client ||= self.class.base_client
+  end
+
+  class ResponseError < StandardError; end
+end

data/lib/methodist/interactor.rb

@@ -13,9 +13,8 @@ class Methodist::Interactor < Methodist::Pattern
 
   attr_accessor :validation_result
 
-  SCHEMA_CONST = 'SCHEMA'
-
   class << self
+    attr_reader :input_schema
     ##
     # Method set Dry::Validation schema for an interactor.
     #
@@ -40,7 +39,7 @@ class Methodist::Interactor < Methodist::Pattern
     ##
     def schema(&block)
       if block_given?
-        const_set SCHEMA_CONST, Dry::Validation.Schema(&block)
+        @input_schema = Dry::Validation.Schema(&block)
       else
         raise SchemaDefinitionError, 'You must pass block to `schema`'
       end
@@ -85,15 +84,18 @@ class Methodist::Interactor < Methodist::Pattern
   def validate(input)
     input = {} unless input
     raise InputClassError, 'If you want to use custom #validate, you have to pass a hash to an interactor' unless input.is_a?(Hash)
-    schema = self.class.const_get SCHEMA_CONST rescue nil
-    raise SchemaDefinitionError, 'You have to define a schema with #schema method' unless schema
-    @validation_result = schema.call(input)
+    raise SchemaDefinitionError, 'You have to define a schema with #schema method' unless input_schema
+    @validation_result = input_schema.call(input)
     return Success(validation_result.to_h) if validation_result.success?
     Failure(failure_validation_value)
   end
 
   private
 
+  def input_schema
+    @input_schema ||= self.class.input_schema rescue nil
+  end
+
   ##
   # Method for validation input of interactor parameters.
   ##

data/lib/methodist/observer.rb

@@ -4,9 +4,9 @@
 #
 #
 class Methodist::Observer < Methodist::Pattern
-  CONST_EXECUTION_BLOCK = 'EXEC_BLOCK'.freeze
-
   class << self
+    attr_reader :execution_block
+
     ##
     # Subscribe to the instance method of the klass to observe
     #
@@ -99,7 +99,7 @@ class Methodist::Observer < Methodist::Pattern
     # +ExecuteBlockWasNotDefined+ - when no block was passed to the execute method in the observer class
     ##
     def trigger!(klass, method_name, result, *args)
-      block = const_get(CONST_EXECUTION_BLOCK) rescue nil
+      block = execution_block rescue nil
       raise ExecuteBlockWasNotDefined, "You must define execute block in your #{self.name}" unless block
       block.call(klass, method_name, result, *args)
     end
@@ -108,7 +108,7 @@ class Methodist::Observer < Methodist::Pattern
     # Method for passing execution block for execution after observed method
     ##
     def execute(&block)
-      const_set(CONST_EXECUTION_BLOCK, block)
+      @execution_block = block
     end
 
     def observed_methods

data/lib/methodist/service.rb

@@ -1,27 +1,4 @@
-require_relative 'pattern'
+require_relative 'client'
 
 class Methodist::Service < Methodist::Pattern
-  CONST_CLIENT = 'CLIENT'
-
-  class << self
-    ##
-    # Define client for service
-    #
-    # ==== Parameters
-    # * +client_instance+ [Instance of client klass] - Instance of client class.
-    # It could be different clients like redis, elastic, internal api etc.
-    ##
-    def client(client_instance)
-      const_set(CONST_CLIENT, client_instance)
-    end
-  end
-
-  ##
-  # Instance method use to get defined client
-  ##
-  def client
-    @client ||= self.class.const_get(CONST_CLIENT) #rescue nil
-  end
-
-  class ResponseError < StandardError; end
 end

data/lib/methodist/version.rb

@@ -1,3 +1,3 @@
 module Methodist
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: methodist
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sergey Nesterov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,7 +110,7 @@ dependencies:
         version: '2.9'
 description: "Methodist - a gem for Ruby on Rails created to stop chaos in your business
   logic. This gem adds generators to your rails application using some patterns: interactor,
-  builder, observer and service. Just use `rails g <pattern> <new_class_name>`. \nDocs:
+  builder, observer and client. Just use `rails g <pattern> <new_class_name>`. \nDocs:
   https://github.com/QNester/methodist/wiki"
 email:
 - qnesterr@gmail.com
@@ -125,6 +125,10 @@ files:
 - lib/generators/builder/builder_generator.rb
 - lib/generators/builder/templates/builder.erb
 - lib/generators/builder/templates/builder_spec.erb
+- lib/generators/client/USAGE
+- lib/generators/client/client_generator.rb
+- lib/generators/client/templates/client.erb
+- lib/generators/client/templates/client_spec.erb
 - lib/generators/interactor/USAGE
 - lib/generators/interactor/interactor_generator.rb
 - lib/generators/interactor/templates/interactor.erb
@@ -139,6 +143,7 @@ files:
 - lib/generators/service/templates/service_spec.erb
 - lib/methodist.rb
 - lib/methodist/builder.rb
+- lib/methodist/client.rb
 - lib/methodist/interactor.rb
 - lib/methodist/observer.rb
 - lib/methodist/pattern.rb