parelation 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 037f22447840bf0175afad3ffc9877399f52e45a
-  data.tar.gz: 245f4049e008a44245cc335f66efe0229e0702b3
+  metadata.gz: 909bd90faf2386e45af33c7f28586f14a5ae442c
+  data.tar.gz: d8792b67b2a9d034dbdfb17dadae325513de1c92
 SHA512:
-  metadata.gz: 4974134e76747012c27f44408d9804040d15c183a03bc3258000e8e04734d46288ba5f1e2e1213cd906678830042e9913ffd6c7b65f196b68f73954e58f82180
-  data.tar.gz: af3bcdb37c9ba6f84e27855816c6317ab809b800a5fe6519a5e9f76555da0169f9ebdd26cc1d2f318c54908ce4b3d87534fc55e341485c48950761e0395f2403
+  metadata.gz: ad4fd5fd7970aa0f453af670ed7875acaf0add58d8105b512d3da7d93d836a21316507d8e5c48f4aeeb6199a869d14b5cae5eef33b8f8ae97c7bcde0dca0e1d4
+  data.tar.gz: 5d8dc24b0bd2bb21b2a8b6cab208aec76523d7378bbdef3f465954eac496c8f2b09ed0a358a7c3ba88028ef06aa9a3ab63b276e88d64aa015f4c474e71019764

data/.gemfiles/4.2.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "activerecord", "~> 4.2.0"
+gemspec path: "../"

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.0
-  - rbx-2.2
+  - 2.2.0
 gemfile:
   - .gemfiles/4.1.gemfile
+  - .gemfiles/4.2.gemfile

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Michael van Rooijen
+Copyright (c) 2015 Michael van Rooijen
 
 MIT License
 

data/README.md

@@ -1,5 +1,6 @@
 # Parelation
 
