changeling 0.0.2 → 0.0.3

data/README.md

@@ -99,10 +99,11 @@ Properties of Loglings (history objects):
 log = @post.history.first
 
 log.klass # class of the object that the Logling is tracking.
-=> "posts"
+=> Post
 
 log.oid # the ID of the object that the Logling is tracking.
-=> "1"
+# 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.
 => {"title" => "Old Title"}
@@ -117,7 +118,7 @@ log.modified_at # what time these changes were made.
 => Sat, 08 Sep 2012 10:21:46 UTC +00:00
 
 log.as_json # JSON representation of the changes.
-=> {:modifications=>{"title" => ["Old Title", "New Title"], :modified_at => Sat, 08 Sep 2012 10:21:46 UTC +00:00}
+=> {:class => Post, :oid => 1, :modifications=> { "title" => ["Old Title", "New Title"] }, :modified_at => Sat, 08 Sep 2012 10:21:46 UTC +00:00}
 ```
 
 ## Testing

data/lib/changeling/models/logling.rb

@@ -38,17 +38,16 @@ module Changeling
         end
 
         def klassify(object)
-          object.class.to_s.underscore
+          object.class
         end
 
         def records_for(object, length = nil)
           self.tire.index.refresh
-
           results = self.search do
            query do
              filtered do
                query { all }
-               filter :terms, :klass => [Logling.klassify(object)]
+               filter :terms, :klass => [Logling.klassify(object).to_s.underscore]
                filter :terms, :oid => [object.id.to_s]
              end
            end
@@ -66,18 +65,27 @@ module Changeling
 
       def to_indexed_json
         {
-          :klass => self.klass,
-          :oid => self.oid,
+          :klass => self.klass.to_s.underscore,
+          :oid => self.oid.to_s,
           :modifications => self.modifications.to_json,
           :modified_at => self.modified_at
         }.to_json
       end
 
+      def as_json
+        {
+          :class => self.klass,
+          :oid => self.oid,
+          :modifications => self.modifications,
+          :modified_at => self.modified_at
+        }
+      end
+
       def initialize(object)
         if object.class == Hash
           changes = JSON.parse(object['modifications'])
-          self.klass = object['klass']
-          self.oid = object['oid']
+          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.before, self.after = Logling.parse_changes(changes)
@@ -90,7 +98,7 @@ module Changeling
           changes.delete("updated_at")
 
           self.klass = Logling.klassify(object)
-          self.oid = object.id.to_s
+          self.oid = object.id
           self.modifications = changes
 
           self.before, self.after = Logling.parse_changes(changes)

data/lib/changeling/version.rb

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

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

@@ -35,7 +35,7 @@ describe Changeling::Models::Logling do
         context "when passed object is a ElasticSearch response hash" do
           before(:each) do
             @object = {
-              "klass"=>"blog_post",
+              "klass"=>"BlogPost",
               "oid"=>"50b8355f7a93d04908000001",
               "modifications"=>"{\"public\":[true,false]}",
               "modified_at"=>"2012-11-29T20:26:07-08:00",
@@ -56,13 +56,18 @@ describe Changeling::Models::Logling do
           end
 
           it "should set klass as the returned klass value" do
-            @logling.klass.should == @object['klass']
+            @logling.klass.should == @object['klass'].constantize
           end
 
           it "should set oid as the returned oid value" do
             @logling.oid.should == @object['oid']
           end
 
+          it "should convert oid to an integer if it's supposed to be an integer" do
+            @object["oid"] = "1"
+            @klass.new(@object).oid.should == @object["oid"].to_i
+          end
+
           it "should set the modifications as the incoming changes parameter" do
             @logling.modifications.should == @changes
           end
@@ -86,8 +91,8 @@ describe Changeling::Models::Logling do
             @logling.klass.should == @klass.klassify(@object)
           end
 
-          it "should set oid as the stringified object's ID" do
-            @logling.oid.should == @object.id.to_s
+          it "should set oid as the object's ID" do
+            @logling.oid.should == @object.id
           end
 
           it "should set the modifications as the incoming changes parameter" do
@@ -144,8 +149,8 @@ describe Changeling::Models::Logling do
       end
 
       describe ".klassify" do
-        it "should return the underscored version of the objects class as a string" do
-          @klass.klassify(@object).should == @object.class.to_s.underscore
+        it "should return the object's class" do
+          @klass.klassify(@object).should == @object.class
         end
       end
 
@@ -204,6 +209,32 @@ describe Changeling::Models::Logling do
         end
       end
 
+      describe ".as_json" do
+        before(:each) do
+          @json = @logling.as_json
+        end
+
+        it "should include the object's klass attribute" do
+          @json[:class].should == @klass.klassify(@object)
+        end
+
+        it "should include the object's oid attribute" do
+          @json[:oid].should == @object.id
+        end
+
+        it "should include the object's modifications attribute" do
+          @json[:modifications].should == @changes
+        end
+
+        it "should include the object's modified_at attribute" do
+          @json[:modified_at].should == @logling.modified_at
+        end
+
+        after(:each) do
+          @logling.to_indexed_json
+        end
+      end
+
       describe ".save" do
         it "should update the ElasticSearch index" do
           @logling.should_receive(:_run_save_callbacks)

data/spec/lib/changeling/probeling_spec.rb

@@ -22,7 +22,7 @@ describe Changeling::Probeling do
   end
 
   describe ".all_history" do
-    it "should query Logling with it's pluralized class name, and it's own ID" do
+    it "should query Logling with it's class name, and it's own ID" do
       @klass.should_receive(:records_for).with(@object)
       @object.all_history
     end
@@ -33,7 +33,7 @@ describe Changeling::Probeling do
   end
 
   describe ".history" do
-    it "should query Logling with it's pluralized class name, and it's own ID, and a default number of loglings to return" do
+    it "should query Logling with it's class name, and it's own ID, and a default number of loglings to return" do
       @klass.should_receive(:records_for).with(@object, 10)
       @object.history
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: changeling
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
-  requirement: &70134819579460 !ruby/object:Gem::Requirement
+  requirement: &70333793166600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70134819579460
+  version_requirements: *70333793166600
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70134819577920 !ruby/object:Gem::Requirement
+  requirement: &70333793164960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70134819577920
+  version_requirements: *70333793164960
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70134819577040 !ruby/object:Gem::Requirement
+  requirement: &70333793164040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.3
   type: :development
   prerelease: false
-  version_requirements: *70134819577040
+  version_requirements: *70333793164040
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70134819575880 !ruby/object:Gem::Requirement
+  requirement: &70333793163020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 3.2.7
   type: :development
   prerelease: false
-  version_requirements: *70134819575880
+  version_requirements: *70333793163020
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70134819590880 !ruby/object:Gem::Requirement
+  requirement: &70333793178260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70134819590880
+  version_requirements: *70333793178260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70134819589240 !ruby/object:Gem::Requirement
+  requirement: &70333793176620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70134819589240
+  version_requirements: *70333793176620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70134819587220 !ruby/object:Gem::Requirement
+  requirement: &70333793174580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70134819587220
+  version_requirements: *70333793174580
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70134819586580 !ruby/object:Gem::Requirement
+  requirement: &70333793173940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70134819586580
+  version_requirements: *70333793173940
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70134819585940 !ruby/object:Gem::Requirement
+  requirement: &70333793173400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70134819585940
+  version_requirements: *70333793173400
 description: A simple, yet flexible solution to tracking changes made to objects in
   your database.
 email: