chewy-translation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2e335e8f628227d76c63fe7dfabd1618435907a
+  data.tar.gz: 612041bbe1a308470135dd54d21b84c28698f69a
+SHA512:
+  metadata.gz: ba4169bc1edb94a67ba5fa8a210bac89d109e4b4942bdf5c8e7f00f1029063c806e979bc3a70b9129334c4480cf5bb2d8f66c8ace509c2a4b48e473c608b76b6
+  data.tar.gz: dad938f4dbecd50400366018255e3b20d37ba7663da5cf93cd43ebd53c395c6339bcc34e803b31587cc6354e542c8aa99cc72e9a9235ac12ffe38d972e7393bf

data/.gitignore

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

data/.travis.yml

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

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 dev@jobteaser.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,10 @@
+source 'https://rubygems.org'
+
+ruby '2.3.1'
+
+# Specify your gem's dependencies in chewy-translation.gemspec
+
+gem 'chewy'
+gem 'activesupport'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 JobTeaser
+
+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,102 @@
+# Chewy::Translation
+
+Chewy::Translation is an easy integration of Translation within Chewy.
+
+Chewy::Translation handles translated content in elasticsearch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chewy-translation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chewy-translation
+
+## Usage
+
+### Indexing translated content
+
+Add a new field in `/app/chewy/user_index.rb`
+
+```ruby
+class UserIndex < Chewy::Index
+
+  define_type User, name: :global do
+    field :translations, type: 'nested' do
+      field :locale, type: 'string'
+      field :name, type: 'string' # add analysers if needed
+    end
+  end
+
+end
+```
+
+If you need to handle an activation status for your translations, add an `active` column in the translation table and index it as follow:
+
+```ruby
+class UserIndex < Chewy::Index
+
+  define_type User, name: :global do
+    field :active_locales, mode: 'arrayed', value:
+      -> (c) { c.translations.select { |t| t.active == true }.map(&:locale) }
+  end
+
+end
+```
+
+### Querying and filtering translated content
+
+#### Autocomplete:
+The autocomplete method searches only in the wanted locale.
+For example the following query will return all the users with a name starting with 'Idefix' in french:
+
+```ruby
+UserIndex::Global.autocomplete(fields: ['name'], query: 'Idefix', locale: :fr)
+```
+It's possible to perform an autocomplete on more than one simple field, for example you can imagine for Users an autocomplete on first_name and last_name: `fields: ['first_name', 'last_name']`.
+
+## Search:
+If the field is translated, the search_by will search in all the available locales in the context.
+For example the following query will return all the users with 'Getafix' in their names (in any available locale).
+```ruby
+UserIndex::Global.search_by(name: 'Getafix')
+```
+
+Let's assume we have an object named 'Getafix' in english and 'Panoramix' in french, if a user with a french interface perform the query above, it will return 'Panoramix'.
+
+It's also possible to search on different fiels on the same query:
+```ruby
+UserIndex::Global.search_by(name: 'Getafix', job: 'druid')
+```
+
+The search_by method can also be used on numeric fields, and it is possible to give an array of numbers to those fields (and it will perform a 'or' between those numbers).
+```ruby
+UserIndex::Global.search_by(name: 'Getafix', some_id: 123, another_id: [123, 456, 789])
+```
+It will display the object with:
+- 'Getafix' in their name
+- 'sickle_id' = 123
+- 'mistletoe_id' in [123, 456, 789]
+
+An other way to perform a search is tu use `search_by_fields`, it allows to search a single string in different fields. For example to search a object containing 'Getafix' in the name or in the character_description: 
+```ruby
+UserIndex::Global.search_by_fields(fields: [:name, :character_description], query: 'Getafix')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jobteaser/chewy-translation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 => :test

data/bin/console

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

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chewy/translation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chewy-translation'
+  spec.version       = Chewy::Translation::VERSION
+  spec.authors       = ['JobTeaser']
+  spec.email         = ['dev@jobteaser.com']
+
+  spec.summary       = %q{Index and search on translated content with chewy.}
+  spec.description   = %q{Index and search on translated content with chewy.}
+  spec.homepage      = 'https://github.com/jobteaser/chewy-translation'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/chewy/translation.rb

@@ -0,0 +1,11 @@
+require 'chewy/translation/query'
+require 'chewy/translation/index'
+require 'chewy/translation/version'
+
+module Chewy
+  module Translation
+    Chewy::Query.send(:include, Chewy::Translation::Query)
+    Chewy::Index.send(:include, Chewy::Translation::Index)
+    Chewy::Type.send(:include, Chewy::Translation::Index)
+  end
+end

data/lib/chewy/translation/index.rb

@@ -0,0 +1,16 @@
+module Chewy
+  module Translation
+    module Index
+      extend ActiveSupport::Concern
+      included do
+        singleton_class.delegate :autocomplete, to: :all
+        singleton_class.delegate :permitted, to: :all
+        singleton_class.delegate :search_by, to: :all
+        singleton_class.delegate :search_by_fields, to: :all
+        singleton_class.delegate :nested_search_by, to: :all
+        singleton_class.delegate :active_filter, to: :all
+        singleton_class.delegate :inactive_filter, to: :all
+      end
+    end
+  end
+end

data/lib/chewy/translation/query.rb

@@ -0,0 +1,196 @@
+module Chewy
+  module Translation
+    module Query
+      # Called on an Index, will autocomplete on the fields regarding or not the locale
+      # Usage :
+      #   UserIndex::Global.autocomplete(fields: ['name'], query: 'Idefix', locale: 'fr')
+      #     => Users with 'Idefix' in their name in french
+      #   UserIndex.autocomplete(fields:['first_name', 'last_name'], query: 'Ordralfabetix', locale: 'fr')
+      #     => Users with 'Ordralfabetix' in their first_name or in their last_name
+      #
+      # /!\ it will fail if you try to autocomplete a non translated field with a locale
+      #
+      # @param fields [array] fields autocompleted
+      # @param query [string] query of the autocomplete
+      # @param locale [string] context locale if the field is translated
+      # @return [chewy::query]
+      def autocomplete(fields:, query:, locale: nil)
+        return search_by_fields(fields: fields, query: query) unless locale
+        search_by_fields_with_locale(fields: fields, query: query, locale: locale)
+      end
+
+      # Principal search function that should be used as often as possible
+      # Usage:
+      #   UserIndex.search_by(name: 'Assurancetour')
+      #     => users including Assurancetour in their name
+      #   UserIndex.search_by(name: 'Assurancetour', harp_id: 1, house_in_tree_id: [1, 2, 3])
+      #     => users including oran in their name, with harp_id 1 and house_in_tree_id 1, 2 or 3
+      #
+      # @param opts [Hash] fields and their associated query
+      # @return [Chewy::Query]
+      def search_by(opts = {})
+        return self if opts.blank?
+        results = self
+        opts.delete_if { |_, v| v.blank? }.each do |k, v|
+          results = results.unit_search_by(k, v)
+        end
+        results
+      end
+
+      # Another way to search the indexes
+      # Usage:
+      #   UserIndex.search_by_fields(fields: ['name', 'character_description'], query: 'Falbala')
+      #     => all objects containing 'Falbala' in  name or in character_description
+      #
+      # @param fields [Array]
+      # @param query [String]
+      # @param query_mode [Symbol] :should or :must
+      #   (:should by default,
+      #   this is most of all for the use of this method from the inside of this module)
+      # @return [Chewy::Query]
+      def search_by_fields(fields:, query:, query_mode: :should)
+        nested_fields = translated_fields & fields unless translated_fields.blank?
+        fields -= translated_fields unless translated_fields.blank?
+        result = []
+        result << { multi_match: { fields: fields, query: query } } unless fields.blank?
+        result << nested_search_by_fields(
+          path: 'translations', fields: nested_fields, query: query
+        ) unless nested_fields.blank?
+        result = { bool: { query_mode => result } }
+        query(result)
+      end
+
+      # Usage:
+      # FortifiedCampIndex::Global.active_filter(['fr', 'en'])
+      #   => FortifiedCamps active either in french OR in english OR both
+      #
+      # @param locales [Array] List of locales on the context
+      # @return [Chewy::Query]
+      def active_filter(locales:)
+        activation_status_filter(active: true, locales: locales)
+      end
+
+      # Usage:
+      # FortifiedCampsIndex::Global.active_filter(['fr', 'en'])
+      #   => FortifiedCamps inactive in french AND in english
+      #
+      # @param locales [Array] List of locales on the context
+      # @return [Chewy::Query]
+      def inactive_filter(locales:)
+        activation_status_filter(active: false, locales: locales)
+      end
+
+      # Usage:
+      #   FortifiedCampsIndex.permitted(policy, :enter?)
+      #   FortifiedCampsIndex.filter { !centurion? }.permitted(policy, :enter?).filter(active:true)
+      #
+      # To call query.permitted(policy, :enter?) is similar to call policy.elasticsearch_show?(enter)
+      #
+      # The permission are defined in each policy,
+      # in the filter module and should be build as follow:
+      #   def elasticsearch_action?(query)
+      #     # returns a chewy query
+      #   end
+      # It needs to be prefixed with elasticsearch
+      # and needs to take a query or an index and return a query
+      #
+      # @param policy [Policy] could be any type of policy linked to the Index.
+      # ie: when the method is called on CompanyIndex,
+      # it should be CompanyPolicy or Backend::CompanyPolicy
+      # @param action [Symbol]
+      # @return [ChewyIndex::Query]
+      def permitted(policy, action)
+        policy.send("elasticsearch_#{action}", self)
+      end
+
+      # Build the hash needed to perform search in nested fields
+      # Usage:
+      #   UserIndex.query(nested_search_by_fields(
+      #     path: 'nested_path',
+      #     fields: ['name'],
+      #     query: 'Fulliautomatix')
+      #   )
+      #     => all objects containing 'Fulliautomatix' in nested_path.name
+      #
+      # CAUTION: this will fail if the field is not of nested type
+      #
+      # @param path [String]
+      # @param fields [Array]
+      # @param query [String]
+      # @return [Hash]
+      def nested_search_by_fields(path:, fields:, query:)
+        { nested: {
+          path: path, query:
+            { multi_match: { fields: fields.map { |f| "#{path}.#{f}" }, query: query }
+          }
+        } }
+      end
+
+      # Atomic function for search by, should not be called from the outside of this module
+      #
+      # @param field [String]
+      # @param value [String|Integer|Array]
+      # @return [Chewy::Query]
+      def unit_search_by(field, value)
+        if value.is_a?(String)
+          search_by_fields(fields: [field.to_s], query: value, query_mode: :must)
+        elsif value.is_a?(Fixnum)
+          query(match: { field => value }).query_mode(:must)
+        elsif value.is_a?(DateTime)
+          # TODO: handle dates
+        elsif value.is_a?(Array)
+          query(bool: { should: value.compact.map { |e| { match: { field => e } } } })
+        end
+      end
+
+      # This should not be called from the outside of this module,
+      # use active_filter or inactive_filter instead.
+      #
+      # @param locales [Array] list of locales on the context
+      # @param active [Boolean] true to have the active records, false to have the inactive records
+      # @return [ChewyIndex::Query]
+      def activation_status_filter(locales:, active:)
+        filter_mode = active ? :or : :and
+        results = []
+        locales.each do |locale|
+          filter_hash = { term: { active_locales: locale } }
+          filter_hash = { not: filter_hash } unless active
+          results << filter_hash
+        end
+        filter(filter_mode => results)
+      end
+
+      # This should not be called from the outside of this module,
+      # call autcomplete or search_by instead.
+      #
+      # @oaram fields [Array]
+      # @param query [String]
+      # @param locale [String]
+      # @return [Chewy::Query]
+      def search_by_fields_with_locale(fields:, query:, locale:)
+        query(
+          nested: { path: 'translations', query: { bool: {
+            must: [
+              { multi_match: { fields: fields.map { |f| "translations.#{f}" }, query: query } },
+              { match: { 'translations.locale' => locale } }
+            ]
+          } } }
+        )
+      end
+
+      # Generate the array of all the translated fields of the current index
+      # @return [Array]
+      def translated_fields
+        @_translated_fields ||= current_index.mappings_hash[:mappings].
+          values.first.values.first[:translations].
+          try(:[], :properties).try(:keys).try(:map, &:to_s)
+      end
+
+      # Name of the current index
+      # @return [Class]
+      def current_index
+        self.class.to_s.split(':').first.constantize
+      end
+    end
+  end
+end

data/lib/chewy/translation/version.rb

@@ -0,0 +1,5 @@
+module Chewy
+  module Translation
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: chewy-translation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JobTeaser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Index and search on translated content with chewy.
+email:
+- dev@jobteaser.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chewy-translation.gemspec
+- lib/chewy/translation.rb
+- lib/chewy/translation/index.rb
+- lib/chewy/translation/query.rb
+- lib/chewy/translation/version.rb
+homepage: https://github.com/jobteaser/chewy-translation
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Index and search on translated content with chewy.
+test_files: []