status_querier 1.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e839e5841ee6b1ad164168dfc877beda8246b0be
+  data.tar.gz: cc0bb0ad5fd9b39dea31d81da3fcbeb10f5f6815
+SHA512:
+  metadata.gz: 58d2336e91a81750e0cee9d7881ecbf90ff48372fac52c0dab65d71ab8033de6b2a2f8c3d78e94674b56b346bd49a96f4ad5792f9dc25ece611f59a7d89e9059
+  data.tar.gz: 90f504fef06fcb2c52468c4d4847ca2d23bc708804dd4e68d7f38159c717631d8b00457fcf8d7018f051fdec698f5c016615a5f694e5546a11958fe72f9aa886

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,16 @@
+### Expected/Desired Behavior:
+< Description of the expected or desired behavior including an example >
+
+### Current Behavior:
+< Description of the current behavior being encountered including an example >
+
+### Impact:
+- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
+- Was a regression introduced(if bug)?
+- Urgency(low, medium, high)?
+- Teams impacted?(web, ios, android, maps, etc)
+
+### Requirements:
+- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
+
+cc: @two_ @team_members

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,19 @@
+### Issue:
+[JIRA-0000](http://link_to_ticket.com)
+
+### Proposed Changes:
+< Description of the proposed change and its value. If possible also include a usage example and relative links to provide additional context for the reviewer>
+
+### Impact:
+- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
+- Any special deployment coordination needed(env changes, data/db migrations, etc.)?
+- Urgency(low, medium, high)?
+- Teams impacted(web, ios, android, maps, etc)?
+
+### Requirements:
+- Add Tests to cover changes
+- Update Swagger documentation if applicable
+- Update repo documentation if applicable(readme, wiki)
+- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
+
+cc: @two_ @team_members

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'bin/console'
+    - 'Rakefile'
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 80

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+deploy:
+  provider: rubygems
+  api_key: $RUBYGEMS_API_KEY
+  gem: status_querier
+  on:
+    tags: true
+    repo: westfieldlabs/status_querier

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in status_querier.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+[![Build Status](https://travis-ci.org/westfieldlabs/status_querier.svg?branch=master)](https://travis-ci.org/westfieldlabs/status_querier)
+# StatusQuerier
+
+`StatusQuerier` gives the ability to safely combine scopes with `or` method given by the `where-or` gem. It restricts the scopes to the allowable 6 types. `pending`, `preview`, `live`, `expired`, `invalid`, and `disabled`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'status_querier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install status_querier
+
+## Usage
+
+To use, copy the following into your model.
+
+```ruby
+include StatusQuerier::Querier
+```
+
+And now you can call `Model.with_any_statuses(['preview', 'live'])`
+
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/westfield/status_querier.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record"
+require "status_querier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+#require "irb"
+#IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contributing.md

@@ -0,0 +1,13 @@
+## Contributing
+
+0. Raise an issue in this project outlining the change you'd like to make. You'll need the `issue_number`
+1. Fork this project into your own Github account
+2. Create your feature branch (`git checkout -b {issue_number}_my-new-feature`)
+4. Push to the branch (`git push -u origin {issue_number}_my-new-feature`)
+5. Write RSpec tests to formalise the outcomes of your change
+6. Write the code to implement the changes, ensuring that the tests eventually pass
+7. Commit your changes (`git commit -am '{issue_number} Added some feature'`)
+8. Push to the branch (`git push -u origin my-new-feature`)
+9. Create a new Pull Request using Github's built-in mechanisms.
+10. Wait for a code review to come back, or an approval.
+11. Either go back and fix whatever the reviewers recommend, or watch and smile as your PR gets merged in and you become part of software development history.

data/lib/status_querier.rb

@@ -0,0 +1,18 @@
+require 'status_querier/version'
+require 'status_querier/querier'
+
+module StatusQuerier
+  SUPPORTED_STATUSES = %i(pending preview live expired invalid disabled).freeze
+  ALL = :all
+  WHITELIST = (SUPPORTED_STATUSES + [ALL]).freeze
+  DEFAULT_LISTING = :default_listing
+
+  module Error
+    class InvalidStatus < ArgumentError; end
+  end
+
+  def self.allow?(status)
+    WHITELIST.include?(status)
+  end
+end
+

data/lib/status_querier/querier.rb

@@ -0,0 +1,55 @@
+require 'active_support/concern'
+require 'where-or'
+
+# HACK: Override 'structurally_compatible_for_or?' from the 'where-or' gem
+# to permit potentially invalid combinations.
+ActiveSupport.on_load(:active_record) do
+  module ActiveRecord
+    module QueryMethods
+
+      def structurally_compatible_for_or_with_suppressed?(other)
+        return true if structurally_compatible_for_or_without_suppressed?(other)
+        Rails.logger.warn "Combining potentially ambiguous conditions. Consider reviewing the scopes and SQL statements involved." if Rails.env.development? || Rails.env.test?
+        true
+      end
+
+      alias_method_chain :structurally_compatible_for_or?, :suppressed
+
+    end
+  end
+end
+
+
+module StatusQuerier
+  module Querier
+    extend ActiveSupport::Concern
+
+    included do
+      def self.with_any_statuses(statuses)
+        statuses = statuses.map(&:to_sym)
+        return all if statuses.include?(StatusQuerier::ALL)
+        (statuses.size > 0) ? Query.new.combine_scopes(self, statuses) : default_listing
+      end
+    end
+
+    private
+
+    class Query
+      def combine_scopes(model_class, statuses, with = :or)
+        statuses.map { |status| with_resource_status(model_class, status) }.reduce(with)
+      end
+
+      def with_resource_status(model_class, status)
+        unless StatusQuerier::SUPPORTED_STATUSES.include?(status)
+          raise Error::InvalidStatus, "Status needs to be #{StatusQuerier::SUPPORTED_STATUSES.join(', ')}"
+        end
+
+        unless model_class.respond_to?(status)
+          raise ::NotImplementedError
+        end
+
+        model_class.send(status)
+      end
+    end
+  end
+end

data/lib/status_querier/version.rb

@@ -0,0 +1,3 @@
+module StatusQuerier
+  VERSION = '1.2.3'
+end

data/status_querier.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+require_relative 'lib/status_querier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'status_querier'
+  spec.version       = StatusQuerier::VERSION
+  spec.authors       = ['Louis Tran']
+  spec.email         = ['tran.louis@gmail.com']
+
+  spec.summary       = 'Wrap the status request parameters.'
+  spec.description   = 'Add `or` functionality to models that support AREL to query statuses.'
+  spec.homepage      = 'https://github.com/westfieldlabs/status_querier'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.2.3'
+
+  spec.add_dependency 'where-or', '~> 0.1'
+  spec.add_dependency 'rails', '~> 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.2'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'benchmark-ips'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: status_querier
+version: !ruby/object:Gem::Version
+  version: 1.2.3
+platform: ruby
+authors:
+- Louis Tran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: where-or
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add `or` functionality to models that support AREL to query statuses.
+email:
+- tran.louis@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE"
+- ".github/PULL_REQUEST_TEMPLATE"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contributing.md
+- lib/status_querier.rb
+- lib/status_querier/querier.rb
+- lib/status_querier/version.rb
+- status_querier.gemspec
+homepage: https://github.com/westfieldlabs/status_querier
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Wrap the status request parameters.
+test_files: []