clean_query_params 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--profile

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stuart Liston
+
+MIT License
+
+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,77 @@
+# CleanQueryParams
+
+A small, concise DSL for describing query parameters, specifically for sorting, paging and querying on index actions.
+I aim to make [the specs](https://github.com/stuliston/clean_query_params/blob/master/spec/clean_query_params_spec.rb) as clear a demonstration as possible,
+but here's a quick test case as an example:
+
+Given a */users* endpoint, you can create a params object like this:
+
+```ruby
+class UserParameters
+  include CleanQueryParams
+
+  defaults sort_by:     'last_name',
+           sort_dir:    'ASC',
+           page_number: 1,
+           page_size:   20
+
+  queryable_by :first_name, :last_name, :age
+end
+
+it "gives you a query params object with pagination, sorting and an extracted query hash" do
+
+  raw_params = {
+    page_number: 2,
+    page_size: 15,
+    first_name: 'Stu',
+    role: 'admin'
+  }
+
+  user_params = UserParameters.new(raw_params)
+
+  # specified above as UserParameters default
+  expect(user_params.sort_by).to eq 'last_name'
+
+  # sensible global default
+  expect(user_params.sort_dir).to eq 'ASC'
+
+  # defined in raw params
+  expect(user_params.page_number).to eq 2
+
+  # defined in raw params
+  expect(user_params.page_size).to eq 15
+
+  # only key/values specified above in queryable_by
+  expect(user_params.query).to eq({ first_name: 'Stu' })
+end
+```
+
+I'm planning to write a railtie to make integration with rails controllers seamless.
+
+More examples to follow...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clean_query_params'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clean_query_params
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/clean_query_params.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clean_query_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clean_query_params"
+  spec.version       = CleanQueryParams::VERSION
+  spec.authors       = ["Stuart Liston"]
+  spec.email         = ["stuart.liston@gmail.com"]
+  spec.description   = %q{Gives you a concise DSL for describing query parameters}
+  spec.summary       = %q{Aims to validate and default a raw params hash (e.g. in a Rails controller) into something you can confidently query your datasource against.}
+  spec.homepage      = "http://github.com/stuliston/clean_query_params"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "i18n"
+  spec.add_runtime_dependency "active_support"
+end

data/lib/clean_query_params/version.rb

@@ -0,0 +1,3 @@
+module CleanQueryParams
+  VERSION = "0.0.1"
+end

data/lib/clean_query_params.rb

@@ -0,0 +1,80 @@
+require "clean_query_params/version"
+require 'active_support/core_ext'
+
+module CleanQueryParams
+
+  # Hmmmm - probably too presumptuous.
+  # Make this confugurable at the app-level?
+  GLOBAL_DEFAULTS = {
+    page_number:  1,
+    page_size:    20,
+    sort_by:      'id',
+    sort_dir:     'ASC'
+  }
+
+  def initialize(params = {})
+    params.keep_if { |k,v| v.present? }
+    @params = defaults.merge(params)
+  end
+
+  def query
+    params.slice(*valid_query_keys)
+  end
+
+  def sort_by
+    params[:sort_by]
+  end
+
+  def sort_dir
+    params[:sort_dir].upcase
+  end
+
+  def page_number
+    params[:page_number]
+  end
+
+  def page_size
+    params[:page_size]
+  end
+
+  # Define and initialise the class-level _defaults Hash
+  # and _valid_query_keys Set.
+  #
+  # Extend host class with macros when we're included.
+  #
+  def self.included(host_class)
+    host_class.class_attribute :_defaults
+    host_class._defaults = Hash.new
+
+    host_class.class_attribute :_valid_query_keys
+    host_class._valid_query_keys = Set.new
+
+    host_class.extend(Dsl)
+  end
+
+  # Module containing macros (class methods).
+  #
+  module Dsl
+
+    def defaults(options = {})
+      self._defaults = options
+    end
+
+    def queryable_by(*keys)
+      self._valid_query_keys = Set.new(keys)
+    end
+  end
+
+  private
+
+  attr_reader :params
+
+  def defaults
+    GLOBAL_DEFAULTS.merge(self.class._defaults)
+  end
+
+  def valid_query_keys
+    self.class._valid_query_keys
+  end
+
+end

data/spec/clean_query_params_spec.rb

@@ -0,0 +1,139 @@
+require 'clean_query_params'
+require 'pry'
+
+describe CleanQueryParams do
+
+  describe "full example for documentation" do
+
+    class UserParameters
+      include CleanQueryParams
+
+      defaults sort_by:     'last_name',
+               sort_dir:    'ASC',
+               page_number: 1,
+               page_size:   20
+
+      queryable_by :first_name, :last_name, :age
+    end
+
+    it "gives you a query params object with pagination, sorting and an extracted query hash" do
+
+      raw_params = {
+        page_number: 2,
+        page_size: 15,
+        first_name: 'Stu',
+        role: 'admin'
+      }
+
+      user_params = UserParameters.new(raw_params)
+
+      # specified above as UserParameters default
+      expect(user_params.sort_by).to eq 'last_name'
+
+      # sensible global default
+      expect(user_params.sort_dir).to eq 'ASC'
+
+      # defined in raw params
+      expect(user_params.page_number).to eq 2
+
+      # defined in raw params
+      expect(user_params.page_size).to eq 15
+
+      # only key/values specified above in queryable_by
+      expect(user_params.query).to eq({ first_name: 'Stu' })
+    end
+
+  end
+
+  describe "public API" do
+
+    context "when a class mixes us in" do
+
+      class ImageParameters
+        include CleanQueryParams
+      end
+
+      let(:image_params) { ImageParameters.new }
+
+      it "responds to #sort_by" do
+        expect(image_params).to respond_to :sort_by
+      end
+
+      it "responds to #sort_dir" do
+        expect(image_params).to respond_to :sort_dir
+      end
+
+      it "responds to #page_number" do
+        expect(image_params).to respond_to :page_number
+      end
+
+      it "responds to #page_size" do
+        expect(image_params).to respond_to :page_size
+      end
+
+      it "responds to #query" do
+        expect(image_params).to respond_to :query
+      end
+
+    end
+
+  end
+
+  describe ".defaults" do
+
+    class PostParameters
+      include CleanQueryParams
+      defaults page_size: 10, sort_by: 'created_at'
+    end
+
+    let(:post_params) { PostParameters.new(params) }
+
+    context "when the params don't specify a value" do
+      let(:params) { {} }
+
+      it "exposes the default" do
+        expect(post_params.page_size).to eq 10
+        expect(post_params.sort_by).to   eq 'created_at'
+      end
+    end
+
+    context "when the params specify a value" do
+      let(:params) { {page_size: 50} }
+
+      it "exposes the specified value" do
+        expect(post_params.page_size).to eq 50
+      end
+    end
+
+    context "when nobody specifies a value" do
+
+      class CarParameters
+        include CleanQueryParams
+      end
+
+      let(:params) { {} }
+
+      it "exposes a global default" do
+        car_params = CarParameters.new(params)
+        expect(car_params.page_size).to eq CleanQueryParams::GLOBAL_DEFAULTS[:page_size]
+      end
+    end
+
+  end
+
+  describe ".queryable_by" do
+
+    class PlaceParameters
+      include CleanQueryParams
+      queryable_by :name, :address
+    end
+
+    it "specifies what keys can exist in #query" do
+      params = { name: 'Mamasita', admin: 'DANGER', address: 'Melbourne' }
+      place_params = PlaceParameters.new(params)
+      expect(place_params.query).to eq({ name: 'Mamasita', address: 'Melbourne' })
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: clean_query_params
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Stuart Liston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gives you a concise DSL for describing query parameters
+email:
+- stuart.liston@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clean_query_params.gemspec
+- lib/clean_query_params.rb
+- lib/clean_query_params/version.rb
+- spec/clean_query_params_spec.rb
+homepage: http://github.com/stuliston/clean_query_params
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Aims to validate and default a raw params hash (e.g. in a Rails controller)
+  into something you can confidently query your datasource against.
+test_files:
+- spec/clean_query_params_spec.rb