elasticsearch-persistence 5.1.0 → 6.0.0.pre

data/lib/elasticsearch/persistence/repository/class.rb

@@ -1,71 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Repository
-
-      # The default repository class, to be used either directly, or as a gateway in a custom repository class
-      #
-      # @example Standalone use
-      #
-      #     repository = Elasticsearch::Persistence::Repository::Class.new
-      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
-      #     repository.save(my_object)
-      #     # => {"_index"=> ... }
-      #
-      # @example Shortcut use
-      #
-      #     repository = Elasticsearch::Persistence::Repository.new
-      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
-      #
-      # @example Configuration via a block
-      #
-      #     repository = Elasticsearch::Persistence::Repository.new do
-      #       index 'my_notes'
-      #     end
-      #
-      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
-      #     # > repository.save(my_object)
-      #     # => {"_index"=> ... }
-      #
-      # @example Accessing the gateway in a custom class
-      #
-      #     class MyRepository
-      #       include Elasticsearch::Persistence::Repository
-      #     end
-      #
-      #     repository = MyRepository.new
-      #
-      #     repository.gateway.client.info
-      #     # => {"status"=>200, "name"=>"Venom", ... }
-      #
-      class Class
-        include Elasticsearch::Persistence::Repository::Client
-        include Elasticsearch::Persistence::Repository::Naming
-        include Elasticsearch::Persistence::Repository::Serialize
-        include Elasticsearch::Persistence::Repository::Store
-        include Elasticsearch::Persistence::Repository::Find
-        include Elasticsearch::Persistence::Repository::Search
-
-        include Elasticsearch::Model::Indexing::ClassMethods
-
-        attr_reader :options
-
-        def initialize(options={}, &block)
-          @options = options
-          index_name options.delete(:index)
-          block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
-        end
-
-        # Return the "host" class, if this repository is a gateway hosted in another class
-        #
-        # @return [nil, Class]
-        #
-        # @api private
-        #
-        def host
-          options[:host]
-        end
-      end
-
-    end
-  end
-end

data/lib/elasticsearch/persistence/repository/naming.rb

