kushojin 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b284f87c77853b11396c7b90b28ba80a237f19af
+  data.tar.gz: 29dfb5f5842aeb0735ce95c89ccd668da388c00f
+SHA512:
+  metadata.gz: da3383afe02b3227e110530c38cf3c70a0b37689f9bf1a2f96f910c621cebecbe528d2cf18ef9cdfe3cb9ce6401677a6a0da1bc15c78ba4e38d6ee568cda14dd
+  data.tar.gz: 3a7dad0856810d4069aa539c403bc9340f90f46aeced4818b84ebb0e5d45c3fdda1be60dbf1984a403ba974e6a51b674c7792a664cff5dffe9dd4a4cd1ee049d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  Exclude:
+    - 'kushojin.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kushojin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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 @@
+# Kushojin [![Build Status](https://travis-ci.org/nowlinuxing/kushojin.svg?branch=master)](https://travis-ci.org/nowlinuxing/kushojin.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/33c293ed9b4f9f25ab2c/maintainability)](https://codeclimate.com/github/nowlinuxing/kushojin/maintainability)
+
+Kushojin aims to record changed attributes of ActiveRecord model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kushojin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kushojin
+
+## Usage
+
+```ruby
+Kushojin::Config.logger = Fluent::Logger::FluentLogger.new(nil, host: "localhost", port: 24224)
+
+class User < ApplicationRecord
+  record_changes
+end
+
+class UsersController < ApplicationController
+  send_changes
+
+  def create
+    User.create(params[:user])
+  end
+end
+```
+
+    $ curl -X POST -d "user[name]=bill&user[age]=20" http://localhost:3000/users
+    # output: users.create {"event":"create","request_id":"4afd0731-dd25-4668-b769-2017dbdd3642","table_name":"users","id":1,"changes":{"name":[null,"bill"],"age":[null,20]}}
+
+## 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/nowlinuxing/kushojin.
+
+
+## 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 "kushojin"
+
+# 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(__FILE__)

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/kushojin.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kushojin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kushojin"
+  spec.version       = Kushojin::VERSION
+  spec.authors       = ["Loose coupling"]
+  spec.email         = ["loosecplg@gmail.com"]
+
+  spec.summary       = %q{Detect changes of model attributes and send to outside.}
+  spec.description   = %q{Detect changes of model attributes and send to outside.}
+  spec.homepage      = "https://github.com/nowlinuxing/kushojin/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 5.1"
+  spec.add_dependency "fluent-logger"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rubocop"
+end

data/lib/kushojin.rb

@@ -0,0 +1,13 @@
+require "active_record"
+require "kushojin/version"
+require "kushojin/config"
+require "kushojin/model_methods"
+require "kushojin/recorder"
+require "kushojin/model_methods"
+require "kushojin/sender"
+require "kushojin/controller_methods" if defined?(AbstractController)
+
+module Kushojin
+end
+
+ActiveRecord::Base.extend Kushojin::ModelMethods::Callback::ClassMethods

data/lib/kushojin/config.rb

@@ -0,0 +1,12 @@
+require "fluent-logger"
+require "kushojin/sender"
+
+module Kushojin
+  module Config
+    mattr_accessor :logger
+    self.logger = Fluent::Logger::ConsoleLogger.open(STDOUT)
+
+    mattr_accessor :sender
+    self.sender = Sender::EachSender.new(logger)
+  end
+end

data/lib/kushojin/controller_methods.rb

@@ -0,0 +1,4 @@
+require "kushojin/controller_methods/filter"
+require "kushojin/controller_methods/send_change_filter"
+
+ActionController::Metal.extend Kushojin::ControllerMethods::Filter

data/lib/kushojin/controller_methods/filter.rb

@@ -0,0 +1,10 @@
+module Kushojin
+  module ControllerMethods
+    module Filter
+      def send_changes(**args)
+        filter = args.delete(:filter) || Kushojin::ControllerMethods::SendChangeFilter.new
+        around_action filter, args
+      end
+    end
+  end
+end

data/lib/kushojin/controller_methods/send_change_filter.rb

@@ -0,0 +1,16 @@
+module Kushojin
+  module ControllerMethods
+    class SendChangeFilter
+      def initialize(sender: nil)
+        @sender = sender || Config.sender
+      end
+
+      def around(controller)
+        Recorder.build
+        yield
+        @sender.send(Recorder.changes, controller: controller)
+        Recorder.destroy
+      end
+    end
+  end
+end

data/lib/kushojin/model_methods.rb

@@ -0,0 +1,3 @@
+require "kushojin/model_methods/change"
+require "kushojin/model_methods/callback"
+require "kushojin/model_methods/record_changes_callbacks"

data/lib/kushojin/model_methods/callback.rb

@@ -0,0 +1,16 @@
+module Kushojin
+  module ModelMethods
+    module Callback
+      RECORD_EVENTS = %i[before_destroy after_create after_update].freeze
+
+      module ClassMethods
+        def record_changes
+          kushojin_callbacks = RecordChangesCallbacks.new
+          RECORD_EVENTS.each do |event|
+            public_send(event, kushojin_callbacks)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kushojin/model_methods/change.rb

@@ -0,0 +1,19 @@
+module Kushojin
+  module ModelMethods
+    class Change
+      attr_reader :event, :model, :changes
+
+      delegate :primary_key, :table_name, to: "@model.class"
+
+      def initialize(event, model)
+        @event = event
+        @model = model.class.new(model.attributes).freeze
+        @changes = model.saved_changes.freeze
+      end
+
+      def changes_without_primary_key
+        @changes.reject { |attr_name, _| attr_name == primary_key }
+      end
+    end
+  end
+end

