ransack_query 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29866fedcac520d326da58852285d277c3c8a5cf
-  data.tar.gz: 4316ef41d3eb2d83f10b5dd6641dae14faaa1718
+  metadata.gz: 553fe942438f924f048fcd4c1fa83366ac4fdb90
+  data.tar.gz: 42fecaf7185e415d54973863339ea75ab00f774f
 SHA512:
-  metadata.gz: 4783eb8b35d2c9e286526346da0e0e75f8bec468681fe678919ea13e193ed7098eb5af264c4b8282bd51e5c64dda4ec470dbe41938d3b53f3ccbdeb57885e1f3
-  data.tar.gz: 2026a2f35455d90bc04654fe30f46ae042360510b779531c1c9570d44fb17638693b5f9360c3f8d8d5c50ddf85a540e88b9a23984dfc754dc1b2e7c7a623f967
+  metadata.gz: c9106e9af0080f40e4101f716181568f90a05361612a0d73125dfdfab69d192153a8fb36e2954c0e96ae0b97d666316687e89ee56b9a65ab292eb74cbb4e306e
+  data.tar.gz: 411acd4b6f5f3e10c9b0d2661ba2ce70fa3250e366445de7a4016851e8ecb8719d5c3ea7c3aa1d10a57a140e33bcd92269f07a010e0ea9c829f3cff19607cc6a

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## 0.4.0 - 2014-09-01
+### Added
+- None
+
+### Changed
+- Changed Condition model to RansackCondition.
+Changed Grouping model to RansackGrouping.
+
+### Removed
+- None

data/README.md

