app_attributes 0.5.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in app_attributes.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# AppAttributes
+
+A very simple polymorphic implementation of name-value pairs for any ActiveRecord model. The value is serialized to allow storage of ruby objects.
+
+# Install
+
+<pre>
+sudo gem install app_attributes
+</pre>
+
+OR
+
+<pre>
+gem 'app_attributes'
+bundle install
+</pre>
+
+# Usage
+
+in your model:
+
+<pre>
+class Author < ActiveRecord::Base
+  include AppAttributes
+
+  ext_attribute :hat_size
+  # provides @author.hat_size, @author.hat_size=, @author.hat_size?
+end
+</pre>
+
+# TODO
+
+* automate migration. currently, you must manually copy/rename migration file in db/migrate
+* finish tests
+* specify dependencies
+
+# Copyright and license
+
+Copyright (c) 2011 Luke Wendling, released under the New BSD License
+
+Contributors:
+
+*   Jeff Pihl
+*   Scott Robertson
+*   Mike Hansen

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app_attributes.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "app_attributes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "app_attributes"
+  s.version     = AppAttributes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luke Wendling"]
+  s.email       = ["noreply@example.com"]
+  s.homepage    = ""
+  s.summary     = %q{Add simple name-value pairs to any ActiveRecord model}
+  s.description = %q{Add simple name-value pairs to any ActiveRecord model}
+
+  s.rubyforge_project = "app_attributes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/db/migrate/create_app_attributes.rb

@@ -0,0 +1,17 @@
+class CreateAppAttributes < ActiveRecord::Migration
+  def self.up
+    create_table :app_attributes do |t|
+      t.string :name
+      t.text   :value
+      t.integer :attributable_id
+      t.string :attributable_type
+      t.timestamps
+    end
+
+    add_index :app_attributes, [:attributable_type, :attributable_id]
+  end
+
+  def self.down
+    drop_table :app_attributes
+  end
+end

data/lib/app_attributes/app_attribute.rb

@@ -0,0 +1,15 @@
+# polymorphic name-value pairs with serialized values
+class AppAttribute < ActiveRecord::Base
+#    name              :string
+#    value             :text
+#    attributable_id   :integer
+#    attributable_type :string
+#    timestamps
+  
+  serialize :value
+  
+  belongs_to :attributable, :polymorphic => true
+  
+  validates_uniqueness_of :name, :scope => [:attributable_id, :attributable_type]
+  validates_presence_of :name
+end

data/lib/app_attributes/version.rb

@@ -0,0 +1,3 @@
+module AppAttributes
+  VERSION = "0.5.0"
+end

data/lib/app_attributes.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), 'app_attributes', 'app_attribute')
+
+module AppAttributes
+  def self.included(base)
+    base.class_eval do
+      has_many :app_attributes, :as => :attributable, :dependent => :delete_all
+    end
+    base.extend(ClassMethods)
+  end
+
+  # Example:
+  # include AppAttributes
+  # ext_attribute :something_extra, 'none'
+  # ext_attribute :something_else
+  #
+  module ClassMethods
+    def ext_attribute(name, default_value=nil)
+      define_method("#{name}") do
+        if self.new_record?
+          app_attr = app_attributes.detect{|oa| oa.name == "#{name}"}
+        else
+          app_attr = app_attributes.find(:first, :conditions => {:name => "#{name}"})
+        end
+        (app_attr && app_attr.value) || default_value
+      end
+
+      define_method("#{name}?") do
+        ! (value=send(name)).blank? && value != 'false'
+      end
+
+      define_method("#{name}=") do |raw_value|
+        new_value = raw_value == false ? 'false' : (raw_value.blank? ? default_value : raw_value)
+        if self.new_record?
+          return if new_value.blank? # fail silently if no default value and new value is blank
+          app_attr = app_attributes.detect{|oa| oa.name == "#{name}"}
+          app_attr ||= app_attributes.build(:name=>"#{name}")
+          app_attr.value = new_value
+        else
+          app_attr = app_attributes.find_or_create_by_name("#{name}")
+#            new_value = '-' if new_value.blank? # validation prevents blank value
+          app_attr.update_attributes(:value => new_value)
+        end
+        return app_attr.value
+      end
+    end
+  end
+end

data/test/app_attribute_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class AppAttributeTest < Test::Unit::TestCase
+  should validate_presence_of(:name)
+  
+  should "validate uniqueness of name in scope" do
+    name = 'Boston'
+    assert_difference "AppAttribute.count" do
+      AppAttribute.create(:name => name, :attributable_id => 1, :attributable_type => 'Author')
+    end
+    app_attr = AppAttribute.new(:name => name, :attributable_id => 1, :attributable_type => 'Author')
+    assert app_attr.errors.on(:name)
+  end
+end

data/test/app_attributes_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class AppAttributesTest < Test::Unit::TestCase
+  
+  context "when extending class attributes" do
+    setup do
+      AppAttribute.class_eval do
+        include AppAttributes
+        ext_attribute :test_attr
+      end
+    end
+    
+    should "create dynamic getters and setters" do
+
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: app_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Luke Wendling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-20 00:00:00 Z
+dependencies: []
+
+description: Add simple name-value pairs to any ActiveRecord model
+email: 
+- noreply@example.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app_attributes.gemspec
+- db/migrate/create_app_attributes.rb
+- lib/app_attributes.rb
+- lib/app_attributes/app_attribute.rb
+- lib/app_attributes/version.rb
+- test/app_attribute_test.rb
+- test/app_attributes_test.rb
+- test/test_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: app_attributes
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Add simple name-value pairs to any ActiveRecord model
+test_files: []
+