thoth 0.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf973001ee233881ab90f419d34c0a2309c77384
-  data.tar.gz: 72dcca25a59ea36fe4bc00841a7f56d85846e425
+SHA256:
+  metadata.gz: cd988c8a0356cb7e895c099375de581868eece1f234ae362db17d287ee1dc521
+  data.tar.gz: ed3385f0d9eee202743492b598bc368bdf06b89da74d457c7916b0a6523d84be
 SHA512:
-  metadata.gz: 53d6518d84221be35752b0cd9902bf4fdb75b2097c82490ebd0b49f80b8834d8a72ca79f5cc2b984e8c9ab8fb13517089b496a169c753ae512eecb838b786454
-  data.tar.gz: bb2dff3aec685077dc08204b69c404ee850927187226a51fc0bfb60de9010a9d45e3e4fd37bc836067c163cd480b0e69e03b88f198263e687360a5661a49a517
+  metadata.gz: c3204fd840e86c2023530c0179e66360b51b9c6468922cf860c47e97b6c9421661086b25864c26eb211239bfd83eb0295fb60c6d314d55b0484fe5627127e4fe
+  data.tar.gz: 9d495a5584ab882ab362d92d2120135b580dd3d548a0cb548408168fd21d87dc54fec668ae145ef9ce22cff53afe7726345355d93f0115a63237840d8c6f474c

data/README.md

@@ -42,6 +42,7 @@ class Cat < ActiveRecord::Base
 
   # :on (default [:create, :update, :destroy]) - which events should be logged
   # :only (default all attributes) - for updates, only log when these attributes are changed
