query_string_search 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5750a3574b4f201d0e9274a96fa4e1a10aff5593
-  data.tar.gz: 6bddcc98d4a95cd33a88ecd0d7d5adb49cc787ea
+  metadata.gz: 3b484ab328b2b5e889f3c0760ef857b3eccdddd8
+  data.tar.gz: d0071f6f1ca439042d640ce53271beda186375e2
 SHA512:
-  metadata.gz: 97feeae7f780d9513c10b1861cee25a72297d4e6af9fddd2e341e922349d627fa11bd25c4b785a5323cbe805846d5dbdec514474c6a30e912a9312d8479c51fd
-  data.tar.gz: 1f275d60e2f5b2075214b60e58546edbe261fc40db111734bb56584daac3088da502281314695fd3415a0c2ffae5c597ba1f8bbaaac30c4b4a9a19a2e4f5363e
+  metadata.gz: 44babe5feac2376030fe68edaa8a740c7f684959de01142558faa0d108ae86fc29ceeec5fd4a37896f38a19f6c95783c9da365afdea532632ab3e0ed110282f7
+  data.tar.gz: bc97993d98ba3a8fd352729a2bbbb3a329ee1d28d957c926e210f311fd42670526b538834a423092bdac947b519d0d3e4c99849cf47886b30722b908025d1bb5

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.1.5
+- 2.2.0
+- 2.0.0-p598
+addons:
+  code_climate:
+    repo_token:
+      secure: XnZ8VLwsAVr3lrJ3gInolfi1dALfyu0XF74t7VExawsSGuDJzFnx4lwqw139uQHqEUNOl/lj+SHMjgEIxtoM6LjX/JBiCQLTMyKKz5EMwUvFULz4vWaGy2mgyA48WDXZL/s1k0GW7/Q8wxpdQ7uU2izx2RaJ+PLmcYUNQhNBbMI=

data/README.md

@@ -1,4 +1,4 @@
-# Query String Search
+# Query String Search [![Build Status](https://api.travis-ci.org/umn-asr/query_string_search.svg?branch=master)](https://travis-ci.org/umn-asr/query_string_search) [![Code Climate](https://codeclimate.com/github/umn-asr/query_string_search/badges/gpa.svg)](https://codeclimate.com/github/umn-asr/query_string_search)
 
 Provides an easy way to implement searching in your API endpoints
 
@@ -28,6 +28,12 @@ Returns every movie without ratings.
 
 Returns every movie with a year of 1994
 
+### Return all data that matches one of many attributes
+
+`movies?q=year=1994|1995`
+
+Returns all movies with a year of 1994 or 1995
+
 ### Combining Searches
 
 Search criteria can be separated with commas
