changes_are_logged 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c0a48f3d22566d6b3ce0e11581f26e349927a31
-  data.tar.gz: 9f236ae8f678bdc46e2796b203d2de2485c6c466
+  metadata.gz: 0db78111e08142c80966e125fefc9b785bf750b3
+  data.tar.gz: 5ce3fa303c8e88475b20f42643fdaf7b6761fc6e
 SHA512:
-  metadata.gz: e8c63536e1e473aaa7edab32adfcc79c5ba25ff23a0851c1414c9445e8cbe29f57eee6bc265c4faf0675b92f70918ef7b7cda777865fd2da4bfac3761a7afb41
-  data.tar.gz: 18e39e2afe1ccca46ff6f4c39ef76471a99d68bb23f1efd92675ad11c04fd1cf04a559ad5a41be67ae193b21b1de1b319be6664e56e1f9bcc7d0e30980a1eaca
+  metadata.gz: 2dffbcd9dd09a96c0808d43616726758749a6c2c6a38b70ebeff2ec69a9259fd804e68b7e1870d509b547b7381afdc73463988f90eee52c5dffac8878ab3bfd3
+  data.tar.gz: ad110b572a752c1163e0f1cb7a058391a9efe612325307708b40433053eddcfce6d2f5e7e207ade2881842396a7abacb2b29ef09f8e4cb83902038e9d8aac900

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.3.3
+sudo: false
+cache:
+  - bundler
+notifications:
+  email: false
+script: bundle exec rspec
+env:
+  - RAILS_VERSION='~> 4.0.0'
+  - RAILS_VERSION='~> 4.1.0'
+  - RAILS_VERSION='~> 4.2.0'
+  - RAILS_VERSION='~> 5.0.0'

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0
+* Interface changed: call `automatically_log_changes` in your model instead of setting up an `after_initialize` callback.
+* `automatically_log_changes` now supports list of columns to exclude.
+
+# 0.0.2
+* Birthday

data/Gemfile

@@ -1,4 +1,8 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in changes_are_logged.gemspec
-gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry-byebug'
+end

data/README.md

@@ -3,18 +3,20 @@ Changes Are Logged
 
 This is a simple way to record when a ActiveRecord model is modified.
 
-USAGE
-=====
+## Usage
 
-Hook changes_are_logged into your ActiveRecord model:
+Hook changes_are_logged into your ActiveRecord model by calling the `automatically_log_changes` method:
 
+```ruby
 class Game < ActiveRecord::Base
   include ChangesAreLogged
-  after_initialize :automatically_log_changes
+  automatically_log_changes
 end
+```
 
-Then anytime that object is modified, a new entry in the change_logs table will be added:
-<pre><code>
+Then any time that object is modified, a new entry in the `change_logs` table will be added:
+
+```
 > game.change_logs
  => []
 > game.update_attribute(:name, 'Wombats Rule')
@@ -22,28 +24,42 @@ Then anytime that object is modified, a new entry in the change_logs table will
 > game.change_logs
  => [#<ChangeLog id: 442, target_id: 65, target_type: "Game", changes_logged: {"name"=>["Old Name", "Wombats Rule"]}, comments: nil, user_id: 68, created_at: "2011-11-16 00:01:04">]
 >
-</code></pre>
-
-ASSUMPTIONS
-===========
-
-The method 'current_user' is defined by your app, and returns the User that is currently logged in.
-
-TODO
-====
-
-Add migration for creation of the change_logs table. For now, here is the schema:
-<pre><code>
-mysql> desc change_logs;
-+----------------+--------------+------+-----+---------+----------------+
-| Field          | Type         | Null | Key | Default | Extra          |
-+----------------+--------------+------+-----+---------+----------------+
-| id             | int(11)      | NO   | PRI | NULL    | auto_increment |
-| target_id      | int(11)      | YES  |     | NULL    |                |
-| target_type    | varchar(255) | YES  |     | NULL    |                |
-| changes_logged | text         | YES  |     | NULL    |                |
-| comments       | text         | YES  |     | NULL    |                |
-| user_id        | int(11)      | YES  |     | NULL    |                |
-| created_at     | datetime     | YES  |     | NULL    |                |
-+----------------+--------------+------+-----+---------+----------------+
-</code></pre>
+```
+
+You can alter the logged values by passing a block to `automatically_log_changes`, which can be handy if the column contains a complex Ruby object (think Carrierwave uploaders, etc). The block expects you to return a two-element array with the modified old and new values:
+
+```ruby
+class Game < ActiveRecord::Base
+  # example carrierwave uploader attached to the 'thumbnail' column
+  mount_uploader :thumbnail, MyApp::MyThumbnailUploader
+
+  include ChangesAreLogged
+  automatically_log_changes do |attribute, old_value, new_value|
+    if attribute == 'thumbnail'
+      [old_value.filename, new_value.filename]  # or something similar
+    end
+  end
+end
+```
+
+Now the value of the `thumbnail` column won't be included if it changes. The text "Attribute changed, but value has been filtered." will be logged instead.
+
+## Assumptions
+
+The method `current_user` is defined by your app, and returns the user instance that is currently logged in.
+
+## Setup
+
+Add migration for creation of the `change_logs` table. Here's the important bit:
+
+```ruby
+create_table :change_logs do |t|
+  t.column :target_id, :integer
+  t.column :target_type, :string
+  t.column :changes_logged, :text
+  t.column :comments, :text
+  t.column :user_id, :integer
+  t.column :user_is_staff, :boolean
+  t.timestamps
+end
+```

