plucky 0.5.2 → 0.6.0

data/spec/plucky/normalizers/criteria_hash_key_spec.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+describe Plucky::Normalizers::CriteriaHashKey do
+  subject {
+    described_class.new
+  }
+
+  context "with a string" do
+    it "returns symbol" do
+      subject.call('foo').should eq(:foo)
+    end
+  end
+
+  context "with a symbol" do
+    it "returns symbol" do
+      subject.call(:foo).should eq(:foo)
+    end
+  end
+
+  context "with :id" do
+    it "returns :_id" do
+      subject.call(:id).should eq(:_id)
+    end
+  end
+
+  it "returns key if something weird" do
+    subject.call(['crazytown']).should eq(['crazytown'])
+  end
+
+  SymbolOperators.each do |operator|
+    context "with #{operator} symbol operator" do
+      it "returns field" do
+        subject.call(:age.send(operator)).should eq(:age)
+      end
+    end
+  end
+end

data/spec/plucky/normalizers/criteria_hash_value_spec.rb

@@ -0,0 +1,193 @@
+require 'helper'
+
+describe Plucky::Normalizers::CriteriaHashValue do
+  let(:criteria_hash) { Plucky::CriteriaHash.new }
+
+  subject {
+    described_class.new(criteria_hash)
+  }
+
+  context "with a string" do
+    it "leaves string values for string keys alone" do
+      subject.call(:foo, :foo, 'bar').should eq('bar')
+    end
+
+    context "that is actually an object id" do
+      it "converts string values to object ids for object id keys" do
+        criteria_hash.object_ids = [:_id]
+        id = BSON::ObjectId.new
+        subject.call(:_id, :_id, id.to_s).should eq(id)
+      end
+    end
+  end
+
+  context "with a time" do
+    it "converts times to utc" do
+      time = Time.now
+      actual = time
+      expected = time.utc
+      result = subject.call(:foo, :foo, actual)
+      result.should be_utc
+      result.should eq(expected)
+    end
+
+    it "leaves utc times alone" do
+      time = Time.now
+      actual = time.utc
+      expected = time.utc
+      result = subject.call(:foo, :foo, actual)
+      result.should be_utc
+      result.should eq(expected)
+    end
+  end
+
+  context "with an array" do
+    it "defaults to $in" do
+      actual = [1,2,3]
+      expected = {:$in => [1,2,3]}
+      subject.call(:foo, :foo, actual).should eq(expected)
+    end
+
+    it "does not double up $in" do
+      actual = [1, 2, 3]
+      expected = [1, 2, 3]
+      subject.call(:$in, :$in, actual).should eq(expected)
+    end
+
+    it "uses existing modifier if present" do
+      actual = {'$all' => [1,2,3]}
+      expected = {'$all' => [1,2,3]}
+      subject.call(:foo, :foo, actual).should eq(expected)
+
+      actual = {'$any' => [1,2,3]}
+      expected = {'$any' => [1,2,3]}
+      subject.call(:foo, :foo, actual).should eq(expected)
+    end
+
+    it "does not turn value to $in with $or key" do
+      actual = [{:numbers => 1}, {:numbers => 2}]
+      expected = [{:numbers => 1}, {:numbers => 2}]
+      subject.call(:$or, :$or, actual).should eq(expected)
+    end
+
+    it "does not turn value to $in with $and key" do
+      actual = [{:numbers => 1}, {:numbers => 2}]
+      expected = [{:numbers => 1}, {:numbers => 2}]
+      subject.call(:$and, :$and, actual).should eq(expected)
+    end
+
+    it "does not turn value to $in with $nor key" do
+      actual = [{:numbers => 1}, {:numbers => 2}]
+      expected = [{:numbers => 1}, {:numbers => 2}]
+      subject.call(:$nor, :$nor, actual).should eq(expected)
+    end
+
+    it "defaults to $in even with ObjectId keys" do
+      actual = [1,2,3]
+      expected = {:$in => [1,2,3]}
+      criteria_hash.object_ids = [:mistake_id]
+      subject.call(:mistake_id, :mistake_id, actual).should eq(expected)
+    end
+  end
+
+  context "with a set" do
+    it "defaults to $in and convert to array" do
+      actual = [1,2,3].to_set
+      expected = {:$in => [1,2,3]}
+      subject.call(:numbers, :numbers, actual).should eq(expected)
+    end
+
+    it "uses existing modifier if present and convert to array" do
+      actual = {'$all' => [1,2,3].to_set}
+      expected = {'$all' => [1,2,3]}
+      subject.call(:foo, :foo, actual).should eq(expected)
+
+      actual = {'$any' => [1,2,3].to_set}
+      expected = {'$any' => [1,2,3]}
+      subject.call(:foo, :foo, actual).should eq(expected)
+    end
+  end
+
+  context "with string object ids for string keys" do
+    let(:object_id) { BSON::ObjectId.new }
+
+    it "leaves string ids as strings" do
+      subject.call(:_id, :_id, object_id.to_s).should eq(object_id.to_s)
+      subject.call(:room_id, :room_id, object_id.to_s).should eq(object_id.to_s)
+    end
+  end
+
+  context "with string object ids for object id keys" do
+    let(:object_id) { BSON::ObjectId.new }
+
+    before do
+      criteria_hash.object_ids = [:_id, :room_id]
+    end
+
+    it "converts strings to object ids" do
+      subject.call(:_id, :_id, object_id.to_s).should eq(object_id)
+      subject.call(:room_id, :room_id, object_id.to_s).should eq(object_id)
+    end
+
+    context "nested with modifier" do
+      let(:oid1) { BSON::ObjectId.new }
+      let(:oid2) { BSON::ObjectId.new }
+      let(:oids) { [oid1.to_s, oid2.to_s] }
+
+      it "converts strings to object ids" do
+        actual = {:$in => oids}
+        expected = {:$in => [oid1, oid2]}
+        subject.call(:_id, :_id, actual).should eq(expected)
+      end
+
+      it "does not modify original array of string ids" do
+        subject.call(:_id, :_id, {:$in => oids})
+        oids.should == [oid1.to_s, oid2.to_s]
+      end
+    end
+  end
+
+  context "nested clauses" do
+    it "knows constant array of operators that take nested queries" do
+      described_class::NestingOperators.should == [:$or, :$and, :$nor]
+    end
+
+    described_class::NestingOperators.each do |operator|
+      context "with #{operator}" do
+        it "works with symbol operators" do
+          nested1     = {:age.gt   => 12, :age.lt => 20}
+          translated1 = {:age      => {:$gt  => 12, :$lt  => 20 }}
+          nested2     = {:type.nin => ['friend', 'enemy']}
+          translated2 = {:type     => {:$nin => ['friend', 'enemy']}}
+          value       = [nested1, nested2]
+          expected    = [translated1, translated2]
+
+          subject.call(operator, operator, value).should eq(expected)
+        end
+
+        it "honors criteria hash options" do
+          nested     = [{:post_id  => '4f5ead6378fca23a13000001'}]
+          translated = [{:post_id  => BSON::ObjectId.from_string('4f5ead6378fca23a13000001')}]
+          given      = {operator.to_s => [nested]}
+
+          criteria_hash.object_ids = [:post_id]
+          subject.call(operator, operator, nested).should eq(translated)
+        end
+      end
+    end
+
+    context "doubly nested" do
+      it "works with symbol operators" do
+        nested1     = {:age.gt   => 12, :age.lt => 20}
+        translated1 = {:age      => {:$gt => 12, :$lt => 20}}
+        nested2     = {:type.nin => ['friend', 'enemy']}
+        translated2 = {:type     => {:$nin => ['friend', 'enemy']}}
+        nested3     = {'$and'    => [nested2]}
+        translated3 = {:$and     => [translated2]}
+        expected    = [translated1, translated3]
+
+        subject.call(:$or, :$or, [nested1, nested3]).should eq(expected)
+      end
+    end
+  end
+end

