hound 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5124b75e28297b2fcc833c9b785afaaf30ef1a6d
-  data.tar.gz: 243191f171a35b3d0434e19ba8a8c0b2a98d7fae
+  metadata.gz: 788da607d57abb6490a4ef46a87442a887e17edd
+  data.tar.gz: a3adbd30914bc452af590c8f5acf7bbbbf6ccab5
 SHA512:
-  metadata.gz: 35a19f7e49986a4a5e9e5114de97f9416535f0fc53497f50e17c504f4522593f9d23e16cc860cc1a3a7b66f19a87cb32e1c8aed97030a831b568c29f4ca42002
-  data.tar.gz: e0ce3c16219b152035deaf16e1c748f2e0dc9ff3fc72a23d891d1e51ae6c005279b2c1e7fe52f8bf333997686d14949110376c7a3def5697109c9ac5f89d7b31
+  metadata.gz: 548a27cd88a07f80ac75dfa0a3f5ed2e0b7b13ff553e6917949379165fd1929eb967efdae776c261c6494c99fe94d1186aaa62dd86e394c81babce1a11bff7cd
+  data.tar.gz: 04109465ee9387282a5fbed0b186d974b963e78ab0eedaf1f7606aa1b889f4259c0d48be9958dcf7beb5a5d08f4dc546fb187b8e7ac440a15185fe4c04be87de

data/.gitignore

