hound 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5124b75e28297b2fcc833c9b785afaaf30ef1a6d
+  data.tar.gz: 243191f171a35b3d0434e19ba8a8c0b2a98d7fae
+SHA512:
+  metadata.gz: 35a19f7e49986a4a5e9e5114de97f9416535f0fc53497f50e17c504f4522593f9d23e16cc860cc1a3a7b66f19a87cb32e1c8aed97030a831b568c29f4ca42002
+  data.tar.gz: e0ce3c16219b152035deaf16e1c748f2e0dc9ff3fc72a23d891d1e51ae6c005279b2c1e7fe52f8bf333997686d14949110376c7a3def5697109c9ac5f89d7b31

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in hound.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,98 @@
+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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,19 @@
+# Hound
+
+## Installation
+
+Add Hound to your `Gemfile` and run `bundle install`:
+
+```ruby
+gem 'hound'
+```
+
+Hound expects a `hound_actions` table to exist in your schema, go ahead
+and run the generator provided:
+
+```
+rails generate hound:install
+```
+
+This will create a new migration file. Run `rake db:migrate` to add
+this table.

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hound'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/hound.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'hound/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'hound'
+  s.version     = Hound::VERSION
+  s.authors     = ['Lee Jarvis']
+  s.email       = ['ljjarvis@gmail.com']
+  s.homepage    = 'https://github.com/injekt/hound'
+  s.summary     = 'Trace changes to your models'
+  s.description = 'Trace your model actions and create activity lists'
+
+  s.files = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{^test/})
+
+  s.add_dependency 'rails', '>= 3.2.0'
+
+  s.add_development_dependency 'sqlite3'
+end

data/lib/generators/hound/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Generates a migration to add a hound_actions table.

data/lib/generators/hound/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module Hound
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Generates a migration to add a hound_actions table.'
+    def create_migration_file
+      migration_template 'create_hound_actions.rb', 'db/migrate/create_hound_actions.rb'
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+class CreateHoundActions < ActiveRecord::Migration
+  def self.up
+    create_table :hound_actions do |t|
+      t.string   :action,          null: false
+      t.string   :actionable_type, null: false
+      t.integer  :actionable_id,   null: false
+      t.datetime :created_at
+    end
+    add_index :hound_actions, [:actionable_type, :actionable_id]
+  end
+
+  def self.down
+    remove_index :hound_actions, [:actionable_type, :actionable_id]
+    drop_table :hound_actions
+  end
+end

data/lib/hound/action.rb

@@ -0,0 +1,11 @@
+module Hound
+  class Action < ActiveRecord::Base
+    self.table_name = 'hound_actions'
+    attr_accessible :action, :actionable_id, :actionable_type
+    belongs_to :actionable, polymorphic: true
+
+    scope :created,   -> { where(action: 'create')  }
+    scope :updated,   -> { where(action: 'update')  }
+    scope :destroyed, -> { where(action: 'destroy') }
+  end
+end

data/lib/hound/config.rb

@@ -0,0 +1,15 @@
+require 'singleton'
+
+module Hound
+  class Config
+    include Singleton
+
+    # An Array of actions Hound should track.
+    attr_accessor :actions
+
+    def initialize
+      @actions = %w'create update destroy'
+    end
+
+  end
+end

data/lib/hound/controller.rb

@@ -0,0 +1,36 @@
+module Hound
+  module Controller
+
+    def self.included(base)
+      base.before_filter :set_hound_user
+    end
+
+    protected
+
+    # Attempt to fetch the current_user object. Return nil otherwise.
+    # This method should be overridden for providing custom behavour.
+    def hound_user
+      @hound_user ||= current_user
+    rescue NoMethodError
+      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 set_hound_user
+      Hound.store[:hound_user_type] = hound_user_type
+      Hound.store[:hound_user_id] = hound_user_id
+    end
+
+  end
+end

data/lib/hound/model.rb

@@ -0,0 +1,55 @@
+module Hound
+  module Model
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # Tell Hound to track this models actions.
+      #
+      # options - a Hash of configuration options.
+      def hound(options = {})
+        send :include, InstanceMethods
+
+        has_many :actions,
+          as: 'actionable',
+          class_name: 'Hound::Action'
+
+        options[:actions] ||= Hound.config.actions
+        options[:actions] = Array(options[:actions]).map(&:to_s)
+
+        class_attribute :hound_options
+        self.hound_options = options.dup
+
+        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')
+      end
+    end
+
+    module InstanceMethods
+
+      private
+
+      def hound_create
+        actions.create! action: 'create'
+      end
+
+      def hound_update
+        actions.create! action: 'update'
+      end
+
+      def hound_destroy
+        Hound::Action.create(
+          actionable_id:   self.id,
+          actionable_type: self.class.base_class.name,
+          action: 'destroy'
+        )
+      end
+
+    end
+
+  end
+end

data/lib/hound/version.rb

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

data/lib/hound.rb

@@ -0,0 +1,38 @@
+require 'hound/model'
+require 'hound/controller'
+require 'hound/action'
+require 'hound/config'
+require 'hound/version'
+
+module Hound
+
+  # The configuration storage for Hound.
+  #
+  # Returns the Hound::Config instance.
+  def self.config
+    @config ||= Hound::Config.instance
+  end
+
+  def self.configure
+    yield config
+  end
+
+  # Returns the Hash for storing hound properties on the current thread.
+  def self.store
+    Thread.current[:hound] ||= {}
+  end
+
+  # Returns an ActionRecord::Relation for the Hound::Action model.
+  def self.actions
+    Action.scoped
+  end
+
+end
+
+ActiveSupport.on_load :action_controller do
+  include Hound::Controller
+end
+
+ActiveSupport.on_load :active_record do
+  include Hound::Model
+end

data/lib/tasks/hound_tasks.rake

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