historical 0.2.1 → 0.2.2

data/lib/historical/models/model_version/meta.rb

@@ -0,0 +1,19 @@
+module Historical::Models
+  class ModelVersion
+    # A meta model which stores additional data to each new version (could be used for audits).
+    class Meta
+      include MongoMapper::EmbeddedDocument
+      extend Historical::MongoMapperEnhancements
+      
+      key :created_at, Time
+    
+      # Retrieve customized class definition for a record class (e.g. TopicMeta, MessageMeta)
+      # @return [Class]
+      def self.for_class(source_class)
+        Historical::Models::Pool.pooled(Historical::Models::Pool.pooled_name(source_class, self)) do
+          Class.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/historical/models/pool.rb

@@ -0,0 +1,31 @@
+module Historical::Models
+  # @private
+  # cached classes are stored here
+  module Pool
+    @@class_pool = {}
+    mattr_accessor :class_pool
+
+    # Gets a class from the pool or sets it if the class couldn't be found.
+    def self.pooled(name)
+      class_pool[name] ||= begin
+        yield.tap do |cls|
+          const_set(name, cls)
+        end
+      end
+    end
+
+    # Removes all stored classes from the pool
+    def self.clear!
+      class_pool.each do |k,v|
+        remove_const(k)
+      end
+
+      self.class_pool = {}
+    end
+
+    # Generate unique classnames within the pool.
+    def self.pooled_name(specialized_for, parent)
+      "#{specialized_for.name.demodulize}#{parent.name.demodulize}"
+    end
+  end
+end

data/lib/historical/mongo_mapper_enhancements.rb

@@ -1,5 +1,12 @@
 module Historical
+  # Contains some helper methods for better MongoMapper integration.
   module MongoMapperEnhancements
+    
+    # Simple `belongs_to` relation to an ActiveRecord model.
+    # 
+    # @param name The name of the relation.
+    # @option options [String] :class_name (name.classify) The class name of the model (if it can't be guessed from the name)
+    # @option options [true,false] :polymorphic (false) Will create an additional {name}_type key in the model.
     def belongs_to_active_record(name, options = {})
       ar_id_field   = "#{name}_id"
       ar_type_field = "#{name}_type"
@@ -8,6 +15,7 @@ module Historical
       class_name    = options.delete(:class_name)
       model_class   = nil
       
+      # classname
       unless polymorphic
         if class_name
           model_class = class_name.is_a?(Class) ? class_name.name : class_name.classify
@@ -16,9 +24,11 @@ module Historical
         end
       end
       
+      # define the keys
       key ar_id_field,    Integer,  options
       key ar_type_field,  String,   options if polymorphic
       
+      # getter
       define_method name do
         if id = send(ar_id_field)
           if polymorphic
@@ -32,6 +42,7 @@ module Historical
         end
       end
       
+      # setter
       define_method "#{name}=" do |val|
         id = type = nil
         

data/lib/historical/railtie.rb

@@ -2,9 +2,11 @@ require 'historical'
 require 'rails'
 
 module Historical
+  # The railtie to be loaded by Rails.
   class Railtie < Rails::Railtie
-    config.after_initialize do
-      ActiveRecord::Base.send(:extend, Historical::ActiveRecord)
+    initializer "historical.attach_to_active_record" do
+      ::ActiveRecord::Base.send(:extend, Historical::ActiveRecord)
+      Historical.boot!
     end
   end
 end

data/spec/historical_spec.rb

@@ -10,6 +10,34 @@ describe "A historical model" do
     is_historical
   end
   
+  context "when loading model from database without history" do
+    before :each do
+      Historical.boot!
+      @msg = Message.find(1)
+      @msg.history.destroy
+    end
+    
+    it "should call the creation-generator" do
+      o = Object.new
+      o.stub!(:created_at=).once.with(@msg.created_at)
+      o.stub!(:save!).once
+      
+      @msg.should_receive(:spawn_version).once.with(:create).and_return(o)
+      @msg.history
+    end
+    
+    it "should auto-generate a creation" do
+      @msg.history.version_index.should == 0
+      @msg.history.creation.should_not be_nil
+    end
+    
+    it "should have the original timestamps" do
+      @msg.history.creation.tap do |e|
+        e.created_at.should == @msg.created_at
+      end
+    end
+  end
+  
   context "when created" do
     it "should persist" do
       msg = Message.new(:title => "Hello")
@@ -41,6 +69,8 @@ describe "A historical model" do
       version_count = lambda { @msg.history.versions.count }
   
       lambda do
+        @msg.should_not be_new_record
+        @msg.changes.should be_empty
         @msg.save!
       end.should_not change(version_count, :call)
     end
@@ -78,7 +108,7 @@ describe "A historical model" do
       grouped[:body].old_value.should == nil
       
       grouped[:votes].new_value.should == 42
-      grouped[:votes].old_value.should == nil
+      grouped[:votes].old_value.should == 0
       
       grouped[:read].new_value.should == true
       grouped[:read].old_value.should == false
@@ -123,13 +153,13 @@ describe "A historical model" do
     
       it "should create attribute-diffs in update-diff" do
         @msg.history.tap do |h|
-          model_diff = h.updates.first.diff
-          model_diff.changes.count.should == 1
+          diff = h.updates.first.diff
+          diff.changes.count.should == 1
   
-          model_diff.changes.first.tap do |diff|  
-            diff.attribute.should == "title"
-            diff.old_value.should == @first_title
-            diff.new_value.should == @new_title
+          diff.changes.first.tap do |attr_diff|
+            attr_diff.attribute.should == "title"
+            attr_diff.old_value.should == @first_title
+            attr_diff.new_value.should == @new_title
           end
         end
       end
@@ -232,15 +262,15 @@ describe "A historical model" do
   it "should not break handy queries for chained restorations" do
     @message = Message.create(:title => "one")
     @message.update_attributes(:title => "two").should be_true
-    @message.history.own_version.version_index.should == 1
+    @message.history.version_index.should == 1
     @message.version.should == 1
     
     previous = @message.history.restore(:previous)
-    previous.history.own_version.version_index.should == 0
+    previous.history.version_index.should == 0
     previous.version.should == 0
     
     identity = previous.history.restore(:next)
-    identity.history.own_version.version_index.should == 1
+    identity.history.version_index.should == 1
     identity.version.should == 1
     
     identity.should_not     be_nil
@@ -254,26 +284,30 @@ describe "A historical model" do
       cattr_accessor :current_user
 
       extend Historical::ActiveRecord
+      
       is_historical do
-        belongs_to_active_record :author, :required => true, :class_name => "User"
+        meta do
+          belongs_to_active_record :author, :required => true, :class_name => "User"
+        end
 
-        historical_callback do |diff|
-          diff.author = AuditedMessage.current_user
+        callback do |version|
+          version.meta.author = AuditedMessage.current_user
         end
       end
     end
     
     before :each do
       AuditedMessage.current_user = nil
+      Historical.boot!
     end
     
-    it "should create custom keys on ModelDiffs" do
+    it "should create custom keys on ModelVersion::Diffs" do
       user = User.create(:name => "Jane Doe")
       AuditedMessage.current_user = user
       
       msg = AuditedMessage.create(:title => "one")
       
-      author = msg.history.versions.first.diff.author
+      author = msg.history.versions.first.meta.author
       author.should == user
       author.id.should == user.id
     end

data/spec/spec_helper.rb

@@ -6,8 +6,9 @@ require 'spec/autorun'
 
 require 'rubygems'
 
-gem "rails", "= 2.3.8"
+gem "rails", "= 3.0.0"
 
+require 'ruby-debug'
 require 'active_support'
 require 'active_support/test_case'
 require 'active_record'
@@ -24,7 +25,7 @@ ActiveRecord::Base.silence do
     create_table :messages do |t|
       t.string    :title
       t.text      :body
