methodist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 229590fd037e63ac5773c8a8e11c9ef451d3d01a5cc417c6e97c6c62fe5f30dc
+  data.tar.gz: acaaf7d57b19ab0b440fb132a43d85bbed2fd838027d2befef5e9d77329dfca2
+SHA512:
+  metadata.gz: 71f861ed48e4a2a390c78c570207ea9ef7fdc00989c383a7dcaec373c951a8a8cef9e165ae8d37bc6b78af50d7bee1edd88e47d9b0f865d39e32b2019d3a9f73
+  data.tar.gz: ed50190b816143494934cb50018f04e3f88a2e5e8f147bc34956bc7c1c3211a6643dab95f4d85b3d93d0f14a5030d93a7013deb05d9a18d54e6423960e5c1688

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Sergey Nesterov
+
+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,56 @@
+# Methodist
+[![Build Status](https://travis-ci.org/QNester/methodist.svg?branch=master)](https://travis-ci.org/QNester/methodist)
+[![Maintainability](https://api.codeclimate.com/v1/badges/eebe37d3169041579416/maintainability)](https://codeclimate.com/github/QNester/methodist/maintainability)
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gem-methodist/methodist?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+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.
+- __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.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'methodist'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself:
+```bash
+$ gem install methodist
+```
+
+## Usage
+Just execute in a terminal
+```
+rails g <pattern_name> <generated_class>
+```
+where _<pattern_name>_ is one of the patterns (observer, interactor, etc.)
+
+About every Methodist pattern you can read [here](https://github.com/QNester/methodist/wiki)
+
+## Contributing
+To contribute just:
+1) Create issue. Issue should contain information about goals of your
+ future changes.
+2) Fork project.
+3) Create branch. The name of the branch should begin with the ID of your issue.
+Examle: `ISSUE-205-create-new-pattern-generator`.
+4) Make changes.
+5) *Write tests*.
+6) Make a commit. The name of the commit should begin with the ID of your issue.
+Examle: `[ISSUE-205] Create new pattern generator`.
+7) Push.
+8) Create a pull request to the `develop` branch.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+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    = 'Methodist'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/generators/builder/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generator for creating a Builder class based on Methodist::Builder
+
+Example:
+    rails generate builder Thing
+
+    This will create:
+        app/builders/thing.rb
+        spec/builders/thing_spec.rb

data/lib/generators/builder/builder_generator.rb

@@ -0,0 +1,27 @@
+require_relative '../methodist_generator'
+
+class BuilderGenerator < MethodistGenerator
+  desc 'Create a builder'
+  source_root File.expand_path('templates', __dir__)
+
+  PATTERN_FOLDER     = 'builders'.freeze
+  TEMPLATE_FILE      = 'builder.erb'.freeze
+  TEMPLATE_SPEC_FILE = 'builder_spec.erb'.freeze
+
+  class_option 'path',  type: :string,  desc: "Parent module for a new builder", default: PATTERN_FOLDER
+
+  def generate
+    template(
+      TEMPLATE_FILE,
+      "#{filename_with_path}_builder.rb"
+    )
+  end
+
+  def generate_spec
+    template(
+      TEMPLATE_SPEC_FILE,
+      "#{filename_with_path(prefix: 'spec')}_builder_spec.rb"
+    )
+  end
+end
+

data/lib/generators/builder/templates/builder.erb

@@ -0,0 +1,10 @@
+<%- unless options['clean'] -%>
+# See docs to understand how to use a builder:
+# https://github.com/QNester/methodist/tree/master/docs/builder.md
+<% end -%>
+class <%= name.camelcase %>Builder < Methodist::Builder
+  <%- unless options['clean'] -%>
+  # Use `field` method to define a builder attribute.
+  # Example: field :title, ->(val) { val.is_a?(String) }
+  <%- end -%>
+end

data/lib/generators/builder/templates/builder_spec.erb

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

data/lib/generators/interactor/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generator for creating a Interactor class based on Methodist::Interactor
+
+Example:
+    rails generate interactor Thing
+
+    This will create:
+        app/interactors/thing.rb
+        spec/interactors/thing_spec.rb

data/lib/generators/interactor/interactor_generator.rb

