property_sets 0.0.6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Morten Primdahl
+
+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/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Morten Primdahl
+
+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.rdoc

@@ -0,0 +1,101 @@
+= Property sets
+
+The property_set gem is an evolution of the has_settings gem which was an evolution of the features gem. This is getting old.
+
+This gem is a way for you to use a basic "key/value" store for storing attributes for a given model in a relational fashion where there's a row per attribute. Alternatively you'd need to add a new column per attribute to your main table, or serialize the attributes and their values.
+
+== Description
+
+You configure the allowed stored properties by specifying these in an initializer:
+
+  class Account < ActiveRecord::Base
+    property_set :settings do
+      property :version, :default => "v1.0"
+      property :product
+    end
+
+    property_set :texts do
+      property :epilogue
+    end
+  end
+
+The declared properties can then be accessed runtime via the defined association:
+
+  account.settings.ssl         # returns the value of the setting
+  account.settings.ssl=(value) # immediately changes the value of the setting
+  account.settings.ssl?        # coerces the setting to boolean AR style
+
+If the value has never been set, a nil (or default) is returned. And that's pretty much it.
+
+Stored properties can also be updated with the update_attributes and update_attributes! methods.
+
+  # Assuming params include { :account => { :settings => { :version => "v2.0", :forums => '0' }}}
+  # the below would set the respective values on the account
+  account.update_attributes(params[:account])
+
+We also created a view helper to help you generate the UI for enabling and disabling properties:
+
+  <% form_for(:account, :html => { :method => :put }) do |f| %>
+    <h3>
+      <%= f.property_set_check_box(:settings) :forums %> Enable forums on your account
+    </h3>
+  <% end %>
+
+== Security
+
+We support protection from mass updates, the syntax is as follows:
+
+  class Account < ActiveRecord::Base
+    property_set :settings do
+      property :product, :protected => true
+    end
+  end
+
+== Installation
+
+Install the gem in your rails project by putting it in your Gemfile:
+
+  gem 'property_set'
+
+Also remember to create the storage table, if for example you are going to be using this with an accounts model and have, you can should the table like:
+
+  create_table :account_settings do |t|
+    t.integer  :account_id, :null => false
+    t.string   :name, :null => false
+    t.string   :value
+    t.timestamps
+  end
+
+  add_index :account_settings, [ :account_id, :name ], :unique => true
+
+== Requirements
+
+* ActiveRecord
+* ActionPack
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Zendesk
+
+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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "property_sets"
+    gem.summary = %Q{Property sets for ActiveRecord}
+    gem.description = %Q{This gem is an ActiveRecord extension which provides a convenient interface for managing per row properties}
+    gem.email = "morten@zendesk.com"
+    gem.homepage = "http://github.com/morten/property_sets"
+    gem.authors = ["Morten Primdahl"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "property_sets #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/lib/property_sets.rb

@@ -0,0 +1,20 @@
+require 'property_sets/property_set_model'
+require 'property_sets/active_record_extension'
+require 'property_sets/property_set_helper'
+
+module PropertySets
+  def self.ensure_property_set_class(association, owner_class)
+    const_name = "#{owner_class.name}#{association.to_s.singularize.capitalize}".to_sym
+    unless Object.const_defined?(const_name)
+      property_class = Object.const_set(const_name, Class.new(ActiveRecord::Base))
+      property_class.class_eval do
+        include PropertySets::PropertySetModel::InstanceMethods
+        extend  PropertySets::PropertySetModel::ClassMethods
+      end
+
+      property_class.owner_class = owner_class
+      property_class.owner_assoc = association
+    end
+    Object.const_get(const_name)
+  end
+end

data/lib/property_sets/active_record_extension.rb

@@ -0,0 +1,58 @@
+module PropertySets
+  module ActiveRecordExtension
+    module ClassMethods
+      def property_set(association, &block)
+        raise "Invalid association name, letters only" unless association.to_s =~ /[a-z]+/
+        property_class = PropertySets.ensure_property_set_class(association, self)
+        property_class.instance_eval(&block)
+
+        has_many association.to_s.pluralize.to_sym, :class_name => property_class.name, :dependent => :destroy do
+
+          # Accepts a name value pair hash { :name => 'value', :pairs => true } and builds a property for each key
+          def build(property_pairs)
+            property_pairs.keys.each do |name|
+              value = property_pairs[name]
+              self << proxy_reflection.klass.new(:name => name.to_s, :value => value)
+            end
+          end
+
+          # Define the settings query methods, e.g. +account.settings.wiffle?+
+          property_class.keys.each do |key|
+            raise "Invalid key #{key}" if self.respond_to?(key)
+
+            # Reports the coerced truth valye of the property
+            define_method "#{key}?" do
+              lookup(key).true?
+            end
+
+            # Assigns a new value to the property
+            define_method "#{key}=" do |value|
+              instance = lookup(key)
+              instance.value = value
+              instance.save
+            end
+
+            # Returns the value of the property
+            define_method "#{key}" do
+              lookup(key)
+            end
+
+            # The finder method which returns the property if present, otherwise a new instance with defaults
+            define_method "lookup" do |key|
+              instance = detect { |property| property.name.to_sym == key }
+              instance ||= property_class.new(@owner.class.name.underscore.to_sym => @owner, :name => key.to_s, :value => property_class.default(key))
+            end
+          end
+        end
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend(ClassMethods)
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include PropertySets::ActiveRecordExtension
+end

data/lib/property_sets/property_set_helper.rb

@@ -0,0 +1,19 @@
+module ActionView
+  module Helpers
+    def setting_check_box(model_name, method, options = {}, checked_value = "1", unchecked_value = "0")
+      the_model = @template.instance_variable_get("@#{model_name}")
+      throw "No @#{model_name} in scope" if the_model.nil?
+      throw "The setting_check_box only works on models with settings" unless the_model.respond_to?(:settings)
+      options[:checked] = the_model.settings.send("#{method}?")
+      options[:id]    ||= "#{model_name}_settings_#{method}"
+      options[:name]    = "#{model_name}[settings][#{method}]"
+      @template.check_box(model_name, "settings_#{method}", options, checked_value, unchecked_value)
+    end
+
+    class FormBuilder
+      def setting_check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+        @template.setting_check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
+      end
+    end
+  end
+end

data/lib/property_sets/property_set_model.rb

@@ -0,0 +1,97 @@
+module PropertySets
+  module PropertySetModel
+    module InstanceMethods
+      def protected?
+        self.class.protected?(self.name.to_sym)
+      end
+
+      def false?
+        [ "false", "0", "", "off", "n" ].member?(value.to_s.downcase)
+      end
+
+      def true?
+        !false?
+      end
+
+      def to_s
+        value.to_s
+      end
+
+      private
+
+      def validate_format_of_name
+        if name.blank?
+          errors.add(:name, :blank)
+        elsif !name.is_a?(String) || name !~ /^([a-z0-9]+_?)+$/
+          errors.add(:name, :invalid)
+        end
+      end
+
+      def owner_class_instance
+        send(self.class.owner_class_sym)
+      end
+
+      def update_owner_timestamp
+        owner_class_instance.update_attribute(:updated_at, Time.now) if owner_class_instance && !owner_class_instance.new_record?
+      end
+
+      def reset_owner_association
+        owner_class_instance.send(self.class.owner_assoc).reload
+      end
+    end
+
+    module ClassMethods
+      def self.extended(base)
+        base.after_create  :reset_owner_association
+        base.after_destroy :reset_owner_association
+        base.validate      :validate_format_of_name
+      end
+
+      def property(key, options = nil)
+        @properties ||= {}
+        @properties[key] = options
+      end
+
+      def keys
+        @properties.keys
+      end
+
+      def protected?(key)
+        !!@properties[key][:protected]
+      end
+
+      def default(key)
+        @properties[key] && @properties[key].key?(:default) ? @properties[key][:default] : nil
+      end
+
+      def owner_class=(owner_class)
+        @owner_class_sym = owner_class.name.underscore.to_sym
+        belongs_to              owner_class_sym
+        validates_presence_of   owner_class_sym
+        validates_uniqueness_of :name, :scope => owner_class_key_sym
+
+        if owner_class.table_exists? && owner_class.column_names.include?("updated_at")
+          before_create   :update_owner_timestamp
+          before_destroy  :update_owner_timestamp
+        end
+      end
+
+      def owner_assoc=(association)
+        @owner_assoc = association
+      end
+
+      def owner_assoc
+        @owner_assoc
+      end
+
+      def owner_class_sym
+        @owner_class_sym
+      end
+
+      def owner_class_key_sym
+        "#{owner_class_sym}_id".to_sym
+      end
+    end
+
+  end
+end

data/test/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql
+  encoding: utf8
+  database: property_sets_test
+  username: root
+  password:
+  socket: /tmp/mysql.sock

data/test/fixtures/account_settings.yml

@@ -0,0 +1,14 @@
+account1_foo:
+  account_id: 1
+  name: foo
+  value:
+
+account1_bar:
+  account_id: 1
+  name: bar
+  value: 1
+
+account1_baz:
+  account_id: 1
+  name: baz
+  value: 0