@@ -41,7 +47,7 @@ Records that match **all** the criteria will be returned. All un-rated movies ma
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'query_string_search', git: https://github.umn.edu/asrweb/query_string_search.git
+gem 'query_string_search'
 ```
 
 And then execute:

data/lib/query_string_search/matchers/match_attribute.rb

@@ -4,10 +4,13 @@ class MatchAttribute < QueryStringSearch::AbstractMatcher
   end
 
   def self.reserved_words
-    %w(true all)
+    [
+      /^true$/,
+      /^all$/
+    ]
   end
 
   def self.build_me?(_, search_param)
-    reserved_words.include?(search_param)
+    reserved_words.any? { |r| r.match(search_param) }
   end
 end

data/lib/query_string_search/matchers/match_attribute_value.rb

@@ -6,6 +6,8 @@ class MatchAttributeValue < QueryStringSearch::AbstractMatcher
   end
 
   def self.build_me?(search_type, search_param)
-    search_param && search_type && !all_reserved_words.include?(search_param)
+    search_param &&
+      search_type &&
+      all_reserved_words.none? { |r| r.match(search_param) }
   end
 end

data/lib/query_string_search/matchers/match_multiple_attribute_values.rb

@@ -0,0 +1,21 @@
+class MatchMultipleAttributeValues < QueryStringSearch::AbstractMatcher
+  def match?(target)
+    match_with_contingency do
+      value.include?(target.public_send(attribute).to_s.upcase)
+    end
+  end
+
+  def self.reserved_words
+    [
+      /^\w+\|\w+/
+    ]
+  end
+
+  def value=(x)
+    super(x.split("|").map(&:upcase))
+  end
+
+  def self.build_me?(_, search_param)
+    reserved_words.any? { |r| r.match(search_param) }
+  end
+end

data/lib/query_string_search/matchers/match_no_attribute.rb

@@ -4,10 +4,13 @@ class MatchNoAttribute < QueryStringSearch::AbstractMatcher
   end
 
   def self.reserved_words
-    %w(false none)
+    [
+      /^false$/,
+      /^none$/
+    ]
   end
 
   def self.build_me?(_, search_param)
-    reserved_words.include?(search_param)
+    reserved_words.any? { |r| r.match(search_param) }
   end
 end

data/lib/query_string_search/version.rb

@@ -1,3 +1,3 @@
 module QueryStringSearch
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/query_string_search.gemspec

@@ -6,8 +6,8 @@ require 'query_string_search/version'
 Gem::Specification.new do |spec|
   spec.name          = "query_string_search"
   spec.version       = QueryStringSearch::VERSION
-  spec.authors       = ["Ian Whitney"]
-  spec.email         = ["whit0694@umn.edu"]
+  spec.authors       = ["Ian Whitney", "Debbie Gillespie", "Davin Lagerroos"]
+  spec.email         = ["asrwebteam@umn.edu"]
   spec.summary       = %q{Provides a standard way to do searches using query strings in an API endpoint}
   spec.homepage      = "https://github.com/umn-asr/query_string_search"
   spec.license       = ""
@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "travis", "~> 1.7"
   spec.add_development_dependency "rubocop"
 end

data/spec/doubles/search_target.rb

@@ -0,0 +1,6 @@
+class SearchTarget
+  attr_accessor :property
+  def initialize(property: nil)
+    self.property = property
+  end
+end

data/spec/features/find_records_that_match_one_of_many_attributes_spec.rb

@@ -0,0 +1,13 @@
+require_relative "../../lib/query_string_search"
+require_relative "../fixtures/movie"
+
+RSpec.describe "Finding data that matches one of many attributes" do
+  let(:data_set) { Movie.random_collection }
+  let(:movies_in_1994_or_1995) { data_set.select { |d| %w(1994 1995).include?(d.year) } }
+
+  it "Returns records that match the requested value" do
+    results = QueryStringSearch.new(data_set, "year=1994|1995").results
+
+    expect(results).to eq(movies_in_1994_or_1995)
+  end
+end

data/spec/lib/query_string_search/matchers/match_attribute_spec.rb

@@ -1,10 +1,11 @@
 require_relative "../../../../lib/query_string_search/abstract_matcher"
+require_relative "../../../doubles/search_target"
 
 RSpec.describe MatchAttribute do
   describe "match?" do
     describe "if the target's attribute is not nil" do
-      let(:target) { Target.new("search_value") }
-      let(:subject) { MatchAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: "search_value") }
+      let(:subject) { MatchAttribute.new(:property) }
 
       it "is true" do
         expect(subject.match?(target)).to be_truthy
@@ -12,8 +13,8 @@ RSpec.describe MatchAttribute do
     end
 
     describe "if the target's attribute is true" do
-      let(:target) { Target.new(true) }
-      let(:subject) { MatchAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: true) }
+      let(:subject) { MatchAttribute.new(:property) }
 
       it "is true" do
         expect(subject.match?(target)).to be_truthy
@@ -21,8 +22,8 @@ RSpec.describe MatchAttribute do
     end
 
     describe "if the target's attribute is nil" do
-      let(:target) { Target.new(nil) }
-      let(:subject) { MatchAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: nil) }
+      let(:subject) { MatchAttribute.new(:property) }
 
       it "is false" do
         expect(subject.match?(target)).to be_falsey
@@ -30,8 +31,8 @@ RSpec.describe MatchAttribute do
     end
 
     describe "if the target's attribute is false" do
-      let(:target) { Target.new(false) }
-      let(:subject) { MatchAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: false) }
+      let(:subject) { MatchAttribute.new(:property) }
 
       it "is true" do
         expect(subject.match?(target)).to be_falsey
@@ -39,7 +40,7 @@ RSpec.describe MatchAttribute do
     end
 
     describe "if the target doesn't have the attribute" do
-      let(:target) { Target.new(rand) }
+      let(:target) { SearchTarget.new(property: rand) }
       let(:subject) { MatchAttribute.new(:bad_attr) }
 
       it "is false" do

data/spec/lib/query_string_search/matchers/match_attribute_value_spec.rb

@@ -1,11 +1,11 @@
 require_relative "../../../../lib/query_string_search/abstract_matcher"
+require_relative "../../../doubles/search_target"
 
 RSpec.describe MatchAttributeValue do
   describe "match?" do
     describe "given a target with an attribute that matches the Parameter's attribute" do
-      let(:target) { Target.new("search_value") }
-      let(:value) { "search_value" }
-      let(:subject) { MatchAttributeValue.new(:search_attr, value) }
+      let(:target) { SearchTarget.new(property: "search_value") }
+      let(:subject) { MatchAttributeValue.new(:property, "search_value") }
 
       it "returns true" do
         expect(subject.match?(target)).to be_truthy
@@ -13,9 +13,8 @@ RSpec.describe MatchAttributeValue do
     end
 
     describe "given a value with spaces" do
-      let(:target) { Target.new("search value") }
-      let(:value) { "search value" }
-      let(:subject) { MatchAttributeValue.new(:search_attr, value) }
+      let(:target) { SearchTarget.new(property: "search value") }
+      let(:subject) { MatchAttributeValue.new(:property, "search value") }
 
       it "returns true" do
         expect(subject.match?(target)).to be_truthy
@@ -23,9 +22,8 @@ RSpec.describe MatchAttributeValue do
     end
 
     describe "given a target with an attribute that does not match the Parameter's attribute" do
-      let(:target) { Target.new("other_value") }
-      let(:value) { "search_value" }
-      let(:subject) { MatchAttributeValue.new(:search_attr, value) }
+      let(:target) { SearchTarget.new(property: "other_value") }
+      let(:subject) { MatchAttributeValue.new(:property, "search_value") }
 
       it "returns false" do
         expect(subject.match?(target)).to be_falsey
@@ -33,9 +31,8 @@ RSpec.describe MatchAttributeValue do
     end
 
     describe "if the target doesn't have the attribute" do
-      let(:value) { "search_value" }
-      let(:target) { Target.new(value) }
-      let(:subject) { MatchAttribute.new(:bad_attr, value) }
+      let(:target) { SearchTarget.new(property: "search_value") }
+      let(:subject) { MatchAttribute.new(:bad_attr, "search_value") }
 
       it "is false" do
         expect(subject.match?(target)).to be_falsey
@@ -46,14 +43,14 @@ RSpec.describe MatchAttributeValue do
   describe "build_me?" do
     describe "given a non-nil search_type and search_param" do
       it "is true" do
-        expect(MatchAttributeValue.build_me?(rand, rand)).to be_truthy
+        expect(MatchAttributeValue.build_me?(rand.to_s, rand.to_s)).to be_truthy
       end
     end
 
     describe "given a nil search_type or search_param" do
       it "is false" do
-        expect(MatchAttributeValue.build_me?(rand, nil)).to be_falsey
-        expect(MatchAttributeValue.build_me?(nil, rand)).to be_falsey
+        expect(MatchAttributeValue.build_me?(rand.to_s, nil)).to be_falsey
+        expect(MatchAttributeValue.build_me?(nil, rand.to_s)).to be_falsey
         expect(MatchAttributeValue.build_me?(nil, nil)).to be_falsey
       end
     end

data/spec/lib/query_string_search/matchers/match_multiple_attribute_values_spec.rb

@@ -0,0 +1,47 @@
+require_relative "../../../../lib/query_string_search/abstract_matcher"
+require_relative "../../../doubles/search_target"
+
+RSpec.describe MatchMultipleAttributeValues do
+  describe "match?" do
+    it "matches if the target's attribute is one of the values" do
+      target = SearchTarget.new(property: "1994")
+      matcher = MatchMultipleAttributeValues.new(:property, "1994|1995")
+      expect(matcher.match?(target)).to be_truthy
+    end
+
+    it "does not match if the target's attribute is not one of the values" do
+      target = SearchTarget.new(property: "199")
+      matcher = MatchMultipleAttributeValues.new(:property, "1994|1995")
+      expect(matcher.match?(target)).to be_falsey
+    end
+
+    describe "if the target doesn't have the attribute" do
+      it "is false" do
+        target = SearchTarget.new(property: "1994")
+        subject = MatchAttribute.new(:bad_attr, "1994|1995")
+
+        expect(subject.match?(target)).to be_falsey
+      end
+    end
+  end
+
+  describe "build_me?" do
+    describe "given a search type and search param that contains a pipe" do
+      it "is true" do
+        expect(MatchMultipleAttributeValues.build_me?(rand, "x|y")).to be_truthy
+      end
+    end
+
+    describe "given a search type and search param that starts with a pipe" do
+      it "is false" do
+        expect(MatchMultipleAttributeValues.build_me?(rand, "|x|y")).to be_falsey
+      end
+    end
+
+    describe "given a search type without a pipe" do
+      it "is false" do
+        expect(MatchMultipleAttributeValues.build_me?(rand, "xy")).to be_falsey
+      end
+    end
+  end
+end

data/spec/lib/query_string_search/matchers/match_no_attribute_spec.rb

@@ -1,10 +1,11 @@
 require_relative "../../../../lib/query_string_search/abstract_matcher"
+require_relative "../../../doubles/search_target"
 
 RSpec.describe MatchNoAttribute do
   describe "match?" do
     describe "if the target's attribute is not nil" do
-      let(:target) { Target.new("search_value") }
-      let(:subject) { MatchNoAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: "search_value") }
+      let(:subject) { MatchNoAttribute.new(:property) }
 
       it "is false" do
         expect(subject.match?(target)).to be_falsey
@@ -12,8 +13,8 @@ RSpec.describe MatchNoAttribute do
     end
 
     describe "if the target's attribute is true" do
-      let(:target) { Target.new(true) }
-      let(:subject) { MatchNoAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: true) }
+      let(:subject) { MatchNoAttribute.new(:property) }
 
       it "is true" do
         expect(subject.match?(target)).to be_falsey
@@ -21,8 +22,8 @@ RSpec.describe MatchNoAttribute do
     end
 
     describe "if the target's attribute is false" do
-      let(:target) { Target.new(false) }
-      let(:subject) { MatchNoAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: false) }
+      let(:subject) { MatchNoAttribute.new(:property) }
 
       it "is true" do
         expect(subject.match?(target)).to be_truthy
@@ -30,8 +31,8 @@ RSpec.describe MatchNoAttribute do
     end
 
     describe "if the target's attribute is nil" do
-      let(:target) { Target.new(nil) }
-      let(:subject) { MatchNoAttribute.new(:search_attr) }
+      let(:target) { SearchTarget.new(property: nil) }
+      let(:subject) { MatchNoAttribute.new(:property) }
 
       it "is true" do
         expect(subject.match?(target)).to be_truthy
@@ -39,7 +40,7 @@ RSpec.describe MatchNoAttribute do
     end
 
     describe "if the target doesn't have the attribute" do
-      let(:target) { Target.new(rand) }
+      let(:target) { SearchTarget.new(property: rand) }
       let(:subject) { MatchNoAttribute.new(:bad_attr) }
 
       it "is false" do

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 # This file was generated by the `rails generate rspec:install` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this
@@ -81,5 +84,3 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 end
-
-Target = Struct.new(:search_attr)

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: query_string_search
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ian Whitney
+- Debbie Gillespie
+- Davin Lagerroos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +54,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -68,15 +98,17 @@ dependencies:
         version: '0'
 description: 
 email:
-- whit0694@umn.edu
+- asrwebteam@umn.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,13 +119,16 @@ files:
 - lib/query_string_search/matchers/match_all.rb
 - lib/query_string_search/matchers/match_attribute.rb
 - lib/query_string_search/matchers/match_attribute_value.rb
+- lib/query_string_search/matchers/match_multiple_attribute_values.rb
 - lib/query_string_search/matchers/match_no_attribute.rb
 - lib/query_string_search/search_options.rb
 - lib/query_string_search/search_parameters.rb
 - lib/query_string_search/version.rb
 - query_string_search.gemspec
+- spec/doubles/search_target.rb
 - spec/features/find_all_data_spec.rb
 - spec/features/find_records_that_match_multiple_parameters_spec.rb
+- spec/features/find_records_that_match_one_of_many_attributes_spec.rb
 - spec/features/find_records_with_matching_attribute_values_spec.rb
 - spec/features/find_records_with_nil_attributes_spec.rb
 - spec/features/find_records_with_nonnil_attributes_spec.rb
@@ -104,6 +139,7 @@ files:
 - spec/lib/query_string_search/matchers/match_all_spec.rb
 - spec/lib/query_string_search/matchers/match_attribute_spec.rb
 - spec/lib/query_string_search/matchers/match_attribute_value_spec.rb
+- spec/lib/query_string_search/matchers/match_multiple_attribute_values_spec.rb
 - spec/lib/query_string_search/matchers/match_no_attribute_spec.rb
 - spec/lib/query_string_search/search_options_spec.rb
 - spec/lib/query_string_search/search_parameters_spec.rb
@@ -133,8 +169,10 @@ signing_key:
 specification_version: 4
 summary: Provides a standard way to do searches using query strings in an API endpoint
 test_files:
+- spec/doubles/search_target.rb
 - spec/features/find_all_data_spec.rb
 - spec/features/find_records_that_match_multiple_parameters_spec.rb
+- spec/features/find_records_that_match_one_of_many_attributes_spec.rb
 - spec/features/find_records_with_matching_attribute_values_spec.rb
 - spec/features/find_records_with_nil_attributes_spec.rb
 - spec/features/find_records_with_nonnil_attributes_spec.rb
@@ -145,6 +183,7 @@ test_files:
 - spec/lib/query_string_search/matchers/match_all_spec.rb
 - spec/lib/query_string_search/matchers/match_attribute_spec.rb
 - spec/lib/query_string_search/matchers/match_attribute_value_spec.rb
+- spec/lib/query_string_search/matchers/match_multiple_attribute_values_spec.rb
 - spec/lib/query_string_search/matchers/match_no_attribute_spec.rb
 - spec/lib/query_string_search/search_options_spec.rb
 - spec/lib/query_string_search/search_parameters_spec.rb