models_timeline 0.0.1.2 → 0.0.2

data/README.rdoc

@@ -4,7 +4,7 @@ Track the entire life cycle of ActiveRecord models.
 ==Installation
 Add the gem to your Gemfile
 
-  gem "timeline"
+  gem "models_timeline"
 
 Copy some migration stuff:
 
@@ -13,7 +13,7 @@ Copy some migration stuff:
 
 Add to your route.rb file:
 
-  mount Timeline::Engine => "/timeline"
+  mount ModelsTimeline::Engine => "/timeline"
 
 Requires Ruby 1.9.2 or later.
 
@@ -37,6 +37,10 @@ Track one or more attributes:
 
 Only the changes of name and price will be tracked.
 
+To see the tracked changes go to:
+
+  http://domain:port/models_timeline
+
 Development
 Questions or problems? Please post them on the issue tracker. You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running bundle and rake.
 

data/app/controllers/models_timeline/application_controller.rb

@@ -0,0 +1,4 @@
+module ModelsTimeline
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/models_timeline/tracks_controller.rb

@@ -0,0 +1,23 @@
+require_dependency "models_timeline/application_controller"
+
+module ModelsTimeline
+  class TracksController < ApplicationController
+    def index
+      @tracks = Track.all
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @tracks }
+      end
+    end
+
+    def show
+      @track = Track.find(params[:id])
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @track }
+      end
+    end
+  end
+end

data/app/helpers/timeline/application_helper.rb

@@ -1,4 +1,4 @@
-module Timeline
+module ModelsTimeline
   module ApplicationHelper
   end
 end

data/app/helpers/timeline/tracks_helper.rb

@@ -1,4 +1,4 @@
-module Timeline
+module ModelsTimeline
   module TracksHelper
   end
 end

data/app/models/models_timeline/track.rb

@@ -0,0 +1,7 @@
+module ModelsTimeline
+  class Track < ActiveRecord::Base
+    serialize :model_changes
+    attr_accessible :action, :item_id, :model_changes, :model_name
+    default_scope order('created_at DESC')
+  end
+end

data/config/routes.rb

@@ -1,3 +1,3 @@
-Timeline::Engine.routes.draw do
+ModelsTimeline::Engine.routes.draw do
   root :to => "tracks#index"
 end

data/db/migrate/20121227092029_create_models_timeline_tracks.rb

@@ -0,0 +1,14 @@
+class CreateModelsTimelineTracks < ActiveRecord::Migration
+  def change
+    create_table :models_timeline_tracks do |t|
+      t.integer :item_id
+      t.string :model_name
+      t.string :action
+      t.string :model_changes
+
+      t.timestamps
+    end
+    add_index(:models_timeline_tracks, :item_id)
+    add_index(:models_timeline_tracks, :model_name)
+  end
+end

data/lib/models_timeline/engine.rb

@@ -0,0 +1,9 @@
+require "models_timeline/engine"
+require "models_timeline/model_additions"
+require "models_timeline/railtie"
+
+module ModelsTimeline
+  class Engine < ::Rails::Engine
+    isolate_namespace ModelsTimeline
+  end
+end

data/lib/models_timeline/model_additions.rb

@@ -0,0 +1,60 @@
+module ModelsTimeline
+  module ModelAdditions
+    def self.extended(obj) #:nodoc
+      obj.send :include, ClassMethods
+    end
+
+    # To track your model changes call <tt> timeline </tt>
+    # in any Active Record model class.
+    #
+    #   class Product < ActiveRecord::Base
+    #     timeline
+    #   end
+    #
+    # To track only one or a set of attributes(columns) call <tt> timeline :attr1, :attr2 </tt>.
+    #
+    #   class Product < ActiveRecord::Base
+    #     timeline :price, :description
+    #   end
+    #
+    def timeline(*attrs)
+      track(attrs)
+    end
+
+  private
+    def track(attributes)
+      after_create do |record|
+        map_attributes_and_save('created', attributes)
+      end
+
+      after_update do |record|
+        map_attributes_and_save('updated', attributes)
+      end
+
+      after_destroy do |record|
+        map_attributes_and_save('destroyed', attributes)
+      end
+    end
+  end
+
+  module ClassMethods
+    def map_attributes_and_save(action, attributes={})
+      attributes = attributes.map{|a| a.to_s unless a.is_a? String}
+
+      model_changes = unless attributes.empty?
+       HashWithIndifferentAccess.new self.changes.select{|c| attributes.include?(c)}
+      else
+        self.changes
+      end
+
+      model_changes.delete(:created_at)
+      model_changes.delete(:updated_at)
+
+      Track.create!({
+        item_id: self.id,
+        model_name: self.class.model_name,
+        action: action,
+        model_changes: model_changes })
+      end
+    end
+  end

