ardm 0.0.1

data/spec/shared/semipublic_property_spec.rb

@@ -0,0 +1,159 @@
+share_examples_for 'A semipublic Property' do
+  module ::Blog
+    class Article < Ardm::Record
+      self.table_name = "articles"
+      property :id, Serial
+    end
+  end
+
+  describe '.new' do
+    describe 'when provided no options' do
+      it 'should return a Property' do
+        property.should be_kind_of(type)
+      end
+
+      it 'should set the load_as' do
+        property.load_as.should be(type.load_as)
+      end
+
+      it 'should set the model' do
+        property.model.should equal(model)
+      end
+
+      it 'should set the options to the default' do
+        property.options.should == type.options.merge(options)
+      end
+    end
+
+    [ :index, :unique_index, :unique, :lazy ].each do |attribute|
+      [ true, false, :title, [ :title ] ].each do |value|
+        opts = { attribute => value }
+        describe "when provided #{opts.inspect}" do
+          let(:property) { type.new(model, name, options.merge(opts)) }
+
+          it 'should return a Property' do
+            property.should be_kind_of(type)
+          end
+
+          it 'should set the model' do
+            property.model.should equal(model)
+          end
+
+          it 'should set the load_as' do
+            property.load_as.should be(type.load_as)
+          end
+
+          it "should set the options to #{opts.inspect}" do
+            property.options.should == type.options.merge(options.merge(opts))
+          end
+        end
+      end
+
+      [ [], nil ].each do |value|
+        describe "when provided #{(invalid_options = { attribute => value }).inspect}" do
+          it 'should raise an exception' do
+            lambda {
+              type.new(model, name, options.merge(invalid_options))
+            }.should raise_error(ArgumentError, "options[#{attribute.inspect}] must be either true, false, a Symbol or an Array of Symbols")
+          end
+        end
+      end
+    end
+  end
+
+  describe '#load' do
+    subject { property.load(value) }
+
+    before do
+      property.should_receive(:typecast).with(value).and_return(value)
+    end
+
+    it { should eql(value) }
+  end
+
+  describe "#typecast" do
+    describe 'when value is nil' do
+      it 'returns value unchanged' do
+        property.typecast(nil).should be(nil)
+      end
+
+      describe 'when value is a Ruby primitive' do
+        it 'returns value unchanged' do
+          property.typecast(value).should == value
+        end
+      end
+    end
+  end
+
+  describe '#valid?' do
+    describe 'when provided a valid value' do
+      it 'should return true' do
+        property.valid?(value).should be(true)
+      end
+    end
+
+    describe 'when provide an invalid value' do
+      it 'should return false' do
+        property.valid?(invalid_value).should be(false)
+      end
+    end
+
+    describe 'when provide a nil value when required' do
+      it 'should return false' do
+        property = type.new(model, name, options.merge(:required => true))
+        property.valid?(nil).should be(false)
+      end
+    end
+
+    describe 'when provide a nil value when not required' do
+      it 'should return false' do
+        property = type.new(model, name, options.merge(:required => false))
+        property.valid?(nil).should be(true)
+      end
+    end
+  end
+
+  describe '#assert_valid_value' do
+    subject do
+      property.assert_valid_value(value)
+    end
+
+    shared_examples_for 'assert_valid_value on invalid value' do
+      it 'should raise Ardm::Property::InvalidValueError' do
+        expect { subject }.to(raise_error(Ardm::Property::InvalidValueError) do |error|
+          error.property.should == property
+        end)
+      end
+    end
+
+    describe 'when provided a valid value' do
+      it 'should return true' do
+        subject.should be(true)
+      end
+    end
+
+    describe 'when provide an invalid value' do
+      let(:value) { invalid_value }
+
+      it_should_behave_like 'assert_valid_value on invalid value'
+    end
+
+    describe 'when provide a nil value when required' do
+      let(:property) { type.new(model, name, options.merge(:required => true)) }
+
+      let(:value) { nil }
+
+      it_should_behave_like 'assert_valid_value on invalid value'
+    end
+
+    describe 'when provide a nil value when not required' do
+      let(:property) { type.new(model, name, options.merge(:required => false)) }
+
+      let(:value) { nil }
+
+      it 'should return true' do
+        subject.should be(true)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--loadby random
+--format profile
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'pry'
+require 'database_cleaner'
+
+ENV['ORM'] ||= 'active_record'
+require 'ardm/env'
+
+Ardm.active_record do
+  ActiveRecord::Base.configurations = { "ardm" => {
+    "database" => "db/test.sqlite",
+    "adapter" => "sqlite3"
+  }}
+  ActiveRecord::Base.establish_connection 'ardm'
+
+  begin
+    $stdout = StringIO.new
+    load Pathname.new(__FILE__).dirname.expand_path.join("schema.rb")
+  ensure
+    $stdout = STDOUT
+  end
+end
+
+Ardm.data_mapper do
+  raise "TODO: DataMapper setup."
+end
+
+Dir["#{Pathname(__FILE__).dirname.expand_path}/shared/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+DEPENDENCIES = {
+  'bcrypt' => 'bcrypt-ruby',
+}
+
+def try_spec
+  begin
+    yield
+  rescue LoadError => error
+    match = error.message.match(/\Ano such file to load -- (.+)\z/)
+    raise error unless match && (lib = match[1])
+
+    gem_location = DEPENDENCIES[lib] || raise("Unknown lib #{lib}")
+
+    warn "[WARNING] Skipping specs using #{lib}, please do: gem install #{gem_location}"
+  end
+end

