advanced 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03d013abf9f84626c703a7776d3604ae6214fa87
+  data.tar.gz: c1d2e25e5d09e10aabce2f4740f8fb8b77f091cf
+SHA512:
+  metadata.gz: eea046ecbc5d2be4827b866d2b0170bbcd9a5c2ba0071184489f85d7ede4ea5ef68b5c7f158cd9505e87c5d81220dd6d150f026d253612b5d0e74645a6da8f8c
+  data.tar.gz: d8ad6abde094aadff5ca891dc319e7635bfb0694c4fd7103ed469bc21d6bed3a06b81214cf14745310d15a6e2e5996874bd50a5ef4af3519ad9468f78c22e926

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in advanced.gemspec
+gemspec
+
+gem 'pry'
+gem 'activemodel'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ray Zane
+
+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,41 @@
+# Advanced
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/advanced`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'advanced'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install advanced
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ray Zane/advanced.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/advanced.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'advanced/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "advanced"
+  spec.version       = Advanced::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["ray@promptworks.com"]
+
+  spec.summary       = %q{Search with objects!}
+  spec.homepage      = "https://github.com/rzane/advanced"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'pipey'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "advanced"
+
+# 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(__FILE__)

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/lib/advanced.rb

@@ -0,0 +1,7 @@
+require 'advanced/version'
+require 'advanced/search'
+require 'advanced/search_form'
+require 'advanced/active_record'
+
+module Advanced
+end

data/lib/advanced/active_record.rb

@@ -0,0 +1,30 @@
+module Advanced
+  module ActiveRecord
+    module DSL
+      def where_eq(param, column: param)
+        define_search param, [param] do |value|
+          where column => value
+        end
+      end
+
+      def where_any_eq(param, column: param)
+        define_search param, [param] do |values|
+          values = values.reject(&:blank?)
+          where column => values if values.any?
+        end
+      end
+
+      def where_lt(param, column: param)
+        define_search param, [param] do |value|
+          where(arel_table[column].lt(value))
+        end
+      end
+
+      def where_gt(param, column: param)
+        define_search param, [param] do |value|
+          where(arel_table[column].gt(value))
+        end
+      end
+    end
+  end
+end

data/lib/advanced/builders.rb

@@ -0,0 +1,11 @@
+module Advanced
+  module Builders
+    class Scope < Module
+      def initialize(search, name)
+        define_method name do |params = {}|
+          search.new(all).call(params)
+        end
+      end
+    end
+  end
+end

data/lib/advanced/definition.rb

@@ -0,0 +1,23 @@
+module Advanced
+  class Definition
+    KEY_TYPES = %i[key keyreq]
+
+    def initialize
+      @names = []
+    end
+
+    def add(names = [])
+      @names += names
+    end
+
+    def parameter_names_for(klass)
+      values = klass.steps.flat_map do |meth|
+        klass.instance_method(meth).parameters.reduce([]) do |acc, (type, name)|
+          KEY_TYPES.include?(type) ? (acc + [name]) : acc
+        end
+      end
+
+      values + @names
+    end
+  end
+end

data/lib/advanced/search.rb

@@ -0,0 +1,52 @@
+require 'pipey'
+require 'advanced/definition'
+require 'advanced/builders'
+
+module Advanced
+  class Search < Pipey::Chain
+    extend Pipey::Steps::Scanner[/\A(search|then)_/]
+    extend Pipey::Extensions::RequiredKeys
+    extend Pipey::Extensions::IgnoreNil
+
+    class << self
+      def definition
+        @definition ||= Definition.new
+      end
+
+      def parameter_names
+        definition.parameter_names_for(self)
+      end
+
+      def use(other)
+        define_method "search_#{other.name}" do |**opts|
+          other.call(scope, **opts)
+        end
+      end
+
+      def scope(name = :search)
+        Builders::Scope.new(self, name)
+      end
+
+      def define_search(name, requirements = [], permits = [], &block)
+        definition.add(requirements)
+        definition.add(permits)
+
+        define_method "search_#{name}" do |**opts|
+          if requirements.all? { |k| opts[k] }
+            instance_exec(
+              *opts.values_at(*requirements),
+              *opts.values_at(*permits),
+              &block
+            )
+          end
+        end
+      end
+    end
+
+    alias scope __getobj__
+
+    def call(params = {})
+      super(params.to_h)
+    end
+  end
+end

data/lib/advanced/search_form.rb

@@ -0,0 +1,69 @@
+require 'set'
+require 'active_support/core_ext/object/blank'
+
+module Advanced
+  class SearchForm
+    begin
+      require 'active_model'
+      include ActiveModel::Model
+    rescue LoadError
+    end
+
+    def self.attribute_names
+      @attribute_names ||= Set.new
+    end
+
+    def self.attribute(*names)
+      names.flatten.each do |name|
+        attribute_names << name
+        attr_accessor name
+      end
+    end
+
+    def self.search(value)
+      attribute(*value.parameter_names)
+    end
+
+    def self.nested(key, form)
+      ivar = :"@#{key}"
+
+      attribute_names << key
+
+      define_method key do
+        instance_variable_get(ivar) ||
+          instance_variable_set(ivar, form.new)
+      end
+
+      define_method "#{key}=" do |values|
+        instance_variable_set(ivar, form.new(values))
+      end
+    end
+
+    # We know exactly what parameters are whitelisted,
+    # so, we can skip by AC::Parameters.
+    def initialize(opts = nil)
+      if opts.respond_to? :to_unsafe_h
+        super opts.to_unsafe_h
+      else
+        super
+      end
+    end
+
+    def blank?
+      to_h.blank?
+    end
+
+    # Pull out the blank values. Recursively check if the
+    # resulting object responds to #to_search_h, as this
+    # would indicate a SearchForm object.
+    def to_search_h
+      self.class.attribute_names.reduce({}) do |acc, key|
+        value = public_send(key)
+        value = value.to_search_h if value.respond_to?(:to_search_h)
+        value = value.presence
+        value ? acc.merge(key => value) : acc
+      end
+    end
+    alias to_h to_search_h
+  end
+end

data/lib/advanced/version.rb

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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: advanced
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-07 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: pipey
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ray@promptworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- advanced.gemspec
+- bin/console
+- bin/setup
+- lib/advanced.rb
+- lib/advanced/active_record.rb
+- lib/advanced/builders.rb
+- lib/advanced/definition.rb
+- lib/advanced/search.rb
+- lib/advanced/search_form.rb
+- lib/advanced/version.rb
+homepage: https://github.com/rzane/advanced
+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.10
+signing_key: 
+specification_version: 4
+summary: Search with objects!
+test_files: []