stretchy-model 0.6.5 → 0.6.6

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

@@ -1,26 +1,35 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a flattened attribute for the model.
-  #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :depth_limit - The Integer maximum allowed depth of the flattened object field. Defaults to 20.
-  #        :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.
-  #        :ignore_above - The Integer limit for the length of leaf values. Values longer than this limit will not be indexed. By default, there is no limit.
-  #        :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 scoring purposes. Defaults to 'docs'.
-  #        :null_value - The String value to be substituted for any explicit null values. Defaults to null.
-  #        :similarity - The String scoring algorithm or similarity to be used. Defaults to 'BM25'.
-  #        :split_queries_on_whitespace - The Boolean indicating if full text queries should split the input on whitespace. Defaults to false.
-  #        :time_series_dimensions - The Array of Strings indicating the fields inside the flattened object that are dimensions of the time series.
-  #
-  # Examples
-  #
-  #   class MyModel
-  #     include StretchyModel
+  # The Flattened attribute type
+  #
+  # This class is used to define a flattened attribute for a model. It provides support for the Elasticsearch flattened data type, which is a type of data type that can hold an entire JSON object as a single field.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:flattened`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:depth_limit:` The Integer maximum allowed depth of the flattened object field. Defaults to 20.
+  #    - `: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.
+  #    - `:ignore_above:` The Integer limit for the length of leaf values. Values longer than this limit will not be indexed. By default, there is no limit.
+  #    - `: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 scoring purposes. Defaults to 'docs'.
+  #    - `:null_value:` The String value to be substituted for any explicit null values. Defaults to null.
+  #    - `:similarity:` The String scoring algorithm or similarity to be used. Defaults to 'BM25'.
+  #    - `:split_queries_on_whitespace:` The Boolean indicating if full text queries should split the input on whitespace. Defaults to false.
+  #    - `:time_series_dimensions:` The Array of Strings indicating the fields inside the flattened object that are dimensions of the time series.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a flattened attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :metadata, :flattened, depth_limit: 10, index_options: 'freqs'
   #   end
+  # ```
   #
-  # Returns nothing.
   class Flattened < Stretchy::Attributes::Type::Base
     OPTIONS = [:depth_limit, :doc_values, :eager_global_ordinals, :ignore_above, :index, :index_options, :null_value, :similarity, :split_queries_on_whitespace, :time_series_dimensions]
 

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

@@ -1,22 +1,31 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a geo_point attribute for the model.
+  # The GeoPoint attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :ignore_malformed - The Boolean indicating if malformed geopoints should be ignored. Defaults to false.
-  #        :ignore_z_value - The Boolean indicating if three dimension points should be accepted but only latitude and longitude values should be indexed. Defaults to true.
-  #        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-  #        :null_value - The GeoPoint 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.
+  # This class is used to define a geo_point attribute for a model. It provides support for the Elasticsearch geo_point data type, which is a type of data type that can hold geographical points (latitude and longitude).
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel
-  #     include StretchyModel
+  # - `type:` `:geo_point`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed geopoints should be ignored. Defaults to false.
+  #    - `:ignore_z_value:` The Boolean indicating if three dimension points should be accepted but only latitude and longitude values should be indexed. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:null_value:` The GeoPoint 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.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a geo_point attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :location, :geo_point, ignore_malformed: true
   #   end
+  # ```
   #
-  # Returns nothing.
   class GeoPoint < Stretchy::Attributes::Type::Base
     OPTIONS = [:ignore_malformed, :ignore_z_value, :index, :null_value, :on_script_error, :script]
 

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

@@ -1,22 +1,31 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a geo_shape attribute for the model.
+  # The GeoShape attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :orientation - The String default orientation for the field’s WKT polygons. Can be 'right', 'counterclockwise', 'ccw', 'left', 'clockwise', or 'cw'. Defaults to 'right'.
-  #        :ignore_malformed - The Boolean indicating if malformed GeoJSON or WKT shapes should be ignored. Defaults to false.
-  #        :ignore_z_value - The Boolean indicating if three dimension points should be accepted but only latitude and longitude values should be indexed. Defaults to true.
-  #        :coerce - The Boolean indicating if unclosed linear rings in polygons should be automatically closed. Defaults to false.
-  #        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-  #        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  # This class is used to define a geo_shape attribute for a model. It provides support for the Elasticsearch geo_shape data type, which is a type of data type that can hold geographical shapes.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel
-  #     include StretchyModel
+  # - `type:` `:geo_shape`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:orientation:` The String default orientation for the field’s WKT polygons. Can be 'right', 'counterclockwise', 'ccw', 'left', 'clockwise', or 'cw'. Defaults to 'right'.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed GeoJSON or WKT shapes should be ignored. Defaults to false.
+  #    - `:ignore_z_value:` The Boolean indicating if three dimension points should be accepted but only latitude and longitude values should be indexed. Defaults to true.
+  #    - `:coerce:` The Boolean indicating if unclosed linear rings in polygons should be automatically closed. Defaults to false.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a geo_shape attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :boundary, :geo_shape, orientation: 'left', coerce: true
   #   end
+  # ```
   #
-  # Returns nothing.
   class GeoShape < Stretchy::Attributes::Type::Base
     OPTIONS = [:orientation, :ignore_malformed, :ignore_z_value, :coerce, :index, :doc_values]
 

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

@@ -1,19 +1,29 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a hash attribute for the model.
+  # The Hash attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :dynamic - The String indicating if new properties should be added dynamically to an existing object. Can be 'true', 'runtime', 'false', or 'strict'. Defaults to 'true'.
-  #        :enabled - The Boolean indicating if the JSON value for the object field should be parsed and indexed. Defaults to true.
-  #        :subobjects - The Boolean indicating if the object can hold subobjects. Defaults to true.
-  #        :properties - The Hash of fields within the object, which can be of any data type, including object.
+  # This class is used to define a hash attribute for a model. It provides support for the Elasticsearch object data type, which is a type of data type that can hold JSON objects.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:hash`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:dynamic:` The String indicating if new properties should be added dynamically to an existing object. Can be 'true', 'runtime', 'false', or 'strict'. Defaults to 'true'.
+  #    - `:enabled:` The Boolean indicating if the JSON value for the object field should be parsed and indexed. Defaults to true.
+  #    - `:subobjects:` The Boolean indicating if the object can hold subobjects. Defaults to true.
+  #    - `:properties:` The Hash of fields within the object, which can be of any data type, including object.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a hash attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :metadata, :hash, dynamic: 'strict', subobjects: false
   #   end
+  # ```
   #
-  # Returns nothing.
   class Hash < Stretchy::Attributes::Type::Base
     OPTIONS = [:dynamic, :enabled, :subobjects, :properties]
 
@@ -26,11 +36,15 @@ module Stretchy::Attributes::Type
     end
 
     def mappings(name)
-      options = {}
+      options = {type: type_for_database}
       OPTIONS.each { |option| options[option] = send(option) unless send(option).nil? }
       { name => options }.as_json
     end
 
+    def keyword_field?
+      true
+    end
+
     private
 
     def cast_value(value)

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

@@ -1,5 +1,30 @@
 module Stretchy::Attributes::Type
+    # The Histogram attribute type
+    #
+    # This class is used to define a histogram attribute for a model. It provides support for the Elasticsearch histogram data type, which is a type of data type that can hold arrays of values and counts.
+    #
+    # ### Parameters
+    #
+    # - `type:` `:histogram`.
+    # - `options:` The Hash of options for the attribute.
+    #    - `:ignore_malformed:` The Boolean indicating if malformed numbers should be ignored. Defaults to false.
+    #    - `:coerce:` The Boolean indicating if the field should automatically convert strings to numbers and truncate fractions for integers. Defaults to true.
+    #
+    # ---
+    #
+    # ### Examples
+    #
+    # #### Define a histogram attribute
+    #
+    # ```ruby
+    #   class MyModel < StretchyModel
+    #     attribute :grades_distribution, :histogram, ignore_malformed: true
+    #   end
+    # ```
+    #
     class Histogram < Stretchy::Attributes::Type::Base
+        OPTIONS = [:ignore_malformed, :coerce]
+
         def type
             :histogram
         end

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

@@ -1,24 +1,33 @@
 module Stretchy::Attributes::Type
-  # Public: Defines an IP attribute for the model.
-  #
-  # 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.
-  #        :ignore_malformed - The Boolean indicating if malformed IP addresses should be ignored. Defaults to false.
-  #        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-  #        :null_value - The String IPv4 or IPv6 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 'reject' or 'ignore'.
-  #        :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.
-  #        :time_series_dimension - The Boolean indicating if the field is a time series dimension. Defaults to false.
-  #
-  # Examples
-  #
-  #   class MyModel
-  #     include StretchyModel
+  # The IP attribute type
+  #
+  # This class is used to define an IP attribute for a model. It provides support for the Elasticsearch IP data type, which is a type of data type that can hold IPv4 and IPv6 addresses.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:ip`.
+  # - `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.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed IP addresses should be ignored. Defaults to false.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:null_value:` The String IPv4 or IPv6 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 'reject' or 'ignore'.
+  #    - `: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.
+  #    - `:time_series_dimension:` The Boolean indicating if the field is a time series dimension. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define an IP attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :ip_address, :ip, ignore_malformed: true, time_series_dimension: true
   #   end
+  # ```
   #
-  # Returns nothing.
   class IP < Stretchy::Attributes::Type::Base
     OPTIONS = [:doc_values, :ignore_malformed, :index, :null_value, :on_script_error, :script, :store, :time_series_dimension]
 

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

@@ -1,17 +1,26 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a join attribute for the model.
+  # The Join attribute type
   #
-  # opts - The Hash options used to define the parent/child relation within documents of the same index (default: {}):
-  #        :relations - The Hash defining a set of possible relations within the documents, each relation being a parent name and a child name.
+  # This class is used to define a join attribute for a model. It provides support for the Elasticsearch join data type, which is a type of data type that can hold parent/child relationships within documents of the same index.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel
-  #     include StretchyModel
+  # - `type:` `:join`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:relations:` The Hash defining a set of possible relations within the documents, each relation being a parent name and a child name.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a join attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :relation, :join, relations: { question: :answer }
   #   end
+  # ```
   #
-  # Returns nothing.
   class Join < Stretchy::Attributes::Type::Base
     OPTIONS = [:relations]
 

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

@@ -1,37 +1,32 @@
 module Stretchy::Attributes::Type
-    # Public: Defines a keyword attribute for the model.
-    #
-    # 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
-    #     attribute :tag, :keyword, ignore_above: 256, time_series_dimension: true
+    # The Join attribute type
+    #
+    # This class is used to define a join attribute for a model. It provides support for the Elasticsearch join data type, which is a type of data type that can hold parent/child relationships within documents of the same index.
+    #
+    # ### Parameters
+    #
+    # - `type:` `:join`.
+    # - `options:` The Hash of options for the attribute.
+    #    - `:relations:` The Hash defining a set of possible relations within the documents, each relation being a parent name and a child name.
+    #
+    # ---
+    #
+    # ### Examples
+    #
+    # #### Define a join attribute
+    #
+    # ```ruby
+    #   class MyModel < StretchyModel
+    #     attribute :relation, :join, relations: { question: :answer }
     #   end
+    # ```
     #
-    # Returns nothing.
     class Keyword < Stretchy::Attributes::Type::Base
       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]
   
       def type
         :keyword
       end
+
     end
   end

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

@@ -0,0 +1,47 @@
+module Stretchy::Attributes::Type
+  # The KnnVector attribute type.
+  #
+  # This class is used to define a `knn_vector` attribute for a model. 
+  # It provides support for the Elasticsearch `knn_vector` data type, 
+  # which is a type of data type that can hold vectors of float values.
+  #
+  # ### Parameters
+  #
+  # The `knn_vector` data type supports the following options:
+  # - `dimension`: The number of dimensions in the vector.
+  # - `method`: The method used for nearest neighbor search. This is a hash that can include the following keys:
+  #   - `name`: The name of the method.
+  #   - `space_type`: The type of space used for the method.
+  #   - `engine`: The engine used for the method.
+  #   - `parameters`: Any additional parameters for the method.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  #
+  # #### Define a `knn_vector` attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :my_vector, :knn_vector
+  #   end
+  # ```
+  #
+  # #### Define a `knn_vector` attribute with options
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :my_vector, :knn_vector, dimension: 3, method: { name: "hnsw", space_type: "cosinesimil", engine: "nmslib", parameters: { ef_construction: 200 } }
+  #   end
+  # ```
+  #
+  class KnnVector < Stretchy::Attributes::Type::Base
+      OPTIONS = [:dimension, :method]
+
+      def type
+        :knn_vector
+      end
+
+  end
+end

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

@@ -1,5 +1,26 @@
-# a space-optimized variant of text that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages.
 module Stretchy::Attributes::Type
+  # The MatchOnlyText attribute type
+  #
+  # This class is used to define a match_only_text attribute for a model. It provides support for the Elasticsearch match_only_text data type, which is a space-optimized variant of text that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages.
+  # `:match_only_text` is a space-optimized variant of text that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:match_only_text`.
+  # - `options:` The Hash of options for the attribute. This type does not have any specific options.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a match_only_text attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :log_message, :match_only_text
+  #   end
+  # ```
+  #
   class MatchOnlyText < Stretchy::Attributes::Type::Text
     def type
       :match_only_text

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