data/spec/unit/bcrypt_hash_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+try_spec do
+  describe Ardm::Property::BCryptHash do
+    before do
+      @clear_password   = 'Ardm R0cks!'
+      @crypted_password = BCrypt::Password.create(@clear_password)
+
+      @nonstandard_type = 1
+
+      class ::TestType
+        @a = 1
+        @b = 'Hi There'
+      end
+      @nonstandard_type2 = TestType.new
+
+      class ::User < Ardm::Record
+        property :id, Serial
+        property :password, BCryptHash
+      end
+
+      @bcrypt_hash = User.properties[:password]
+    end
+
+    describe '.dump' do
+      describe 'when argument is a string' do
+        before do
+          @input  = 'Ardm'
+          @result = @bcrypt_hash.dump(@input)
+        end
+
+        it 'returns instance of BCrypt::Password' do
+          @result.should be_an_instance_of(BCrypt::Password)
+        end
+
+        it 'returns a string that is 60 characters long' do
+          @result.size.should == 60
+        end
+      end
+
+      describe 'when argument is nil' do
+        before do
+          @input  = nil
+          @result = @bcrypt_hash.dump(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+    end
+
+    describe '.load' do
+      describe 'when argument is a string' do
+        before do
+          @input  = 'Ardm'
+          @result = @bcrypt_hash.load(@crypted_password)
+        end
+
+        it 'returns instance of BCrypt::Password' do
+          @result.should be_an_instance_of(BCrypt::Password)
+        end
+
+        it 'returns a string that matches original' do
+          @result.should == @clear_password
+        end
+      end
+
+      describe 'when argument is nil' do
+        before do
+          @input  = nil
+          @result = @bcrypt_hash.load(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+    end
+
+    describe '.typecast' do
+      describe 'when argument is a string' do
+        before do
+          @input  = 'bcrypt hash'
+          @result = @bcrypt_hash.typecast(@input)
+        end
+
+        it 'casts argument to BCrypt::Password' do
+          @result.should be_an_instance_of(BCrypt::Password)
+        end
+
+        it 'casts argument to value that matches input' do
+          @result.should == @input
+        end
+      end
+
+      describe 'when argument is a blank string' do
+        before do
+          @input  = ''
+          @result = @bcrypt_hash.typecast(@input)
+        end
+
+        it 'casts argument to BCrypt::Password' do
+          @result.should be_an_instance_of(BCrypt::Password)
+        end
+
+        it 'casts argument to value that matches input' do
+          @result.should == @input
+        end
+      end
+
+      describe 'when argument is integer' do
+        before do
+          @input  = 2249
+          @result = @bcrypt_hash.typecast(@input)
+        end
+
+        it 'casts argument to BCrypt::Password' do
+          @result.should be_an_instance_of(BCrypt::Password)
+        end
+
+        it 'casts argument to value that matches input' do
+          @result.should == @input
+        end
+      end
+
+      describe 'when argument is hash' do
+        before do
+          @input  = { :cryptic => 'obscure' }
+          @result = @bcrypt_hash.typecast(@input)
+        end
+
+        it 'casts argument to BCrypt::Password' do
+          @result.should be_an_instance_of(BCrypt::Password)
+        end
+
+        it 'casts argument to value that matches input' do
+          @result.should == @input
+        end
+      end
+
+      describe 'when argument is nil' do
+        before do
+          @input  = nil
+          @result = @bcrypt_hash.typecast(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/unit/csv_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+try_spec do
+  describe Ardm::Property::Csv do
+    before do
+      class ::User < Ardm::Record
+        property :id, Serial
+        property :things, Csv
+      end
+
+      @property = User.properties[:things]
+    end
+
+    describe '.load' do
+      describe 'when argument is a comma separated string' do
+        before do
+          @input  = 'uno,due,tre'
+          @result = @property.load(@input)
+        end
+
+        it 'parses the argument using CVS parser' do
+          @result.should == [ %w[ uno due tre ] ]
+        end
+      end
+
+      describe 'when argument is an empty array' do
+        before do
+          @input    = []
+          @result   = @property.load(@input)
+        end
+
+        it 'does not change the input' do
+          @result.should == @input
+        end
+      end
+
+      describe 'when argument is an empty hash' do
+        before do
+          @input    = {}
+          @result   = @property.load(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+
+      describe 'when argument is nil' do
+        before do
+          @input    = nil
+          @result   = @property.load(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+
+      describe 'when argument is an integer' do
+        before do
+          @input    = 7
+          @result   = @property.load(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+
+      describe 'when argument is a float' do
+        before do
+          @input    = 7.0
+          @result   = @property.load(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+
+      describe 'when argument is an array' do
+        before do
+          @input  = [ 1, 2, 3 ]
+          @result = @property.load(@input)
+        end
+
+        it 'returns input as is' do
+          @result.should eql(@input)
+        end
+      end
+    end
+
+    describe '.dump' do
+      describe 'when value is a list of lists' do
+        before do
+          @input  = [ %w[ uno due tre ], %w[ uno dos tres ] ]
+          @result = @property.dump(@input)
+        end
+
+        it 'dumps value to comma separated string' do
+          @result.should == "uno,due,tre\nuno,dos,tres\n"
+        end
+      end
+
+      describe 'when value is a string' do
+        before do
+          @input  = 'beauty hides in the deep'
+          @result = @property.dump(@input)
+        end
+
+        it 'returns input as is' do
+          @result.should == @input
+        end
+      end
+
+      describe 'when value is nil' do
+        before do
+          @input  = nil
+          @result = @property.dump(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+
+      describe 'when value is a hash' do
+        before do
+          @input  = { :library => 'Ardm', :language => 'Ruby' }
+          @result = @property.dump(@input)
+        end
+
+        it 'returns nil' do
+          @result.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/unit/dirty_minder_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'ardm/property/support/dirty_minder'
+
+describe Ardm::Property::DirtyMinder,'set!' do
+
+  let(:property_class) do
+    Class.new(Ardm::Property::Object) do
+    end
+  end
+
+  let(:model) do
+    property_class = self.property_class
+    Class.new(Ardm::Record) do
+      self.table_name = 'api_users'
+
+      property :id, Ardm::Property::Serial
+      property :name, property_class
+    end
+  end
+
+  let(:resource) { model.new }
+
+  let(:object) { model.properties[:name] }
+
+  subject { object.set!(resource,value) }
+
+  shared_examples_for 'a non hooked value' do
+    it 'should not extend value with hook' do
+      value.should_not be_kind_of(Ardm::Property::DirtyMinder::Hooker)
+    end
+  end
+
+  shared_examples_for 'a hooked value' do
+    it 'should extend value with hook' do
+      pending "FIXME: This probably should pass" do
+        value.should be_kind_of(Ardm::Property::DirtyMinder::Hooker)
+      end
+    end
+  end
+
+  before do
+    subject
+  end
+
+  context 'when setting nil' do
+    let(:value) { nil }
+    it_should_behave_like 'a non hooked value'
+  end
+
+  context 'when setting a String' do
+    let(:value) { "The fred" }
+    it_should_behave_like 'a non hooked value'
+  end
+
+  context 'when setting an Array' do
+    let(:value) { ["The fred"] }
+    it_should_behave_like 'a hooked value'
+  end
+
+  context 'when setting a Hash' do
+    let(:value) { {"The" => "fred"} }
+    it_should_behave_like 'a hooked value'
+  end
+end

data/spec/unit/enum_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+try_spec do
+  describe Ardm::Property::Enum do
+    before do
+      class ::User < Ardm::Record
+        property :id, Serial
+      end
+
+      @property_klass = Ardm::Property::Enum
+    end
+
+    it_should_behave_like "A property with flags"
+
+    describe '.dump' do
+      before do
+        @enum = User.property(:enum, Ardm::Property::Enum[:first, :second, :third])
+      end
+
+      it 'should return the key of the value match from the flag map' do
+        @enum.dump(:first).should == 1
+        @enum.dump(:second).should == 2
+        @enum.dump(:third).should == 3
+      end
+
+      describe 'when there is no match' do
+        it 'should return nil' do
+          @enum.dump(:zero).should be_nil
+        end
+      end
+    end
+
+    describe '.load' do
+      before do
+        @enum = User.property(:enum, Ardm::Property::Enum, :flags => [:uno, :dos, :tres])
+      end
+
+      it 'returns the value of the key match from the flag map' do
+        @enum.load(1).should == :uno
+        @enum.load(2).should == :dos
+        @enum.load(3).should == :tres
+      end
+
+      describe 'when there is no key' do
+        it 'returns nil' do
+          @enum.load(-1).should be_nil
+        end
+      end
+    end
+
+    describe '.typecast' do
+      describe 'of Enum created from a symbol' do
+        before do
+          @enum = User.property(:enum, Ardm::Property::Enum, :flags => [:uno])
+        end
+
+        describe 'when given a symbol' do
+          it 'uses Enum type' do
+            @enum.typecast(:uno).should == :uno
+          end
+        end
+
+        describe 'when given a string' do
+          it 'uses Enum type' do
+            @enum.typecast('uno').should == :uno
+          end
+        end
+
+        describe 'when given nil' do
+          it 'returns nil' do
+            @enum.typecast( nil).should == nil
+          end
+        end
+      end
+
+      describe 'of Enum created from integer list' do
+        before do
+          @enum = User.property(:enum, Ardm::Property::Enum, :flags => [1, 2, 3])
+        end
+
+        describe 'when given an integer' do
+          it 'uses Enum type' do
+            @enum.typecast(1).should == 1
+          end
+        end
+
+        describe 'when given a float' do
+          it 'uses Enum type' do
+            @enum.typecast(1.1).should == 1
+          end
+        end
+
+        describe 'when given nil' do
+          it 'returns nil' do
+            @enum.typecast( nil).should == nil
+          end
+        end
+      end
+
+      describe 'of Enum created from a string' do
+        before do
+          @enum = User.property(:enum, Ardm::Property::Enum, :flags => ['uno'])
+        end
+
+        describe 'when given a symbol' do
+          it 'uses Enum type' do
+            @enum.typecast(:uno).should == 'uno'
+          end
+        end
+
+        describe 'when given a string' do
+          it 'uses Enum type' do
+            @enum.typecast('uno').should == 'uno'
+          end
+        end
+
+        describe 'when given nil' do
+          it 'returns nil' do
+            @enum.typecast( nil).should == nil
+          end
+        end
+      end
+    end
+  end
+end