find_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7c36ff779bad0716e65577c8e01b31fc95d8e00
+  data.tar.gz: ac5d43f50143dd7ff29ca8b40f74200352dac5cc
+SHA512:
+  metadata.gz: 9414207d3b4a9a8118a496527f83771639e5f6bd649e3a250e67fd401a2c8fe01ae46aa6e1c1d4c7ca8c376deb194e0c029253efdeb2e334752ed9b753b698d1
+  data.tar.gz: 9be639c05046a34fd0bf192230a28218f397ccbe4f566fb03e9b1d35c844f9a89b1ea40b89ec8417bb3502cec694edbd79938eec9f864c99b44249727ec5482a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= FindHelper
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FindHelper'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/find_helper/active_record_finder.rb

@@ -0,0 +1,49 @@
+module FindHelper
+
+    class ActiveRecordFinder
+
+      include ::FindHelper::FormatFinderValue
+      attr_reader :klass, :filed, :find_filed, :find_value, :find_type, :filed_type
+
+      FINDER_TYPES = {
+          :$eq => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} = ?", value]},
+          :$gt => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} > ?", value]},
+          :$gte => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} >= ?", value]},
+          :$lt => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} < ?", value]},
+          :$lte => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} <= ?", value]},
+          :$ne => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} != ?", value]},
+          :$in => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} in (?)", format_array]},
+          :$nin => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} not in (?) ", format_array]},
+          :$like => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} like ?", "%#{value}%"]},
+          :$exists => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} is not null "]},
+          :$nexists => lambda{|klass, filed, value| ["#{klass.table_name}.#{filed} is null "]}
+      }
+
+      DEFAULT_FINDER_TYPES = :$eq
+
+      def initialize(klass, filed, find_value)
+        @klass = klass
+        @filed = filed
+        @find_value = find_value
+      end
+
+      def split_filed
+        @find_type = :$eq
+        @find_filed = @filed
+        @find_type, @find_filed = @filed.to_s.split("_", 2) if @filed.to_s.first == "$"
+        @find_type = @find_type.to_sym
+      end
+
+      def to_finder
+        split_filed
+
+        FINDER_TYPES[@find_type].call(@klass, @find_filed, format_value)
+      end
+
+      def field_type
+        @field_type ||= klass.columns_hash[@find_filed.to_s].type
+      end
+
+    end
+
+end

data/lib/find_helper/format_finder_value.rb

@@ -0,0 +1,83 @@
+module FindHelper
+
+    module FormatFinderValue
+
+      def format_date
+        if find_value.is_a?(Date)
+          find_value
+        elsif find_value.respond_to?(:to_date)
+          find_value.to_date
+        else
+          Date.parse(find_value.to_s)
+        end
+      end
+
+      def format_regexp
+        if find_value.is_a?(Regexp)
+          find_value
+        else
+          Regexp.new(find_value)
+        end
+      end
+
+      def format_time
+        if [DateTime, Time].include?(find_value.class)
+          find_value
+        elsif find_value.respond_to?(:to_time)
+          find_value.to_time
+        else
+          if find_value.is_a?(Numeric)
+            Time.at(find_value)
+          else
+            Time.parse(find_value)
+          end
+        end
+      end
+
+      def format_array
+        case find_value
+          when String
+            find_value.split(",")
+	        else
+						if find_value.respond_to?(:to_a)
+							find_value.to_a
+						else
+							Array(find_value)
+						end
+
+        end
+      end
+
+      def format_boolean
+        case find_value
+          when String
+            ['true', '1'].include?(find_value)
+          when Integer
+            find_value == 1
+          else
+            find_value
+        end
+      end
+
+      def format_value
+        case field_type
+          when :date
+            format_date
+          when :datetime
+            format_time
+          when  :time
+            format_time
+          when :integer
+            find_value.to_i
+          when :float
+            find_value.to_f
+          when :boolean
+            format_boolean
+          else
+            find_value
+        end
+      end
+
+    end
+
+end

data/lib/find_helper/mongoid_finder.rb

@@ -0,0 +1,56 @@
+module FindHelper
+
+    class MongoidFinder
+      include ::FindHelper::FormatFinderValue
+      attr_reader :klass, :filed, :find_filed, :find_value, :find_type
+
+      FINDER_TYPES = {
+          :$eq => lambda{|filed, value, ins| {filed => value} },
+          :$gt => lambda{|filed, value, ins| {filed => {:$gt => value}} },
+          :$gte => lambda{|filed, value, ins| {filed => {:$gte => value} } },
+          :$lt => lambda{|filed, value, ins| {filed => {:$lt => value}} },
+          :$lte => lambda{|filed, value, ins| {filed => {:$lte => value}} },
+          :$ne => lambda{|filed, value, ins| {filed => {:$ne => value} } },
+          :$in => lambda{|filed, value, ins| {filed => {:$in => ins.format_array}} },
+          :$nin => lambda{|filed, value, ins| {filed => {:$nin => ins.format_array } } },
+          :$like => lambda{|filed, value, ins| {filed => ins.format_regexp} },
+          :$exists => lambda{|filed, value, ins| {filed => { :$exists => true} } },
+          :$nexists => lambda{|filed, value, ins| {filed => { :$exists => false} } }
+      }
+      FIELD_TYPES = {
+          :Time => :time,
+          :Integer => :integer,
+          :String => :string,
+          :Boolean => :boolean,
+          :Float =>  :float,
+          :Date => :date
+      }
+
+      DEFAULT_FINDER_TYPES = :$eq
+
+      def initialize(klass, filed, find_value)
+        @klass = klass
+        @filed = filed
+        @find_value = find_value
+      end
+
+      def split_filed
+        @find_type = :$eq
+        @find_filed = @filed
+        @find_type, @find_filed = @filed.to_s.split("_", 2) if @filed.to_s.first == "$"
+        @find_type = @find_type.to_sym
+      end
+
+      def to_finder
+        split_filed
+
+        FINDER_TYPES[@find_type].call(@find_filed, format_value, self)
+      end
+
+      def field_type
+        @field_type ||= FIELD_TYPES[klass.fields[@find_filed.to_s].type.name.to_sym]
+      end
+
+    end
+
+end

