logga 1.6.2 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad7c8f2df432c96d6db7b3fa5f22c7ac8b7721f3a9af98c2d152dcaa1268113c
-  data.tar.gz: 98f43cf7910d991e11da7ba8324c79be2f4180a714d71cd2e45d1a944247cc6a
+  metadata.gz: e701347d79260bff1bb8db40f220512a456720b66efa246de76dac9a9790bac2
+  data.tar.gz: a8b56e341270752b63f5d1195232e0ac90972d3e66bf0368561b0775ea45e99d
 SHA512:
-  metadata.gz: 84a3ee81304cc97f0db758eec19715a4eb6185a45870c0d67d8dac6ba525e8c0fa08da8391ac7a75a37bd05851bcb881dcbbf57fefd24238a8a6eb70de1f0508
-  data.tar.gz: 20e82cbca661fa23e241aa7f3479d7cc0074971d2148fd7e2ba19ebbdb27b972c577ccc7458f28c4870ba4b298508504ea73ae21d406f412087016c16ea82236
+  metadata.gz: 4991d4f6fb02cb56c5f3b952416fb2c58209eae7a84d65d8db9147b797cab1c40af9123d1be4e70a4b59a9d5a46247f7a1a913695558bf9d7641e76b1fcc38c0
+  data.tar.gz: ccdd5e59e29546563dc5cbba93796682dcdb07286aa91da7974d544daa41a3d43724b93d749d41b7dd5e957240f08f0b9ca062e74e22242d4c22e727dc34e799

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Boxt
+
+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

@@ -2,6 +2,8 @@
 
 Provides attribute logging functionality to ActiveRecord objects.
 
