alchemy-pg_search 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49d88251b2d43c33f9512645a9d2a47f99370b91392dff0752bfa7827dab9484
+  data.tar.gz: 2b402676acaf93b70bb00c900f509bdc3fb2afedf8682040410ff4d0e75187ef
+SHA512:
+  metadata.gz: 5ea033157ed66c0ac4f198d1879f9a78102a237f33977b9f43a0165e4e988baef011f1e28fc1e456e747c1ed134275526293da84f6d181019f668afeedf323e9
+  data.tar.gz: c7bb6894fad22d584ce463e72f57b261d3aa38de6abcd33e80eea39c2e8c55ebad30a279cb96acf9cb07a63a66a10dcbc52e6bb4e93675aeaad588a47a1960b8

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+Gemfile.lock
+.rspec
+spec/dummy/log/*.log
+spec/dummy/db/*.sqlite3*
+spec/dummy/tmp/*
+.ruby-*

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+branches:
+  only:
+    - master
+before_script: 'rake alchemy:spec:prepare'
+script: rspec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 1.2.0 (2018-11-28)
+
+- Rename the #search method into #full_text_search [#14](https://github.com/AlchemyCMS/alchemy-pg_search/pull/14) by [tvdeyen](https://github.com/tvdeyen)
+- Add a page search scope class [#13](https://github.com/AlchemyCMS/alchemy-pg_search/pull/13) by [tvdeyen](https://github.com/tvdeyen)

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'alchemy_cms', github: 'AlchemyCMS/alchemy_cms', branch: '3.6-stable'
+gem 'sassc-rails'
+gem 'pg', '< 1.0'
+
+group :test do
+  gem 'factory_girl_rails'
+  gem "capybara"
+  gem "pry"
+  gem 'launchy'
+end

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014, magic labs GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+  Neither the name of the magic labs GmbH nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,136 @@
+[![Build Status](https://travis-ci.org/AlchemyCMS/alchemy-pg_search.svg?branch=master)](https://travis-ci.org/AlchemyCMS/alchemy-pg_search)
+
+# Alchemy CMS Postgresql Fulltext Search
+
+This gem provides full text search for projects using postgresql databases to Alchemy CMS 3.3 and above.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'alchemy-pg_search', github: 'AlchemyCMS/alchemy-pg_search', branch: 'master'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Add migrations:
+
+```shell
+$ bin/rake alchemy_pg_search:install:migrations
+$ bin/rake db:migrate
+```
+
+## Usage
+
+Every `EssenceText`, `EssenceRichtext` and `EssencePicture` will be indexed unless you tell Alchemy to not index a specific content.
+
+### Disable Indexing
+
+Simply pass `searchable: false` to your content definitions and Alchemy will not index results from that particular content.
+
+```yaml
+# elements.yml
+- name: secrets
+  contents:
+  - name: passwords
+    type: EssenceText
+    searchable: false
+    default: 'This is my secret password.'
+```
+
+### Rendering search results.
+
+In order to render the search results, you'll need a page layout that represents the search result page. Simply mark a page layout as `searchresults: true`. The search form will pick this page as result page.
+
+#### Search Results Page
+
+```yaml
+# page_layouts.yml
+- name: search
+  searchresults: true
+  unique: true
+```
+
+Tip: For maximum flexibility you could also add an element that represents the search results. This lets your editors to place additional elements (maybe a header image or additional text blocks) on the search result page.
+
+```yaml
+# page_layouts.yml
+- name: search
+  searchresults: true
+  unique: true
+  elements:
+  - searchresults
+  autogenerate:
+  - searchresults
+
+# elements.yml
+- name: searchresults
+  unique: true
+```
+
+and then use the view helpers to render the search form on the page layout partial and the search results on the element view partial.
+
+### View Helpers
+
+This gem provides some helper methods that let you render the form and the search results.
+
+* Render the search form:
+  `render_search_form`
+
+* Render the search results:
+  `render_search_results`
+
+### Customize Views
+
+If you want to override the search form and search result views please use this generator.
+
+```shell
+$ bin/rails g alchemy:pg_search:views
+```
+
+### Translating Views
+
+The views are fully translatable. German and english translations are already provided with this gem.
+
+If you want add your own translation, just place a locale file into your projects `config/locales` folder.
+
+Here is the english example:
+
+```yaml
+en:
+  alchemy:
+
+    search_form:
+      placeholder: 'Search query'
+      submit: 'Search'
+
+    search_result_page:
+      result_page: Page
+      no_results: "Your search for '%{query}' offers no result"
+      result_heading: "Your search for '%{query}'"
+      result_count:
+        one: 'Offers one result'
+        other: 'Offers %{count} results'
+```
+
+## Upgrading
+
+If you are upgrading from an old Alchemy < 3.0 based project that uses the ferret based full text search, please run this handy generator:
+
+```shell
+$ bin/rails g alchemy:pg_search:upgrade
+$ bin/rake db:migrate
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,46 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+desc 'Generate documentation for Alchemy CMS.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Alchemy PgSearch'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => ['alchemy:spec:prepare', :spec]
+
+Bundler::GemHelper.install_tasks
+
+namespace :alchemy do
+  namespace :spec do
+
+    desc "Prepares database for testing"
+    task :prepare do
+      system 'cd spec/dummy; RAILS_ENV=test bin/rake db:setup db:seed; cd -'
+    end
+  end
+end

data/alchemy-pg_search.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alchemy/pg_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alchemy-pg_search"
+  spec.version       = Alchemy::PgSearch::VERSION
+  spec.authors       = ["Thomas von Deyen"]
+  spec.email         = ["alchemy@magiclabs.de"]
+  spec.description   = %q{PostgreSQL search for Alchemy CMS 3.0}
+  spec.summary       = %q{This gem provides PostgreSQL full text search to Alchemy 3.0}
+  spec.homepage      = "http://alchemy-cms.com"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "alchemy_cms", ["> 3.2", "< 4.0"]
+  spec.add_runtime_dependency "pg_search", ["~> 0.7"]
+  spec.add_runtime_dependency "pg"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+end

data/app/helpers/alchemy/pg_search/search_helper.rb

@@ -0,0 +1,53 @@
+module Alchemy
+  module PgSearch
+    module SearchHelper
+
+      # Renders a search form
+      #
+      # It queries the controller and then redirects to the search result page.
+      #
+      # === Example search results page layout
+      #
+      # Only performs the search if ferret is enabled in your +config/alchemy/config.yml+ and
+      # a page is present that is flagged with +searchresults+ true.
+      #
+      #   # config/alchemy/page_layouts.yml
+      #   - name: search
+      #     searchresults: true # Flag as search result page
+      #
+      # === Note
+      #
+      # The search result page will not be cached.
+      #
+      # @option options html5 [Boolean] (true) Should the search form be of type search or not?
+      # @option options class [String] (fulltext_search) The default css class of the form
+      # @option options id [String] (search) The default css id of the form
+      #
+      def render_search_form(options={})
+        default_options = {
+          html5: false,
+          class: 'fulltext_search',
+          id: 'search'
+        }
+        render 'alchemy/search/form', options: default_options.merge(options), search_result_page: search_result_page
+      end
+
+      # Renders the search results partial within +app/views/alchemy/search/_results.html+
+      #
+      # @option options show_result_count [Boolean] (true) Should the count of results be displayed or not?
+      # @option options show_heading [Boolean] (true) Should the heading be displayed or not?
+      #
+      def render_search_results(options={})
+        default_options = {
+          show_result_count: true,
+          show_heading: true
+        }
+        render 'alchemy/search/results', options: default_options.merge(options)
+      end
+
+      def highlighted_excerpt(text, phrase, radius = 50)
+        highlight(excerpt(text, phrase, radius: radius).to_s, phrase)
+      end
+    end
+  end
+end

data/app/views/alchemy/search/_form.html.erb

@@ -0,0 +1,12 @@
+<% if search_result_page %>
+  <%= form_tag show_alchemy_page_path(search_result_page),
+    method: 'get', id: options[:id], class: options[:class] do %>
+    <% if options[:html5] %>
+      <%= search_field_tag :query, params[:query],
+        placeholder: Alchemy.t(:placeholder, scope: 'search_form') %>
+    <% else %>
+      <%= text_field_tag(:query, params[:query]) %>
+    <% end %>
+    <%= submit_tag Alchemy.t(:submit, scope: 'search_form'), name: nil %>
+  <% end %>
+<% end %>

data/app/views/alchemy/search/_result.html.erb

@@ -0,0 +1,13 @@
+<li class="search_result">
+  <h3><%= link_to page.name, show_alchemy_page_path(page) %></h3>
+  <% if elements.any? %>
+    <% elements.each do |element| %>
+      <% element.searchable_contents.each do |content| %>
+      <p><%= highlighted_excerpt(content.searchable_ingredient.to_s, params[:query]) %></p>
+      <% end %>
+    <% end %>
+  <% else %>
+    <p><%= page.meta_description %></p>
+  <% end %>
+  <p><%= link_to page.urlname, show_alchemy_page_path(page) %></p>
+</li>

data/app/views/alchemy/search/_results.html.erb

@@ -0,0 +1,26 @@
+<div class="search_results">
+  <% if @search_results.blank? %>
+    <h2 class="no_search_results">
+      <%= raw Alchemy.t('search_result_page.no_results', query: h(params[:query])) %>
+    </h2>
+  <% else %>
+    <h2 class="search_results_heading">
+      <%= raw Alchemy.t("search_result_page.result_heading", query: h(params[:query])) %>
+      <%= Alchemy.t("search_result_page.result_count",
+        count: @search_results.try(:total_count) || @search_results.size) %>
+    </h2>
+    <ul class="search_result_list">
+      <% @search_results.each do |page| %>
+        <%= render('alchemy/search/result',
+          elements: page.element_search_results(params[:query]),
+          options: options,
+          page: page
+        ) %>
+      <% end %>
+    </ul>
+  <% end %>
+</div>
+
+<% if @search_results.try(:total_pages) %>
+  <%= paginate @search_results %>
+<% end %>

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/alchemy_pg_search/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/alchemy.search.de.yml

@@ -0,0 +1,14 @@
+de:
+  alchemy:
+
+    search_form:
+      placeholder: 'Suchbegriff'
+      submit: 'Suchen'
+
+    search_result_page:
+      result_page: Seite
+      no_results: "Ihre Suche nach '%{query}' ergab keine Treffer."
+      result_heading: "Ihre Suche nach '%{query}'"
+      result_count:
+        one: "ergab einen Treffer"
+        other: "ergab %{count} Treffer"

data/config/locales/alchemy.search.en.yml

@@ -0,0 +1,14 @@
+en:
+  alchemy:
+
+    search_form:
+      placeholder: 'Search query'
+      submit: 'Search'
+
+    search_result_page:
+      result_page: Page
+      no_results: "Your search for '%{query}' returned no result"
+      result_heading: "Your search for '%{query}'"
+      result_count:
+        one: 'returned one result'
+        other: 'returned %{count} results'

data/db/migrate/20141211105526_add_searchable_to_alchemy_essence_texts.rb

@@ -0,0 +1,5 @@
+class AddSearchableToAlchemyEssenceTexts < ActiveRecord::Migration
+  def change
+    add_column :alchemy_essence_texts, :searchable, :boolean, default: true
+  end
+end

data/db/migrate/20141211105942_add_searchable_to_alchemy_essence_richtexts.rb

@@ -0,0 +1,5 @@
+class AddSearchableToAlchemyEssenceRichtexts < ActiveRecord::Migration
+  def change
+    add_column :alchemy_essence_richtexts, :searchable, :boolean, default: true
+  end
+end

data/db/migrate/20141211110126_add_searchable_to_alchemy_essence_pictures.rb

@@ -0,0 +1,5 @@
+class AddSearchableToAlchemyEssencePictures < ActiveRecord::Migration
+  def change
+    add_column :alchemy_essence_pictures, :searchable, :boolean, default: true
+  end
+end

data/lib/alchemy-pg_search.rb

@@ -0,0 +1,23 @@
+require "alchemy/pg_search/engine"
+require "alchemy/pg_search/config"
+require "alchemy/pg_search/page_search_scope"
+
+module Alchemy
+  module PgSearch
+    SEARCHABLE_ESSENCES = %w(EssenceText EssenceRichtext EssencePicture)
+    DEFAULT_CONFIG = {
+      page_search_scope: PageSearchScope.new
+    }
+
+    extend Config
+    self.config = DEFAULT_CONFIG
+
+    def self.is_searchable_essence?(essence_type)
+      SEARCHABLE_ESSENCES.include?(essence_type)
+    end
+
+    def self.searchable_essence_classes
+      SEARCHABLE_ESSENCES.map { |k| "Alchemy::#{k.classify}".constantize }
+    end
+  end
+end

data/lib/alchemy/pg_search/config.rb

@@ -0,0 +1,17 @@
+module Alchemy
+  module PgSearch
+    module Config
+      @@config = {
+        paginate_per: 10
+      }
+
+      def config=(settings)
+        @@config.merge!(settings)
+      end
+
+      def config
+        @@config
+      end
+    end
+  end
+end

data/lib/alchemy/pg_search/content_extension.rb

@@ -0,0 +1,30 @@
+Alchemy::Content.class_eval do
+
+  # Prepares the attributes for creating the essence.
+  #
+  # 1. It sets a default text if given in +elements.yml+
+  # 2. It sets searchable value for EssenceText, EssencePicture and EssenceRichtext essences
+  #
+  def prepared_attributes_for_essence
+    attributes = {
+      ingredient: default_text(definition['default'])
+    }
+    if Alchemy::PgSearch.is_searchable_essence?(definition['type'])
+      attributes.merge!(searchable: definition.fetch('searchable', true))
+    end
+    attributes
+  end
+
+  def searchable_ingredient
+    case essence_type
+    when 'Alchemy::EssencePicture'
+      then essence.caption
+    when 'Alchemy::EssenceRichtext'
+      then essence.stripped_body
+    when 'Alchemy::EssenceText'
+      then essence.body
+    else
+      ingredient
+    end
+  end
+end

data/lib/alchemy/pg_search/controller_methods.rb

@@ -0,0 +1,92 @@
+module Alchemy
+  module PgSearch
+
+    # Provides full text search methods in your controller
+    #
+    module ControllerMethods
+
+      # Adds a +before_action+ to your controller
+      #
+      def self.included(controller)
+        controller.send(:before_action, :perform_search, only: :show)
+        controller.send(:helper_method, :search_result_page)
+        controller.send(:helper, Alchemy::PgSearch::SearchHelper)
+      end
+
+      private
+
+      # Performs a full text search with +PgSearch+.
+      #
+      # Gets invoked everytime 'query' is given in params.
+      #
+      # This method only sets the +@search_results+ instance variable.
+      #
+      # You have to redirect to the search result page within a search form.
+      #
+      # === Alchemy provides a handy helper for rendering the search form:
+      #
+      #  render_search_form
+      #
+      # === Note
+      #
+      # If in preview mode a fake search value "lorem" will be set.
+      #
+      # @see Alchemy::PagesHelper#render_search_form
+      #
+      def perform_search
+        if self.class == Alchemy::Admin::PagesController && params[:query].blank?
+          params[:query] = 'lorem'
+        end
+        return if params[:query].blank?
+        @search_results = search_results
+        if paginate_per
+          @search_results = @search_results.page(params[:page]).per(paginate_per)
+        end
+      end
+
+      # Find Pages that have what is provided in "query" param with PgSearch
+      #
+      # @return [Array]
+      #
+      def search_results
+        pages = Alchemy::PgSearch.config[:page_search_scope].pages
+        # Since CanCan cannot (oh the irony) merge +accessible_by+ scope with pg_search scopes,
+        # we need to fake a page object here
+        if can? :show, Alchemy::Page.new(restricted: true, public_on: Date.current)
+          pages.full_text_search(params[:query])
+        else
+          pages.not_restricted.full_text_search(params[:query])
+        end
+      end
+
+      # A view helper that loads the search result page.
+      #
+      # @return [Alchemy::Page]
+      #
+      def search_result_page
+        @search_result_page ||= begin
+          page = Page.published.find_by(
+            page_layout: search_result_page_layout['name'],
+            language_id: Language.current.id
+          )
+          if page.nil?
+            logger.warn "\n++++++\nNo published search result page found. Please create one or publish your search result page.\n++++++\n"
+          end
+          page
+        end
+      end
+
+      def search_result_page_layout
+        page_layout = PageLayout.get_all_by_attributes(searchresults: true).first
+        if page_layout.nil?
+          raise "No searchresults page layout found. Please add page layout with `searchresults: true` into your `page_layouts.yml` file."
+        end
+        page_layout
+      end
+
+      def paginate_per
+        Alchemy::PgSearch.config[:paginate_per]
+      end
+    end
+  end
+end

data/lib/alchemy/pg_search/element_extension.rb

@@ -0,0 +1,40 @@
+Alchemy::Element.class_eval do
+  include PgSearch
+
+  pg_search_scope :full_text_search,
+    associated_against: {
+      searchable_essence_texts:     :body,
+      searchable_essence_richtexts: :stripped_body,
+      searchable_essence_pictures:  :caption
+    },
+    using: {
+      tsearch: {prefix: true}
+    }
+
+  has_many :searchable_essence_texts,
+    -> { joins(:element).where(searchable: true, alchemy_elements: {public: true}) },
+    class_name: 'Alchemy::EssenceText',
+    source_type: 'Alchemy::EssenceText',
+    through: :contents,
+    source: :essence
+
+  has_many :searchable_essence_richtexts,
+    -> { joins(:element).where(searchable: true, alchemy_elements: {public: true}) },
+    class_name: 'Alchemy::EssenceRichtext',
+    source_type: 'Alchemy::EssenceRichtext',
+    through: :contents,
+    source: :essence
+
+  has_many :searchable_essence_pictures,
+    -> { joins(:element).where(searchable: true, alchemy_elements: {public: true}) },
+    class_name: 'Alchemy::EssencePicture',
+    source_type: 'Alchemy::EssencePicture',
+    through: :contents,
+    source: :essence
+
+  has_many :searchable_contents,
+    -> { where(essence_type: ['Alchemy::EssenceText', 'Alchemy::EssenceRichtext', 'Alchemy::EssencePicture']) },
+    class_name: 'Alchemy::Content',
+    source: :contents
+
+end

data/lib/alchemy/pg_search/engine.rb

@@ -0,0 +1,26 @@
+require 'alchemy_cms'
+require 'pg_search'
+
+module Alchemy
+  module PgSearch
+    class Engine < ::Rails::Engine
+      engine_name 'alchemy_pg_search'
+
+      config.to_prepare do
+        require_relative "./content_extension"
+        require_relative './controller_methods'
+        require_relative "./element_extension"
+        require_relative "./page_extension"
+        require_relative './searchable'
+
+        # We need to have the search methods present in all Alchemy controllers
+        Alchemy::BaseController.send(:include, Alchemy::PgSearch::ControllerMethods)
+
+        # Inject searchable attribute persistence into searchable essence classes
+        Alchemy::PgSearch.searchable_essence_classes.each do |klass|
+          klass.send(:include, Alchemy::PgSearch::Searchable)
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/pg_search/page_extension.rb

@@ -0,0 +1,45 @@
+Alchemy::Page.class_eval do
+  include PgSearch
+
+  # Enable Postgresql full text indexing.
+  #
+  pg_search_scope :full_text_search, against: {
+      meta_description: 'B',
+      meta_keywords:    'B',
+      title:            'B',
+      name:             'A'
+    },
+    associated_against: {
+      searchable_essence_texts:     :body,
+      searchable_essence_richtexts: :stripped_body,
+      searchable_essence_pictures:  :caption
+    },
+    using: {
+      tsearch: {prefix: true}
+    }
+
+  has_many :searchable_essence_texts,
+    -> { where(searchable: true, alchemy_elements: {public: true}) },
+    class_name: 'Alchemy::EssenceText',
+    source_type: 'Alchemy::EssenceText',
+    through: :descendent_contents,
+    source: :essence
+
+  has_many :searchable_essence_richtexts,
+    -> { where(searchable: true, alchemy_elements: {public: true}) },
+    class_name: 'Alchemy::EssenceRichtext',
+    source_type: 'Alchemy::EssenceRichtext',
+    through: :descendent_contents,
+    source: :essence
+
+  has_many :searchable_essence_pictures,
+    -> { where(searchable: true, alchemy_elements: {public: true}) },
+    class_name: 'Alchemy::EssencePicture',
+    source_type: 'Alchemy::EssencePicture',
+    through: :descendent_contents,
+    source: :essence
+
+  def element_search_results(query)
+    descendent_elements.full_text_search(query)
+  end
+end

data/lib/alchemy/pg_search/page_search_scope.rb

@@ -0,0 +1,9 @@
+module Alchemy
+  module PgSearch
+    class PageSearchScope
+      def pages
+        Alchemy::Page.published.contentpages.with_language(Alchemy::Language.current.id)
+      end
+    end
+  end
+end

data/lib/alchemy/pg_search/searchable.rb

@@ -0,0 +1,27 @@
+module Alchemy
+  module PgSearch
+
+    # Ensures that the current content definition value for +searchable+ gets persisted.
+    #
+    # It is enabled per default, but you can disable indexing in your +elements.yml+ file.
+    #
+    # === Example
+    #
+    #   name: secrets
+    #   contents:
+    #   - name: confidential
+    #     type: EssenceRichtext
+    #     searchable: false
+    #
+    module Searchable
+      extend ActiveSupport::Concern
+
+      included do
+        before_update do
+          write_attribute(:searchable, definition.fetch('searchable', true))
+          true
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/pg_search/version.rb

@@ -0,0 +1,5 @@
+module Alchemy
+  module PgSearch
+    VERSION = "1.2.0"
+  end
+end

data/lib/generators/alchemy/pg_search/upgrade/templates/migration.rb.tt

@@ -0,0 +1,31 @@
+require 'yaml'
+
+class UpgradeFromAlchemyFerret < ActiveRecord::Migration
+  def up
+    not_searchable_elements.each do |element|
+      element['contents'].each do |content|
+        next unless Alchemy::PgSearch.is_searchable_essence?(content)
+        next if content['searchable'].nil?
+        "Alchemy::#{content['type'].classify}".constantize
+          .joins(content: :element)
+          .where(alchemy_contents: {name: content['name']})
+          .where(alchemy_elements: {name: element['name']})
+          .update_all(searchable: false)
+        say "Sets searchable to false for `#{content['name']}` contents of `#{element['name']}` elements."
+      end
+    end
+  end
+
+  private
+
+  def elements_yml
+    @elements_yml ||= YAML.load_file Rails.root.join('config/alchemy/elements.yml')
+  end
+
+  def not_searchable_elements
+    elements_yml.select do |element|
+      next if !element['contents']
+      element['contents'].any? { |content| content['searchable'] == false }
+    end
+  end
+end

data/lib/generators/alchemy/pg_search/upgrade/upgrade_generator.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+module Alchemy
+  module PgSearch
+    class UpgradeGenerator < ::Rails::Generators::Base
+      desc "This generator upgrades your project from alchemy-ferret based projects."
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def replace_element_config
+        gsub_file Rails.root.join('config/alchemy/elements.yml'),
+          'do_not_index: true', 'searchable: false'
+      end
+
+      def copy_migration_file
+        timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+        copy_file "migration.rb.tt", Rails.root.join("db/migrate/#{timestamp}_upgrade_from_alchemy_ferret.alchemy_pg_search.rb")
+      end
+    end
+  end
+end

data/lib/generators/alchemy/pg_search/views/views_generator.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module Alchemy
+  module PgSearch
+    class ViewsGenerator < ::Rails::Generators::Base
+      desc "This generator copies the search form and result views into your project."
+
+      source_root File.expand_path("../../../../../app/views/alchemy", File.dirname(__FILE__))
+
+      def copy_views
+        directory 'search', Rails.root.join('app/views/alchemy/search')
+      end
+    end
+  end
+end

data/lib/tasks/alchemy/pg_search_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :alchemy_pg_search do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: alchemy-pg_search
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alchemy_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec-rails
+  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: PostgreSQL search for Alchemy CMS 3.0
+email:
+- alchemy@magiclabs.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- alchemy-pg_search.gemspec
+- app/helpers/alchemy/pg_search/search_helper.rb
+- app/views/alchemy/search/_form.html.erb
+- app/views/alchemy/search/_result.html.erb
+- app/views/alchemy/search/_results.html.erb
+- bin/rails
+- config/locales/alchemy.search.de.yml
+- config/locales/alchemy.search.en.yml
+- db/migrate/20141211105526_add_searchable_to_alchemy_essence_texts.rb
+- db/migrate/20141211105942_add_searchable_to_alchemy_essence_richtexts.rb
+- db/migrate/20141211110126_add_searchable_to_alchemy_essence_pictures.rb
+- lib/alchemy-pg_search.rb
+- lib/alchemy/pg_search/config.rb
+- lib/alchemy/pg_search/content_extension.rb
+- lib/alchemy/pg_search/controller_methods.rb
+- lib/alchemy/pg_search/element_extension.rb
+- lib/alchemy/pg_search/engine.rb
+- lib/alchemy/pg_search/page_extension.rb
+- lib/alchemy/pg_search/page_search_scope.rb
+- lib/alchemy/pg_search/searchable.rb
+- lib/alchemy/pg_search/version.rb
+- lib/generators/alchemy/pg_search/upgrade/templates/migration.rb.tt
+- lib/generators/alchemy/pg_search/upgrade/upgrade_generator.rb
+- lib/generators/alchemy/pg_search/views/views_generator.rb
+- lib/tasks/alchemy/pg_search_tasks.rake
+homepage: http://alchemy-cms.com
+licenses:
+- BSD
+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.7.6
+signing_key: 
+specification_version: 4
+summary: This gem provides PostgreSQL full text search to Alchemy 3.0
+test_files: []