changeling 0.0.3 → 0.0.4

data/README.md

@@ -93,6 +93,17 @@ Access all of an objects history:
 @post.all_history
 ```
 
+Access all of an objects history where a specific field was changed:
+
+```ruby
+@post.history_for_field(:title)
+# Or if you prefer stringified fields:
+@post.history_for_field('title')
+
+# You can also pass in a number to limit your results
+@post.history_for_field(:title, 10)
+```
+
 Properties of Loglings (history objects):
 
 ```ruby
@@ -102,7 +113,7 @@ log.klass # class of the object that the Logling is tracking.
 => Post
 
 log.oid # the ID of the object that the Logling is tracking.
-# Note: integer type IDs will be integers. Non-integer types (such as Mongo's IDs) will be represented as a string
+# Note: integer type IDs will be integers. Non-integer types (such as Mongo's IDs) will be represented as a string.
 => 1
 
 log.before # what the before state of the object was.

data/lib/changeling/models/logling.rb

@@ -2,7 +2,7 @@ module Changeling
   module Models
     class Logling
       extend ActiveModel::Naming
-      attr_accessor :klass, :oid, :modifications, :before, :after, :modified_at
+      attr_accessor :klass, :oid, :modifications, :before, :after, :modified_at, :modified_fields
 
       include Tire::Model::Search
       include Tire::Model::Persistence
@@ -10,12 +10,14 @@ module Changeling
       property :klass, :type => 'string'
       property :oid, :type => 'string'
       property :modifications, :type => 'string'
+      property :modified_fields, :type => 'string', :analyzer => 'keyword'
       property :modified_at, :type => 'date'
 
       mapping do
         indexes :klass, :type => "string"
         indexes :oid, :type => "string"
         indexes :modifications, :type => 'string'
+        indexes :modified_fields, :type => 'string', :analyzer => 'keyword'
         indexes :modified_at, :type => 'date'
       end
 
@@ -41,19 +43,36 @@ module Changeling
           object.class
         end
 
-        def records_for(object, length = nil)
+        # TODO: Refactor me! More specs!
+        def records_for(object, length = nil, field = nil)
           self.tire.index.refresh
-          results = self.search do
-           query do
-             filtered do
-               query { all }
-               filter :terms, :klass => [Logling.klassify(object).to_s.underscore]
-               filter :terms, :oid => [object.id.to_s]
+
+          if field
+            results = self.search do
+             query do
+               filtered do
+                 query { all }
+                 filter :terms, :klass => [Logling.klassify(object).to_s.underscore]
+                 filter :terms, :oid => [object.id.to_s]
+                 filter :terms, :modified_fields => [field]
+               end
+             end
+
+             sort { by :modified_at, "desc" }
+            end.results
+          else
+            results = self.search do
+             query do
+               filtered do
+                 query { all }
+                 filter :terms, :klass => [Logling.klassify(object).to_s.underscore]
+                 filter :terms, :oid => [object.id.to_s]
+               end
              end
-           end
 
-           sort { by :modified_at, "desc" }
-          end.results
+             sort { by :modified_at, "desc" }
+            end.results
+          end
 
           if length
             results.take(length)
@@ -68,7 +87,8 @@ module Changeling
           :klass => self.klass.to_s.underscore,
           :oid => self.oid.to_s,
           :modifications => self.modifications.to_json,
-          :modified_at => self.modified_at
+          :modified_at => self.modified_at,
+          :modified_fields => self.modified_fields
         }.to_json
       end
 
@@ -87,19 +107,20 @@ module Changeling
           self.klass = object['klass'].camelize.constantize
           self.oid = object['oid'].to_i.to_s == object['oid'] ? object['oid'].to_i : object['oid']
           self.modifications = changes
+          self.modified_fields = self.modifications.keys
 
           self.before, self.after = Logling.parse_changes(changes)
 
           self.modified_at = DateTime.parse(object['modified_at'])
         else
-          changes = object.changes
-
+          changes = object.changes.reject { |k, v| v.nil? }
           # Remove updated_at field.
           changes.delete("updated_at")
 
           self.klass = Logling.klassify(object)
           self.oid = object.id
           self.modifications = changes
+          self.modified_fields = self.modifications.keys
 
           self.before, self.after = Logling.parse_changes(changes)
 
@@ -112,7 +133,9 @@ module Changeling
       end
 
       def save
-        _run_save_callbacks {}
+        unless self.modifications.empty?
+          _run_save_callbacks {}
+        end
       end
     end
   end

data/lib/changeling/probeling.rb

