custom_attributes 0.1.0

data/lib/custom_attributes.rb

@@ -0,0 +1,22 @@
+# CustomAttributes
+
+require 'custom_attributes/custom_attribute'
+require 'custom_attributes/custom_attribute_value'
+require 'custom_attributes/controller'
+require 'custom_attributes/has_custom_attributes'
+require 'custom_attributes/version'
+
+module CustomAttributes
+  class << self
+    attr_accessor :scope
+    attr_accessor :scope_method
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include CustomAttributes::Model
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include CustomAttributes::Controller
+end

data/lib/custom_attributes/controller.rb

@@ -0,0 +1,20 @@
+module CustomAttributes
+  
+  module Controller
+    def self.included(base)
+      base.before_filter :set_custom_attribute_scope
+    end
+    
+    # override me
+    def custom_attribute_scope
+      if method_name = ::CustomAttributes.scope_method
+       self.__send__(method_name)
+      end
+    end
+    
+    def set_custom_attribute_scope
+      ::CustomAttributes.scope = custom_attribute_scope
+    end
+  end
+  
+end

data/lib/custom_attributes/custom_attribute.rb

@@ -0,0 +1,11 @@
+class ::CustomAttribute < ActiveRecord::Base
+  belongs_to :scope, :polymorphic => true
+  has_many :custom_attribute_values, :dependent => :destroy
+  
+  def owner
+    attributes[:owner].try(:constantize)
+  end
+  
+  validates_presence_of :name
+  validates_uniqueness_of :name, :scope => [:scope_type, :scope_id]
+end

data/lib/custom_attributes/custom_attribute_value.rb

@@ -0,0 +1,6 @@
+class ::CustomAttributeValue < ActiveRecord::Base
+  belongs_to :custom_attribute
+  
+  validates_presence_of :value
+  validates_associated :custom_attribute
+end

data/lib/custom_attributes/has_custom_attributes.rb

@@ -0,0 +1,136 @@
+module CustomAttributes
+  module Model
+    module ClassMethods
+      def has_custom_attributes
+        self.__send__ :include, CustomAttributes::HasCustomAttributes
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+    end
+  end
+  
+  module HasCustomAttributes
+    module ClassMethods
+      def custom_attributes
+        @custom_attributes ||= {}
+        @custom_attributes[::CustomAttributes.scope || :no_scope] ||= begin
+          arel = ::CustomAttribute.where(:owner => self.to_s)
+          if scope = ::CustomAttributes.scope
+            arel = arel.where(:scope_type => scope.class.to_s, :scope_id => scope.id)
+          else
+            arel = arel.where('scope_type IS NULL AND scope_id IS NULL')
+          end
+          arel
+        end
+      end
+      
+      def add_custom_attribute(value_or_array)
+        case value_or_array
+          when ::CustomAttribute
+            value_or_array.owner = self.to_s
+            value_or_array.save
+          when Array
+            opts = {:scope => ::CustomAttributes.scope}
+            opts.merge!(value_or_array.pop) if value_or_array.last.is_a?(Hash)
+            value_or_array.each do |name|
+              add_custom_attribute ::CustomAttribute.new(opts.merge(:name => name))
+            end
+          when String, Symbol
+            add_custom_attribute [value_or_array]
+          else
+            raise "Uexpected values for custom_attributes <<: #{value_or_array.inspect}"
+        end
+      end
+    end
+
+    module InstanceMethods
+      def [](name)
+        custom_attributes[name] || super
+      end
+      
+      def []=(name, value)
+        if custom_attribute_names.include?(name)
+          custom_attributes[name] = value
+        else
+          super
+        end
+      end
+      
+      def attributes=(hash)
+        custom_attribute_names.each do |name|
+          if hash.keys.include?(name)
+            custom_attributes[name] = hash.delete(name)
+          end
+        end
+      end
+      
+      def attributes
+        super.merge custom_attributes
+      end
+      
+      def custom_attributes
+        @custom_attributes ||= {}
+        @custom_attributes[::CustomAttributes.scope || :no_scope] ||= begin
+          all_attributes = self.class.custom_attributes
+          all_attributes.inject({}) do |attribs, custom_attrib|
+            # FIXME: should NOT make a separate request to the db for each value
+            attribs[custom_attrib.name] = read_custom_attribute(custom_attrib.name)
+            attribs
+          end
+        end
+      end
+      
+      def custom_attribute_names
+        self.class.custom_attributes.map(&:name)
+      end
+    
+      def method_missing(meth, *args, &blk)
+        name = meth.to_s.gsub(/\=$/, '')
+        if custom_attribute_names.include?(name)
+          if meth =~ /\=$/
+            self[name] = args.first
+          else
+            self[name] || read_custom_attribute(name)
+          end
+        else
+          super
+        end
+      end
+      
+      private
+      
+      def attribute_values(name)
+        custom_attribute = self.class.custom_attributes.where(:name => name).first
+        custom_attribute.custom_attribute_values
+      end
+      
+      def read_custom_attribute(name)
+        attribute_values(name).where(:owner_id => self.id).first.try(:value)
+      end
+
+      def write_custom_attribute(name, value)
+        values = attribute_values(name)
+        existing_value = values.where(:owner_id => self.id).first
+        if existing_value
+          existing_value.update_attribute(:value, value)
+        else
+          values.create(:owner_id => self.id, :value => value)
+        end
+      end
+      
+      def write_custom_attributes_from_hash
+        custom_attributes.each do |name, value|
+          write_custom_attribute(name, value)
+        end
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.__send__ :include, InstanceMethods
+      receiver.after_save :write_custom_attributes_from_hash
+    end
+  end
+end

