gummi 0.3.7 → 0.3.8

data/lib/gummi.rb

@@ -12,6 +12,7 @@ require 'repobahn/entity'
 require 'gummi/version'
 require 'gummi/errors'
 require 'gummi/api'
+require 'gummi/configuration'
 
 require 'gummi/db_layer/index'
 require 'gummi/db_layer/document/attributes'
@@ -39,8 +40,8 @@ require 'gummi/entity_layer/entity'
 
 module Gummi
   def self.env
-    if defined? Rails
-      Rails.env
+    if defined? ::Rails
+      ::Rails.env
     else
       RAILS_ENV || 'development'
     end

data/lib/gummi/configuration.rb

@@ -0,0 +1,38 @@
+require 'logger'
+
+module Gummi
+  class Configuration
+
+    attr_accessor :logger
+
+    def initialize(options={})
+      @logger = options[:logger] || default_logger
+    end
+
+    private
+
+    def default_logger
+      if defined?(Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # Public: Yields the configuration instance.
+  #
+  def self.configure(&block)
+    yield config
+  end
+
+  # Public: Reset the configuration (useful for testing).
+  #
+  def self.reset!
+    @config = nil
+  end
+end

data/lib/gummi/db_layer/default_index.rb

@@ -4,8 +4,8 @@ module Gummi
       include Gummi::DbLayer::Index
 
       def self.name
-        if defined? Rails
-          "#{Rails.application.class.name.deconstantize.underscore}_#{Rails.env}"
+        if defined? ::Rails
+          "#{::Rails.application.class.name.deconstantize.underscore}_#{::Rails.env}"
         else
           "gummi_#{Gummi.env}"
         end

data/lib/gummi/db_layer/document.rb

@@ -152,14 +152,16 @@ module Gummi
         # ––––––––––––––––––––––––
 
         def get!(id, parent_id = nil)
-          options = { index: index.name, type: document_type, id: id, fields: %w{ _source _parent } }
-          if parent_id
-            options.merge! parent: parent_id
-          elsif parent_document_type
-            raise ArgumentError, "The parent_id attribute is required for getting #{name} from Elastic Search"
-          end
-          response = Hashie::Mash.new client.get options
-          hit_to_document response
+            options = { index: index.name, type: document_type, id: id, fields: %w{ _source _parent } }
+            if parent_id
+              options.merge! parent: parent_id
+            elsif parent_document_type
+              raise ArgumentError, "The parent_id attribute is required for getting #{name} from Elastic Search"
+            end
+            response = ActiveSupport::Notifications.instrument "search.elasticsearch", name: "Document#get!", search: options do
+              Hashie::Mash.new client.get options
+            end
+            hit_to_document response
         end
 
         def delete!(id, parent_id = nil)
@@ -169,7 +171,9 @@ module Gummi
           elsif parent_document_type
             raise ArgumentError, "The parent_id attribute is required for getting #{name} from Elastic Search"
           end
-          response = Hashie::Mash.new client.delete options
+          response = ActiveSupport::Notifications.instrument "search.elasticsearch", name: "Document#delete!", search: options do
+            Hashie::Mash.new client.delete options
+          end
           response.ok && response.found
         end
 
@@ -194,7 +198,10 @@ module Gummi
           options = {}
         end
         raise ArgumentError unless [:create, :index].include?(method)
-        response = Hashie::Mash.new client.send(method, options.merge(index: index.name, type: document_type, id: self.id, body: attributes))
+        opts = options.merge(index: index.name, type: document_type, id: self.id, body: attributes)
+        response = ActiveSupport::Notifications.instrument "search.elasticsearch", name: "Document#create(#{method})", search: opts do
+          Hashie::Mash.new client.send(method, opts)
+        end
         if response.ok
           self.id      = response._id
           self.version = response._version

data/lib/gummi/db_layer/document/search/result.rb

@@ -9,7 +9,7 @@ module Gummi
           def initialize(response, converter, per_page, page)
             @success   = !!response
             @response  = Hashie::Mash.new response
-            @took      = @response.hits.took  if @response.hits
+            @took      = @response.took
             @total     = @response.hits.total if @response.hits
             @hits      = @response.hits.hits  if @response.hits
             @facets    = @response.facets || Hashie::Mash.new

data/lib/gummi/db_layer/document/search/searching.rb

@@ -28,7 +28,9 @@ module Gummi
           end
 
           def execute
-            Gummi::DbLayer::Document::Search::Result.new client.search(to_client_args), document_class, per_page, page
+            ActiveSupport::Notifications.instrument "search.elasticsearch", name: "#{self.class.name}#execute", search: to_client_args do
+              Gummi::DbLayer::Document::Search::Result.new client.search(to_client_args), document_class, per_page, page
+            end
           rescue Faraday::Error::ConnectionFailed
             Gummi::DbLayer::Document::Search::Result.new nil, document_class, per_page, page
           end
@@ -51,4 +53,4 @@ module Gummi
       end
     end
   end
-end
+end

data/lib/gummi/db_layer/index.rb

@@ -21,7 +21,10 @@ module Gummi
         #
         def teardown
           raise NotImplementedError if Gummi.env == 'production'
-          response = client.indices.delete index: name
+
+          response = ActiveSupport::Notifications.instrument "search.elasticsearch", name: "Index(#{self.name}).teardown", search: {} do
+            client.indices.delete index: name
+          end
           response.present?
         rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
           true
@@ -32,8 +35,10 @@ module Gummi
         end
 
         def refresh
-          client.indices.refresh
-          client.cluster.health wait_for_status: :yellow
+          ActiveSupport::Notifications.instrument "search.elasticsearch", name: "Index(#{self.name}).refresh", search: {} do
+            client.indices.refresh
+            client.cluster.health wait_for_status: :yellow
+          end
         end
 
         def settings

data/lib/gummi/rails.rb

@@ -0,0 +1,5 @@
+module Gummi
+  module Rails
+
+  end
+end

data/lib/gummi/rails/instrumentation.rb

@@ -0,0 +1,6 @@
+module Gummi
+  module Rails
+    module Instrumentation
+    end
+  end
+end

data/lib/gummi/rails/instrumentation/controller_runtime.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext/module/attr_internal'
+
+module Gummi
+  module Rails
+    module Instrumentation
+
+      # Hooks into ActionController to display Elasticsearch runtime
+      #
+      # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/railties/controller_runtime.rb
+      #
+      module ControllerRuntime
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :elasticsearch_runtime
+
+        def cleanup_view_runtime
+          elasticsearch_rt_before_render = Gummi::Rails::Instrumentation::LogSubscriber.reset_runtime
+          runtime = super
+          elasticsearch_rt_after_render = Gummi::Rails::Instrumentation::LogSubscriber.reset_runtime
+          self.elasticsearch_runtime = elasticsearch_rt_before_render + elasticsearch_rt_after_render
+          runtime - elasticsearch_rt_after_render
+        end
+
+        def append_info_to_payload(payload)
+          super
+          payload[:elasticsearch_runtime] = (elasticsearch_runtime || 0) + Gummi::Rails::Instrumentation::LogSubscriber.reset_runtime
+        end
+
+        module ClassMethods
+          def log_process_action(payload)
+            messages, elasticsearch_runtime = super, payload[:elasticsearch_runtime]
+            messages << ("Elasticsearch: %.1fms" % elasticsearch_runtime.to_f) if elasticsearch_runtime
+            messages
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gummi/rails/instrumentation/log_subscriber.rb

@@ -0,0 +1,43 @@
+module Gummi
+  module Rails
+    module Instrumentation
+
+      # A log subscriber to attach to Elasticsearch related events
+      #
+      # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/log_subscriber.rb
+      #
+      class LogSubscriber < ActiveSupport::LogSubscriber
+        def self.runtime=(value)
+          Thread.current["elasticsearch_runtime"] = value
+        end
+
+        def self.runtime
+          Thread.current["elasticsearch_runtime"] ||= 0
+        end
+
+        def self.reset_runtime
+          rt, self.runtime = runtime, 0
+          rt
+        end
+
+        # Intercept `search.elasticsearch` events, and display them in the Rails log
+        #
+        def search(event)
+          self.class.runtime += event.duration
+          return unless logger.debug?
+          payload = event.payload
+          name    = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+          search  = payload[:search].inspect.gsub(/:(\w+)=>/, '\1: ')
+          logger.debug "#{color(name, GREEN, true)} #{search}"
+        end
+
+        def logger
+          Gummi.config.logger
+        end
+      end
+
+    end
+  end
+end
+
+Gummi::Rails::Instrumentation::LogSubscriber.attach_to :elasticsearch

data/lib/gummi/rails/instrumentation/railtie.rb

@@ -0,0 +1,23 @@
+module Gummi
+  module Rails
+    module Instrumentation
+
+      # Rails initializer class to require Elasticsearch::Rails::Instrumentation files,
+      # set up Elasticsearch::Model and hook into ActionController to display Elasticsearch-related duration
+      #
+      # @see http://edgeguides.rubyonrails.org/active_support_instrumentation.html
+      #
+      class Railtie < ::Rails::Railtie
+        initializer "gummi.instrumentation" do |app|
+          require 'gummi/rails/instrumentation/log_subscriber'
+          require 'gummi/rails/instrumentation/controller_runtime'
+
+          ActiveSupport.on_load(:action_controller) do
+            include Gummi::Rails::Instrumentation::ControllerRuntime
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/gummi/version.rb

@@ -1,3 +1,3 @@
 module Gummi
-  VERSION = '0.3.7'
+  VERSION = '0.3.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gummi
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -206,6 +206,7 @@ files:
 - gummi.gemspec
 - lib/gummi.rb
 - lib/gummi/api.rb
+- lib/gummi/configuration.rb
 - lib/gummi/db_layer/default_index.rb
 - lib/gummi/db_layer/document.rb
 - lib/gummi/db_layer/document/attributes.rb
@@ -214,7 +215,6 @@ files:
 - lib/gummi/db_layer/document/search/raw.rb
 - lib/gummi/db_layer/document/search/result.rb
 - lib/gummi/db_layer/document/search/searching.rb
-- lib/gummi/db_layer/favorstuff.rb
 - lib/gummi/db_layer/fields/boolean.rb
 - lib/gummi/db_layer/fields/integer.rb
 - lib/gummi/db_layer/fields/keyword.rb
@@ -227,6 +227,11 @@ files:
 - lib/gummi/db_layer/index.rb
 - lib/gummi/entity_layer/entity.rb
 - lib/gummi/errors.rb
+- lib/gummi/rails.rb
+- lib/gummi/rails/instrumentation.rb
+- lib/gummi/rails/instrumentation/controller_runtime.rb
+- lib/gummi/rails/instrumentation/log_subscriber.rb
+- lib/gummi/rails/instrumentation/railtie.rb
 - lib/gummi/repository_layer/repository.rb
 - lib/gummi/repository_layer/repository/result.rb
 - lib/gummi/version.rb
@@ -269,12 +274,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 37788337669997294
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 37788337669997294
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/lib/gummi/db_layer/favorstuff.rb

@@ -1,15 +0,0 @@
-def self.favored_by(user_id, lot_ids = nil, search_options = {})
-   seek = Seek.new search_options, valid_sort_bys: %w{ catalogue_number }, max_per_page: 50, default_sort_by: :catalogue_number, default_sort_direction: :asc
-   favor_query  = { filtered: { query: { match_all: {} }, filter: { term: { user_id: user_id.to_i } } } }
-   favor_filter = { has_child: { type: DB::Favoring.document_type, query: favor_query } }
-   if lot_ids
-     lot_ids   = lot_ids.presence || [-1]
-     lot_query = { ids: { values: lot_ids } }
-     query     = { filtered: { query: lot_query, filter: favor_filter }}
-     body      = { query: query }
-   else
-     body = { query: favor_filter }
-   end
-   body.merge! sort: { seek.sort_by => seek.sort_direction }
-   raw_search seek.to_hash.merge options: { body: body }
-end