magiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec60d6eebae1b801609b5f02fd507a010c4a40b4
+  data.tar.gz: 7b9662e27f4dde73ce0dac5e313e9dd5a8dd7913
+SHA512:
+  metadata.gz: 5c176e692ffa6d2ca00d1652c7861eedb86ab696d1cb5f6e439eb278e4fbc2a4fe980914d636e84332fafd53838cdf75733df16c5071bbb626f645112f7a0f16
+  data.tar.gz: 4053b9d9ed3b8f0a0ac099592859f3349c36235e949fe9daf27e7a475bd785bb766ef73541faef7d57f30971f5290ff179dd878b33962798c2b405a8ec1ea58d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at heycarsten@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carsten Nielsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Magiq
+
+### A library for building magical query interfaces for Arel scopes
+
+_Say it like: "Ma-Jee-Que"_
+
+This is a small ad-hoc utility library that I built in 2014 for use in
+[LCBO API](https://lcboapi.com). I wanted a clean, declarative way to specify
+query param interfaces to my API endpoints.
+
+Ultimately, it works! But life happened and I never really got the second
+version out the door. Since then JSON-API has really matured and a number of
+libraries have been released to solve this problem and much more.
+
+These days I'd like to just use `JSONAPI::Resources` for everything, but I still
+sort of find myself wanting for a better way to specifiy query interfaces.
+
+I'd like to morph `Magiq` into something that could enhance sorting and
+filtering in `JSONAPI::Resources`. It might remain a more generic library with
+an integration gem `jsonapi-resources-magiq` maybe?
+
+## Installation
+
+You'll probably be using this in a Rails application or something similar,
+simply add this line to your application's Gemfile:
+
+```ruby
+gem 'magiq'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+```
+app/queries/
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/heycarsten/magiq. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "magiq"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/magiq.rb

@@ -0,0 +1,31 @@
+require 'ostruct'
+require 'magiq/version'
+
+module Magiq
+  class Error < StandardError; end
+  class ParamsError < Error; end
+  class BadParamError < Error; end
+
+  DEFAULT_CONFIG = OpenStruct.new(
+    array_param_limit: 150,
+    default_page_size: 50,
+    max_page_size:     250,
+    min_page_size:     1
+  )
+
+  module_function
+
+  def [](key)
+    config[key]
+  end
+
+  def config
+    @config ||= DEFAULT_CONFIG.dup
+  end
+
+  def configure
+    yield(config)
+  end
+end
+
+require 'magiq/query'

data/lib/magiq/builder.rb

@@ -0,0 +1,60 @@
+require 'magiq/param'
+
+module Magiq
+  class Builder
+    END_RNG     = /\}([a-z0-9_]+)\Z/
+    START_RNG   = /\A([a-z0-9_]+)\{/
+    CONSTRAINTS = [:mutual, :exclusive]
+    LISTENERS   = [:check, :apply]
+
+    attr_reader :listeners, :constraints, :params
+
+    def initialize
+      @listeners   = Hash.new { |h, k| h[k] = [] }
+      @constraints = []
+      @params      = {}
+    end
+
+    def add_listener(type, params, opts = {}, &block)
+      listeners_for(type) << [type, params, opts, block]
+    end
+
+    def listeners_for(type)
+      if !LISTENERS.include?(type)
+        raise ArgumentError, "unknown listener type: #{type.inspect}"
+      end
+
+      listeners[type]
+    end
+
+    def add_param(key, opts = {})
+      param = Param.new(key, opts)
+
+      param.keys.each do |k|
+        if params.key?(k.to_sym)
+          raise ArgumentError, "already registered param under key/alias: " \
+          "#{k}"
+        end
+
+        params[k] = param
+      end
+    end
+
+    def add_constraint(op, params_arg, opts = {})
+      if !CONSTRAINTS.include?(op)
+        raise ArgumentError, "unknown constraint type: #{op.inspect}"
+      end
+
+      params = Array(params_arg)
+
+      if params.size == 1 && !opts[:exclusive]
+        raise ArgumentError, "a single parameter can't be mutual unless it " \
+          "has an exclusive counterpart"
+      end
+
+      params.each do |p|
+        constraints << [op, params, opts]
+      end
+    end
+  end
+end

data/lib/magiq/param.rb

@@ -0,0 +1,87 @@
+require 'magiq/types'
+
+module Magiq
+  class Param
+    attr_reader :key, :type, :keys, :aliases
+
+    OPTS = [
+      TYPE  = :type,
+      SOLO  = :solo,
+      LIMIT = :limit,
+      ALIAS = :alias,
+      ARRAY = :array
+    ]
+
+    def initialize(key, opts = {})
+      @key     = key.to_sym
+      @type    = Types.lookup(opts[TYPE] || :string)
+      @solo    = opts[SOLO]  ? true : false
+      @limit   = opts[LIMIT] || Magiq[:array_param_limit]
+      @aliases = opts[ALIAS] ? Array(opts[:alias]) : []
+      @keys    = [@key].concat(@aliases).map(&:to_sym)
+
+      @array = case opts[ARRAY]
+      when :always
+        :always
+      when :allow
+        :allow
+      when nil, false
+        false
+      else
+        raise ArgumentError, ":array option must be :always, :allow, or false, " \
+        "not: #{opts[ARRAY].inspect}"
+      end
+    end
+
+    def clean(raw_value)
+      v = raw_value.to_s.strip
+      v == '' ? nil : v
+    end
+
+    def accepts_array?
+      @array ? true : false
+    end
+
+    def solo?
+      @solo
+    end
+
+    def extract(raw_value)
+      return unless raw_value
+
+      if raw_value.is_a?(Array) && !accepts_array?
+        raise BadParamError, "An array of values was passed to the `#{key}` " \
+        "parameter but it is not permitted to accept more than one value."
+      end
+
+      value = case @array
+      when :always
+        raw_value.is_a?(Array) ? raw_value : raw_value.split(',')
+      when :allow
+        if raw_value.is_a?(Array)
+          raw_value
+        elsif raw_value.include?(',')
+          raw_value.split(',')
+        else
+          raw_value
+        end
+      else
+        raw_value
+      end
+
+      if value.is_a?(Array) && @limit && value.size > @limit
+        raise BadParamError, "The number of items passed to the `#{key}` " \
+        "parameter is #{value.size} which exceeds the permitted maxium of " \
+        "#{@limit} items."
+      end
+
+      if value.is_a?(Array)
+        return value.map { |v| @type.cast(clean(v)) }
+      end
+
+      return unless (v = clean(value))
+
+      @type.cast(v)
+    end
+  end
+end

data/lib/magiq/query.rb

@@ -0,0 +1,408 @@
+require 'magiq/builder'
+require 'magiq/utils'
+
+module Magiq
+  class Query
+    attr_reader :raw_params, :params, :scope, :model, :solo_param
+
+    def self.builder
+      @builder ||= Builder.new
+    end
+
+    def self.model(&block)
+      @model_proc = block
+    end
+
+    def self.model_proc
+      @model_proc
+    end
+
+    def self.scope(&block)
+      @scope_proc = block
+    end
+
+    def self.scope_proc
+      @scope_proc || -> { model.unscoped }
+    end
+
+    def self.unqualified_columns
+      @unqualified_columns ||= []
+    end
+
+    def self.unqualified(fields)
+      unqualified_columns.concat(fields)
+    end
+
+    def self.params(*keys, &block)
+      opts = keys.last.is_a?(Hash) ? keys.pop : {}
+
+      if block_given?
+        types = opts.delete(:type)
+
+        keys.each do |k|
+          type = types.is_a?(Hash) ? types[k] : types
+          def_param(k, opts.merge(type: type))
+        end
+
+        apply(*keys, &block)
+      else
+        def_param(keys[0], opts)
+      end
+    end
+
+    def self.param(*args, &block)
+      params(*args, &block)
+    end
+
+    def self.def_param(key, opts = {})
+      builder.add_param(key, opts)
+    end
+
+    def self.apply(*params, &block)
+      opts = params.last.is_a?(Hash) ? params.pop : {}
+      builder.add_listener(:apply, params, opts, &block)
+    end
+
+    def self.check(*params, &block)
+      opts = params.last.is_a?(Hash) ? params.pop : {}
+      builder.add_listener(:check, params, opts, &block)
+    end
+
+    def self.mutual(params, opts = {})
+      builder.add_constraint(:mutual, params, opts)
+    end
+
+    def self.exclusive(*params)
+      builder.add_constraint(:exclusive, params)
+    end
+
+    def self.has_pagination(opts = {})
+      max_page_size     = opts[:max_page_size] || Magiq[:max_page_size]
+      min_page_size     = opts[:min_page_size] || Magiq[:min_page_size]
+      default_page_size = opts[:default_page_size] || Magiq[:default_page_size]
+
+      param :page,      type: :whole
+      param :page_size, type: :whole
+
+      check :page, :page_size, any: true do |page, page_size|
+        if page && page < 1
+          bad! "The value provided for `page` must be 1 or greater, but " \
+          "#{page.inspect} was provided."
+        end
+
+        if page_size && page_size > max_page_size
+          bad! "The maximum permitted value for `page_size` is " \
+          "#{max_page_size}, but #{page_size.inspect} was provided."
+        elsif page_size && page_size < min_page_size
+          bad! "The minimum permitted value for `page_size` is " \
+          "#{min_page_size}, but #{page_size.inspect} was provided."
+        end
+      end
+
+      apply do
+        next if solo?
+
+        page      = params[:page]
+        page_size = params[:page_size] || default_page_size
+        new_scope = scope.page(page)
+
+        page_size ? new_scope.per(page_size) : new_scope
+      end
+    end
+
+    def self.toggle(*fields)
+      fields.each do |field|
+        param(field, type: :bool)
+        apply(field) do |val|
+          scope.where(field => val)
+        end
+      end
+    end
+
+    def self.sort(fields)
+      param :sort, type: :string, array: :always, limit: fields.size
+      apply :sort do |raw_vals|
+        vals = raw_vals.is_a?(Array) ? raw_vals : raw_vals.split(',')
+
+        vals.reduce(scope) do |scope, val|
+          col = if val.start_with?('-')
+            direction = :desc
+            val.sub('-', '').to_sym
+          elsif val.start_with?('+')
+            direction = :asc
+            val.sub('+', '').to_sym
+          else
+            bad! "A sort order was not specified for the sort field value " \
+            "'#{val}', it must be prefixed with either a plus (+#{val}) for " \
+            "ascending order, or a minus (-#{val}) for decending order"
+          end
+
+          unless fields.include?(col)
+            bad! "A provided sorting field: #{col}, is unknown or unsortable. The " \
+            "permitted values are: #{fields.join(', ')}"
+          end
+
+          if is_unqualified?(col)
+            scope.order("\"#{col}\" #{direction}")
+          else
+            scope.order(col => direction)
+          end
+        end
+      end
+    end
+
+    def self.by(column, opts = {}, &block)
+      param(column, {
+        solo:  true,
+        type:  :id,
+        alias: Magiq::Utils.pluralize(column.to_s).to_sym,
+        array: :always
+      }.merge(opts))
+
+      if block_given?
+        apply(column, &block)
+      else
+        apply(column) do |ids|
+          if ids.empty?
+            nil
+          else
+            tbl = model.table_name
+
+            sql = ids.each_with_index.map { |raw_id, i|
+              id = raw_id.is_a?(Numeric) ? raw_id : "'#{raw_id}'"
+              "WHEN #{id} THEN #{i}"
+            }.join(' ')
+
+            scope.where(column => ids).order("CASE #{tbl}.#{column} #{sql} END")
+          end
+        end
+      end
+    end
+
+    def self.range(field, opts = {})
+      lt_param  = :"#{field}_lt"
+      lte_param = :"#{field}_lte"
+      gt_param  = :"#{field}_gt"
+      gte_param = :"#{field}_gte"
+      eq_param  = field.to_sym
+
+      param(lt_param,  type: opts[:type] || :whole)
+      param(lte_param, type: opts[:type] || :whole)
+      param(gt_param,  type: opts[:type] || :whole)
+      param(gte_param, type: opts[:type] || :whole)
+      param(eq_param,  type: opts[:type] || :whole)
+
+      exclusive(gt_param, gte_param)
+      exclusive(lt_param, lte_param)
+      mutual(eq_param, exclusive: [lt_param, lte_param, gt_param, gte_param])
+
+      check do
+        next if Magiq::Utils.present?(params[eq_param])
+
+        lt_par = if (lt_val = params[lte_param])
+          lte_param
+        elsif (lt_val = params[lt_param])
+          lt_param
+        end
+
+        gt_par = if (gt_val = params[gte_param])
+          gte_param
+        elsif (gt_val = params[gt_param])
+          gt_param
+        end
+
+        next unless lt_par && gt_par
+
+        if lt_val > gt_val
+          bad! "A value of #{lt_val} was provided for `#{lt_par}` but a value " \
+          "of #{gt_val} was provided for `#{gt_par}`. The permitted value of  " \
+          "`#{lt_par}` must be less than the permitted value provided for " \
+          "`#{gt_par}`."
+        end
+
+        if lt_val == gt_val
+          bad! "The same value of #{gt_val} was provided for both `#{lt_par}` " \
+          "and #{gt_par}. The permitted value of `#{lt_par}` must be " \
+          "less than the permitted value provided for `#{gt_par}`."
+        end
+      end
+
+      apply(eq_param) do |val|
+        if is_unqualified?(field)
+          scope.where("#{field} = ?", val)
+        else
+          scope.where(model.arel_table[field].eq(val))
+        end
+      end
+
+      apply(gt_param) do |val|
+        if is_unqualified?(field)
+          scope.where("#{field} > ?", val)
+        else
+          scope.where(model.arel_table[field].gt(val))
+        end
+      end
+
+      apply(lt_param) do |val|
+        if is_unqualified?(field)
+          scope.where("#{field} < ?", val)
+        else
+          scope.where(model.arel_table[field].lt(val))
+        end
+      end
+
+      apply(gte_param) do |val|
+        if is_unqualified?(field)
+          scope.where("#{field} >= ?", val)
+        else
+          scope.where(model.arel_table[field].gte(val))
+        end
+      end
+
+      apply(lte_param) do |val|
+        if is_unqualified?
+          scope.where("#{field} <= ?", val)
+        else
+          scope.where(model.arel_table[field].lte(val))
+        end
+      end
+    end
+
+    def initialize(params)
+      @raw_params = params
+      @listeners  = {}
+    end
+
+    def builder
+      self.class.builder
+    end
+
+    def update_scope!(new_scope)
+      return unless new_scope
+      @scope = new_scope
+    end
+
+    def is_unqualified?(column)
+      self.class.unqualified_columns.include?(column)
+    end
+
+    def extract!
+      @params = {}
+
+      raw_params.each_pair do |raw_key, raw_value|
+        key = raw_key.to_sym
+
+        next unless (param = builder.params[key])
+
+        begin
+          next unless (value = param.extract(raw_value))
+          @params[param.key] = value
+        rescue BadParamError => e
+          raise BadParamError, "The `#{param.key}` parameter is invalid: " \
+          "#{e.message}"
+        end
+      end
+
+      @params.keys.each do |p|
+        next unless (found = builder.params[p])
+        next unless found.solo?
+
+        if @params.size > 1
+          raise BadParamError, "The `#{found.key}` parameter can only be used " \
+          "by itself in a query."
+        else
+          @has_solo_param = true
+          @solo_param = found
+        end
+      end
+    end
+
+    def verify!
+      if !@params
+        raise RuntimeError, "verify! was called before extract!"
+      end
+
+      builder.constraints.each do |(op, keys, opts)|
+        case op
+        when :exclusive
+          found_keys = keys.select { |k| params.key?(k) }
+
+          next if found_keys.empty? || found_keys.one?
+
+          raise ParamsError, "The following parameters are not permitted " \
+          "to be provided together: #{found_keys.join(', ')}"
+        when :mutual
+          exclusives = opts[:exclusive] && Array(opts[:exclusive]) || []
+          found_keys = keys.select { |k| params.key?(k) }
+          found_excl = exclusives.select { |k| params.key?(k) }
+
+          next if found_keys.empty?
+          next if found_keys.empty? && found_excl.empty?
+          next if found_keys == keys && found_excl.empty?
+
+          if found_excl.any?
+            raise ParamsError, "The provided " \
+            "parameter#{found_keys.one? ? '' : 's'}: " \
+            "#{found_keys.map { |k| "`#{k}`" }.join(', ')} " \
+            "#{found_keys.one? ? 'is' : 'are'} mutually exclusive to: " \
+            "#{found_excl.map { |k| "`#{k}`" }.join ', '}."
+          end
+
+          raise ParamsError, "The provided " \
+          "parameter#{found_keys.one? ? '' : 's'}: " \
+          "#{found_keys.map { |k| "`#{k}`" }.join(', ')} requires: " \
+          "#{(keys - found_keys).map { |k| "`#{k}`" }.join(', ')}."
+        end
+      end
+    end
+
+    def check!
+      @model = instance_exec(&self.class.model_proc)
+      @scope = instance_exec(&self.class.scope_proc)
+
+      each_listener_for :check do |seek_params, opts, op|
+        next instance_exec(&op) if seek_params.empty?
+        next if !opts[:any] && !seek_params.all? { |p| params.key?(p) }
+
+        vals = seek_params.map { |p| params[p] }
+        instance_exec(*vals, &op)
+      end
+    end
+
+    def apply!
+      each_listener_for :apply do |seek_params, opts, op|
+        next update_scope! instance_exec(&op) if seek_params.empty?
+        next if !opts[:any] && !seek_params.all? { |p| params.key?(p) }
+
+        vals = seek_params.map { |p| params[p] }
+        update_scope! instance_exec(*vals, &op)
+      end
+    end
+
+    def solo?
+      @has_solo_param ? true : false
+    end
+
+    def bad!(message)
+      raise BadParamError, message
+    end
+
+    def listeners_for(type)
+      builder.listeners_for(type)
+    end
+
+    def each_listener_for(type, &block)
+      listeners_for(type).each do |t, params, opts, op|
+        block.(params, opts, op)
+      end
+    end
+
+    def to_scope
+      extract!
+      verify!
+      check!
+      apply!
+      @scope
+    end
+  end
+end

data/lib/magiq/types.rb

@@ -0,0 +1,216 @@
+require 'date'
+
+module Magiq
+  module Types
+    module_function
+
+    def registry
+      @registry ||= {}
+    end
+
+    def register(id, adapter)
+      registry[id.to_sym] = adapter
+    end
+
+    def lookup(id)
+      if (found = registry[id.to_sym])
+        found
+      else
+        raise ArgumentError, "no type is registered under: #{id.inspect}"
+      end
+    end
+
+    class Type
+      attr_reader :raw
+
+      def self.cast(raw)
+        new(raw).cast!
+      end
+
+      def initialize(raw)
+        @raw = raw.to_s.strip
+      end
+
+      def cast!
+        raw
+      end
+
+      protected
+
+      def bad!(message)
+        raise BadParamError, message
+      end
+    end
+
+    class String < Type
+      def cast!
+        raw == nil ? nil : raw.to_s
+      end
+    end
+    register :string, String
+
+    class Bool < Type
+      def cast!
+        case v = raw.downcase
+        when 't', 'true', '1', 'yes', 'y'
+          true
+        when 'f', 'false', '0', 'no', 'n'
+          false
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, the " \
+          "permitted values are: \"true\", or \"false\""
+        end
+      end
+    end
+    register :bool, Bool
+
+    class Float < Type
+      def cast!
+        raw.to_f
+      end
+    end
+    register :float, Float
+
+    class Int < Type
+      def cast!
+        raw.to_i
+      end
+    end
+    register :int, Int
+
+    class ID < Type
+      def cast!
+        v = raw.to_i
+
+        if v > 0
+          v
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a numerical ID greater than zero."
+        end
+      end
+    end
+    register :id, ID
+
+    class UPC < Type
+      UPC_RNG = /[^0-9]/
+      UPC_MAX = 9999999999999
+
+      def cast!
+        v = raw.to_s.gsub(UPC_RNG, '').to_i
+
+        if v > 0 && v <= UPC_MAX
+          v
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a valid UPC with a numerical value between zero and #{UPC_MAX}."
+        end
+      end
+    end
+    register :upc, UPC
+
+    class InventoryID < Type
+      INVENTORY_ID_RNG = /\A([0-9]{1,12})\-([0-9]{1,3})\Z/
+
+      def cast!
+        v = raw.to_s.strip
+
+        if v =~ INVENTORY_ID_RNG
+          [$1.to_i, $2.to_i]
+        else
+          bad! "provided value of #{raw.inspect} is not a permitted " \
+          "inventory ID, it must be a product ID and store ID separated by a " \
+          "dash, eg: 232744-94"
+        end
+      end
+    end
+    register :inventory_id, InventoryID
+
+    class CategoryDepth < Type
+      def cast!
+        v = raw.to_s.to_i
+
+        if v >= 0 && v <= 2
+          v
+        else
+          bad! "provided value of #{raw.inspect} is not a permitted category " \
+          "depth, it must be an integer value of 0, 1, or 2."
+        end
+      end
+    end
+    register :category_depth, CategoryDepth
+
+    class Latitude < Type
+      def cast!
+        case v = raw.to_f
+        when 0.0
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a valid latitude in the range of -90.0 to 90.0"
+        when -90..90
+          v
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a valid latitude in the range of -90.0 to 90.0"
+        end
+      end
+    end
+    register :latitude, Latitude
+
+    class Longitude < Type
+      def cast!
+        case v = raw.to_f
+        when 0.0
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a valid longitude within -180.0 to 180.0"
+        when -180..180
+          v
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a valid longitude within -180.0 to 180.0"
+        end
+      end
+    end
+    register :longitude, Longitude
+
+    class Whole < Type
+      def cast!
+        if (v = raw.to_i) >= 0
+          v
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be a non-negative number"
+        end
+      end
+    end
+    register :whole, Whole
+
+    class EnumSort < Type
+      def cast!
+        case raw.downcase
+        when 'asc'
+          :asc
+        when 'desc'
+          :desc
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, permitted " \
+          "values are: \"asc\", or \"desc\""
+        end
+      end
+    end
+    register :enum_sort, EnumSort
+
+    class Date < Type
+      DATE_RNG = /[12]{1}[0-9]{3}\-[10]{1}[0-9]{1}\-[0123]{1}[0-9]{1}/
+
+      def cast!
+        if raw =~ DATE_RNG
+          Date.parse($1)
+        else
+          bad! "provided value of #{raw.inspect} is not permitted, it must " \
+          "be an ISO 8601 formatted date: YYYY-MM-DD"
+        end
+      end
+    end
+    register :date, Date
+  end
+end

data/lib/magiq/utils.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+
+module Magiq
+  module Utils
+    module_function
+
+    def pluralize(string)
+      ActiveSupport::Inflector.pluralize(string)
+    end
+
+    def blank?(val)
+      val.respond_to?(:empty?) ? !!val.empty? : !val
+    end
+
+    def present?(val)
+      !blank?(val)
+    end
+  end
+end

data/lib/magiq/version.rb

@@ -0,0 +1,3 @@
+module Magiq
+  VERSION = '0.1.0'
+end

data/magiq.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'magiq'
+  spec.version       = Magiq::VERSION
+  spec.authors       = ['Carsten Nielsen']
+  spec.email         = ['heycarsten@gmail.com']
+
+  spec.summary       = %q{Magically turn query parameters into ActiveRecord scopes}
+  spec.description   = %q{Magiq enables you to declaratively specifiy queries that translate into ActiveRecord Arel scopes}
+  spec.homepage      = 'https://github.com/heycarsten/magiq'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: magiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carsten Nielsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Magiq enables you to declaratively specifiy queries that translate into
+  ActiveRecord Arel scopes
+email:
+- heycarsten@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/magiq.rb
+- lib/magiq/builder.rb
+- lib/magiq/param.rb
+- lib/magiq/query.rb
+- lib/magiq/types.rb
+- lib/magiq/utils.rb
+- lib/magiq/version.rb
+- magiq.gemspec
+homepage: https://github.com/heycarsten/magiq
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Magically turn query parameters into ActiveRecord scopes
+test_files: []