hound 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 788da607d57abb6490a4ef46a87442a887e17edd
-  data.tar.gz: a3adbd30914bc452af590c8f5acf7bbbbf6ccab5
+  metadata.gz: dbbb90e55615005651013a007a49add63ba47920
+  data.tar.gz: 6b477231c8ac9307b8e6b6a8a6aa0a3a0a66044c
 SHA512:
-  metadata.gz: 548a27cd88a07f80ac75dfa0a3f5ed2e0b7b13ff553e6917949379165fd1929eb967efdae776c261c6494c99fe94d1186aaa62dd86e394c81babce1a11bff7cd
-  data.tar.gz: 04109465ee9387282a5fbed0b186d974b963e78ab0eedaf1f7606aa1b889f4259c0d48be9958dcf7beb5a5d08f4dc546fb187b8e7ac440a15185fe4c04be87de
+  metadata.gz: cc5d8f271aabddb48373cfcee959c9e3d0848c1f018719cb9dc3bc96d250b56d701e15ef939f7b06df9bf0a6f87fe3d695ea30e14231d66356e674b6568dd04c
+  data.tar.gz: 635412aa1c93cacef0b7ba2d687682b2827619da9a00b0e4f27f21b19c18166287a0ffa12b64b59ba0cb97c5c5aedafec695b65922def8860058b9f514caee97

data/.travis.yml

@@ -1,9 +1,8 @@
+language: ruby
+before_script: 'cd test/dummy && bundle exec rake db:migrate'
 rvm:
   - 1.9.2
   - 1.9.3
-  - ruby-head
-  - jruby-19mode
-  - rbx-18mode
 notifications:
   email:
     on_success: change

data/README.md