@@ -1,3 +1,5 @@
+[![Code Climate](https://codeclimate.com/github/frank-west-iii/ransack_query.png)](https://codeclimate.com/github/frank-west-iii/ransack_query)
+
 # RansackQuery
 
 This gem provides a semantic way of building advanced ransack queries outside of using the form.
@@ -42,7 +44,7 @@ and with arrays
     end
 and with blocks
 
-    RansackQuery.build(prefix: 'q') do |grouping|
+    RansackQuery.build do |grouping|
       grouping.add_condition do |condition|
         condition.attribute = 'first_name'
         condition.value = 'Bob'

data/lib/{condition.rb → ransack_condition.rb}

@@ -1,4 +1,4 @@
-class Condition
+class RansackCondition
   attr_accessor :id, :predicate, :attribute, :value
 
   def initialize(attributes={})
@@ -19,6 +19,10 @@ class Condition
     }
   end
 
+  def to_condition
+    self
+  end
+
   private
   def build_ransack_array(array, hash_key)
     counter = -1
@@ -32,4 +36,4 @@ class Condition
     end
   end
 
-end
+end

data/lib/{grouping.rb → ransack_grouping.rb}

@@ -1,4 +1,4 @@
-class Grouping
+class RansackGrouping
   attr_accessor :id, :combinator
   attr_reader :conditions, :groupings
 
@@ -12,31 +12,31 @@ class Grouping
 
   def add_condition(condition=nil)
     if block_given?
-      condition = Condition.new do |new_condition|
+      condition = RansackCondition.new do |new_condition|
         yield new_condition
       end
     end
-    conditions << condition
+    conditions << condition.to_condition
     self
   end
 
   def add_grouping(grouping=nil)
     if block_given?
-      grouping = Grouping.new do |new_grouping|
+      grouping = RansackGrouping.new do |new_grouping|
         yield new_grouping
       end
     end
-    groupings << grouping
+    groupings << grouping.to_grouping
     self
   end
 
   def add_conditions(conditions)
-    @conditions += conditions
+    Array(conditions).each {|c| add_condition(c) }
     self
   end
 
   def add_groupings(groupings)
-    @groupings += groupings
+    Array(groupings).each {|g| add_grouping(g) }
     self
   end
 
@@ -51,6 +51,10 @@ class Grouping
     ransack_hash
   end
 
+  def to_grouping
+    self
+  end
+
   private
 
   def ransackify_conditions(ransack_hash)

data/lib/ransack_query/version.rb

@@ -1,3 +1,3 @@
 module RansackQuery
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/ransack_query.rb

@@ -1,13 +1,13 @@
 require 'ransack_query/version'
-require 'grouping'
-require 'condition'
+require 'ransack_grouping'
+require 'ransack_condition'
 require 'json'
 require 'securerandom'
 
 module RansackQuery
 
   def self.build(options = {})
-    grouping = Grouping.new do |new_grouping|
+    grouping = RansackGrouping.new do |new_grouping|
       yield new_grouping
     end
     ransack_hash = {'g' => grouping.ransackify}
@@ -20,18 +20,4 @@ module RansackQuery
     SecureRandom.hex
   end
 
-  def self.sample
-    build do |grouping|
-      grouping.combinator = :or
-      grouping.add_grouping do |new_grouping|
-        new_grouping.add_condition(Condition.new(attribute: 'document_number', value: '111'))
-        new_grouping.add_condition(Condition.new(attribute: 'driver_name', value: '222'))
-      end
-      grouping.add_grouping do |new_grouping|
-        new_grouping.add_condition(Condition.new(attribute: 'document_number', value: '333'))
-        new_grouping.add_condition(Condition.new(attribute: 'driver_name', value: '444'))
-      end
-    end
-  end
-
 end

data/spec/factories/{condition.rb → ransack_condition.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 FactoryGirl.define do
 
-  factory :condition do
+  factory :ransack_condition do
     id 1
     attribute 'attribute'
     value 'value'
@@ -19,4 +19,4 @@ FactoryGirl.define do
     end
   end
 
-end
+end

data/spec/factories/{grouping.rb → ransack_grouping.rb}

@@ -1,16 +1,16 @@
 # encoding: utf-8
 FactoryGirl.define do
 
-  factory :grouping do
+  factory :ransack_grouping do
     id 1
 
     trait :complex do
       combinator :or
       after(:build) do |obj|
-        grouping = FactoryGirl.build(:grouping, :with_conditions)
+        grouping = FactoryGirl.build(:ransack_grouping, :with_conditions)
         grouping.id = 2
         obj.add_grouping(grouping)
-        grouping = FactoryGirl.build(:grouping, :with_conditions)
+        grouping = FactoryGirl.build(:ransack_grouping, :with_conditions)
         grouping.id = 3
         obj.add_grouping(grouping)
       end
@@ -19,11 +19,11 @@ FactoryGirl.define do
     trait :with_conditions do
       id 2
       after(:build) do |obj|
-        obj.add_condition FactoryGirl.build(:condition, :document_number)
-        obj.add_condition FactoryGirl.build(:condition, :driver_name)
+        obj.add_condition FactoryGirl.build(:ransack_condition, :document_number)
+        obj.add_condition FactoryGirl.build(:ransack_condition, :driver_name)
       end
     end
 
   end
 
-end
+end

data/spec/models/ransack_condition_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe RansackCondition do
+  let(:condition) { FactoryGirl.build(:ransack_condition) }
+  let(:condition_hash) { FactoryGirl.build(:condition_hash) }
+
+  it 'should have an id' do
+    expect(subject.id).to_not be_nil
+  end
+
+  it 'should have a default predicate of eq' do
+    expect(subject.predicate).to eq :eq
+  end
+
+  it 'should accept a predicate' do
+    expect(lambda { subject.predicate = :eq }).to_not raise_error
+  end
+
+  it 'should accept an attribute' do
+    expect(lambda { subject.attribute = 'attribute' }).to_not raise_error
+  end
+
+  it 'should accept a value' do
+    expect(lambda { subject.value = 'value' }).to_not raise_error
+  end
+
+  it 'should accept setting the attribute via the initializer' do
+    expect(RansackCondition.new(attribute: 'new_attribute').attribute).to eq 'new_attribute'
+  end
+
+  it 'should accept setting the value via the initializer' do
+    expect(RansackCondition.new(value: 'new_value').value).to eq 'new_value'
+  end
+
+  it 'should accept setting the predicate via the initializer' do
+    expect(RansackCondition.new(predicate: 'new_predicate').predicate).to eq 'new_predicate'
+  end
+
+  it 'should allow initializing via a block' do
+    id = nil
+    new_condition = RansackCondition.new do |condition|
+      id = condition.id
+    end
+    expect(id).to eq new_condition.id
+  end
+
+  it 'should build a ransack hash' do
+    expect(condition.ransackify).to eq condition_hash
+  end
+end

data/spec/models/ransack_grouping_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe RansackGrouping do
+  subject { FactoryGirl.build(:ransack_grouping) }
+  let(:complex) { FactoryGirl.build(:ransack_grouping, :complex) }
+  let(:with_conditions) { FactoryGirl.build(:grouping, :with_conditions) }
+
+  it 'should have an id' do
+    expect(subject.id).to_not be_nil
+  end
+
+  it 'should have a default combinator of and' do
+    expect(subject.combinator).to eq :and
+  end
+
+  it 'should return a accept setting combinator' do
+    expect(lambda { subject.combinator = :and }).to_not raise_error
+  end
+
+  it 'should allow you to add a condition' do
+    subject.add_condition(RansackCondition.new({attribute: 'location_code', value: '001', predicate: 'eq'}))
+    expect(subject.conditions.size).to eq 1
+  end
+
+  it 'should allow adding conditions through chaining' do
+    subject.add_condition(RansackCondition.new(attribute: 'location_code', value: '001', predicate: 'eq')).
+        add_condition(RansackCondition.new(attribute: 'location_code', value: '002', predicate: 'eq'))
+    expect(subject.conditions.size).to eq 2
+  end
+
+  it 'should allow adding groupings' do
+    subject.add_grouping(RansackGrouping.new)
+    expect(subject.groupings.size).to eq 1
+  end
+
+  it 'should allow adding groupings through chaining' do
+    subject.add_grouping(RansackGrouping.new).
+        add_grouping(RansackGrouping.new)
+    expect(subject.groupings.size).to eq 2
+  end
+
+  it 'should allow adding groupings without chaining' do
+    subject.add_grouping(RansackGrouping.new)
+    subject.add_grouping(RansackGrouping.new)
+    expect(subject.groupings.size).to eq 2
+  end
+
+  it 'should allow building a group via a block' do
+    g = RansackGrouping.new do |grouping|
+      grouping.combinator = :or
+      grouping.add_grouping do |new_grouping|
+        new_grouping.add_condition(RansackCondition.new(attribute: 'ItemNumber', value: 'RC')).
+            add_condition(RansackCondition.new(attribute: 'LocationCode', value: '002'))
+      end
+      grouping.add_grouping do |new_grouping|
+        new_grouping.add_condition(RansackCondition.new(attribute: 'ItemNumber', value: 'RC')).
+            add_condition(RansackCondition.new(attribute: 'LocationCode', value: '001'))
+      end
+    end
+
+    expect(g.groupings.size).to eq 2
+  end
+
+  it 'should allow adding conditions en masse' do
+    subject.add_conditions(
+        [RansackCondition.new(attribute: 'location_code', value: '001', predicate: 'eq'),
+         RansackCondition.new(attribute: 'location_code', value: '001', predicate: 'eq')])
+    expect(subject.conditions.size).to eq 2
+  end
+
+  it 'should allow adding groupings en masse' do
+    subject.add_groupings([RansackGrouping.new, RansackGrouping.new])
+    expect(subject.groupings.size).to eq 2
+  end
+
+  it 'should allow adding a condition via a block' do
+    klass = nil
+    subject.add_condition do |condition|
+      klass = condition.class
+    end
+    expect(klass).to eq RansackCondition
+  end
+
+  it 'should allow adding a group via a block' do
+    klass = nil
+    subject.add_grouping do |grouping|
+      klass = grouping.class
+    end
+    expect(klass).to eq RansackGrouping
+  end
+
+  it 'should allow initializing via a block' do
+    id = nil
+    grouping = RansackGrouping.new do |grp|
+      id = grp.id
+    end
+    expect(id).to eq grouping.id
+  end
+
+  it 'should build a complex ransack hash' do
+    expect(complex.ransackify).to eq FactoryGirl.build(:grouping_hash)
+  end
+
+end

data/spec/models/ransack_query_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe RansackQuery do
   it 'should not build without a block' do
-    lambda { RansackQuery.build }.should raise_error
+    expect(lambda { RansackQuery.build }).to raise_error
   end
 
   it 'should return a grouping to build off' do
@@ -10,40 +10,42 @@ describe RansackQuery do
     RansackQuery.build do |grouping|
       klass = grouping.class
     end
-    klass.should equal Grouping
+    expect(klass).to eq RansackGrouping
   end
 
   it 'should return a hash' do
-    RansackQuery.build do |grouping|
+    result = RansackQuery.build do |grouping|
       grouping.id = 'id1'
       grouping.add_condition do |condition|
         condition.id = 'id2'
         condition.attribute = 'attribute'
         condition.value = 'value'
       end
-    end.should eq({'g' => {'id1' => {'m' => 'and', 'c' => {'id2' => {'a' => {'0' => {'name' => 'attribute'}}, 'p' => 'eq', 'v' => {'0' => {'value' => 'value'}}}}}}})
+    end
+    expect(result).to eq({'g' => {'id1' => {'m' => 'and', 'c' => {'id2' => {'a' => {'0' => {'name' => 'attribute'}}, 'p' => 'eq', 'v' => {'0' => {'value' => 'value'}}}}}}})
   end
 
   it 'should return a json string if specified' do
-    RansackQuery.build(format: :json) do |grouping|
+    result = RansackQuery.build(format: :json) do |grouping|
       grouping.id = 'id1'
       grouping.add_condition do |condition|
         condition.id = 'id2'
         condition.attribute = 'attribute'
         condition.value = 'value'
       end
-    end.should eq "{\"g\":{\"id1\":{\"m\":\"and\",\"c\":{\"id2\":{\"a\":{\"0\":{\"name\":\"attribute\"}},\"p\":\"eq\",\"v\":{\"0\":{\"value\":\"value\"}}}}}}}"
+    end
+    expect(result).to eq "{\"g\":{\"id1\":{\"m\":\"and\",\"c\":{\"id2\":{\"a\":{\"0\":{\"name\":\"attribute\"}},\"p\":\"eq\",\"v\":{\"0\":{\"value\":\"value\"}}}}}}}"
   end
 
   it 'should allow a prefix to be passed in' do
-    RansackQuery.build(prefix: 'q') do |grouping|
+    result = RansackQuery.build(prefix: 'q') do |grouping|
       grouping.id = 'id1'
       grouping.add_condition do |condition|
         condition.id = 'id2'
         condition.attribute = 'attribute'
         condition.value = 'value'
       end
-    end.should eq({'q' => {'g' => {'id1' => {'m' => 'and', 'c' => {'id2' => {'a' => {'0' => {'name' => 'attribute'}}, 'p' => 'eq', 'v' => {'0' => {'value' => 'value'}}}}}}}})
+    end
+    expect(result).to eq({'q' => {'g' => {'id1' => {'m' => 'and', 'c' => {'id2' => {'a' => {'0' => {'name' => 'attribute'}}, 'p' => 'eq', 'v' => {'0' => {'value' => 'value'}}}}}}}})
   end
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ransack_query
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Frank West
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,21 +160,22 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/condition.rb
-- lib/grouping.rb
+- lib/ransack_condition.rb
+- lib/ransack_grouping.rb
 - lib/ransack_query.rb
 - lib/ransack_query/version.rb
 - ransack_query.gemspec
-- spec/factories/condition.rb
-- spec/factories/grouping.rb
 - spec/factories/hash.rb
-- spec/models/condition_spec.rb
-- spec/models/grouping_spec.rb
+- spec/factories/ransack_condition.rb
+- spec/factories/ransack_grouping.rb
+- spec/models/ransack_condition_spec.rb
+- spec/models/ransack_grouping_spec.rb
 - spec/models/ransack_query_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/frank-west-iii/ransack_query
@@ -202,10 +203,11 @@ signing_key:
 specification_version: 4
 summary: Provides a way to build advanced ransack queries.
 test_files:
-- spec/factories/condition.rb
-- spec/factories/grouping.rb
 - spec/factories/hash.rb
-- spec/models/condition_spec.rb
-- spec/models/grouping_spec.rb
+- spec/factories/ransack_condition.rb
+- spec/factories/ransack_grouping.rb
+- spec/models/ransack_condition_spec.rb
+- spec/models/ransack_grouping_spec.rb
 - spec/models/ransack_query_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/models/condition_spec.rb

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-describe Condition do
-  let(:condition) { FactoryGirl.build(:condition) }
-  let(:condition_hash) { FactoryGirl.build(:condition_hash) }
-
-  it 'should have an id' do
-    subject.id.should_not be nil
-  end
-
-  it 'should have a default predicate of eq' do
-    subject.predicate.should eq :eq
-  end
-
-  it 'should accept a predicate' do
-    lambda { subject.predicate = :eq }.should_not raise_error
-  end
-
-  it 'should accept an attribute' do
-    lambda { subject.attribute = 'attribute' }.should_not raise_error
-  end
-
-  it 'should accept a value' do
-    lambda { subject.value = 'value' }.should_not raise_error
-  end
-
-  it 'should accept setting the attribute via the initializer' do
-    Condition.new(attribute: 'new_attribute').attribute.should eq 'new_attribute'
-  end
-
-  it 'should accept setting the value via the initializer' do
-    Condition.new(value: 'new_value').value.should eq 'new_value'
-  end
-
-  it 'should accept setting the predicate via the initializer' do
-    Condition.new(predicate: 'new_predicate').predicate.should eq 'new_predicate'
-  end
-
-  it 'should allow initializing via a block' do
-    id = nil
-    new_condition = Condition.new do |condition|
-      id = condition.id
-    end
-    id.should eq new_condition.id
-  end
-
-  it 'should build a ransack hash' do
-    condition.ransackify.should eq condition_hash
-  end
-
-end

data/spec/models/grouping_spec.rb

@@ -1,104 +0,0 @@
-require 'spec_helper'
-
-describe Grouping do
-  subject { FactoryGirl.build(:grouping) }
-  let(:complex) { FactoryGirl.build(:grouping, :complex) }
-  let(:with_conditions) { FactoryGirl.build(:grouping, :with_conditions) }
-
-  it 'should have an id' do
-    subject.id.should_not be nil
-  end
-
-  it 'should have a default combinator of and' do
-    subject.combinator.should eq :and
-  end
-
-  it 'should return a accept setting combinator' do
-    lambda { subject.combinator = :and }.should_not raise_error
-  end
-
-  it 'should allow you to add a condition' do
-    subject.add_condition({attribute: 'location_code', value: '001', predicate: 'eq'})
-    subject.conditions.size.should eq 1
-  end
-
-  it 'should allow adding conditions through chaining' do
-    subject.add_condition(Condition.new(attribute: 'location_code', value: '001', predicate: 'eq')).
-        add_condition(Condition.new(attribute: 'location_code', value: '002', predicate: 'eq'))
-    subject.conditions.size.should eq 2
-  end
-
-  it 'should allow adding groupings' do
-    subject.add_grouping(Grouping.new)
-    subject.groupings.size.should eq 1
-  end
-
-  it 'should allow adding groupings through chaining' do
-    subject.add_grouping(Grouping.new).
-        add_grouping(Grouping.new)
-    subject.groupings.size.should eq 2
-  end
-
-  it 'should allow adding groupings without chaining' do
-    subject.add_grouping(Grouping.new)
-    subject.add_grouping(Grouping.new)
-    subject.groupings.size.should eq 2
-  end
-
-  it 'should do stuff' do
-    g = Grouping.new do |grouping|
-      grouping.combinator = :or
-      grouping.add_grouping do |new_grouping|
-        new_grouping.add_condition(Condition.new(attribute: 'ItemNumber', value: 'RC')).
-            add_condition(Condition.new(attribute: 'LocationCode', value: '002'))
-      end
-      grouping.add_grouping do |new_grouping|
-        new_grouping.add_condition(Condition.new(attribute: 'ItemNumber', value: 'RC')).
-            add_condition(Condition.new(attribute: 'LocationCode', value: '001'))
-      end
-    end
-
-    g.groupings.size.should eq 2
-  end
-
-  it 'should allow adding conditions en masse' do
-    subject.add_conditions(
-        [Condition.new(attribute: 'location_code', value: '001', predicate: 'eq'),
-         Condition.new(attribute: 'location_code', value: '001', predicate: 'eq')])
-    subject.conditions.size.should eq 2
-  end
-
-  it 'should allow adding groupings en masse' do
-    subject.add_groupings([Grouping.new, Grouping.new])
-    subject.groupings.size.should eq 2
-  end
-
-  it 'should allow adding a condition via a block' do
-    klass = nil
-    subject.add_condition do |condition|
-      klass = condition.class
-    end
-    klass.should eq Condition
-  end
-
-  it 'should allow adding a group via a block' do
-    klass = nil
-    subject.add_grouping do |grouping|
-      klass = grouping.class
-    end
-    klass.should eq Grouping
-  end
-
-  it 'should allow initializing via a block' do
-    id = nil
-    grouping = Grouping.new do |grouping|
-      id = grouping.id
-    end
-    id.should eq grouping.id
-  end
-
-  it 'should build a complex ransack hash' do
-    complex.ransackify.should eq FactoryGirl.build(:grouping_hash)
-  end
-
-end