property_sets 2.5.0 → 2.6.0

data/README.md

@@ -1,145 +0,0 @@
-# Property sets [![Build Status](https://secure.travis-ci.org/zendesk/property_sets.png)](http://travis-ci.org/zendesk/property_sets)
-
-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 using the [ActiveRecord 3.2 store](https://github.com/rails/rails/commit/85b64f98d100d37b3a232c315daa10fad37dccdc).
-
-## Description
-
-You configure the allowed stored properties by specifying these in the model:
-
-```ruby
-class Account < ActiveRecord::Base
-  property_set :settings do
-    property :version, :default => "v1.0"
-    property :featured, :protected => true
-    property :activated
-  end
-
-  property_set :texts do
-    property :epilogue
-  end
-end
-```
-
-The declared properties can then be accessed runtime via the defined association:
-
-```ruby
-# Return the value of the version record for this account, or the default value if not set
-account.settings.version
-
-# Update the version record with given value
-account.settings.version = "v1.1"
-
-# Query the truth value of the property
-account.settings.featured?
-
-# Short hand for setting one or more values
-account.settings.set(:version => "v1.2", :activated => true)
-
-# Short hand for getting a hash with pairs for each key argument
-account.settings.get([:version, :activated])
-```
-
-### Validations
-
-Property sets supports standard AR validations, although in a somewhat manual fashion.
-
-```ruby
-class Account < ActiveRecord::Base
-  property_set :settings do
-    property :version, :default => "v1.0"
-    property :featured, :protected => true
-
-    validates_format_of :value, :with => /v\d+\.\d+/, :message => "of version is invalid",
-                        :if => Proc.new { |r| r.name.to_sym == :version }
-  end
-end
-```
-
-On `account.save` this will result in an error record being added. You can also inspect the
-setting record using `account.settings.version_record`
-
-### Bulk operations
-
-Stored properties can also be updated with the update_attributes and update_attributes! methods by
-enabling nested attributes. Like this (from the test cases):
-
-```ruby
-@account.texts_attributes = [
-  { :name => "foo", :value => "1"  },
-  { :name => "bar", :value => "0"  }
-]
-```
-
-And for existing records:
-
-```ruby
-@account.update_attributes!(:texts_attributes => [
-  { :id => @account.texts.foo.id, :name => "foo", :value => "0"  },
-  { :id => @account.texts.bar.id, :name => "bar", :value => "1" }
-])
-```
-
-Using nested attributes is subject to implementing your own security measures for mass update assignments.
-Alternatively, it is possible to use a custom hash structure:
-
-```ruby
-params = {
-  :settings => { :version => "v4.0", :featured => "1" },
-  :texts    => { :epilogue => "Wibble wobble" }
-}
-
-@account.update_attributes(params)
-```
-
-The above will not update `featured` as this has the protected flag set and is hence protected from
-mass updates.
-
-### View helpers
-
-We support a couple of convenience mechanisms for building forms and putting the values into the above hash structure. So far, only support check boxes and radio buttons:
-
-```erb
-<% form_for(:account, :html => { :method => :put }) do |f| %>
-  <h3><%= f.property_set(:settings).check_box :activated %> Activated?</h3>
-  <h3><%= f.property_set(:settings).radio_button :hot, "yes" %> Hot</h3>
-  <h3><%= f.property_set(:settings).radio_button :not, "no" %> Not</h3>
-  <h3><%= f.property_set(:settings).select :level, [["One", 1], ["Two", 2]] %></h3>
-<% end %>
-```
-
-## Installation
-
-Install the gem in your rails project by putting it in your Gemfile:
-
-```
-gem "property_sets"
-```
-
-Also remember to create the storage table(s), if for example you are going to be using this with an accounts model and a "settings" property set, you can define the table like:
-
-```ruby
-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
-* ActiveSupport
-
-## License and copyright
-
-Copyright 2013 Zendesk
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -1,14 +0,0 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'appraisal'
-require 'bump/tasks'
-
-require 'rake/testtask'
-Rake::TestTask.new do |test|
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default do
-  sh "bundle exec rake appraisal:install && bundle exec rake appraisal test"
-end

data/benchmark/read.rb

@@ -1,82 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test/helper')
-
-class Account < ActiveRecord::Base
-  # Benchmark reading from an object with many settings when:
-  # 1. Settings are undefined and use the default value (empty)
-  # 2. Settings are defined and use the database value (fully defined)
-
-  # This is a fairly realastic example of an object that has a lot of settings
-  property_set :benchmark_settings do
-    # 30 simple objects
-    10.times do |i|
-      property "float_prop_#{i}", :type => :float,   :default => 3.1415
-      property "int_prop_#{i}",   :type => :integer, :default => 22
-      property "string_prop_#{i}", :type => :string,  :default => "Sausalito, CA"
-    end
-
-    # 10 complex
-    5.times do |i|
-      property "datetime_prop_#{i}",   :type => :datetime,   :default => Time.now.to_s
-      property "serialized_prop_#{i}", :type => :serialized, :default => { "Hello" => "There" }
-    end
-
-    # 60 booleans
-    60.times do |i|
-      property "boolean_prop_#{i}", :type => :boolean, :default => true
-    end
-  end
-
-end
-
-class BenchmarkRead < ActiveSupport::TestCase
-
-  context "property sets" do
-
-    setup do
-      @account = Account.create(:name => "Name")
-    end
-
-    should "benchmark fully defined settings" do
-      # Most settings are defined and will come from the database
-      @account.benchmark_settings.keys.each do |key|
-        @account.benchmark_settings.build_default(key)
-      end
-      @account.save!
-      @account.reload
-      assert_equal 100, @account.benchmark_settings.count
-
-      GC.start
-      full_timing = Benchmark.ms do
-        1_000.times do
-          read_settings(@account)
-        end
-      end
-      puts "Reading fully defined settings: #{full_timing}ms"
-    end
-
-    should "benchmark defaults" do
-      assert_equal 0, @account.benchmark_settings.count
-      # Most settings are undefined and will use the default value
-      GC.start
-      empty_timing = Benchmark.ms do
-        1_000.times do
-          read_settings(@account)
-        end
-      end
-      puts "Reading empty settings: #{empty_timing}ms"
-    end
-
-  end
-
-  def read_settings(account)
-    account.benchmark_settings.float_prop_1
-    account.benchmark_settings.int_prop_1
-    account.benchmark_settings.string_prop_1
-    account.benchmark_settings.datetime_prop_1
-    account.benchmark_settings.boolean_prop_20?
-    account.benchmark_settings.boolean_prop_30?
-    account.benchmark_settings.boolean_prop_40?
-    account.benchmark_settings.boolean_prop_50?
-  end
-
-end

data/gemfiles/rails2.3.gemfile

@@ -1,20 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord-jdbcmysql-adapter", "1.3.5", :platforms=>:jruby
-gem "bump"
-gem "rake"
-gem "bundler"
-gem "appraisal"
-gem "actionpack", ">= 2.3.14", "< 4.1"
-gem "iconv", :platforms=>:ruby_20
-gem "activerecord", "~> 2.3.14"
-gem "activesupport", "~> 2.3.14"
-gem "shoulda", "~> 2.11"
-gem "mysql2", "~> 0.2.0", :platforms=>:ruby
-gem "activerecord-mysql2-adapter", :platforms=>:ruby
-gem "mocha", "~> 0.12.0"
-gem "test-unit", "< 2.5.5"
-
-gemspec :path=>"../"

data/gemfiles/rails3.2.gemfile

@@ -1,19 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord-jdbcmysql-adapter", "1.3.5", :platforms=>:jruby
-gem "mysql2", :platforms=>:ruby
-gem "bump"
-gem "rake"
-gem "bundler"
-gem "shoulda"
-gem "mocha"
-gem "appraisal"
-gem "test-unit", ">= 2.5.2"
-gem "actionpack", ">= 2.3.14", "< 4.1"
-gem "iconv", :platforms=>:ruby_20
-gem "activerecord", "~> 3.2.6"
-gem "activesupport", "~> 3.2.6"
-
-gemspec :path=>"../"

data/gemfiles/rails4.0.gemfile

@@ -1,20 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord-jdbcmysql-adapter", "1.3.5", :platforms=>:jruby
-gem "mysql2", :platforms=>:ruby
-gem "bump"
-gem "rake"
-gem "bundler"
-gem "shoulda"
-gem "mocha"
-gem "appraisal"
-gem "test-unit", ">= 2.5.2"
-gem "actionpack", ">= 2.3.14", "< 4.1"
-gem "iconv", :platforms=>:ruby_20
-gem "activerecord", "~> 4.0.2"
-gem "activesupport", "~> 4.0.2"
-gem "protected_attributes"
-
-gemspec :path=>"../"

data/property_sets.gemspec

@@ -1,20 +0,0 @@
-lib = File.expand_path("../lib/", __FILE__)
-$:.unshift lib unless $:.include?(lib)
-
-require 'property_sets/version'
-
-Gem::Specification.new "property_sets", PropertySets::VERSION do |s|
-  s.summary     = "Property sets for ActiveRecord."
-  s.description = "This gem is an ActiveRecord extension which provides a convenient interface for managing per row properties."
-  s.authors  = ["Morten Primdahl"]
-  s.email    = 'primdahl@me.com'
-  s.homepage = 'http://github.com/zendesk/property_sets'
-  s.license  = 'Apache License Version 2.0'
-
-  s.add_runtime_dependency("activesupport", ">= 2.3.14", "< 4.1")
-  s.add_runtime_dependency("activerecord", ">= 2.3.14", "< 4.1")
-  s.add_runtime_dependency("json")
-
-  s.files = `git ls-files`.split("\n")
-  s.license = "MIT"
-end

data/test/database.rb

@@ -1,83 +0,0 @@
-# setup database
-require 'active_record'
-ActiveRecord::Base.logger = Logger.new(STDOUT)
-ActiveRecord::Base.logger.level = Logger::ERROR
-
-config = {
-  :adapter  => RUBY_PLATFORM == "java" ? 'mysql' : 'mysql2',
-  :database => 'property_sets_test',
-  :username => 'root',
-  :password => nil,
-  :host     => '127.0.0.1',
-  :port     => 3306
-}
-
-ActiveRecord::Base.establish_connection(config.merge(:database => nil))
-
-# clear out everything
-ActiveRecord::Base.connection.drop_database config[:database]
-ActiveRecord::Base.connection.create_database config[:database], :charset => 'utf8', :collation => 'utf8_unicode_ci'
-
-# connect and check
-ActiveRecord::Base.establish_connection(config)
-ActiveRecord::Base.connection.execute('select 1')
-
-ActiveRecord::Migration.verbose = false
-
-ActiveRecord::Schema.define(:version => 1) do
-  create_table "account_settings", :force => true do |t|
-    t.integer  "account_id"
-    t.string   "name"
-    t.string   "value"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  add_index :account_settings, [ :account_id, :name ], :unique => true
-
-  create_table "account_texts", :force => true do |t|
-    t.integer  "account_id"
-    t.string   "name"
-    t.string   "value"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  add_index :account_texts, [ :account_id, :name ], :unique => true
-
-  create_table "account_validations", :force => true do |t|
-    t.integer  "account_id"
-    t.string   "name"
-    t.string   "value"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  add_index :account_validations, [ :account_id, :name ], :unique => true
-
-  create_table "account_typed_data", :force => true do |t|
-    t.integer  "account_id"
-    t.string   "name"
-    t.string   "value"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  add_index :account_typed_data, [ :account_id, :name ], :unique => true
-
-  create_table "account_benchmark_settings", :force => true do |t|
-    t.integer  "account_id"
-    t.string   "name"
-    t.string   "value"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  add_index :account_benchmark_settings, [ :account_id, :name ], :unique => true
-
-  create_table "accounts", :force => true do |t|
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-end

data/test/fixtures/account_settings.yml

@@ -1,14 +0,0 @@
-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

data/test/fixtures/account_texts.yml

@@ -1,4 +0,0 @@
-account1_foo:
-  account_id: 1
-  name: foo
-  value:

data/test/fixtures/accounts.yml

@@ -1,3 +0,0 @@
-account1:
-  name: The Account
-  id: 1

data/test/helper.rb

@@ -1,99 +0,0 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-
-require 'test/unit'
-
-begin
-  require 'mocha/setup' # Rails 2
-rescue LoadError
-  require 'mocha'
-end
-
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_record'
-require 'active_record/fixtures'
-require 'shoulda'
-
-if ActiveRecord::VERSION::MAJOR > 2
-  if ActiveRecord::VERSION::MINOR > 1
-    ActiveRecord::Base.mass_assignment_sanitizer = :strict
-  end
-  if ActiveRecord::VERSION::MAJOR == 4
-    require 'protected_attributes'
-  end
-  ActiveRecord::Base.attr_accessible
-end
-
-I18n.enforce_available_locales = false if ActiveRecord::VERSION::MAJOR > 2
-
-require File.expand_path "../database", __FILE__
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'property_sets'
-require 'property_sets/delegator'
-
-class ActiveSupport::TestCase
-  include ActiveRecord::TestFixtures
-
-  def create_fixtures(*table_names)
-    if block_given?
-      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
-    else
-      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
-    end
-  end
-
-  self.use_transactional_fixtures = true
-  self.use_instantiated_fixtures  = false
-end
-
-ActiveSupport::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
-$LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)
-
-class ActsLikeAnInteger
-  def to_i
-    123
-  end
-end
-
-class Account < ActiveRecord::Base
-  include PropertySets::Delegator
-  delegate_to_property_set :settings, :old => :hep
-
-  attr_accessible :name
-  attr_accessible :texts_attributes
-
-  property_set :settings do
-    property :foo
-    property :bar
-    property :baz
-    property :hep, :default   => 'skep'
-    property :pro, :protected => true
-  end
-
-  property_set :texts do
-    property :foo
-    property :bar
-  end
-
-  accepts_nested_attributes_for :texts
-
-  property_set :validations do
-    property :validated
-    property :regular
-
-    validates_format_of :value, :with => /\d+/, :message => "BEEP", :if => lambda { |r| r.name.to_sym == :validated }
-  end
-
-  property_set :typed_data do
-    property :string_prop, :type => :string
-    property :datetime_prop, :type => :datetime
-    property :float_prop, :type => :float
-    property :int_prop, :type => :integer
-    property :serialized_prop, :type => :serialized
-    property :default_prop, :type => :integer, :default => ActsLikeAnInteger.new
-    property :serialized_prop_with_default, :type => :serialized, :default => "[]"
-  end
-end