rails-properties 3.4.3

data/spec/property_object_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+describe RailsProperties::PropertyObject do
+  let(:user) { User.create! :name => 'Mr. Pink' }
+
+  if RailsProperties.can_protect_attributes?
+    let(:new_property_object) { user.property_objects.build({ :var => 'dashboard'}, :without_protection => true) }
+    let(:saved_property_object) { user.property_objects.create!({ :var => 'dashboard', :value => { 'theme' => 'pink', 'filter' => false}}, :without_protection => true) }
+  else
+    let(:new_property_object) { user.property_objects.build({ :var => 'dashboard'}) }
+    let(:saved_property_object) { user.property_objects.create!({ :var => 'dashboard', :value => { 'theme' => 'pink', 'filter' => false}}) }
+  end
+
+  describe "serialization" do
+    it "should have a hash default" do
+      expect(RailsProperties::PropertyObject.new.value).to eq({})
+    end
+  end
+
+  describe "Getter and Setter" do
+    context "on unsaved properties" do
+      it "should respond to setters" do
+        expect(new_property_object).to respond_to(:foo=)
+        expect(new_property_object).to respond_to(:bar=)
+      end
+
+      it "should not respond to some getters" do
+        expect { new_property_object.foo! }.to raise_error(NoMethodError)
+        expect { new_property_object.foo? }.to raise_error(NoMethodError)
+      end
+
+      it "should not respond if a block is given" do
+        expect {
+          new_property_object.foo do
+          end
+        }.to raise_error(NoMethodError)
+      end
+
+      it "should not respond if params are given" do
+        expect { new_property_object.foo(42) }.to raise_error(NoMethodError)
+        expect { new_property_object.foo(42,43) }.to raise_error(NoMethodError)
+      end
+
+      it "should return nil for unknown attribute" do
+        expect(new_property_object.foo).to eq(nil)
+        expect(new_property_object.bar).to eq(nil)
+      end
+
+      it "should return defaults" do
+        expect(new_property_object.theme).to eq('blue')
+        expect(new_property_object.view).to eq('monthly')
+        expect(new_property_object.filter).to eq(true)
+      end
+
+      it "should return defaults when using `try`" do
+        expect(new_property_object.try(:theme)).to eq('blue')
+        expect(new_property_object.try(:view)).to eq('monthly')
+        expect(new_property_object.try(:filter)).to eq(true)
+      end
+
+      it "should store different objects to value hash" do
+        new_property_object.integer = 42
+        new_property_object.float   = 1.234
+        new_property_object.string  = 'Hello, World!'
+        new_property_object.array   = [ 1,2,3 ]
+        new_property_object.symbol  = :foo
+
+        expect(new_property_object.value).to eq('integer' => 42,
+                                           'float'   => 1.234,
+                                           'string'  => 'Hello, World!',
+                                           'array'   => [ 1,2,3 ],
+                                           'symbol'  => :foo)
+      end
+
+      it "should set and return attributes" do
+        new_property_object.theme = 'pink'
+        new_property_object.foo = 42
+        new_property_object.bar = 'hello'
+
+        expect(new_property_object.theme).to eq('pink')
+        expect(new_property_object.foo).to eq(42)
+        expect(new_property_object.bar).to eq('hello')
+      end
+
+      it "should set dirty trackers on change" do
+        new_property_object.theme = 'pink'
+        expect(new_property_object).to be_value_changed
+        expect(new_property_object).to be_changed
+      end
+    end
+
+    context "on saved properties" do
+      it "should not set dirty trackers on property same value" do
+        saved_property_object.theme = 'pink'
+        expect(saved_property_object).not_to be_value_changed
+        expect(saved_property_object).not_to be_changed
+      end
+
+      it "should delete key on assigning nil" do
+        saved_property_object.theme = nil
+        expect(saved_property_object.value).to eq({ 'filter' => false })
+      end
+    end
+  end
+
+  describe "update_attributes" do
+    it 'should save' do
+      expect(new_property_object.update_attributes(:foo => 42, :bar => 'string')).to be_truthy
+      new_property_object.reload
+
+      expect(new_property_object.foo).to eq(42)
+      expect(new_property_object.bar).to eq('string')
+      expect(new_property_object).not_to be_new_record
+      expect(new_property_object.id).not_to be_zero
+    end
+
+    it 'should not save blank hash' do
+      expect(new_property_object.update_attributes({})).to be_truthy
+    end
+
+    if RailsProperties.can_protect_attributes?
+      it 'should not allow changing protected attributes' do
+        new_property_object.update_attributes!(:var => 'calendar', :foo => 42)
+
+        expect(new_property_object.var).to eq('dashboard')
+        expect(new_property_object.foo).to eq(42)
+      end
+    end
+  end
+
+  describe "save" do
+    it "should save" do
+      new_property_object.foo = 42
+      new_property_object.bar = 'string'
+      expect(new_property_object.save).to be_truthy
+      new_property_object.reload
+
+      expect(new_property_object.foo).to eq(42)
+      expect(new_property_object.bar).to eq('string')
+      expect(new_property_object).not_to be_new_record
+      expect(new_property_object.id).not_to be_zero
+    end
+  end
+
+  describe "validation" do
+    it "should not validate for unknown var" do
+      new_property_object.var = "unknown-var"
+
+      expect(new_property_object).not_to be_valid
+      expect(new_property_object.errors[:var]).to be_present
+    end
+  end
+end

