recorder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b3955ec8b5c54010caff1d1e24aa92bcb2c5b43
+  data.tar.gz: ded550166b4025bc612fe913d4e79a480f2d06f4
+SHA512:
+  metadata.gz: 3b77a10f6e0ded0fc17d52ac885b9a89a7cb70b6052d616f45c33a189e15d3f3aba2c6db97b4fac9689daf121d020f65ab4afa61bf9b291c601de5c61928be94
+  data.tar.gz: 3b1ff7aa9ee10e24babbe23ae278c4047e64c26e4ee45f5128107872f05d30f7679d800a019656c9172567f34e5f4be16e1319ed0a512a2e5f7bb334183537b8

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,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 igor
+
+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,39 @@
+# Recorder
+
+Recorder tracks changes of your Rails models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recorder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recorder
+
+## 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]/recorder.
+
+
+## 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 "recorder"
+
+# 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/generators/recorder/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Generates (but does not run) a migration to add a revisions table.

data/lib/generators/recorder/install_generator.rb

@@ -0,0 +1,40 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Recorder
+  # Installs Recorder in a rails app.
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    class_option(
+      :with_partitions,
+      type: :boolean,
+      default: false,
+      desc: "Create partitions for `revisions` table"
+    )
+
+    desc "Generates (but does not run) a migration to add a `revisions` table."
+
+    def create_migration_file
+      self.add_or_skip_recorder_migration('create_recorder_revisions')
+      self.add_or_skip_recorder_migration('add_partitions_to_recorder_revisions_table') if options.with_partitions?
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+  protected
+
+    def add_or_skip_recorder_migration(template)
+      migration_dir = File.expand_path('db/migrate')
+      if self.class.migration_exists?(migration_dir, template)
+        ::Kernel.warn "Migration already exists: #{template}"
+      else
+        migration_template "#{template}.rb", "db/migrate/#{template}.rb"
+      end
+    end
+  end
+end

data/lib/generators/recorder/templates/create_recorder_revisions.rb

@@ -0,0 +1,18 @@
+# This migration creates the `revisions` table.
+class CreateRecorderRevisions < ActiveRecord::Migration
+  def change
+    create_table :recorder_revisions do |t|
+      t.string :item_type, null: false
+      t.integer :item_id, null: false
+      t.string :event, null: false
+      t.jsonb :data, null: false
+      t.inet :ip
+      t.date :action_date, null: false
+      t.integer :user_id
+      t.jsonb :meta
+      t.datetime :created_at, null: false
+    end
+
+    add_index :recorder_revisions, [:item_type, :item_id]
+  end
+end

data/lib/recorder/draper/decorator_concern.rb

@@ -0,0 +1,13 @@
+module Recorder
+  module Draper
+    module DecoratorConcern
+      def self.included(base)
+        base.decorates_association :item
+      end
+
+      def item_human_attribute_name(attribute)
+        self.item.source.class.human_attribute_name(attribute)
+      end
+    end
+  end
+end

data/lib/recorder/observer.rb

@@ -0,0 +1,26 @@
+require 'recorder/tape'
+require 'active_support/concern'
+
+module Recorder::Observer
+  extend ::ActiveSupport::Concern
+
+  included do
+    has_many :revisions, :class_name => '::Recorder::Revision', :inverse_of => :item, :as => :item
+  end
+
+  module ClassMethods
+    def record_changes(options = {})
+      after_commit :on => :create do
+        Recorder::Tape.new(self, options).record_create
+      end
+
+      after_commit :on => :update do
+        Recorder::Tape.new(self, options).record_update
+      end
+
+      after_commit :on => :destroy do
+        Recorder::Tape.new(self, options).record_destroy
+      end
+    end
+  end
+end

data/lib/recorder/rails/controller_concern.rb

@@ -0,0 +1,51 @@
+module Recorder
+  module Rails
+    # Extensions to rails controllers. Provides convenient ways to pass certain
+    # information to the model layer, with `recorder_meta`.
+    module ControllerConcern
+      def self.included(base)
+        base.before_action :set_recorder_info
+        base.before_action :set_recorder_meta
+      end
+
+    protected
+
+      # Returns the user who is responsible for any changes that occur.
+      # By default this calls `current_user` and returns the result.
+      #
+      # Override this method in your controller to call a different
+      # method, e.g. `current_person`, or anything you like.
+      def recorder_user_id
+        return unless defined?(current_user)
+        current_user.try!(:id)
+      rescue NoMethodError
+        current_user
+      end
+
+      def recorder_info
+        {
+          :user_id => self.recorder_user_id,
+          :ip => request.remote_ip,
+          :action_date => Date.current,
+          :meta => self.recorder_meta
+        }
+      end
+
+      # Override this method in your controller to return a hash of any
+      # information you need.
+      def recorder_meta
+        nil
+      end
+
+      # Tells Recorder any information from the controller you want to store
+      # alongside any changes that occur.
+      def set_recorder_info
+        ::Recorder.info = self.recorder_info
+      end
+
+      def set_recorder_meta
+        ::Recorder.meta = self.recorder_meta
+      end
+    end
+  end
+end