data/spec/plucky/normalizers/fields_value_spec.rb

@@ -0,0 +1,45 @@
+require 'helper'
+require 'plucky/normalizers/fields_value'
+
+describe Plucky::Normalizers::FieldsValue do
+  it "defaults to nil" do
+    subject.call(nil).should be_nil
+  end
+
+  it "returns nil if empty string" do
+    subject.call('').should be_nil
+  end
+
+  it "returns nil if empty array" do
+    subject.call([]).should be_nil
+  end
+
+  it "works with array" do
+    subject.call(['one', 'two']).should eq(['one', 'two'])
+  end
+
+  # Ruby 1.9.x was sending array [{:age => 20}], instead of hash.
+  it "works with array that has one hash" do
+    subject.call([{:age => 20}]).should eq({:age => 20})
+  end
+
+  it "flattens multi-dimensional array" do
+    subject.call([[:one, :two]]).should eq([:one, :two])
+  end
+
+  it "works with symbol" do
+    subject.call(:one).should eq([:one])
+  end
+
+  it "works with array of symbols" do
+    subject.call([:one, :two]).should eq([:one, :two])
+  end
+
+  it "works with hash" do
+    subject.call({:one => 1, :two => -1}).should eq({:one => 1, :two => -1})
+  end
+
+  it "converts comma separated list to array" do
+    subject.call('one, two').should eq(['one', 'two'])
+  end
+end

data/spec/plucky/normalizers/integer_spec.rb

@@ -0,0 +1,24 @@
+require 'helper'
+require 'plucky/normalizers/integer'
+
+describe Plucky::Normalizers::Integer do
+  context "with nil" do
+    it "returns nil" do
+      subject.call(nil).should be_nil
+    end
+  end
+
+  context "with an integer" do
+    it "returns an integer" do
+      subject.call(1).should be(1)
+      subject.call(3232).should be(3232)
+    end
+  end
+
+  context "with a string" do
+    it "returns a string" do
+      subject.call('1').should be(1)
+      subject.call('3232').should be(3232)
+    end
+  end
+end

data/spec/plucky/normalizers/options_hash_key_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe Plucky::Normalizers::OptionsHashKey do
+  subject {
+    described_class.new
+  }
+
+  it "changes order to sort" do
+    subject.call(:order).should eq(:sort)
+  end
+
+  it "changes select to fields" do
+    subject.call(:select).should eq(:fields)
+  end
+
+  it "changes offset to skip" do
+    subject.call(:offset).should eq(:skip)
+  end
+
+  it "changes id to _id" do
+    subject.call(:id).should eq(:_id)
+  end
+end

data/spec/plucky/normalizers/options_hash_value_spec.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+describe Plucky::Normalizers::OptionsHashValue do
+  let(:key_normalizer) {
+    lambda { |key|
+      if key == :id
+        :_id
+      else
+        key.to_sym
+      end
+    }
+  }
+
+  let(:upcasing_normalizer) {
+    lambda { |value| value.to_s.upcase }
+  }
+
+  let(:default_arguments) {
+    {
+      :key_normalizer => key_normalizer,
+    }
+  }
+
+  subject {
+    described_class.new(default_arguments)
+  }
+
+  it "raises exception if missing key normalizer" do
+    expect {
+      described_class.new
+    }.to raise_error(ArgumentError, "Missing required key :key_normalizer")
+  end
+
+  it "allows injecting a new value normalizer" do
+    instance = described_class.new(default_arguments.merge({
+      :value_normalizers => {
+        :some_field => upcasing_normalizer,
+      }
+    }))
+
+    instance.call(:some_field, 'upcase me').should eq('UPCASE ME')
+  end
+
+  context "with :fields key" do
+    subject {
+      described_class.new(default_arguments.merge({
+        :value_normalizers => {
+          :fields => upcasing_normalizer
+        },
+      }))
+    }
+
+    it "calls the fields value normalizer" do
+      subject.call(:fields, :foo).should eq('FOO')
+    end
+  end
+
+  context "with :sort key" do
+    subject {
+      described_class.new(default_arguments.merge({
+        :value_normalizers => {
+          :sort => upcasing_normalizer
+        },
+      }))
+    }
+
+    it "calls the sort value normalizer" do
+      subject.call(:sort, :foo).should eq('FOO')
+    end
+  end
+
+  context "with :limit key" do
+    subject {
+      described_class.new(default_arguments.merge({
+        :value_normalizers => {
+          :limit => upcasing_normalizer
+        },
+      }))
+    }
+
+    it "calls the limit value normalizer" do
+      subject.call(:limit, :foo).should eq('FOO')
+    end
+  end
+
+  context "with :skip key" do
+    subject {
+      described_class.new(default_arguments.merge({
+        :value_normalizers => {
+          :skip => upcasing_normalizer
+        },
+      }))
+    }
+
+    it "calls the skip value normalizer" do
+      subject.call(:skip, :foo).should eq('FOO')
+    end
+  end
+end