data/changes_are_logged.gemspec

@@ -5,21 +5,19 @@ require "changes_are_logged/version"
 Gem::Specification.new do |s|
   s.name        = "changes_are_logged"
   s.version     = ChangesAreLogged::VERSION
-  s.authors     = ["nyu", "jdb", "cef", "ejk"]
-  s.email       = ""
-  s.homepage    = ""
-  s.summary     = %q{Log changes for record keeping}
-  s.description = %q{change_log}
-
-  s.rubyforge_project = "changes_are_logged"
+  s.authors     = ['Lawrence Wang', 'Cameron Dutro']
+  s.homepage    = 'https://github.com/lumoslabs/changes_are_logged'
+  s.summary     = 'Tracks changes to your activerecord models'
+  s.description = 'Tracks changes to your activerecord models'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency 'activerecord', ENV.fetch('RAILS_VERSION', '>= 4.0')
+
   # specify any dependencies here instead of Gemfile:
-  s.add_development_dependency 'rspec-rails', '2.7.0'
-  s.add_development_dependency 'activerecord', '3.0.11'
-  s.add_development_dependency 'sqlite3', '1.3.4'
+  s.add_development_dependency 'rspec-rails', '~> 3.0'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/lib/changes_are_logged/change_log.rb

@@ -35,21 +35,21 @@ class ChangeLog < ActiveRecord::Base
     return nil unless user_id
     user_is_staff ? StaffUser.find(user_id) : User.find(user_id)
   end
-  
+
   def has_changes?
     changes_logged && changes_logged.any?
   end
-  
+
   def pretty_change_hashes
     changes_logged.map do |k, (from, to)|
       {
-        :key  => k, 
-        :from => self.class.pretty_value(from), 
+        :key  => k,
+        :from => self.class.pretty_value(from),
         :to   => self.class.pretty_value(to)
       }
     end
   end
-  
+
   def self.pretty_value(v)
     if v.nil?
       "(nil)"
@@ -59,5 +59,5 @@ class ChangeLog < ActiveRecord::Base
       v.pretty_inspect
     end
   end
-  
-end
+
+end

data/lib/changes_are_logged/version.rb

@@ -1,3 +1,3 @@
 module ChangesAreLogged
-  VERSION = "0.0.2"
+  VERSION = '1.0.0'
 end

data/lib/changes_are_logged.rb

@@ -1,4 +1,4 @@
-require "changes_are_logged/version"
+require 'changes_are_logged/version'
 require 'changes_are_logged/change_log'
 
 module ChangesAreLogged
@@ -17,12 +17,23 @@ module ChangesAreLogged
         end
       end
 
-      if self.new_record?
+      if new_record?
         @change_comments = "new record" if @change_comments.blank?
         @changes_logged = {}
         save_change_log
-      elsif self.changed? || !@change_comments.blank?
-        @changes_logged = self.changes
+      elsif changed? || !@change_comments.blank?
+        @changes_logged = HashWithIndifferentAccess.new
+
+        if log_changes_callback
+          changes.each do |attribute, (old_value, new_value)|
+            @changes_logged[attribute] = log_changes_callback.call(
+              attribute, old_value, new_value
+            )
+          end
+        else
+          @changes_logged.merge!(changes)
+        end
+
         @changes_logged.delete("updated_at")
         save_change_log
       end
@@ -30,8 +41,8 @@ module ChangesAreLogged
 
     def save_change_log
       self.change_logs << ChangeLog.new(
-        :changes_logged => @changes_logged, 
-        :user_id        => @modifying_user_id, 
+        :changes_logged => @changes_logged,
+        :user_id        => @modifying_user_id,
         :comments       => @change_comments,
         :user_is_staff  => @modifying_user_is_staff
       )
@@ -43,18 +54,25 @@ module ChangesAreLogged
     def attribute_change(attr)
       [changed_attributes[attr], __send__(:read_attribute, attr)] if attribute_changed?(attr)
     end
+  end
 
-    def automatically_log_changes
-      @log_changes = true
+  module ClassMethods
+    def automatically_log_changes(&block)
+      after_initialize -> do
+        @log_changes = true
+        @log_changes_callback = block
+      end
     end
   end
 
   def self.included(klass)
     klass.class_eval do
       include InstanceMethods
+      extend ClassMethods
       attr_accessor :modifying_user_id
       attr_accessor :change_comments
       attr_accessor :log_changes
+      attr_reader :log_changes_callback
       before_save :log_it
       has_many :change_logs, :as => :target
     end

