redispatcher 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a1dba3c146a45fc5d21299e409df5d8b860aa9b
-  data.tar.gz: ad10a86219e6f1fc18b7513f24d20f3256e088f9
+  metadata.gz: ac321b3304cf0535c40a2bc21d20c23b0981e574
+  data.tar.gz: e04b15f34501d6ed5167b8a7ba5651f68f15548f
 SHA512:
-  metadata.gz: 3b99d6b2df35ce4196a748ef9a39d65c901377008d31d6b7479004b1968c5d2fa8cc29d4bc3905a4a209e01865a660112431cdfda4e86da00ebed801b341d180
-  data.tar.gz: 29e17215b38690bc68d37171d61f18dc2f07fa9b27bcc577de76ab81e76f998d72b922db821c3dd3674edbdb649cfdc8e481bdc4bf562d698586241244390cb0
+  metadata.gz: 318f94952b648b182984ca067c673d1607bbe9404411ec046911f2936cfdb4cd6eceb67c66d0038af11e136e31ab67a076d17342a5be74331e24f15abce3299d
+  data.tar.gz: 1a88a9a9a5b43f80d0edd15e8ae65638d5cd596626f49d2e68763befcf63d84ebba93ebcfba6af126a6934a52ba166c6466ef20248e731d7c47d30968a1c123e

data/README.md

