indago 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25248eebba2bf6fd040038720bd0501778c6b8ed32a8cca0b534bc7e538b95a5
+  data.tar.gz: df1356fb937196e84c4276ab000b41924479d97a8c33064eca7edf54604c1cbc
+SHA512:
+  metadata.gz: '068cf27997b839b66c2cec3439201d6c808ab8550a3b84df0cdfeee27d1cbb0156d6f3afd9f76a34ba2924058c932d9ec0e0fce23427f56d2ac8ac9a1554985b'
+  data.tar.gz: 60b60f2249b2273e880dbdb3f049b40a22c0958050bba90e05d374ba5639227d45becef6722961a3dc60513407fabecd8c4911da4e9de8912fe836cc6273b2a7

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in indago.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nebulab SRLs
+
+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,67 @@
+# Indago
+
+Lightweight drop-in Ransack replacement without the ActiveRecord hackery.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'indago'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+In your controller:
+
+```rb
+require "indago"
+
+class PostsController < ApplicationController
+  SEARCH_FIELDS = [
+    # Reusing scopes
+    Indago::Field.new(:is_published) do |scope, value|
+      value.present? ? scope.published : scope
+    end,
+
+    # Complex joins
+    Indago::Field.new(:commented_by_id) do |scope, value|
+      scope.where(
+        id: Comment.where(author_id: value).select(:post_id).distinct
+      )
+    end,
+
+    # Common search fields
+    Indago::Field::Contain.new(:title_cont, :title),
+    Indago::Field::Contain.new(:body_cont, :body),
+
+    # Custom queries
+    Indago::Field.new(:body_starts_with) do |scope, value|
+      scope.where("body LIKE ?", "#{value}%")
+    end
+  ]
+
+  def index
+    @search = Indago::Search.new(Post.all, SEARCH_FIELDS, params[:q])
+    @posts = @search.result
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/nebulab/indago.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "indago"
+
+# 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/indago.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/indago/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "indago"
+  spec.version       = Indago::VERSION
+  spec.authors       = ["Elia Schito", "Filippo Liverani"]
+  spec.email         = ["eliaschito@nebulab.it", "filippoliverani@nebulab.it"]
+
+  spec.summary       = %q{Lightweight drop-in Ransack replacement without the ActiveRecord hackery.}
+  spec.homepage      = "https://github.com/nebulab/indago#readme"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nebulab/indago"
+  spec.metadata["changelog_uri"] = "https://github.com/nebulab/indago/releases"
+  spec.metadata["copyright"] = "Nebulab SRLs"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(File.expand_path('..', __FILE__)) { `git ls-files -z`.split("\x0") }
+
+  spec.files         = files.reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/indago.rb

@@ -0,0 +1,9 @@
+require "indago/version"
+
+module Indago
+  class Error < StandardError; end
+
+  autoload :Field, "indago/field"
+  autoload :Hackery, "indago/hackery"
+  autoload :Search, "indago/search"
+end

data/lib/indago/field.rb

@@ -0,0 +1,21 @@
+class Indago::Field
+  autoload :Contain, 'indago/field/contain'
+
+  attr_reader :name
+
+  def initialize(name, &block)
+    @name = name
+    @block = block
+  end
+
+  def call(scope, value)
+    @block.call(scope, value)
+  end
+
+  def self.for(name)
+    case name.to_s
+    when /^(\w+)_cont$/ then Contain.new(name.to_sym, $1.to_sym)
+    else raise Indago::Error, "Cannot find a proper field for #{name.inspect}"
+    end
+  end
+end

data/lib/indago/field/contain.rb

@@ -0,0 +1,15 @@
+class Indago::Field::Contain
+  attr_reader :name
+
+  # @example
+  #   Indago::Fields::Contain.new(:title)
+  #
+  def initialize(name, attribute)
+    @name = name || :"#{attribute}_cont"
+    @attribute = attribute
+  end
+
+  def call(scope, value)
+    scope.where("#{@attribute} LIKE ?", "%#{value}%")
+  end
+end

data/lib/indago/hackery.rb

@@ -0,0 +1,24 @@
+# BEWARE of the Hackery!
+module Indago::Hackery
+  extend self
+
+  def install!
+    Indago::Search.prepend Search
+    ActiveRecord::Base.singleton_class.prepend Base
+  end
+
+  module Search
+    # Pretend to be a Ransack::Search
+    def is_a?(klass)
+      return true if defined?(Ransack::Search) && klass == Ransack::Search
+      super
+    end
+  end
+
+  module Base
+    def ransack(params)
+      fields = params.keys.map { |name| Indago::Fields.for(name) }
+      Indago::Search.new(all, fields, params)
+    end
+  end
+end

data/lib/indago/search.rb

@@ -0,0 +1,29 @@
+class Indago::Search
+  def initialize(scope, fields, params)
+    @scope = scope
+    @params = params.presence || {}
+    @fields = fields
+    @field_names = @fields.map { |field| field.name.to_sym }
+  end
+
+  def result
+    @result ||= @fields.reduce(@scope) do |scope, field|
+      value = @params[field.name]
+      value.present? ? field.call(scope, value) : scope
+    end
+  end
+
+  def method_missing(name, *args, &block)
+    if @field_names.include?(name) && args.empty?
+      @params[name]
+    elsif @scope.respond_to?(name)
+      @scope.send(name, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(name, include_private = false)
+    @field_names.include?(name) || @scope.respond_to?(name) || super
+  end
+end

data/lib/indago/version.rb

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: indago
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elia Schito
+- Filippo Liverani
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- eliaschito@nebulab.it
+- filippoliverani@nebulab.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- indago.gemspec
+- lib/indago.rb
+- lib/indago/field.rb
+- lib/indago/field/contain.rb
+- lib/indago/hackery.rb
+- lib/indago/search.rb
+- lib/indago/version.rb
+homepage: https://github.com/nebulab/indago#readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nebulab/indago#readme
+  source_code_uri: https://github.com/nebulab/indago
+  changelog_uri: https://github.com/nebulab/indago/releases
+  copyright: Nebulab SRLs
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Lightweight drop-in Ransack replacement without the ActiveRecord hackery.
+test_files: []