data/spec/plucky/normalizers/sort_value_spec.rb

@@ -0,0 +1,94 @@
+require 'helper'
+require 'plucky/normalizers/sort_value'
+
+describe Plucky::Normalizers::SortValue do
+  let(:key_normalizer) {
+    lambda { |key| key == :id ? :_id : key.to_sym }
+  }
+
+  subject {
+    described_class.new({
+      :key_normalizer => key_normalizer,
+    })
+  }
+
+  it "raises exception if missing key normalizer" do
+    expect {
+      described_class.new
+    }.to raise_error(ArgumentError, "Missing required key :key_normalizer")
+  end
+
+  it "defaults to nil" do
+    subject.call(nil).should eq(nil)
+  end
+
+  it "works with natural order ascending" do
+    subject.call('$natural' => 1).should eq('$natural' => 1)
+  end
+
+  it "works with natural order descending" do
+    subject.call('$natural' => -1).should eq('$natural' => -1)
+  end
+
+  it "converts single ascending field (string)" do
+    subject.call('foo asc').should eq([['foo', 1]])
+    subject.call('foo ASC').should eq([['foo', 1]])
+  end
+
+  it "converts single descending field (string)" do
+    subject.call('foo desc').should eq([['foo', -1]])
+    subject.call('foo DESC').should eq([['foo', -1]])
+  end
+
+  it "converts multiple fields (string)" do
+    subject.call('foo desc, bar asc').should eq([['foo', -1], ['bar', 1]])
+  end
+
+  it "converts multiple fields and default no direction to ascending (string)" do
+    subject.call('foo desc, bar, baz').should eq([['foo', -1], ['bar', 1], ['baz', 1]])
+  end
+
+  it "converts symbol" do
+    subject.call(:name).should eq([['name', 1]])
+  end
+
+  it "converts operator" do
+    subject.call(:foo.desc).should eq([['foo', -1]])
+  end
+
+  it "converts array of operators" do
+    subject.call([:foo.desc, :bar.asc]).should eq([['foo', -1], ['bar', 1]])
+  end
+
+  it "converts array of symbols" do
+    subject.call([:first_name, :last_name]).should eq([['first_name', 1], ['last_name', 1]])
+  end
+
+  it "works with array and one string element" do
+    subject.call(['foo, bar desc']).should eq([['foo', 1], ['bar', -1]])
+  end
+
+  it "works with array of single array" do
+    subject.call([['foo', -1]]).should eq([['foo', -1]])
+  end
+
+  it "works with array of multiple arrays" do
+    subject.call([['foo', -1], ['bar', 1]]).should eq([['foo', -1], ['bar', 1]])
+  end
+
+  it "compacts nil values in array" do
+    subject.call([nil, :foo.desc]).should eq([['foo', -1]])
+  end
+
+  it "converts array with mix of values" do
+    subject.call([:foo.desc, 'bar']).should eq([['foo', -1], ['bar', 1]])
+  end
+
+  it "converts keys based on key normalizer" do
+    subject.call([:id.asc]).should eq([['_id', 1]])
+  end
+
+  it "converts string with $natural correctly" do
+    subject.call('$natural desc').should eq([['$natural', -1]])
+  end
+end