@@ -1,10 +1,12 @@
-![This is really cool dispatcher. However es6-dispatcher is really piece of crap](https://zhf.io/raw/p8IRct)
+![Redispatcher](https://zhf.io/raw/p8IRct)
 
 [![Gem Version](https://badge.fury.io/rb/redispatcher.svg)](http://badge.fury.io/rb/redispatcher)
 [![Code Climate](https://codeclimate.com/github/rambler-digital-solutions/redispatcher/badges/gpa.svg)](https://codeclimate.com/github/rambler-digital-solutions/redispatcher)
 [![Test Coverage](https://codeclimate.com/github/rambler-digital-solutions/redispatcher/badges/coverage.svg)](https://codeclimate.com/github/rambler-digital-solutions/redispatcher)
 
-Dispatch ActiveRecord objects to any structures with ease.
+This gem provides delivery of objects from database to any structure with power of callbacks.
+
+Supporting ORM is ActiveRecord and Sequel (through [sequel-rails](https://github.com/TalentBox/sequel-rails) gem)
 
 ## Installation
 
@@ -26,16 +28,24 @@ Or install it yourself as:
 
 ### Writing Dispatchers
 
-Dispatchers inherit from `Redispatcher::Dispatcher`, live in your `app/dispatchers` directory, and are named for the model that they dispatch:
+Dispatchers inherit from `Redispatcher::Dispatcher`, live in your `app/dispatchers` directory, and are named for the model that they dispatch.
+
+You can use rails generator to generate dispatcher:
+
+```
+rails g dispatcher Topic
+```
+
+This will create TopicDispatcher:
 
 ```ruby
 # app/dispatchers/topic_dispatcher.rb
 class TopicDispatcher < Redispatcher::Dispatcher
+  # ...
 end
 ```
 
-
-Do not hesitate to use dispatscher's callbacks `before_` and `after_` `initialize`, `process`, `commit`, `rollback` just like that:
+Do not hesitate to use dispatscher's callbacks `before_initialize`, `after_initialize`, `before_process`, `after_process`, `before_commit`, `after_commit`, `before_rollback`, `after_rollback` just like that:
 
 ```ruby
 # app/dispatchers/topic_dispatcher.rb
@@ -59,12 +69,22 @@ end
 
 ### Enable dispatcher for your model
 
+With ActiveRecord:
+
 ```ruby
 class Topic < ActiveRecord::Base
   dispatchable
 end
 ```
 
+With Sequel:
+
+```ruby
+class Topic < Sequel::Model
+  dispatchable
+end
+```
+
 ### Dispatch!
 
 Just call dispatch method on object you going to dispatch.
@@ -73,6 +93,10 @@ Just call dispatch method on object you going to dispatch.
 dispatched_topic = Topic.first.dispatch
 ```
 
+## License
+
+Redispatcher is licensed under the MIT license. See LICENSE for full license text.
+
 ## Contributing
 
 1. Fork it ( https://github.com/rambler-digital-solutions/redispatcher/fork )

data/lib/generators/rails/dispatcher_generator.rb

@@ -0,0 +1,24 @@
+module Rails
+  module Generators
+   class DispatcherGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      check_class_collision suffix: "Dispatcher"
+
+      class_option :parent, type: :string, desc: "The parent class for the generated dispatcher"
+
+      def create_dispatcher_file
+        template 'dispatcher.rb', File.join('app/dispatchers', class_path, "#{file_name}_dispatcher.rb")
+      end
+
+      hook_for :test_framework
+
+      private
+
+      def parent_class_name
+        options.fetch("parent") do
+          "Redispatcher::Dispatcher"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/dispatcher.rb

@@ -0,0 +1,29 @@
+<%- module_namespacing do -%>
+  <%- if parent_class_name.present? -%>
+class <%= class_name %>Dispatcher < <%= parent_class_name %>
+  <%- else -%>
+class <%= class_name %>
+  <%- end -%>
+  # Now define some callbacks, for example:
+  #
+  # after_initialize do
+  #   @processed_object = {}
+  # end
+  #
+  # before_process do
+  #   @processed_object.merge!(title: object.title, created_at: object.created_at)
+  # end
+  #
+  # after_commit do
+  #   File.open('/tmp/dispatcher.json', 'w') do
+  #     f.write(JSON.pretty_generate(processed_object))
+  #     f.close
+  #   end
+  #   object.update_attributes(dispatched_at: Time.now)
+  # end
+  #
+  # after_rollback do
+  #   puts 'Oh snap!'
+  # end
+end
+<% end -%>

data/lib/redispatcher.rb

@@ -5,31 +5,13 @@ require_relative 'redispatcher/dispatchable'
 require_relative 'redispatcher/callbacks'
 require_relative 'redispatcher/logger'
 require_relative 'redispatcher/dispatcher'
+require_relative 'redispatcher/dispatchable_method'
+require_relative 'redispatcher/railtie' if defined? Rails
 
 module Redispatcher
-end
-
-class << ActiveRecord::Base
-  def dispatchable(options = {})
-    # Check options
-    raise Redispatcher::DispatcherError.new("Options for dispatchable must be in a hash.") unless options.is_a? Hash
-    options.each do |key, value|
-      # No options yet
-      unless [:dispatcher_class].include? key
-        raise Redispatcher::DispatcherError.new("Unknown option for dispatchable: #{key.inspect} => #{value.inspect}.")
-      end
+  def self.setup_orm(base)
+    base.class_eval do
+      extend Redispatcher::DispatchableMethod
     end
-
-    include Redispatcher::Callbacks
-    define_dispatcher_callbacks :dispatch
-
-    include Redispatcher::Dispatchable
-
-    # Create dispatcher class accessor and set to option or default
-    #cattr_accessor :dispatcher_class
-    #self.dispatcher_class = option[:dispatcher_class]
-
-    after_commit :dispatch
   end
 end
-

data/lib/redispatcher/callbacks.rb

@@ -1,6 +1,7 @@
 module Redispatcher
   module Callbacks
     def self.included(base)
+      base.send(:include, ActiveSupport::Callbacks)
       base.extend(ClassMethods)
       base.send(:include, InstanceMethods)
     end

data/lib/redispatcher/dispatchable_method.rb

@@ -0,0 +1,23 @@
+module Redispatcher
+  module DispatchableMethod
+    def dispatchable(options = {})
+      # Check options
+      raise Redispatcher::DispatcherError.new("Options for dispatchable must be in a hash.") unless options.is_a? Hash
+      options.each do |key, value|
+        # No options yet
+        unless [:dispatcher_class].include? key
+          raise Redispatcher::DispatcherError.new("Unknown option for dispatchable: #{key.inspect} => #{value.inspect}.")
+        end
+      end
+
+      include Redispatcher::Callbacks
+      define_dispatcher_callbacks :dispatch
+
+      include Redispatcher::Dispatchable
+
+      # Create dispatcher class accessor and set to option or default
+      #cattr_accessor :dispatcher_class
+      #self.dispatcher_class = option[:dispatcher_class]
+    end
+  end
+end

data/lib/redispatcher/dispatcher.rb

@@ -44,21 +44,23 @@ module Redispatcher
     end
 
     class << self
+      attr_accessor :instance
+
       def dispatch(object, options={})
-        @dispatcher = new(object, options)
+        @instance = new(object, options)
 
         begin
-          @dispatcher.process
+          instance.process
         rescue DispatcherSuppressedError => e
-          log e
+          instance.log e
           return nil
         end
 
         begin
-          return @dispatcher.commit
+          return instance.commit
         rescue Exception => e
-          log e
-          @dispatcher.rollback
+          instance.log e
+          instance.rollback
           raise e
         end
       end

data/lib/redispatcher/logger.rb

@@ -3,7 +3,7 @@ module Redispatcher
     # Log a dispatcher-specific line. This will log to STDOUT
     # by default.
     # Set Dispatcher.options[:log] to false to turn off.
-    def log message
+    def log(message)
       logger.info("[redispatcher] #{message}") if logging?
     end
 

data/lib/redispatcher/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails/railtie'
+
+module Redispatcher
+  class Railtie < Rails::Railtie
+
+    config.after_initialize do |app|
+      app.config.paths.add 'app/dispatcher', eager_load: true
+    end
+
+    initializer "redispatcher.setup_orm" do |app|
+      [:active_record, :sequel].each do |orm|
+        ActiveSupport.on_load orm do
+          Redispatcher.setup_orm self
+        end
+      end
+    end
+  end
+end

data/redispatcher.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'redispatcher'
-  spec.version       = '0.0.2'
+  spec.version       = '0.0.3'
   spec.authors       = ['Sergey Besedin']
   spec.email         = ['kr3ssh@gmail.com']
   spec.summary       = %q{Gem to dispatch ActiveRecord objects to anywhere}
@@ -12,23 +12,29 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/rambler-digital-solutions/redispatcher'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version     = '>= 1.9'
+
   spec.files         = %w(
     Gemfile
     LICENSE.txt
     README.md
     Rakefile
+    lib/generators/rails/dispatcher_generator.rb
+    lib/generators/rails/templates/dispatcher.rb
     lib/redispatcher.rb
     lib/redispatcher/callbacks.rb
     lib/redispatcher/dispatchable.rb
+    lib/redispatcher/dispatchable_method.rb
     lib/redispatcher/dispatcher.rb
     lib/redispatcher/exceptions.rb
     lib/redispatcher/logger.rb
+    lib/redispatcher/railtie.rb
     redispatcher.gemspec
   )
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails'
+  spec.add_dependency 'rails', '>= 4.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redispatcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sergey Besedin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -63,12 +63,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rails/dispatcher_generator.rb
+- lib/generators/rails/templates/dispatcher.rb
 - lib/redispatcher.rb
 - lib/redispatcher/callbacks.rb
 - lib/redispatcher/dispatchable.rb
+- lib/redispatcher/dispatchable_method.rb
 - lib/redispatcher/dispatcher.rb
 - lib/redispatcher/exceptions.rb
 - lib/redispatcher/logger.rb
+- lib/redispatcher/railtie.rb
 - redispatcher.gemspec
 homepage: https://github.com/rambler-digital-solutions/redispatcher
 licenses:
@@ -82,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -90,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Gem to dispatch ActiveRecord objects to anywhere