mini-smart-box 0.0.1

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/log_subscriber.rb

@@ -0,0 +1,67 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  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[:klass]} #{payload[:name]} (#{event.duration.round(1)}ms)"
+          search  = payload[:search].inspect.gsub(/:(\w+)=>/, '\1: ')
+          debug %Q|  #{color(name, GREEN, color_option(true))} #{colorize_logging ? "\e[2m#{search}\e[0m" : search}|
+        end
+
+        private
+
+        def color_option(bold_value)
+          new_color_syntax? ? { bold: bold_value } : bold_value
+        end
+
+        def new_color_syntax?
+          return @new_color_syntax if defined?(@new_color_syntax)
+
+          @new_color_syntax = ::ActiveSupport.respond_to?(:gem_version) && ::ActiveSupport::gem_version >= '7.1'
+        end
+      end
+    end
+  end
+end
+
+Elasticsearch::Rails::Instrumentation::LogSubscriber.attach_to :elasticsearch

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/publishers.rb

@@ -0,0 +1,53 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module Rails
+    module Instrumentation
+      module Publishers
+
+        # Wraps the `SearchRequest` methods to perform the instrumentation
+        #
+        # @see SearchRequest#execute_with_instrumentation!
+        # @see http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html
+        #
+        module SearchRequest
+
+          def self.included(base)
+            base.class_eval do
+              unless method_defined?(:execute_without_instrumentation!)
+                alias_method :execute_without_instrumentation!, :execute!
+                alias_method :execute!, :execute_with_instrumentation!
+              end
+            end
+          end
+
+          # Wrap `Search#execute!` and perform instrumentation
+          #
+          def execute_with_instrumentation!
+            ActiveSupport::Notifications.instrument "search.elasticsearch",
+              name:   'Search',
+              klass:  (self.klass.is_a?(Elasticsearch::Model::Proxy::ClassMethodsProxy) ? self.klass.target.to_s : self.klass.to_s),
+              search: self.definition do
+              execute_without_instrumentation!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/railtie.rb

@@ -0,0 +1,44 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  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 "elasticsearch.instrumentation" do |app|
+          require 'elasticsearch/rails/instrumentation/log_subscriber'
+          require 'elasticsearch/rails/instrumentation/controller_runtime'
+
+          Elasticsearch::Model::Searching::SearchRequest.class_eval do
+            include Elasticsearch::Rails::Instrumentation::Publishers::SearchRequest
+          end if defined?(Elasticsearch::Model::Searching::SearchRequest)
+
+          ActiveSupport.on_load(:action_controller) do
+            include Elasticsearch::Rails::Instrumentation::ControllerRuntime
+          end
+        end
+      end
+
+    end
+  end
+end

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation.rb

@@ -0,0 +1,53 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'elasticsearch/rails/instrumentation/railtie'
+require 'elasticsearch/rails/instrumentation/publishers'
+
+module Elasticsearch
+  module Rails
+
+    # This module adds support for displaying statistics about search duration in the Rails application log
+    # by integrating with the `ActiveSupport::Notifications` framework and `ActionController` logger.
+    #
+    # == Usage
+    #
+    # Require the component in your `application.rb` file:
+    #
+    #     require 'elasticsearch/rails/instrumentation'
+    #
+    # You should see an output like this in your application log in development environment:
+    #
+    #     Article Search (321.3ms) { index: "articles", type: "article", body: { query: ... } }
+    #
+    # Also, the total duration of the request to Elasticsearch is displayed in the Rails request breakdown:
+    #
+    #     Completed 200 OK in 615ms (Views: 230.9ms | ActiveRecord: 0.0ms | Elasticsearch: 321.3ms)
+    #
+    # @note The displayed duration includes the HTTP transfer -- the time it took Elasticsearch
+    #       to process your request is available in the `response.took` property.
+    #
+    # @see Elasticsearch::Rails::Instrumentation::Publishers
+    # @see Elasticsearch::Rails::Instrumentation::Railtie
+    #
+    # @see http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html
+    #
+    #
+    module Instrumentation
+    end
+  end
+end

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/lograge.rb

@@ -0,0 +1,57 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module Rails
+    module Lograge
+
+      # Rails initializer class to require Elasticsearch::Rails::Instrumentation files,
+      # set up Elasticsearch::Model and add Lograge configuration to display Elasticsearch-related duration
+      #
+      # Require the component in your `application.rb` file and enable Lograge:
+      #
+      #     require 'elasticsearch/rails/lograge'
+      #
+      # You should see the full duration of the request to Elasticsearch as part of each log event:
+      #
+      #     method=GET path=/search ... status=200 duration=380.89 view=99.64 db=0.00 es=279.37
+      #
+      # @see https://github.com/roidrage/lograge
+      #
+      class Railtie < ::Rails::Railtie
+        initializer "elasticsearch.lograge" do |app|
+          require 'elasticsearch/rails/instrumentation/publishers'
+          require 'elasticsearch/rails/instrumentation/log_subscriber'
+          require 'elasticsearch/rails/instrumentation/controller_runtime'
+
+          Elasticsearch::Model::Searching::SearchRequest.class_eval do
+            include Elasticsearch::Rails::Instrumentation::Publishers::SearchRequest
+          end if defined?(Elasticsearch::Model::Searching::SearchRequest)
+
+          ActiveSupport.on_load(:action_controller) do
+            include Elasticsearch::Rails::Instrumentation::ControllerRuntime
+          end
+
+          config.lograge.custom_options = lambda do |event|
+            { es: event.payload[:elasticsearch_runtime].to_f.round(2) }
+          end
+        end
+      end
+
+    end
+  end
+end

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/tasks/import.rb

