praxis 2.0.pre.8 → 2.0.pre.13

data/spec/praxis/extensions/attribute_filtering/filter_tree_node_spec.rb

@@ -4,14 +4,15 @@ require 'praxis/extensions/attribute_filtering'
 
 describe Praxis::Extensions::AttributeFiltering::FilterTreeNode do
 
+  let(:dummy_object) { double("Fake NodeObject")}
   let(:filters) do
     [
-      {name: 'one', specs: { op: '>', value: 1}},
-      {name: 'one', specs: { op: '<', value: 10}},
-      {name: 'rel1.a1', specs: { op: '=', value: 1}},
-      {name: 'rel1.a2', specs: { op: '=', value: 2}},
-      {name: 'rel1.rel2.b1', specs: { op: '=', value: 11}},
-      {name: 'rel1.rel2.b2', specs: { op: '=', value: 12}}
+      {name: 'one', op: '>', value: 1, node_object: dummy_object},
+      {name: 'one', op: '<', value: 10},
+      {name: 'rel1.a1', op: '=', value: 1},
+      {name: 'rel1.a2', op: '=', value: 2},
+      {name: 'rel1.rel2.b1', op: '=', value: 11},
+      {name: 'rel1.rel2.b2', op: '=', value: 12, node_object: dummy_object}
     ]
   end
   context 'initialization' do
@@ -19,20 +20,38 @@ describe Praxis::Extensions::AttributeFiltering::FilterTreeNode do
     it 'holds the top conditions and the child in a TreeNode' do
       expect(subject.path).to eq([])
       expect(subject.conditions.size).to eq(2)
+      expect(subject.conditions.map{|i| i.slice(:name,:op,:value)}).to eq([
+        {name: 'one', op: '>', value: 1},
+        {name: 'one', op: '<', value: 10},
+      ])
       expect(subject.children.keys).to eq(['rel1'])
       expect(subject.children['rel1']).to be_kind_of(described_class)
     end
 
+    it 'passes on any node_object value at any level' do
+      expect(subject.conditions.first[:node_object]).to be(dummy_object)
+      expect(subject.conditions[1]).to_not have_key(:node_object)
+      expect(subject.children['rel1'].children['rel2'].conditions[1][:node_object]).to be(dummy_object)
+    end
+
     it 'recursively holds the conditions and the children of their children in a TreeNode' do
       rel1 = subject.children['rel1']
       expect(rel1.path).to eq(['rel1'])
       expect(rel1.conditions.size).to eq(2)
+      expect(rel1.conditions.map{|i| i.slice(:name,:op,:value)}).to eq([
+        {name: 'a1', op: '=', value: 1},
+        {name: 'a2', op: '=', value: 2},
+      ])
       expect(rel1.children.keys).to eq(['rel2'])
       expect(rel1.children['rel2']).to be_kind_of(described_class)
 
       rel1rel2 = rel1.children['rel2']
       expect(rel1rel2.path).to eq(['rel1','rel2'])
       expect(rel1rel2.conditions.size).to eq(2)
+      expect(rel1rel2.conditions.map{|i| i.slice(:name,:op,:value)}).to eq([
+        {name: 'b1', op: '=', value: 11},
+        {name: 'b2', op: '=', value: 12}  
+      ])      
       expect(rel1rel2.children.keys).to be_empty
     end
   end

data/spec/praxis/extensions/attribute_filtering/filtering_params_spec.rb

@@ -6,28 +6,210 @@ describe Praxis::Extensions::AttributeFiltering::FilteringParams do
 
   context '.load' do
     subject { described_class.load(filters_string) }
+
+    context 'unescapes the URL encoded values' do
+      it 'for single values' do
+          str = "one=#{CGI.escape('*')}&two>#{CGI.escape('^%$#!st_uff')}|three<normal"
+          parsed = [
+            { name: :one, op: '=', value: '*'},
+            { name: :two, op: '>', value: '^%$#!st_uff'},
+            { name: :three, op: '<', value: 'normal'},
+          ]
+          expect(described_class.load(str).parsed_array.map{|i| i.slice(:name,:op,:value)}).to eq(parsed)
+      end
+      it 'each of the multi-values' do
+        escaped_one = [
+          CGI.escape('fun!'),
+          CGI.escape('Times'),
+          CGI.escape('~!@#$%^&*()_+-={}|[]\:";\'<>?,./`')
+        ].join(',')
+        str = "one=#{escaped_one}&two>normal"
+        parsed = [
+          { name: :one, op: '=', value: ['fun!','Times','~!@#$%^&*()_+-={}|[]\:";\'<>?,./`']},
+          { name: :two, op: '>', value: 'normal'},
+        ]
+        expect(described_class.load(str).parsed_array.map{|i| i.slice(:name,:op,:value)}).to eq(parsed)
+    end
+    end
     context 'parses for operator' do
