logga 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9434272e2e6abace03aeda69fbc33cb7ffa14d1
-  data.tar.gz: 19a90c76932c845daf8a9001cbcc52682a7c6dfc
+SHA256:
+  metadata.gz: a10fef3d96c1c0ff09efc4f3043bf3751453b05ac86202969707a663494717ec
+  data.tar.gz: 0a08c2788adf74f258cb058902206181e03680caa0f7149b5a7291612173dfba
 SHA512:
-  metadata.gz: 852eb6e83549f5894dad56a89b4672697bcdf8ea7523f76feb256b18304109c73553773723856e97f31a1cfb2fca65d1ce2a71ea0c1de55832913229f0c12102
-  data.tar.gz: 5e63e9aab7812003e6e8bd7885af6064ee4d81dcbba39a12db4b6d191022a7b30de3929faf7dbe17823318fea12934137a52c9a6bdc69cfdb012a188c98bb733
+  metadata.gz: cc8887eb3f511ee2d500e4ee4a7ede79acc3b32d410d67f2e06ac37ebd098399188bc58fd442fa6c5bb59b27b1ac99b7289c3a378e2592732be5772cc396cd1b
+  data.tar.gz: e77078b35294a50d06fb58e8587cd126605029f3a0459f541440835c53984e985c3b83b43ce06056e99d1f730b8e7e2750f6f42af8cd4a1709a82747891488b4

data/.gitignore

@@ -70,7 +70,6 @@ nbproject
 *.rbc
 
 # RVM / rbenv
-.ruby-version
 .ruby-gemset
 .rvmrc
 

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  boxt_ruby_style_guide:
+    - default.yml

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.3

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.4
-before_install: gem install bundler -v 1.15.1
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in logga.gemspec

data/README.md

@@ -1,8 +1,6 @@
 # Logga
 
-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/logga`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Provides attribute logging functionality to ActiveRecord objects.
 
 ## Installation
 
@@ -31,19 +29,26 @@ end
 
 ```
 
-so that new LogEntry records attached to a given Order instance will be created whenever a new one is created or
+So that new LogEntry records attached to a given Order instance will be created whenever a new one is created or
 modified.
 
 ## 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 `git push gemfury master` where gemfury remote is `https://[YOUR GEM FURY USER NAME]git.fury.io/boxt/logga_engine.git`.
