preferable 0.4.0 → 0.5.0

data/spec/preferable/coder_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Preferable::Coder do
+
+  let :user do
+    User.create! do |u|
+      u.preferences[:newsletter] = '1'
+    end.reload
+  end
+
+  let :legacy do
+    User.create!
+  end
+
+  it 'should not dump blank values' do
+    subject.dump(nil).should be_nil
+    subject.dump("ANY").should be_nil
+    subject.dump({}).should be_nil
+  end
+
+  it 'should dump hashes values' do
+    subject.dump(user.preferences).should == %({"newsletter":true})
+  end
+
+  it 'should load blank values' do
+    subject.load(nil).should == {}
+    subject.load(" ").should == {}
+  end
+
+  it 'should load hashes as they are' do
+    subject.load({"newsletter" => false}).should == {"newsletter" => false}
+  end
+
+  it 'should not fail over encoding errors' do
+    subject.load("SOMETHING WRONG!?").should == {}
+  end
+
+  it 'should raise errors if something other than a hash was loaded' do
+    lambda { subject.load("[1, 2]") }.should raise_error(ActiveRecord::SerializationTypeMismatch)
+  end
+
+  it 'should load values' do
+    subject.load(subject.dump(user.preferences)).should == {"newsletter" => true}
+  end
+
+  it "should load legacy settings" do
+    legacy.update_column :preferences, "---\n:color: \"222222\"\n_: \"::User\"\n"
+    legacy.reload.preferences.should == { "color" => "222222" }
+
+    legacy.update_column :preferences, "--- !map:Preferable::Set \n:color: \"222222\"\n_: \"::User\"\n"
+    legacy.reload.preferences.should == { "color" => "222222" }
+
+    legacy.update_column :preferences, "--- !ruby/object:Preferable::Set \n:color: \"222222\"\n_: \"::User\"\n"
+    legacy.reload.preferences.should == { "color" => "222222" }
+  end
+
+end

data/spec/preferable/field_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Preferable::Field do
+
+  def field(type, opts = {})
+    described_class.new :any, type, opts
+  end
+
+  def integer(opts = {})
+    field :integer, opts
+  end
+
+  subject do
+    described_class.new "color", "string", :if => lambda {|v| v =~ /^[A-F0-9]{6}$/ }, :default => '444444'
+  end
+
+  it 'should have a name' do
+    subject.name.should == "color"
+  end
+
+  it 'should have a type' do
+    subject.type.should == :string
+  end
+
+  it 'should have a default' do
+    subject.default.should == '444444'
+  end
+
+  it 'should have options' do
+    subject.options.keys.should == [:if]
+  end
+
+  it 'should reject invalid types' do
+    lambda { described_class.new :any, :invalid }.should raise_error(ArgumentError)
+  end
+
+  it 'should check if values are assignable' do
+    even = lambda {|v| (v % 2).zero? }
+    is_2 = lambda {|v| v == 2 }
+
+    integer(:if => even).valid?(1).should be(false)
+    integer(:if => even).valid?(2).should be(true)
+    integer(:unless => even).valid?(1).should be(true)
+    integer(:unless => even).valid?(2).should be(false)
+    integer(:if => even, :unless => is_2).valid?(2).should be(false)
+    integer(:if => even, :unless => is_2).valid?(3).should be(false)
+    integer(:if => even, :unless => is_2).valid?(4).should be(true)
+  end
+
+  it 'should type-cast strings' do
+    field(:string).type_cast(nil).should == nil
+    field(:string).type_cast(1).should == '1'
+  end
+
+  it 'should type-cast ints' do
+    field(:integer).type_cast(nil).should == nil
+    field(:integer).type_cast('1').should == 1
+    field(:integer).type_cast(2.5).should == 2
+    field(:integer).type_cast("").should == 0
+  end
+
+  it 'should type-cast floats' do
+    field(:float).type_cast(nil).should == nil
+    field(:float).type_cast('1').should == 1.0
+    field(:float).type_cast(2.5).should == 2.5
+    field(:float).type_cast("").should == 0
+  end
+
+  it 'should type-cast booleans' do
+    field(:boolean).type_cast(nil).should == nil
+    field(:boolean).type_cast('1').should == true
+    field(:boolean).type_cast(0).should == false
+    field(:boolean).type_cast(true).should == true
+  end
+
+  it 'should type-cast dates' do
+    field(:date).type_cast('2011-01-01').should == Date.civil(2011, 1, 1)
+    field(:date).type_cast(Date.civil(2011, 11, 11)).should == Date.civil(2011, 11, 11)
+    field(:date).type_cast(Time.at(1234567890)).should == Date.civil(2009, 2, 13)
+  end
+
+  it 'should type-cast datetimes' do
+    field(:datetime).type_cast('2011-01-01 12:10').should == Time.zone.local(2011, 1, 1, 12, 10)
+    field(:datetime).type_cast(Time.at(1234567890)).should == Time.at(1234567890)
+    field(:datetime).type_cast(Time.at(1234567890)).zone.should == "UTC"
+  end
+
+  it 'should type-cast arrays' do
+    field(:array).type_cast('1').should == ['1']
+    field(:array, :cast => :integer).type_cast('1').should == [1]
+    field(:array, :cast => :integer).type_cast(['1', 2, 'B']).should == [1, 2, 0]
+  end
+
+end

