elastics-rails 1.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2013 by Domizio Demichelis
+
+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,19 @@
+# elastics-rails
+
+[![Gem Version](https://badge.fury.io/rb/elastics-rails.png)](http://badge.fury.io/rb/elastics-rails)
+
+Integrates all the elastics gems with `Rails`, providing also specific tasks, generators, helpers, logger options, etc.
+
+## Links
+
+- __Gem-Specific Documentation__
+  - [elastics-rails](http://elastics.github.io/elastics/doc/5-elastics-rails)
+
+## Credits
+
+Special thanks for their sponsorship to [Escalate Media](http://www.escalatemedia.com) and [Barquin International](http://www.barquin.com).
+
+## Copyright
+
+Copyright (c) 2012-2013 by [Domizio Demichelis](mailto://dd.nexus@gmail.com)<br>
+See [LICENSE](https://github.com/elastics/elastics/blob/master/elastics-rails/LICENSE) for details.

data/VERSION

@@ -0,0 +1 @@
+1.0.4

data/elastics-rails.gemspec

@@ -0,0 +1,24 @@
+require 'date'
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name                      = 'elastics-rails'
+  s.summary                   = 'Rails integration for Elastics'
+  s.description               = 'Provides the engine, generators and helpers to integrate Elastics with Rails'
+  s.homepage                  = 'http://elastics.github.io/elastics'
+  s.authors                   = ["Domizio Demichelis"]
+  s.email                     = 'dd.nexus@gmail.com'
+  s.files                     = `git ls-files -z`.split("\0")
+  s.version                   = version
+  s.date                      = Date.today.to_s
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rdoc_options              = %w[--charset=UTF-8]
+  s.license                   = 'MIT'
+
+  s.add_runtime_dependency 'rails', '>=2.0'
+
+  s.add_runtime_dependency 'elastics-client',        version
+  s.add_runtime_dependency 'elastics-models', version
+
+  s.add_runtime_dependency 'prompter', '~> 0.1.5'
+end

data/lib/elastics-rails.rb

@@ -0,0 +1,20 @@
+require 'elastics'
+require 'elastics-models'
+require 'rails'
+require 'elastics/result/rails_helper'
+require 'elastics/rails/helper'
+require 'elastics/rails/logger'
+
+Elastics::LIB_PATHS << File.dirname(__FILE__)
+
+if ::Rails.respond_to?(:version) && ::Rails.version.to_i >= 3
+  require 'elastics/rails/engine'
+else
+  Elastics::Conf.configure do |c|
+    c.config_file       = "#{RAILS_ROOT}/config/elastics.yml"
+    c.elastics_dir       = "#{RAILS_ROOT}app/elastics"
+    c.logger            = Logger.new(STDOUT)
+    c.logger.level      = ::Logger::DEBUG if RAILS_ENV == 'development'
+    c.result_extenders |= [ Elastics::Result::RailsHelper ]
+  end
+end

data/lib/elastics/rails/engine.rb

@@ -0,0 +1,39 @@
+module Elastics
+  module Rails
+    class Engine < ::Rails::Engine
+
+      ActiveSupport.on_load(:before_configuration) do
+        config.elastics = Conf
+        config.elastics.variables[:index] = [self.class.name.split('::').first.underscore, ::Rails.env].join('_')
+        config.elastics.config_file       = ::Rails.root.join('config', 'elastics.yml').to_s
+        config.elastics.elastics_dir       = ::Rails.root.join('app', 'elastics').to_s
+        config.elastics.logger            = Logger.new(STDOUT)
+        config.elastics.logger.level      = ::Logger::DEBUG if ::Rails.env.development?
+        config.elastics.result_extenders |= [ Elastics::Result::RailsHelper ]
+      end
+
+      ActiveSupport.on_load(:after_initialize) do
+        Helper.after_initialize
+      end
+
+      rake_tasks do
+        Elastics::LIB_PATHS.each do |path|
+          task_path = "#{path}/tasks.rake"
+          load task_path if File.file?(task_path)
+        end
+      end
+
+      console do
+        config.elastics.logger.log_to_rails_logger = false
+        config.elastics.logger.log_to_stderr       = true
+        config.elastics.logger.debug_variables     = false
+        config.elastics.logger.debug_result        = false
+      end
+
+      config.to_prepare do
+        Elastics.reload!
+      end
+
+    end
+  end
+end

data/lib/elastics/rails/helper.rb

@@ -0,0 +1,14 @@
+module Elastics
+  module Rails
+    module Helper
+      extend self
+
+      def after_initialize
+        # we need to reload the elastics API methods with the new variables
+        Elastics.reload!
+        Conf.elastics_models && Conf.elastics_models.each {|m| eval"::#{m}" if m.is_a?(String) }
+      end
+
+    end
+  end
+end

data/lib/elastics/rails/logger.rb

@@ -0,0 +1,29 @@
+module Elastics
+  module Rails
+    class Logger < Elastics::Logger
+
+      attr_accessor :log_to_rails_logger, :log_to_stderr
+
+      def initialize(*)
+        super
+        self.formatter = proc do |severity, datetime, progname, msg|
+          elastics_formatted = elastics_format(severity, msg)
+          ::Rails.logger.send(severity.downcase.to_sym, elastics_formatted) if log_to_rails_logger && ::Rails.logger.respond_to?(severity.downcase.to_sym)
+          elastics_formatted if log_to_stderr
+        end
+        @log_to_rails_logger = true
+        @log_to_stderr       = false
+      end
+
+      def log_to_stdout
+        Deprecation.warn 'Flex::Configuration.logger.log_to_stdout', 'Elastics::Configuration.logger.log_to_stderr'
+        log_to_stderr
+      end
+      def log_to_stdout=(val)
+        Deprecation.warn 'Flex::Configuration.logger.log_to_stdout=', 'Elastics::Configuration.logger.log_to_stderr='
+        self.log_to_stderr = val
+      end
+
+    end
+  end
+end

data/lib/elastics/result/rails_helper.rb

@@ -0,0 +1,48 @@
+module Elastics
+  class Result
+    module RailsHelper
+
+      module Highlighter
+
+        RE = /highlighted_(\w+)/
+
+        def respond_to?(meth, private=false)
+          meth.to_s =~ RE
+          !!$1 || super
+        end
+
+        def method_missing(meth, *args, &block)
+          meth.to_s =~ RE
+          attribute = $1
+          if attribute
+            opts = {:fragment_separator => ' ... '}.merge(args.first||{})
+            if self['highlight']
+              key, high = self['highlight'].find { |k,v| k.gsub('.','_') == attribute }
+              high = Array.wrap(high) if high
+            end
+            if high.blank?
+              respond_to?(attribute.to_sym) ? send(attribute.to_sym) : ''
+            else
+              high.join(opts[:fragment_separator]).html_safe
+            end
+          else
+            super
+          end
+        end
+
+      end
+
+
+      # extend if result is a Search or MultiGet
+      def self.should_extend?(result)
+        result.is_a?(Search) || result.is_a?(MultiGet)
+      end
+
+      # extend the collection on extend
+      def self.extended(result)
+        result.collection.each { |h| h.extend(Highlighter) }
+      end
+
+    end
+  end
+end

data/lib/generators/elastics/setup/setup_generator.rb

@@ -0,0 +1,53 @@
+require 'prompter'
+
+class Elastics::SetupGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.banner
+    "rails generate elastics:setup"
+  end
+
+  def ask_base_name
+    @module_name   = Prompter.ask('Please, enter a class name for your Search class. Choose a name not defined in your app.',
+                                  :default => 'Elasticsearch', :hint => '[<enter>=Elasticsearch]')
+    @extender_name = "#{@module_name}Extender"
+  end
+
+  def add_config_elastics_file
+    template 'elastics_config.yml', Rails.root.join('config', 'elastics.yml')
+  end
+
+  def create_initializer_file
+    template 'elastics_initializer.rb.erb', Rails.root.join('config', 'initializers', 'elastics.rb')
+  end
+
+  def create_elastics_dir
+    template 'elastics_dir/elastics.rb.erb',          Rails.root.join('app', 'elastics', "#{@module_name.underscore}.rb")
+    template 'elastics_dir/elastics.yml.erb',         Rails.root.join('app', 'elastics', "#{@module_name.underscore}.yml")
+    template 'elastics_dir/elastics_extender.rb.erb', Rails.root.join('app', 'elastics', "#{@extender_name.underscore}.rb")
+  end
+
+
+  def show_setup_message
+    Prompter.say <<-text, :style => :green
+
+    Setup done!
+
+    During prototyping, remember also:
+
+      1. each time you include a new Elastics::ModelIndexer
+         you should add its name to the config.elastics_model in "config/initializers/elastics.rb"
+
+      2. each time you include a new Elastics::ActiveModel
+         you should add its name to the config.elastics_active_model in "config/initializers/elastics.rb"
+
+      3. each time you add/change a elastics.parent relation you should reindex
+
+    The complete documentation is available at https://github.com/elastics/elastics-doc/doc
+    If you have any problem with Elastics, please report the issue at https://github.com/elastics/elastics/issues.
+    text
+  end
+
+end
+

data/lib/generators/elastics/setup/templates/elastics_config.yml

@@ -0,0 +1,18 @@
+# ANCHORS literal key: it will not be used as template
+# you can store here fragments of structures to reuse below
+ANCHORS:
+  -
+
+# This is a dynamic index name.
+# The default index name generated by Elastics is usually <application_name>_<environment>,
+# but you may have changed it in the initializers/elastics.rb or you can hardcode it if you prefer.
+# The settings and mapping below will work with any index (providing that it is a single index).
+# If you set it as an array of indices, you must edit this file accordingly, providing one entry per index.
+<%%= Elastics::Configuration.variables[:index] %>:
+
+  settings:
+    number_of_shards: 5
+    number_of_replicas: 1
+
+  # add your custom mappings here
+  mappings: {}

data/lib/generators/elastics/setup/templates/elastics_dir/elastics.rb.erb

@@ -0,0 +1,23 @@
+# inspect the methods loaded in this module and their usage
+# in the rails console by just typing:
+# >> puts <%= @module_name %>.elastics.doc
+# you can eventually restrict the doc to a single method by pasing its name:
+# >> puts <%= @module_name %>.elastics.doc :search
+# see the detailed doc for this feature at http://elastics.github.io/elastics/doc/2-elastics/4-Self-Documentation.html
+
+module <%= @module_name %>
+
+  extend self
+
+  # if you don't use elastics scopes and you stick with elastics templates, you can comment the next line
+  include Elastics::Scopes
+
+  # enables the templating
+  include Elastics::Templates
+  # loads the <%= "#{@module_name.underscore}.yml" %> file
+  elastics.load_search_source
+
+  # you may need to add more method here, usually custom scopes
+  # or wrapper methods that use one of the autogenerated methods from the loaded templates
+
+end

data/lib/generators/elastics/setup/templates/elastics_dir/elastics.yml.erb

@@ -0,0 +1,22 @@
+# Add here your search queries
+# see the detailed Source documentation at http://elastics.github.io/elastics/doc/2-elastics/2-Templating/2-Sources.html
+
+
+# ANCHORS litheral key: it will not be used as template
+# you can store here fragments of queries to reuse in the templates below
+ANCHORS:
+  -
+
+# this is a a basic template loaded in your class <%= @module_name %>
+# it defines the 'q' tag. You can check its usage from the rails console by just typing:
+# >> puts <%= @module_name %>.elastics.doc
+# You can eventually restrict the doc to a single method by pasing its name:
+# >> puts <%= @module_name %>.elastics.doc :search
+# see the detailed doc for this feature at http://elastics.github.io/elastics/doc/2-elastics/4-Self-Documentation.html
+
+# the :cleanable_query is a special variable that get cleaned up if contains illegal characters for the Lucene syntax
+search:
+- query:
+    query_string:
+      query: <<cleanable_query= "*">>
+

data/lib/generators/elastics/setup/templates/elastics_dir/elastics_extender.rb.erb

@@ -0,0 +1,17 @@
+# see the detailed Extenders documentation at http://elastics.github.io/elastics/doc/2-elastics/3-Result-Extenders.html
+
+module <%= @extender_name  %>
+
+  # set this method to restrict this extender to certain types of results
+  # see the other Elastics extenders for reference
+  def self.should_extend?(response)
+    false
+  end
+
+  # adds your methods
+
+  def an_extending_method
+    # self is the structure returned by ES
+  end
+
+end

data/lib/generators/elastics/setup/templates/elastics_initializer.rb.erb

@@ -0,0 +1,54 @@
+# see the detailed Configuration documentation at http://elastics.github.io/elastics/doc/1-Global-Doc/3-Configuration.html
+
+Elastics::Configuration.configure do |config|
+
+  # you must add your indexed model names here
+  config.elastics_models = %w[  ]
+
+  # you must add your active model names here
+  config.elastics_active_models = %w[  ]
+
+  # Add the your result extenders here
+  config.result_extenders |= [ <%= "#{@extender_name}" %> ]
+
+  # Add the default variables here:
+  # see also the details Variables documentation at http://elastics.github.io/elastics/doc/2-elastics/2-Templating/4-Variables.html
+  # config.variables.deep_merge! :index    => 'my_index',
+  #                              :type     => 'project',
+  #                              :anything => 'anything
+
+  # used by the live-reindex feature
+  # if you change it you must deploy the change first, then you can live-reindex in any next deploy
+  # read the documentation at http://elastics.github.io/elastics/doc/2-elastics/7-Live-Reindex.html#elasticsconfigurationapp_id
+  config.app_id = '<%= Time.now.strftime('%Y%m%d%H%M%S_') + Rails.application.class.name.split('::').first.underscore %>_' + Rails.env
+
+  # used by the live-reindex feature
+  # Uncomment and set the redis client only if you don't want to use the redis default client
+  # config.redis = Redis.new(:host => somehost, :port: 6379, :db = 1)
+
+
+  # Logger variables: see http://elastics.github.io/elastics/doc/1-Global-Doc/3-Configuration.html
+  # config.logger.debug_variables = false
+  # config.logger.debug_request   = false
+  # config.logger.debug_result    = false
+  # config.logger.curl_format     = false
+
+  # Custom config file path
+  # config.config_file = '/custom/path/to/elastics.yml',
+
+  # Custom elastics dir path
+  # config.elastics_dir = '/custom/path/to/elastics',
+
+  # The custom http_client you may want to implement
+  # config.http_client = Your::Client.new
+
+  # The custom url of your Elasticsearch server
+  # config.http_client.base_uri = 'http://localhost:9200'
+
+  # The options passed to the http_client. They are client specific.
+  # config.http_client.options = {:timeout => 5}
+
+  # Experimental: checks the response and returns a boolean (should raise?)
+  # config.http_client.raise_proc = proc{|response| response.status >= 400}
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: elastics-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Domizio Demichelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: elastics-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: elastics-models
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: prompter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+description: Provides the engine, generators and helpers to integrate Elastics with
+  Rails
+email: dd.nexus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- elastics-rails.gemspec
+- lib/elastics-rails.rb
+- lib/elastics/rails/engine.rb
+- lib/elastics/rails/helper.rb
+- lib/elastics/rails/logger.rb
+- lib/elastics/result/rails_helper.rb
+- lib/generators/elastics/setup/setup_generator.rb
+- lib/generators/elastics/setup/templates/elastics_config.yml
+- lib/generators/elastics/setup/templates/elastics_dir/elastics.rb.erb
+- lib/generators/elastics/setup/templates/elastics_dir/elastics.yml.erb
+- lib/generators/elastics/setup/templates/elastics_dir/elastics_extender.rb.erb
+- lib/generators/elastics/setup/templates/elastics_initializer.rb.erb
+homepage: http://elastics.github.io/elastics
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails integration for Elastics
+test_files: []