@@ -5,3 +5,4 @@ test/dummy/db/*.sqlite3
 test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - rbx-18mode
+notifications:
+  email:
+    on_success: change
+    on_failure: always

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2013 Lee Jarvis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -16,4 +16,78 @@ rails generate hound:install
 ```
 
 This will create a new migration file. Run `rake db:migrate` to add
-this table.
+this table.
+
+## Usage
+
+Hound will automatically track `create` `update` and `destroy` methods that
+occur on your 'hounded' models. You can tell Hound which actions you'd like
+to track in the `hound` method:
+
+```ruby
+class Article < ActiveRecord::Base
+  hound actions: [:create, :update] # only track create/update
+end
+```
+
+Hound also adds a `hound_action` helper method to your controllers. This
+allows you to set a custom action on any of your hounded models.
+
+```ruby
+class ArticlesController < ApplicationController
+  def add_to_frontpage
+    # Does not update @article so no action will be created
+    @frontpage << @article
+    hound_action @article, 'added_to_frontpage'
+  end
+end
+
+@article.actions.last.action #=> 'added_to_frontpage'
+```
+
+Hound will track the current user making these changes assuming your
+application controller responds to a `current_user` method. If you have a
+custom method, you can override `hound_user` to return this instead.
+
+```ruby
+class ApplicationController < ActionController::Base
+  def hound_user
+    current_admin_user
+  end
+end
+```
+
+For this to work successfully you must tell Hound about your user class
+(note that this value defaults to 'User' already).
+
+```ruby
+Hound.config.user_class = 'CustomUser'
+Hound.config.user_class = AdminUser # String or constant
+```
+
+### Cleaning up actions
+
+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,
+either create a rake task:
+
+```ruby
+task :prune_hound_actions do
+  Hound.actions.where('created_at < ?', 1.week.ago).delete_all
+end
+```
+
+And run it as a cron job, or you can simply limit records on a per model basis
+
+```ruby
+class Article < ActiveRecord::Base
+  hound limit: 10
+end
+```
+
+Now Hound will never store more than 10 actions for an Article. You can
+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.

data/hound.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split($/)
   s.test_files = s.files.grep(%r{^test/})
 
-  s.add_dependency 'rails', '>= 3.2.0'
+  s.add_dependency 'rails', '>= 3.1.0'
 
   s.add_development_dependency 'sqlite3'
 end

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

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

data/lib/hound.rb

@@ -1,6 +1,5 @@
 require 'hound/model'
 require 'hound/controller'
-require 'hound/action'
 require 'hound/config'
 require 'hound/version'
 
@@ -35,4 +34,5 @@ end
 
 ActiveSupport.on_load :active_record do
   include Hound::Model
+  require 'hound/action'
 end

data/lib/hound/action.rb

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

data/lib/hound/config.rb

@@ -7,8 +7,20 @@ module Hound
     # An Array of actions Hound should track.
     attr_accessor :actions
 
+    # The String used to represent a User class (defaults to 'User').
+    attr_reader :user_class
+
+    # Limit actions on a global basis.
+    attr_accessor :limit
+
     def initialize
       @actions = %w'create update destroy'
+      @user_class = 'User'
+      @limit = nil
+    end
+
+    def user_class=(klassname)
+      @user_class = klassname.to_s
     end
 
   end

data/lib/hound/controller.rb

@@ -11,25 +11,22 @@ module Hound
     # This method should be overridden for providing custom behavour.
     def hound_user
       @hound_user ||= current_user
-    rescue NoMethodError
+    rescue NameError
       nil
     end
 
-    def hound_user_type
-      if hound_user
-        hound_user.class.base_class.name
-      end
-    end
-
     def hound_user_id
       hound_user.try(:id)
     end
 
     private
 
+    def hound_action(object, action = params[:action])
+      object.actions.create(action: action, user_id: hound_user_id)
+    end
+
     def set_hound_user
-      Hound.store[:hound_user_type] = hound_user_type
-      Hound.store[:hound_user_id] = hound_user_id
+      Hound.store[:current_user_id] = hound_user_id
     end
 
   end

data/lib/hound/model.rb

@@ -23,6 +23,7 @@ module Hound
         class_attribute :hound_options
         self.hound_options = options.dup
 
+        # Add action hooks
         after_create :hound_create if options[:actions].include?('create')
         before_update :hound_update if options[:actions].include?('update')
         after_destroy :hound_destroy if options[:actions].include?('destroy')
@@ -34,19 +35,39 @@ module Hound
       private
 
       def hound_create
-        actions.create! action: 'create'
+        attributes = default_attributes.merge(action: 'create')
+        actions.create! attributes
+        inforce_limit
       end
 
       def hound_update
-        actions.create! action: 'update'
+        attributes = default_attributes.merge(action: 'update')
+        actions.create! attributes
+        inforce_limit
       end
 
       def hound_destroy
-        Hound::Action.create(
-          actionable_id:   self.id,
-          actionable_type: self.class.base_class.name,
-          action: 'destroy'
-        )
+        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
+      end
+
+      def default_attributes
+        {
+          user_id: Hound.store[:current_user_id]
+        }
+      end
+
+      def inforce_limit
+        limit = self.class.hound_options[:limit]
+        limit ||= Hound.config.limit
+        if limit and actions.size > limit
+          good_actions = actions.order('created_at DESC').limit(limit)
+          actions.where('id NOT IN (?)', good_actions.map(&:id)).delete_all
+        end
       end
 
     end

data/lib/hound/version.rb

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

data/test/config_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TestUserClass; end
+
+class ConfigTest < ActiveSupport::TestCase
+
+  test 'user_class' do
+    assert_equal 'User', Hound.config.user_class
+
+    Hound.config.user_class = TestUserClass
+    assert_equal 'TestUserClass', Hound.config.user_class
+  end
+
+end

data/test/dummy/app/assets/javascripts/articles.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,7 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+
+  def current_user
+    @current_user ||= User.create! name: 'Lee'
+  end
 end

data/test/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,21 @@
+class ArticlesController < ApplicationController
+
+  def create
+    @article = Article.create(params[:article])
+    head :ok
+  end
+
+  def update
+    @article = Article.find(params[:id])
+    @article.update_attributes(params[:article])
+    hound_action @article, 'something_custom'
+    head :ok
+  end
+
+  def destroy
+    @article = Article.find(params[:id])
+    @article.destroy
+    head :ok
+  end
+
+end

data/test/dummy/app/helpers/articles_helper.rb

@@ -0,0 +1,2 @@
+module ArticlesHelper
+end

data/test/dummy/app/models/post.rb

@@ -1,4 +1,4 @@
 class Post < ActiveRecord::Base
   attr_accessible :text
-  hound actions: 'create'
+  hound actions: 'update', limit: 3
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,5 @@
 Dummy::Application.routes.draw do
+  resources :articles
   # The priority is based upon order of creation:
   # first created -> highest priority.
 

data/test/dummy/db/migrate/{20130307175522_create_persued_actions.rb → 20130308110847_create_hound_actions.rb}

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

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 => 20130307183451) do
+ActiveRecord::Schema.define(:version => 20130308110847) do
 
   create_table "articles", :force => true do |t|
     t.string   "title"
@@ -24,10 +24,11 @@ ActiveRecord::Schema.define(:version => 20130307183451) do
     t.string   "action",          :null => false
     t.string   "actionable_type", :null => false
     t.integer  "actionable_id",   :null => false
+    t.integer  "user_id"
     t.datetime "created_at"
   end
 
-  add_index "hound_actions", ["actionable_type", "actionable_id"], :name => "index_houndd_actions_on_actionable_type_and_actionable_id"
+  add_index "hound_actions", ["actionable_type", "actionable_id"], :name => "index_hound_actions_on_actionable_type_and_actionable_id"
 
   create_table "posts", :force => true do |t|
     t.text     "text"

data/test/dummy/test/functional/articles_controller_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ArticlesControllerTest < ActionController::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/unit/helpers/articles_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class ArticlesHelperTest < ActionView::TestCase
+end

data/test/functional/controller_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class ControllerTest < ActionController::TestCase
+  tests ArticlesController
+
+  test 'creating an action' do
+    post :create, article_attributes
+    assert_equal 1, assigns(:article).actions.size
+  end
+
+  test 'hound_user defaults to current_user' do
+    post :create, article_attributes
+    assert_equal User.first, assigns(:article).actions.first.user
+  end
+
+  test 'custom actions' do
+    article = Article.create title: 'Salut, World!', body: 'Lorem Ipsum'
+    put :update, article_attributes.merge(id: article.id)
+    actions = assigns(:article).actions
+    assert_equal 3, actions.size # one to create, one to update, one custom
+    assert_equal 'something_custom', actions.last.action
+    assert_equal User.first, actions.last.user
+  end
+
+  private
+
+  def article_attributes
+    { article: { title: 'Hello, World!', body: 'Lorem Ipsum' } }
+  end
+end

data/test/hound_test.rb

@@ -7,7 +7,7 @@ class HoundTest < ActiveSupport::TestCase
 
   test 'hound_options' do
     assert_equal %w'create update destroy', Article.hound_options[:actions]
-    assert_equal %w'create', Post.hound_options[:actions]
+    assert_equal %w'update', Post.hound_options[:actions]
   end
 
   test 'hound model creation' do
@@ -28,4 +28,12 @@ class HoundTest < ActiveSupport::TestCase
     assert_equal 'Article', action.actionable_type
     assert_equal @article.id, action.actionable_id
   end
+
+  test 'limiting actions' do
+    @post = Post.create! text: 'lorem ipsum'
+    5.times do |n|
+      @post.update_attributes(text: "lorem ipsum #{n}")
+    end
+    assert_equal 3, @post.actions.size
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hound
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -46,8 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -62,12 +62,17 @@ files:
 - lib/hound/model.rb
 - lib/hound/version.rb
 - lib/tasks/hound_tasks.rake
+- test/config_test.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/articles.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/stylesheets/articles.css
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/articles_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/articles_helper.rb
 - test/dummy/app/mailers/.gitkeep
 - test/dummy/app/models/.gitkeep
 - test/dummy/app/models/article.rb
@@ -92,8 +97,8 @@ files:
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20130307165752_create_users.rb
 - test/dummy/db/migrate/20130307165837_create_articles.rb
-- test/dummy/db/migrate/20130307175522_create_persued_actions.rb
 - test/dummy/db/migrate/20130307183451_create_posts.rb
+- test/dummy/db/migrate/20130308110847_create_hound_actions.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -105,9 +110,12 @@ files:
 - test/dummy/test/fixtures/articles.yml
 - test/dummy/test/fixtures/posts.yml
 - test/dummy/test/fixtures/users.yml
+- test/dummy/test/functional/articles_controller_test.rb
 - test/dummy/test/unit/article_test.rb
+- test/dummy/test/unit/helpers/articles_helper_test.rb
 - test/dummy/test/unit/post_test.rb
 - test/dummy/test/unit/user_test.rb
+- test/functional/controller_test.rb
 - test/hound_test.rb
 - test/test_helper.rb
 homepage: https://github.com/injekt/hound
@@ -134,12 +142,17 @@ signing_key:
 specification_version: 4
 summary: Trace changes to your models
 test_files:
+- test/config_test.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/articles.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/stylesheets/articles.css
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/articles_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/articles_helper.rb
 - test/dummy/app/mailers/.gitkeep
 - test/dummy/app/models/.gitkeep
 - test/dummy/app/models/article.rb
@@ -164,8 +177,8 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/db/migrate/20130307165752_create_users.rb
 - test/dummy/db/migrate/20130307165837_create_articles.rb
-- test/dummy/db/migrate/20130307175522_create_persued_actions.rb
 - test/dummy/db/migrate/20130307183451_create_posts.rb
+- test/dummy/db/migrate/20130308110847_create_hound_actions.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -177,8 +190,11 @@ test_files:
 - test/dummy/test/fixtures/articles.yml
 - test/dummy/test/fixtures/posts.yml
 - test/dummy/test/fixtures/users.yml
+- test/dummy/test/functional/articles_controller_test.rb
 - test/dummy/test/unit/article_test.rb
+- test/dummy/test/unit/helpers/articles_helper_test.rb
 - test/dummy/test/unit/post_test.rb
 - test/dummy/test/unit/user_test.rb
+- test/functional/controller_test.rb
 - test/hound_test.rb
 - test/test_helper.rb

data/Gemfile.lock

@@ -1,98 +0,0 @@
-PATH
-  remote: .
-  specs:
-    hound (0.0.1)
-      rails (>= 3.2.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.13.rc2)
-      actionpack (= 3.2.13.rc2)
-      mail (~> 2.5.3)
-    actionpack (3.2.13.rc2)
-      activemodel (= 3.2.13.rc2)
-      activesupport (= 3.2.13.rc2)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.5)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.13.rc2)
-      activesupport (= 3.2.13.rc2)
-      builder (~> 3.0.0)
-    activerecord (3.2.13.rc2)
-      activemodel (= 3.2.13.rc2)
-      activesupport (= 3.2.13.rc2)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.13.rc2)
-      activemodel (= 3.2.13.rc2)
-      activesupport (= 3.2.13.rc2)
-    activesupport (3.2.13.rc2)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.4)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    jquery-rails (2.2.1)
-      railties (>= 3.0, < 5.0)
-      thor (>= 0.14, < 2.0)
-    json (1.7.7)
-    mail (2.5.3)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.21)
-    multi_json (1.6.1)
-    polyglot (0.3.3)
-    rack (1.4.5)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.3)
-      rack
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rails (3.2.13.rc2)
-      actionmailer (= 3.2.13.rc2)
-      actionpack (= 3.2.13.rc2)
-      activerecord (= 3.2.13.rc2)
-      activeresource (= 3.2.13.rc2)
-      activesupport (= 3.2.13.rc2)
-      bundler (~> 1.0)
-      railties (= 3.2.13.rc2)
-    railties (3.2.13.rc2)
-      actionpack (= 3.2.13.rc2)
-      activesupport (= 3.2.13.rc2)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.0.3)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    sprockets (2.2.2)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.7)
-    thor (0.17.0)
-    tilt (1.3.4)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.36)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  hound!
-  jquery-rails
-  sqlite3