data/lib/models_timeline/railtie.rb

@@ -0,0 +1,9 @@
+module ModelsTimeline
+  class Railtie < Rails::Railtie
+    initializer 'timeline.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/models_timeline/version.rb

@@ -0,0 +1,3 @@
+module ModelsTimeline
+  VERSION = "0.0.1.2"
+end

data/lib/models_timeline.rb

@@ -0,0 +1,3 @@
+require 'models_timeline/engine'
+module ModelsTimeline
+end

data/lib/tasks/timeline_tasks.rake

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
-# task :timeline do
-#   # Task goes here
-# end
+task :timeline do
+   # Task goes here
+end

data/lib/timeline/version.rb

@@ -1,3 +1,3 @@
-module Timeline
-  VERSION = "0.0.1.2"
+module ModelsTimeline
+  VERSION = "0.0.2"
 end

data/lib/timeline.rb

@@ -1,3 +1,3 @@
 require 'timeline/engine'
-module Timeline
+module ModelsTimeline
 end

data/test/functional/timeline/tracks_controller_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-module Timeline
+module ModelsTimeline
   class TracksControllerTest < ActionController::TestCase
     fixtures 'timeline/tracks'
     setup do

data/test/model/helpers/timeline/timelines_helper_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-module Timeline
+module ModelsTimeline
   class TimelinesHelperTest < ActionView::TestCase
   end
 end

data/test/model/helpers/tracks_helper_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-module Timeline
+module ModelsTimeline
   class TracksHelperTest < ActionView::TestCase
   end
 end

data/test/model/modesl_timeline/track_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+require 'debugger'
+module ModelsTimeline
+  class TrackTest < ActiveSupport::TestCase
+    self.use_transactional_fixtures = true
+
+    setup do
+      Track.destroy_all
+    end
+
+    def attr
+      {name: 'angelo', days: 2, done: true}
+    end
+
+    def new_project
+      Project.create!(attr)
+    end
+
+    test "test model addition" do
+      assert_kind_of Class, Project
+      assert_respond_to Project, :timeline
+      assert_respond_to Project, :timeline, {}
+    end
+
+    test "track all model attributes" do
+      Project.timeline
+      project = new_project
+
+      track = Track.first
+      assert_equal Track.all.count, 1
+      assert_equal track.model_name, 'Project'
+      #test if all attributes are correctly stored
+      attr.each_key do |k|
+        assert_equal track.model_changes[k], [nil, attr[k]]
+      end
+
+      #update
+      project.update_attributes({name: 'pippo'})
+      track = Track.first
+      assert_equal Track.all.count, 2
+      assert_equal track.model_name, 'Project'
+      assert_equal track.action, 'updated'
+      #test track added on update
+      assert_equal track.model_changes.size, 1
+      debugger
+      assert_equal track.model_changes[:name], ['angelo','pippo']
+
+      #destroy
+      project.destroy
+      track = Track.first
+      assert_equal Track.all.count, 3
+      assert_equal track.model_name, 'Project'
+      assert_equal track.action, 'destroyed'
+      #test track added on update
+      assert_equal track.model_changes.size, 0
+    end
+
+    test "track all some attributes" do
+      Project.reset_callbacks :create
+      Project.reset_callbacks :update
+
+      Project.timeline(:name,:days)
+
+      project = Project.create!({name: 'angelo', days: 2, done: true})
+      assert_equal Project.all.count, 1
+      track = Track.first
+      assert_equal track.model_name, 'Project'
+      #test if all attributes are correctly stored
+      [:name, :days].each do |k|
+        assert_equal track.model_changes[k], [nil, attr[k]]
+      end
+
+      #update
+      project.update_attributes({name: 'tom', days: 4})
+      track = Track.first
+      assert_equal track.model_name, 'Project'
+      assert_equal track.action, 'updated'
+      #test track added on update
+      assert_equal track.model_changes.size, 2
+      assert_equal track.model_changes[:name], ['angelo','tom']
+      assert_equal track.model_changes[:days], [2,4]
+
+      #destroy
+      project.destroy
+      track = Track.first
+      assert_equal track.model_name, 'Project'
+      assert_equal track.action, 'destroyed'
+      #test track added on update
+    end
+
+  end
+end