+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`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ltello/logga.
+Bug reports and pull requests are welcome on GitHub at https://github.com/boxt/logga.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## TODOs
+
+* Write some tests
+* Improve the documentation

data/lib/logga.rb

@@ -1,14 +1,13 @@
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_support/concern'
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "active_support/concern"
 require_relative "logga/version"
 require_relative "logga/active_record"
 
-
 module Logga
-
   ActiveSupport.on_load(:active_record) do
     include Logga::ActiveRecord
   end
-
 end

data/lib/logga/active_record.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Logga
   module ActiveRecord
     extend ActiveSupport::Concern
 
-    EXCLUDED_KEYS          = [:id, :created_at, :deleted_at, :initial, :updated_at, :log, :sent_after_sales_emails]
-    EXCLUDED_KEYS_SUFFIXES = [:_id, :_filenames]
+    EXCLUDED_KEYS          = %i[id created_at deleted_at initial updated_at log sent_after_sales_emails].freeze
+    EXCLUDED_KEYS_SUFFIXES = %i[_id _filenames].freeze
 
     included do
       class_attribute :log_fields,      instance_writer: false
@@ -18,37 +20,43 @@ module Logga
         after_destroy :log_model_deletion if actions.include?(:delete)
         after_update  :log_model_changes  if actions.include?(:update)
         define_method(:log_receiver) { to == :self ? self : send(to) }
+
         self.log_fields      = fields
         self.excluded_fields = Array(exclude_fields)
       end
     end
 
+    def log_field_changes(changes)
+      return if changes.blank?
+
+      body = field_changes_to_message(changes)
+      create_log_entry(author_data.merge(body: body)) if body.present?
+    end
+
     def log_model_creation
+      return if should_not_log?
+
       body_generator = ->(record) { default_creation_log_body(record) }
       body           = log_fields.fetch(:created_at, body_generator).call(self)
-      log_receiver&.log_entries&.create(author_data.merge(body: body, created_at: creation_at))
+      create_log_entry(author_data.merge(body: body, created_at: creation_at))
     end
 
     def log_model_deletion
-      body_generator = ->(record) {default_deletion_log_body(record)}
+      return if should_not_log?
+
+      body_generator = ->(record) { default_deletion_log_body(record) }
       body           = log_fields.fetch(:deleted_at, body_generator).call(self)
-      log_receiver&.log_entries&.create(author_data.merge(body: body))
+      create_log_entry(author_data.merge(body: body))
     end
 
     def log_model_changes
-      field_changes = previous_changes.reject do |k, _|
-        EXCLUDED_KEYS.include?(k.to_sym) ||
-        (!log_fields.include?(k.to_sym) &&
-         (excluded_fields.include?(k.to_sym) ||
-          EXCLUDED_KEYS_SUFFIXES.any? { |suffix| k.to_s.end_with?(suffix.to_s) }))
-      end
-      log_field_changes(field_changes)
-    end
+      return if should_not_log?
 
-    def log_field_changes(changes)
-      return if changes.blank?
-      body = field_changes_to_message(changes)
-      log_receiver&.log_entries&.create(author_data.merge(body: body)) if body.present?
+      field_changes = previous_changes.reject { |k, _| reject_change?(k) }
+      return if field_changes.blank?
+
+      body = field_changes_to_message(field_changes)
+      create_log_entry(author_data.merge(body: body)) if body.present?
     end
 
     private
@@ -56,14 +64,19 @@ module Logga
     def author_data
       data = Hash(log_receiver.try(:author) || try(:author)).with_indifferent_access
       {
-          author_id:   data[:id],
-          author_type: data[:type],
-          author_name: data[:name]
+        author_id:   data[:id],
+        author_type: data[:type],
+        author_name: data[:name]
       }
     end
 
+    def create_log_entry(entry)
+      log_receiver&.log_entries&.create(entry)
+    end
+
     def creation_at
       return Time.current unless log_receiver == self
+
       (log_receiver&.log_entries&.order(:created_at)&.first&.created_at || Time.current) - 0.1.seconds
     end
 
@@ -71,10 +84,10 @@ module Logga
       [
         "#{titleized_model_class_name(record)} created",
         ("(#{record.state})" if record.try(:state))
-      ].compact.join(' ')
+      ].compact.join(" ")
     end
 
-    def default_change_log_body(record, field, old_value, new_value)
+    def default_change_log_body(record, field, _old_value, new_value)
       "#{titleized_model_class_name(record)} #{field.humanize(capitalize: false)} set to #{new_value}"
     end
 
@@ -82,16 +95,29 @@ module Logga
       [
         "#{titleized_model_class_name(record)} removed",
         ("(#{record.name})" if record.try(:name))
-      ].compact.join(' ')
+      ].compact.join(" ")
     end
 
     def field_changes_to_message(changes)
-      body_generator = ->(record, field, old_value, new_value) { default_change_log_body(record, field, old_value, new_value) }
+      body_generator = lambda { |record, field, old_value, new_value|
+        default_change_log_body(record, field, old_value, new_value)
+      }
       changes.inject([]) do |result, (field, (old_value, new_value))|
         result << log_fields.fetch(field.to_sym, body_generator).call(self, field, old_value, new_value)
       end.compact.join("\n")
     end
 
+    def reject_change?(key)
+      EXCLUDED_KEYS.include?(key.to_sym) ||
+        (!log_fields.include?(key.to_sym) &&
+         (excluded_fields.include?(key.to_sym) ||
+          EXCLUDED_KEYS_SUFFIXES.any? { |suffix| key.to_s.end_with?(suffix.to_s) }))
+    end
+
+    def should_not_log?
+      !log_receiver.respond_to?(:log_entries)
+    end
+
     def titleized_model_class_name(record)
       record.class.name.demodulize.titleize
     end

data/lib/logga/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Logga
-  VERSION = '1.4.0'.freeze
+  VERSION = "1.6.0"
 end

data/logga.gemspec

@@ -1,17 +1,21 @@
-# coding: utf-8
+# frozen_string_literal: true
+
+# rubocop:disable Style/ExpandPathArguments
+# NOTE: This is because of Gemfury failing with __dir__
 lib = File.expand_path("../lib", __FILE__)
+# rubocop:enable Style/ExpandPathArguments
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "logga/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "logga"
   spec.version       = Logga::VERSION
-  spec.authors       = ["Stuart Chinery, Rob Hesketh, Lorenzo Tello"]
-  spec.email         = ["stuart.chinery@gmail.com, contact@robhesketh.com, ltello8a@gmail.com"]
+  spec.authors       = ["Boxt"]
+  spec.email         = ["developers@boxt.co.uk"]
 
-  spec.summary       = "Extensions to ActiveRecord to log entries on model changes"
+  spec.summary       = "ActiveRecord log entries on model changes"
   spec.description   = "Extensions to ActiveRecord to log entries on model changes"
-  spec.homepage      = "https://github.com/ltello/logga"
+  spec.homepage      = "https://github.com/boxt/logga"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -21,13 +25,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",      "~> 1.15"
-  spec.add_development_dependency "rake",         "~> 10.0"
-  spec.add_development_dependency "rspec",        "~> 3.6"
-  spec.add_development_dependency "factory_girl", "~> 4.8"
-  spec.add_development_dependency "byebug",       "~> 5.0"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "boxt_ruby_style_guide", "~> 1.1"
+  spec.add_development_dependency "bundler",               "~> 1.17"
+  spec.add_development_dependency "byebug",                "~> 10.0"
+  spec.add_development_dependency "rake",                  "~> 12.3"
+  spec.add_development_dependency "rspec",                 "~> 3.6"
+  spec.add_development_dependency "simplecov",             "~> 0.16"
 
-  spec.add_runtime_dependency "activerecord",     "~> 5.2"
-  spec.add_runtime_dependency "activesupport",    "~> 5.2"
+  spec.add_runtime_dependency "activerecord",  "~> 5.2"
+  spec.add_runtime_dependency "activesupport", "~> 5.2"
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: logga
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
-- Stuart Chinery, Rob Hesketh, Lorenzo Tello
+- Boxt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: boxt_ruby_style_guide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -124,13 +124,15 @@ dependencies:
         version: '5.2'
 description: Extensions to ActiveRecord to log entries on model changes
 email:
-- stuart.chinery@gmail.com, contact@robhesketh.com, ltello8a@gmail.com
+- developers@boxt.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -142,7 +144,7 @@ files:
 - lib/logga/active_record.rb
 - lib/logga/version.rb
 - logga.gemspec
-homepage: https://github.com/ltello/logga
+homepage: https://github.com/boxt/logga
 licenses:
 - MIT
 metadata: {}
@@ -162,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Extensions to ActiveRecord to log entries on model changes
+summary: ActiveRecord log entries on model changes
 test_files: []