hario 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 879fa179f9fab01c486396fc9afd19c19b98c674
-  data.tar.gz: 180dd6a66f7b4fd8a63403a70a955a8f9a5da1da
+  metadata.gz: 51eaa13608caa623aa57c2e1c2b275aab5419e0a
+  data.tar.gz: 0bdab870d96a09ccdaf3357f0c45107dc366a50e
 SHA512:
-  metadata.gz: 4dd7b5574c72a7157316dd8a59f5f8f809c8c12d896a563627eddf8eed6e76fc8feafb7766edd45137a7b8a468dd314649592ef2eedb3d369cfbdd41a26cbad6
-  data.tar.gz: e972fde3bfb04f2b42e7ff87d2958ac4d6d442da443c61aaa7907d4452712bb748a8efe0116c6583e15f4de8f266d58c59fda32f82a913c1ec3b951f63178f1d
+  metadata.gz: 2b0236ad432571151b232b5d2f869cc46048a60bbe058ee550347fa7940664728952c1a84f5f413bbc166aacd15eae613af47528d19645c8e451577fca862bb3
+  data.tar.gz: 7c598b57e7310d36620783a0bcd3dd17878e79a4dbe0b65221495fd2e7f52c221f7ea7ba23e5188f560483944af7fbc06d99150fe29c3e663326d2910188f43b

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ### Setup
 
-Add `include Hario::Filterable` to your AR model to add the `search` method, for instance (we'll use these classes as examples throughout):
+Add `extend Hario::Filterable` to your AR model to add the `search` method, for instance (we'll use these classes as examples throughout):
 
 ```ruby
 def Brand < ActiveRecord::Base
@@ -46,7 +46,9 @@ class BrandsController < ApplicationController
   respond_to :json
 
   def index
-    @brands = Brand.search(params[:filters])
+    @brands = Brand.search(params[:filters], params[:pluck])
+    # or to only use the filterable functionality
+    # @brands = Brand.search(params[:filters])
 
     respond_with(@brands)
   end
@@ -79,9 +81,23 @@ The available operators are:
 - like (sql like)
 - equals
 
-## Todo
+### Pluck
 
-- Migrate our application-specific tests across to the gem
+Oftentimes you might only need a particular attribute, or a few attributes, from the resource, in which case getting the whole of the resources would be inefficient.
+
+This is where pluck comes in handy, it allows you to specify which attributes you're interested in in the request, reducing the amount of data that has to be retrieved from the database, and more importantly, sent over the wire:
+
+```ruby
+@brands = Brand.search(nil, ["name"])
+# will return an array of hashes containing only the primary key and the name attribute for each brand.
+```
+
+Like filters, you can also pluck associated columns from other models using the dot notation, e.g.:
+
+```ruby
+# assuming Country belongs_to :continent
+@countries = Country.search(nil, ["name", "continent.name"])
+```
 
 ## Tests
 

data/hario.gemspec

@@ -17,10 +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", "~> 4.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 "rake"
   spec.add_development_dependency "sqlite3", "~> 1.3.5"
-  spec.add_development_dependency "database_rewinder", "~> 0"
+  spec.add_development_dependency "database_rewinder"
 end

data/lib/hario/behaviours/filter.rb

@@ -1,57 +1,72 @@
 require "hario/behaviours/utils"
 
-class FilterParser
-  include ParserUtils
+module Hario
+  class FilterParser
+    include ParserUtils
 
-  OPERATORS = { lt: '<', gt: '>', lte: '<=', gte: '>=', like: 'like', equals: '=' }
+    OPERATORS = { lt: '<', gt: '>', lte: '<=', gte: '>=', like: 'like', equals: '=' }
 
-  attr_accessor :join_clause, :where_clauses
+    attr_accessor :join_clause, :where_clauses
 
-  def initialize(filters, klass)
-    @filters = filters
-    @klass = klass
+    def initialize(filters, klass)
+      @filters = filters
+      @klass = klass
 
-    parse_filters
-  end
+      parse_filters
+    end
 
-  private
-    def parse_filters
-      @join_clause, @where_clauses = @filters.inject([{}, []]) do |m, (descriptor, value)|
-        association_chain, attribute, operator = parse_descriptor(descriptor)
-        condition = build_condition(association_chain, attribute, operator, value)
+    InvalidAttributeError = Class.new(RuntimeError)
 
-        nested_associations = (association_chain.dup << {}).reverse.inject { |v, key| { key => v } }
-        joins = m[0].deep_merge(nested_associations)
-        wheres = m[1] + [condition]
-        [joins, wheres]
-      end
-    end
+    private
+      def parse_filters
+        @join_clause, @where_clauses = @filters.inject([{}, []]) do |m, (descriptor, value)|
+          association_chain, attribute, operator = parse_descriptor(descriptor)
+          condition = build_condition(association_chain, attribute, operator, value)
 
-    def parse_descriptor(descriptor)
-      parts = descriptor.split('.')
-      operator = parts.pop.to_sym
-      attribute = parts.pop
-      association_chain = parts
+          nested_associations = (association_chain.dup << {}).reverse.inject { |v, key| { key => v } }
+          joins = m[0].deep_merge(nested_associations)
+          wheres = m[1] + [condition]
+          [joins, wheres]
+        end
+      end
 
-      [association_chain, attribute, operator]
-    end
+      def parse_descriptor(descriptor)
+        parts = descriptor.split('.')
+        operator = parts.pop.to_sym
+        attribute = parts.pop
+        association_chain = parts
 
-    def build_condition(association_chain, attribute, operator, value)
-      if association_chain.any?
-        attribute_table = table_name_from_association_chain(association_chain)
+        [association_chain, attribute, operator]
       end
 
-      case operator
-      when :equals
-        condition = { attribute => value }
-        condition = { attribute_table => condition } if attribute_table
-      else
-        value = "%#{value}%" if operator == :like
-        operator = OPERATORS[operator]
-        condition = ["? #{operator} ?", attribute, value]
-        condition[1].prepend("#{attribute_table}.") if attribute_table
+      def build_condition(association_chain, attribute, operator, value)
+        if association_chain.any?
+          end_model = end_model_from_association_chain(association_chain)
+          attribute_table = end_model.table_name
+        else
+          end_model = @klass
+        end
+
+        raise_if_invalid_attribute!(attribute, end_model)
+
+        case operator
+        when :equals
+          condition = { attribute => value }
+          condition = { attribute_table => condition } if attribute_table
+        else
+          operator = OPERATORS[operator]
+          condition = ["#{attribute} #{operator} ?", value]
+          condition[0].prepend("#{attribute_table || @klass.table_name}.")
+        end
+
+        condition
       end
 
-      condition
-    end
+      def raise_if_invalid_attribute!(attribute, end_model)
+        unless end_model.column_names.include?(attribute)
+          raise InvalidAttributeError,
+            "'#{attribute}' is not a valid column name for '#{end_model.table_name}'"
+        end
+      end
+  end
 end

data/lib/hario/behaviours/pluck.rb

@@ -1,42 +1,44 @@
 require "hario/behaviours/utils"
 
-class PluckParser
-  include ParserUtils
+module Hario
+  class PluckParser
+    include ParserUtils
 
-  attr_accessor :join_clause, :pluck_clause
+    attr_accessor :join_clause, :pluck_clause
 
-  def initialize(pluck, klass)
-    @pluck = pluck
-    @klass = klass
+    def initialize(pluck, klass)
+      @pluck = pluck
+      @klass = klass
 
-    parse_pluck
-  end
+      parse_pluck
+    end
 
-  private
-    def parse_pluck
-      @join_clause = {}
-      @pluck_clause = [[@klass.table_name, 'id'].join('.')]
+    private
+      def parse_pluck
+        @join_clause = {}
+        @pluck_clause = [[@klass.table_name, 'id'].join('.')]
 
-      ns, no_ns = @pluck.partition{ |p| p.include?('.') }
+        ns, no_ns = @pluck.partition{ |p| p.include?('.') }
 
-      no_ns.each{ |p| @pluck_clause << [@klass.table_name, p].join('.') }
+        no_ns.each{ |p| @pluck_clause << [@klass.table_name, p].join('.') }
 
-      ns.each do |p|
-        association_chain, attribute = parse_namespace(p)
+        ns.each do |p|
+          association_chain, attribute = parse_namespace(p)
 
-        nested_associations = (association_chain.dup << {}).reverse.inject { |v, key| { key => v } }
-        @join_clause.deep_merge!(nested_associations)
+          nested_associations = (association_chain.dup << {}).reverse.inject { |v, key| { key => v } }
+          @join_clause.deep_merge!(nested_associations)
 
-        attribute_table = table_name_from_association_chain(association_chain)
-        @pluck_clause << [attribute_table, attribute].join('.')
+          attribute_table = table_name_from_association_chain(association_chain)
+          @pluck_clause << [attribute_table, attribute].join('.')
+        end
       end
-    end
 
-    def parse_namespace(namespace)
-      parts = namespace.split('.')
-      attribute = parts.pop
-      association_chain = parts
-      
-      [association_chain, attribute]
-    end
+      def parse_namespace(namespace)
+        parts = namespace.split('.')
+        attribute = parts.pop
+        association_chain = parts
+
+        [association_chain, attribute]
+      end
+  end
 end

data/lib/hario/behaviours/utils.rb

@@ -1,11 +1,15 @@
 module ParserUtils
   def table_name_from_association_chain(association_chain)
+    end_model_from_association_chain(association_chain).table_name
+  end
+
+  def end_model_from_association_chain(association_chain)
     head = @klass
 
     association_chain.each do |a_name|
       head = head.reflect_on_all_associations.find{ |a| a.name.to_s == a_name }.klass
     end
     
-    head.table_name
+    head
   end
 end

data/lib/hario/version.rb

@@ -1,3 +1,3 @@
 module Hario
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/filter_test.rb

@@ -1,6 +1,12 @@
 require_relative 'test_helper'
+require 'date'
 
 class FilterTest < Hario::Test
+  def test_test_data_loaded_properly
+    assert Brand.count > 0,
+      "Test data not loaded"
+  end
+
   def test_simple_filter
     filters = { 'name.equals' => "Adidas" }
     brands = Brand.search(filters)
@@ -27,4 +33,19 @@ class FilterTest < Hario::Test
     assert_equal 1, brands.count
     assert brand.name == "Adidas"
   end
+
+  def test_filter_with_date_condition
+    filters = { 'created_at.gt' => (DateTime.now - 5).iso8601 }
+    products = Product.search(filters)
+
+    assert_equal 2, products.count
+  end
+
+  def test_invalid_attribute_raises
+    filters = { 'foobar.equals' => "ehehehe" }
+
+    assert_raises Hario::FilterParser::InvalidAttributeError do
+      Product.search(filters)
+    end
+  end
 end

data/test/fixtures.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 @adidas = Brand.create!(name: "Adidas")
 @shoe = ProductCategory.create!(name: "Shoe")
 @tee = ProductCategory.create!(name: "T-shirt")
@@ -5,7 +7,8 @@
 Product.create!(
   brand_id: @adidas.id,
   category_id: @shoe.id,
-  name: "Gazelle OG"
+  name: "Gazelle OG",
+  created_at: DateTime.now - 10
 )
 Product.create!(
   brand_id: @adidas.id,

data/test/schema.rb

@@ -1,12 +1,14 @@
 ActiveRecord::Schema.define(:version => 1) do
   create_table :brands, :force => true do |t|
     t.column :name, :string
+    t.timestamps null: false
   end
 
   create_table :products, :force => true do |t|
     t.column :name, :string
     t.column :category_id, :integer
     t.column :brand_id, :integer
+    t.timestamps null: false
   end
 
   create_table :product_categories, :force => true do |t|

data/test/test_helper.rb

@@ -8,7 +8,9 @@ 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"))
+ActiveRecord::Migration.suppress_messages do
+  load(File.join(File.dirname(__FILE__), "schema.rb"))
+end
 
 ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: hario
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -42,14 +42,14 @@ dependencies:
   name: rake
   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'
 - !ruby/object:Gem::Dependency
@@ -70,14 +70,14 @@ dependencies:
   name: database_rewinder
   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: 
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Hario provides ActiveRecord filtering for Rails APIs.