@@ -7,5 +7,9 @@ module Changeling
     def history(records = 10)
       Changeling::Models::Logling.records_for(self, records.to_i)
     end
+
+    def history_for_field(field_name, records = nil)
+      Changeling::Models::Logling.records_for(self, records ? records.to_i : nil, field_name.to_s)
+    end
   end
 end

data/lib/changeling/trackling.rb

@@ -5,7 +5,7 @@ module Changeling
     end
 
     def save_logling
-      if self.changes
+      if self.changes && !self.changes.empty?
         logling = Changeling::Models::Logling.create(self)
       end
     end

data/lib/changeling/version.rb

@@ -1,3 +1,3 @@
 module Changeling
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/changeling/models/logling_spec.rb

@@ -38,15 +38,7 @@ describe Changeling::Models::Logling do
               "klass"=>"BlogPost",
               "oid"=>"50b8355f7a93d04908000001",
               "modifications"=>"{\"public\":[true,false]}",
-              "modified_at"=>"2012-11-29T20:26:07-08:00",
-              "id"=>"UU2YGr1WSbilNUlyM1ja8g",
-              "_score"=>nil,
-              "_type"=>"changeling/models/logling",
-              "_index"=>"changeling_test_changeling_models_loglings",
-              "_version"=>1,
-              "sort"=>[1354249567000],
-              "highlight"=>nil,
-              "_explanation"=>nil
+              "modified_at"=>"2012-11-29T20:26:07-08:00"
             }
 
             @logling = @klass.new(@object)
@@ -72,6 +64,10 @@ describe Changeling::Models::Logling do
             @logling.modifications.should == @changes
           end
 
+          it "should set the modified_fields as the keys of the modifications" do
+            @logling.modified_fields.should == @changes.keys
+          end
+
           it "should set before and after based on .parse_changes" do
             @logling.before.should == @before
             @logling.after.should == @after
@@ -104,6 +100,22 @@ describe Changeling::Models::Logling do
             @logling.after.should == @after
           end
 
+          it "should set the modified_fields as the keys of the modifications" do
+            @logling.modified_fields.should == @changes.keys
+          end
+
+          it "should ignore changes that are nil" do
+            changes = {}
+
+            @changes.keys.each do |key|
+              changes[key] = nil
+            end
+
+            @object.stub(:changes).and_return(changes)
+
+            @klass.new(@object).modifications.should be_empty
+          end
+
           it "should set modified_at to the object's time of update if the object responds to the updated_at method" do
             @object.should_receive(:respond_to?).with(:updated_at).and_return(true)
 
@@ -154,6 +166,7 @@ describe Changeling::Models::Logling do
         end
       end
 
+      # TODO: More specs!
       describe ".records_for" do
         before(:each) do
           @index = @klass.tire.index
@@ -204,6 +217,10 @@ describe Changeling::Models::Logling do
           @logling.should_receive(:modified_at)
         end
 
+        it "should include an array of the object's modified fields" do
+          @logling.should_receive(:modified_fields)
+        end
+
         after(:each) do
           @logling.to_indexed_json
         end
@@ -240,6 +257,11 @@ describe Changeling::Models::Logling do
           @logling.should_receive(:_run_save_callbacks)
         end
 
+        it "should not update the index if there are no changes" do
+          @logling.stub(:modifications).and_return({})
+          @logling.should_not_receive(:_run_save_callbacks)
+        end
+
         after(:each) do
           @logling.save
         end

data/spec/lib/changeling/probeling_spec.rb

@@ -57,4 +57,90 @@ describe Changeling::Probeling do
       @object.history(20).count.should == 4
     end
   end
