mongoid_activity_tracker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73473aba526b5c072e700088ae1a34673719233f
+  data.tar.gz: 70106be3454df722a79849544026e69910508ecb
+SHA512:
+  metadata.gz: ad2d58489e90642bb822d5eb2814e1d996f433734cb4d662776df1ba93ae4fdaf8c6b8e834d04ecf55211a8920045a10527932c4cf1b16287f3a3b8b4e755937
+  data.tar.gz: 64bb974d6b8648ab5d995e38452775ebcd9457dd5c2998ac94487b6c78ac20fe0753e0a4ebe9e17c5726939b1604dbd543e7548d3e5b1544676e9c656776e9e7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 2.1.2
+services:
+  - mongodb
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_permalink_extension.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Celizna
+
+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,83 @@
+# Mongoid Activity Tracker
+
+[![Build Status](https://travis-ci.org/tomasc/mongoid_activity_tracker.svg)](https://travis-ci.org/tomasc/mongoid_activity_tracker) [![Gem Version](https://badge.fury.io/rb/mongoid_activity_tracker.svg)](http://badge.fury.io/rb/mongoid_activity_tracker) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid_activity_tracker.svg)](https://coveralls.io/r/tomasc/mongoid_activity_tracker)
+
+Module and a service class to help with tracking activity in your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```Ruby
+gem 'mongoid_activity_tracker'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install mongoid_activity_tracker
+```
+
+## Usage
+
+Setup a class that will record the activity:
+
+```Ruby
+class MyTracker
+  include MongoidActivityTracker::Tracker
+end
+```
+
+Track the activity:
+
+```Ruby
+my_tracker = MongoidActivityTracker::TrackActivity.with(MyTracker, current_user)
+
+res = my_tracker.track('create')
+
+res.actor # returns the current_user
+res.actor_cache # => { to_s: … }
+res.actor_cache_object.to_s # the 'actor_cache_object' wraps the actor_cache hash into an OpenStruct
+res.action # => 'create'
+```
+
+## Configuration
+
+Along the action, it is possible to track any number of related documents.
+
+First, configure your tracker class using the `.tracks` macros:
+
+```Ruby
+class MyTracker
+  include MongoidActivityTracker::Tracker
+  tracks :subject, cache_methods: [:to_s, :id]
+end
+```
+
+Then, specify your subject when tracking the activity along the action:
+
+```Ruby
+my_tracker = MongoidActivityTracker::TrackActivity.with(MyTracker, current_user)
+
+res = my_tracker.track('create', subject: my_subject)
+
+res.subject # returns my_subject
+res.subject_cache # => { to_s: …, id: … }
+res.subject_cache_object.to_s # …
+```
+
+By default, the `:cache_methods` parameters is set to track [:to_s].
+
+## Contributing
+
+1. Fork it ( https://github.com/tomasc/mongoid_activity_tracker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/mongoid_activity_tracker/track_activity.rb

@@ -0,0 +1,22 @@
+module MongoidActivityTracker
+  class TrackActivity
+
+    def self.with *args
+      new(*args)
+    end
+
+    # ---------------------------------------------------------------------
+    
+    def initialize tracker_class, actor
+      @tracker_class = tracker_class
+      @actor = actor
+    end
+
+    def track action, options={}
+      @tracker_class.create(
+        { action: action, actor: @actor}.merge(options)
+      )
+    end
+
+  end
+end

data/lib/mongoid_activity_tracker/tracker.rb

@@ -0,0 +1,66 @@
+require 'mongoid'
+require 'ostruct'
+
+module MongoidActivityTracker
+  module Tracker
+
+    attr_accessor :actor_cache_methods
+
+    module ClassMethods
+      def tracks relation_name, cache_methods: %i(to_s)
+        belongs_to relation_name, polymorphic: true
+
+        field "#{relation_name}_cache", type: Hash, default: {}
+
+        attr_accessor "#{relation_name}_cache_methods"
+
+        define_method "#{relation_name}_cache_methods" do
+          instance_variable_set "@#{relation_name}_cache_methods", cache_methods unless instance_variable_get "@#{relation_name}_cache_methods"
+          instance_variable_get "@#{relation_name}_cache_methods"
+        end
+
+        define_method "#{relation_name}_cache_object" do
+          OpenStruct.new(send("#{relation_name}_cache"))
+        end
+
+        before_save -> { set_cache(relation_name) }
+      end
+    end
+
+    # ---------------------------------------------------------------------
+
+    def self.included base
+      base.extend ClassMethods
+      base.class_eval do
+        include Mongoid::Document
+
+        field :action, type: String
+
+        tracks :actor
+
+        validates :actor, presence: true
+        validates :action, presence: true
+      end
+
+    end
+
+    # =====================================================================
+
+    def created_at
+      self.id.generation_time.in_time_zone(Time.zone)
+    end
+
+    private # =============================================================
+
+    def set_cache name
+      return unless self.send("#{name}_cache_methods").present?
+      return unless self.send(name).present?
+
+      self.send("#{name}_cache_methods").each do |m|
+        next if self.send("#{name}_cache")[m].present?
+        self.send("#{name}_cache")[m] = self.send(name).send(m) if self.send(name).respond_to?(m)
+      end
+    end
+
+  end
+end

data/lib/mongoid_activity_tracker/version.rb

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

data/lib/mongoid_activity_tracker.rb

@@ -0,0 +1 @@
+require "mongoid_activity_tracker/version"

data/mongoid_activity_tracker.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_activity_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_activity_tracker"
+  spec.version       = MongoidActivityTracker::VERSION
+  spec.authors       = ["Tomas Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+  spec.description   = %q{Minimal set of classes and modules to help with activity tracking.}
+  spec.summary       = %q{Minimal set of classes and modules to help with activity tracking.}
+  spec.homepage      = "https://github.com/tomasc/mongoid_activity_tracker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "mongoid", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/test/mongoid_activity_tracker/track_activity_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+require_relative '../../lib/mongoid_activity_tracker/track_activity'
+
+module MongoidActivityTracker
+  describe TrackActivity do
+    let(:actor) { TestActor.new }
+    subject { TrackActivity.with(TestTrackerTwo, actor) }
+    let(:sub) { TestSubject.new }
+
+    describe '.call' do
+      before do
+        @tracker = subject.track('create', subject: sub)
+      end
+      it 'returns the tracker instance' do
+        @tracker.must_be_kind_of TestTrackerTwo
+      end
+      it 'always sets the :actor' do
+        @tracker.actor.must_equal actor
+      end
+      it 'sets the :actor_cache with :to_s by default' do
+        @tracker.actor_cache.must_equal({ to_s: actor.to_s })
+      end
+      it 'always sets the :action' do
+        @tracker.action.must_equal 'create'
+      end
+      it 'sets any other attributes' do
+        @tracker.subject.must_equal sub
+      end
+    end
+
+  end
+end

data/test/mongoid_activity_tracker/tracker_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+require_relative '../../lib/mongoid_activity_tracker/tracker'
+
+module MongoidActivityTracker
+  describe Tracker do
+
+    let(:actor) { TestActor.new }
+    subject { TestTracker.new }
+
+    describe 'associations' do
+      it 'belongs to :actor' do
+        subject.must_respond_to :actor
+      end
+    end
+
+    describe 'fields' do
+      it 'has :action' do
+        subject.must_respond_to :action
+      end
+      it 'has :actor_cache' do
+        subject.must_respond_to :actor_cache
+        subject.actor_cache.must_be_kind_of Hash
+      end
+    end
+
+    # ---------------------------------------------------------------------
+
+    describe '.tracks' do
+      let(:tracker_two) { TestTrackerTwo.new }
+      it 'adds the belongs_to :subject relation' do
+        tracker_two.must_respond_to :subject
+      end
+      it 'adds the :subject_cache field' do
+        tracker_two.must_respond_to :subject_cache
+        tracker_two.subject_cache.must_be_kind_of Hash
+      end
+      it 'defines the :subject_cache_methods accessor' do
+        tracker_two.must_respond_to :subject_cache_methods
+      end
+      it 'sets :to_s as a default for the :subject_cache_methods' do
+        tracker_two.subject_cache_methods.must_equal %i(to_s)
+      end
+      it 'adds the :subject_cache_object wrapper' do
+        tracker_two.subject_cache_object.must_respond_to :to_s
+      end
+      it 'sets the cache before :save' do
+        test_subject = TestSubject.new
+        tracker_two.subject = test_subject
+        tracker_two.run_callbacks(:save)
+        tracker_two.subject_cache.fetch(:to_s).must_equal test_subject.to_s
+      end
+    end
+    
+    # ---------------------------------------------------------------------
+    
+    describe ':created_at' do
+      it 'infers time from BSON id' do
+        subject.must_respond_to :created_at
+        subject.created_at.must_be_kind_of Time
+      end
+    end
+
+    describe ':actor_cache' do
+      before do
+        subject.actor = actor
+      end
+      it 'sets :actor_cache on save' do
+        subject.run_callbacks(:save)
+        subject.actor_cache.fetch(:to_s).must_equal actor.to_s
+      end
+      it 'allows preset cache manually' do
+        subject.actor_cache[:to_s] = 'foo-bar'
+        subject.run_callbacks(:save)
+        subject.actor_cache.fetch(:to_s).must_equal 'foo-bar'
+      end
+      it 'allows to override the default cache methods' do
+        subject.actor_cache_methods = %i(class)
+        subject.run_callbacks(:save)
+        subject.actor_cache.fetch(:class).must_equal TestActor
+      end
+    end
+
+    describe ':actor_cache_object' do
+      it 'wraps the :actor_cache with a Struct' do
+        subject.actor_cache_object.must_be_kind_of OpenStruct
+      end
+      it 'converts keys to methods' do
+        subject.actor_cache_object.must_respond_to :to_s
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+require 'bundler/setup'
+require 'database_cleaner'
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mongoid'
+require 'mongoid_activity_tracker'
+require 'mongoid_activity_tracker/tracker'
+
+if ENV["CI"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+ENV["MONGOID_TEST_HOST"] ||= "localhost"
+ENV["MONGOID_TEST_PORT"] ||= "27017"
+
+HOST = ENV["MONGOID_TEST_HOST"]
+PORT = ENV["MONGOID_TEST_PORT"].to_i
+
+def database_id
+  "mongoid_activity_tracker_test"
+end
+
+CONFIG = {
+  sessions: {
+    default: {
+      database: database_id,
+      hosts: [ "#{HOST}:#{PORT}" ]
+    }
+  }
+}
+
+Mongoid.configure do |config|
+  config.load_configuration(CONFIG)
+end
+
+DatabaseCleaner.orm = :mongoid
+DatabaseCleaner.strategy = :truncation
+
+class MiniTest::Spec
+  before(:each) { DatabaseCleaner.start }
+  after(:each) { DatabaseCleaner.clean }
+end
+
+# ---------------------------------------------------------------------
+
+class TestTracker
+  include MongoidActivityTracker::Tracker
+end
+
+class TestTrackerTwo
+  include MongoidActivityTracker::Tracker
+  tracks :subject
+end
+
+class TestActor
+  include Mongoid::Document
+end
+
+class TestSubject
+  include Mongoid::Document
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_activity_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimal set of classes and modules to help with activity tracking.
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid_activity_tracker.rb
+- lib/mongoid_activity_tracker/track_activity.rb
+- lib/mongoid_activity_tracker/tracker.rb
+- lib/mongoid_activity_tracker/version.rb
+- mongoid_activity_tracker.gemspec
+- test/mongoid_activity_tracker/track_activity_test.rb
+- test/mongoid_activity_tracker/tracker_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tomasc/mongoid_activity_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: Minimal set of classes and modules to help with activity tracking.
+test_files:
+- test/mongoid_activity_tracker/track_activity_test.rb
+- test/mongoid_activity_tracker/tracker_test.rb
+- test/test_helper.rb