+[![Gem Version](https://badge.fury.io/rb/parelation.svg)](http://badge.fury.io/rb/parelation)
 [![Code Climate](https://codeclimate.com/github/meskyanichi/parelation.png)](https://codeclimate.com/github/meskyanichi/parelation)
 [![Build Status](https://travis-ci.org/meskyanichi/parelation.svg)](https://travis-ci.org/meskyanichi/parelation)
 
@@ -7,21 +8,21 @@ Parelation, for Rails/ActiveRecord 4.1.0+, allows you to query your ActiveRecord
 
 This library was developed for- and extracted from [HireFire].
 
+The documentation can be found on [RubyDoc].
+
 ### Compatibility
 
 - Rails/ActiveRecord 4.1.0+
 - Ruby (MRI) 2.0+
-- Ruby (RBX) 2.2+
 
 ### Installation
 
-Compile and install the gem from source.
+Add the gem to your Gemfile and run `bundle`.
 
 ```rb
-gem "parelation", github: "meskyanichi/parelation"
+gem "parelation"
 ```
 
-*This library won't be hosted on RubyGems.org until it's been tested more in development.*
 
 ### Example
 
@@ -241,7 +242,6 @@ This will tell client developers what parameter failed in the HTTP response. Thi
 Contributions are welcome, but please conform to these requirements:
 
 - Ruby (MRI) 2.0+
-- Ruby (RBX) 2.2+
 - ActiveRecord 4.1.0+
 - 100% Spec Coverage
   - Generated by when running the test suite
@@ -267,6 +267,12 @@ rspec spec
 rubycritic lib
 ```
 
+To run the local documentation server:
+
+```
+yard server --reload
+```
+
 Create a new branch and start hacking:
 
 ```
@@ -278,11 +284,11 @@ Submit a pull request.
 
 ### Author / License
 
-Copyright (c) 2014 Michael van Rooijen ( [@meskyanichi] )<br />
-Released under the MIT [License].
+Released under the [MIT License] by [Michael van Rooijen].
 
-[@meskyanichi]: https://twitter.com/meskyanichi
+[Michael van Rooijen]: https://twitter.com/meskyanichi
 [HireFire]: http://hirefire.io
 [Passing Specs]: https://travis-ci.org/meskyanichi/parelation
 [Code Climate Score]: https://codeclimate.com/github/meskyanichi/parelation
-[License]: https://github.com/meskyanichi/parelation/blob/master/LICENSE
+[RubyDoc]: http://rubydoc.info/github/meskyanichi/parelation/master/frames
+[MIT License]: https://github.com/meskyanichi/parelation/blob/master/LICENSE

data/lib/parelation.rb

@@ -3,7 +3,7 @@ module Parelation
     require "parelation/errors/parameter"
   end
 
-  module Criteria
+  class Criteria
     require "parelation/criteria/select"
     require "parelation/criteria/limit"
     require "parelation/criteria/offset"

data/lib/parelation/criteria.rb

@@ -1,4 +1,4 @@
-module Parelation::Criteria
+class Parelation::Criteria
 
   # @return [ActiveRecord::Relation] the current criteria chain
   #
@@ -14,7 +14,7 @@ module Parelation::Criteria
 
   # @param chain [ActiveRecord::Relation]
   # @param param [String]
-  # @param value [String, Symbol, Array, Hash]
+  # @param value [String, Array, Hash]
   #
   def initialize(chain, param, value)
     @chain = chain

data/lib/parelation/criteria/limit.rb

@@ -1,5 +1,4 @@
-class Parelation::Criteria::Limit
-  include Parelation::Criteria
+class Parelation::Criteria::Limit < Parelation::Criteria
 
   # @param param [String]
   # @return [TrueClass, FalseClass]

data/lib/parelation/criteria/offset.rb

@@ -1,5 +1,4 @@
-class Parelation::Criteria::Offset
-  include Parelation::Criteria
+class Parelation::Criteria::Offset < Parelation::Criteria
 
   # @param param [String]
   # @return [TrueClass, FalseClass]

data/lib/parelation/criteria/order.rb

@@ -1,5 +1,4 @@
-class Parelation::Criteria::Order
-  include Parelation::Criteria
+class Parelation::Criteria::Order < Parelation::Criteria
 
   require_relative "order/object"
 

data/lib/parelation/criteria/query.rb

@@ -1,5 +1,4 @@
-class Parelation::Criteria::Query
-  include Parelation::Criteria
+class Parelation::Criteria::Query < Parelation::Criteria
 
   # @param param [String]
   # @return [TrueClass, FalseClass]

data/lib/parelation/criteria/select.rb

@@ -1,5 +1,4 @@
-class Parelation::Criteria::Select
-  include Parelation::Criteria
+class Parelation::Criteria::Select < Parelation::Criteria
 
   # @param param [String]
   # @return [TrueClass, FalseClass]

data/lib/parelation/criteria/where.rb

@@ -1,5 +1,4 @@
-class Parelation::Criteria::Where
-  include Parelation::Criteria
+class Parelation::Criteria::Where < Parelation::Criteria
 
   require_relative "where/caster"
   require_relative "where/directional_query_applier"
@@ -22,7 +21,7 @@ class Parelation::Criteria::Where
       when "where_not"
         chain.where.not(field => value)
       when "where_gt", "where_gte", "where_lt", "where_lte"
-        DirectionalQueryApplier.new(param, criteria, chain).apply
+        DirectionalQueryApplier.new(chain, param, field, value).apply
       end
     end
   end

data/lib/parelation/criteria/where/directional_query_applier.rb

@@ -1,49 +1,53 @@
-  class Parelation::Criteria::Where::DirectionalQueryApplier
-
-    # @return [Hash] keyword to operator mappings
-    #
-    OPERATOR_MAPPING = {
-      "where_gt" => ">",
-      "where_gte" => ">=",
-      "where_lt" => "<",
-      "where_lte" => "<="
-    }
-
-    # @return [String]
-    #
-    attr_reader :operator
-
-    # @return [Hash]
-    #
-    attr_reader :criteria
-
-    # @return [ActiveRecord::Relation]
-    #
-    attr_reader :chain
-
-    # @param operator [String] the named operator from the params
-    # @param criteria [Hash] the data to build query operations with
-    # @param chain [ActiveRecord::Relation] the chain to apply to
-    #
-    def initialize(operator, criteria, chain)
-      @operator = operator
-      @criteria = criteria
-      @chain = chain
-    end
-
-    # @return [ActiveRecord::Relation] the chain with newly applied operations
-    #
-    def apply
-      criteria.inject(chain) do |chain, (key, value)|
-        chain.where(sql, key, value)
-      end
-    end
-
-    private
-
-    # @return [String] the base SQL template to build queries on-top of
-    #
-    def sql
-      %Q{"#{chain.arel_table.name}".? #{OPERATOR_MAPPING[operator]} ?}
-    end
+class Parelation::Criteria::Where::DirectionalQueryApplier
+
+  # @return [Hash] keyword to operator mappings
+  #
+  OPERATOR_MAPPING = {
+    "where_gt" => ">",
+    "where_gte" => ">=",
+    "where_lt" => "<",
+    "where_lte" => "<="
+  }
+
+  # @return [ActiveRecord::Relation]
+  #
+  attr_reader :chain
+
+  # @return [String]
+  #
+  attr_reader :operator
+
+  # @return [String]
+  #
+  attr_reader :field
+
+  # @return [String]
+  #
+  attr_reader :value
+
+  # @param chain [ActiveRecord::Relation] the chain to apply to
+  # @param operator [String] the named operator from the params
+  # @param field [String] the field to query on
+  # @param value [String] the value of the query
+  #
+  def initialize(chain, operator, field, value)
+    @chain = chain
+    @operator = operator
+    @field = field
+    @value = value
   end
+
+  # @return [ActiveRecord::Relation] the chain with newly applied operations
+  #
+  def apply
+    chain.where(sql, field, value)
+  end
+
+  private
+
+  # @return [String] the base SQL template to build queries on-top of
+  #
+  def sql
+    %Q{"#{chain.arel_table.name}".? #{OPERATOR_MAPPING[operator]} ?}
+  end
+end

data/lib/parelation/version.rb

@@ -1,3 +1,3 @@
 module Parelation
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/parelation.gemspec

@@ -18,12 +18,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord", ">= 4.1.0"
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rake", "~> 10.4.2"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.10"
+  spec.add_development_dependency "database_cleaner", "~> 1.4.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_development_dependency "simplecov", "~> 0.9.1"
+  spec.add_development_dependency "yard", "~> 0.8.7.6"
 end

data/spec/lib/applier_spec.rb

@@ -22,8 +22,9 @@ describe Parelation::Applier do
       "offset" => "100"
     }
 
-    criteria = klass.new(Project.create.tickets, params).apply
-    ar_query = Project.create.tickets
+    project = Project.create
+    criteria = klass.new(project.tickets, params).apply
+    ar_query = project.tickets
       .select(:id, :name, :state, :message)
       .where(state: ["open", "pending"])
       .where.not(state: "closed")

data/spec/spec_helper.rb

@@ -8,13 +8,6 @@ SimpleCov.start
 require "parelation"
 
 RSpec.configure do |config|
-  config.mock_framework = :mocha
-
-  config.before do
-    DatabaseCleaner.start
-  end
-
-  config.after do
-    DatabaseCleaner.clean
-  end
+  config.before { DatabaseCleaner.start }
+  config.after { DatabaseCleaner.clean }
 end

data/spec/support/db.rb

@@ -1,7 +1,6 @@
-ActiveRecord::Base
-  .logger = Logger.new(LOG_PATH)
-ActiveRecord::Base
-  .establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3", database: ":memory:"
+)
 
 class Schema < ActiveRecord::Migration
 

data/spec/support/env.rb

@@ -1,14 +1,8 @@
-require "fileutils"
-require "logger"
 require "pry"
 require "sqlite3"
 require "active_record"
 
 ROOT_PATH = File.expand_path("../../..", __FILE__)
 SPEC_PATH = File.join(ROOT_PATH, "spec")
-TMP_PATH = File.join(ROOT_PATH, "tmp")
-LOG_PATH = File.join(TMP_PATH, "parelation.log")
-
-FileUtils.mkdir_p(TMP_PATH)
 
 require "#{SPEC_PATH}/support/db"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parelation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -42,114 +42,100 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.10
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7.6
 description: 
 email:
 - michael@vanrooijen.io
@@ -158,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gemfiles/4.1.gemfile"
+- ".gemfiles/4.2.gemfile"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -213,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Translates HTTP parameters to ActiveRecord queries.