@@ -65,7 +65,29 @@ Hound.config.user_class = 'CustomUser'
 Hound.config.user_class = AdminUser # String or constant
 ```
 
-### Cleaning up actions
+You can also disable Hound on a model instance basis:
+
+```ruby
+article = Article.new title: 'Hello, World!'
+article.hound? #=> true
+article.hound = false # disable hound
+article.save
+article.actions #=> []
+```
+
+## Changes
+
+Hound also tracks the changes made when updating your hounded records. You
+can access the change updates through the `changeset` attribute:
+
+```ruby
+article = Article.create! title: 'Hello, World!'
+article.update_attributes(title: 'Salut, World!')
+article.actions.last.changeset
+  #=> {"title" => ["Hello, World!", "Salut, World!"]}
+```
+
+## Cleaning Up
 
 With all this action creating we're doing, your database is bound to start
 getting full quickly. You have two options for cleaning up after yourself,
@@ -90,4 +112,10 @@ configure this globally through `Hound.config.limit`, too. Do note though
 that adding this functionality means whenever an action is tracked, Hound
 will not only create a new action, it will check and destroy any actions
 outside of this limit. This requires an extra call to the database, so if
-that could be an issue, using a rake task might be a better idea.
+that could be an issue, using a rake task might be a better idea.
+
+## TODO
+
+* Implement action grouping
+* Generate a config initializer on install?
+* Disable hound in test environment?

data/lib/generators/hound/templates/create_hound_actions.rb

@@ -6,6 +6,7 @@ class CreateHoundActions < ActiveRecord::Migration
       t.integer  :actionable_id,   null: false
       t.integer  :user_id
       t.datetime :created_at
+      t.text     :changeset
     end
     add_index :hound_actions, [:actionable_type, :actionable_id]
   end

data/lib/hound/action.rb

@@ -1,9 +1,10 @@
 module Hound
   class Action < ActiveRecord::Base
     self.table_name = 'hound_actions'
-    attr_accessible :action, :actionable_id, :actionable_type, :user_id
+    attr_accessible :action, :actionable_id, :actionable_type, :user_id, :changeset
     belongs_to :actionable, polymorphic: true
     belongs_to :user, class_name: Hound.config.user_class
+    serialize :changeset, Hash
 
     scope :created,   -> { where(action: 'create')  }
     scope :updated,   -> { where(action: 'update')  }

data/lib/hound/model.rb

@@ -23,6 +23,8 @@ module Hound
         class_attribute :hound_options
         self.hound_options = options.dup
 
+        attr_accessor :hound
+
         # Add action hooks
         after_create :hound_create if options[:actions].include?('create')
         before_update :hound_update if options[:actions].include?('update')
@@ -32,27 +34,41 @@ module Hound
 
     module InstanceMethods
 
+      # Return all actions in provided date.
+      def actions_for_date(date)
+        actions.where(created_at: date)
+      end
+
+      # Returns true if hound is enabled on this instance.
+      def hound?
+        hound != false
+      end
+
       private
 
       def hound_create
+        return unless hound?
         attributes = default_attributes.merge(action: 'create')
         actions.create! attributes
-        inforce_limit
+        enforce_limit
       end
 
       def hound_update
+        return unless hound?
         attributes = default_attributes.merge(action: 'update')
+        attributes.merge!(changeset: changes)
         actions.create! attributes
-        inforce_limit
+        enforce_limit
       end
 
       def hound_destroy
+        return unless hound?
         attributes = default_attributes.merge(action: 'destroy')
         attributes.merge!(
           actionable_id: self.id,
           actionable_type: self.class.base_class.name)
         Hound::Action.create(attributes)
-        inforce_limit
+        enforce_limit
       end
 
       def default_attributes
@@ -61,7 +77,7 @@ module Hound
         }
       end
 
-      def inforce_limit
+      def enforce_limit
         limit = self.class.hound_options[:limit]
         limit ||= Hound.config.limit
         if limit and actions.size > limit

data/lib/hound/version.rb

@@ -1,3 +1,3 @@
 module Hound
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/dummy/db/migrate/20130310103454_add_changeset_to_hound_actions.rb

@@ -0,0 +1,5 @@
+class AddChangesetToHoundActions < ActiveRecord::Migration
+  def change
+    add_column :hound_actions, :changeset, :text
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130308110847) do
+ActiveRecord::Schema.define(:version => 20130310103454) do
 
   create_table "articles", :force => true do |t|
     t.string   "title"
@@ -26,6 +26,7 @@ ActiveRecord::Schema.define(:version => 20130308110847) do
     t.integer  "actionable_id",   :null => false
     t.integer  "user_id"
     t.datetime "created_at"
+    t.text     "changeset"
   end
 
   add_index "hound_actions", ["actionable_type", "actionable_id"], :name => "index_hound_actions_on_actionable_type_and_actionable_id"

data/test/unit/model_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class ModelTest < ActiveSupport::TestCase
+
+  setup do
+    @article = Article.create! title: 'Hello, World!', body: 'Lorem Ipsum'
+  end
+
+  test 'actions_for_date' do
+    @article.actions.create!(action: 'created').tap { |x| x.created_at = 3.days.ago; x.save }
+    @article.actions.create!(action: 'created').tap { |x| x.created_at = 5.days.from_now; x.save }
+    @article.actions.create!(action: 'created').tap { |x| x.created_at = Date.today; x.save }
+    assert_equal 2, @article.actions_for_date(2.days.ago..3.days.from_now).size
+  end
+
+  test 'avoid tracking actions on an instance' do
+    article = Article.new title: 'Hello, World!', body: 'Lorem Ipsum'
+    article.hound = false
+    article.save
+    assert_empty article.actions
+  end
+
+  test 'tracking model changes' do
+    @article.update_attributes(title: 'Salut, World!')
+    assert_equal({"title" => ["Hello, World!", "Salut, World!"]}, @article.actions.last.changeset)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hound
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -99,6 +99,7 @@ files:
 - test/dummy/db/migrate/20130307165837_create_articles.rb
 - test/dummy/db/migrate/20130307183451_create_posts.rb
 - test/dummy/db/migrate/20130308110847_create_hound_actions.rb
+- test/dummy/db/migrate/20130310103454_add_changeset_to_hound_actions.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -118,6 +119,7 @@ files:
 - test/functional/controller_test.rb
 - test/hound_test.rb
 - test/test_helper.rb
+- test/unit/model_test.rb
 homepage: https://github.com/injekt/hound
 licenses: []
 metadata: {}
@@ -179,6 +181,7 @@ test_files:
 - test/dummy/db/migrate/20130307165837_create_articles.rb
 - test/dummy/db/migrate/20130307183451_create_posts.rb
 - test/dummy/db/migrate/20130308110847_create_hound_actions.rb
+- test/dummy/db/migrate/20130310103454_add_changeset_to_hound_actions.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -198,3 +201,4 @@ test_files:
 - test/functional/controller_test.rb
 - test/hound_test.rb
 - test/test_helper.rb
+- test/unit/model_test.rb