@@ -1,115 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Repository
-
-      # Wraps all naming-related features of the repository (index name, the domain object class, etc)
-      #
-      module Naming
-
-        # Get or set the class used to initialize domain objects when deserializing them
-        #
-        def klass name=nil
-          @klass = name || @klass
-        end
-
-        # Set the class used to initialize domain objects when deserializing them
-        #
-        def klass=klass
-          @klass = klass
-        end
-
-        # Get or set the index name used when storing and retrieving documents
-        #
-        def index_name name=nil
-          @index_name = name || @index_name || begin
-            if respond_to?(:host) && host && host.is_a?(Module)
-              self.host.to_s.underscore.gsub(/\//, '-')
-            else
-              self.class.to_s.underscore.gsub(/\//, '-')
-            end
-          end
-        end; alias :index :index_name
-
-        # Set the index name used when storing and retrieving documents
-        #
-        def index_name=(name)
-          @index_name = name
-        end; alias :index= :index_name=
-
-        # Get or set the document type used when storing and retrieving documents
-        #
-        def document_type name=nil
-          @document_type = name || @document_type || (klass ? klass.to_s.underscore : nil)
-        end; alias :type :document_type
-
-        # Set the document type used when storing and retrieving documents
-        #
-        def document_type=(name)
-          @document_type = name
-        end; alias :type= :document_type=
-
-        # Get the Ruby class from the Elasticsearch `_type`
-        #
-        # @example
-        #     repository.__get_klass_from_type 'note'
-        #     => Note
-        #
-        # @return [Class] The class corresponding to the passed type
-        # @raise [NameError] if the class cannot be found
-        #
-        # @api private
-        #
-        def __get_klass_from_type(type)
-          klass = type.classify
-          klass.constantize
-        rescue NameError => e
-          raise NameError, "Attempted to get class '#{klass}' from the '#{type}' type, but no such class can be found."
-        end
-
-        # Get the Elasticsearch `_type` from the Ruby class
-        #
-        # @example
-        #     repository.__get_type_from_class Note
-        #     => "note"
-        #
-        # @return [String] The type corresponding to the passed class
-        #
-        # @api private
-        #
-        def __get_type_from_class(klass)
-          klass.to_s.underscore
-        end
-
-        # Get a document ID from the document (assuming Hash or Hash-like object)
-        #
-        # @example
-        #     repository.__get_id_from_document title: 'Test', id: 'abc123'
-        #     => "abc123"
-        #
-        # @api private
-        #
-        def __get_id_from_document(document)
-          document[:id] || document['id'] || document[:_id] || document['_id']
-        end
-
-        # Extract a document ID from the document (assuming Hash or Hash-like object)
-        #
-        # @note Calling this method will *remove* the `id` or `_id` key from the passed object.
-        #
-        # @example
-        #     options = { title: 'Test', id: 'abc123' }
-        #     repository.__extract_id_from_document options
-        #     # => "abc123"
-        #     options
-        #     # => { title: 'Test' }
-        #
-        # @api private
-        #
-        def __extract_id_from_document(document)
-          document.delete(:id) || document.delete('id') || document.delete(:_id) || document.delete('_id')
-        end
-      end
-
-    end
-  end
-end

data/lib/rails/generators/elasticsearch/model/model_generator.rb

@@ -1,21 +0,0 @@
-require "rails/generators/elasticsearch_generator"
-
-module Elasticsearch
-  module Generators
-    class ModelGenerator < ::Rails::Generators::NamedBase
-      source_root File.expand_path('../templates', __FILE__)
-
-      desc "Creates an Elasticsearch::Persistence model"
-      argument :attributes, type: :array, default: [], banner: "attribute:type attribute:type"
-
-      check_class_collision
-
-      def create_model_file
-        @padding = attributes.map { |a| a.name.size }.max
-        template "model.rb.tt", File.join("app/models", class_path, "#{file_name}.rb")
-      end
-
-      hook_for :test_framework
-    end
-  end
-end

data/lib/rails/generators/elasticsearch/model/templates/model.rb.tt

@@ -1,9 +0,0 @@
-<% module_namespacing do -%>
-class <%= class_name %>
-  include Elasticsearch::Persistence::Model
-
-<% attributes.each do |attribute| -%>
-  <%= "attribute :#{attribute.name},".ljust(@padding+12) %> <%= attribute.type %>
-<% end -%>
-end
-<% end -%>

data/lib/rails/generators/elasticsearch_generator.rb

@@ -1,2 +0,0 @@
-require "rails/generators/named_base"
-require "rails/generators/active_model"

data/test/integration/model/model_basic_test.rb

@@ -1,238 +0,0 @@
-require 'test_helper'
-
-require 'elasticsearch/persistence/model'
-require 'elasticsearch/persistence/model/rails'
-
-module Elasticsearch
-  module Persistence
-    class PersistenceModelBasicIntegrationTest < Elasticsearch::Test::IntegrationTestCase
-
-      class ::Person
-        include Elasticsearch::Persistence::Model
-        include Elasticsearch::Persistence::Model::Rails
-
-        settings index: { number_of_shards: 1 }
-        document_type 'human_being'
-
-        attribute :name, String,
-                  mapping: { fields: {
-                    name: { type: 'text', analyzer: 'snowball' },
-                    raw:  { type: 'keyword' }
-                  } }
-
-        attribute :birthday,   Date
-        attribute :department, String
-        attribute :salary,     Integer
-        attribute :admin,      Boolean, default: false
-
-        validates :name, presence: true
-      end
-
-      context "A basic persistence model" do
-        setup do
-          Person.create_index! force: true
-        end
-
-        should "warn that the ActiveRecord persistence pattern is deprecated" do
-          Kernel.expects(:warn).at_least_once
-          class ShouldWarn; include Elasticsearch::Persistence::Model; end
-        end
-
-        should "save the object with custom ID" do
-          person = Person.new id: 1, name: 'Number One'
-          person.save
-
-          document = Person.find(1)
-          assert_not_nil document
-          assert_equal 'Number One', document.name
-        end
-
-        should "create the object with custom ID" do
-          person = Person.create id: 1, name: 'Number One'
-
-          document = Person.find(1)
-          assert_not_nil document
-          assert_equal 'Number One', document.name
-        end
-
-        should "save and find the object" do
-          person = Person.new name: 'John Smith', birthday: Date.parse('1970-01-01')
-          assert person.save
-
-          assert_not_nil person.id
-          document = Person.find(person.id)
-
-          assert_instance_of Person, document
-          assert_equal 'John Smith', document.name
-          assert_equal 'John Smith', Person.find(person.id).name
-
-          assert_not_nil Elasticsearch::Persistence.client.get index: 'people', type: 'human_being', id: person.id
-        end
-
-        should "not save an invalid object" do
-          person = Person.new name: nil
-          assert ! person.save
-        end
-
-        should "save an invalid object with the :validate option" do
-          person = Person.new name: nil, salary: 100
-          assert person.save validate: false
-
-          assert_not_nil person.id
-          document = Person.find(person.id)
-          assert_equal 100, document.salary
-        end
-
-        should "delete the object" do
-          person = Person.create name: 'John Smith', birthday: Date.parse('1970-01-01')
-
-          person.destroy
-          assert person.frozen?
-
-          assert_raise Elasticsearch::Transport::Transport::Errors::NotFound do
-            Elasticsearch::Persistence.client.get index: 'people', type: 'person', id: person.id
-          end
-        end
-
-        should "update an object attribute" do
-          person = Person.create name: 'John Smith'
-
-          person.update name: 'UPDATED'
-
-          assert_equal 'UPDATED', person.name
-          assert_equal 'UPDATED', Person.find(person.id).name
-        end
-
-        should "create the model with correct Date form Rails' form attributes" do
-          params = { "birthday(1i)"=>"2014",
-                     "birthday(2i)"=>"1",
-                     "birthday(3i)"=>"1"
-                   }
-          person = Person.create params.merge(name: 'TEST')
-
-          assert_equal Date.parse('2014-01-01'), person.birthday
-          assert_equal Date.parse('2014-01-01'), Person.find(person.id).birthday
-        end
-
-        should_eventually "update the model with correct Date form Rails' form attributes" do
-          params = { "birthday(1i)"=>"2014",
-                     "birthday(2i)"=>"1",
-                     "birthday(3i)"=>"1"
-                   }
-          person = Person.create params.merge(name: 'TEST')
-
-          person.update params.merge('birthday(1i)' => '2015')
-
-          assert_equal Date.parse('2015-01-01'), person.birthday
-          assert_equal Date.parse('2015-01-01'), Person.find(person.id).birthday
-        end
-
-        should "increment an object attribute" do
-          person = Person.create name: 'John Smith', salary: 1_000
-
-          person.increment :salary
-
-          assert_equal 1_001, person.salary
-          assert_equal 1_001, Person.find(person.id).salary
-        end
-
-        should "update the object timestamp" do
-          person = Person.create name: 'John Smith'
-          updated_at = person.updated_at
-
-          sleep 1
-          person.touch
-
-          assert person.updated_at > updated_at, [person.updated_at, updated_at].inspect
-
-          found = Person.find(person.id)
-          assert found.updated_at > updated_at, [found.updated_at, updated_at].inspect
-        end
-
-        should 'update the object timestamp on save' do
-          person = Person.create name: 'John Smith'
-          person.admin = true
-          sleep 1
-          person.save
-
-          Person.gateway.refresh_index!
-
-          found = Person.find(person.id)
-
-          # Compare without milliseconds
-          assert_equal person.updated_at.to_i, found.updated_at.to_i
-        end
-
-        should "respect the version" do
-          person = Person.create name: 'John Smith'
-
-          person.update( { name: 'UPDATE 1' })
-
-          assert_raise Elasticsearch::Transport::Transport::Errors::Conflict do
-            person.update( { name: 'UPDATE 2' }, { version: 1 } )
-          end
-        end
-
-        should "find all instances" do
-          Person.create name: 'John Smith'
-          Person.create name: 'Mary Smith'
-          Person.gateway.refresh_index!
-
-          people = Person.all
-
-          assert_equal 2, people.total
-          assert_equal 2, people.size
-        end
-
-        should "find instances by search" do
-          Person.create name: 'John Smith'
-          Person.create name: 'Mary Smith'
-          Person.gateway.refresh_index!
-
-          people = Person.search query: { match: { name: 'smith' } },
-                                 highlight: { fields: { name: {} } }
-
-          assert_equal 2, people.total
-          assert_equal 2, people.size
-
-          assert people.map_with_hit { |o,h| h._score }.all? { |s| s > 0 }
-
-          assert_not_nil people.first.hit
-          assert_match /smith/i, people.first.hit.highlight['name'].first
-        end
-
-        should "find instances in batches" do
-          50.times { |i| Person.create name: "John #{i+1}" }
-          Person.gateway.refresh_index!
-
-          @batches = 0
-          @results = []
-
-          Person.find_in_batches(_source_include: 'name') do |batch|
-            @batches += 1
-            @results += batch.map(&:name)
-          end
-
-          assert_equal  3, @batches
-          assert_equal 50, @results.size
-          assert_contains @results, 'John 1'
-        end
-
-        should "find each instance" do
-          50.times { |i| Person.create name: "John #{i+1}" }
-          Person.gateway.refresh_index!
-
-          @results = []
-
-          Person.find_each(_source_include: 'name') do |person|
-            @results << person.name
-          end
-
-          assert_equal 50, @results.size
-          assert_contains @results, 'John 1'
-        end
-      end
-
-    end
-  end
-end