cast_about_for 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f89b80544593269d2556df48a28845c7b9afb875
-  data.tar.gz: f32a8afe8c775646c101a17976ff144d43d43076
+  metadata.gz: e5f49b9f0d9074c8dabf2932029de383179fb429
+  data.tar.gz: 1264283111f24c0fcad5d3e36576644dc1a5eaed
 SHA512:
-  metadata.gz: c1ee3ad830d4fa24b31b4f45c000561120c72059b0945741909aa3e980ae952005f593eadea3ee95d2ce734387d88e63e8b6fff9b5cb9811302b10d6e84d3441
-  data.tar.gz: 071d92105a788ec87ba1a930dd42c88962637a2feea7ad956e2b018ac02569288687d94abb2b4e9236519da367ab877d756c87fdfa5782ae35a7059c29f652f9
+  metadata.gz: 792179f701b91f51f0988452666e02c7c113839c74edd1a77af90b3a89b64c1bfcf5ffbd6db68ddba7072847e67fa3e0fba4fbf853c635d2692284412f554200
+  data.tar.gz: 20d77f0ac8bb4da57d80b61b80e37baa9cf262bcf8d39eebd9dd09e03d74bf4bb9b565a9b6569a368f871988c1428ec5950c43ec8cab05a8dc2f582f08491f72

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cast_about_for.gemspec
 gemspec
 
-gem 'activerecord', '5.0.0'
-gem 'sqlite3'
+gem 'activerecord', '~> 5.0.0.1'
+gem 'sqlite3', '~> 1.3.11'
 gem 'minitest'

data/README.md