data/lib/kushojin/model_methods/record_changes_callbacks.rb

@@ -0,0 +1,13 @@
+module Kushojin
+  module ModelMethods
+    class RecordChangesCallbacks
+      Callback::RECORD_EVENTS.each do |event|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{event}(model)                                                          # def after_create
+          Recorder.record(:#{event.to_s.split(/_/).last}, model) if Recorder.current #   Recorder.record(:create, model) if Recorder.current
+        end                                                                          # end
+        RUBY
+      end
+    end
+  end
+end

data/lib/kushojin/recorder.rb

@@ -0,0 +1,29 @@
+module Kushojin
+  class Recorder
+    THREAD_KEY = "kushojin.recorder".freeze
+
+    attr_reader :changes
+
+    (class << self; self; end).delegate :changes, :record, to: :current
+
+    def self.build
+      Thread.current[THREAD_KEY] = new
+    end
+
+    def self.current
+      Thread.current[THREAD_KEY]
+    end
+
+    def self.destroy
+      Thread.current[THREAD_KEY] = nil
+    end
+
+    def initialize
+      @changes = []
+    end
+
+    def record(event, model)
+      @changes << ModelMethods::Change.new(event, model)
+    end
+  end
+end

data/lib/kushojin/sender.rb

@@ -0,0 +1,3 @@
+require "kushojin/sender/base"
+require "kushojin/sender/each_sender"
+require "kushojin/sender/serializer"

data/lib/kushojin/sender/base.rb

@@ -0,0 +1,13 @@
+module Kushojin
+  module Sender
+    class Base
+      def initialize(logger, **_args)
+        @logger = logger
+      end
+
+      def send(_changes, **_args)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/kushojin/sender/each_sender.rb

@@ -0,0 +1,33 @@
+module Kushojin
+  module Sender
+    class EachSender < Base
+      def initialize(logger, serializer: Serializer::SimpleSerializer)
+        super
+        @serializer = serializer
+      end
+
+      def send(changes, controller:)
+        changes.each do |change|
+          @logger.post(tag(controller), @serializer.serialize(change, controller: controller))
+        end
+      end
+
+      private
+
+      def tag(controller)
+        "#{controller.controller_name}.#{controller.action_name}"
+      end
+
+      def map(change, controller:)
+        changes = change.changes_without_primary_key.reject { |attr_name, _| ignore_columns.include?(attr_name) }
+        {
+          "event"            => change.event.to_s,
+          "request_id"       => controller.request.request_id,
+          "table_name"       => change.table_name,
+          change.primary_key => change.model.id,
+          "changes"          => changes,
+        }
+      end
+    end
+  end
+end

data/lib/kushojin/sender/serializer.rb

@@ -0,0 +1,2 @@
+require "kushojin/sender/serializer/base"
+require "kushojin/sender/serializer/simple_serializer"

data/lib/kushojin/sender/serializer/base.rb

@@ -0,0 +1,21 @@
+module Kushojin
+  module Sender
+    module Serializer
+      class Base
+        def self.default_ignore_columns
+          c = Class.new
+          c.extend(ActiveRecord::Timestamp::ClassMethods)
+          c.class_eval { timestamp_attributes_for_create + timestamp_attributes_for_update }
+        end
+        private_class_method :default_ignore_columns
+
+        class_attribute :ignore_columns
+        self.ignore_columns = default_ignore_columns
+
+        def self.serialize(_change, **_args)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/kushojin/sender/serializer/simple_serializer.rb

@@ -0,0 +1,21 @@
+module Kushojin
+  module Sender
+    module Serializer
+      class SimpleSerializer < Base
+        def self.serialize(change, controller:)
+          {
+            "event"            => change.event.to_s,
+            "request_id"       => controller.request.request_id,
+            "table_name"       => change.table_name,
+            change.primary_key => change.model.id,
+            "changes"          => changes_hash(change),
+          }
+        end
+
+        def self.changes_hash(change)
+          change.changes_without_primary_key.reject { |attr_name, _| ignore_columns.include?(attr_name) }
+        end
+      end
+    end
+  end
+end

data/lib/kushojin/version.rb

@@ -0,0 +1,3 @@
+module Kushojin
+  VERSION = "0.1.1".freeze
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: kushojin
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Loose coupling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Detect changes of model attributes and send to outside.
+email:
+- loosecplg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kushojin.gemspec
+- lib/kushojin.rb
+- lib/kushojin/config.rb
+- lib/kushojin/controller_methods.rb
+- lib/kushojin/controller_methods/filter.rb
+- lib/kushojin/controller_methods/send_change_filter.rb
+- lib/kushojin/model_methods.rb
+- lib/kushojin/model_methods/callback.rb
+- lib/kushojin/model_methods/change.rb
+- lib/kushojin/model_methods/record_changes_callbacks.rb
+- lib/kushojin/recorder.rb
+- lib/kushojin/sender.rb
+- lib/kushojin/sender/base.rb
+- lib/kushojin/sender/each_sender.rb
+- lib/kushojin/sender/serializer.rb
+- lib/kushojin/sender/serializer/base.rb
+- lib/kushojin/sender/serializer/simple_serializer.rb
+- lib/kushojin/version.rb
+homepage: https://github.com/nowlinuxing/kushojin/
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Detect changes of model attributes and send to outside.
+test_files: []