data/spec/preferable/model_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Preferable::Model do
+
+  subject do
+    Class.new(ActiveRecord::Base)
+  end
+
+  it 'should be includable' do
+    subject.send(:included_modules).should include(described_class)
+  end
+
+  it 'should store a preferable schema' do
+    User._preferable.keys.should =~ ["newsletter", "color"]
+  end
+
+  it 'should inherit preferable schema correctly' do
+    Admin._preferable.keys.should =~ ["newsletter", "color", "reminder"]
+  end
+
+  it 'should allow to define preferables' do
+    res = nil
+    subject._preferable.should be_nil
+    subject.preferable { res = self.class.name }
+    subject._preferable.should be_a(Preferable::Schema)
+    res.should == "Preferable::Schema"
+  end
+
+  describe "saving" do
+
+    it 'should save preferences with new records' do
+      user = User.new
+      user.preferences.should == {}
+      user.preferences[:color] = '222222'
+      user.tap(&:save!).tap(&:reload).preferences.should == { "color" => '222222' }
+    end
+
+    it 'should save preferences with existing records' do
+      user = User.create!(:name => 'Random', :preferences => { :color => '222222' }).reload
+      user.preferences.should == { "color" => '222222' }
+      user.preferences[:newsletter] = '1'
+      user.tap(&:save!).tap(&:reload).preferences.should == { "color" => '222222', "newsletter" => true }
+    end
+
+  end
+
+
+  describe "instances" do
+
+    subject do
+      User.new
+    end
+
+    it 'should have preferences' do
+      subject.preferences.should be_a(Preferable::Set)
+    end
+
+    it 'should allow assigning preferences' do
+      subject.preferences = { :color => '222222' }
+      subject.preferences.should be_a(Preferable::Set)
+      subject.preferences.should == { "color" => '222222' }
+    end
+
+    it 'should serialize preferences' do
+      subject.class.serialized_attributes.keys.should include('preferences')
+    end
+
+  end
+end

data/spec/preferable/schema_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Preferable::Schema do
+
+  it { should be_a(Hash) }
+  it { should respond_to(:string) }
+  it { should respond_to(:integer) }
+  it { should respond_to(:float) }
+  it { should respond_to(:date) }
+  it { should respond_to(:datetime) }
+  it { should respond_to(:array) }
+  it { should respond_to(:boolean) }
+
+  it 'should build and store field' do
+    field = subject.field :color, :string
+    field.should be_a(Preferable::Field)
+    subject.should == { "color" => field }
+  end
+
+  it 'should provide shorthand method' do
+    subject.integer :client_id
+    subject.keys.should == ["client_id"]
+    subject.values.first.should be_a(Preferable::Field)
+  end
+
+  it 'should allow to specify options with shorthand method' do
+    subject.integer :client_id, :default => 1
+    subject.values.first.default.should == 1
+  end
+
+  it 'should allow specifying multiple fields with shorthand method' do
+    subject.integer :first, :second
+    subject.keys.should =~ ["first", "second"]
+  end
+
+  it 'should allow specifying multiple fields with options with shorthand method' do
+    subject.integer :first, :second, :default => 0
+    subject.keys.should =~ ["first", "second"]
+    subject.values.map(&:default).should == [0, 0]
+  end
+
+end