data/spec/queries_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'Queries performed' do
+  context 'New record' do
+    let!(:user) { User.new :name => 'Mr. Pink' }
+
+    it 'should be saved by one SQL query' do
+      expect {
+        user.save!
+      }.to perform_queries(1)
+    end
+
+    it 'should be saved with properties for one key by two SQL queries' do
+      expect {
+        user.properties(:dashboard).foo = 42
+        user.properties(:dashboard).bar = 'string'
+        user.save!
+      }.to perform_queries(2)
+    end
+
+    it 'should be saved with properties for two keys by three SQL queries' do
+      expect {
+        user.properties(:dashboard).foo = 42
+        user.properties(:dashboard).bar = 'string'
+        user.properties(:calendar).bar = 'string'
+        user.save!
+      }.to perform_queries(3)
+    end
+  end
+
+  context 'Existing record without properties' do
+    let!(:user) { User.create! :name => 'Mr. Pink' }
+
+    it 'should be saved without SQL queries' do
+      expect {
+        user.save!
+      }.to perform_queries(0)
+    end
+
+    it 'should be saved with properties for one key by two SQL queries' do
+      expect {
+        user.properties(:dashboard).foo = 42
+        user.properties(:dashboard).bar = 'string'
+        user.save!
+      }.to perform_queries(2)
+    end
+
+    it 'should be saved with properties for two keys by three SQL queries' do
+      expect {
+        user.properties(:dashboard).foo = 42
+        user.properties(:dashboard).bar = 'string'
+        user.properties(:calendar).bar = 'string'
+        user.save!
+      }.to perform_queries(3)
+    end
+  end
+
+  context 'Existing record with properties' do
+    let!(:user) do
+      User.create! :name => 'Mr. Pink' do |user|
+        user.properties(:dashboard).theme = 'pink'
+        user.properties(:calendar).scope = 'all'
+      end
+    end
+
+    it 'should be saved without SQL queries' do
+      expect {
+        user.save!
+      }.to perform_queries(0)
+    end
+
+    it 'should be saved with properties for one key by one SQL queries' do
+      expect {
+        user.properties(:dashboard).foo = 42
+        user.properties(:dashboard).bar = 'string'
+        user.save!
+      }.to perform_queries(1)
+    end
+
+    it 'should be saved with properties for two keys by two SQL queries' do
+      expect {
+        user.properties(:dashboard).foo = 42
+        user.properties(:dashboard).bar = 'string'
+        user.properties(:calendar).bar = 'string'
+        user.save!
+      }.to perform_queries(2)
+    end
+
+    it 'should be destroyed by two SQL queries' do
+      expect {
+        user.destroy
+      }.to perform_queries(2)
+    end
+
+    it "should update properties by one SQL query" do
+      expect {
+        user.properties(:dashboard).update_attributes! :foo => 'bar'
+      }.to perform_queries(1)
+    end
+  end
+end

