changes_are_logged 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c0a48f3d22566d6b3ce0e11581f26e349927a31
+  data.tar.gz: 9f236ae8f678bdc46e2796b203d2de2485c6c466
+SHA512:
+  metadata.gz: e8c63536e1e473aaa7edab32adfcc79c5ba25ff23a0851c1414c9445e8cbe29f57eee6bc265c4faf0675b92f70918ef7b7cda777865fd2da4bfac3761a7afb41
+  data.tar.gz: 18e39e2afe1ccca46ff6f4c39ef76471a99d68bb23f1efd92675ad11c04fd1cf04a559ad5a41be67ae193b21b1de1b319be6664e56e1f9bcc7d0e30980a1eaca

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in changes_are_logged.gemspec
+gemspec

data/README.md

@@ -0,0 +1,49 @@
+Changes Are Logged
+==================
+
+This is a simple way to record when a ActiveRecord model is modified.
+
+USAGE
+=====
+
+Hook changes_are_logged into your ActiveRecord model:
+
+class Game < ActiveRecord::Base
+  include ChangesAreLogged
+  after_initialize :automatically_log_changes
+end
+
+Then anytime that object is modified, a new entry in the change_logs table will be added:
+<pre><code>
+> game.change_logs
+ => []
+> game.update_attribute(:name, 'Wombats Rule')
+ => true
+> 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>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/changes_are_logged.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+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.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.require_paths = ["lib"]
+
+  # 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'
+end

data/lib/changes_are_logged.rb

@@ -0,0 +1,62 @@
+require "changes_are_logged/version"
+require 'changes_are_logged/change_log'
+
+module ChangesAreLogged
+  module InstanceMethods
+    def log_it
+      return unless @log_changes
+
+      # FIXME too complected with lumos_rails
+      unless @modifying_user_id
+        @modifying_user_id = if defined?(StaffUser) && staff_user = StaffUser.current
+          @modifying_user_is_staff = true
+          staff_user.id
+        end
+        @modifying_user_id ||= if defined?(current_user) && current_user && current_user.respond_to?(:id)
+          current_user.id
+        end
+      end
+
+      if self.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
+        @changes_logged.delete("updated_at")
+        save_change_log
+      end
+    end
+
+    def save_change_log
+      self.change_logs << ChangeLog.new(
+        :changes_logged => @changes_logged, 
+        :user_id        => @modifying_user_id, 
+        :comments       => @change_comments,
+        :user_is_staff  => @modifying_user_is_staff
+      )
+      @change_comments = nil
+    end
+
+    # this modifies dirty.rb behavior.  previously #changes returned the change in the accessor method
+    # now, #changes will return raw changes made to actual database attributes
+    def attribute_change(attr)
+      [changed_attributes[attr], __send__(:read_attribute, attr)] if attribute_changed?(attr)
+    end
+
+    def automatically_log_changes
+      @log_changes = true
+    end
+  end
+
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+      attr_accessor :modifying_user_id
+      attr_accessor :change_comments
+      attr_accessor :log_changes
+      before_save :log_it
+      has_many :change_logs, :as => :target
+    end
+  end
+end

data/lib/changes_are_logged/change_log.rb

@@ -0,0 +1,63 @@
+class ChangeLog < ActiveRecord::Base
+
+  IGNORED_KEYS = ["updated_at"]
+
+  belongs_to :target, :polymorphic => true
+  serialize :changes_logged
+
+  scope :for_target_id, lambda {|target_id| {:conditions => {:target_id => target_id}}}
+  scope :for_target_type, lambda {|target_type| {:conditions => {:target_type => target_type}}}
+
+  validates :target, :presence => true
+
+  def pretty_changes(html = false)
+    change_string = ""
+    if has_changes?
+      changes_logged.each do |k,v|
+        unless IGNORED_KEYS.include?(k)
+          from = self.class.pretty_value(v[0])
+          to = self.class.pretty_value(v[1])
+
+          change_string << (html ? "&bull;&nbsp;" : "- ")
+          change_string << (html ? "<i>#{k}</i>" : k)
+          change_string << " CHANGED FROM #{from} TO #{to}"
+          change_string << (html ? "<br/>" : "\n")
+        end
+      end
+      change_string.html_safe
+    else
+      "No changes!"
+    end
+  end
+
+  # FIXME too complected with lumos_rails
+  def user
+    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), 
+        :to   => self.class.pretty_value(to)
+      }
+    end
+  end
+  
+  def self.pretty_value(v)
+    if v.nil?
+      "(nil)"
+    elsif v == ""
+      "(empty)"
+    else
+      v.pretty_inspect
+    end
+  end
+  
+end

data/lib/changes_are_logged/version.rb

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

data/spec/change_log_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'ChangeLog' do
+  context 'Making changes to a game' do
+    before do
+      @game = Game.create
+      @original_change_logs_size = @game.change_logs.size
+      @game.update_attribute(:name, 'shazam!')
+    end
+
+    it 'should add an entry to the change_logs' do
+      @game.reload.change_logs.size.should == @original_change_logs_size + 1
+    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!
+    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
+    end
+  end
+
+  context 'Saving a game with no changes and a blank comment' do
+    before do
+      @game = Game.create
+      @original_change_logs_size = @game.change_logs.size
+      @game.change_comments = ""
+      @game.save!
+    end
+
+    it 'should not log anything' do
+      @game.reload.change_logs.size.should == @original_change_logs_size
+    end
+  end
+
+  context 'Saving a game with no changes but a comment with content' do
+    before do
+      @game = Game.create
+      @original_change_logs_size = @game.change_logs.size
+      @game.change_comments = "commenting on a non-change"
+      @game.save!
+    end
+
+    it 'should log the comment and indicate no changes' do
+      @game.reload.change_logs.size.should == @original_change_logs_size + 1
+      @game.change_logs.last.changes_logged.should == {}
+      @game.change_logs.last.comments.should == "commenting on a non-change"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_record'
+
+require 'changes_are_logged'
+
+require 'support/database_helpers' #test_data'
+
+RSpec.configure do |config|
+  config.include ChangesAreLogged::Spec::DatabaseHelpers
+
+  config.before do
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+    setup_db
+  end
+
+  config.after do
+    teardown_db
+  end
+end

data/spec/support/database_helpers.rb

@@ -0,0 +1,39 @@
+module ChangesAreLogged
+  module Spec
+    module DatabaseHelpers
+
+      def setup_db
+        ActiveRecord::Schema.define(:version => 1) do
+          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.datetime :created_at
+          end
+
+          create_table :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
+
+      def teardown_db
+        ActiveRecord::Base.connection.tables.each do |table|
+          ActiveRecord::Base.connection.drop_table(table)
+        end
+      end
+
+      class ::Game < ActiveRecord::Base
+        include ChangesAreLogged
+        after_initialize :automatically_log_changes
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: changes_are_logged
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- nyu
+- jdb
+- cef
+- ejk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.11
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: change_log
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- changes_are_logged.gemspec
+- lib/changes_are_logged.rb
+- lib/changes_are_logged/change_log.rb
+- lib/changes_are_logged/version.rb
+- spec/change_log_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_helpers.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: changes_are_logged
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Log changes for record keeping
+test_files:
+- spec/change_log_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_helpers.rb