data/lib/custom_attributes/version.rb

@@ -0,0 +1,9 @@
+module CustomAttributes
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    BUILD = 0
+
+    STRING = [MAJOR, MINOR, BUILD].join('.')
+  end
+end

data/lib/generators/custom_attributes/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module CustomAttributes
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Generates (but does not run) a migration to add the custom_attributes table.'
+
+    def copy_files
+      template        'custom_attributes.rb', 'config/initializers/custom_attributes.rb'
+    end
+    
+    def create_migration_file
+      migration_template 'create_custom_attributes.rb', 'db/migrate/create_custom_attributes.rb'
+    end
+  end
+end

data/lib/generators/custom_attributes/templates/create_custom_attributes.rb

@@ -0,0 +1,27 @@
+class CreateCustomAttributes < ActiveRecord::Migration
+  def self.up
+    create_table :custom_attributes do |t|
+      t.string :name
+      t.string :owner
+      t.string :scope_type
+      t.string :scope_id
+      t.timestamps
+    end
+    add_index :custom_attributes, [:scope_type, :scope_id]
+    
+    create_table :custom_attribute_values do |t|
+      t.integer :custom_attribute_id
+      t.string :owner_id
+      t.string :value
+      t.timestamps
+    end
+    add_index :custom_attribute_values, :custom_attribute_id
+  end
+  
+  def self.down
+    remove_index :custom_attributes, [:item_type, :item_id]
+    drop_table :custom_attributes
+    remove_index :custom_attribute_values, [:custom_attribute_id]
+    drop_table :custom_attribute_values
+  end
+end

data/lib/generators/custom_attributes/templates/custom_attributes.rb

@@ -0,0 +1,18 @@
+# Add scope by defining which controller method returns it:
+# 
+# ::CustomAttributes.scope_method = :current_user
+# 
+# Or set the scope object directly:
+# 
+# ::CustomAttributes.scope = User.first
+# 
+# Or override the controller method that returns the scope:
+# 
+# class ApplicationController < ActionController::Base
+#   def custom_attribute_scope
+#     # scope determination
+#     if current_user.can?(:customize, resource)
+#       current_user
+#     end
+#   end
+# end

data/test/custom_attributes_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CustomAttributesTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: custom_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Ren\xC3\xA9 F\xC3\xB6hring"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3"
+  type: :runtime
+  version_requirements: *id001
+description: CustomAttributes allows you to add custom attributes to ActiveRecord objects, optionally scoped by another model (e.g. users).
+email: rf@bamaru.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/custom_attributes/controller.rb
+- lib/custom_attributes/custom_attribute.rb
+- lib/custom_attributes/custom_attribute_value.rb
+- lib/custom_attributes/has_custom_attributes.rb
+- lib/custom_attributes/version.rb
+- lib/custom_attributes.rb
+- lib/generators/custom_attributes/install_generator.rb
+- lib/generators/custom_attributes/templates/create_custom_attributes.rb
+- lib/generators/custom_attributes/templates/custom_attributes.rb
+- test/custom_attributes_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rrrene/custom_attributes
+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: 
+- none
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: CustomAttributes allows you to add custom attributes to ActiveRecord objects, optionally scoped by another model (e.g. users).
+test_files: []
+