+  # :except (default none) - for updates, do not log if only attributes in this list are changed
   log_events on: [:update, :destroy], only: [:mood, :name]
 end
 ```

data/lib/thoth/logger.rb

@@ -9,6 +9,11 @@ module Thoth
       @timestamp_key = options.fetch(:timestamp_key, :time)
     end
 
+    #lazy load this since this class is initialized before rails' filter_parameters is set
+    def param_filter
+      @param_filter ||= ::ActionDispatch::Http::ParameterFilter.new(::Rails.application.config.filter_parameters)
+    end
+
     def log(event_name, details={}, context={})
       event_data = marshal_event(event_name, details, context)
 
@@ -21,12 +26,12 @@ module Thoth
     private
 
     def marshal_event(event_name, details, context)
-      {
+      param_filter.filter({
         event: event_name,
         timestamp_key => Time.now.utc.strftime(timestamp_format),
         context: context.reverse_merge(Thoth.context),
         details: details
-      }
+      })
     end
   end
 end

data/lib/thoth/rails/controller_context.rb

@@ -3,7 +3,7 @@ module Thoth
     module ControllerContext
 
       def self.included(base)
-        base.around_filter(:set_thoth_request_context)
+        base.around_action(:set_thoth_request_context)
       end
 
       def set_thoth_request_context
@@ -13,7 +13,12 @@ module Thoth
       end
 
       def thoth_request_context
-        context = params.dup
+        #>= Rails 4.2
+        if ::Rails::VERSION::MAJOR >= 5 || (::Rails::VERSION::MAJOR == 4 && ::Rails::VERSION::MINOR >= 2)
+          context = params.to_unsafe_h
+        else
+          context = params.to_h
+        end
         context[:current_user] = current_user.try(:id) if defined?(current_user)
         context
       end

data/lib/thoth/rails/model.rb

@@ -30,8 +30,14 @@ module Thoth
     def thoth_log_update
       return unless self.class.thoth_options[:on].include?(:update)
 
-      only_options = self.class.thoth_options[:only]
-      if only_options.empty? || !(only_options.map(&:to_s) & changes.keys).empty?
+      except_options = self.class.thoth_options[:except]
+      only_options = if except_options.present?
+        self.class.columns.map(&:name) - except_options.map(&:to_s)
+      else
+        self.class.thoth_options[:only]
+      end
+
+      if only_options.empty? || !(only_options.map(&:to_s) & changed_attribute_names_to_save).empty?
         thoth_log_model(:update)
       end
     end
@@ -42,7 +48,11 @@ module Thoth
     end
 
     def thoth_log_model(action)
-      Thoth.logger.log("#{self.class.name} #{action}", changes: changes, attributes: attributes)
+      Thoth.logger.log("#{self.class.name} #{action}", changes: changes_to_log, attributes: attributes)
+    end
+
+    def changes_to_log
+      has_changes_to_save? ? changes_to_save : saved_changes
     end
   end
 end

data/lib/thoth/rails/railtie.rb

@@ -5,7 +5,7 @@ module Thoth
   class Railtie < ::Rails::Railtie
     initializer "thoth.configure_rails_initialization" do
       Thoth.logger ||= (
-        file = File.open(::Rails.root.join(*%W[log events_#{ENV['RAILS_ENV']}.log]), 'a')
+        file = File.open(::Rails.root.join(*%W[log events_#{::Rails.env}.log]), 'a')
         file.sync = true
         Logger.new(Output::Json.new(file))
       )

data/lib/thoth/version.rb

@@ -1,3 +1,3 @@
 module Thoth
-  VERSION = "0.0.6"
+  VERSION = "2.0.0"
 end

data/spec/dummy/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '3.2.18'
+gem 'rails', '5.1.7'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
@@ -10,17 +10,17 @@ gem 'sqlite3'
 
 # Gems used only for assets and not required
 # in production environments by default.
-group :assets do
-  gem 'sass-rails',   '~> 3.2.3'
-  gem 'coffee-rails', '~> 3.2.1'
+# group :assets do
+#   gem 'sass-rails',   '~> 3.2.3'
+#   gem 'coffee-rails', '~> 3.2.1'
 
-  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  # gem 'therubyracer', :platforms => :ruby
+#   # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+#   # gem 'therubyracer', :platforms => :ruby
 
-  gem 'uglifier', '>= 1.0.3'
-end
+#   gem 'uglifier', '>= 1.0.3'
+# end
 
-gem 'jquery-rails'
+# gem 'jquery-rails'
 
 gem 'thoth', path: File.join(File.dirname(__FILE__), %w[.. ..])
 

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/models/car.rb

@@ -1,3 +1,3 @@
 class Car < ActiveRecord::Base
-  attr_accessible :make, :model, :year
+  # attr_accessible :make, :model, :year
 end

data/spec/dummy/app/models/cat.rb

@@ -1,5 +1,5 @@
 class Cat < ActiveRecord::Base
-  attr_accessible :name, :breed
+  # attr_accessible :name, :breed
 
   def evil?
     true

data/spec/dummy/app/models/person.rb

@@ -1,3 +1,3 @@
 class Person < ActiveRecord::Base
-  attr_accessible :name, :food, :color
+  # attr_accessible :name, :food, :color
 end

data/spec/dummy/config/application.rb

@@ -51,12 +51,14 @@ module Dummy
     # This will create an empty whitelist of attributes available for mass-assignment for all models
     # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
     # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
+    # config.active_record.whitelist_attributes = true
 
     # Enable the asset pipeline
     config.assets.enabled = true
 
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
+
+    config.eager_load = false
   end
 end

data/spec/dummy/config/environments/development.rb

@@ -23,11 +23,11 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
 
   # Do not compress assets
   config.assets.compress = false

data/spec/dummy/config/environments/test.rb

@@ -30,7 +30,7 @@ Dummy::Application.configure do
   config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/spec/dummy/config/secrets.yml

@@ -0,0 +1,17 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: a9fd55a1a5f8cceaa3e268109e1eaaff039f583d1c181285972943ecc50f7db1304482f74eecf6e03cb96eac1cb785b0115935050b76474dc02d8035de68fd96
+
+test:
+  secret_key_base: 420f66fbeefc13c18e9850d3a1b1e27500d0a802619a8731de312ed7faffa419f5b76fa1d2b5b81d335f787f4e100ba2cef315a02a23026e33a2c940ad7fb0a2

data/spec/thoth/rails/controller_context_spec.rb

@@ -23,7 +23,7 @@ describe ControllerWithThothContextController, type: :controller do
   context "on any action" do
     it "stores params in the Thoth.context" do
       get :show
-      expect(assigns(:context)).to eq({"controller"=>"controller_with_thoth_context", "action"=>"show", "current_user"=>1})
+      expect(controller.view_context.assigns['context']).to eq({"controller"=>"controller_with_thoth_context", "action"=>"show", "current_user"=>1})
     end
   end
-end
+end

data/spec/thoth/rails/model_spec.rb

@@ -32,7 +32,7 @@ describe Thoth::Rails::Model do
   end
 
   context "on destroy" do
-    let!(:person) { Person.create(name: 'Lee') }
+    let!(:person) { Person.create(name: 'Lee').reload }
 
     it "records the destroy event" do
       expect(Thoth).to receive(:logger).and_return(double(log: true))
@@ -45,7 +45,7 @@ describe Thoth::Rails::Model do
         log_events on: :update
       end
 
-      let!(:cat) { Cat.create }
+      let!(:cat) { Cat.create.reload }
 
       it "does not record anything" do
         expect(Thoth).not_to receive(:logger)
@@ -55,11 +55,11 @@ describe Thoth::Rails::Model do
   end
 
   context "on update" do
-    let!(:person) { Person.create(name: 'Lee') }
+    let!(:person) { Person.create(name: 'Lee').reload }
 
     it "records the update event" do
       expect(Thoth).to receive(:logger).and_return(double(log: true))
-      person.update_attributes!(name: 'Smith')
+      person.update!(name: 'Smith')
     end
 
     context "when logging only changes to certain attribute" do
@@ -68,20 +68,20 @@ describe Thoth::Rails::Model do
         log_events only: :name
       end
 
-      let!(:person) { PersonWithOnly.create(name: 'Lee') }
+      let!(:person) { PersonWithOnly.create(name: 'Lee').reload }
 
 
       context "and a watched attribute changes" do
         it "records the update event" do
           expect(Thoth).to receive(:logger).and_return(double(log: true))
-          person.update_attributes!(name: 'Smith', color: :blue)
+          person.update!(name: 'Smith', color: :blue)
         end
       end
 
       context "and a watched attribute does not change" do
         it "does not record anything" do
           expect(Thoth).not_to receive(:logger)
-          person.update_attributes!(color: :blue)
+          person.update!(color: :blue)
         end
       end
     end
@@ -92,11 +92,11 @@ describe Thoth::Rails::Model do
         log_events on: :destroy
       end
 
-      let!(:car) { Car.create(make: 'Tesla', model: 'S') }
+      let!(:car) { Car.create(make: 'Tesla', model: 'S').reload }
 
       it "does not record anything" do
         expect(Thoth).not_to receive(:logger)
-        car.update_attributes!(model: 'X')
+        car.update!(model: 'X')
       end
     end
   end

data/thoth.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Philippe Huibonhoa"]
   spec.email         = ["phuibonhoa@gmail.com"]
   spec.summary       = %q{Easy event logging for rails.}
-  spec.homepage      = "https://github.com/bkr/thoth"
+  spec.homepage      = "https://github.com/phuibonhoa/thoth"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -17,13 +17,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport', ['>= 3.0']
+  spec.add_dependency 'activesupport', ['>= 5.1']
   spec.add_dependency 'request_store'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rails', '~> 3.2.18'
-  spec.add_development_dependency 'rspec-rails', '~> 2.14'
+  spec.add_development_dependency 'rails', '>= 5.1'
+  spec.add_development_dependency 'rspec-rails', '>= 4.1.2'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'pry-remote'
   spec.add_development_dependency 'timecop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thoth
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Philippe Huibonhoa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +70,30 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.18
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.18
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 4.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 4.1.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - phuibonhoa@gmail.com
 executables: []
@@ -161,6 +161,7 @@ files:
 - spec/dummy/Gemfile
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/images/rails.png
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -188,6 +189,7 @@ files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/20140926015139_create_people.rb
 - spec/dummy/db/migrate/20140926022006_create_cars.rb
 - spec/dummy/db/migrate/20140926022112_create_cats.rb
@@ -223,11 +225,11 @@ files:
 - spec/thoth/rails/controller_context_spec.rb
 - spec/thoth/rails/model_spec.rb
 - thoth.gemspec
-homepage: https://github.com/bkr/thoth
+homepage: https://github.com/phuibonhoa/thoth
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -242,9 +244,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Easy event logging for rails.
 test_files:
@@ -252,6 +253,7 @@ test_files:
 - spec/dummy/Gemfile
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/images/rails.png
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -279,6 +281,7 @@ test_files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/20140926015139_create_people.rb
 - spec/dummy/db/migrate/20140926022006_create_cars.rb
 - spec/dummy/db/migrate/20140926022112_create_cats.rb