activerecord-filter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa6a908a88c2552f0e8fc6ac2556d651fc9eb7b
-  data.tar.gz: d21504e13db25b2095554fcc67b0852226444325
+  metadata.gz: e58dc2beee5f882a7ffc33cbedd1af29badedfb8
+  data.tar.gz: 1ae2e957182bac436a0416e522b5ca65e92122c4
 SHA512:
-  metadata.gz: fae042c9f46ae8a21ea19deb8f846967e6992083b51ca0bc62b3ae548d5d287aed28198572adc294437d38f4def37e2a61fea05854754231bd09f17d3b133460
-  data.tar.gz: 35d171276aaadc17f95f9984b05300962175dd1571179b6164c8560101f91e0e82374c21b7b6d8dfc97b089cf02539ec8291ea9b8d1a0dc629271a42d9f073e0
+  metadata.gz: 4d3f3fbbc571cccfee96bf9fdcd765d36325232d03898177fd8f6cc065682d6a610524e520087de2a6fb20203728c2dca01d03fc1abe752119814f7d6f8708fa
+  data.tar.gz: 1db8ff73b59f396551fd1eca0687a5ef940cf533f744e0b3b7b8f098e0c64664ddc1d5261256ed97bc810917e84e4885a2304f8d863ba8c04958ce16cfcfac20

data/README.md

@@ -1,2 +1,63 @@
-# activerecord-filter
-A safe way to accept user parameters and query against your ActiveRecord Models
+# ActiveRecord::filter
+
+`ActiveRecord::filter` provides and easy way to accept user input and filter a query by the input.
+
+Installtion
+-----------
+
+- Add `gem 'activerecord-filter', require: 'active_record/filter'
+- Run `bundle install`
+
+Examples
+--------
+
+Normal columns:
+
+```ruby
+Property.filter(:id => 5).to_sql
+# => "...WHERE properties.id = 5"
+
+Property.filter(:id => [5, 10, 15]).to_sql
+# => "...WHERE properties.id IN (5, 10, 15)"
+
+Property.filter(:id => {:gt => 5}).to_sql
+# => "...WHERE properties.id > 5"
+
+Property.filter(:id => {:gte => 5}).to_sql
+# => "...WHERE properties.id >= 5"
+
+Property.filter(:id => {:lt => 5}).to_sql
+# => "...WHERE properties.id < 5"
+
+Property.filter(:id => {:lte => 5}).to_sql
+# => "...WHERE properties.id <= 5"
+
+Property.filter(:address_id => nil).to_sql
+# => "...WHERE properties.address_id IS NULL..."
+
+Property.filter(:address_id => false).to_sql
+# => "...WHERE properties.address_id IS NULL..."
+
+Property.filter(:address_id => true).to_sql
+# => "...WHERE properties.address_id IS NOT NULL..."
+```
+
+It can also work with array columns:
+
+```ruby
+Property.filter(:tags => 'Skyscraper').to_sql
+# => "...WHERE 'Skyscraper' = ANY(properties.tags)..."
+
+Property.filter(:tags => ['Skyscraper', 'Brick']).to_sql
+# => "...WHERE (properties.aliases && '{"Skyscraper", "Brick"}')..."
+```
+It can also sort on relations:
+
+```ruby
+Photo.filter(:property => 10).to_sql
+# => "...WHERE photos.property_id = 5"
+
+Photo.filter(:property => {name: 'Empire State'}).to_sql
+# => "...INNER JOIN properties ON properties.id = photos.property_id
+# => "   WHERE properties.name = 'Empire State'"
+```

data/ext/active_record/base.rb

@@ -134,7 +134,6 @@ class ActiveRecord::Base
       when nil
         where(table[column].eq(nil))
       else
-        puts value.inspect
         raise 'Not supported'
       end
     end
@@ -143,8 +142,21 @@ class ActiveRecord::Base
       table = options[:table_alias] ? arel_table.alias(options[:table_alias]) : arel_table
 
       case value
+      when Hash
+        resource = all
+        value.each_pair do |key, value|
+          resource = case key.to_sym
+          when :contains
+            resource.where(Arel::Nodes::Contains.new(table[column], Arel::Attributes::Array.new(value)))
+          when :overlaps
+            resource.where(Arel::Nodes::Overlaps.new(table[column], Arel::Attributes::Array.new(value)))
+          else
+            raise "Not Supported: #{key.to_sym}"
+          end
+        end
+        resource
       when Array
-        where(Arel::Nodes::Overlaps.new(table[column], Arel::Attributes::Array.new(value)))
+        where(Arel::Nodes::Contains.new(table[column], Arel::Attributes::Array.new(value)))
       else
         any_column = Arel::Nodes::NamedFunction.new('ANY', [table[column]])
         predicate = Arel::Nodes::Equality.new(Arel::Nodes.build_quoted(value), any_column)
@@ -226,13 +238,14 @@ class ActiveRecord::Base
       when Hash
         if relation.polymorphic?
           raise 'no :as' if !value[:as]
-          klass = value.delete(:as).classify.constantize
+          v = value.dup
+          klass = v.delete(:as).classify.constantize
           t1 = resource.arel_table
           t2 = klass.arel_table
           resource = resource.joins(t1.join(t2).on(
             t2[:id].eq(t1["#{relation.name}_id"]).and(t1["#{relation.name}_type"].eq(klass.name))
           ).join_sources.first)
-          resource = resource.merge(klass.filter(value))
+          resource = resource.merge(klass.filter(v))
         else
           resource = resource.joins(relation.name) # if !resource.references?(relation.name)
           resource = resource.merge(relation.klass.filter(value))

data/ext/arel/visitors/postgresql.rb

@@ -19,7 +19,14 @@ module Arel
         type = if !o.relation[0]
           ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array.new(nil)
         else
-          ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array.new("ActiveRecord::Type::#{o.relation[0].class}".constantize.new)
+          # TODO: temp fix, need to figure out how to look up ruby type ->
+          # postgres type or use the column we're quering on...
+          dt = if o.relation[0].class == Fixnum
+            dt = "Integer"
+          else
+            o.relation[0].class
+          end
+          ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array.new("ActiveRecord::Type::#{dt}".constantize.new)
         end
 
         collector << quote(type.type_cast_for_database(o.relation))

data/lib/active_record/filter/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Filter
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-filter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg