elasticfusion 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 938b72038fd4f89e02fd831abd666c1cde6bb8c6
+  data.tar.gz: 9710d296afd5c5723174a9e6cc6d4b1600ecbacb
+SHA512:
+  metadata.gz: 02a3d11f81fee37f4f165f729759b75dc001a18189b96b147aad79092d2b41cfde213a6846aa6042dce3ec14ea8f215cc107c34b4e9f78ef089b2e11886df789
+  data.tar.gz: 9882c8b937b120c910db52df7542935a5ac3218f973e773c4bf86b89bfe870e968a234586871c6da844cc87b5d2e24e600d133512dda07296e8290a517906c48

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+engines:
+  rubocop:
+    enabled: true
+    config:
+      file: .rubocop.yml

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,67 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - test/**/*
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - test/**/*
+
+Metrics/MethodLength:
+  Max: 20
+
+# In search tests, parameters are aligned in a special way
+# for the sake of readability.
+Style/AlignParameters:
+  Exclude:
+    - test/unit/search/**/*
+
+Style/AndOr:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Guard clauses make parsing-related code actually harder to read.
+Style/GuardClause:
+  Exclude:
+    - lib/elasticfusion/search/**/*
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/OptionalArguments:
+  Exclude:
+    - test/**/*
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/MethodName:
+  Exclude:
+    - lib/elasticfusion/search/visitors/es_visitor.rb
+
+Style/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Style/RedundantSelf:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,22 @@
+dist: trusty
+
+sudo: false
+
+rvm: 2.4.1
+
+jdk: openjdk8
+
+env:
+  - ES_VERSION=5.3.1 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
+
+install:
+  - wget ${ES_DOWNLOAD_URL}
+  - tar -xzf elasticsearch-${ES_VERSION}.tar.gz
+  - ./elasticsearch-${ES_VERSION}/bin/elasticsearch &
+  - bundle install
+
+cache:
+  - bundler
+
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/README.md

@@ -0,0 +1,40 @@
+# Elasticfusion
+
+[![Build Status](https://travis-ci.org/little-bobby-tables/elasticfusion.svg?branch=master)](https://travis-ci.org/little-bobby-tables/elasticfusion)
+[![Test Coverage](https://codeclimate.com/github/little-bobby-tables/elasticfusion/badges/coverage.svg)](https://codeclimate.com/github/little-bobby-tables/elasticfusion/coverage)
+[![Gem Version](https://badge.fury.io/rb/elasticfusion.svg)](https://badge.fury.io/rb/elasticfusion)
+
+Elasticfusion provides additional functionality on top of [*elasticsearch-rails*](https://github.com/elastic/elasticsearch-rails).
+
+It includes:
+* a keyword-based case-insensitive search engine supporting boolean expressions
+(conjunction, disjunction, negation) and field queries (range);
+* background jobs to carry out index updates.
+
+It was written with a specific use case in mind and as such places a 
+number of restrictions on the allowed use of Elasticsearch.
+For instance, partial updates are not supported, and `_source` field
+in general is encouraged to be disabled.
+
+### Requirements
+
+* Rails 5
+* Elasticsearch 5
+
+### Setup
+
+1. Place your index definitions in *app/indexes* directory.
+
+2. Drop `Elasticfusion.load_index_definitions` in *app/models/application_record.rb* 
+(or any autoloaded file, really).
+
+3. Add `indexing` queue to your Active Job backend.
+
+### Usage examples
+
+Elasticfusion was written specifically for [fanuniverse](https://www.github.com/little-bobby-tables/fanuniverse).
+Refer to it for real-world usage examples.
+
+### Aknowledgements
+
+This gem was largely inspired by search handling in *booru-on-rails* ([Derpibooru](https://www.derpibooru.org)).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = false
+end
+
+task default: :test

data/elasticfusion.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'elasticfusion/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'elasticfusion'
+  spec.version       = Elasticfusion::VERSION
+  spec.authors       = ['little-bobby-tables']
+  spec.email         = ['little-bobby-tables@users.noreply.github.com']
+
+  spec.summary       = 'elasticsearch-rails extensions'
+  spec.homepage      = 'https://github.com/little-bobby-tables/elasticfusion'
+  spec.license       = 'CC0-1.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '>= 5.0'
+  spec.add_runtime_dependency 'chronic'
+  spec.add_runtime_dependency 'elasticsearch'
+  spec.add_runtime_dependency 'elasticsearch-rails'
+  spec.add_runtime_dependency 'elasticsearch-model'
+
+  spec.add_development_dependency 'openssl'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/elasticfusion.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'active_support/all'
+require 'elasticsearch/model'
+
+require 'elasticfusion/hooks'
+require 'elasticfusion/loader'
+require 'elasticfusion/definition'

data/lib/elasticfusion/definition.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'elasticfusion/model/settings'
+require 'elasticfusion/model/indexing'
+require 'elasticfusion/model/searching'
+
+module Elasticfusion
+  def self.define(cls, &block)
+    cls.class_eval do
+      include Elasticsearch::Model
+
+      def self.elasticfusion(&block)
+        @elasticfusion ||= Model::Settings.new(self, &block)
+      end
+    end
+
+    cls.class_eval(&block)
+
+    # Model extensions may rely on settings set with the block
+    # and should only be included after evaluating it.
+    cls.class_eval do
+      include Model::Indexing
+      include Model::Searching
+    end
+  end
+end

data/lib/elasticfusion/hooks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Elasticfusion
+  module ActiveRecordAdapterPatch
+    # https://github.com/elastic/elasticsearch-rails/issues/608,
+    # might be related to https://github.com/elastic/elasticsearch-rails/issues/258,
+    # though in my experience it only affects Rails 5+.
+    def records
+      @_records_sorted ||= super.to_a
+    end
+  end
+end
+
+Elasticsearch::Model::Adapter::ActiveRecord::Records.prepend(
+  Elasticfusion::ActiveRecordAdapterPatch)

data/lib/elasticfusion/jobs/reindex_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Elasticfusion
+  module Jobs
+    class ReindexJob < ActiveJob::Base
+      queue_as :indexing
+
+      def perform(model_class, id)
+        model_class.constantize.find(id).reindex_now
+      end
+    end
+  end
+end

data/lib/elasticfusion/loader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Elasticfusion
+  # Call this method from within an autoloaded file (e.g. models/application_record.rb)
+  # to instantiate index definitions and refresh them in development, when Rails
+  # autoreloads constants.
+  def self.load_index_definitions
+    Dir.glob(Rails.root.join('app', 'indexes', '*.rb'), &method(:load))
+  end
+end

data/lib/elasticfusion/model/indexing.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'elasticfusion/jobs/reindex_job'
+
+module Elasticfusion
+  module Model
+    module Indexing
+      def self.included(model)
+        model.class_eval do
+          after_commit(on: :create) do
+            __elasticsearch__.index_document
+          end
+
+          after_commit(on: :destroy) do
+            __elasticsearch__.delete_document
+          end
+
+          if elasticfusion[:reindex_when_updated]
+            after_commit(on: :update) do |record|
+              if (record.previous_changes.keys.map(&:to_sym) &
+                  record.class.elasticfusion[:reindex_when_updated]).any?
+                record.reindex_later
+              end
+            end
+          end
+        end
+      end
+
+      def reindex_later
+        Elasticfusion::Jobs::ReindexJob.perform_later(self.class.to_s, self.id)
+      end
+
+      def reindex_now
+        __elasticsearch__.index_document
+      end
+    end
+  end
+end

data/lib/elasticfusion/model/searching.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'elasticfusion/search/wrapper'
+
+module Elasticfusion
+  module Model
+    module Searching
+      def self.included(model)
+        model.class_eval do
+          def self.custom_search(query = nil, &block)
+            Search::Wrapper.new(self, query, &block)
+          end
+        end
+      end
+    end
+  end
+end