revision-san 0.2.0

data/README.md

@@ -0,0 +1,26 @@
+# Revision-San
+
+A simple Rails plugin which creates revisions of your model and comes with an equally simple HTML differ.
+
+## Install
+
+    $ gem install revision-san
+
+## Usage
+
+Include the `RevisionSan` module into the model for which you'd like to keep revisions.
+
+```ruby
+class Artist < ActiveRecord::Base
+  include RevisionSan
+end
+```
+
+And create a migration to add the columns needed by Revision-San to your model:
+
+```ruby
+add_column :artists, :revision, :integer,           :default => 1
+add_column :artists, :revision_parent_id, :integer, :default => nil
+
+add_index  :artists, :revision_parent_id
+```

data/lib/revision_san.rb

@@ -0,0 +1,49 @@
+require 'revision_san/diff'
+
+module RevisionSan
+  extend ActiveSupport::Concern
+
+  included do
+    before_update :create_new_revision
+    scope :current_revisions, { :conditions => { :revision_parent_id => nil } }
+  end
+  
+  module ClassMethods
+    def find_with_current_revisions(*args)
+      current_revisions.find_without_current_revisions(*args)
+    end
+    
+    def count_with_current_revisions(*args)
+      current_revisions.count_without_current_revisions(*args)
+    end
+    
+    def self.extended(klass)
+      class << klass
+        alias_method_chain :find, :current_revisions
+        alias_method_chain :count, :current_revisions
+      end
+    end
+  end
+  
+  def revisions
+    self.class.find_without_current_revisions(:all, :conditions => { :revision_parent_id => id }, :order => 'id ASC') + [self]
+  end
+  
+  def fetch_revision(revision)
+    revision = revision.to_i
+    return self if self.revision == revision
+    sub_query = revision_parent_id.blank? ? "revision_parent_id = #{id}" : "(id = #{revision_parent_id} OR revision_parent_id = #{revision_parent_id})"
+    self.class.find_without_current_revisions :first, :conditions => "#{sub_query} AND revision = #{revision}"
+  end
+  
+  def create_new_revision
+    if changed?
+      record = self.class.new(:revision_parent_id => id)
+      attributes.except('id', 'revision_parent_id').each do |key, value|
+        record.send(:write_attribute, key, changes.has_key?(key) ? changes[key].first : value)
+      end
+      record.save(:validate => false)
+      self.revision += 1
+    end
+  end
+end

data/lib/revision_san/diff.rb

@@ -0,0 +1,101 @@
+require 'diff/lcs'
+
+module RevisionSan
+  # Return a RevisionSan::Diff object which compares this revision to the specified revision.
+  #
+  #   artist = Artist.create(:name => 'van Gogh')
+  #   artist.update_attribute(:name => 'Vincent van Gogh')
+  #
+  #   revision_1 = artist.fetch_revision(1)
+  #   diff = revision_1.compare_against_revision(2)
+  #   diff.name # => '<ins>Vincent </ins>van Gogh'
+  def compare_against_revision(revision)
+    Diff.new(self, fetch_revision(revision))
+  end
+  
+  class Diff
+    attr_reader :from, :to
+    
+    def initialize(from, to)
+      @from, @to = from, to
+    end
+    
+    def diff_for_column(column)
+      from_lines, to_lines = [@from.send(column), @to.send(column)].map do |res|
+        text = res.blank? ? '' : res.to_s
+        text = yield(text) if block_given?
+        text.scan(/\n+|.+/)
+      end
+      SimpleHTMLFormatter.diff(from_lines, to_lines)
+    end
+    
+    def method_missing(method, *args, &block)
+      if @from.respond_to?(method) || @from.class.column_names.include?(method.to_s)
+        define_and_call_singleton_method(method, &block)
+      else
+        super
+      end
+    end
+    
+    def define_and_call_singleton_method(method, &block)
+      instance_eval %{
+        def #{method}(&block)
+          diff_for_column('#{method}', &block)
+        end
+        
+        #{method}(&block)
+      }
+    end
+    
+    module SimpleHTMLFormatter
+      def self.diff(from_lines, to_lines)
+        LineDiffHTMLFormatter.new(from_lines, to_lines).output
+      end
+      
+      class LineDiffHTMLFormatter
+        def output
+          @output.join.gsub(%r{</ins><ins>|</del><del>|<del></del>}, '')
+        end
+        
+        def initialize(from, to)
+          @output = []
+          @went_deep = false
+          ::Diff::LCS.traverse_sequences(from, to, self)
+        end
+        
+        def discard_a(change)
+          from_words, to_words = [change.old_element, change.new_element].map { |text| text.to_s.scan(/\w+|\W|\s/) }
+          changes = ::Diff::LCS.diff(from_words, to_words).length
+          if changes > 1 && changes > (from_words.length / 5)
+            @output << "<del>#{change.old_element}</del>"
+          else
+            @output << WordDiffHTMLFormatter.new(from_words, to_words).output
+            @went_deep = true
+          end
+        end
+        
+        def discard_b(change)
+          if @went_deep
+            @went_deep = false
+          else
+            @output << "<ins>#{change.new_element}</ins>"
+          end
+        end
+        
+        def match(match)
+          @output << match.new_element
+        end
+      end
+      
+      class WordDiffHTMLFormatter < LineDiffHTMLFormatter
+        def output
+          @output.join
+        end
+        
+        def discard_a(change)
+          @output << "<del>#{change.old_element}</del>"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: revision-san
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Eloy Duran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Rails plugin which creates revisions of your model and comes
+  with an equally simple HTML differ.
+email: eloy.de.enige@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/revision_san.rb
+- lib/revision_san/diff.rb
+homepage: http://github.com/Fingertips/revision_san
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple Rails plugin which creates revisions of your model and comes with
+  an equally simple HTML differ.
+test_files: []