@@ -0,0 +1,28 @@
+require_relative '../methodist_generator'
+
+class InteractorGenerator < MethodistGenerator
+  desc 'Create an interactor'
+  source_root File.expand_path('templates', __dir__)
+
+  PATTERN_FOLDER     = 'interactors'.freeze
+  TEMPLATE_FILE      = 'interactor.erb'.freeze
+  TEMPLATE_SPEC_FILE = 'interactor_spec.erb'.freeze
+
+  class_option 'skip-validations', type: :boolean, desc: "Skip validations in generated files", default: false
+  class_option 'path',  type: :string,  desc: "Parent module for a new interactor", default: PATTERN_FOLDER
+
+  def generate
+    template(
+      TEMPLATE_FILE,
+      "#{filename_with_path}.rb"
+    )
+  end
+
+  def generate_spec
+    template(
+      TEMPLATE_SPEC_FILE,
+      "#{filename_with_path(prefix: 'spec')}_spec.rb"
+    )
+  end
+end
+

data/lib/generators/interactor/templates/interactor.erb

@@ -0,0 +1,22 @@
+<% unless options['clean'] -%>
+# Methodist interactors use dry-transaction.
+# Check docs here: https://github.com/dry-rb/dry-transaction
+<% end -%>
+class <%= name.camelcase %> < Methodist::Interactor
+  <% unless options['skip-validations'] %>
+  # See here the syntax for validation http://dry-rb.org/gems/dry-validation/
+  schema do
+    # required(:name).value(:str?)
+  end
+  <% end %>
+  <% unless options['clean'] -%>
+  # Use your step, tee, try or map
+  # More info: http://dry-rb.org/gems/dry-transaction/step-adapters/
+  <% end -%>
+  <%- unless options['skip-validations'] %>
+  step :validate
+  <%- end -%>
+  <%- unless options['clean'] -%>
+  # step :do_something
+  <%- end %>
+end

data/lib/generators/interactor/templates/interactor_spec.erb

@@ -0,0 +1,31 @@
+require 'rails_helper'
+
+RSpec.describe <%= name.camelcase %> do
+  subject { described_class.new.call(input) }
+
+  <%- unless options['skip-validations'] %>
+  context 'valid input' do
+    let!(:input) do
+      <%- unless options['clean'] %>
+      # valid input for your interactor
+      <%- end %>
+    end
+
+    it 'returns success result' do
+      expect(subject).to be_success
+    end
+  end
+
+  context 'invalid input' do
+    let!(:input) do
+      <%- unless options['clean'] %>
+      # failure input for yout interactor
+      <%- end %>
+    end
+
+    it 'returns success result' do
+      expect(subject).to be_failure
+    end
+  end
+  <%- end -%>
+end

data/lib/generators/methodist_generator.rb

@@ -0,0 +1,18 @@
+class MethodistGenerator < Rails::Generators::NamedBase
+  DEFAULT_PREFIX = 'app'.freeze
+
+  class_option 'clean',  type: :boolean, desc: "Skip comments and annotations in generated files", default: false
+  class_option 'in-lib', type: :boolean, desc: "Create files in lib path, not in app", default: false
+
+  private
+
+  def filename_with_path(prefix: DEFAULT_PREFIX)
+    prefix = 'lib' if options['in-lib'] && prefix != 'spec'
+    prefix = 'spec/lib' if options['in-lib'] && prefix == 'spec'
+
+    name_as_arr = name.split('/')
+    path = name_as_arr.first(name_as_arr.size - 1).join('/')
+    name = name_as_arr.last
+    "#{prefix}/#{options['path']}/#{path}/#{name}"
+  end
+end

data/lib/generators/observer/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate a new observer
+
+Example:
+    rails generate observer Notification
+
+    This will create:
+        config/initializers/observers/notification_observer.rb
+        spec/observers/initialized/notification_observer_spec.rb

data/lib/generators/observer/observer_generator.rb

@@ -0,0 +1,22 @@
+require_relative '../methodist_generator'
+
+class ObserverGenerator < MethodistGenerator
+  desc 'Create an observer'
+  source_root File.expand_path('templates', __dir__)
+
+  PATTERN_FOLDER = 'observers'.freeze
+  TEMPLATE_FILE = 'observer.erb'.freeze
+  TEMPLATE_SPEC_FILE = 'observer_spec.erb'.freeze
+  DEFAULT_PREFIX = 'config/initializers'.freeze
+
+  class_option 'skip-validations', type: :boolean, desc: "Skip validations in generated files", default: false
+  class_option 'path',  type: :string,  desc: "Parent module for new a interactor", default: PATTERN_FOLDER
+
+  def generate
+    template(
+      TEMPLATE_FILE,
+      "#{filename_with_path(prefix: DEFAULT_PREFIX)}_observer.rb"
+    )
+  end
+end
+

