elasticsearch_record 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f50568400141462093f5d91bf5b26efb44a52b9529577d5e72a4d3699a57717
-  data.tar.gz: 89536ffacc4ddd5fb4d0334eda843d206c25fc867664f6f9454ee07d921ec712
+  metadata.gz: b6e4ca9acc6ee9abda4a3dacec4a75f9f1af77c361dbff3b53aa30648dfa5a5f
+  data.tar.gz: f6cf2edda611efb7daa6585764c09c2320040c8970555d64dab96ced763d2f19
 SHA512:
-  metadata.gz: 20d82567d738f3f5fa78cdd1bb2595ea7cd068dd16a14fbda56b4c88450a33cac5b32106652401854e0085e1c4378cce6b3ef23983b04ec71fb14f931628c19e
-  data.tar.gz: 3bcd72650c2d0817048edf3eff0be6ba8de4cc568b04203c3ec9631ccd4ef269b1c91f6f70d90dc05419357e5f4d3c3f164b4b4345f72c54c9d0cfabe15d3103
+  metadata.gz: 1d9327c0b6500d47ec5459ebd5e6053d8178d59b33cd690d5f9a2752ec22cc52d2728b295dd4644c5f7fa6b794c6a8d69305b372c6c138e2ae8c717500669453
+  data.tar.gz: 050e345874250113d23c69d4de6d3c8f35c7c6b4538fe8d1ee3dbeaf86a64dc7c745175a8301c5d78121481927bff34033a321e390fbaddf3356110951afb3c4

data/README.md

@@ -56,6 +56,7 @@ Or install it yourself as:
 ## Setup
 
 ### a) Update your **database.yml** and add a elasticsearch connection:
+
 ```yml
  # config/database.yml
  
@@ -115,6 +116,7 @@ end
 ```
 
 ### c) Create a model that inherits from `ElasticsearchRecord::Base` model.
+
 ```ruby
 # app/models/application_elasticsearch_record.rb
 
@@ -135,6 +137,7 @@ end
 ```
 
 ### d) have FUN with your model:
+
 ```ruby
 scope = Search
         .where(name: 'Custom Object Name')
@@ -155,12 +158,13 @@ scope.where(kind: :undefined).offset(10).update_all(name: "New Name")
 
 ## Active Record Query Interface
 
-### Refactored ```where``` method:
+### Refactored `where` method:
 Different to the default where-method you can now use it in different ways.
 
 Using it by default with a Hash, the method decides itself to either add a filter, or must_not clause.
 
-_Hint: If not provided through ```#kind```-method a default kind **:bool** will be used._
+_Hint: If not provided through `#kind`-method a default kind **:bool** will be used._
+
 ```ruby
 # use it by default
 Search.where(name: 'A nice object')
@@ -213,7 +217,6 @@ results_count = scope.count
 # > 5
 total = scope.total
 # > 3335
-
 ```
 
 ### Available query/relation chain methods
@@ -322,7 +325,6 @@ Elasticsearch's default value for queries without a **size** is forced to **10**
 To provide a similar behaviour as the (my)SQL interface,
 this can be automatically set to the `max_result_window` value by calling `.limit(nil)` on the models' relation.
 
-
 ```ruby
 SearchUser.where(name: 'Peter').limit(nil)
 # returns a maximum of 10 items ...
@@ -350,6 +352,7 @@ SearchUser.where(name: 'Peter').limit(nil)
 Quick access to model-related methods for easier access without creating a overcomplicated method call on the models connection...
 
 Access these methods through the model class method `.api`.
+
 ```ruby
 # returns mapping of model class
 klass.api.mappings
@@ -523,7 +526,6 @@ class AddTests < ActiveRecord::Migration[7.0]
 end
 ```
 
-
 ## environment-related-table-name:
 Using the `_env_table_name`-method will resolve the table (index) name within the current environment,
 even if the environments shares the same cluster ...
@@ -533,11 +535,14 @@ Within the migration the `_env_table_name`-method must be used in combination wi
 
 **Example:**
 Production uses a index suffix with '-pro', development uses '-dev' - they share the same cluster, but different indexes.
+
 For the **settings** table:
-- settings-pro
-- settings-dev
+
+* settings-pro
+* settings-dev
 
 A single migration can be created to be used within each environment:
+
 ```ruby
 # Example migration
 class AddSettings < ActiveRecord::Migration[7.0]

data/docs/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ElasticsearchRecord - CHANGELOG
 
