stretchy-model 0.6.5 → 0.6.6

data/lib/stretchy/attributes/type/sparse_vector.rb

@@ -1,21 +1,27 @@
-# 
-# attribute :ml, :sparse_vector
-# 
-# {
-#   "mappings": {
-#     "properties": {
-#       "ml.tokens": {
-#         "type": "sparse_vector"
-#       }
-#     }
-#   }
-# }
-#
-
-
 module Stretchy
   module Attributes
       module Type
+          # The SparseVector attribute type
+          #
+          # This class is used to define a sparse_vector attribute for a model. It provides support for the Elasticsearch sparse_vector data type, which is a type of data type that can hold sparse vectors of float values.
+          #
+          # ### Parameters
+          #
+          # - `type:` `:sparse_vector`.
+          # - `options:` The Hash of options for the attribute. This type does not have any specific options.
+          #
+          # ---
+          #
+          # ### Examples
+          #
+          # #### Define a sparse_vector attribute
+          #
+          # ```ruby
+          #   class MyModel < StretchyModel
+          #     attribute :ml, :sparse_vector
+          #   end
+          # ```
+          #
           class SparseVector < Stretchy::Attributes::Type::Base
 
               def type
@@ -23,12 +29,10 @@ module Stretchy
               end
 
               def mappings(name) 