+
+  describe ".history_for_field" do
+    it "should query Logling with it's class name, and it's own ID, and a field name" do
+      @klass.should_receive(:records_for).with(@object, nil, "field")
+      @object.history_for_field("field")
+    end
+
+    it "should be able to take a length to specify amount of loglings to return" do
+      @klass.should_receive(:records_for).with(@object, 5, "field")
+      @object.history_for_field("field", 5)
+    end
+
+    it "should handle non-integer arguments for length" do
+      @klass.should_receive(:records_for).with(@object, 5, "field")
+      @object.history_for_field("field", "5")
+    end
+
+    it "should handle symbol arguments for field" do
+      @klass.should_receive(:records_for).with(@object, nil, "field")
+      @object.history_for_field(:field)
+    end
+
+    it "should only return loglings where the specified field has changed" do
+      models.values.each do |value|
+        value[:changes].keys.each do |field|
+          @object.history_for_field(field).each do |logling|
+            logling.modifications.keys.should include(field)
+          end
+
+          @object.history_for_field(field).count.should == 2
+        end
+      end
+    end
+
+    it "should be able to find loglings even if there was more than one change logged in the logling" do
+      models.each_pair do |model, args|
+        @object = model.new(args[:options])
+        @object.save!
+
+        args[:changes].each do |field, values|
+          values.reverse.each do |value|
+            @object.send("#{field}=", value)
+            @object.save!
+            # Sleep to guarantee saves are not within the same second.
+            sleep 1
+          end
+        end
+
+        # This should make 2 changes at the same time then save it
+        args[:changes].each do |field, values|
+          @object.send("#{field}=", values.last)
+        end
+
+        @object.save!
+      end
+
+      models.values.each do |value|
+        value[:changes].keys.each do |field|
+          # Reverse chronological order: first object is the last inserted, which should have 2 changes.
+          # The last object should have 1 change.
+          @object.history_for_field(field).last.modifications.keys.count.should == 1
+          @object.history_for_field(field).first.modifications.keys.count.should == 2
+
+          @object.history_for_field(field).count.should == 3
+        end
+      end
+    end
+
+    it "should only return the specified amount of loglings" do
+      models.values.each do |value|
+        value[:changes].keys.each do |field|
+          @object.history_for_field(field).count.should == 2
+          @object.history_for_field(field, 1).count.should == 1
+        end
+      end
+    end
+
+    it "should not error out if the record count desired is more than the total number of loglings" do
+      models.values.each do |value|
+        value[:changes].keys.each do |field|
+          @object.history_for_field(field).count.should == 2
+          @object.history_for_field(field, 10).count.should == 2
+        end
+      end
+    end
+  end
 end

data/spec/lib/changeling/trackling_spec.rb

@@ -11,26 +11,27 @@ describe Changeling::Trackling do
     end
 
     describe "callbacks" do
-      before(:each) do
-        @changes = args[:changes]
-      end
-
       it "should not create a logling when doing the initial save of a new object" do
         @klass.should_not_receive(:create)
-        @object.save!
+        @object.run_after_callbacks(:create)
       end
 
-      it "should create a logling with the changed attributes of an object when it is saved" do
-        # Persist object to DB so we can update it.
-        @object.save!
-
-        @klass.should_receive(:create).with(@object)
+      it "should create a logling when updating an object and changes are made" do
+        @klass.should_receive(:create)
+        @object.stub(:changes).and_return({ :field => 'value' })
+        @object.run_after_callbacks(:update)
+      end
 
-        @changes.each_pair do |k, v|
-          @object.send("#{k}=", v[1])
-        end
+      it "should create a logling when updating an object and changes are empty" do
+        @klass.should_not_receive(:create)
+        @object.stub(:changes).and_return({})
+        @object.run_after_callbacks(:update)
+      end
 
-        @object.save!
+      it "should not create a logling when updating an object and no changes have been made" do
+        @klass.should_not_receive(:create)
+        @object.stub(:changes).and_return(nil)
+        @object.run_after_callbacks(:update)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: changeling
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
-  requirement: &70333793166600 !ruby/object:Gem::Requirement
+  requirement: &70120925957500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333793166600
+  version_requirements: *70120925957500
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70333793164960 !ruby/object:Gem::Requirement
+  requirement: &70120925956900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333793164960
+  version_requirements: *70120925956900
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70333793164040 !ruby/object:Gem::Requirement
+  requirement: &70120925956080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.3
   type: :development
   prerelease: false
-  version_requirements: *70333793164040
+  version_requirements: *70120925956080
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70333793163020 !ruby/object:Gem::Requirement
+  requirement: &70120925955460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 3.2.7
   type: :development
   prerelease: false
-  version_requirements: *70333793163020
+  version_requirements: *70120925955460
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70333793178260 !ruby/object:Gem::Requirement
+  requirement: &70120925954960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333793178260
+  version_requirements: *70120925954960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70333793176620 !ruby/object:Gem::Requirement
+  requirement: &70120925954180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333793176620
+  version_requirements: *70120925954180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70333793174580 !ruby/object:Gem::Requirement
+  requirement: &70120925953640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333793174580
+  version_requirements: *70120925953640
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70333793173940 !ruby/object:Gem::Requirement
+  requirement: &70120925953060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333793173940
+  version_requirements: *70120925953060
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70333793173400 !ruby/object:Gem::Requirement
+  requirement: &70120925952440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333793173400
+  version_requirements: *70120925952440
 description: A simple, yet flexible solution to tracking changes made to objects in
   your database.
 email:
@@ -151,12 +151,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -473586463949581456
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -473586463949581456
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15