change_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eccce87c40217d416bc63ee6941d52581f4d94fb
+  data.tar.gz: 7f11f6947cb9a51eee76dc75075049a771be59bc
+SHA512:
+  metadata.gz: f40605ad489349f0216bb96f1459c8fd31c30b34b74ab4ea8b88120580d882abf250474ee58c84d37dd1a3c2947f7ecbebabf19afee6b84d300625054d532618
+  data.tar.gz: b266ae9887155f2dc4e8824136ba1504591a550d662d8d56927a858a0cd6e3be97d1b1f057272ea8bd87d98e6810c964cbac8e4ed4d2fce44818978b5bbf2374

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.1.3"
+  - "2.3.0"

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rspec'
+end
+
+group :test do
+  gem 'activerecord'
+  gem 'sqlite3'
+  gem 'database_cleaner'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Laura Eck
+
+MIT License
+
+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

@@ -0,0 +1,39 @@
+# Change Tracker
+[![Build Status](https://travis-ci.org/Morred/change_tracker.svg?branch=master)](https://travis-ci.org/Morred/change_tracker)
+
+This gem helps you to track changes to your models. It's like a very lightweight version of gems like paper_trail, which are awesome but felt like overkill for what I needed at that point in time (specifically a changelog that would just display changes to records, no need for rolling back to earlier versions etc).
+
+It adds a table to your database where it will then proceed to track changes (creating, updating and deleting) to records of the models you want to track. 
+
+This includes the model name and ID of the record as well as the change type (:added_record, :changed_record, :deleted_record) and the data that changed.
+When creating or deleting a record, Change Tracker will serialize and save the complete record into the changed_data field, whereas when updating a record it will only save the attributes that have changed.
+
+
+## Setup
+
+Add the gem to your Gemfile.
+```
+gem 'change_tracker'
+```
+Run `bundle install`.
+
+Add a *changes* table to your database:
+```
+bundle exec rails generate change_tracker:install
+bundle exec rake db:migrate
+```
+
+## Usage
+
+Include it into the models you want to track like this:
+
+```
+class Something < ActiveRecord::Base
+
+  include ChangeTracker
+
+  ...
+
+end
+```
+That's it!

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/change_tracker.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'change_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "change_tracker"
+  spec.version       = ChangeTracker::VERSION
+  spec.authors       = ["Laura Eck"]
+  spec.email         = ["me@lauraeck.com"]
+  spec.summary       = %q{A gem to track changes to your models' data}
+  spec.description   = %q{A gem to track changes to your models' data for creating, updating and deleting}
+  spec.homepage      = "https://github.com/Morred/change_tracker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/lib/change_tracker.rb

@@ -0,0 +1,4 @@
+require "active_record"
+require "change_tracker/version"
+require "change_tracker/app/change_tracker"
+require "change_tracker/app/models/change"

data/lib/change_tracker/app/change_tracker.rb

@@ -0,0 +1,34 @@
+module ChangeTracker
+  extend ActiveSupport::Concern
+
+  included do
+    before_save :find_changes
+    after_save :save_changes
+    before_destroy :save_destroyed_record
+  end
+
+  # before_save
+  def find_changes
+    tracked_object = self
+    change_type = tracked_object.new_record? ? :added_record : :changed_record
+    @changes = Change.new(change_type: change_type, record_model: tracked_object.class.name)
+    @changes.changed_data = tracked_object.changes if @changes.change_type == 'changed_record'
+  end
+
+  # after_save
+  def save_changes
+    tracked_object = self
+    @changes.record_id = tracked_object.id
+    @changes.changed_data = tracked_object.attributes if @changes.change_type == 'added_record'
+    @changes.save!
+  end
+
+  # before_destroy
+  def save_destroyed_record
+    tracked_object = self
+    @changes = Change.create!(change_type: :deleted_record,
+                              record_model: tracked_object.class.name,
+                              changed_data: tracked_object.attributes,
+                              record_id: tracked_object.id)
+  end
+end

data/lib/change_tracker/app/models/change.rb

@@ -0,0 +1,6 @@
+class Change < ActiveRecord::Base
+  enum change_type: [ :added_record, :changed_record, :deleted_record ]
+  serialize :changed_data, Hash
+
+  validates :record_model, :record_id, :change_type, :changed_data, presence: true
+end

data/lib/change_tracker/version.rb

@@ -0,0 +1,3 @@
+module ChangeTracker
+  VERSION = "0.1.0"
+end

data/lib/generators/change_tracker/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/migration'
+
+module ChangeTracker
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "change_tracker_migration.rb", "db/migrate/change_tracker_migration.rb"
+      end
+    end
+  end
+end

data/lib/generators/change_tracker/install/templates/change_tracker_migration.rb

@@ -0,0 +1,15 @@
+class ChangeTrackerMigration < ActiveRecord::Migration
+  def self.up
+    create_table :changes do |t|
+      t.string :record_model
+      t.integer :record_id
+      t.integer :change_type, default: nil
+      t.text :changed_data
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :changes
+  end
+end

data/spec/change_tracker_spec.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8 
+require 'spec_helper'
+
+class PickledRadish < ActiveRecord::Base
+  validates :pickler, :manufacturing_date, presence: true
+end
+
+describe 'Change Tracker' do
+
+  context 'for untracked models' do
+
+    it 'does not track creating a model' do
+      PickledRadish.create(pickler: "Mortimer", manufacturing_date: Date.today)
+      expect(Change.all.count).to eq(0)
+    end
+
+    it 'does not track changing a model' do
+      jar = PickledRadish.create(pickler: "Mortimer", manufacturing_date: Date.today)
+      jar.update_attributes(pickler: "Sally")
+      expect(Change.all.count).to eq(0)
+    end
+
+    it 'does not track deleting a model' do
+      jar = PickledRadish.create(pickler: "Mortimer", manufacturing_date: Date.today)
+      jar.destroy
+      expect(Change.all.count).to eq(0)
+    end
+
+  end
+
+  context 'for tracked models' do
+    before(:each) do
+      PickledRadish.send(:include, ChangeTracker)
+    end
+
+    it 'tracks creating a model' do
+      jar = PickledRadish.create(pickler: "Mortimer", manufacturing_date: Date.today)
+      expect(Change.all.count).to eq(1)
+      change = Change.last
+      expect(change.record_model).to eq("PickledRadish")
+      expect(change.record_id).to eq(jar.id)
+      expect(change.change_type).to eq("added_record")
+      expect(change.changed_data).to include({"id"=>"#{jar.id}".to_i, "pickler"=>"Mortimer"})
+    end
+
+    it 'tracks updating a model' do
+      jar = PickledRadish.create(pickler: "Mortimer", manufacturing_date: Date.today)
+      jar.update(pickler: "Sally")
+      expect(Change.all.count).to eq(2)
+      change = Change.last
+      expect(change.record_model).to eq("PickledRadish")
+      expect(change.record_id).to eq(jar.id)
+      expect(change.change_type).to eq("changed_record")
+      expect(change.changed_data).to eq({"pickler" => ["Mortimer", "Sally"]})
+    end
+
+    it 'tracks deleting a model' do
+      jar = PickledRadish.create(pickler: "Mortimer", manufacturing_date: Date.today)
+      jar.destroy
+      expect(Change.all.count).to eq(2)
+      change = Change.last
+      expect(change.record_model).to eq("PickledRadish")
+      expect(change.record_id).to eq(jar.id)
+      expect(change.change_type).to eq("deleted_record")
+      expect(change.changed_data).to include({"id"=>"#{jar.id}".to_i, "pickler"=>"Mortimer"})
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH << '.' unless $LOAD_PATH.include?('.')
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'active_record'
+require 'database_cleaner'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+require File.expand_path('../../lib/change_tracker', __FILE__)
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :changes do |t|
+    t.string   :record_model
+    t.integer  :record_id
+    t.integer  :change_type
+    t.text     :changed_data
+    t.timestamps
+  end
+
+  create_table :pickled_radishes do |t|
+    t.string :pickler
+    t.datetime :manufacturing_date
+  end
+end
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: change_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laura Eck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: A gem to track changes to your models' data for creating, updating and
+  deleting
+email:
+- me@lauraeck.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- change_tracker.gemspec
+- lib/change_tracker.rb
+- lib/change_tracker/app/change_tracker.rb
+- lib/change_tracker/app/models/change.rb
+- lib/change_tracker/version.rb
+- lib/generators/change_tracker/install/install_generator.rb
+- lib/generators/change_tracker/install/templates/change_tracker_migration.rb
+- spec/change_tracker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Morred/change_tracker
+licenses:
+- MIT
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to track changes to your models' data
+test_files:
+- spec/change_tracker_spec.rb
+- spec/spec_helper.rb
+has_rdoc: