rails_log_book 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1dcd95f53c62fb9971f9b6aa3600f083fe20e390
-  data.tar.gz: 5c8d602213701f68f25b4ea419bba3b415e25f4b
+SHA256:
+  metadata.gz: 33c84201892d61f332f7f60bd66ac9d052c37b9d9a894e5210eecf528efcb1ee
+  data.tar.gz: 2dd8618869a1a1955e8c24261edbd11561662792d39e736de94513ea32b28358
 SHA512:
-  metadata.gz: cf696b59c7b89efea1dbb24525750653d1507e3b78803a4ae2c36076348f73d9099210ba75ad54c2f5f8f79d90cf7d2792f4d12becff5f5ba6867198991aebf5
-  data.tar.gz: 70d8ddd9694e9221d4347e1aaaaa5ceb8859cab8a0d224bca164bb1e989e4643956710ac216b2717fc05ff749fd37ed6f8708f7e6622f723aea8bd53da127634
+  metadata.gz: 1f0b026c941e50454283953976c11eef81cba06e8c37ddb6ffaffbfb1ca1c3ef030c1b6e82c5be68c9151948465fa335ae4f3b79a8e2606a4a0190559e6f07cd
+  data.tar.gz: 0b321da7a85b6fe8620fe1863ac26560c3dd40a5fa06eabf1a7d4d1ec0f299d296994634370bac9c66a82990440ae2d578ced623b617474d2f864ec8b6443bde

data/README.md

@@ -1,29 +1,185 @@
 # LogBook
 
-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/log_book`. To experiment with that code, run `bin/console` for an interactive prompt.
+LogBook is a gem that tracks changes on your records. Created for the purpuse of auditing and showing activity log.
+For comparison with [paper_\__trail](https://github.com/airblade/paper_trail) and [audited](https://github.com/collectiveidea/audited) see []()
 
-TODO: Delete this and the text above, and describe your gem
+## Supported ORMs
 
-## Installation
+Currently only supports ActiveRecord.
 
-Add this line to your application's Gemfile:
+## Instalation
+
+Add to your Gemfile:
+
+``` ruby
+gem 'rails_log_book'
+```
+
+Then run:
 
 ```ruby
-gem 'log_book'
+rails generate log_book:install
+rake db:migrate
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Add to models you want to keep track of:
 
-Or install it yourself as:
+``` ruby
+  class User < ActiveRecord::Base
+    include LogBook::Recorder
 
-    $ gem install log_book
+    has_log_book_records
+  end
+```
 
-## Usage
+Add to controlers and actions you want the tracker to be active:
+
+``` ruby
+  class UsersController < ApplicationController
+    include LogBook::ControllerRecord
+  end
+```
+
+By default, whenever a user record is created, updated or deleted in any actions of users\_controller a new log\_book record will be created.
+
+## ActiveRecord Options
+
+### fields
+
+``` ruby
+  class User < ActiveRecord::Base
+    include LogBook::Recorder
+
+    # all fields
+    # has_log_book_records
 
-TODO: Write usage instructions here
+    # Only fields
+    # has_log_book_records only: [:email, :name]
+
+    # Ignored fields
+    # has_log_book_records except: [:password]
+
+    # Default ignored fields
+    # primary_key (id), LogBook.config.ignored_attributes (:created_at, :updated_at)
+  end
+```
+
+### callbacks
+
+``` ruby
+  class User < ActiveRecord::Base
+    include LogBook::Recorder
+
+    # all events
+    # has_log_book_records
+
+    # Only record on create and destroy (not update)
+    # has_log_book_records on: [:create, :destroy]
+  end
+```
+
+### parent
+
+Define who is a parent of this object. Will be recorded in a `parent` polymorphic columns
+
+``` ruby
+  class User < ActiveRecord::Base
+    include LogBook::Recorder
+    belongs_to :company
+
+    # Parent is Company and will be recorded with each user change
+    # has_log_book_records parent: :company
+  end
+```
 
