cast_about_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a49119ec5a7172e8ee08ea954f8b5463856f8bde
+  data.tar.gz: 611350d0aa629f2cd032ddc41f05f532192b5593
+SHA512:
+  metadata.gz: d960f66b2d079f0c6dc7a333c3e4277982e4ac60ba93c5ab9faf8d24ab8911df1dec868df8e156fb0a64fe77acea3a7739c12aac5ef708d3dcd42a2f27b3e91e
+  data.tar.gz: 2f2c07a76b98c4b165866ac73e9dc9bce4cbfedf9ed2e29202fb011248683cc7c392205a6e4c66fb7d9ef4f23508ae81f01f78177117b09a15fecbc9fd7ea9e3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at frayay@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,9 @@
+# source 'https://rubygems.org'
+source 'https://ruby.taobao.org/'
+
+# Specify your gem's dependencies in cast_about_for.gemspec
+gemspec
+
+gem 'activerecord', '5.0.0'
+gem 'sqlite3'
+gem 'minitest'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 ray
+
+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.md

@@ -0,0 +1,196 @@
+# CastAboutFor
+
+CastAboutFor allows you easily and reliably query ActiveRecord.
+
+## Installation
+
+Install this gem by adding this to your Gemfile:
+
+```ruby
+gem 'cast_about_for'
+```
+
+Then run:
+
+``` shell
+bundle install
+```
+
+Updating is as simple as `bundle update cast_about_for`.
+
+## Usage
+
+### Setting the Query Column
+
+First, you must set some query colums in your model using the `cast_about_for_params` macro:
+
+``` ruby
+class Product < ActiveRecord::Base
+  cast_about_for_params equal: ['name', 'sex']
+
+  # ...
+end
+```
+
+### Start the Query:
+
+You can always use the `#cast_about_for` class method to query: 
+
+``` ruby
+def index
+  @products = Product.cast_about_for(params, jsonapi: true)
+end
+```
+
+Want to count records? Simple:
+
+```ruby
+  Product.cast_about_for(params, jsonapi: true).count
+```
+
+## cast_about_for_params Configure
+
+### Equal
+
+If you want to use a column query the SQL look like `SELECT "products".* FROM "products" WHERE (name = 'iPhone')`, you can pass it as an option:
+
+``` ruby
+# params = {name: 'iPhone'}
+# Product.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params equal: ['name']
+
+  # ...
+end
+```
+OR you want to alias of the 'name' column
+
+``` ruby
+# params = { nick_name: "iPhone"}
+# User.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params equal: [{name: "nick_name"}]
+
+  # ...
+end
+```
+
+!Your `name` of the `params` must be instead of `nick_name`.
+
+AND you have other columns, you can do it like below.
+
+``` ruby
+# params = { nick_name: "iPhone", info: "sales", price: "600"}
+# User.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params equal: [{name: "nick_name"}, {information: "info"}, price]
+
+  # ...
+end
+```
+
+
+### Like
+
+If you want to use a column query the SQL look like `SELECT "products".* FROM "products" WHERE (introduce LIKE '%To%')`, you can pass it as an option:
+
+``` ruby
+# params = {introduce: 'To'}
+# Product.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params like: ['introduce']
+
+  # ...
+end
+```
+
+Suck as `Equal`. If you want alias of 'introduce', you can
+
+``` ruby
+class Product < ActiveRecord::Base
+  cast_about_for_params like: [{introduce: 'intr'}]
+
+  # ...
+end
+```
+### After
+
+If you want to use a column query the SQL look like `SELECT "products".* FROM "products" WHERE (production_date >= '2016-07-05 13:09:00')`, you can pass it as an option:
+
+``` ruby
+# params = {started_at: '2016-07-05 13:09:00'}
+# Product.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params after: { production_date: "started_at" }
+
+  # ...
+end
+```
+
+### Before
+
+If you want to use a column query the SQL look like `SELECT "products".* FROM "products" WHERE (production_date <= '2016-07-05 13:09:00')`, you can pass it as an option:
+
+``` ruby
+# params = {before_at: '2016-07-05 13:09:00'}
+# Product.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  cast_about_for_params before: { production_date: "before_at" }
+
+  # ...
+end
+```
+
+### Enum
+
+If you have a column use enum, you can pass it as an option:
+
+``` ruby
+# params = {category: "food"}
+# Product.cast_about_for(params, jsonapi: false)
+
+class Product < ActiveRecord::Base
+  enum category: {food: 0}
+  cast_about_for_params enum: ['category']
+
+  # ...
+end
+```
+
+## Advanced Usage
+
+### JSON API
+
+If you are using `JSON API`, you can set in the `#cast_about_for`: 
+
+```ruby
+  Product.cast_about_for(params, jsonapi: true) # JSON API
+  Product.cast_about_for(params, jsonapi: false) # or not
+```
+
+### Custom Query by Block
+
+```ruby
+  Product.cast_about_for(params, jsonapi: true) do |product|
+    product.where(name: 'hello')
+    next product
+  end
+```
+
+## Collaborators
+
+Thank you to the following people:
+
+* The creators of the [by_star](https://github.com/radar/by_star) gem
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cast_about_for"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cast_about_for.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cast_about_for/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cast_about_for"
+  spec.version       = CastAboutFor::VERSION
+  spec.authors       = ["JeskTop"]
+  spec.email         = ["frayay@gmail.com"]
+
+  spec.summary       = %q{query ActiveRecord? Easy.}
+  spec.description   = %q{allows you easily and reliably query ActiveRecord.}
+  spec.homepage      = "https://github.com/minnowlab/cast_about_for/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  unless spec.respond_to?(:metadata)
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "by_star"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
+end

data/lib/cast_about_for/base.rb

@@ -0,0 +1,31 @@
+require 'cast_about_for/search'
+module CastAboutFor
+  module Base
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      include Search
+      CAST_ABOUT_FOR_KEY = [:equal, :like, :enum, :after, :before]
+      def cast_about_for_params *args
+
+        options = args.extract_options!.dup
+
+        options.each_key do |key|
+          raise ArgumentError, "Unknown cast_about_for key: '#{key}" unless CAST_ABOUT_FOR_KEY.include?(key)
+        end
+
+        validate_keys = options.slice(*CAST_ABOUT_FOR_KEY)
+
+        validate_keys.each do |key, value|
+          next unless value.is_a?(Array)
+          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
+
+        class_variable_set(:@@cast_about_for_params, options)
+      end
+    end
+  end
+end

data/lib/cast_about_for/search.rb

@@ -0,0 +1,73 @@
+module CastAboutFor
+  module Search
+    def cast_about_for *args, &block
+      cast_about_params = class_variable_get(:@@cast_about_for_params).dup
+      options = args.dup
+      options = options.extract_options!
+
+      jsonapi = options[:jsonapi] || false
+      params = jsonapi ? args[0][:filter] : args[0]
+      
+      seach_model = self.all
+      cast_about_params.each do |key, value|
+        seach_model = send("cast_about_for_by_#{key}", value, params, seach_model)
+      end
+
+      seach_model = yield(seach_model) if block_given?
+
+      return seach_model
+    end
+
+    private
+
+    def cast_about_for_by_equal search_values, params, seach_model
+      search_values.each do |search_value|
+        search_column, search_name = obtain_value(search_value)
+        seach_model = seach_model.where("#{search_column} = ?", params[search_name.to_sym]) if params[search_name.to_sym].present?
+      end
+      seach_model
+    end
+
+    def cast_about_for_by_like search_values, params, seach_model
+      search_values.each do |search_value|
+        search_column, search_name = obtain_value(search_value)
+        seach_model = seach_model.where("#{search_column} LIKE ?", "%#{params[search_name.to_sym]}%") if params[search_name.to_sym].present?
+      end
+      seach_model
+    end
+
+    def cast_about_for_by_after search_values, params, seach_model
+      search_column, search_name = obtain_by_star_value(search_values, params[search_values[:field].to_sym])
+      seach_model = seach_model.after(params[search_name.to_sym].to_datetime, field: "#{self.to_s.tableize}.#{search_column.to_s}") if params[search_name.to_sym].present?
+      seach_model
+    end
+
+    def cast_about_for_by_before search_values, params, seach_model
+      search_column, search_name = obtain_by_star_value(search_values, params[search_values[:field].to_sym])
+
+      seach_model = seach_model.before(params[search_name.to_sym].to_datetime, field: "#{self.to_s.tableize}.#{search_column.to_s}") if params[search_name.to_sym].present?
+      seach_model
+    end
+
+    def cast_about_for_by_enum search_values, params, seach_model
+      search_values.each do |search_value|
+        search_column, search_name = obtain_value(search_value)
+        seach_model = seach_model.where("#{search_column} = ?", self.send(search_column.to_s.pluralize.to_sym)[params[search_name.to_sym]]) if params[search_name.to_sym].present?
+      end
+      seach_model
+    end
+
+    def obtain_value(value)
+      case value
+        when Hash then [value.first.first, value.first.last]
+        else [value, value]
+      end          
+    end
+
+    def obtain_by_star_value(value, field)
+      column = field.present? ? field : :created_at
+      raise ArgumentError, "Unknown column: #{column}" unless self.respond_to?(column) || self.column_names.include?(column.to_s)
+      [column.to_sym, value[:time]]
+    end
+  end
+end

data/lib/cast_about_for/version.rb

@@ -0,0 +1,3 @@
+module CastAboutFor
+  VERSION = "0.1.0"
+end

data/lib/cast_about_for.rb

@@ -0,0 +1,7 @@
+require 'cast_about_for/base'
+require 'cast_about_for/search'
+require 'active_record'
+require 'active_support'
+require 'by_star'
+
+ActiveRecord::Base.send :include, CastAboutFor::Base

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: cast_about_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JeskTop
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: by_star
+  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
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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
+  name: activerecord
+  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
+  name: pg
+  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
+  name: mysql2
+  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: allows you easily and reliably query ActiveRecord.
+email:
+- frayay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cast_about_for.gemspec
+- lib/cast_about_for.rb
+- lib/cast_about_for/base.rb
+- lib/cast_about_for/search.rb
+- lib/cast_about_for/version.rb
+homepage: https://github.com/minnowlab/cast_about_for/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: query ActiveRecord? Easy.
+test_files: []