changeling 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--format documentation

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+services:
+  - mongodb
+  - elasticsearch

data/README.md

@@ -3,6 +3,8 @@
 [travis-image]: https://secure.travis-ci.org/hahuang65/Changeling.png?branch=master
 [travis-link]: http://travis-ci.org/hahuang65/Changeling
 [travis-home]: http://travis-ci.org/
+[brew-home]: http://mxcl.github.com/homebrew/
+[elasticsearch-home]: http://www.elasticsearch.org
 
 A flexible and lightweight object change tracking system.
 
@@ -28,7 +30,12 @@ $ gem install changeling
 
 ## Requirements
 
-* Redis (Tested on 2.4.x)
+* [ElasticSearch][elasticsearch-home] (Tested on 0.19.9 with JVM 20.10-b01-428)
+  * Install via [Homebrew][brew-home]
+
+```sh
+$ brew install elasticsearch
+```
 
 ## Usage
 
@@ -94,7 +101,7 @@ log = @post.history.first
 log.klass # class of the object that the Logling is tracking.
 => "posts"
 
-log.object_id # the ID of the object that the Logling is tracking.
+log.oid # the ID of the object that the Logling is tracking.
 => "1"
 
 log.before # what the before state of the object was.
@@ -106,11 +113,11 @@ log.after # what the after state of the object is.
 log.modifications # what changes were made to the object that this Logling recorded. Basically a roll up of the .before and .after methods.
 => {"title" => ["Old Title", "New Title"]}
 