@@ -231,6 +231,139 @@ class Product < ActiveRecord::Base
   # ...
 end
 ```
+
+### Comparison
+If you want to compare a column, the sql like this: The SQL: `SELECT "products".* FROM "products" WHERE (weight >= '100' AND weight <= '1000')`
+you can do it like this:
+```ruby
+# params = {weight_min: 100, weight_max: 1000}
+# Product.cast_about_for(params)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params comparison: [{"weight >= ?" => "weight_min"}, {"weight <= ?" => "weight_max"}]
+
+end
+```
+
+###Includes
+If you want to `includes` other models, you can do it like this
+```ruby
+class Product < ActiveRecord::Base
+  cast_about_for_params includes: [:user, :items]
+
+#This will make `product` include `user` and `items` automatically
+#Like:  Product.includes(:user, :items)
+end
+
+```
+###Joins
+
+If you want to join a model you can do it like this:
+
+```ruby
+Example 1 
+
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [equal: :name]}]
+  
+end
+
+# params = {name: "user"}
+# Product.cast_about_for(params)
+# It will be generates like this: Product.joins(:user).where("users.name = ?", "user")
+# The sql would like this: `SELECT "products".* FROM "products" INNER JOIN "users" ON "users"."id" = "products"."user_id" WHERE (users.name = 'user')`
+
+If you want to query the condition of "LIKE", do it like this
+
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [like: :name]}]
+  
+end
+Then the sql would be like this:  `SELECT "products".* FROM "products" INNER JOIN "users" ON "users"."id" = "products"."user_id" WHERE (users.name Like 'user')`
+
+
+--------
+Example 2
+If you want to nickname the `name` of the params like: 
+# params = {user_name: "user"}
+# Product.cast_about_for(params)
+
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [equal: {name: :user_name}]}]
+  
+end
+
+# Also will generates like this: Product.joins(:user).where("users.name = ?", "user") 
+# The sql would like this: `SELECT "products".* FROM "products" INNER JOIN "users" ON "users"."id" = "products"."user_id" WHERE (users.name = 'user')`
+
+--------
+Example 3
+If multiple user columns that you want to query, you can do it like this:
+# params = {name: "user", age: 18}
+# Product.cast_about_for(params)
+
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [equal: [:name, :age]}]
+  
+end
+# Also will generates like this: Product.joins(:user).where("users.name = ? AND users.age = ?", "user", "18") 
+# The sql would like this: `SELECT "products".* FROM "products" INNER JOIN "users" ON "users"."id" = "products"."user_id" WHERE (users.name = 'user' AND users.age = 18)`
+
+
+If you want to nickname the params:
+# params = {user_name: "user", user_age: 18}
+# Product.cast_about_for(params)
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [equal: [{name: :user_name}, {age: :user_age}]}]
+  
+end
+
+--------
+Example 4
+You can use the `equal` and `like` at the same time:
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [equal: :age], [like: :name]}]
+  
+end
+
+`OR`
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{user: [equal: [:age, :height]], [like: [:name, :roles]]}]
+  
+end
+
+--------
+Example 5
+Nested joins:
+
+Now, I have `product` `user` `company` models, 
+
+class Product <  ActiveRecord::Base
+  belongs_to :user
+end
+
+class User <  ActiveRecord::Base
+  belongs_to :company
+  has_many :products
+end
+
+class Company <  ActiveRecord::Base
+  has_many :user
+end
+
+I have company `name`, and now I want to query the products through the user who belong to the company, so I can do it like this:
+
+class Product <  ActiveRecord::Base
+  cast_about_for_params joins: [{{user: :company} => [like: {name: :company_name}]}]
+  
+end
+# params = {company_name: "Teo"}
+# Product.cast_about_for(params)
+# The sql would like this:  SELECT "products".* FROM "products" INNER JOIN "users" ON "users"."id" = "products"."user_id" INNER JOIN "companies" ON "companies"."id" = "users"."company_id" WHERE (companies.name LIKE 'Teo')
+
+```
+
+
 ## Advanced Usage
 
 ### JSON API

data/lib/cast_about_for/base.rb

@@ -1,11 +1,12 @@
 require 'cast_about_for/search'
+require 'cast_about_for/validate_macro'
 module CastAboutFor
   module Base
     extend ActiveSupport::Concern
 
     module ClassMethods
       include Search
-      CAST_ABOUT_FOR_KEY = [:equal, :like, :enum, :after, :before]
+      CAST_ABOUT_FOR_KEY = [:equal, :like, :enum, :joins, :includes, :after, :before, :comparison]
       def cast_about_for_params *args
 
         options = args.extract_options!.dup
@@ -14,14 +15,9 @@ module CastAboutFor
           raise ArgumentError, "Unknown cast_about_for key: '#{key}" unless CAST_ABOUT_FOR_KEY.include?(key)
         end
 
-        validate_keys = options.slice(*CAST_ABOUT_FOR_KEY.first(3))
+        validate_keys = options.slice(*CAST_ABOUT_FOR_KEY.first(5))
 
-        validate_keys.each do |key, value|
-          value.each do |attribute|
-            attribute = attribute.is_a?(Hash) ? attribute.first.first : attribute
-            raise ArgumentError, "Unknown column: #{attribute}" unless self.respond_to?(attribute) || self.column_names.include?(attribute.to_s)
-          end
-        end
+        ValidateMacro.validate(self, validate_keys)
 
         class_variable_set(:@@cast_about_for_params, options)
       end

data/lib/cast_about_for/search.rb

@@ -68,6 +68,33 @@ module CastAboutFor
       seach_model
     end
 
+    def cast_about_for_by_comparison search_values, params, seach_model
+      search_values.each do |comparison|
+        comparison.each do |seach_mod, search_name|
+          seach_model = seach_model.where("#{seach_mod}", params[search_name.to_sym]) if params.present? && params[search_name.to_sym].present?
+        end
+      end
+      seach_model
+    end
+
+    def cast_about_for_by_joins search_values, params, seach_model
+      search_values.each do |associations|
+        associations.each do |association, association_operations|
+          association_operations.each do |operations|
+            operations.each do |action, columns|
+              seach_model = send("#{action.to_s}_operation", association, columns, params, seach_model)
+            end
+          end
+        end
+      end
+      seach_model
+    end
+
+    def cast_about_for_by_includes search_values, params, seach_model
+      seach_model = seach_model.includes(search_values)
+      seach_model
+    end
+
     def obtain_value(value)
       case value
         when Hash then [value.first.first, value.first.last]
@@ -87,5 +114,37 @@ module CastAboutFor
       raise ArgumentError, "Unknown column: #{column}" unless self.respond_to?(column) || self.column_names.include?(column.to_s)
       [column.to_sym, value[:time]]
     end
+
+    def like_operation(association, columns, params, seach_model)
+      association, association_name = obtain_joins_value(association)
+      columns = columns.is_a?(Array) ? columns : [columns]
+      columns.each do |column|
+        search_column, search_name = obtain_value(column)
+        seach_model = seach_model.joins(association).where("#{association_name.to_s.pluralize}.#{search_column} LIKE ?", "%#{params[search_name.to_sym]}%") if params.present? && params[search_name.to_sym].present?
+      end
+      p 
+      seach_model
+    end
+
+    def equal_operation(association, columns, params, seach_model)
+      association, association_name = obtain_joins_value(association)
+      columns = columns.is_a?(Array) ? columns : [columns]
+      columns.each do |column|
+        search_column, search_name = obtain_value(column)
+        seach_model = seach_model.joins(association).where("#{association_name.to_s.pluralize}.#{search_column} = ?", params[search_name.to_sym]) if params.present? && params[search_name.to_sym].present?
+      end
+      seach_model
+    end
+
+    
+    def obtain_joins_value(value) 
+      if Hash === value  #如果是hash则使用嵌入式joins
+        association = {}
+        value.each{|k, v| association[k.to_sym] = v.to_sym}
+        [association, value.flatten.last]
+      else
+        [value.to_sym, value]
+      end
+    end
   end
 end

data/lib/cast_about_for/validate_macro.rb

@@ -0,0 +1,69 @@
+module CastAboutFor
+  module ValidateMacro
+
+    class << self
+
+      def validate(record, options)
+        options.each do |key, value|
+          case key
+          when :joins then send("validate_join", record, value)
+          when :includes then send("validate_includes", record, value)
+          else send("validate_others", record, value)
+          end
+        end
+      end
+
+      private
+
+      def validate_join(record, value)
+        value.each do |association|
+          association.each do |association_name, association_operations|
+            validate_join_associations(record, association_name)
+
+            association_operations.each do |operations|
+              operations.each_value do |columns|
+                association_name = association_name.is_a?(Hash) ? association_name.flatten.last : association_name
+                klass = Object.const_get("#{association_name}".camelize.singularize)
+                columns = columns.is_a?(Array) ? columns : [columns]
+                columns.each do |column|
+                  column = column.is_a?(Hash) ? column.first.first : column
+                  raise ArgumentError, "Unknown column: #{column} for #{klass}" unless klass.column_names.include?("#{column}")
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def validate_includes(record, value)
+        value = value.is_a?(Array) ? value : [value]
+        value.each do |association|
+          raise ArgumentError, "Unknown association #{association} fo #{record}" unless record._reflections.keys.include?(association.to_s)
+        end
+      end
+
+      def validate_others(record, value)
+        value.each do |attribute|
+          attribute = attribute.is_a?(Hash) ? attribute.first.first : attribute
+          raise ArgumentError, "Unknown column: #{attribute} fo #{record}" unless record.respond_to?(attribute) || record.column_names.include?(attribute.to_s)
+        end
+      end
+
+      def validate_join_associations(record, association_name)
+        if association_name.is_a?(Hash)     #检查是否为嵌入式的joins，例如: A.joins(b: :c)
+          association_name.each do |key, value|
+            validate_join_association(record, key)
+            validate_join_association(Object.const_get("#{key}".camelize.singularize), value)
+          end
+        else
+          validate_join_association(record, association_name)
+        end
+      end
+
+      def validate_join_association(record, association_name)
+        # _reflections method come from rails ActiveRecord::Reflection
+        raise ArgumentError, "Unknown association #{association_name} fo #{record}" unless record._reflections.keys.include?(association_name.to_s)
+      end
+    end
+  end
+end

data/lib/cast_about_for/version.rb

@@ -1,3 +1,3 @@
 module CastAboutFor
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cast_about_for
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - JeskTop
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,6 +156,7 @@ files:
 - lib/cast_about_for.rb
 - lib/cast_about_for/base.rb
 - lib/cast_about_for/search.rb
+- lib/cast_about_for/validate_macro.rb
 - lib/cast_about_for/version.rb
 homepage: https://github.com/minnowlab/cast_about_for/
 licenses: