activerecord-denormalize 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record-denormalize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Keita Urashima
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# ActiveRecord::Denormalize
+
+Denormalize fields in ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-denormalize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-denormalize
+
+## Usage
+
+``` ruby
+class Message < ActiveRecord::Base
+  # sender_type:string, sender_id:integer, _sender:hstore
+
+  belongs_to :sender, polymorphic: true
+end
+
+class User < ActiveRecord::Base
+  # name:string
+
+  has_many :messages, as: :sender, denormalize: {
+    attributes: [:name]
+  }
+end
+
+user    = User.create!(name: 'foo')
+message = Message.create!(sender: user)
+
+message.sender_name #=> 'foo'
+
+user.update_attribute :name, 'bar'
+
+message.reload
+message.sender_name #=> 'bar'
+
+Message.all.each do |msg|
+  # no N+1 query
+  msg.sender_name
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-denormalize.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'activerecord-denormalize/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'activerecord-denormalize'
+  gem.version       = ActiveRecord::Denormalize::VERSION
+  gem.authors       = ['Keita Urashima']
+  gem.email         = ['ursm@ursm.jp']
+  gem.description   = %q{Denormalize fields in ActiveRecord.}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activerecord'
+  gem.add_dependency 'activerecord-postgres-hstore'
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/active_record/denormalize.rb

@@ -0,0 +1,94 @@
+require 'activerecord-postgres-hstore'
+
+module ActiveRecord::Denormalize
+  class << self
+    def included(builder)
+      builder.valid_options << :denormalize
+    end
+
+    def extract_attributes(obj, keys)
+      return {} unless obj
+
+      keys.each_with_object({}) {|key, hash|
+        case key
+        when Hash
+          key.each do |k, v|
+            hash[k] = v.is_a?(Proc) ? obj.instance_exec(&v) : obj.__send__(v)
+          end
+        else
+          hash[key] = obj.__send__(key)
+        end
+      }
+    end
+  end
+
+  def build
+    super.tap {|reflection|
+      configure_denormalize reflection
+    }
+  end
+
+  private
+
+  def configure_denormalize(reflection)
+    return unless opts = options[:denormalize]
+
+    dest_class  = reflection.klass
+    source_name = options[:as] || reflection.source_reflection.options[:as]
+
+    attributes = opts[:attributes]
+    store_in   = opts[:store_in]   || "_#{source_name}"
+    prefix     = opts[:prefix]     || "#{source_name}_"
+
+    define_denormalize_to_method   attributes, store_in
+    define_denormalize_from_method dest_class, source_name, attributes, store_in
+    define_denormalize_readers     dest_class, attributes, prefix, store_in
+  end
+
+  def define_denormalize_to_method(attributes, store_in)
+    dest_name   = name
+    method_name = "denormalize_to_#{dest_name}"
+
+    mixin.redefine_method method_name do
+      attrs = ActiveRecord::Denormalize.extract_attributes(self, attributes)
+
+      __send__(dest_name).update_all ["#{store_in} = ?::hstore", attrs.to_hstore]
+    end
+
+    model.after_save method_name
+  end
+
+  def define_denormalize_from_method(dest_class, source_name, attributes, store_in)
+    method_name = "denormalize_from_#{source_name}"
+
+    dest_class.redefine_method method_name do
+      source = __send__(source_name)
+      attrs  = ActiveRecord::Denormalize.extract_attributes(source, attributes)
+
+      self[store_in] = attrs.stringify_keys
+    end
+
+    dest_class.before_create method_name
+  end
+
+  def define_denormalize_readers(dest_class, attributes, prefix, store_in)
+    attributes.each do |attr|
+      case attr
+      when Hash
+        attr.each_key do |key|
+          define_denormalize_reader dest_class, key, prefix, store_in
+        end
+      else
+        define_denormalize_reader dest_class, attr, prefix, store_in
+      end
+    end
+  end
+
+  def define_denormalize_reader(dest_class, name, prefix, store_in)
+    dest_class.class_eval <<-RUBY
+      def #{prefix}#{name}
+        #{store_in}[#{name.to_s.inspect}]
+      end
+    RUBY
+  end
+end

data/lib/activerecord-denormalize.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+require 'activerecord-denormalize/version'
+require 'active_record/denormalize'
+
+class ActiveRecord::Associations::Builder::HasMany
+  include ActiveRecord::Denormalize
+end

data/lib/activerecord-denormalize/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Denormalize
+    VERSION = '0.1.0'
+  end
+end

data/spec/active_record/denormalize_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ActiveRecord::Denormalize do
+  subject(:message) { Message.create!(sender: sender) }
+
+  context 'normal case' do
+    let(:sender) { User.create!(name: 'foo') }
+
+    its(:sender_name) { should == sender.name }
+
+    specify do
+      expect {
+        sender.update_attribute :name, 'bar'
+      }.to change { message.reload.sender_name }.to('bar')
+    end
+  end
+
+  context 'not associated' do
+    let(:sender) { nil }
+
+    its(:sender_name) { should be_nil }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'bundler/setup'
+
+require 'rspec'
+require 'rspec/autorun'
+
+require 'active_record'
+require 'activerecord-postgres-hstore/activerecord'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end
+
+config = {
+  adapter:      'postgresql',
+  database:     'activerecord-denormalize',
+  username:     'postgres',
+  min_messages: 'warning'
+}
+
+ActiveRecord::Base.establish_connection config.merge(database: 'postgres', schema_search_path: 'public')
+ActiveRecord::Base.connection.recreate_database config[:database]
+ActiveRecord::Base.establish_connection config
+
+class SetupMigration < ActiveRecord::Migration
+  def up
+    execute 'CREATE EXTENSION IF NOT EXISTS hstore'
+
+    create_table :messages do |t|
+      t.references :sender, polymorphic: true
+      t.hstore     :_sender
+    end
+
+    create_table :users do |t|
+      t.string :name
+    end
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+SetupMigration.new.up
+
+require 'activerecord-denormalize'
+
+class Message < ActiveRecord::Base
+  belongs_to :sender, polymorphic: true
+  serialize :_sender, ActiveRecord::Coders::Hstore
+end
+
+class User < ActiveRecord::Base
+  has_many :messages, as: :sender, denormalize: {
+    attributes: [:name]
+  }
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-denormalize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Keita Urashima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-17 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: '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: activerecord-postgres-hstore
+  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: rspec
+  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: Denormalize fields in ActiveRecord.
+email:
+- ursm@ursm.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-denormalize.gemspec
+- lib/active_record/denormalize.rb
+- lib/activerecord-denormalize.rb
+- lib/activerecord-denormalize/version.rb
+- spec/active_record/denormalize_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: ''
+test_files:
+- spec/active_record/denormalize_spec.rb
+- spec/spec_helper.rb