+### meta
+
+Arbitrary column. This is a jsonb field which can have all kinds of information. Useful when you want to cache fields at the exact point of record creation
+
+``` ruby
+  class User < ActiveRecord::Base
+    include LogBook::Recorder
+
+    # runs `log_book_meta(record)` method to assign to `:meta` field
+    # has_log_book_records meta: true
+
+    # runs `meta_method` method to assing to `:meta` field
+    # has_log_book_records meta: :meta_method
+
+    # runs passed proc to assing to `:meta` field
+    # has_log_book_records meta: -> { { slug: email.split('@').first } }
+  end
+```
+
+### squash
+
+Enables/disables suashing on this model
+
+``` ruby
+  class User < ActiveRecord::Base
+    include LogBook::Recorder
+
+    # Enables squashing (defaults to false)
+    # has_log_book_records squash: true
+```
+
+## ActionController options
+
+### current\_author
+
+Defines what method is run when looking for the author for recording
+
+``` ruby
+  class Admin::UsersController < ActionController::Base
+    inlcude LogBook::ControllerRecord
+
+    # defaults to `current_user`
+    def current_author
+      current_admin
+    end
+```
+
+## Configuration
+
+``` ruby
+# config/initializers/log_book.rb
+LogBook.configure do |config|
+  config.records_table_name = 'records'
+  config.ignored_attributes = [:updated_at, :created_at]
+  config.author_method = :current_user
+  config.record_squashing = false
+  config.recording_enabled = false
+  config.skip_if_empty_actions = [:update]
+end
+```
+
+## Additional methods
+
+``` ruby
+LogBook.with_recording {}         #=> Enables recording within block
+LogBook.without_recording {}      #=> Disables recording within block
+LogBook.record_as(author) {}      #=> Records as a different author within block
+LogBook.with_record_squashing {}  #=> Squashes records within block
+LogBook.enable_recording          #=> Enables recording from this point
+LogBook.disable_recording         #=> Disables recording from this point
+LogBook.record_squashing_enabled  #=> Enables record squashing from this point
+LogBook.recording_enabled         #=> Returns true if recording is enabled
+LogBook.recording_enabled=(val)   #=> Enables/Disables recording
+LogBook.squash_records            #=> Squash records with current :request_uuid
+```
+
+## Squashing
+
+The idea of squashing came when we needed to show an activity page where all changes made in the single request as one change.
+
+Each request has its own unique `request_uuid` and it is recorded with each record. If squashing is enabled, `after_action` method with squashing is called.
+All records with the same `request_uuid` are "squashed" into one record.
+
+``` sql
+INSERT INTO "users" ("name", "email") VALUES ("test", "test@test.com")
+```
 ## 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.
@@ -32,7 +188,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/log_book. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/log_book. 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

data/lib/generators/log_book/install_generator.rb

@@ -1,6 +1,6 @@
 require 'rails/generators/migration'
 require 'generators/log_book/migration'
-require 'log_book'
+require 'rails_log_book'
 
 module LogBook
   module Generators
@@ -17,6 +17,12 @@ module LogBook
       def copy_migration
         migration_template 'install.rb', 'db/migrate/install_log_book.rb'
       end
+
+      def migration_version
+        if rails5?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
     end
   end
 end

data/lib/generators/log_book/templates/install.rb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :records do |t|
       t.belongs_to :author, polymorphic: true, index: true
@@ -6,7 +6,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.belongs_to :parent, polymorphic: true, index: true
       t.jsonb :record_changes, default: {}
       t.jsonb :meta, default: {}
-      t.string :request_uuid
+      t.string :request_uuid, index: true
       t.string :action
 
       t.datetime :created_at

data/lib/log_book/controller_record.rb

@@ -21,7 +21,7 @@ module LogBook
     end
 
     def current_author
-      raise NotImplementedError unless respond_to?(LogBook.config.author_method)
+      raise NotImplementedError unless respond_to?(LogBook.config.author_method, true)
       send(LogBook.config.author_method)
     end
   end

data/lib/log_book/recorder.rb

@@ -34,19 +34,6 @@ module LogBook
         self.class.with_recording(&block)
       end
 