data/spec/change_log_spec.rb

@@ -13,23 +13,56 @@ describe 'ChangeLog' do
     end
   end
 
-  context 'Making changes to a game with change comments' do
-    before do
-      @game = Game.create
-      @original_change_logs_size = @game.change_logs.size
-      @original_name = @game.name
-      @original_slug = @game.url_slug
-      @game.name = 'shazam!'
-      @game.url_slug = 'shazam'
-      @comment = 'switching to cooler name'
-      @game.change_comments = @comment
-      @game.save!
+  shared_examples 'a change-logging game model' do |game_class|
+    let(:game) { game_class.create.tap { |g| g.change_comments = comment } }
+    let(:comment) { 'switching to cooler name' }
+    let(:new_attributes) { { name: 'shazam!', url_slug: 'shazam' } }
+    let(:change_log) { game.change_logs.last }
+
+    it 'creates a new change log record with the correct attributes' do
+      original_attributes = game.attributes
+
+      expect { game.update_attributes(new_attributes) }.to(
+        change { game.change_logs.count }.from(1).to(2)
+      )
+
+      expect(change_log.changes_logged).to eq(
+        'name'     => [original_attributes[:name], new_attributes[:name]],
+        'url_slug' => [original_attributes[:url_slug], new_attributes[:url_slug]]
+      )
     end
 
-    it 'should record the change comments in the change_logs' do
-      @game.reload.change_logs.size.should == @original_change_logs_size + 1
-      @game.change_logs.last.changes_logged.should == {"name" => [@original_name, "shazam!"], "url_slug"=>[@original_slug, "shazam"]}
-      @game.change_logs.last.comments.should == @comment
+    it 'includes the given comment in the change log record' do
+      game.update_attributes(new_attributes)
+      expect(change_log.comments).to eq(comment)
+    end
+  end
+
+  context 'with a standard game model' do
+    it_behaves_like 'a change-logging game model', Game
+  end
+
+  context 'with an STI model' do
+    it_behaves_like 'a change-logging game model', SubclassedGame
+  end
+
+  context 'with a model that modifies certain logged values' do
+    let(:game) { OtherGame.create.tap { |g| g.change_comments = comment } }
+    let(:comment) { 'switching to cooler name' }
+    let(:new_attributes) { { name: 'shazam!', url_slug: 'shazam' } }
+    let(:change_log) { game.change_logs.last }
+
+    it 'creates a new change log record with modified column values' do
+      original_attributes = game.attributes
+
+      expect { game.update_attributes(new_attributes) }.to(
+        change { game.change_logs.count }.from(1).to(2)
+      )
+
+      expect(change_log.changes_logged).to eq(
+        'name'     => ['old_', 'new_shazam!'],
+        'url_slug' => [original_attributes[:url_slug], 'shazam']
+      )
     end
   end
 

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'active_record'
+require 'pry-byebug'
 
 require 'changes_are_logged'
 
-require 'support/database_helpers' #test_data'
+require 'support/database_helpers'
 
 RSpec.configure do |config|
   config.include ChangesAreLogged::Spec::DatabaseHelpers
@@ -17,4 +18,4 @@ RSpec.configure do |config|
   config.after do
     teardown_db
   end
-end
+end

data/spec/support/database_helpers.rb

@@ -20,6 +20,13 @@ module ChangesAreLogged
             t.column :created_at, :datetime
             t.column :updated_at, :datetime
           end
+
+          create_table :other_games do |t|
+            t.column :name, :string
+            t.column :url_slug, :string
+            t.column :created_at, :datetime
+            t.column :updated_at, :datetime
+          end
         end
       end
 
@@ -31,9 +38,23 @@ module ChangesAreLogged
 
       class ::Game < ActiveRecord::Base
         include ChangesAreLogged
-        after_initialize :automatically_log_changes
+        automatically_log_changes
+      end
+
+      class ::OtherGame < ActiveRecord::Base
+        include ChangesAreLogged
+        automatically_log_changes do |attribute, old_value, new_value|
+          if attribute == 'name'
+            ["old_#{old_value}", "new_#{new_value}"]
+          else
+            [old_value, new_value]
+          end
+        end
+      end
+
+      class ::SubclassedGame < Game
       end
     end
 
   end
-end
+end

metadata

@@ -1,67 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: changes_are_logged
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
-- nyu
-- jdb
-- cef
-- ejk
+- Lawrence Wang
+- Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
 date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.11
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.11
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
-description: change_log
-email: ''
+        version: '1.3'
+description: Tracks changes to your activerecord models
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -72,7 +73,7 @@ files:
 - spec/change_log_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_helpers.rb
-homepage: ''
+homepage: https://github.com/lumoslabs/changes_are_logged
 licenses: []
 metadata: {}
 post_install_message: 
@@ -90,11 +91,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: changes_are_logged
-rubygems_version: 2.2.3
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Log changes for record keeping
+summary: Tracks changes to your activerecord models
 test_files:
 - spec/change_log_spec.rb
 - spec/spec_helper.rb