hario 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 314a179b80afaf6621fc5fd75b8ac07f9b666e83
-  data.tar.gz: 66974a51f922f7141e76032957f94bc671c98a34
+  metadata.gz: f50d53adcbb963fc89944af16e00690535a7c6ab
+  data.tar.gz: 45235182715628de22cdde31fa12a65556c5fcca
 SHA512:
-  metadata.gz: e7374fc27c93e5d1eb848a1b955919f9b938913a0120277a58e10a33b7d9fa7bed23faf0f57cf2ba8e37794cb549606629d9b0285c7d4570ab40413799180c01
-  data.tar.gz: 0fdc5240d5b1959848b1b76280cdd97219493d639a22bcf735fa1207acd0d4e1ef0178945b9d0637be46a808d0107f5bd2c23a49cc7c92d02e4f027313b4f949
+  metadata.gz: 7a2f840423cda8d11c7c702b2512646bbddbfe55022b4b173262f3fcd404b80cfd2adbbf6f0891dee7fbde5297889758b58cf6622d37eed5816d3b7036bc73a8
+  data.tar.gz: d0017e3e65ae1f31e4cbf46d56b12092f056fcddfbda1703f059ce2b2beaa5373ed75a71abee4225ba28675e4f4d8037639fcedf691f0620afff6829ba930443

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+test/debug.log

data/Gemfile

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

data/README.md

@@ -18,15 +18,82 @@ Or install it yourself as:
 
 ## Usage
 
+### Setup
+
+Add `include Hario::Filterable` to your AR model to add the `search` method, for instance (we'll use these classes as examples throughout):
+
 ```ruby
-def Animal < ActiveRecord::Base
+def Brand < ActiveRecord::Base
   include Hario::Filterable
+
+  has_many :products
+end
+
+def Product < ActiveRecord::Base
+  belongs_to :brand
+  belongs_to :category, class_name: "ProductCategory"
+end
+
+def ProductCategory < ActiveRecord::Base
+  has_many :products
+end
+```
+
+Then in your BrandsController you can use the `search` method in your index action:
+
+```ruby
+class BrandsController < ApplicationController
+  respond_to :json
+
+  def index
+    @brands = Brand.search(params[:filters])
+
+    respond_with(@brands)
+  end
 end
 ```
 
+### Filters
+
+The format of `params[:filters]`'s keys is a dot-seperated chain of association(s) -> attribute -> operator, for instance if you wanted to return brands that have products of type "Shoe" you could add the filter:
+
+```ruby
+{ 'products.category.name.equals' => 'Shoe' }
+```
+
+Which would result in the SQL query something like:
+
+```sql
+SELECT "brands".* FROM "brands"
+INNER JOIN "products" ON "products"."brand_id" = "brands"."id"
+INNER JOIN "product_categories" ON "product_categories"."id" = "products"."category_id"
+WHERE "product_categories"."name" = 'Shoe'
+```
+
+The available operators are:
+
+- lt (less than)
+- gt (greater than)
+- lte (less than or equal)
+- gte (greater than or equal)
+- like (sql like)
+- equals
+
+## Todo
+
+- Migrate our application-specific tests across to the gem
+
+## Tests
+
+To run tests:
+
+```
+rake test
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/hario/fork )
+1. Fork it ( https://github.com/meritec/hario/fork )
 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`)

data/Rakefile

@@ -4,6 +4,6 @@ require "rake/testtask"
 Rake::TestTask.new do |t|
   t.libs = ["lib"]
   t.warning = true
-  t.verbose = true
+  # t.verbose = true
   t.test_files = FileList['test/*_test.rb']
 end

data/hario.gemspec

@@ -17,9 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", "~> 3.0"
+  spec.add_runtime_dependency "activerecord", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 0"
-  spec.add_development_dependency "sqlite3", "~> 0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.5"
+  spec.add_development_dependency "database_rewinder", "~> 0"
 end

data/lib/hario/version.rb

@@ -1,3 +1,3 @@
 module Hario
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/filter_test.rb

@@ -1,19 +1,30 @@
-require 'minitest/autorun'
 require_relative 'test_helper'
 
-class FilterTest < Minitest::Test
-  def setup
-    @brand = Brand.create!(name: "Adidas")
+class FilterTest < Hario::Test
+  def test_simple_filter
+    filters = { 'name.equals' => "Adidas" }
+    brands = Brand.search(filters)
+
+    assert !brands.any?{ |b| b.name != "Adidas" }
   end
 
-  def teardown
-    Brand.delete_all
+  def test_filter_with_join
+    filters = { 'products.name.equals' => "Gazelle OG" }
+    brands = Brand.search(filters)
+
+    assert_equal 1, brands.count
+    assert brands.first.name == "Adidas"
   end
 
-  def test_simple_filter
-    filters = { 'name.equals' => "Adidas" }
+  def test_filter_with_double_join
+    filters = {
+      'products.category.name.equals' => "T-shirt",
+      'products.name.equals' => "Hamburg"
+    }
     brands = Brand.search(filters)
+    brand = brands.first
 
-    assert !brands.any?{|b| b.name != "Adidas" }
+    assert_equal 1, brands.count
+    assert brand.name == "Adidas"
   end
 end

data/test/fixtures.rb

@@ -0,0 +1,19 @@
+@adidas = Brand.create!(name: "Adidas")
+@shoe = ProductCategory.create!(name: "Shoe")
+@tee = ProductCategory.create!(name: "T-shirt")
+
+Product.create!(
+  brand_id: @adidas.id,
+  category_id: @shoe.id,
+  name: "Gazelle OG"
+)
+Product.create!(
+  brand_id: @adidas.id,
+  category_id: @shoe.id,
+  name: "Hamburg"
+)
+Product.create!(
+  brand_id: @adidas.id,
+  category_id: @tee.id,
+  name: "Hamburg"
+)

data/test/hario_test_class.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+
+class Hario::Test < Minitest::Unit::TestCase
+  def teardown
+    DatabaseRewinder.clean
+  end
+end

data/test/models.rb

@@ -2,4 +2,15 @@ require 'hario'
 
 class Brand < ActiveRecord::Base
   include Hario::Filterable
+
+  has_many :products
+end
+
+class Product < ActiveRecord::Base
+  belongs_to :brand
+  belongs_to :category, class_name: "ProductCategory"
+end
+
+class ProductCategory < ActiveRecord::Base
+  has_many :products
 end

data/test/schema.rb

@@ -5,7 +5,7 @@ ActiveRecord::Schema.define(:version => 1) do
 
   create_table :products, :force => true do |t|
     t.column :name, :string
-    t.column :product_category_id, :integer
+    t.column :category_id, :integer
     t.column :brand_id, :integer
   end
 

data/test/test_helper.rb

@@ -1,12 +1,21 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require "logger"
 require "active_record"
 require "hario"
 require "models"
 
 ActiveRecord::Base.configurations = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
 ActiveRecord::Base.establish_connection(ENV['DB'] || :sqlite3)
-load(File.join(File.dirname(__FILE__), "/schema.rb"))
+load(File.join(File.dirname(__FILE__), "schema.rb"))
 
-ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+
+require "active_support"
+require "database_rewinder"
+
+DatabaseRewinder[ENV['DB'] || 'sqlite3']
+DatabaseRewinder.clean_all
+require "fixtures"
+require "hario_test_class"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hario
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: database_rewinder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -85,8 +99,9 @@ files:
 - lib/hario/behaviours/utils.rb
 - lib/hario/version.rb
 - test/database.yml
-- test/debug.log
 - test/filter_test.rb
+- test/fixtures.rb
+- test/hario_test_class.rb
 - test/models.rb
 - test/pluck_test.rb
 - test/schema.rb
@@ -117,8 +132,9 @@ specification_version: 4
 summary: Hario provides ActiveRecord filtering for Rails APIs.
 test_files:
 - test/database.yml
-- test/debug.log
 - test/filter_test.rb
+- test/fixtures.rb
+- test/hario_test_class.rb
 - test/models.rb
 - test/pluck_test.rb
 - test/schema.rb

data/test/debug.log

@@ -1,16 +0,0 @@
-# Logfile created on 2015-06-25 23:10:26 +0100 by logger.rb/44203
-D, [2015-06-25T23:10:27.058465 #74888] DEBUG -- :    (0.1ms)  begin transaction
-D, [2015-06-25T23:10:27.088174 #74888] DEBUG -- :   SQL (0.2ms)  INSERT INTO "brands" ("name") VALUES (?)  [["name", "Adidas"]]
-D, [2015-06-25T23:10:27.104100 #74888] DEBUG -- :    (0.2ms)  commit transaction
-D, [2015-06-25T23:10:27.127906 #74888] DEBUG -- :   Brand Load (0.2ms)  SELECT "brands".* FROM "brands" WHERE "brands"."name" = ?  [["name", "Adidas"]]
-D, [2015-06-25T23:10:27.145343 #74888] DEBUG -- :   SQL (15.2ms)  DELETE FROM "brands"
-D, [2015-06-25T23:11:17.882386 #74899] DEBUG -- :    (0.1ms)  begin transaction
-D, [2015-06-25T23:11:17.912442 #74899] DEBUG -- :   SQL (0.3ms)  INSERT INTO "brands" ("name") VALUES (?)  [["name", "Adidas"]]
-D, [2015-06-25T23:11:17.913038 #74899] DEBUG -- :    (0.1ms)  commit transaction
-D, [2015-06-25T23:11:17.939361 #74899] DEBUG -- :   Brand Load (0.2ms)  SELECT "brands".* FROM "brands" WHERE "brands"."name" = ?  [["name", "Adidas"]]
-D, [2015-06-25T23:11:17.941683 #74899] DEBUG -- :   SQL (0.1ms)  DELETE FROM "brands"
-D, [2015-06-25T23:11:27.792300 #74906] DEBUG -- :    (0.1ms)  begin transaction
-D, [2015-06-25T23:11:27.857213 #74906] DEBUG -- :   SQL (0.2ms)  INSERT INTO "brands" ("name") VALUES (?)  [["name", "Adidas"]]
-D, [2015-06-25T23:11:27.857824 #74906] DEBUG -- :    (0.1ms)  commit transaction
-D, [2015-06-25T23:11:27.885282 #74906] DEBUG -- :   Brand Load (0.2ms)  SELECT "brands".* FROM "brands" WHERE "brands"."name" = ?  [["name", "Adidas"]]
-D, [2015-06-25T23:11:27.887789 #74906] DEBUG -- :   SQL (0.1ms)  DELETE FROM "brands"