hario 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51eaa13608caa623aa57c2e1c2b275aab5419e0a
-  data.tar.gz: 0bdab870d96a09ccdaf3357f0c45107dc366a50e
+  metadata.gz: 136e0b28f2d3f6bc51ba637b83c31f48fcdda3ca
+  data.tar.gz: a8b61b6290486260fe75361a503513b98ca689d6
 SHA512:
-  metadata.gz: 2b0236ad432571151b232b5d2f869cc46048a60bbe058ee550347fa7940664728952c1a84f5f413bbc166aacd15eae613af47528d19645c8e451577fca862bb3
-  data.tar.gz: 7c598b57e7310d36620783a0bcd3dd17878e79a4dbe0b65221495fd2e7f52c221f7ea7ba23e5188f560483944af7fbc06d99150fe29c3e663326d2910188f43b
+  metadata.gz: 2f96e37359a8f64548d93c65c2ca1421cfa99551f236dc5ae465da78bd978e1704ce81a87bf07271e9bdc5cb0ace2d854d3c99f39046bf0a75c554ff14413f6b
+  data.tar.gz: eb7059a076117f97f07e20681af33d67c43d12d028fe28781bb99b9b9aff371a79ebaac29ffec4195e4ce584da75680142f87a842e61203c75f5a67651a3b3ac

data/lib/hario.rb

@@ -4,10 +4,16 @@ require "hario/behaviours/pluck"
 
 module Hario
   module Filterable
-    def search(filters, pluck = nil)
+    HARIO_APPLY_TYPES = %w( filters pluck ).map(&:to_sym)
+
+    attr_reader :hario_attributes_list
+
+    def search(filters, pluck = [])
+      pluck = pluck.reject{ |p| p.nil? || p.empty? }
+
       s = all
       s = s.apply_filters(filters) if filters
-      s = s.apply_pluck(pluck) if pluck
+      s = s.apply_pluck(pluck) if pluck.any?
       s
     end
 
@@ -32,5 +38,22 @@ module Hario
     def hash_pluck(*keys)
       pluck(*keys).map{ |vals| Hash[keys.zip(Array(vals))] }
     end
+
+    def hario_attributes(types, only: nil, except: nil)
+      @hario_attributes_list ||= {}
+      Array.wrap(types).each do |t|
+        raise_if_not_hario_type!(t)
+        @hario_attributes_list[t] =
+          { only: Array.wrap(only), except: Array.wrap(except) }
+      end
+    end
+
+    private
+      def raise_if_not_hario_type!(type)
+        unless HARIO_APPLY_TYPES.include?(type)
+          raise ArgumentError, "#{type} is not one of " \
+            "#{HARIO_APPLY_TYPES.map(&:inspect).join(', ')}"
+        end
+      end
   end
 end

data/lib/hario/behaviours/filter.rb

@@ -4,7 +4,8 @@ module Hario
   class FilterParser
     include ParserUtils
 
-    OPERATORS = { lt: '<', gt: '>', lte: '<=', gte: '>=', like: 'like', equals: '=' }
+    OPERATORS = { lt: '<', gt: '>', lte: '<=', gte: '>=', like: 'like', equals: '=', is: 'is' }
+    IS_VALUES = { null: 'NULL', not_null: 'NOT NULL' }
 
     attr_accessor :join_clause, :where_clauses
 
@@ -15,7 +16,7 @@ module Hario
       parse_filters
     end
 
-    InvalidAttributeError = Class.new(RuntimeError)
+    InvalidValueError     = Class.new(RuntimeError)
 
     private
       def parse_filters
@@ -47,12 +48,18 @@ module Hario
           end_model = @klass
         end
 
+        raise_if_unlisted_attribute!(:filters, end_model, attribute)
         raise_if_invalid_attribute!(attribute, end_model)
 
         case operator
         when :equals
           condition = { attribute => value }
           condition = { attribute_table => condition } if attribute_table
+        when :is
+          value = value.to_sym
+          raise_if_invalid_is_value!(value)
+          condition = ["#{attribute} #{operator} #{IS_VALUES[value]}"]
+          condition[0].prepend("#{attribute_table || @klass.table_name}.")
         else
           operator = OPERATORS[operator]
           condition = ["#{attribute} #{operator} ?", value]
@@ -62,6 +69,13 @@ module Hario
         condition
       end
 
+      def raise_if_invalid_is_value!(value)
+        unless IS_VALUES[value]
+          raise InvalidValueError,
+            "When using 'is', value must be one of #{IS_VALUES.keys.join(', ')}"
+        end
+      end
+
       def raise_if_invalid_attribute!(attribute, end_model)
         unless end_model.column_names.include?(attribute)
           raise InvalidAttributeError,

data/lib/hario/behaviours/pluck.rb

@@ -20,11 +20,17 @@ module Hario
 
         ns, no_ns = @pluck.partition{ |p| p.include?('.') }
 
-        no_ns.each{ |p| @pluck_clause << [@klass.table_name, p].join('.') }
+        no_ns.each do |p|
+          raise_if_unlisted_attribute!(:pluck, @klass, p)
+          @pluck_clause << [@klass.table_name, p].join('.')
+        end
 
         ns.each do |p|
           association_chain, attribute = parse_namespace(p)
 
+          end_model = end_model_from_association_chain(association_chain)
+          raise_if_unlisted_attribute!(:pluck, end_model, attribute)
+
           nested_associations = (association_chain.dup << {}).reverse.inject { |v, key| { key => v } }
           @join_clause.deep_merge!(nested_associations)
 

data/lib/hario/behaviours/utils.rb

@@ -1,4 +1,6 @@
 module ParserUtils
+  InvalidAttributeError = Class.new(RuntimeError)
+
   def table_name_from_association_chain(association_chain)
     end_model_from_association_chain(association_chain).table_name
   end
@@ -12,4 +14,16 @@ module ParserUtils
     
     head
   end
+
+  def raise_if_unlisted_attribute!(type, model_class, attribute)
+    return unless model_class.respond_to?(:hario_attributes_list)
+    return unless model_class.hario_attributes_list
+    lists = model_class.hario_attributes_list[type]
+    return unless lists
+    attribute = attribute.to_sym
+    if (lists[:except].present? &&  lists[:except].include?(attribute)) ||
+       (lists[:only  ].present? && !lists[:only  ].include?(attribute))
+      raise InvalidAttributeError, "#{attribute} is forbidden"
+    end
+  end
 end

data/lib/hario/version.rb

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

data/test/filter_test.rb

@@ -38,7 +38,7 @@ class FilterTest < Hario::Test
     filters = { 'created_at.gt' => (DateTime.now - 5).iso8601 }
     products = Product.search(filters)
 
-    assert_equal 2, products.count
+    assert_equal 3, products.count
   end
 
   def test_invalid_attribute_raises
@@ -48,4 +48,46 @@ class FilterTest < Hario::Test
       Product.search(filters)
     end
   end
+
+  def test_is_null
+    filters = { 'brand_id.is' => "null" }
+
+    products = Product.search(filters)
+    assert_equal 1, products.count
+    assert_equal 'Nil product', products.first.name
+  end
+
+  def test_is_not_null
+    filters = { 'brand_id.is' => "not_null" }
+
+    products = Product.search(filters)
+    assert_equal 3, products.count
+    products.each do |p|
+      refute_equal 'Nil product', p.name
+    end
+  end
+
+  def test_is_value_must_be_correct
+    filters = { 'brand_id.is' => "meh" }
+
+    assert_raises Hario::FilterParser::InvalidValueError do
+      Product.search(filters)
+    end
+  end
+
+  def test_hidden_column_filter
+    filters = { 'hidden_column.equals' => 5 }
+
+    assert_raises Hario::FilterParser::InvalidAttributeError do
+      Product.search(filters)
+    end
+  end
+
+  def test_hidden_column_filter_with_join
+    filters = { 'products.hidden_column.equals' => 5 }
+
+    assert_raises Hario::FilterParser::InvalidAttributeError do
+      Brand.search(filters)
+    end
+  end
 end

data/test/fixtures.rb

@@ -19,4 +19,7 @@ Product.create!(
   brand_id: @adidas.id,
   category_id: @tee.id,
   name: "Hamburg"
-)
+)
+Product.create!(
+  name: 'Nil product'
+)

data/test/models.rb

@@ -9,6 +9,8 @@ end
 class Product < ActiveRecord::Base
   extend Hario::Filterable
 
+  hario_attributes [:filters, :pluck], except: :hidden_column
+
   belongs_to :brand
   belongs_to :category, class_name: "ProductCategory"
 end

data/test/pluck_test.rb

@@ -16,4 +16,23 @@ class PluckTest < Hario::Test
     assert_equal ["id", "name", "brands.name"], products.flat_map(&:keys).uniq,
         "Pluck not returning correct attributes with association pluck"
   end
-end
+
+  def test_hidden_column_pluck
+    assert_raises Hario::PluckParser::InvalidAttributeError do
+      Product.search(nil, %w( hidden_column ))
+    end
+  end
+
+  def test_hidden_column_pluck_with_join
+    assert_raises Hario::PluckParser::InvalidAttributeError do
+      Brand.search(nil, %w( products.hidden_column ))
+    end
+  end
+
+  def test_empty_string_ignored
+    Product.search(nil, [""])
+
+    # no exception
+    assert true
+  end
+end

data/test/schema.rb

@@ -8,6 +8,7 @@ ActiveRecord::Schema.define(:version => 1) do
     t.column :name, :string
     t.column :category_id, :integer
     t.column :brand_id, :integer
+    t.column :hidden_column, :integer
     t.timestamps null: false
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hario
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mike Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Hario provides ActiveRecord filtering for Rails APIs.