@@ -1,20 +1,25 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a nested attribute for the model.
+  # The MatchOnlyText attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :dynamic - The String indicating if new properties should be added dynamically to an existing nested object. Can be 'true', 'false', or 'strict'. Defaults to 'true'.
-  #        :properties - The Hash of fields within the nested object, which can be of any data type, including nested.
-  #        :include_in_parent - The Boolean indicating if all fields in the nested object are also added to the parent document as standard fields. Defaults to false.
-  #        :include_in_root - The Boolean indicating if all fields in the nested object are also added to the root document as standard fields. Defaults to false.
+  # This class is used to define a match_only_text attribute for a model. It provides support for the Elasticsearch match_only_text data type, which is a space-optimized variant of text that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel
-  #     include StretchyModel
-  #     attribute :metadata, :nested, dynamic: 'strict', include_in_parent: true
+  # - `type:` `:match_only_text`.
+  # - `options:` The Hash of options for the attribute. This type does not have any specific options.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a match_only_text attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :log_message, :match_only_text
   #   end
+  # ```
   #
-  # Returns nothing.
   class Nested < Stretchy::Attributes::Type::Base
     OPTIONS = [:dynamic, :properties, :include_in_parent, :include_in_root]
 

data/lib/stretchy/attributes/type/numeric/base.rb

@@ -1,29 +1,37 @@
 module Stretchy::Attributes::Type::Numeric
-  # Public: Defines a numeric attribute for the model. This is a base class for numeric types.
-  #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :coerce - The Boolean indicating if strings should be converted to numbers and fractions truncated for integers. Defaults to true.
-  #        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
-  #        :ignore_malformed - The Boolean indicating if malformed numbers should be ignored. Defaults to false.
-  #        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-  #        :meta - The Hash metadata about the field.
-  #        :null_value - The Numeric 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.
-  #        :time_series_dimension - The Boolean indicating if the field is a time series dimension. Defaults to false.
-  #        :time_series_metric - The String indicating if the field is a time series metric. Can be 'counter', 'gauge', or 'null'.
-  #
-  # Examples
-  #
-  #   class MyModel
-  #     include StretchyModel
+  # The Base class for numeric attribute types
+  #
+  # This class is used to define a base for numeric attribute types for a model. It provides support for the Elasticsearch numeric data types, which are types of data that can hold numeric values.
+  #
+  # ### Parameters
+  #
+  # - `options:` The Hash of options for the attribute.
+  #    - `:coerce:` The Boolean indicating if strings should be converted to numbers and fractions truncated for integers. Defaults to true.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed numbers should be ignored. Defaults to false.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:meta:` The Hash metadata about the field.
+  #    - `:null_value:` The Numeric 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.
+  #    - `:time_series_dimension:` The Boolean indicating if the field is a time series dimension. Defaults to false.
+  #    - `:time_series_metric:` The String indicating if the field is a time series metric. Can be 'counter', 'gauge', or 'null'.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a numeric attribute
+  #
+  # ```ruby
+  #   class MyModel < Stretchy::Record
   #     attribute :age, :integer, coerce: false, time_series_dimension: true
   #   end
+  # ```
   #
-  # Returns nothing.
-  class Base < Stretchy::Attributes::Type::Base
-    OPTIONS = [:coerce, :doc_values, :ignore_malformed, :index, :meta, :null_value, :on_script_error, :script, :store, :time_series_dimension, :time_series_metric]
+  class Base < Stretchy::Attributes::Type::Base #:nodoc:
+    OPTIONS = [:coerce, :doc_values, :ignore_malformed, :index, :meta, :null_value, :on_script_error, :script, :store, :time_series_dimension, :time_series_metric] + self.superclass::OPTIONS
 
     def type
       raise NotImplementedError, "You must use one of the numeric types: integer, long, short, byte, double, float, half_float, scaled_float."

data/lib/stretchy/attributes/type/numeric/byte.rb

@@ -1,4 +1,24 @@
 module Stretchy::Attributes::Type::Numeric
+  # The Byte attribute type
+  #
+  # This class is used to define a byte attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold byte values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:byte`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a byte attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :data, :byte
+  #   end
+  # ```
+  #
   class Byte < Base
     def type
       :byte

data/lib/stretchy/attributes/type/numeric/double.rb

@@ -1,4 +1,24 @@
 module Stretchy::Attributes::Type::Numeric
+  # The Double attribute type
+  #
+  # This class is used to define a double attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold double-precision 64-bit IEEE 754 floating point values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:double`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a double attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :rating, :double
+  #   end
+  # ```
+  #
   class Double < Base
     def type
       :double

data/lib/stretchy/attributes/type/numeric/float.rb

@@ -1,4 +1,24 @@
 module Stretchy::Attributes::Type::Numeric
+  # The Float attribute type
+  #
+  # This class is used to define a float attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold single-precision 32-bit IEEE 754 floating point values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:float`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a float attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :rating, :float
+  #   end
+  # ```
+  #
   class Float < Base
     def type
       :float