-      t.integer   :votes
+      t.integer   :votes,         :default => 0
       t.datetime  :published_at
       t.date      :stamped_on
       t.decimal   :donated,       :precision => 10, :scale => 2
@@ -36,6 +37,12 @@ ActiveRecord::Base.silence do
       t.string :name
       t.timestamps
     end
+    
+    execute "
+      INSERT INTO
+        messages (id, title, body, created_at, updated_at)
+      VALUES
+        (1, 'existed already', 'hi', '2010-01-01 00:00:00', '2010-01-01 00:00:00')"
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: historical
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Marcel Jackwerth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-26 00:00:00 +02:00
+date: 2010-10-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,20 +42,23 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - historical.gemspec
 - lib/historical.rb
 - lib/historical/active_record.rb
+- lib/historical/class_builder.rb
 - lib/historical/model_history.rb
 - lib/historical/models/attribute_diff.rb
-- lib/historical/models/model_diff.rb
 - lib/historical/models/model_version.rb
+- lib/historical/models/model_version/diff.rb
+- lib/historical/models/model_version/meta.rb
+- lib/historical/models/pool.rb
 - lib/historical/mongo_mapper_enhancements.rb
 - lib/historical/railtie.rb
 - rails/init.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= historical2
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Marcel Jackwerth. See LICENSE for details.

data/lib/historical/models/model_diff.rb

@@ -1,90 +0,0 @@
-module Historical::Models
-  class ModelDiff
-    include MongoMapper::EmbeddedDocument
-    extend Historical::MongoMapperEnhancements
-    class_inheritable_accessor :historical_callbacks
-
-    validates_associated :changes
-
-    key   :_type,       String
-    key   :diff_type,   String,   :required => true
-    many  :changes,     :class_name => "Historical::Models::AttributeDiff"
-    
-    delegate :creation?, :update?, :to => :diff_type_inquirer
-  
-    def record
-      new_version.record
-    end
-  
-    def new_version
-      @parent || _parent_document
-    end
-  
-    def old_version
-      new_version.previous
-    end
-
-    def self.from_versions(from, to)
-      return from_creation(to) if from.nil?
-      
-      generate_from_version(from, 'update').tap do |d|
-        from.record.attribute_names.each do |attr_name|
-          attr = attr_name.to_sym
-          next if Historical::IGNORED_ATTRIBUTES.include? attr
-    
-          old_value, new_value = from[attr], to[attr]
-         
-          Historical::Models::AttributeDiff.specialized_for(d, attr).new.tap do |ad|
-            ad.attribute_type = Historical::Models::AttributeDiff.detect_attribute_type(d, attr)
-            ad.parent = d
-            ad.old_value = old_value
-            ad.new_value = new_value
-            ad.attribute = attr.to_s
-            d.changes << ad
-          end if old_value != new_value
-        end
-      end
-    end
-
-    def self.from_creation(to)
-      generate_from_version(to)
-    end
-  
-    protected
-    
-    def diff_type_inquirer
-      ActiveSupport::StringInquirer.new(diff_type)
-    end
-    
-    def self.historical_callback(&block)
-      raise "no block given" unless block_given?
-
-      self.historical_callbacks ||= []
-      self.historical_callbacks << block
-    end
-    
-  
-    def self.generate_from_version(version, type = 'creation')
-      for_class(version.record.class).new.tap do |d|
-        d.diff_type   = type
-        d.instance_variable_set :@parent, version
-        
-        if cbs = d.class.historical_callbacks
-          cbs.each do |c|
-            c.call(d)
-          end
-        end
-      end
-    end
-    
-    def self.for_class(source_class)
-      Historical::Models::Pool.pooled(Historical::Models::Pool.pooled_name(source_class, self)) do
-        Class.new(self).tap do |cls|
-          source_class.historical_customizations.each do |customization|
-            cls.instance_eval(&customization)
-          end
-        end
-      end
-    end
-  end
-end