data/lib/find_helper/scope.rb

@@ -0,0 +1,23 @@
+module FindHelper
+
+	module Scope
+		def by_scopes(attrs, allow_blank = false)
+			attrs = attrs.delete_if{|_, value| value.blank? } unless allow_blank
+
+			attrs.inject(self) do |parent_scope, (key, value)|
+				scope_name = key.to_sym
+				is_named_scope = self.respond_to?(scope_name)
+
+				if is_named_scope
+					parent_scope.send(scope_name, value)
+				else
+					is_active_record = self.superclass.name == 'ActiveRecord::Base'
+					finder_class = is_active_record ? ActiveRecordFinder : MongoidFinder
+
+					parent_scope.where(finder_class.new(self, key, value).to_finder)
+				end
+			end
+		end
+
+	end
+end

data/lib/find_helper/version.rb

@@ -0,0 +1,3 @@
+module FindHelper
+  VERSION = "0.0.1"
+end

data/lib/find_helper.rb

@@ -0,0 +1,128 @@
+require 'find_helper'
+require 'find_helper/version'
+require 'find_helper/scope'
+require 'find_helper/format_finder_value'
+require 'find_helper/active_record_finder'
+require 'find_helper/mongoid_finder'
+
+=begin
+  用来扩展model的查询能力
+     1. 通过参数来实现级联调用named_scope的效果
+     2. 提供包含多种比较条件的查询
+     3. 自动将特殊字段类型的查询值转换, 包含日期, 时间, 数组, 数组, 布尔
+
+  Example:
+
+  class Product < ActiveRecord::Base
+
+    include FindHelper    # 引入hash级联查询能力
+
+    定义一个字段name的like查询scope
+    named_scope :product_name, { |name| :conditions => ['name like ?', "%{name}%"])
+
+    named_scope :price_gte, {|price| :conditions => ['price_gte >= ?', price]}
+
+  end
+
+  常规查询方法 VS  hash级联查询查询方法(by_scopes)
+  查询 name like 'prom', price 大于 100的
+
+  Product.name('prom').price_gte(100)
+                       |
+                       v
+  Product.by_scopes({:name => 'prom', :price_gte => 100})
+
+  同时还支持
+
+  1. 一般查询扩展
+      Product.by_scopes({:product_name => 'prom', :price_gte => 100, :domain_id => 5})
+                                 |
+                                 v
+      Product.product_name('prom').price_gte(100).find(:all, :conditions => {'products.domain_id = ?', 5})
+
+  2. 默认去除空值查询条件
+      Product.by_scopes({:product_name => '', :price_gte => 100, :domain_id => 5})
+                                 |
+                                 v
+      Product.price_gte(100).find(:all, :conditions => {'products.domain_id = ?', 5})
+
+      不去除空值查询条件
+      Product.by_scopes({:name => '', :price_gte => 100, :domain_id => 5}, false)
+                                 |
+                                 v
+      Product.product_name('').price_gte(100).find(:all, :conditions => {'products.domain_id = ?', 5})
+
+  3. $like(模糊)查询
+      Product.by_scopes({:$like_name => 'prom'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.name like ?', "%prom%"])
+
+  4. $gt(大于)查询
+      Product.by_scopes({:$gt_price => '100'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price > ?', 100])
+
+  5. $gte(大于等于)查询
+      Product.by_scopes({:$gte_price => '100'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price >= ?', 100])
+
+  6. $le(小于)查询
+      Product.by_scopes({:$le_price => '100'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price < ?', 100])
+
+  7. $lte(等于小于)查询
+      Product.by_scopes({:$le_price => '100'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price <= ?', 100])
+
+  8. $ne(不等于)查询
+      Product.by_scopes({:$ne_price => '100'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price != ?', 100])
+
+  9. $in(集合内)查询
+      Product.by_scopes({:$in_price => '100,150,200'})
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price in ?', [100, 150, 200])
+
+  10. $nin(集合外)查询
+      Product.by_scopes({:$nin_price => '100,150,200'}) # 查询值 可以为符号','连接的字符串或数组
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price not in ?', [100, 150, 200])
+
+  11. $exists(存在或不为空值)查询
+      Product.by_scopes({:$exists_price => value})  #注 value可为任意值
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price is not null')
+
+  12. $nexists(不存在或不为空值)查询
+      Product.by_scopes({:$nexists_price => value})  #注 value可为任意值
+                            |
+                            v
+      Product.find(:all, :conditions => ['products.price is null')
+
+  13. 日期类查询
+      Product.by_scopes({:$gte_created_at => '2012-12-12'})  #注 查询值 可为时间类型的字符串或时间类(包含 Date, DateTime, Time)
+                            |
+                            v
+      Product.find(:all, :conditions => ["created_at >= '2012-12-12 00:00:00'")
+=end
+
+module FindHelper
+	extend ActiveSupport::Concern
+
+	included do
+		self.send(:extend, Scope)
+	end
+end

data/lib/tasks/find_helper_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :find_helper do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "find_helper"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end