data/lib/generators/observer/templates/observer.erb

@@ -0,0 +1,13 @@
+class <%= name.camelcase %>Observer < Methodist::Observer
+  # observe Klass, :instance_method
+
+  execute do |klass, instance_method|
+    # Write here actions you want to trigger
+    # Example:
+    #     CounterService.new.increment("#{klass.downcase.demodulize}_instance_method")
+  end
+
+  class << self
+    # Define here any methods you want to use in the execute block.
+  end
+end

data/lib/generators/service/USAGE

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

data/lib/generators/service/service_generator.rb

@@ -0,0 +1,27 @@
+require_relative '../methodist_generator'
+
+class ServiceGenerator < MethodistGenerator
+  desc 'Create service'
+  source_root File.expand_path('templates', __dir__)
+
+  PATTERN_FOLDER     = 'services'.freeze
+  TEMPLATE_FILE      = 'service.erb'.freeze
+  TEMPLATE_SPEC_FILE = 'service_spec.erb'.freeze
+
+  class_option 'path',  type: :string,  desc: "Parent module for a new service", default: PATTERN_FOLDER
+
+  def generate
+    template(
+      TEMPLATE_FILE,
+      "#{filename_with_path}_service.rb"
+    )
+  end
+
+  def generate_spec
+    template(
+      TEMPLATE_SPEC_FILE,
+      "#{filename_with_path(prefix: 'spec')}_service_spec.rb"
+    )
+  end
+end
+

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

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

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

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

data/lib/methodist.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+require "methodist/railtie"
+require 'methodist/pattern'
+require 'methodist/interactor'
+require 'methodist/observer'
+require 'methodist/builder'
+require 'methodist/service'
+
+module Methodist
+end

data/lib/methodist/builder.rb

@@ -0,0 +1,100 @@
+require_relative 'pattern'
+
+class Methodist::Builder < Methodist::Pattern
+  class << self
+    def attr_accessor(*args)
+      @attributes ||= []
+      @attributes += args
+      @attributes.uniq!
+      super(*args)
+    end
+
+    ##
+    # Define attribute and set validation for value
+    #
+    # ==== Parameters
+    # * +attr_name+ [String] - name of defined attribute
+    # * +proc+ [Proc] - proc for validate contains value. If proc call result
+    # will returns true then #valid_attr? will returns true.
+    #
+    ##
+    def field(attr_name, proc = nil)
+      attr_accessor(attr_name)
+      set_proc_to_const(proc, attr_name) if proc
+    end
+
+    ##
+    # Define multiple attributes and set validation for values
+    #
+    # ==== Parameters
+    # * +attr_names+ [Args] - name of defined attribute
+    # * +proc+ [Proc] - proc for validate contains values.
+    #
+    ##
+    def fields(*attr_names, &block)
+      attr_names.each { |attr_name| field(attr_name, &block) }
+    end
+
+    ##
+    # Array of defined attributes
+    ##
+    def attributes
+      @attributes || []
+    end
+
+    alias_method :attrs, :attributes
+
+    def set_proc_to_const(proc, attr_name)
+      const_set(proc_const_name(attr_name), proc)
+    end
+
+    def proc_const_name(attr_name)
+      "VALIDATION_PROC_#{attr_name.upcase}"
+    end
+  end
+
+  ##
+  # Convert attributes and values to hash.
+  #
+  # ==== Example
+  #   In builder with attributes 'title', 'author'
+  #   when you will use this method you will have:
+  #   { title: 'Title', author: 'Author' }
+  ##
+  def to_h
+    hash = {}
+    self.class.attributes.each do |att|
+      hash[att] = self.send(att)
+    end
+    hash
+  end
+
+  alias_method :to_hash, :to_h
+
+  ##
+  # Validate all attributes.
+  ##
+  def valid?
+    self.class.attributes.all? { |att| valid_attr?(att) }
+  end
+
+  ##
+  # Validate attribute value.
+  # Proc passed in #field method use for validation.
+  # If proc was not defined just return true.
+  #
+  # ==== Parameters
+  # * +attr_name+ [String/Symbol] - name of attribute
+  ##
+  def valid_attr?(attr_name)
+    proc = get_proc(attr_name)
+    return true if proc.nil?
+    proc.call(self.send(attr_name))
+  end
+
+  private
+
+  def get_proc(attr_name)
+    self.class.const_get(self.class.proc_const_name(attr_name)) # rescue nil
+  end
+end

data/lib/methodist/interactor.rb

@@ -0,0 +1,112 @@
+require "dry/transaction"
+require "dry/validation"
+
+##
+# == Methodist::Interactor
+# Base class for a Methodist interactor.
+#
+# Methodist::Interactor dependency from dry-rb transactions and dry-rb validations
+#
+#
+class Methodist::Interactor < Methodist::Pattern
+  include Dry::Transaction
+
+  attr_accessor :validation_result
+
+  SCHEMA_CONST = 'SCHEMA'
+
+  class << self
+    ##
+    # Method set Dry::Validation schema for an interactor.
+    #
+    # Receive block for generating Dry::Validation schema
+    # result.
+    #
+    #   class InteractorClass < Methodist::Interactor
+    #     schema do
+    #       required(:name).value(:str?)
+    #     end
+    #
+    #     step :validate
+    #   end
+    #
+    #   InteractorClass.new.call(name: nil) #=> Failure(ValidationError)
+    #
+    #
+    # ==== See
+    # http://dry-rb.org/gems/dry-validation/
+    #
+    # https://github.com/dry-rb/dry-transaction
+    ##
+    def schema(&block)
+      if block_given?
+        const_set SCHEMA_CONST, Dry::Validation.Schema(&block)
+      else
+        raise SchemaDefinitionError, 'You must pass block to `schema`'
+      end
+    end
+  end
+
+  ##
+  # Method for validation input of interactor parameters.
+  #
+  # ==== Parameters
+  # * +input+ [Hash] - parameters for interactor
+  #
+  # ==== Example
+  #
+  #   # app/interactors/interactor_class.rb
+  #   class InteractorClass < Methodist::Interactor
+  #     schema do
+  #       required(:name).value(:str?)
+  #     end
+  #
+  #     step :validate
+  #   end
+  #
+  #   # your controller action
+  #   def create
+  #     result = InteractorClass.new.call(name: nil) #=> Failure(ValidationError)
+  #     raise InteractorError, result.value if result.failure?
+  #   end
+  #
+  # ==== Return
+  # * +Dry::Monads::Result::Success+ - success result of interactor step
+  # * +Dry::Monads::Result::Failure+  - failure result of interactor step
+  #
+  # ==== Raise
+  # * +SchemaDefinitionError+  - raise if method was called without a schema definition
+  #
+  #
+  # ==== Attention
+  # You can redefine failure_validation_value for a custom
+  # value returning in case of validation Failure
+  ##
+  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)
+    return Success(validation_result.to_h) if validation_result.success?
+    Failure(failure_validation_value)
+  end
+
+  private
+
+  ##
+  # Method for validation input of interactor parameters.
+  ##
+  def failure_validation_value
+    field = validation_result.errors.keys.first
+    {
+      error: 'ValidationError',
+      field: field,
+      reason: "#{field}: #{validation_result.errors[field].first}"
+    }
+  end
+
+
+  class SchemaDefinitionError < StandardError; end
+  class InputClassError < StandardError; end
+end

data/lib/methodist/observer.rb

@@ -0,0 +1,131 @@
+##
+# == Methodist::Observer
+# Base class for Methodist observers
+#
+#
+class Methodist::Observer < Methodist::Pattern
+  CONST_EXECUTION_BLOCK = 'EXEC_BLOCK'.freeze
+
+  class << self
+    ##
+    # Subscribe to the instance method of the klass to observe
+    #
+    # ==== Parameters
+    # * +klass+ [Class] - The owner of the method for observation
+    # * +method_name+ [String/Symbol] - Observation method name
+    #
+    # ===== Options
+    # * +skip_if+ [Proc] - Skip triggered execution if condition is true
+    #
+    # ==== Yield
+    # main_block - execution block. If this block was passed,
+    # `#execute` block will be ignored
+    #
+    ##
+    def observe(klass, method_name, skip_if: nil, &main_block)
+      method_name = method_name.to_sym
+      original_method = klass.instance_method(method_name)
+      method_observe = observer_method(method_name)
+      method_dump = method_dump(method_name)
+      me = self
+
+      return false if method_defined?(klass, method_dump)
+
+      klass.send(:alias_method, method_dump, method_name) # dump method
+
+      observer_method_proc = -> (*args, &block) do
+        result = original_method.bind(self).call(*args, &block)
+        unless skip_if.nil?
+          return if skip_if.call(result)
+        end
+        if block_given?
+          main_block.call(klass, method_name)
+        else
+          me.trigger!(klass, method_name)
+        end
+        result # return the result of the original method
+      end
+
+      klass.send(:define_method, method_observe, observer_method_proc)
+
+      klass.send(:alias_method, method_name, method_observe) # redefine the original method
+      add_observed(klass, method_name)
+      true
+    end
+
+    ##
+    # Stop observation instance method of klass for observe
+    #
+    # ==== Parameters
+    # * +klass+ [Class] - Klass owner of the observed method
+    # * +method_name+ [String/Symbol] - Name of the observed method
+    ##
+    def stop_observe(klass, method_name)
+      method_observe = observer_method(method_name)
+      method_dump = method_dump(method_name)
+      return false unless method_defined?(klass, method_observe) && method_defined?(klass, method_dump)
+
+      klass.send(:alias_method, method_name, method_dump) # restore dumped method
+      klass.send(:remove_method, method_observe) # remove observed method
+      klass.send(:remove_method, method_dump) # remove dump method
+      remove_from_observed(klass, method_name)
+      true
+    end
+
+    ##
+    # The executable block is passed to #execute
+    # Parameters *klass* and *method_name* are passed to block call
+    #
+    # ==== Parameters
+    # * +klass+ [Class] - Klass owner of the observed method
+    # * +method+ [Class] - Name of the observed method
+    #
+    # ===== Raise
+    # +ExecuteBlockWasNotDefined+ - when no block was passed to the execute method in the observer class
+    ##
+    def trigger!(klass, method_name)
+      block = const_get(CONST_EXECUTION_BLOCK) rescue nil
+      raise ExecuteBlockWasNotDefined, "You must define execute block in your #{self.name}" unless block
+      block.call(klass, method_name)
+    end
+
+    ##
+    # Method for passing execution block for execution after observed method
+    ##
+    def execute(&block)
+      const_set(CONST_EXECUTION_BLOCK, block)
+    end
+
+    def observed_methods
+      @observed_method ||= []
+    end
+
+    private
+
+    def observer_method(method)
+      "#{method}_observer"
+    end
+
+    def method_dump(method)
+      "#{method}_dump"
+    end
+
+    def klass_with_method(klass, method)
+      "#{klass}##{method}"
+    end
+
+    def method_defined?(klass, method)
+      klass.instance_methods(false).include?(method.to_sym)
+    end
+
+    def add_observed(klass, method_name)
+      observed_methods << klass_with_method(klass, method_name)
+    end
+
+    def remove_from_observed(klass, method_name)
+      observed_methods.delete(klass_with_method(klass, method_name))
+    end
+
+    class ExecuteBlockWasNotDefined < StandardError; end
+  end
+end

data/lib/methodist/pattern.rb

@@ -0,0 +1,5 @@
+class Methodist::Pattern
+  def methodistic?
+    true
+  end
+end

data/lib/methodist/railtie.rb

@@ -0,0 +1,4 @@
+module Methodist
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/methodist/service.rb

@@ -0,0 +1,27 @@
+require_relative 'pattern'
+
+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

@@ -0,0 +1,3 @@
+module Methodist
+  VERSION = '0.1.0'
+end

data/lib/tasks/methodist_tasks.rake

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

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: methodist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Nesterov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: dry-transaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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:
+  https://github.com/QNester/methodist/wiki"
+email:
+- qnesterr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/builder/USAGE
+- lib/generators/builder/builder_generator.rb
+- lib/generators/builder/templates/builder.erb
+- lib/generators/builder/templates/builder_spec.erb
+- lib/generators/interactor/USAGE
+- lib/generators/interactor/interactor_generator.rb
+- lib/generators/interactor/templates/interactor.erb
+- lib/generators/interactor/templates/interactor_spec.erb
+- lib/generators/methodist_generator.rb
+- lib/generators/observer/USAGE
+- lib/generators/observer/observer_generator.rb
+- lib/generators/observer/templates/observer.erb
+- lib/generators/service/USAGE
+- lib/generators/service/service_generator.rb
+- lib/generators/service/templates/service.erb
+- lib/generators/service/templates/service_spec.erb
+- lib/methodist.rb
+- lib/methodist/builder.rb
+- lib/methodist/interactor.rb
+- lib/methodist/observer.rb
+- lib/methodist/pattern.rb
+- lib/methodist/railtie.rb
+- lib/methodist/service.rb
+- lib/methodist/version.rb
+- lib/tasks/methodist_tasks.rake
+homepage: https://github.com/QNester/methodist
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Gem for Ruby on Rails created to stop chaos in your buisness logic.
+test_files: []