data/spec/scopes_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'scopes' do
+  let!(:user1) { User.create! :name => 'Mr. White' do |user| user.properties(:dashboard).theme = 'white' end }
+  let!(:user2) { User.create! :name => 'Mr. Blue' }
+
+  it "should find objects with existing properties" do
+    expect(User.with_properties).to eq([user1])
+  end
+
+  it "should find objects with properties for key" do
+    expect(User.with_properties_for(:dashboard)).to eq([user1])
+    expect(User.with_properties_for(:foo)).to eq([])
+  end
+
+  it "should records without properties" do
+    expect(User.without_properties).to eq([user2])
+  end
+
+  it "should records without properties for key" do
+    expect(User.without_properties_for(:foo)).to eq([user1, user2])
+    expect(User.without_properties_for(:dashboard)).to eq([user2])
+  end
+
+  it "should require symbol as key" do
+    [ nil, "string", 42 ].each do |invalid_key|
+      expect { User.without_properties_for(invalid_key) }.to raise_error(ArgumentError)
+      expect { User.with_properties_for(invalid_key)    }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/serialize_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe "Serialization" do
+  let!(:user) do
+    User.create! :name => 'Mr. White' do |user|
+      user.properties(:dashboard).theme = 'white'
+      user.properties(:calendar).scope = 'all'
+    end
+  end
+
+  describe 'created properties' do
+    it 'should be serialized' do
+      user.reload
+
+      dashboard_properties = user.property_objects.where(:var => 'dashboard').first
+      calendar_properties = user.property_objects.where(:var => 'calendar').first
+
+      expect(dashboard_properties.var).to eq('dashboard')
+      expect(dashboard_properties.value).to eq({'theme' => 'white'})
+
+      expect(calendar_properties.var).to eq('calendar')
+      expect(calendar_properties.value).to eq({'scope' => 'all'})
+    end
+  end
+
+  describe 'updated properties' do
+    it 'should be serialized' do
+      user.properties(:dashboard).update_attributes! :smart => true
+
+      dashboard_properties = user.property_objects.where(:var => 'dashboard').first
+      calendar_properties = user.property_objects.where(:var => 'calendar').first
+
+      expect(dashboard_properties.var).to eq('dashboard')
+      expect(dashboard_properties.value).to eq({'theme' => 'white', 'smart' => true})
+
+      expect(calendar_properties.var).to eq('calendar')
+      expect(calendar_properties.value).to eq({'scope' => 'all'})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #  config.order = 'random'
+
+  config.before(:each) do
+    clear_db
+  end
+
+  config.after :suite do
+    RailsPropertiesMigration.migrate(:down)
+  end
+end
+
+require 'active_record'
+require 'protected_attributes' if ENV['PROTECTED_ATTRIBUTES'] == 'true'
+require 'rails-properties'
+
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = false
+end
+
+class User < ActiveRecord::Base
+  has_properties do |s|
+    s.key :dashboard, :defaults => { :theme => 'blue', :view => 'monthly', :filter => true }
+    s.key :calendar,  :defaults => { :scope => 'company'}
+  end
+end
+
+class GuestUser < User
+  has_properties do |s|
+    s.key :dashboard, :defaults => { :theme => 'red', :view => 'monthly', :filter => true }
+  end
+end
+
+class Account < ActiveRecord::Base
+  has_properties :portal
+end
+
+class Project < ActiveRecord::Base
+  has_properties :info, :class_name => 'ProjectPropertyObject'
+end
+
+class ProjectPropertyObject < RailsProperties::PropertyObject
+  validate do
+    unless self.owner_name.present? && self.owner_name.is_a?(String)
+      errors.add(:base, "Owner name is missing")
+    end
+  end
+end
+
+def setup_db
+  ActiveRecord::Base.configurations = YAML.load_file(File.dirname(__FILE__) + '/database.yml')
+  ActiveRecord::Base.establish_connection(:sqlite)
+  ActiveRecord::Migration.verbose = false
+
+  print "Testing with ActiveRecord #{ActiveRecord::VERSION::STRING}"
+  if ActiveRecord::VERSION::MAJOR == 4
+    print " #{defined?(ProtectedAttributes) ? 'with' : 'without'} gem `protected_attributes`"
+  end
+  puts
+
+  require File.expand_path('../../lib/generators/rails_properties/migration/templates/migration.rb', __FILE__)
+  RailsPropertiesMigration.migrate(:up)
+
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.string :type
+      t.string :name
+    end
+
+    create_table :accounts do |t|
+      t.string :subdomain
+    end
+
+    create_table :projects do |t|
+      t.string :name
+    end
+  end
+end
+
+def clear_db
+  User.delete_all
+  Account.delete_all
+  RailsProperties::PropertyObject.delete_all
+end
+
+setup_db

data/spec/support/matchers/perform_queries.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :perform_queries do |expected|
+  match do |block|
+    query_count(&block) == expected
+  end
+
+  failure_message do |actual|
+    "Expected to run #{expected} queries, got #{@counter.query_count}"
+  end
+
+  def query_count(&block)
+    @counter = ActiveRecord::QueryCounter.new
+    ActiveSupport::Notifications.subscribe('sql.active_record', @counter.to_proc)
+    yield
+    ActiveSupport::Notifications.unsubscribe(@counter.to_proc)
+
+    @counter.query_count
+  end
+
+  def supports_block_expectations?
+    true
+  end
+end