-      described_class::AVAILABLE_OPERATORS.each do |op|
+      described_class::VALUE_OPERATORS.each do |op|
         it "#{op}" do
           str = "thename#{op}thevalue"
           parsed = [{ name: :thename, op: op, value: 'thevalue'}]
-          expect(described_class.load(str).parsed_array).to eq(parsed)
+          expect(described_class.load(str).parsed_array.map{|i| i.slice(:name,:op,:value)}).to eq(parsed)
+        end
+      end
+      described_class::NOVALUE_OPERATORS.each do |op|
+        it "#{op}" do
+          str = "thename#{op}"
+          parsed = [{ name: :thename, op: op, value: nil}]
+          expect(described_class.load(str).parsed_array.map{|i| i.slice(:name,:op,:value)}).to eq(parsed)
         end
       end
+      it 'can parse multiple values for filter' do
+        str="filtername=1,2,3"
+        parsed = [{ name: :filtername, op: '=', value: ["1","2","3"]}]
+        expect(described_class.load(str).parsed_array.map{|i| i.slice(:name,:op,:value)}).to eq(parsed)
+      end
     end
-    context 'with all operators at once' do
-      let(:filters_string) { 'one=1&two!=2&three>=3&four<=4&five<5&six>6&seven!&eight!!'}
+    context 'with all value operators at once for the same AND group' do
+      let(:filters_string) { 'one=11&two!=22&three>=33&four<=4&five<5&six>6&seven!&eight!!'}
       it do
-        expect(subject.parsed_array).to eq([
-          { name: :one, op: '=', value: '1'},
-          { name: :two, op: '!=', value: '2'},
-          { name: :three, op: '>=', value: '3'},
+        expect(subject.parsed_array.map{|i| i.slice(:name,:op,:value)}).to eq([
+          { name: :one, op: '=', value: '11'},
+          { name: :two, op: '!=', value: '22'},
+          { name: :three, op: '>=', value: '33'},
           { name: :four, op: '<=', value: '4'},
           { name: :five, op: '<', value: '5'},
           { name: :six, op: '>', value: '6'},
           { name: :seven, op: '!', value: nil},
           { name: :eight, op: '!!', value: nil},          
         ])
+        # And all have the same parent, which is an AND group
+        parent = subject.parsed_array.map{|i|i[:node_object].parent_group}.uniq
+        expect(parent.size).to eq(1)
+        expect(parent.first.type).to eq(:and)
+        expect(parent.first.parent_group).to be_nil
+      end
+    end
+
+    context 'with with nested precedence groups' do
+      let(:filters_string) { '(one=11)&(two!=22|three!!)&four<=4&five>5|six!'}
+      it do
+        parsed = subject.parsed_array
+        expect(parsed.map{|i| i.slice(:name,:op,:value)}).to eq([
+          { name: :one, op: '=', value: '11'},
+          { name: :two, op: '!=', value: '22'},
+          { name: :three, op: '!!', value: nil},
+          { name: :four, op: '<=', value: '4'},
+          { name: :five, op: '>', value: '5'},
+          { name: :six, op: '!', value: nil},
+        ])
+        # Grouped appropriately
+        parent_of = parsed.each_with_object({}) do |item, hash|
+          hash[item[:name]] = item[:node_object].parent_group
+        end
+        # This is the expected tree grouping result
+        # OR -- six
+        #  |--- AND --five
+        #        |--- four
+        #        |--- OR -- three
+        #        |     |--- two
+        #        |--- one
+        # two and 3 are grouped together by an OR
+        expect(parent_of[:two]).to be(parent_of[:three])
+        expect(parent_of[:two].type).to eq(:or)
+        
+        # one, two, four and the or from two/three are grouped together by an AND
+        expect([parent_of[:one],parent_of[:two].parent_group,parent_of[:four],parent_of[:five]]).to all(be(parent_of[:one]))
+        expect(parent_of[:one].type).to eq(:and)
+
+        # six and the whole group above are grouped together with an OR
+        expect(parent_of[:six]).to be(parent_of[:one].parent_group)
+        expect(parent_of[:six].type).to eq(:or)
+      end
+    end
+
+    context 'value coercing when associated to a MediaType' do
+      let(:parsed) do
+        # Note wrap the filter_params (.for) type in an attribute (which then we discard), so it will 
+        # construct it propertly by applying the block. Seems easier than creating the type alone, and 
+        # then manually apply the block
+        Attributor::Attribute.new(described_class.for(Post)) do
+          filter 'id', using: ['=', '!=', '!']
+        end.type.load(str).parsed_array
+      end
+
+      context 'with a single value' do
+        let(:str) { 'id=1' }
+        it 'coerces its value to the associated mediatype attribute type' do
+          expect(parsed.first[:value]).to eq(1)
+          expect(Post.attributes[:id].type.valid_type?(parsed.first[:value])).to be_truthy
+        end
+      end
+
+      context 'with multimatch' do
+        let(:str) { 'id=1,2,3' }
+        it 'coerces ALL csv values to the associated mediatype attribute type' do
+          expect(parsed.first[:value]).to eq([1, 2, 3])
+          parsed.first[:value].each do |val|
+            expect(Post.attributes[:id].type.valid_type?(val)).to be_truthy
+          end
+        end
+      end
+
+      context 'with a single value that is null' do
+        let(:str) { 'id!' }
+        it 'properly loads it as null' do
+          expect(parsed.first[:value]).to be_nil
+        end
+      end
+    end
+
+  end
+
+  context '.validate' do
+    let(:filtering_params_type) do
+      # Note wrap the filter_params (.for) type in an attribute (which then we discard), so it will 
+      # construct it propertly by applying the block. Seems easier than creating the type alone, and 
+      # then manually apply the block
+      Attributor::Attribute.new(described_class.for(Post)) do
+        filter 'id', using: ['=', '!=']
+        filter 'title', using: ['=', '!='], fuzzy: true
+        filter 'content', using: ['=', '!=']
+      end.type
+    end
+    let(:loaded_params) { filtering_params_type.load(filters_string) }
+    subject { loaded_params.validate(filters_string) }
+
+    context 'errors' do
+      context 'given attributes that do not exist in the type' do
+        let(:filters_string) { 'NotAnExistingAttribute=Foobar*'}
+        it 'raises an error' do
+          expect{subject}.to raise_error(/NotAnExistingAttribute.*does not exist/)
+        end
+      end
+
+      context 'given unallowed attributes' do
+        let(:filters_string) { 'href=Foobar*'}
+        it 'raises an error' do
+          expect(subject).to_not be_empty
+          matches_error = subject.any? {|err| err =~ /Filtering by href is not allowed/}
+          expect(matches_error).to be_truthy
+        end
+      end
+
+      context 'given unallowed operator' do
+        let(:filters_string) { 'title>Foobar*'}
+        it 'raises an error' do
+          expect(subject).to_not be_empty
+          expect(subject.first).to match(/Operator > not allowed for filter title/)
+        end
+      end
+    end
+    context 'fuzzy matches' do
+      context 'when allowed' do
+        context 'given a fuzzy string' do
+          let(:filters_string) { 'title=IAmAString*'}
+          it 'validates properly' do
+            expect(subject).to be_empty
+          end
+        end
+      end
+      context 'when NOT allowed' do
+        context 'given a fuzzy string' do
+          let(:filters_string) { 'content=IAmAString*'}
+          it 'errors out' do
+            expect(subject).to_not be_empty
+            expect(subject.first).to match(/Fuzzy matching for content is not allowed/)
+          end
+        end
+        context 'given a non-fuzzy string' do
+          let(:filters_string) { 'content=IAmAString'}
+          it 'validates properly' do
+            expect(subject).to be_empty
+          end
+        end
       end
     end
   end

data/spec/praxis/extensions/attribute_filtering/filters_parser_spec.rb

@@ -0,0 +1,140 @@
+require 'praxis/extensions/attribute_filtering/filters_parser'
+
+
+describe Praxis::Extensions::AttributeFiltering::FilteringParams::Condition do
+end 
+
+describe Praxis::Extensions::AttributeFiltering::FilteringParams::ConditionGroup do
+end 
+
+describe Praxis::Extensions::AttributeFiltering::FilteringParams::Parser do
+
+  context 'testing' do
+    let(:expectations) do
+      { 
+        'one=11|two=22' => "( one=11 OR two=22 )"
+      }
+    end
+    it 'parses and loads the parsed result into the tree objects' do
+      expectations.each do |filters, dump_result|
+
+        parsed = described_class.new.parse(filters)
+        tree = Praxis::Extensions::AttributeFiltering::FilteringParams::ConditionGroup.load(parsed)
+
+        expect(tree.dump).to eq(dump_result)
+      end
+    end
+  end
+   context 'parses the grammar' do
+
+    # Takes a hash with keys containing literal filters string, and values being the "dump format for Condition/Group"
+    shared_examples 'round-trip-properly' do |expectations|
+      it description do
+        expectations.each do |filters, dump_result|
+          parsed = Praxis::Extensions::AttributeFiltering::FilteringParams::Parser.new.parse(filters)
+          tree = Praxis::Extensions::AttributeFiltering::FilteringParams::ConditionGroup.load(parsed)
+          expect(tree.dump).to eq(dump_result)
+        end
+      end
+    end
+
+    context 'single expression' do
+      it_behaves_like 'round-trip-properly', { 
+        'one=11' => 'one=11',
+        '(one=11)' => 'one=11',
+        'one!' => "one!",
+      }
+    end
+    context 'same expression operator' do
+      it_behaves_like 'round-trip-properly', { 
+        'one=11&two=22' => '( one=11 AND two=22 )',
+        'one=11&two=22&three=3' => '( one=11 AND two=22 AND three=3 )',
+        'one=1,2,3&two=4,5' => '( one=[1,2,3] AND two=[4,5] )',
+        'one=11|two=22' => '( one=11 OR two=22 )',
+        'one=11|two=22|three=3' => '( one=11 OR two=22 OR three=3 )',
+      }
+    end
+
+    context 'respects and/or precedence and parenthesis grouping' do
+      it_behaves_like 'round-trip-properly', { 
+        'a=1&b=2&z=9|c=3' => '( ( a=1 AND b=2 AND z=9 ) OR c=3 )',
+        'a=1|b=2&c=3' => '( a=1 OR ( b=2 AND c=3 ) )',
+        'a=1|b=2&c=3&d=4' => '( a=1 OR ( b=2 AND c=3 AND d=4 ) )',
+        '(a=1|b=2)&c=3&d=4' => '( ( a=1 OR b=2 ) AND c=3 AND d=4 )',
+        'a=1|a.b.c_c=1&b=2' => '( a=1 OR ( a.b.c_c=1 AND b=2 ) )',
+        'a=1,2,3|b=4,5&c=one,two' => '( a=[1,2,3] OR ( b=[4,5] AND c=[one,two] ) )',
+        'one=11&two=2|three=3' => '( ( one=11 AND two=2 ) OR three=3 )', # AND has higer precedence
+        'one=11|two=2&three=3' => '( one=11 OR ( two=2 AND three=3 ) )', # AND has higer precedence
+        'one=11&two=2|three=3&four=4' => '( ( one=11 AND two=2 ) OR ( three=3 AND four=4 ) )',
+        '(one=11)&(two!=2|three=3)&four=4&five=5|six=6' => 
+            '( ( one=11 AND ( two!=2 OR three=3 ) AND four=4 AND five=5 ) OR six=6 )',
+        '(one=11)&three=3' => '( one=11 AND three=3 )',
+        '(one=11|two=2)&(three=3|four=4)' => '( ( one=11 OR two=2 ) AND ( three=3 OR four=4 ) )',
+        '(category_uuid=deadbeef1|category_uuid=deadbeef2)&(name=Book1|name=Book2)' =>
+            '( ( category_uuid=deadbeef1 OR category_uuid=deadbeef2 ) AND ( name=Book1 OR name=Book2 ) )',
+        '(category_uuid=deadbeef1&name=Book1)|(category_uuid=deadbeef2&name=Book2)' =>
+            '( ( category_uuid=deadbeef1 AND name=Book1 ) OR ( category_uuid=deadbeef2 AND name=Book2 ) )',
+      }
+    end
+
+    context 'empty values get converted to empty strings' do
+      it_behaves_like 'round-trip-properly', { 
+        'one=' => 'one=""',
+        'one=&two=2' => '( one="" AND two=2 )',
+      }
+    end
+
+    context 'no value operands' do
+      it_behaves_like 'round-trip-properly', { 
+        'one!' => "one!",
+        'one!!' => "one!!"
+      }
+
+      it 'fails if passing a value' do
+        expect {
+          described_class.new.parse('one!val')
+        }.to raise_error(Parslet::ParseFailed)
+        expect {
+          described_class.new.parse('one!!val')
+        }.to raise_error(Parslet::ParseFailed)
+      end 
+    end
+
+    context 'csv values result in multiple values for the operation' do
+      it_behaves_like 'round-trip-properly', { 
+        'multi=1,2' => "multi=[1,2]",
+        'multi=1,2,valuehere' => "multi=[1,2,valuehere]"
+      }
+    end
+
+    context 'supports [a-zA-Z0-9_\.] for filter names' do
+      it_behaves_like 'round-trip-properly', { 
+        'normal=1'      => 'normal=1',
+        'cOmBo=1'       => 'cOmBo=1',
+        '1=2'           => '1=2',
+        'aFew42Things=1' => 'aFew42Things=1',
+        'under_scores=1' => 'under_scores=1',
+        'several.dots.in.here=1' => 'several.dots.in.here=1',
+        'cOrN.00copia.of_thinGs.42_here=1' => 'cOrN.00copia.of_thinGs.42_here=1',
+      }
+    end
+    context 'supports everything (except &|(),) for values (even without encoding..not allowed, but just to ensure the parser does not bomb)' do
+      it_behaves_like 'round-trip-properly', {
+        'v=1123' => 'v=1123',
+        'v=*foo*' => 'v=*foo*',
+        'v=*^%$#@!foo' => 'v=*^%$#@!foo',
+        'v=_-=\{}"?:><' => 'v=_-=\{}"?:><',
+        'v=_-=\{}"?:><,another_value!' => 'v=[_-=\{}"?:><,another_value!]',
+      }
+    end
+    context 'properly handles url-encoded values' do
+      it_behaves_like 'round-trip-properly', {
+        "v=#{CGI.escape('1123')}" => 'v=1123',
+        "v=#{CGI.escape('*foo*')}" => 'v=*foo*',
+        "v=#{CGI.escape('*^%$#@!foo')}" => 'v=*^%$#@!foo',
+        "v=#{CGI.escape('~!@#$%^&*()_+-={}|[]\:";\'<>?,./`')}" => 'v=~!@#$%^&*()_+-={}|[]\:";\'<>?,./`',
+        "v=#{CGI.escape('_-+=\{}"?:><')},#{CGI.escape('another_value!')}" => 'v=[_-+=\{}"?:><,another_value!]',
+      }
+    end 
+  end
+end

data/spec/praxis/extensions/field_expansion_spec.rb

@@ -24,8 +24,7 @@ describe Praxis::Extensions::FieldExpansion do
 
   let(:request_params) do
     double('params',
-      fields: Praxis::Extensions::FieldSelection::FieldSelector.for(Person).load(fields),
-      view: view
+      fields: Praxis::Extensions::FieldSelection::FieldSelector.for(Person).load(fields)
     )
   end
 
@@ -33,7 +32,6 @@ describe Praxis::Extensions::FieldExpansion do
   let(:media_type) { Person }
 
   let(:fields) { nil }
-  let(:view) { nil }
 
   let(:test_attributes) {  }
   let(:test_params) { double('test_params', attributes: test_attributes) }
@@ -43,43 +41,26 @@ describe Praxis::Extensions::FieldExpansion do
   context '#expanded_fields' do
 
     context 'with fields and view params defined' do
-      let(:test_attributes) { {view: true, fields: true}  }
+      let(:test_attributes) { {} }
 
-      context 'and no fields provided' do
+      context 'with no fields provided' do
         it 'returns the fields for the default view' do
           expect(expansion).to eq({id: true, name: true})
         end
-
-        pending 'and a view'
       end
 
       context 'with a set of fields provided' do
         let(:fields) { 'id,name,owner{name}' }
-        it 'returns the subset of fields for the default view' do
+        it 'returns the subset of fields' do
           expected = {id: true, name: true }
           expect(expansion).to eq expected
         end
-
-        pending 'and a view'
       end
     end
 
-    context 'with only a view param defined' do
-      let(:test_attributes) { {view: true}  }
-
-      it 'returns the fields for the default view' do
-        expect(expansion).to eq({id: true, name: true})
-      end
-
-      pending 'and a view'
-    end
-
-
     context 'with an action with no params' do
       let(:test_params) { nil }
-      let(:fields){ nil }
-      let(:view){ nil }
-      it 'ignores incoming parameters and expands for the default view' do
+      it 'ignores incoming parameters and expands for the default fieldset' do
         expect(expansion).to eq({id: true, name: true})
       end
     end