-                  {
-                    properties: {
-                      "#{name}.tokens": {
-                          type: "sparse_vector"
-                      }
-                    }
+                {
+                  "#{name}.tokens": {
+                      type: "sparse_vector"
+                  }
                 }.as_json
               end
           end

data/lib/stretchy/attributes/type/string.rb

@@ -1,5 +1,46 @@
 module Stretchy::Attributes::Type
-  class String < Stretchy::Attributes::Type::Text # :nodoc:
+  # The String attribute type
+  #
+  # _alias for `:text`_
+  #
+  # This class is used to define a string attribute for a model. It provides support for the Elasticsearch text data type, which is a type of data type that can hold text. In this library, the string type is an alias for the text type.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:string`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:analyzer:` The String analyzer to be used for the text field, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
+  #    - `:eager_global_ordinals:` The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
+  #    - `:fielddata:` The Boolean indicating if the field can use in-memory fielddata for sorting, aggregations, or scripting. Defaults to false.
+  #    - `:fielddata_frequency_filter:` The Hash of expert settings which allow to decide which values to load in memory when fielddata is enabled.
+  #    - `:fields:` The Hash of multi-fields allow the same string value to be indexed in multiple ways for different purposes. By default, a 'keyword' field is added. Set to false to disable.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:index_options:` The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
+  #    - `:index_prefixes:` The Hash indicating if term prefixes of between 2 and 5 characters are indexed into a separate field.
+  #    - `:index_phrases:` The Boolean indicating if two-term word combinations (shingles) are indexed into a separate field. Defaults to false.
+  #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
+  #    - `:position_increment_gap:` The Integer indicating the number of fake term position which should be inserted between each element of an array of strings. Defaults to 100.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:search_analyzer:` The String analyzer that should be used at search time on the text field. Defaults to the analyzer setting.
+  #    - `:search_quote_analyzer:` The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
+  #    - `:similarity:` The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
+  #    - `:term_vector:` The String indicating if term vectors should be stored for the field. Defaults to 'no'.
+  #    - `:meta:` The Hash of metadata about the field.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a string attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :name, :string
+  #   end
+  # ```
+  #
+  class String < Stretchy::Attributes::Type::Text
+    
     def type
       :string
     end

data/lib/stretchy/attributes/type/text.rb

@@ -1,37 +1,57 @@
 module Stretchy::Attributes::Type
-    # Public: Defines a text attribute for the model. This field type is used for text strings.
-    #
-    # opts - The Hash options used to refine the attribute (default: {}):
-    #        :analyzer - The String analyzer to be used for the text field, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
-    #        :eager_global_ordinals - The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
-    #        :fielddata - The Boolean indicating if the field can use in-memory fielddata for sorting, aggregations, or scripting. Defaults to false.
-    #        :fielddata_frequency_filter - The Hash of expert settings which allow to decide which values to load in memory when fielddata is enabled.
-    #        :fields - The Hash of multi-fields allow the same string value to be indexed in multiple ways for different purposes. By default, a 'keyword' field is added. Set to false to disable.
-    #        :index - The Boolean indicating if the field should be searchable. Defaults to true.
-    #        :index_options - The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
-    #        :index_prefixes - The Hash indicating if term prefixes of between 2 and 5 characters are indexed into a separate field.
-    #        :index_phrases - The Boolean indicating if two-term word combinations (shingles) are indexed into a separate field. Defaults to false.
-    #        :norms - The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
-    #        :position_increment_gap - The Integer indicating the number of fake term position which should be inserted between each element of an array of strings. Defaults to 100.
-    #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-    #        :search_analyzer - The String analyzer that should be used at search time on the text field. Defaults to the analyzer setting.
-    #        :search_quote_analyzer - The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
-    #        :similarity - The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
-    #        :term_vector - The String indicating if term vectors should be stored for the field. Defaults to 'no'.
-    #        :meta - The Hash of metadata about the field.
-    #
-    #
-    # Examples
-    #
-    #   class MyModel
-    #     include StretchyModel
+    # The Text attribute type
+    #
+    # This class is used to define a text attribute for a model. It provides support for the Elasticsearch text data type, which is a type of data type that can hold text strings.
+    #
+    # >[!NOTE]
+    # >
+    # > The default for the `:text` type is to have a keyword multified if `field:` is not specified and `fields:` is not explicitly false.
+    # > This can be disabled by setting `Stretchy.configuration.add_keyword_field_to_text_attributes` to false.
+    # > The default keyword field name is `:keyword`, but this can be changed by setting `Stretchy.configuration.default_keyword_field`.
+    #
+    # ### Parameters
+    #
+    # - `type:` `:text`.
+    # - `options:` The Hash of options for the attribute.
+    #    - `:analyzer:` The String analyzer to be used for the text field, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
+    #    - `:eager_global_ordinals:` The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
+    #    - `:fielddata:` The Boolean indicating if the field can use in-memory fielddata for sorting, aggregations, or scripting. Defaults to false.
+    #    - `:fielddata_frequency_filter:` The Hash of expert settings which allow to decide which values to load in memory when fielddata is enabled.
+    #    - `:fields:` The Hash of multi-fields allow the same string value to be indexed in multiple ways for different purposes. By default, a 'keyword' field is added. Set to false to disable.
+    #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+    #    - `:index_options:` The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
+    #    - `:index_prefixes:` The Hash indicating if term prefixes of between 2 and 5 characters are indexed into a separate field.
+    #    - `:index_phrases:` The Boolean indicating if two-term word combinations (shingles) are indexed into a separate field. Defaults to false.
+    #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
+    #    - `:position_increment_gap:` The Integer indicating the number of fake term position which should be inserted between each element of an array of strings. Defaults to 100.
+    #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+    #    - `:search_analyzer:` The String analyzer that should be used at search time on the text field. Defaults to the analyzer setting.
+    #    - `:search_quote_analyzer:` The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
+    #    - `:similarity:` The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
+    #    - `:term_vector:` The String indicating if term vectors should be stored for the field. Defaults to 'no'.
+    #    - `:meta:` The Hash of metadata about the field.
+    #
+    # ---
+    #
+    # ### Examples
+    #
+    # #### Define a text attribute
+    #
+    # ```ruby
+    #   class MyModel < StretchyModel
     #     attribute :description, :text, analyzer: 'english'
     #   end
+    # ```
     #
-    # Returns nothing.
     class Text < Stretchy::Attributes::Type::Base
       OPTIONS = [:analyzer, :eager_global_ordinals, :fielddata, :fielddata_frequency_filter, :fields, :index, :index_options, :index_prefixes, :index_phrases, :norms, :position_increment_gap, :store, :search_analyzer, :search_quote_analyzer, :similarity, :term_vector, :meta]
-  
+
+      def initialize(**args)
+        # Add a keyword field by default if no fields are specified
+        args.reverse_merge!(fields: {keyword: {type: :keyword, ignore_above: 256}}) if args[:fields].nil? && Stretchy.configuration.add_keyword_field_to_text_attributes
+        super 
+      end
+
       def type
         :text
       end
@@ -40,6 +60,11 @@ module Stretchy::Attributes::Type
         :text
       end
 
+      # The default for the `:text` type is to have a keyword field if no fields are specified.
+      def keyword_field?
+        fields.find { |k,d| d[:type].to_sym == :keyword}.present?
+      end
+
       def mappings(name)
         options = {type: type_for_database}
         OPTIONS.each { |option| options[option] = send(option) unless send(option).nil? }

data/lib/stretchy/attributes/type/token_count.rb

@@ -1,21 +1,31 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a token_count attribute for the model. This field type is used for counting the number of tokens in a string.
+  # The TokenCount attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :analyzer - The String analyzer to be used to analyze the string value. Required.
-  #        :enable_position_increments - The Boolean indicating if position increments should be counted. Defaults to true.
-  #        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
-  #        :index - The Boolean indicating if the field should be searchable. Defaults to true.
-  #        :null_value - The Numeric value to be substituted for any explicit null values. Defaults to null.
-  #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  # This class is used to define a token_count attribute for a model. It provides support for the Elasticsearch token_count data type, which is a type of data type that can count the number of tokens in a string.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:token_count`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:analyzer:` The String analyzer to be used to analyze the string value. Required.
+  #    - `:enable_position_increments:` The Boolean indicating if position increments should be counted. Defaults to true.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:null_value:` The Numeric value to be substituted for any explicit null values. Defaults to null.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a token_count attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :description_token_count, :token_count, analyzer: 'standard'
   #   end
+  # ```
   #
-  # Returns nothing.
   class TokenCount < Stretchy::Attributes::Type::Base
     OPTIONS = [:analyzer, :enable_position_increments, :doc_values, :index, :null_value, :store]
 

data/lib/stretchy/attributes/type/version.rb

@@ -1,16 +1,26 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a version attribute for the model. This field type is used for software versions following the Semantic Versioning rules.
+  # The Version attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :meta - The Hash of metadata about the field.
+  # This class is used to define a version attribute for a model. This field type is used for software versions following the Semantic Versioning rules.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:version`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:meta:` The Hash of metadata about the field.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a version attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :software_version, :version
   #   end
+  # ```
   #
-  # Returns nothing.
   class Version < Stretchy::Attributes::Type::Base
     OPTIONS = [:meta]
 

data/lib/stretchy/attributes/type/wildcard.rb

@@ -1,33 +1,44 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a wildcard attribute for the model. This field type is a specialization of the keyword field, but it supports wildcard searches.
-  #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
-  #        :eager_global_ordinals - The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
-  #        :fields - The Hash of multi-fields for the same string value to be indexed in multiple ways.
-  #        :ignore_above - The Integer limit for the length of the string. Strings longer than this limit will not be indexed. Defaults to 2147483647.
-  #        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-  #        :index_options - The String indicating what information should be stored in the index for scoring purposes. Defaults to 'docs'.
-  #        :meta - The Hash metadata about the field.
-  #        :norms - The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to false.
-  #        :null_value - The String value to be substituted for any explicit null values. Defaults to null.
-  #        :on_script_error - The String defining what to do if the script defined by the :script parameter throws an error at indexing time. Can be 'fail' or 'continue'.
-  #        :script - The String script that will index values generated by this script, rather than reading the values directly from the source.
-  #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-  #        :similarity - The String scoring algorithm or similarity to be used. Defaults to 'BM25'.
-  #        :normalizer - The String pre-processor for the keyword prior to indexing. Defaults to null.
-  #        :split_queries_on_whitespace - The Boolean indicating if full text queries should split the input on whitespace. Defaults to false.
-  #        :time_series_dimension - The Boolean indicating if the field is a time series dimension. Defaults to false.
-  #
-  # Examples
-  #
-  #   class MyModel
-  #     include StretchyModel
+  # The Wildcard attribute type
+  #
+  # This class is used to define a wildcard attribute for a model. This field type is a specialization of the keyword field, but it supports wildcard searches.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:wildcard`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  #    - `:eager_global_ordinals:` The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
+  #    - `:fields:` The Hash of multi-fields for the same string value to be indexed in multiple ways.
+  #    - `:ignore_above:` The Integer limit for the length of the string. Strings longer than this limit will not be indexed. Defaults to 2147483647.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:index_options:` The String indicating what information should be stored in the index for scoring purposes. Defaults to 'docs'.
+  #    - `:meta:` The Hash metadata about the field.
+  #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to false.
+  #    - `:null_value:` The String value to be substituted for any explicit null values. Defaults to null.
+  #    - `:on_script_error:` The String defining what to do if the script defined by the :script parameter throws an error at indexing time. Can be 'fail' or 'continue'.
+  #    - `:script:` The String script that will index values generated by this script, rather than reading the values directly from the source.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:similarity:` The String scoring algorithm or similarity to be used. Defaults to 'BM25'.
+  #    - `:normalizer:` The String pre-processor for the keyword prior to indexing. Defaults to null.
+  #    - `:split_queries_on_whitespace:` The Boolean indicating if full text queries should split the input on whitespace. Defaults to false.
+  #    - `:time_series_dimension:` The Boolean indicating if the field is a time series dimension. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a wildcard attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :description_wildcard, :wildcard
   #   end
+  # ```
   #
-  # Returns nothing.
   class Wildcard < Stretchy::Attributes::Type::Keyword
+    OPTIONS = [:doc_values, :eager_global_ordinals, :fields, :ignore_above, :index, :index_options, :meta, :norms, :null_value, :on_script_error, :script, :store, :similarity, :normalizer, :split_queries_on_whitespace, :time_series_dimension]
+    attr_reader *OPTIONS
     def type
       :wildcard
     end

data/lib/stretchy/attributes.rb

@@ -1,4 +1,32 @@
 module Stretchy
+  # used to define and manage the attributes of a model in Stretchy. It provides methods for getting and setting attribute values, inspecting the model, and registering attribute types.
+  #
+  # ### Methods
+  #
+  # - `[](attribute)`: Retrieves the value of the specified attribute.
+  # - `[]=(attribute, value)`: Sets the value of the specified attribute.
+  # - `inspect`: Returns a string representation of the model, including its class name and attributes.
+  # - `self.inspect`: Returns a string representation of the model class, including its name and attribute types.
+  # - `attribute_mappings`: Returns a JSON representation of the attribute mappings for the model.
+  # - `self.register!`: Registers the attribute types with ActiveModel.
+  #
+  # ### Example
+  #
+  # In this example, the `Attributes` module is used to define an attribute for `MyModel`, get and set the attribute value, inspect the model and the model class, and get the attribute mappings.
+  #
+  # ```ruby
+  # class MyModel < Stretchy::Record
+  #   attribute :title, :string
+  # end
+  #
+  # model = MyModel.new(title: "hello")
+  # model[:title] # => "hello"
+  # model.inspect # => "#<MyModel title: hello>"
+  # MyModel.inspect # => "#<MyModel title: string>"
+  # MyModel.attribute_mappings # => {properties: {title: {type: "string"}}}
+  # ```
+  #
+  #
   module Attributes
     extend ActiveSupport::Concern
 
@@ -38,6 +66,7 @@ module Stretchy
       ActiveModel::Type.register(:ip, Stretchy::Attributes::Type::IP)
       ActiveModel::Type.register(:join, Stretchy::Attributes::Type::Join)
       ActiveModel::Type.register(:keyword, Stretchy::Attributes::Type::Keyword)
+      ActiveModel::Type.register(:knn_vector, Stretchy::Attributes::Type::KnnVector)
       ActiveModel::Type.register(:match_only_text, Stretchy::Attributes::Type::MatchOnlyText)
       ActiveModel::Type.register(:nested, Stretchy::Attributes::Type::Nested)
       ActiveModel::Type.register(:percolator, Stretchy::Attributes::Type::Percolator)

data/lib/stretchy/delegation/gateway_delegation.rb

@@ -18,6 +18,33 @@ module Stretchy
                 :count,
         to: :gateway
 
+      # This method is used to set or retrieve the index name for the Elasticsearch index.
+      #
+      # ### Parameters
+      #
+      # - `name:` (String, nil) - The name to set for the index. If nil, the method will act as a getter.
+      # - `&block:` A block that returns the index name when called.
+      #
+      # ### Returns
+      #
+      # - (String) - The index name.
+      #
+      # ### Behavior
+      #
+      # - If a name or block is provided, it sets the index name to the provided name or block.
+      # - If no argument is provided, it retrieves the index name. 
+      # - If the index name is callable (e.g., a Proc), it calls the block.
+      # - If the index name is not set, it defaults to the parameterized and underscored collection name of the base class model.
+      #
+      # ### Example
+      #
+      # In this example, the index name for instances of `MyModel` will be "my_custom_index" instead of "my_models".
+      #
+      # ```ruby
+      # class MyModel < Stretchy::Record
+      #   index_name "my_custom_index"
+      # end
+      # ```
       def index_name(name=nil, &block)
           if name || block_given?
             return (@index_name = name || block)
@@ -30,6 +57,30 @@ module Stretchy
           end
       end
 
+      # This method is used to set or retrieve the settings for the Elasticsearch index.
+      #
+      # ### Parameters
+      #
+      # - `settings:` (Hash) - The settings to set for the index. If empty, the method will act as a getter.
+      #
+      # ### Returns
+      #
+      # - (Hash) - The index settings.
+      #
+      # ### Behavior
+      #
+      # - If settings are provided, it sets the index settings to the provided settings.
+      # - If no argument is provided, it retrieves the index settings. 
+      # - If the `default_pipeline` is set, it merges it into the index settings.
+      #
+      # ### Example
+      #
+      # ```ruby
+      # class MyModel < Stretchy::Record
+      #   index_settings number_of_shards: 5, number_of_replicas: 1
+      # end
+      # ```
+      # In this example, the index settings for instances of `MyModel` will have 5 shards and 1 replica.
       def index_settings(settings={})
         @index_settings ||= settings
         @index_settings.merge!(default_pipeline: default_pipeline.to_s) if default_pipeline
@@ -40,6 +91,33 @@ module Stretchy
         @gateway = nil
       end
 
+      # This method is used to access the underlying `Stretchy::Repository` for the model. It creates the repository if it doesn't exist, and reuses it if it does.
+      #
+      # ### Parameters
+      #
+      # - `&block:` (optional) A block that is evaluated in the context of the repository. This can be used to perform operations on the repository.
+      #
+      # ### Returns
+      #
+      # - (Stretchy::Repository) - The repository for the model.
+      #
+      # ### Behavior
+      #
+      # - If the repository doesn't exist or if the client of the existing repository is not the current client from the Stretchy configuration, 
+      #   it creates a new repository with the current `client`, `index_name`, `class`, `mapping`, and `settings`.
+      # - If a block is given, it is evaluated in the context of the repository.
+      # - It always returns the repository.
+      #
+      # ### Example
+      #
+      # ```ruby
+      # class MyModel < Stretchy::Record
+      #   gateway do
+      #     # Perform operations on the repository
+      #   end
+      # end
+      # ```
+      #
       def gateway(&block)
           reload_gateway_configuration! if @gateway && @gateway.client != Stretchy.configuration.client
 

data/lib/stretchy/index_setting.rb

@@ -0,0 +1,94 @@
+module Stretchy
+  # This class is used to define settings for an Elasticsearch index. 
+  # It provides methods to define analyzers, filters, tokenizers, and normalizers.
+  #
+  # ## Usage
+  # ```ruby
+  # class MyIndexSetting < Stretchy::IndexSetting
+  #   analyzer :default, 
+  #            filter: [:lowercase, :asciifolding],
+  #            tokenizer: :standard
+  #
+  #   filter :my_stemmer,
+  #          type: :stemmer,
+  #          name: :light_english
+  #
+  #   tokenizer :path_tokenizer, 
+  #             type: :path_hierarchy,
+  #             reverse: true
+  #
+  #   normalizer :my_normalizer, 
+  #              type: :custom,
+  #              filter: [:lowercase]
+  # end
+  # ```
+  #
+  # In this example, we define a custom index setting `MyIndexSetting` that includes a default analyzer, a custom filter, a custom tokenizer, and a custom normalizer.
+  #
+  # ## Methods
+  # - `analyzer(name, options)`: Defines an analyzer with the given name and options.
+  # - `filter(name, options)`: Defines a filter with the given name and options.
+  # - `tokenizer(name, options)`: Defines a tokenizer with the given name and options.
+  # - `normalizer(name, options)`: Defines a normalizer with the given name and options.
+  #
+  # Each of these methods takes a name as the first argument and a hash of options as the second argument. The options will depend on the specific type of analyzer, filter, tokenizer, or normalizer being defined.
+  #
+  # ### Accessing Defined Settings
+  # You can access the settings defined in an `IndexSetting` subclass using the `analyzers`, `filters`, `tokenizers`, and `normalizers` methods. These methods return a hash of the defined settings for their respective type.
+  #
+  # ```ruby
+  #  MyIndexSetting.analyzers
+  #  # => { default: { filter: [:lowercase, :asciifolding], tokenizer: :standard } }
+  # ```
+  #
+  # ```ruby
+  #  MyIndexSetting.filters
+  #  # => { my_stemmer: { type: :stemmer, name: :light_english } }
+  # ```
+  #
+  # ```ruby
+  #  MyIndexSetting.tokenizers
+  #  # => { path_tokenizer: { type: :path_hierarchy, reverse: true } }
+  # ```
+  #
+  # ```ruby
+  #  MyIndexSetting.normalizers
+  #  # => { my_normalizer: { type: :custom, filter: [:lowercase] } }
+  # ```
+  # ### Using the Settings
+  # You can use the settings defined in an `IndexSetting` subclass to configure the settings for a `StretchyModel`.
+  #
+  # ```ruby
+  # class MyModel < StretchyModel
+  #  index_settings(MyIndexSetting.as_json)
+  # end
+  # ```
+  #
+  class IndexSetting
+    class << self
+      METHODS = [:analyzer, :filter, :tokenizer, :normalizer]
+
+      def settings
+        @settings ||= {}
+      end
+
+      def as_json
+        {
+          self.name.demodulize.underscore.to_sym => settings
+        }
+      end
+
+      METHODS.each do |method|
+        define_method(method) do |*args|
+          settings[method] ||= {}
+          settings[method][args.shift] = Hash[*args] unless args.empty?
+        end
+
+        define_method("#{method}s") do
+          settings[method] || {}
+        end
+      end
+
+    end
+  end
+end