data/spec/preferable/set_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Preferable::Set do
+
+  let :user do
+    User.new
+  end
+
+  let :admin do
+    Admin.new
+  end
+
+  subject do
+    user.preferences
+  end
+
+  it 'should wrap values' do
+    described_class.wrap(user, subject).should_not be(subject)
+    described_class.wrap(user, subject).should == subject
+    described_class.wrap(user, subject).owner.should be(user)
+
+    described_class.wrap(admin, subject).should be_instance_of(described_class)
+    described_class.wrap(admin, subject).owner.should be(admin)
+
+    described_class.wrap(user, {}).should be_instance_of(described_class)
+    described_class.wrap(user, {}).owner.should be(user)
+  end
+
+  it 'should reference the owner' do
+    subject.owner.should == user
+  end
+
+  it 'should be convertable to a simple hash' do
+    subject.to_hash.should be_instance_of(Hash)
+  end
+
+  describe "reading" do
+
+    it 'should return assignments or defaults' do
+      subject[:color].should == '444444'
+      subject[:color] = '222222'
+      subject[:color].should == '222222'
+    end
+
+    it 'should return nil for invalid keys' do
+      subject[:invalid].should be_nil
+    end
+
+  end
+
+  describe "writing" do
+
+    it 'should ignore invalid keys' do
+      subject[:invalid] = '1'
+      subject.should == {}
+    end
+
+    it 'should set values' do
+      subject[:color] = '222222'
+      subject.should == { "color" => '222222' }
+    end
+
+    it 'should notify record about changes' do
+      subject[:color] = '222222'
+      user.should be_changed
+      user.changed_attributes.should == { "preferences"=>{} }
+    end
+
+    it 'should type cast values' do
+      subject[:color] = 222222
+      subject.should == { "color" => '222222' }
+    end
+
+    it 'should unset key when defaults are assigned' do
+      subject[:color] = '222222'
+      subject.should == { "color" => '222222' }
+      subject[:color] = '444444'
+      subject.should == {}
+    end
+
+    it 'should unset key when nil is assigned' do
+      subject[:color] = '222222'
+      subject.should == { "color" => '222222' }
+      subject[:color] = nil
+      subject.should == {}
+    end
+
+    it 'should allow mass-update' do
+      subject.set 'color' => 222222, :newsletter => '1'
+      subject.should == { "color" => '222222', "newsletter" => true }
+      subject.set :color => nil, :newsletter => false
+      subject.should == {}
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+$: << File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require :default, :test
+
+require 'active_support'
+require 'active_record'
+require 'rspec'
+require 'preferable'
+
+Time.zone = 'UTC'
+ActiveRecord::Base.time_zone_aware_attributes = true
+ActiveRecord::Base.default_timezone = :utc
+ActiveRecord::Base.configurations["test"] = { 'adapter' => 'sqlite3', 'database' => ":memory:" }
+ActiveRecord::Base.establish_connection(:test)
+ActiveRecord::Base.connection.create_table :users do |t|
+  t.string :name
+  t.text   :preferences
+end
+
+class User < ActiveRecord::Base
+
+  preferable do
+    string  :color, :default => '444444'
+    boolean :newsletter, :default => false
+  end
+
+end
+
+class Admin < User
+
+  preferable do
+    boolean :reminder, :default => false
+  end
+
+end

metadata

@@ -1,62 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: preferable
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 0.5.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Dimitrij Denissenko
 - Evgeniy Dolzhenko
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: abstract
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &9804020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *9804020
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &9735560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *9735560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &9731060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9731060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &9691900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9691900
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &9690880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9690880
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: &9690140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9690140
 description: Great for storing user preferences
 email: dimitrij@blacksquaremedia.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.markdown
 - lib/preferable.rb
 - lib/preferable/field.rb
@@ -64,42 +91,40 @@ files:
 - lib/preferable/set.rb
 - lib/preferable/schema.rb
 - lib/preferable/coder.rb
+- spec/preferable/field_spec.rb
+- spec/preferable/coder_spec.rb
+- spec/preferable/model_spec.rb
+- spec/preferable/schema_spec.rb
+- spec/preferable/set_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bsm/preferable
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
-      version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple preferences store for ActiveRecord
-test_files: []
-
+test_files:
+- spec/preferable/field_spec.rb
+- spec/preferable/coder_spec.rb
+- spec/preferable/model_spec.rb
+- spec/preferable/schema_spec.rb
+- spec/preferable/set_spec.rb
+- spec/spec_helper.rb