@@ -0,0 +1,128 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# A collection of Rake tasks to facilitate importing data from your models into Elasticsearch.
+#
+# Add this e.g. into the `lib/tasks/elasticsearch.rake` file in your Rails application:
+#
+#     require 'elasticsearch/rails/tasks/import'
+#
+# To import the records from your `Article` model, run:
+#
+#     $ bundle exec rake environment elasticsearch:import:model CLASS='MyModel'
+#
+# Run this command to display usage instructions:
+#
+#     $ bundle exec rake -D elasticsearch
+#
+STDOUT.sync = true
+STDERR.sync = true
+
+begin; require 'ansi/progressbar'; rescue LoadError; end
+
+namespace :elasticsearch do
+
+  task :import => 'import:model'
+
+  namespace :import do
+    import_model_desc = <<-DESC.gsub(/    /, '')
+      Import data from your model (pass name as CLASS environment variable).
+
+        $ rake environment elasticsearch:import:model CLASS='MyModel'
+
+      Force rebuilding the index (delete and create):
+        $ rake environment elasticsearch:import:model CLASS='Article' FORCE=y
+
+      Customize the batch size:
+        $ rake environment elasticsearch:import:model CLASS='Article' BATCH=100
+
+      Set target index name:
+        $ rake environment elasticsearch:import:model CLASS='Article' INDEX='articles-new'
+
+      Pass an ActiveRecord scope to limit the imported records:
+        $ rake environment elasticsearch:import:model CLASS='Article' SCOPE='published'
+    DESC
+    desc import_model_desc
+    task model: :environment do
+      if ENV['CLASS'].to_s == ''
+        puts '='*90, 'USAGE', '='*90, import_model_desc, ""
+        exit(1)
+      end
+
+      klass  = eval(ENV['CLASS'].to_s)
+      total  = klass.count rescue nil
+      pbar   = ANSI::Progressbar.new(klass.to_s, total) rescue nil
+      pbar.__send__ :show if pbar
+
+      unless ENV['DEBUG']
+        begin
+          klass.__elasticsearch__.client.transport.logger.level = Logger::WARN
+        rescue NoMethodError; end
+        begin
+          klass.__elasticsearch__.client.transport.tracer.level = Logger::WARN
+        rescue NoMethodError; end
+      end
+
+      total_errors = klass.__elasticsearch__.import force:      ENV.fetch('FORCE', false),
+                                  batch_size: ENV.fetch('BATCH', 1000).to_i,
+                                  index:      ENV.fetch('INDEX', nil),
+                                  scope:      ENV.fetch('SCOPE', nil) do |response|
+        pbar.inc response['items'].size if pbar
+        STDERR.flush
+        STDOUT.flush
+      end
+      pbar.finish if pbar
+
+      puts "[IMPORT] #{total_errors} errors occurred" unless total_errors.zero?
+      puts '[IMPORT] Done'
+    end
+
+    desc <<-DESC.gsub(/    /, '')
+      Import all indices from `app/models` (or use DIR environment variable).
+
+        $ rake environment elasticsearch:import:all DIR=app/models
+    DESC
+    task all: :environment do
+      dir    = ENV['DIR'].to_s != '' ? ENV['DIR'] : Rails.root.join("app/models")
+
+      puts "[IMPORT] Loading models from: #{dir}"
+      Dir.glob(File.join("#{dir}/**/*.rb")).each do |path|
+        model_filename = path[/#{Regexp.escape(dir.to_s)}\/([^\.]+).rb/, 1]
+
+        next if model_filename.match(/^concerns\//i) # Skip concerns/ folder
+
+        begin
+          klass = model_filename.camelize.constantize
+        rescue NameError
+          require(path) ? retry : raise(RuntimeError, "Cannot load class '#{klass}'")
+        end
+
+        # Skip if the class doesn't have Elasticsearch integration
+        next unless klass.respond_to?(:__elasticsearch__)
+
+        puts "[IMPORT] Processing model: #{klass}..."
+
+        ENV['CLASS'] = klass.to_s
+        Rake::Task["elasticsearch:import:model"].invoke
+        Rake::Task["elasticsearch:import:model"].reenable
+        puts
+      end
+    end
+
+  end
+
+end

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/version.rb

@@ -0,0 +1,22 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module Rails
+    VERSION = '8.0.1'.freeze
+  end
+end

data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails.rb

@@ -0,0 +1,24 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require "elasticsearch/rails/version"
+
+module Elasticsearch
+  module Rails
+    # Your code goes here...
+  end
+end