-      def new_record
-        record = LogBook::Record.new(
-          action: LogBook.store[:action],
-          record_changes: record_changes,
-          author: LogBook.store[:author],
-          subject: self,
-          meta: {}
-        )
-        record.meta = log_book_meta_info(record) if recording_options[:meta].present?
-        record.parent = send(recording_options[:parent]) if recording_options[:parent].present?
-        record
-      end
-
       def recording_attributes
         attributes.except(*non_recording_columns)
       end
@@ -60,9 +47,9 @@ module LogBook
       def record_changes
         if recording_options[:only]
           recording_columns = self.class.recording_columns.map(&:name)
-          changes.slice(*recording_columns)
+          saved_changes.slice(*recording_columns)
         else
-          changes.except(*non_recording_columns)
+          saved_changes.except(*non_recording_columns)
         end
       end
 
@@ -80,12 +67,24 @@ module LogBook
 
       def write_record(action)
         return unless LogBook.recording_enabled
-        LogBook.store[:action] ||= action
-        record = new_record
+        record = new_record(LogBook.store[:action] || action)
         return unless record.changes_to_record?
         record.save
       end
 
+      def new_record(action)
+        record = LogBook::Record.new(
+          action: action,
+          record_changes: record_changes,
+          author: LogBook.store[:author],
+          subject: self,
+          meta: {}
+        )
+        record.meta = log_book_meta_info(record) if recording_options[:meta].present?
+        record.parent = send(recording_options[:parent]) if recording_options[:parent].present?
+        record
+      end
+
       def log_book_meta_info(record)
         case recording_options[:meta]
         when NilClass then nil

data/lib/log_book/squash_records.rb

@@ -6,17 +6,28 @@ module LogBook
 
     def call
       records.group_by(&:parent).each do |parent, children|
-        next if parent.nil?
         children_to_squash = children.select { |child| child.subject.try(:to_squash?) }
         next if children_to_squash.empty?
 
-        parent_in_records = parent_in_records(parent)
-        parent_in_records.record_changes.merge!(squashed_changes(children_to_squash, :record_changes))
-        parent_in_records.meta.merge!(squashed_changes(children_to_squash, :meta))
-        parent_in_records.created_at ||= children_to_squash.first.created_at
-        parent_in_records.save
+        if parent.present?
+          parent_in_records = parent_in_records(parent)
+          parent_in_records.record_changes.merge!(squashed_changes(children_to_squash, :record_changes))
+          parent_in_records.meta.merge!(squashed_changes(children_to_squash, :meta))
+          parent_in_records.created_at ||= children_to_squash.first.created_at
+          parent_in_records.save
 
-        children_to_squash.each(&:delete)
+          children_to_squash.each(&:delete)
+        else
+          next if children_to_squash.one?
+
+          records.reduce do |main_record, record|
+            main_record.record_changes.merge!(record.record_changes)
+            main_record.meta.merge!(record.meta)
+
+            record.delete
+            main_record
+          end.save
+        end
       end
     end
 

data/lib/log_book/version.rb

@@ -1,3 +1,3 @@
 module LogBook
-  VERSION = "0.3.0"
+  VERSION = '1.0.0'
 end

data/log_book.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'rails_log_book'
   spec.version       = LogBook::VERSION
   spec.authors       = ['Stjepan Hadjic']
-  spec.email         = ['d4be4st@gmail.com']
+  spec.email         = ['stjepan.hadjic@infinum.co']
 
   spec.summary       = 'Write a short summary, because Rubygems requires one.'
   spec.description   = 'Write a longer description or delete this line.'
@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug'
 
   spec.add_dependency 'request_store'
-  spec.add_dependency 'activerecord', '>= 4.0', '< 5.1'
+  spec.add_dependency 'activerecord', '> 5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_log_book
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stjepan Hadjic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,25 +112,19 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   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'
+        version: '5.2'
 description: Write a longer description or delete this line.
 email:
-- d4be4st@gmail.com
+- stjepan.hadjic@infinum.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -180,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Write a short summary, because Rubygems requires one.