lukewendling-expressive_record 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+2008-11-17 - 0.1.0
+==========
+init release. still working out the bugs.

data/README.rdoc

@@ -0,0 +1,36 @@
+== Expressive Record
+
+Add meaningful names for belongs_to associations to Rails 2.1 model object dirty changes (http://dev.rubyonrails.org/changeset/9127)
+
+== Install
+
+sudo gem install lukewendling-expressive_record --source http://gems.github.com
+
+== Usage
+
+ActiveRecord 2.1 introduces dirty changes; the ability to query a model object to track attribute changes before the record is saved using #changes, #changed, etc.
+
+However, belongs_to associations are cached simply as foreign key changes, so Ticket#changes yields something like ["status_id" => {"111", "222"}], which isn't especially helpful when rolling your own ticket history mechanism.
+
+Expressive Records turns foreign key-based changes into meaningful terms.
+
+  class Ticket < ActiveRecord::Base
+    include ExpressRecord
+    
+    expressify_changes
+    
+  end
+  
+expressify_changes uses a before_update callback to register changes in a separate log table, by convention, that has the following schema:
+
+  class CreateTicketChanges < ActiveRecord::Migration
+    def self.up
+      create_table "ticket_changes", :force => true do |t|
+        t.integer  "ticket_id",      :null => false
+        t.string   "attribute_type", :null => false
+        t.text     "old_value"
+        t.text     "new_value"
+        t.timestamps
+      end
+    end
+  end

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('expressive_record', '0.1.0') do |p|
+  p.description    = "Add meaningful names for belongs_to associations to Rails 2.1 model object dirty changes"
+  p.url			       = "http://github.com/lukewendling/expressive_record"
+  p.author          = "Luke Wendling"
+  p.email           = "luke@lukewendling.com"
+  p.development_dependencies  = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/expressive_record.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{expressive_record}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luke Wendling"]
+  s.date = %q{2008-11-17}
+  s.description = %q{Add meaningful names for belongs_to associations to Rails 2.1 model object dirty changes}
+  s.email = %q{luke@lukewendling.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/expressive_record.rb", "README.rdoc"]
+  s.files = ["CHANGELOG", "expressive_record.gemspec", "init.rb", "lib/expressive_record.rb", "Manifest", "Rakefile", "README.rdoc"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/lukewendling/expressive_record}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Expressive_record", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{expressive_record}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Add meaningful names for belongs_to associations to Rails 2.1 model object dirty changes}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'expressive_record'

data/lib/expressive_record.rb

@@ -0,0 +1,33 @@
+module ExpressiveRecord
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  def express_changes
+    ActiveRecord::Base.transaction do
+      self.changes.each do |attr, values|
+        valuefied = valuefy(attr, values)
+        ticket_changes.create(:attribute_type => attr, :old_value => valuefied[0], :new_value => valuefied[1])
+      end
+    end
+  end
+
+  private
+  #    find association's meaningful value (i.e. user.name instead of user id)
+    def valuefy(attr, values, assoc_attr = :name)
+  #      TODO: is there a better way to determine if an attr is an association
+      if attr.ends_with?('_id')
+        assoc = self.send(attr.gsub(/_id$/,'').to_sym)
+        return [(values[0].nil? ? '-' : assoc.class.find(values[0]).send(assoc_attr)), assoc.class.find(values[1]).send(assoc_attr)]
+      else
+        return values
+      end
+    end
+
+  module ClassMethods
+    def expressify_changes
+      before_update do |record|
+        record.express_changes
+      end
+    end
+  end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: lukewendling-expressive_record
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Luke Wendling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-17 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Add meaningful names for belongs_to associations to Rails 2.1 model object dirty changes
+email: luke@lukewendling.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/expressive_record.rb
+- README.rdoc
+files: 
+- CHANGELOG
+- expressive_record.gemspec
+- init.rb
+- lib/expressive_record.rb
+- Manifest
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/lukewendling/expressive_record
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Expressive_record
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: expressive_record
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Add meaningful names for belongs_to associations to Rails 2.1 model object dirty changes
+test_files: []
+