+[![CircleCI](https://circleci.com/gh/boxt/logga/tree/master.svg?style=svg&circle-token=f9550ac25744c292e3680638bad3d5deafb1c4e1)](https://circleci.com/gh/boxt/logga/tree/master)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -12,11 +14,15 @@ gem 'logga'
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install logga
+```sh
+gem install logga
+```
 
 ## Usage
 
@@ -26,7 +32,6 @@ Add this to your model:
 class Order < ApplicationRecord
   add_log_entries_for :create, :update
 end
-
 ```
 
 So that new LogEntry records attached to a given Order instance will be created whenever a new one is created or
@@ -34,11 +39,13 @@ 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+## Versioning
+
+The version of the gem should be set in the `VERSION` file found in the root of the project. This is then read by the `lib/boxt_aasm_ext/version.rb` file to set in the gem.
 
 ## Contributing
 
@@ -50,5 +57,5 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## TODOs
 
-* Write some tests
-* Improve the documentation
+- Write some tests
+- Improve the documentation

data/Rakefile

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rake/testtask"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+end
 
-task :default => :spec
+task test: :spec

data/VERSION

@@ -0,0 +1 @@
+2.1.2

data/lib/logga/active_record.rb

@@ -4,13 +4,13 @@ module Logga
   module ActiveRecord
     extend ActiveSupport::Concern
 
-    EXCLUDED_KEYS          = %i[id created_at deleted_at initial updated_at log sent_after_sales_emails].freeze
+    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
+      class_attribute :log_fields, instance_writer: false
       class_attribute :excluded_fields, instance_writer: false
-      self.log_fields      = {}
+      self.log_fields = {}
       self.excluded_fields = {}
     end
 
@@ -21,7 +21,7 @@ module Logga
         after_update  :log_model_changes  if actions.include?(:update)
         define_method(:log_receiver) { to == :self ? self : send(to) }
 
-        self.log_fields      = fields
+        self.log_fields = fields
         self.excluded_fields = Array(exclude_fields)
       end
     end
@@ -37,7 +37,7 @@ module Logga
       return if should_not_log?
 
       body_generator = ->(record) { default_creation_log_body(record) }
-      body           = log_fields.fetch(:created_at, body_generator).call(self)
+      body = log_fields.fetch(:created_at, body_generator).call(self)
       create_log_entry(author_data.merge(body: body, created_at: creation_at))
     end
 
@@ -45,7 +45,7 @@ module Logga
       return if should_not_log?
 
       body_generator = ->(record) { default_deletion_log_body(record) }
-      body           = log_fields.fetch(:deleted_at, body_generator).call(self)
+      body = log_fields.fetch(:deleted_at, body_generator).call(self)
       create_log_entry(author_data.merge(body: body))
     end
 
@@ -61,7 +61,7 @@ module Logga
     def author_data
       data = Hash(log_receiver.try(:author) || try(:author)).with_indifferent_access
       {
-        author_id:   data[:id],
+        author_id: data[:id],
         author_type: data[:type],
         author_name: data[:name]
       }

data/lib/logga/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Logga
-  VERSION = "1.6.2"
+  version_file = File.join(File.dirname(__FILE__), "../../VERSION")
+  VERSION = File.read(version_file).split("\n").first
 end

metadata

@@ -1,127 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: logga
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 2.1.2
 platform: ruby
 authors:
 - Boxt
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: boxt_ruby_style_guide
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
+        version: '6.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
+        version: '6.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: boxt_ruby_style_guide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
+        version: '0.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
+        version: '0.17'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '0.17'
 description: Extensions to ActiveRecord to log entries on model changes
 email:
 - developers@boxt.co.uk
@@ -129,26 +155,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- VERSION
 - lib/logga.rb
 - lib/logga/active_record.rb
 - lib/logga/version.rb
-- logga.gemspec
 homepage: https://github.com/boxt/logga
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,16 +174,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: ActiveRecord log entries on model changes
 test_files: []

data/.gitignore

@@ -1,101 +0,0 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Gems
-/Gemfile.lock
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-journal
-
-# Ignore gem building folder: pkg
-pkg
-
-# Ignore log and tmp files
-log/*
-*.log
-tmp
-tmp/**/*
-
-# Documentation
-/doc/
-doc/api
-doc/app
-.yardoc
-/_yardoc/
-.yardopts
-
-# Public Uploads
-public/system/*
-public/themes/*
-
-# Public Cache
-public/javascripts/cache
-public/stylesheets/cache
-
-# Vendor Cache
-vendor/cache
-
-# Acts as Indexed
-index/**/*
-
-# Refinery Specific
-*.tmproj
-*.autobackupbyrefinery.*
-refinerycms-*.gem
-.autotest
-
-# Mac
-.DS_Store
-
-# Windows
-Thumbs.db
-
-# NetBeans
-nbproject
-
-# Eclipse
-.project
-
-# Redcar
-.redcar
-
-# Rubinius
-*.rbc
-
-# RVM / rbenv
-.ruby-gemset
-.rvmrc
-
-# Vim
-*.swp
-*.swo
-
-# RubyMine
-.idea
-
-# E-texteditor
-.eprj
-
-# Backup
-*~
-
-# Capybara Bug
-capybara-*html
-
-# sass
-.sass-cache
-.sass-cache/*
-
-# SimpleCov (tests code converage)
-/coverage
-
-# RSpec
-/spec/reports/
-.rspec_status

data/.rspec

@@ -1,4 +0,0 @@
---color
---require byebug
---require spec_helper
---format documentation

data/.rubocop.yml

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

data/.ruby-version

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Lorenzo Tello
-
-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/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "logga"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/logga.gemspec

@@ -1,37 +0,0 @@
-# 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       = ["Boxt"]
-  spec.email         = ["developers@boxt.co.uk"]
-
-  spec.summary       = "ActiveRecord log entries on model changes"
-  spec.description   = "Extensions to ActiveRecord to log entries on model changes"
-  spec.homepage      = "https://github.com/boxt/logga"
-  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_development_dependency "boxt_ruby_style_guide", "~> 2.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"
-end