data/test/model/timeline/track_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 require 'debugger'
-module Timeline
+module ModelsTimeline
   class TrackTest < ActiveSupport::TestCase
     self.use_transactional_fixtures = true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: models_timeline
 version: !ruby/object:Gem::Version
-  version: 0.0.1.2
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -71,17 +71,26 @@ files:
 - app/assets/stylesheets/scaffold.css
 - app/assets/stylesheets/timeline/application.css
 - app/assets/stylesheets/timeline/tracks.css
+- app/controllers/models_timeline/application_controller.rb
+- app/controllers/models_timeline/tracks_controller.rb
 - app/controllers/timeline/application_controller.rb
 - app/controllers/timeline/tracks_controller.rb
 - app/helpers/timeline/application_helper.rb
 - app/helpers/timeline/tracks_helper.rb
+- app/models/models_timeline/track.rb
 - app/models/timeline/track.rb
 - app/views/layouts/timeline/application.html.erb
-- app/views/timeline/tracks/_track.erb
-- app/views/timeline/tracks/index.html.erb
-- app/views/timeline/tracks/show.html.erb
+- app/views/models_timeline/tracks/_track.erb
+- app/views/models_timeline/tracks/index.html.erb
+- app/views/models_timeline/tracks/show.html.erb
 - config/routes.rb
+- db/migrate/20121227092029_create_models_timeline_tracks.rb
 - db/migrate/20121227092029_create_timeline_tracks.rb
+- lib/models_timeline/engine.rb
+- lib/models_timeline/model_additions.rb
+- lib/models_timeline/railtie.rb
+- lib/models_timeline/version.rb
+- lib/models_timeline.rb
 - lib/tasks/timeline_tasks.rake
 - lib/timeline/engine.rb
 - lib/timeline/model_additions.rb
@@ -115,6 +124,7 @@ files:
 - test/dummy/config.ru
 - test/dummy/db/migrate/20121227094706_create_projects.rb
 - test/dummy/db/schema.rb
+- test/dummy/log/development.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -129,6 +139,7 @@ files:
 - test/integration/navigation_test.rb
 - test/model/helpers/timeline/timelines_helper_test.rb
 - test/model/helpers/tracks_helper_test.rb
+- test/model/modesl_timeline/track_test.rb
 - test/model/timeline/track_test.rb
 - test/test_helper.rb
 - test/timeline_test.rb
@@ -181,6 +192,7 @@ test_files:
 - test/dummy/config.ru
 - test/dummy/db/migrate/20121227094706_create_projects.rb
 - test/dummy/db/schema.rb
+- test/dummy/log/development.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -195,6 +207,7 @@ test_files:
 - test/integration/navigation_test.rb
 - test/model/helpers/timeline/timelines_helper_test.rb
 - test/model/helpers/tracks_helper_test.rb
+- test/model/modesl_timeline/track_test.rb
 - test/model/timeline/track_test.rb
 - test/test_helper.rb
 - test/timeline_test.rb