operationable 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ade6d51c19fadefd0b41528d0f81f1da2ddbdf6
+  data.tar.gz: b890c49175142c5ed3067f407e52117dffbef8e5
+SHA512:
+  metadata.gz: 3466d1c15547a9b30dd3e32442f5bf2785c9255edd647681f2b7ce5126e7b7c3ff4ea1b82c4ce73dfe44f06048037b1212f10277dedac359862b20b2b92e3a43
+  data.tar.gz: f3ba44086bc63975640ae53b77f26b21bed05d649d7e8bcec466d96fa241e152b1e822fdef7ec3cb0cb430d7ae51adf411d65c1d148bc4b07b260e346fce535c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+- Inited

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rails", ">= 4.2.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kirill Suhodolov
+
+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,40 @@
+# Operationable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/operationable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'operationable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install operationable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/operationable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "operationable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/jobs/operation_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+class OperationJob < ActiveJob::Base
+  queue_as do
+    arguments.first[:queue]
+  end
+
+  def perform(options, props)
+    "Operationable::Runners::#{options[:type].capitalize}".constantize.call(options, props)
+  end
+
+  after_perform do
+    ActiveRecord::Base.clear_active_connections!
+    GC.start
+  end
+end

data/lib/operationable.rb

@@ -0,0 +1,23 @@
+require 'rails'
+require 'active_support/dependencies'
+
+require "operationable/version"
+
+require 'operationable/builder'
+require 'operationable/callback'
+require 'operationable/operation'
+require 'operationable/serializer'
+require 'operationable/specification'
+
+require 'operationable/runners/base'
+require 'operationable/runners/serial'
+require 'operationable/runners/separate'
+
+require 'jobs/operation_job'
+require 'operations/create'
+require 'operations/destroy'
+require 'operations/update'
+
+module Operationable
+
+end

data/lib/operationable/builder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Operationable
+  class Builder
+    attr_reader :record, :params
+
+    def initialize(record, params={})
+      @record = record
+      @params = params
+    end
+
+    def build
+      record
+    end
+  end
+end

data/lib/operationable/callback.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Operationable
+  class Callback
+    attr_reader :props
+
+    def initialize(props)
+      @props = props
+    end
+
+    def record
+      @record ||= props[:name].constantize.find(props[:id])
+    end
+
+    def user
+      @user ||= User.find(props[:changed_by_id])
+    end
+  end
+end

data/lib/operationable/operation.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Operationable
+  class Operation
+    attr_reader :record, :user, :params, :result
+
+    def initialize(record, user, params={})
+      @record = record
+      @user = user
+      @params = params
+    end
+
+    def process
+      return false unless valid
+
+      @result = build
+
+      return false unless persist
+
+      run
+
+      record.reload
+    end
+
+    private
+
+    def valid
+      true
+    end
+
+    def persist
+      record
+    end
+
+    def build
+      "#{class_name}::Builder".constantize.new(record, params).build
+    end
+
+    def run
+      "#{class_name}::Runner".constantize.new(record, params, result, user).run
+    end
+
+    def class_name
+      self.class.name
+    end
+  end
+end

data/lib/operationable/runners/base.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+module Operationable
+  module Runners
+    class Base
+      attr_reader :callbacks, :record, :user, :params, :result
+
+      def initialize(record, params, result, user)
+        @record = record
+        @params = params
+        @result = result
+        @user = user
+        @callbacks = []
+
+        initialize_callbacks
+      end
+
+      def run
+      end
+
+      private
+
+      def props
+        serializer_instance.serialize
+      end
+
+      def initialize_callbacks
+      end
+
+      def push_to_queue(callback_method_name, queue=nil)
+        callbacks << {
+          callback_method_name: callback_method_name.to_s,
+          queue: queue.to_s
+        }
+      end
+
+      def callback_names
+        check_callbacks.map { |callback| callback[:callback_method_name] }
+      end
+
+      def check_callbacks
+        callbacks.find_all do |callback|
+          satisfy = specification&.try("should_#{callback[:callback_method_name]}".to_sym)
+          satisfy.nil? || satisfy
+        end
+      end
+
+      def serializer_instance
+        serializer_class_name.constantize.new(record, user, params, result, activity, action_name)
+      end
+
+      def specification
+        @specification ||= specification_class_name.constantize.new(record, params, activity, action_name)
+      end
+
+      def callback_class_name
+        "#{operation_class_name}::Callback"
+      end
+
+      def serializer_class_name
+        "#{operation_class_name}::Serializer"
+      end
+
+      def specification_class_name
+        "#{operation_class_name}::Specification"
+      end
+
+      def operation_class_name
+        self.class.name.chomp('::Runner')
+      end
+
+      def activity
+        operation_class_name.split('::').last.underscore
+      end
+
+      def action_name
+        operation_class_name.split('::')[-2..-1].join(' ').titleize
+      end
+
+      def class_name
+        self.class.name
+      end
+
+      def perform_method
+        sync? ? :perform_now : :perform_later
+      end
+
+      def sync?
+        %w(test development).include? Rails.env
+      end
+    end
+  end
+end

data/lib/operationable/runners/separate.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Operationable
+  module Runners
+    class Separate < ::Operationable::Runners::Base
+      def run
+        check_callbacks.each { |callback| process(callback) }
+      end
+
+      def process(callback_method_name:, queue: nil)
+        (queue.blank? ? self.class : OperationJob.method(perform_method)).call(options(callback_method_name, queue), props)
+      end
+
+      def options(callback_method_name, queue)
+        { type: 'separate',
+          callback_class_name: callback_class_name,
+          callback_method_name: callback_method_name,
+          queue: queue }
+      end
+
+      def self.call(options, props)
+        options[:callback_class_name].constantize.new(props).method(options[:callback_method_name]).call
+      end
+    end
+  end
+end

data/lib/operationable/runners/serial.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Operationable
+  module Runners
+    class Serial < ::Operationable::Runners::Base
+      def run
+        process
+      end
+
+      def process
+        (queue.blank? ? self.class : OperationJob.method(perform_method)).call(options, props)
+      end
+
+      def self.call(options, props)
+        instance = options[:callback_class_name].constantize.new(props)
+        options[:callback_names].each { |method_name| instance.method(method_name).call }
+      end
+
+      def options
+        { type: 'serial',
+          callback_class_name: callback_class_name,
+          callback_names: callback_names,
+          queue: queue }
+      end
+
+      private
+
+      def queue
+        check_callbacks.first[:queue]
+      end
+    end
+  end
+end

data/lib/operationable/serializer.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+module Operationable
+  class Serializer
+    attr_reader :record, :user, :params, :result, :activity, :action_name
+
+    RECORD_FIELDS = [].freeze
+    USER_FIELDS = %i(id role email name).freeze
+
+    def initialize(record, user, params, result, activity, action_name)
+      @record = record
+      @user = user
+      @params = params
+      @result = result
+      @activity = activity
+      @action_name = action_name
+    end
+
+    def serialize
+      stringify_arguments(extract_props(record, user))
+    end
+
+    private
+
+    def extract_props(record, user)
+      { **extract_from_record(record), **extract_from_user(user), activity: activity, action_name: action_name }
+    end
+
+    def extract_from_record(record)
+      extracted_props = record_fields.each_with_object({}) do |field, result|
+        result[field] = record.try(field)
+        result
+      end
+
+      extracted_props[:name] = record.class.name
+
+      extracted_props
+    end
+
+    def extract_from_user(user)
+      user_fields.each_with_object({}) do |field, result|
+        result["changed_by_#{field}".to_sym] = user.try(field)
+        result
+      end
+    end
+
+    def record_fields
+      self.class.const_get('RECORD_FIELDS')
+    end
+
+    def user_fields
+      self.class.const_get('USER_FIELDS')
+    end
+
+    def stringify_arguments(params)
+      params.compact!
+
+      params.transform_values! do |value|
+        if value.is_a? Array
+          value.map { |i| acceptable_argument?(i) ? i : i.to_s }
+        elsif value.is_a? Hash
+          stringify_arguments(value)
+        else
+          acceptable_argument?(value) ? value : value.to_s
+        end
+      end
+
+      params
+    end
+
+    def acceptable_argument?(arg)
+      [Numeric, String, NilClass].any? { |t| arg.is_a? t }
+    end
+  end
+end

data/lib/operationable/specification.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Operationable
+  class Specification
+    attr_reader :record, :params, :activity
+
+    def initialize(record, params={}, activity='', action_name='')
+      @record = record
+      @params = params
+      @activity = activity
+      @action_name = action_name
+    end
+
+    def satisfied_by?(list, record)
+      (list & record.previous_changes.keys).any?
+    end
+  end
+end

data/lib/operationable/version.rb

@@ -0,0 +1,3 @@
+module Operationable
+  VERSION = "0.1.7"
+end

data/lib/operations/create.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Operations
+  class Create < ::Operationable::Operation
+    def persist
+      record.save
+    end
+  end
+end

data/lib/operations/destroy.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Operations
+  class Destroy < ::Operationable::Operation
+    def persist
+      record.destroy
+    end
+  end
+end

data/lib/operations/update.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Operations
+  class Update < ::Operationable::Operation
+    def persist
+      record.save
+    end
+  end
+end

data/operationable.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'operationable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "operationable"
+  spec.version       = Operationable::VERSION
+  spec.authors       = ["Kirill Suhodolov", "Vitaliy Korbut"]
+  spec.email         = ["kirillsuhodolov@gmail.com"]
+
+  spec.summary       = "Implementation of command pattern to avoid ActiveRecord callbacks " \
+                       "and get advantages of async jobs for heavy calculations"
+  spec.description   = "Implementation of command pattern to avoid ActiveRecord callbacks " \
+                       "and get advantages of async jobs for heavy calculations"
+  spec.homepage      = "https://github.com/KirillSuhodolov/operationable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- spec/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency             'activejob', '>= 4.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/operationable_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Operationable do
+  it "has a version number" do
+    expect(Operationable::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "operationable"

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: operationable
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Kirill Suhodolov
+- Vitaliy Korbut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Implementation of command pattern to avoid ActiveRecord callbacks and
+  get advantages of async jobs for heavy calculations
+email:
+- kirillsuhodolov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/jobs/operation_job.rb
+- lib/operationable.rb
+- lib/operationable/builder.rb
+- lib/operationable/callback.rb
+- lib/operationable/operation.rb
+- lib/operationable/runners/base.rb
+- lib/operationable/runners/separate.rb
+- lib/operationable/runners/serial.rb
+- lib/operationable/serializer.rb
+- lib/operationable/specification.rb
+- lib/operationable/version.rb
+- lib/operations/create.rb
+- lib/operations/destroy.rb
+- lib/operations/update.rb
+- operationable-0.1.0.gem
+- operationable-0.1.1.gem
+- operationable-0.1.2.gem
+- operationable-0.1.3.gem
+- operationable-0.1.4.gem
+- operationable-0.1.5.gem
+- operationable-0.1.6.gem
+- operationable.gemspec
+- spec/operationable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/KirillSuhodolov/operationable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Implementation of command pattern to avoid ActiveRecord callbacks and get
+  advantages of async jobs for heavy calculations
+test_files:
+- spec/operationable_spec.rb
+- spec/spec_helper.rb