+## [1.5.1] - 2023-07-11
+* [fix] `ElasticsearchRecord::ModelApi` 'drop!' & 'truncate!' methods to support correct parameter 'confirm'
+* [ref] improved yard documentation
+
 ## [1.5.0] - 2023-07-10
 * [add] additional `ElasticsearchRecord::ModelApi` methods **drop!** & **truncate!**, which have to be called with a `confirm:true` parameter
 * [add] `.ElasticsearchRecord::Base.delegate_query_nil_limit` to automatically delegate a relations `limit(nil)`-call to the **max_result_window** _(set to 10.000 as default)_

data/elasticsearch_record.gemspec

@@ -40,4 +40,5 @@ DESC
   spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
+  spec.add_development_dependency 'yard-relative_markdown_links', '>= 0.4'
 end

data/lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_mapping_definition.rb

@@ -100,7 +100,7 @@ module ActiveRecord
         end
 
         # returns the meta hash
-        # @param [Hash]
+        # @return [Hash]
         def meta
           __get_attribute(:meta) || {}
         end

data/lib/elasticsearch_record/gem_version.rb

@@ -9,7 +9,7 @@ module ElasticsearchRecord
   module VERSION
     MAJOR = 1
     MINOR = 5
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/elasticsearch_record/model_api.rb

@@ -33,8 +33,8 @@ module ElasticsearchRecord
     #   drop!(confirm: true)
     #   truncate!(confirm: true)
     %w(drop truncate).each do |method|
-      define_method("#{method}!") do |confirmed: false|
-        raise "#{method} of table '#{_index_name}' aborted!\nexecution not confirmed!\ncall with: #{klass}.api.#{method}!(confirmed: true)" unless confirmed
+      define_method("#{method}!") do |confirm: false|
+        raise "#{method} of table '#{_index_name}' aborted!\nexecution not confirmed!\ncall with: #{klass}.api.#{method}!(confirm: true)" unless confirm
         _connection.send("#{method}_table", _index_name)
       end
     end
@@ -68,6 +68,84 @@ module ElasticsearchRecord
       end
     end
 
+    # -- DYNAMIC METHOD DOCUMENTATION FOR YARD -------------------------------------------------------------------------
+
+    # @!method open!
+    # Shortcut to open the closed index.
+    # @return [Boolean] acknowledged status
+
+    # @!method close!
+    # Shortcut to close the opened index.
+    # @return [Boolean] acknowledged status
+
+    # @!method refresh!
+    # Shortcut to refresh the index.
+    # @return [Boolean] result state (returns false if refreshing failed)
+
+    # @!method block!
+    # Shortcut to block write access on the index
+    # @return [Boolean] acknowledged status
+
+    # @!method unblock!
+    # Shortcut to unblock all blocked accesses on the index
+    # @return [Boolean] acknowledged status
+
+    # @!method drop!(confirm: false)
+    # Shortcut to drop the index
+    # @param confirm
+    # @return [Boolean] acknowledged status
+
+    # @!method truncate!(confirm: false)
+    # Shortcut to truncate the index
+    # @param confirm
+    # @return [Boolean] acknowledged status
+
+    # @!method mappings
+    # Shortcut for mappings
+    # @return [Hash]
+
+    # @!method metas
+    # Shortcut for metas
+    # @return [Hash]
+
+    # @!method settings(flat_settings=true)
+    # Shortcut for settings
+    # @param [Boolean] flat_settings (default: true)
+    # @return [Hash]
+
+    # @!method aliases
+    # Shortcut for aliases
+    # @return [Hash]
+
+    # @!method state
+    # Shortcut for state
+    # @return [Hash]
+
+    # @!method schema(features=[])
+    # Shortcut for schema
+    # @param [Array, Symbol] features
+    # @return [Hash]
+
+    # @!method exists?
+    # Shortcut for exists
+    # @return [Boolean]
+
+    # @!method alias_exists?
+    # Shortcut for alias_exists
+    # @return [Boolean]
+
+    # @!method setting_exists?
+    # Shortcut for setting_exists
+    # @return [Boolean]
+
+    # @!method mapping_exists?
+    # Shortcut for mapping_exists
+    # @return [Boolean]
+
+    # @!method meta_exists?
+    # Shortcut for meta_exists
+    # @return [Boolean]
+
     # fast insert/update data.
     #
     # @example

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Tobias Gonsior
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,10 +94,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: yard-relative_markdown_links
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: 'ElasticsearchRecord is a ActiveRecord adapter and provides similar functionality
   for Elasticsearch.
 
-'
+  '
 email:
 - info@ruby-smart.org
 executables: []
@@ -191,7 +205,7 @@ metadata:
   source_code_uri: https://github.com/ruby-smart/elasticsearch_record
   documentation_uri: https://rubydoc.info/gems/elasticsearch_record
   changelog_uri: https://github.com/ruby-smart/elasticsearch_record/blob/main/docs/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,8 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: ActiveRecord adapter for Elasticsearch
 test_files: []