data/lib/recorder/revision.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+
+class Recorder::Revision < ActiveRecord::Base
+  self.table_name = 'recorder_revisions'
+
+  if ::Recorder.active_record_protected_attributes?
+    attr_accessible(
+      :event,
+      :user_id,
+      :ip,
+      :user_agent,
+      :action_date,
+      :data,
+      :meta
+    )
+  end
+
+  belongs_to :item, :polymorphic => true, :inverse_of => :revisions
+  belongs_to :user
+
+  validates :item, :presence => true
+  validates :event, :presence => true
+  validates :action_date, :presence => true
+  validates :data, :presence => true
+
+  scope :ordered_by_created_at, -> { order(:created_at => :desc) }
+end

data/lib/recorder/tape.rb

@@ -0,0 +1,85 @@
+class Recorder::Tape
+
+  attr_reader :item, :options
+
+  def initialize(item, options = {})
+    @item = item
+    @options = options
+  end
+
+  def record_create
+    data = {
+      :changes => self.sanitize_attributes(self.item.attributes)
+    }
+
+    # changes.merge!(self.parse_associations_attributes)
+
+    if data.any?
+      self.record(
+        Recorder.store.merge({
+          :event => :create,
+          :data => data
+        })
+      )
+    end
+  end
+
+  def record_update
+    data = {
+      :changes => self.sanitize_attributes(self.item.previous_changes)
+    }
+
+    associations = self.parse_associations_attributes
+    data.merge!(:associations => self.parse_associations_attributes) if associations.any?
+
+    if data.any?
+      self.record(
+        Recorder.store.merge({
+          :event => :update,
+          :data => data
+        })
+      )
+    end
+  end
+
+  def record_destroy
+  end
+
+protected
+
+  def record(params)
+    params.merge!({
+      :action_date => Date.today
+    })
+
+    self.item.revisions.create(params)
+  end
+
+  def sanitize_attributes(attributes = {})
+    # attributes.symbolize_keys.delete_if{ |key, value|  [:created_at, :updated_at, :delta].include?(key) || (value[0] == value[1]) }
+    attributes.symbolize_keys.except(:created_at, :updated_at, :delta)
+  end
+
+  def parse_associations_attributes
+    if self.options[:associations].any?
+      self.options[:associations].inject({}) do |hash, association|
+        reflection = self.item.class.reflect_on_association(association)
+        if reflection.present?
+          if reflection.collection?
+
+          else
+            object = self.item.send(association)
+
+            if object.present? && self.sanitize_attributes(object.previous_changes).any?
+              hash[reflection.name] = {
+                :changes => self.sanitize_attributes(object.previous_changes)
+              }
+            end
+          end
+        end
+
+        hash
+      end
+    end
+  end
+end

data/lib/recorder/version.rb

@@ -0,0 +1,15 @@
+module Recorder
+  # :nodoc:
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY = 0
+    PRE = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze
+
+    def self.to_s
+      STRING
+    end
+  end
+end

data/lib/recorder.rb

@@ -0,0 +1,43 @@
+require 'recorder/version'
+require 'recorder/observer'
+require 'recorder/rails/controller_concern'
+
+require 'request_store'
+
+module Recorder
+  class << self
+    # Sets Recorder information from the controller.
+    # @api public
+    def info=(hash)
+      self.store.merge!(hash)
+    end
+
+    # Sets Recorder meta information.
+    # @api public
+    def meta=(hash)
+      self.store[:meta] = hash
+    end
+
+    # Returns a boolean indicating whether "protected attibutes" should be
+    # configured, e.g. attr_accessible.
+    def active_record_protected_attributes?
+      @active_record_protected_attributes ||= !!defined?(ProtectedAttributes)
+    end
+
+    # Thread-safe hash to hold Recorder's data.
+    # @api private
+    def store
+      RequestStore.store[:recorder] ||= { }
+    end
+
+    def version
+      VERSION::STRING
+    end
+  end
+end
+
+if defined?(Draper)
+  require 'recorder/draper/decorator_concern'
+end
+
+require 'recorder/revision'

data/recorder.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recorder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'recorder'
+  spec.version       = Recorder::VERSION::STRING
+  spec.authors       = ["Igor Alexandrov"]
+  spec.email         = ["igor.alexandrov@jetrockets.ru"]
+
+  spec.summary       = %q{Rails model auditor}
+  spec.description   = %q{Recorder tracks changes of your Rails models}
+  spec.homepage      = "https://github.com/jetrockets/recorder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 4.0', '< 5.1'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 5.1'
+  spec.add_dependency 'request_store'
+  spec.add_dependency 'pg'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: recorder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Alexandrov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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: pg
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: Recorder tracks changes of your Rails models
+email:
+- igor.alexandrov@jetrockets.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/recorder/USAGE
+- lib/generators/recorder/install_generator.rb
+- lib/generators/recorder/templates/create_recorder_revisions.rb
+- lib/recorder.rb
+- lib/recorder/draper/decorator_concern.rb
+- lib/recorder/observer.rb
+- lib/recorder/rails/controller_concern.rb
+- lib/recorder/revision.rb
+- lib/recorder/tape.rb
+- lib/recorder/version.rb
+- recorder.gemspec
+homepage: https://github.com/jetrockets/recorder
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails model auditor
+test_files: []