-log.changed_at # what time these changes were made.
+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"], :changed_at => Sat, 08 Sep 2012 10:21:46 UTC +00:00}
+=> {:modifications=>{"title" => ["Old Title", "New Title"], :modified_at => Sat, 08 Sep 2012 10:21:46 UTC +00:00}
 ```
 
 ## Testing
@@ -120,7 +127,7 @@ against the following interpreters (with corresponding ORM/ODMs) and datastores:
 
 * MRI 1.9.2 (Mongoid 2.4.1, ActiveRecord 3.1.3)
 * MRI 1.9.3 (Mongoid 3.0.3, ActiveRecord 3.2.7)
-* Redis 2.4.x
+* ElasticSearch (Tested on 0.19.9 with JVM 20.10-b01-428)
 
 ## Contributing
 
@@ -133,7 +140,8 @@ against the following interpreters (with corresponding ORM/ODMs) and datastores:
 ## TODO
 
 * Restore state from a Logling
-* Use Mongo / SQL as a datastore rather than Redis (not sure about this one yet.)
-* Sinatra app to monitor changes as they happen in real-time
-* Analytics for changes
+* Filter Loglings by which fields have changed.
+* Performance testing against large data loads.
+* Sinatra app to monitor changes as they happen in real-time.
+* Analytics for changes.
 * Much more...

data/changeling.gemspec

@@ -16,16 +16,19 @@ Gem::Specification.new do |gem|
   gem.version       = Changeling::VERSION
 
   # Dependencies
-  gem.add_dependency "redis"
+  gem.add_dependency "tire"
+  gem.add_dependency "activemodel"
 
   # Development Dependencies
   case RUBY_VERSION
   when "1.9.2"
     gem.add_development_dependency "mongoid", "2.4.1"
     gem.add_development_dependency "activerecord", "3.1.3"
+    gem.add_development_dependency "ruby-debug19"
   when "1.9.3"
     gem.add_development_dependency "mongoid", "3.0.3"
     gem.add_development_dependency "activerecord", "3.2.7"
+    gem.add_development_dependency "debugger"
   end
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"

data/lib/changeling.rb

@@ -1,8 +1,10 @@
 require 'rubygems'
-require 'redis'
+require 'tire'
 require "changeling/version"
 
 module Changeling
+  Tire::Model::Search.index_prefix "changeling"
+
   autoload :Trackling, 'changeling/trackling'
   autoload :Probeling, 'changeling/probeling'
 

data/lib/changeling/models/logling.rb

@@ -1,11 +1,27 @@
 module Changeling
   module Models
     class Logling
-      attr_accessor :klass, :object_id, :modifications, :before, :after, :changed_at
+      extend ActiveModel::Naming
+      attr_accessor :klass, :oid, :modifications, :before, :after, :modified_at
+
+      include Tire::Model::Search
+      include Tire::Model::Persistence
+
+      property :klass, :type => 'string'
+      property :oid, :type => 'string'
+      property :modifications, :type => 'string'
+      property :modified_at, :type => 'date'
+
+      mapping do
+        indexes :klass, :type => "string"
+        indexes :oid, :type => "string"
+        indexes :modifications, :type => 'string'
+        indexes :modified_at, :type => 'date'
+      end
 
       class << self
-        def create(object, changes)
-          logling = self.new(object, changes)
+        def create(object)
+          logling = self.new(object)
           logling.save
         end
 
@@ -21,59 +37,74 @@ module Changeling
           [before, after]
         end
 
-        def redis
-          @redis ||= Redis.new
-        end
-
-        def redis_key(klass, object_id)
-          "changeling::#{klass}::#{object_id}"
+        def klassify(object)
+          object.class.to_s.underscore
         end
 
         def records_for(object, length = nil)
-          key = self.redis_key(object.class.to_s.underscore.pluralize, object.id.to_s)
-          length ||= self.redis.llen(key)
-
-          results = self.redis.lrange(key, 0, length).map { |value| self.new(object, JSON.parse(value)['modifications']) }
+          self.tire.index.refresh
+
+          results = self.search do
+           query do
+             filtered do
+               query { all }
+               filter :terms, :klass => [Logling.klassify(object)]
+               filter :terms, :oid => [object.id.to_s]
+             end
+           end
+
+           sort { by :modified_at, "desc" }
+          end.results
+
+          if length
+            results.take(length)
+          else
+            results
+          end
         end
       end
 
-      def as_json
+      def to_indexed_json
         {
-          :modifications => self.modifications,
-          :changed_at => self.changed_at
-        }
+          :klass => self.klass,
+          :oid => self.oid,
+          :modifications => self.modifications.to_json,
+          :modified_at => self.modified_at
+        }.to_json
       end
 
-      def initialize(object, changes)
-        # Remove updated_at field.
-        changes.delete("updated_at")
-
-        self.klass = object.class.to_s.underscore.pluralize
-        self.object_id = object.id.to_s
-        self.modifications = changes
+      def initialize(object)
+        if object.class == Hash
+          changes = JSON.parse(object['modifications'])
+          self.klass = object['klass']
+          self.oid = object['oid']
+          self.modifications = changes
 
-        self.before, self.after = Logling.parse_changes(changes)
+          self.before, self.after = Logling.parse_changes(changes)
 
-        if object.respond_to?(:updated_at)
-          self.changed_at = object.updated_at
+          self.modified_at = DateTime.parse(object['modified_at'])
         else
-          self.changed_at = Time.now
-        end
-      end
+          changes = object.changes
 
-      def redis_key
-        Logling.redis_key(self.klass, self.object_id)
-      end
+          # Remove updated_at field.
+          changes.delete("updated_at")
 
-      def save
-        key = self.redis_key
-        value = self.serialize
+          self.klass = Logling.klassify(object)
+          self.oid = object.id.to_s
+          self.modifications = changes
+
+          self.before, self.after = Logling.parse_changes(changes)
 
-        Logling.redis.lpush(key, value)
+          if object.respond_to?(:updated_at)
+            self.modified_at = object.updated_at
+          else
+            self.modified_at = Time.now
+          end
+        end
       end
 
-      def serialize
-        self.as_json.to_json
+      def save
+        _run_save_callbacks {}
       end
     end
   end

data/lib/changeling/trackling.rb

@@ -5,8 +5,8 @@ module Changeling
     end
 
     def save_logling
-      if changes = self.changes
-        logling = Changeling::Models::Logling.create(self, changes)
+      if self.changes
+        logling = Changeling::Models::Logling.create(self)
       end
     end
   end

data/lib/changeling/version.rb

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

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

@@ -13,68 +13,115 @@ describe Changeling::Models::Logling do
       @object = model.new(args[:options])
       @changes = args[:changes]
 
-      @logling = @klass.new(@object, @changes)
+      @object.stub(:changes).and_return(@changes)
+      @logling = @klass.new(@object)
     end
 
     context "Class Methods" do
       describe ".create" do
         before(:each) do
-          @object.stub(:changes).and_return(@changes)
 
-          @klass.should_receive(:new).with(@object, @changes).and_return(@logling)
+          @klass.should_receive(:new).with(@object).and_return(@logling)
         end
 
         it "should call new with it's parameters then save the initialized logling" do
           @logling.should_receive(:save)
 
-          @klass.create(@object, @changes)
+          @klass.create(@object)
         end
       end
 
       describe ".new" do
-        before(:each) do
-          @before, @after = @klass.parse_changes(@changes)
-        end
+        context "when passed object is a ElasticSearch response hash" do
+          before(:each) do
+            @object = {
+              "klass"=>"blog_post",
+              "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
+            }
+
+            @logling = @klass.new(@object)
+            @changes = JSON.parse(@object['modifications'])
+            @before, @after = @klass.parse_changes(@changes)
+            @modified_time = DateTime.parse(@object['modified_at'])
+          end
 
-        it "should set klass as the pluralized version of the class name" do
-          @logling.klass.should == @object.class.to_s.underscore.pluralize
-        end
+          it "should set klass as the returned klass value" do
+            @logling.klass.should == @object['klass']
+          end
 
-        it "should set object_id as the stringified object's ID" do
-          @logling.object_id.should == @object.id.to_s
-        end
+          it "should set oid as the returned oid value" do
+            @logling.oid.should == @object['oid']
+          end
 
-        it "should set the modifications as the incoming changes parameter" do
-          @logling.modifications.should == @changes
-        end
+          it "should set the modifications as the incoming changes parameter" do
+            @logling.modifications.should == @changes
+          end
+
+          it "should set before and after based on .parse_changes" do
+            @logling.before.should == @before
+            @logling.after.should == @after
+          end
 
-        it "should set before and after based on .parse_changes" do
-          @logling.before.should == @before
-          @logling.after.should == @after
+          it "should set modified_at as the parsed version of the returned modified_at value" do
+            @logling.modified_at.should == @modified_time
+          end
         end
 
-        it "should set changed_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)
+        context "when passed object is a real object" do
+          before(:each) do
+            @before, @after = @klass.parse_changes(@changes)
+          end
 
-          # Setting up a variable to prevent test flakiness from passing time.
-          time = Time.now
-          @object.stub(:updated_at).and_return(time)
+          it "should set klass as the .klassify-ed value" do
+            @logling.klass.should == @klass.klassify(@object)
+          end
 
-          # Create a new logling to trigger the initialize method
-          @logling = @klass.new(@object, @changes)
-          @logling.changed_at.should == @object.updated_at
-        end
+          it "should set oid as the stringified object's ID" do
+            @logling.oid.should == @object.id.to_s
+          end
+
+          it "should set the modifications as the incoming changes parameter" do
+            @logling.modifications.should == @changes
+          end
+
+          it "should set before and after based on .parse_changes" do
+            @logling.before.should == @before
+            @logling.after.should == @after
+          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)
+
+            # Setting up a variable to prevent test flakiness from passing time.
+            time = Time.now
+            @object.stub(:updated_at).and_return(time)
 
-        it "should set changed_at to the current time if the object doesn't respond to updated_at" do
-          @object.should_receive(:respond_to?).with(:updated_at).and_return(false)
+            # Create a new logling to trigger the initialize method
+            @logling = @klass.new(@object)
+            @logling.modified_at.should == @object.updated_at
+          end
+
+          it "should set modified_at to the current time if the object doesn't respond to updated_at" do
+            @object.should_receive(:respond_to?).with(:updated_at).and_return(false)
 
-          # Setting up a variable to prevent test flakiness from passing time.
-          time = Time.now
-          Time.stub(:now).and_return(time)
+            # Setting up a variable to prevent test flakiness from passing time.
+            time = Time.now
+            Time.stub(:now).and_return(time)
 
-          # Create a new logling to trigger the initialize method
-          @logling = @klass.new(@object, @changes)
-          @logling.changed_at.should == time
+            # Create a new logling to trigger the initialize method
+            @logling = @klass.new(@object)
+            @logling.modified_at.should == time
+          end
         end
       end
 
@@ -96,108 +143,76 @@ describe Changeling::Models::Logling do
         end
       end
 
-      describe ".redis_key" do
-        it "should consist of 3 parts, changeling::model_name::object_id" do
-          @klass.redis_key(@logling.klass, @logling.object_id).should == "changeling::#{@object.class.to_s.underscore.pluralize}::#{@object.id.to_s}"
+      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
         end
       end
 
       describe ".records_for" do
         before(:each) do
-          @klass.stub(:redis).and_return($redis)
+          @index = @klass.tire.index
+          @results = []
+          @klass.stub_chain(:tire, :index).and_return(@index)
+          @klass.stub_chain(:search, :results).and_return(@results)
         end
 
-        it "should get a redis_key" do
-          @key = @logling.redis_key
-          @klass.should_receive(:redis_key).with(@logling.klass, @logling.object_id).and_return(@key)
+        it "should refresh the ElasticSearch index" do
+          @index.should_receive(:refresh)
           @klass.records_for(@object)
         end
 
-        it "should find the length of the Redis list" do
-          @key = @logling.redis_key
-          @klass.stub(:redis_key).and_return(@key)
-          $redis.should_receive(:llen).with(@key)
-          @klass.records_for(@object)
-        end
-
-        it "should not find the length of the Redis list if length option is passed" do
-          @key = @logling.redis_key
-          @klass.stub(:redis_key).and_return(@key)
-          $redis.should_not_receive(:llen).with(@key)
-          @klass.records_for(@object, 10)
+        it "should only return the amount specified" do
+          num = 5
+          @results.should_receive(:take).with(num)
+          @klass.records_for(@object, 5)
         end
 
-        it "should find all entries in the Redis list" do
-          @key = @logling.redis_key
-          @length = 100
-          @klass.stub(:redis_key).and_return(@key)
-          $redis.stub(:llen).and_return(@length)
-          $redis.should_receive(:lrange).with(@key, 0, @length).and_return([])
+        it "should return all if no amount is specified" do
+          @results.should_not_receive(:take)
           @klass.records_for(@object)
         end
-
-        it "should find the specified amount of entries in the Redis list if length option is passed" do
-          @key = @logling.redis_key
-          @klass.stub(:redis_key).and_return(@key)
-          $redis.should_receive(:lrange).with(@key, 0, 5).and_return([])
-          @klass.records_for(@object, 5)
-        end
       end
     end
 
     context "Instance Methods" do
-      describe ".as_json" do
-        it "should include the object's modifications attribute" do
-          @logling.should_receive(:modifications)
+      describe ".to_indexed_json" do
+        it "should include the object's klass attribute" do
+          @logling.should_receive(:klass)
         end
 
-        it "should include the object's changed_at attribute" do
-          @logling.should_receive(:changed_at)
-        end
-
-        after(:each) do
-          @logling.as_json
+        it "should include the object's oid attribute" do
+          @logling.should_receive(:oid)
         end
-      end
 
-      describe ".redis_key" do
-        it "should pass in it's klass and object_id" do
-          @klass.should_receive(:redis_key).with(@logling.klass, @logling.object_id)
-          @logling.redis_key
+        it "should include the object's modifications attribute" do
+          @logling.should_receive(:modifications)
         end
-      end
 
-      describe ".save" do
-        before(:each) do
-          @klass.stub(:redis).and_return($redis)
+        it "should convert the object's modifications attribute to JSON" do
+          mods = {}
+          @logling.should_receive(:modifications).and_return(mods)
+          mods.should_receive(:to_json)
         end
 
-        it "should generate a key for storing in Redis" do
-          @logling.should_receive(:redis_key)
+        it "should include the object's modified_at attribute" do
+          @logling.should_receive(:modified_at)
         end
 
-        it "should serialize the logling" do
-          @logling.should_receive(:serialize)
+        after(:each) do
+          @logling.to_indexed_json
         end
+      end
 
-        it "should push the serialized object into Redis" do
-          @key = 1
-          @value = 2
-          @logling.stub(:redis_key).and_return(@key)
-          @logling.stub(:serialize).and_return(@value)
-          $redis.should_receive(:lpush).with(@key, @value)
+      describe ".save" do
+        it "should update the ElasticSearch index" do
+          @logling.should_receive(:_run_save_callbacks)
         end
 
         after(:each) do
           @logling.save
         end
       end
-
-      describe ".serialize" do
-        it "should JSON-ify the as_json object" do
-          @logling.serialize.should == @logling.as_json.to_json
-        end
-      end
     end
   end
 end

data/spec/lib/changeling/probeling_spec.rb

@@ -48,6 +48,11 @@ describe Changeling::Probeling do
       @object.history("5")
     end
 
+    it "should only return the amount of loglings requested" do
+      @object.all_history.count.should == 4
+      @object.history(2).count.should == 2
+    end
+
     it "should not error out if the record count desired is more than the total number of loglings" do
       @object.history(20).count.should == 4
     end

data/spec/lib/changeling/trackling_spec.rb

@@ -24,7 +24,7 @@ describe Changeling::Trackling do
         # Persist object to DB so we can update it.
         @object.save!
 
-        @klass.should_receive(:create).with(@object, @changes)
+        @klass.should_receive(:create).with(@object)
 
         @changes.each_pair do |k, v|
           @object.send("#{k}=", v[1])

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require(File.expand_path('../../lib/changeling', __FILE__))
 require 'mongoid'
-require 'redis'
 require 'database_cleaner'
 
 # Fixtures
@@ -21,12 +20,12 @@ RSpec.configure do |config|
 
   config.before(:suite) do
     DatabaseCleaner[:mongoid].strategy = :truncation
-    $redis = Redis.new(:db => 1)
+    Tire::Model::Search.index_prefix "changeling_test"
   end
 
   config.before(:each) do
-    $redis.flushdb
     DatabaseCleaner.start
+    clear_tire_indexes
   end
 
   config.after(:each) do
@@ -34,6 +33,20 @@ RSpec.configure do |config|
   end
 end
 
+# Inspiration from http://stackoverflow.com/questions/9676089/how-to-test-elasticsearch-in-a-rails-application-rspec
+def clear_tire_indexes
+  [Changeling::Models::Logling].each do |model|
+    # Make sure that the current model is using Tire
+    if model.respond_to?(:tire)
+      # Delete the index for the model.
+      model.tire.index.delete
+
+      # Reload the model's index so that it can be used again.
+      model.tire.create_elasticsearch_index
+    end
+  end
+end
+
 def models
   @models = {
     BlogPost => {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: changeling
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-08 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
-  requirement: &70287887029460 !ruby/object:Gem::Requirement
+  name: tire
+  requirement: &70134819579460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70287887029460
+  version_requirements: *70134819579460
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70134819577920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70134819577920
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70287887028580 !ruby/object:Gem::Requirement
+  requirement: &70134819577040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +43,10 @@ dependencies:
         version: 3.0.3
   type: :development
   prerelease: false
-  version_requirements: *70287887028580
+  version_requirements: *70134819577040
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70287887028040 !ruby/object:Gem::Requirement
+  requirement: &70134819575880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +54,21 @@ dependencies:
         version: 3.2.7
   type: :development
   prerelease: false
-  version_requirements: *70287887028040
+  version_requirements: *70134819575880
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70134819590880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70134819590880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70287887027640 !ruby/object:Gem::Requirement
+  requirement: &70134819589240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70287887027640
+  version_requirements: *70134819589240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70287887027080 !ruby/object:Gem::Requirement
+  requirement: &70134819587220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70287887027080
+  version_requirements: *70134819587220
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70287887026620 !ruby/object:Gem::Requirement
+  requirement: &70134819586580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70287887026620
+  version_requirements: *70134819586580
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70287887026120 !ruby/object:Gem::Requirement
+  requirement: &70134819585940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70287887026120
+  version_requirements: *70134819585940
 description: A simple, yet flexible solution to tracking changes made to objects in
   your database.
 email:
@@ -97,6 +119,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
 - .travis.yml
 - Gemfile