mongoid_activity_tracker 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee65ee17d1eb90b0e1b2dcda4b58fdfdeb86f17
-  data.tar.gz: 40b9bdf6a32a373639b277178c5d238d079d5def
+  metadata.gz: ee823c459da4ba5e2237e1b4f37781bd4cd2e415
+  data.tar.gz: 973cfac3d8cb5b3cb8ffa5e1dad4dd7537a2b46f
 SHA512:
-  metadata.gz: 7501a73486046c4b8ab16b318e5b30b1cc9d9a1e5e6173693638b4a25584f17f524748222f01fdd0dd9fb412c127583084de4d719a0efd754b7175c2c6e3e222
-  data.tar.gz: 9f950c7d392f3a12e0f8cb1ac52f87e52d4c578b33ae93975ef4b73347a1aa62d16284a18fac75db2d6e32d2805b2ff8d51816e4e03901f2f492aaf12d204509
+  metadata.gz: ed8320caa536de6ff2da6b6fce30c55e48860a50895415643161290d3d69d853a1ae481e4c7256427e574026f556db9e3bf211697db6cfce8253c579edc43068
+  data.tar.gz: d31ffa48203b59524e927a7d4e50662c7ac3f35c11b00c61998e1222017a0214ab3c5921bfad4eb5ea5405709267bd1d643147c0a5a4ff01c1fe41cd59d639cc

data/README.md

@@ -37,42 +37,54 @@ end
 Track the activity:
 
 ```Ruby
-my_tracker = MongoidActivityTracker::TrackActivity.with(MyTracker, current_user)
-
-res = my_tracker.track('create')
+res = MyTracker.track(current_user, :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'
+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:
+First, configure the tracker class using the `.tracks` macros:
 
 ```Ruby
 class MyTracker
   include MongoidActivityTracker::Tracker
-  tracks :subject, cache_methods: [:to_s, :id]
+  tracks :subject
 end
 ```
 
-Then, specify your subject when tracking the activity along the action:
+Then, specify the subject when tracking the activity:
 
 ```Ruby
-my_tracker = MongoidActivityTracker::TrackActivity.with(MyTracker, current_user)
-
-res = my_tracker.track('create', subject: my_subject)
+res = MyTracker.track(current_user, :create, subject: my_subject)
 
-res.subject # returns my_subject
-res.subject_cache # => { to_s: …, id: … }
+res.subject # => my_subject
+res.subject_cache # => { to_s: … }
 res.subject_cache_object.to_s # …
 ```
 
-By default, the `:cache_methods` parameters is set to track [:to_s].
+By default, the `:cache_methods` parameter is set to track [:to_s]. It can be customised to cache results of other methods as follows:
+
+```Ruby
+class MyTracker
+  include MongoidActivityTracker::Tracker
+  tracks :actor, cache_methods: [:to_s, :first_name, :last_name]
+  tracks :subject, cache_methods: [:to_s, :my_custom_method]
+end
+```
+
+The tracker class can be also subclassed:
+
+```Ruby
+class MyTrackerWithTarget < MyTracker
+  tracks :target
+end
+```
 
 ## Contributing
 

data/lib/mongoid_activity_tracker/tracker.rb

@@ -7,6 +7,15 @@ module MongoidActivityTracker
     attr_accessor :actor_cache_methods
 
     module ClassMethods
+
+      def track _actor, _action, options={}
+        self.create(
+          { action: _action, actor: _actor }.merge(options)
+        )
+      end
+
+      # ---------------------------------------------------------------------
+      
       def tracks relation_name, cache_methods: %i(to_s)
         belongs_to relation_name, polymorphic: true
 
@@ -15,8 +24,8 @@ module MongoidActivityTracker
         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"
+          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
@@ -34,7 +43,7 @@ module MongoidActivityTracker
       base.class_eval do
         include Mongoid::Document
 
-        field :action, type: String
+        field :action, type: Symbol
 
         tracks :actor
 

data/lib/mongoid_activity_tracker/version.rb

@@ -1,3 +1,3 @@
 module MongoidActivityTracker
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/mongoid_activity_tracker.rb

@@ -1,4 +1,3 @@
 require 'mongoid_activity_tracker/version'
 
-require 'mongoid_activity_tracker/track_activity'
 require 'mongoid_activity_tracker/tracker'

data/test/mongoid_activity_tracker/tracker_test.rb

@@ -1,11 +1,10 @@
 require 'test_helper'
 
-require_relative '../../lib/mongoid_activity_tracker/tracker'
-
 module MongoidActivityTracker
   describe Tracker do
 
     let(:actor) { TestActor.new }
+    let(:sub) { TestSubject.new }
     subject { TestTracker.new }
 
     describe 'associations' do
@@ -24,31 +23,53 @@ module MongoidActivityTracker
       end
     end
 
+    # ---------------------------------------------------------------------
+    
+    describe '.track' do
+      before do
+        @result = TestTracker.track(actor, :create, subject: sub)
+      end
+      it 'returns new object' do
+        @result.must_be_kind_of TestTracker
+      end
+      it 'always sets the :actor' do
+        @result.actor.must_equal actor
+      end
+      it 'sets the :actor_cache with :to_s by default' do
+        @result.actor_cache.must_equal({ to_s: actor.to_s })
+      end
+      it 'sets the :action' do
+        @result.action.must_equal :create
+      end
+      it 'sets any other attributes' do
+        @result.subject.must_equal sub
+      end
+    end
+
     # ---------------------------------------------------------------------
 
     describe '.tracks' do
-      let(:tracker_two) { TestTrackerTwo.new }
       it 'adds the belongs_to :subject relation' do
-        tracker_two.must_respond_to :subject
+        subject.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
+        subject.must_respond_to :subject_cache
+        subject.subject_cache.must_be_kind_of Hash
       end
       it 'defines the :subject_cache_methods accessor' do
-        tracker_two.must_respond_to :subject_cache_methods
+        subject.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)
+        subject.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
+        subject.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
+        subject.subject = test_subject
+        subject.run_callbacks(:save)
+        subject.subject_cache.fetch(:to_s).must_equal test_subject.to_s
       end
     end
     

data/test/test_helper.rb

@@ -3,9 +3,9 @@ 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"
@@ -39,18 +39,13 @@ DatabaseCleaner.orm = :mongoid
 DatabaseCleaner.strategy = :truncation
 
 class MiniTest::Spec
-  before(:each) { DatabaseCleaner.start }
-  after(:each) { DatabaseCleaner.clean }
+  before(:each) { DatabaseCleaner.clean }
 end
 
 # ---------------------------------------------------------------------
 
 class TestTracker
   include MongoidActivityTracker::Tracker
-end
-
-class TestTrackerTwo
-  include MongoidActivityTracker::Tracker
   tracks :subject
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_activity_tracker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -137,11 +137,9 @@ files:
 - 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
@@ -169,6 +167,5 @@ 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

data/lib/mongoid_activity_tracker/track_activity.rb

@@ -1,22 +0,0 @@
-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/test/mongoid_activity_tracker/track_activity_test.rb

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