shale 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a0f059693d5ea371ffca8b475ebb261ee99096509e588d2f1163a96bf8fbc0
-  data.tar.gz: c1af0c61c7d9a93bd601188c50916d4f702228052541adee34456c4d7dac8b9a
+  metadata.gz: 81b22181e1c63b2757fdd137f09a185caf894de6d43c108119c18c9260b48afd
+  data.tar.gz: 065bc2d6f8a6eec466b52574ed38846dc0b4e0315ba9b83fc0d24ed75066ef07
 SHA512:
-  metadata.gz: 31bd59c352febaf287eda07a79f56e5fe942fd86623f532e48c25ff5e946bb53fc879c3f8bb13121989268057beb4ee740f8aac7b1275dda8b9a2d21a5f75aaf
-  data.tar.gz: 127b46cdeb0960643aa60410597f7ace1815dd19e3845cd0cb7c2ea3d2d44b4326333656bdf96209effcf17daabbc5a70de9f430acd42e21d961e2c356d9be9f
+  metadata.gz: 9b106ac74372bc089093ee8c12238b48505cff4d318967e2760ef2842e9a783125227177fd5f2cb47b27872adc7cbbf0686226934132b5c8f346c71b92159c8a
+  data.tar.gz: dcb0088d6f700f1654313a72156e9d1e4cd0c1b75b99a82cea17e12af96ced1407e358b1d0cc52e7e3f0a1c46cb19d702b3a49628a0da67e521a20906e006a6c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.2.0] - 2024-10-31
+
+### Added
+- Allow to pass adapter specific options
+- Allow to pass `additional_properties` option to JSON Schema generator
+- Allow to pass `description` option to JSON Schema generator
+- Support for symbol type aliases in attribute mappings
+
 ## [1.1.0] - 2024-02-17
 
 ### Added

data/README.md

@@ -65,6 +65,7 @@ $ gem install shale
 * [Using methods to extract and generate data](#using-methods-to-extract-and-generate-data)
 * [Delegating fields to child attributes](#delegating-fields-to-child-attributes)
 * [Additional options](#additional-options)
+* [Overriding attribute methods](#overriding-attribute-methods)
 * [Using custom models](#using-custom-models)
 * [Supported types](#supported-types)
 * [Writing your own type](#writing-your-own-type)
@@ -82,17 +83,17 @@ $ gem install shale
 require 'shale'
 
 class Address < Shale::Mapper
-  attribute :city, Shale::Type::String
-  attribute :street, Shale::Type::String
-  attribute :zip, Shale::Type::String
+  attribute :city, :string
+  attribute :street, :string
+  attribute :zip, :string
 end
 
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :age, Shale::Type::Integer
-  attribute :married, Shale::Type::Boolean, default: -> { false }
-  attribute :hobbies, Shale::Type::String, collection: true
+  attribute :first_name, :string
+  attribute :last_name, :string
+  attribute :age, :integer
+  attribute :married, :boolean, default: -> { false }
+  attribute :hobbies, :string, collection: true
   attribute :address, Address
 end
 ```
@@ -208,8 +209,8 @@ person.to_yaml
 ### Converting TOML to object
 
 To use TOML with Shale you have to set adapter you want to use.
-Out of the box Shale suports [Tomlib](https://github.com/kgiszczak/tomlib).
-It also comes with adapter for [toml-rb](https://github.com/emancu/toml-rb) if you prefer that.
+It comes with adapters for [Tomlib](https://github.com/kgiszczak/tomlib) and
+[toml-rb](https://github.com/emancu/toml-rb).
 For details see [Adapters](#adapters) section.
 
 To set it, first make sure Tomlib gem is installed:
@@ -221,8 +222,8 @@ $ gem install tomlib
 then setup adapter:
 
 ```ruby
-require 'tomlib'
-Shale.toml_adapter = Tomlib
+require 'sahle/adapter/tomlib'
+Shale.toml_adapter = Shale::Adapter::Tomlib
 
 # Alternatively if you'd like to use toml-rb, use:
 require 'shale/adapter/toml_rb'
@@ -442,8 +443,8 @@ By default keys are named the same as attributes. To use custom keys use:
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 
   json do
     map 'firstName', to: :first_name
@@ -456,8 +457,8 @@ end
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 
   yaml do
     map 'firstName', to: :first_name
@@ -470,8 +471,8 @@ end
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 
   toml do
     map 'firstName', to: :first_name
@@ -488,8 +489,8 @@ to `:first_name` attribute and the second column to `:last_name`.
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 
   csv do
     map 'firstName', to: :first_name
@@ -502,8 +503,8 @@ end
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 
   hsh do
     map 'firstName', to: :first_name
@@ -518,9 +519,9 @@ XML is more complicated format than JSON or YAML. To map elements, attributes an
 
 ```ruby
 class Address < Shale::Mapper
-  attribute :street, Shale::Type::String
-  attribute :city, Shale::Type::String
-  attribute :zip, Shale::Type::String
+  attribute :street, :string
+  attribute :city, :string
+  attribute :zip, :string
 
   xml do
     map_content to: :street
@@ -530,10 +531,10 @@ class Address < Shale::Mapper
 end
 
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :age, Shale::Type::Integer
-  attribute :hobbies, Shale::Type::String, collection: true
+  attribute :first_name, :string
+  attribute :last_name, :string
+  attribute :age, :integer
+  attribute :hobbies, :string, collection: true
   attribute :address, Address
 
   xml do
@@ -572,7 +573,7 @@ You can use `cdata: true` option on `map_element` and `map_content` to handle CD
 
 ```ruby
 class Address < Shale::Mapper
-  attribute :content, Shale::Type::String
+  attribute :content, :string
 
   xml do
     map_content to: :content, cdata: true
@@ -580,7 +581,7 @@ class Address < Shale::Mapper
 end
 
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
+  attribute :first_name, :string
   attribute :address, Address
 
   xml do
@@ -606,9 +607,9 @@ To map namespaced elements and attributes use `namespace` and `prefix` propertie
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :age, Shale::Type::Integer
+  attribute :first_name, :string
+  attribute :last_name, :string
+  attribute :age, :integer
 
   xml do
     root 'person'
@@ -633,11 +634,11 @@ explicitly declare it on `map_attribute`).
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :middle_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :age, Shale::Type::Integer
-  attribute :hobby, Shale::Type::String
+  attribute :first_name, :string
+  attribute :middle_name, :string
+  attribute :last_name, :string
+  attribute :age, :integer
+  attribute :hobby, :string
 
   xml do
     root 'person'
@@ -673,9 +674,9 @@ For CSV the default is to render `nil` elements.
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :age, Shale::Type::Integer
+  attribute :first_name, :string
+  attribute :last_name, :string
+  attribute :age, :integer
 
   json do
     map 'first_name', to: :first_name, render_nil: true
@@ -723,9 +724,9 @@ class Base < Shale::Mapper
 end
 
 class Person < Base
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :age, Shale::Type::Integer
+  attribute :first_name, :string
+  attribute :last_name, :string
+  attribute :age, :integer
 
   json do
     # override default from Base class
@@ -742,8 +743,8 @@ end
 
 ```ruby
 class Person < Base
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 
   json do
     render_nil false
@@ -762,9 +763,9 @@ you can use methods to do so:
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :hobbies, Shale::Type::String, collection: true
-  attribute :street, Shale::Type::String
-  attribute :city, Shale::Type::String
+  attribute :hobbies, :string, collection: true
+  attribute :street, :string
+  attribute :city, :string
 
   json do
     map 'hobbies', using: { from: :hobbies_from_json, to: :hobbies_to_json }
@@ -853,7 +854,7 @@ You can also pass a `context` object that will be available in extractor/generat
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :password, Shale::Type::String
+  attribute :password, :string
 
   json do
     map 'password', using: { from: :password_from_json, to: :password_to_json }
@@ -883,7 +884,7 @@ If you want to work on multiple elements at a time you can group them using `gro
 
 ```ruby
 class Person < Shale::Mapper
-  attribute :name, Shale::Type::String
+  attribute :name, :string
 
   json do
     group from: :name_from_json, to: :name_to_json do
@@ -934,12 +935,12 @@ To delegate fields to child complex types you can use `receiver: :child` declara
 
 ```ruby
 class Address < Shale::Mapper
-  attribute :city, Shale::Type::String
-  attribute :street, Shale::Type::String
+  attribute :city, :string
+  attribute :street, :string
 end
 
 class Person < Shale::Mapper
-  attribute :name, Shale::Type::String
+  attribute :name, :string
   attribute :address, Address
 
   json do
@@ -1059,8 +1060,8 @@ names and shouldn't be included in the returned collection. It also accepts all
 
 ```ruby
 class Person
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
 end
 
 people = Person.from_csv(<<~DATA, headers: true, col_sep: '|')
@@ -1085,6 +1086,63 @@ Person.to_csv(people, headers: true, col_sep: '|')
 # James|Sixpack
 ```
 
+Most adapters accept options specific to them. Eg. if you want to be able to work
+with NaN values in JSON:
+
+```ruby
+class Person
+  attribute :age, :float
+end
+
+person = Person.from_json('{"age": NaN}', allow_nan: true)
+
+# =>
+#
+# #<Person:0x0000000113d7a488 @age=Float::NAN>
+
+Person.to_json(person, allow_nan: true)
+
+# =>
+#
+# {
+#   "age": NaN
+# }
+```
+
+### Overriding attribute methods
+
+It's possible to override an attribute method to change its output:
+
+```ruby
+class Person < Shale::Mapper
+  attribute :gender, :string
+
+  def gender
+    if super == 'm'
+      'male'
+    else
+      'female'
+    end
+  end
+end
+
+puts Person.from_json('{"gender":"m"}')
+
+# =>
+#
+# #<Person:0x00007f9bc3086d60
+#  @gender="male">
+```
+
+Be conscious that the original attribute value will be lost after its transformation though:
+
+```ruby
+puts User.from_json('{"gender":"m"}').to_json
+# => {"gender":"male"}
+```
+
+It'll no longer return gender `m`.
+
 ### Using custom models
 
 By default Shale combines mapper and model into one class. If you want to use your own classes
@@ -1102,15 +1160,15 @@ end
 class AddressMapper < Shale::Mapper
   model Address
 
-  attribute :street, Shale::Type::String
-  attribute :city, Shale::Type::String
+  attribute :street, :string
+  attribute :city, :string
 end
 
 class PersonMapper < Shale::Mapper
   model Person
 
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
+  attribute :first_name, :string
+  attribute :last_name, :string
   attribute :address, AddressMapper
 end
 
@@ -1150,12 +1208,21 @@ PersonMapper.to_json(person, pretty: true)
 
 Shale supports these types out of the box:
 
-- `Shale::Type::Boolean`
-- `Shale::Type::Date`
-- `Shale::Type::Float`
-- `Shale::Type::Integer`
-- `Shale::Type::String`
-- `Shale::Type::Time`
+- `:boolean` (`Shale::Type::Boolean`)
+- `:date` (`Shale::Type::Date`)
+- `:float` (`Shale::Type::Float`)
+- `:integer` (`Shale::Type::Integer`)
+- `:string` (`Shale::Type::String`)
+- `:time` (`Shale::Type::Time`)
+
+The symbol type alias and the type class are interchangeable:
+
+```ruby
+class Person < Shale::Mapper
+  attribute :age, Shale::Type::Integer
+  # attribute :age, :integer
+end
+```
 
 ### Writing your own type
 
@@ -1171,6 +1238,31 @@ class MyIntegerType < Shale::Type::Value
 end
 ```
 
+Then you can use it in your model:
+
+```ruby
+class Person < Shale::Mapper
+  attribute :age, MyIntegerType
+end
+```
+
+You can also register your own type with a symbol alias if you
+intend to use it often.
+
+```ruby
+require 'shale/type'
+
+Shale::Type.register(:my_integer, MyIntegerType)
+```
+
+Then you can use it like this:
+
+```ruby
+class Person < Shale::Mapper
+  attribute :age, :my_integer
+end
+```
+
 ### Adapters
 
 Shale uses adapters for parsing and generating documents.
@@ -1323,18 +1415,18 @@ require 'shale/schema'
 class PersonMapper < Shale::Mapper
   model Person
 
-  attribute :first_name, Shale::Type::String
-  attribute :last_name, Shale::Type::String
-  attribute :address, Shale::Type::String
-  attribute :age, Shale::Type::Integer
+  attribute :first_name, :string
+  attribute :last_name, :string
+  attribute :address, :string
+  attribute :age, :integer
 
   json do
-    properties max_properties: 5
+    properties max_properties: 5, additional_properties: false
 
     map "first_name", to: :first_name, schema: { required: true }
     map "last_name", to: :last_name, schema: { required: true }
-    map "address", to: :age, schema: { max_length: 128 }
-    map "age", to: :age, schema: { minimum: 1, maximum: 150 }
+    map "address", to: :address, schema: { max_length: 128, description: "Street, home number, city and country" }
+    map "age", to: :age, schema: { minimum: 1, maximum: 150, description: "Person age" }
   end
 end
 
@@ -1352,7 +1444,6 @@ Shale::Schema.to_json(
 #   "$defs": {
 #     "Person": {
 #       "type": "object",
-#       "maxProperties": 5,
 #       "properties": {
 #         "first_name": {
 #           "type": "string"
@@ -1360,23 +1451,30 @@ Shale::Schema.to_json(
 #         "last_name": {
 #           "type": "string"
 #         },
-#         "age": {
+#         "address": {
 #           "type": [
-#             "integer",
+#             "string",
 #             "null"
 #           ],
-#          "minimum": 1,
-#          "maximum": 150
-#        },
-#         "address": {
+#           "maxLength": 128,
+#           "description": "Street, home number, city and country"
+#         },
+#         "age": {
 #           "type": [
-#             "string",
+#             "integer",
 #             "null"
 #           ],
-#           "maxLength": 128
+#           "minimum": 1,
+#           "maximum": 150,
+#           "description": "Person age"
 #         }
 #       },
-#       "required": ["first_name", "last_name"]
+#       "required": [
+#         "first_name",
+#         "last_name"
+#       ],
+#       "maxProperties": 5,
+#       "additionalProperties": false
 #     }
 #   }
 # }

data/lib/shale/adapter/json.rb

@@ -11,27 +11,30 @@ module Shale
       # Parse JSON into Hash
       #
       # @param [String] json JSON document
+      # @param [Hash] options
       #
       # @return [Hash]
       #
       # @api private
-      def self.load(json)
-        ::JSON.parse(json)
+      def self.load(json, **options)
+        ::JSON.parse(json, **options)
       end
 
       # Serialize Hash into JSON
       #
       # @param [Hash] obj Hash object
-      # @param [true, false] pretty
+      # @param [Hash] options
       #
       # @return [String]
       #
       # @api private
-      def self.dump(obj, pretty: false)
-        if pretty
-          ::JSON.pretty_generate(obj)
+      def self.dump(obj, **options)
+        json_options = options.except(:pretty)
+
+        if options[:pretty]
+          ::JSON.pretty_generate(obj, **json_options)
         else
-          ::JSON.generate(obj)
+          ::JSON.generate(obj, **json_options)
         end
       end
     end

data/lib/shale/adapter/toml_rb.rb

@@ -4,29 +4,31 @@ require 'toml-rb'
 
 module Shale
   module Adapter
-    # TOML adapter
+    # TomlRB adapter
     #
     # @api public
     class TomlRB
       # Parse TOML into Hash
       #
       # @param [String] toml TOML document
+      # @param [Hash] options
       #
       # @return [Hash]
       #
       # @api private
-      def self.load(toml)
+      def self.load(toml, **_options)
         ::TomlRB.parse(toml)
       end
 
       # Serialize Hash into TOML
       #
       # @param [Hash] obj Hash object
+      # @param [Hash] options
       #
       # @return [String]
       #
       # @api private
-      def self.dump(obj)
+      def self.dump(obj, **_options)
         ::TomlRB.dump(obj)
       end
     end

data/lib/shale/adapter/tomlib.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'tomlib'
+
+module Shale
+  module Adapter
+    # Tomlib adapter
+    #
+    # @api public
+    class Tomlib
+      # Parse TOML into Hash
+      #
+      # @param [String] toml TOML document
+      # @param [Hash] options
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def self.load(toml, **_options)
+        ::Tomlib.load(toml)
+      end
+
+      # Serialize Hash into TOML
+      #
+      # @param [Hash] obj Hash object
+      # @param [Hash] options
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.dump(obj, **options)
+        ::Tomlib.dump(obj, **options)
+      end
+    end
+  end
+end

data/lib/shale/error.rb

@@ -9,7 +9,8 @@ module Shale
 
     # To use Tomlib:
     # Make sure tomlib is installed eg. execute: gem install tomlib
-    Shale.toml_adapter = Tomlib
+    require 'shale/adapter/tomlib'
+    Shale.toml_adapter = Shale::Adapter::Tomlib
 
     # To use toml-rb:
     # Make sure toml-rb is installed eg. execute: gem install toml-rb
@@ -104,6 +105,18 @@ module Shale
   class NotAShaleMapperError < ShaleError
   end
 
+  # Error for registering class that is not a valid Type::Value
+  #
+  # @api private
+  class NotATypeValueError < ShaleError
+  end
+
+  # Error for using unknown symbol type
+  #
+  # @api private
+  class UnknownTypeError < ShaleError
+  end
+
   # Raised when receiver attribute is not defined
   #
   # @api private

data/lib/shale/mapper.rb

@@ -5,6 +5,7 @@ require_relative 'error'
 require_relative 'utils'
 require_relative 'mapping/dict'
 require_relative 'mapping/xml'
+require_relative 'type'
 require_relative 'type/complex'
 
 module Shale
@@ -12,16 +13,16 @@ module Shale
   #
   # @example
   #   class Address < Shale::Mapper
-  #     attribute :city, Shale::Type::String
-  #     attribute :street, Shale::Type::String
-  #     attribute :state, Shale::Type::Integer
-  #     attribute :zip, Shale::Type::String
+  #     attribute :city, :string
+  #     attribute :street, :string
+  #     attribute :state, :string
+  #     attribute :zip, :string
   #   end
   #
   #   class Person < Shale::Mapper
-  #     attribute :first_name, Shale::Type::String
-  #     attribute :last_name, Shale::Type::String
-  #     attribute :age, Shale::Type::Integer
+  #     attribute :first_name, :string
+  #     attribute :last_name, :string
+  #     attribute :age, :integer
   #     attribute :address, Address
   #   end
   #
@@ -144,18 +145,19 @@ module Shale
       # Define attribute on class
       #
       # @param [Symbol] name Name of the attribute
-      # @param [Shale::Type::Value] type Type of the attribute
+      # @param [Symbol, Class<Shale::Type::Value>] type Type of the attribute
       # @param [Boolean] collection Is the attribute a collection
       # @param [Proc] default Default value for the attribute
       #
       # @raise [DefaultNotCallableError] when attribute's default is not callable
+      # @raise [UnknownTypeError] when type is a symbol and not found in the registry
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer, default: -> { 1 }
-      #     attribute :hobbies, Shale::Type::String, collection: true
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer, default: -> { 1 }
+      #     attribute :hobbies, :string, collection: true
       #   end
       #
       #   person = Person.new
@@ -177,6 +179,10 @@ module Shale
           raise DefaultNotCallableError.new(to_s, name)
         end
 
+        if type.is_a?(Symbol)
+          type = Type.lookup(type)
+        end
+
         @attributes[name] = Attribute.new(name, type, collection, default)
 
         @hash_mapping.map(name.to_s, to: name) unless @hash_mapping.finalized?
@@ -201,9 +207,9 @@ module Shale
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer
       #
       #     hsh do
       #       map 'firstName', to: :first_name
@@ -225,9 +231,9 @@ module Shale
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer
       #
       #     json do
       #       map 'firstName', to: :first_name
@@ -249,9 +255,9 @@ module Shale
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer
       #
       #     yaml do
       #       map 'first_name', to: :first_name
@@ -273,9 +279,9 @@ module Shale
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer
       #
       #     toml do
       #       map 'first_name', to: :first_name
@@ -297,9 +303,9 @@ module Shale
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer
       #
       #     csv do
       #       map 'first_name', to: :first_name
@@ -321,9 +327,9 @@ module Shale
       #
       # @example
       #   class Person < Shale::Mapper
-      #     attribute :first_name, Shale::Type::String
-      #     attribute :last_name, Shale::Type::String
-      #     attribute :age, Shale::Type::Integer
+      #     attribute :first_name, :string
+      #     attribute :last_name, :string
+      #     attribute :age, :integer
       #
       #     xml do
       #       root 'Person'

data/lib/shale/mapping/dict_base.rb

@@ -67,13 +67,15 @@ module Shale
       # @param [Integer] min_properties
       # @param [Integer] max_properties
       # @param [Hash] dependent_required
+      # @param [Boolean] additional_properties
       #
       # @api public
-      def properties(min_properties: nil, max_properties: nil, dependent_required: nil)
+      def properties(min_properties: nil, max_properties: nil, dependent_required: nil, additional_properties: nil)
         @root = {
           min_properties: min_properties,
           max_properties: max_properties,
           dependent_required: dependent_required,
+          additional_properties: additional_properties,
         }
       end
 

data/lib/shale/schema/json_generator/boolean.rb

@@ -15,7 +15,8 @@ module Shale
         #
         # @api private
         def as_type
-          { 'type' => 'boolean' }
+          { 'type' => 'boolean',
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/collection.rb

@@ -46,7 +46,8 @@ module Shale
             'maxItems' => schema[:max_items],
             'uniqueItems' => schema[:unique],
             'minContains' => schema[:min_contains],
-            'maxContains' => schema[:max_contains] }.compact
+            'maxContains' => schema[:max_contains],
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/date.rb

@@ -15,7 +15,9 @@ module Shale
         #
         # @api private
         def as_type
-          { 'type' => 'string', 'format' => 'date' }
+          { 'type' => 'string',
+            'format' => 'date',
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/float.rb

@@ -20,7 +20,8 @@ module Shale
             'exclusiveMaximum' => schema[:exclusive_maximum],
             'minimum' => schema[:minimum],
             'maximum' => schema[:maximum],
-            'multipleOf' => schema[:multiple_of] }.compact
+            'multipleOf' => schema[:multiple_of],
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/integer.rb

@@ -20,7 +20,8 @@ module Shale
             'exclusiveMaximum' => schema[:exclusive_maximum],
             'minimum' => schema[:minimum],
             'maximum' => schema[:maximum],
-            'multipleOf' => schema[:multiple_of] }.compact
+            'multipleOf' => schema[:multiple_of],
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/object.rb

@@ -40,6 +40,8 @@ module Shale
             'minProperties' => @root[:min_properties],
             'maxProperties' => @root[:max_properties],
             'dependentRequired' => @root[:dependent_required],
+            'description' => @root[:description],
+            'additionalProperties' => @root[:additional_properties],
           }.compact
         end
       end

data/lib/shale/schema/json_generator/string.rb

@@ -19,7 +19,8 @@ module Shale
             'format' => schema[:format],
             'minLength' => schema[:min_length],
             'maxLength' => schema[:max_length],
-            'pattern' => schema[:pattern] }.compact
+            'pattern' => schema[:pattern],
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/time.rb

@@ -15,7 +15,9 @@ module Shale
         #
         # @api private
         def as_type
-          { 'type' => 'string', 'format' => 'date-time' }
+          { 'type' => 'string',
+            'format' => 'date-time',
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/schema/json_generator/value.rb

@@ -15,7 +15,8 @@ module Shale
         #
         # @api private
         def as_type
-          { 'type' => %w[boolean integer number object string] }
+          { 'type' => %w[boolean integer number object string],
+            'description' => schema[:description] }.compact
         end
       end
     end

data/lib/shale/type/boolean.rb

@@ -29,5 +29,7 @@ module Shale
         !FALSE_VALUES.include?(value) unless value.nil?
       end
     end
+
+    register(:boolean, Boolean)
   end
 end

data/lib/shale/type/complex.rb

@@ -257,13 +257,14 @@ module Shale
         # @param [Array<Symbol>] only
         # @param [Array<Symbol>] except
         # @param [any] context
+        # @param [Hash] json_options
         #
         # @return [model instance]
         #
         # @api public
-        def from_json(json, only: nil, except: nil, context: nil)
+        def from_json(json, only: nil, except: nil, context: nil, **json_options)
           of_json(
-            Shale.json_adapter.load(json),
+            Shale.json_adapter.load(json, **json_options),
             only: only,
             except: except,
             context: context
@@ -277,14 +278,15 @@ module Shale
         # @param [Array<Symbol>] except
         # @param [any] context
         # @param [true, false] pretty
+        # @param [Hash] json_options
         #
         # @return [String]
         #
         # @api public
-        def to_json(instance, only: nil, except: nil, context: nil, pretty: false)
+        def to_json(instance, only: nil, except: nil, context: nil, pretty: false, **json_options)
           Shale.json_adapter.dump(
             as_json(instance, only: only, except: except, context: context),
-            pretty: pretty
+            **json_options.merge(pretty: pretty)
           )
         end
 
@@ -294,13 +296,14 @@ module Shale
         # @param [Array<Symbol>] only
         # @param [Array<Symbol>] except
         # @param [any] context
+        # @param [Hash] yaml_options
         #
         # @return [model instance]
         #
         # @api public
-        def from_yaml(yaml, only: nil, except: nil, context: nil)
+        def from_yaml(yaml, only: nil, except: nil, context: nil, **yaml_options)
           of_yaml(
-            Shale.yaml_adapter.load(yaml),
+            Shale.yaml_adapter.load(yaml, **yaml_options),
             only: only,
             except: except,
             context: context
@@ -313,13 +316,15 @@ module Shale
         # @param [Array<Symbol>] only
         # @param [Array<Symbol>] except
         # @param [any] context
+        # @param [Hash] yaml_options
         #
         # @return [String]
         #
         # @api public
-        def to_yaml(instance, only: nil, except: nil, context: nil)
+        def to_yaml(instance, only: nil, except: nil, context: nil, **yaml_options)
           Shale.yaml_adapter.dump(
-            as_yaml(instance, only: only, except: except, context: context)
+            as_yaml(instance, only: only, except: except, context: context),
+            **yaml_options
           )
         end
 
@@ -329,14 +334,15 @@ module Shale
         # @param [Array<Symbol>] only
         # @param [Array<Symbol>] except
         # @param [any] context
+        # @param [Hash] toml_options
         #
         # @return [model instance]
         #
         # @api public
-        def from_toml(toml, only: nil, except: nil, context: nil)
+        def from_toml(toml, only: nil, except: nil, context: nil, **toml_options)
           validate_toml_adapter
           of_toml(
-            Shale.toml_adapter.load(toml),
+            Shale.toml_adapter.load(toml, **toml_options),
             only: only,
             except: except,
             context: context
@@ -349,14 +355,16 @@ module Shale
         # @param [Array<Symbol>] only
         # @param [Array<Symbol>] except
         # @param [any] context
+        # @param [Hash] toml_options
         #
         # @return [String]
         #
         # @api public
-        def to_toml(instance, only: nil, except: nil, context: nil)
+        def to_toml(instance, only: nil, except: nil, context: nil, **toml_options)
           validate_toml_adapter
           Shale.toml_adapter.dump(
-            as_toml(instance, only: only, except: except, context: context)
+            as_toml(instance, only: only, except: except, context: context),
+            **toml_options
           )
         end
 
@@ -1000,17 +1008,19 @@ module Shale
       # @param [Array<Symbol>] except
       # @param [any] context
       # @param [true, false] pretty
+      # @param [Hash] json_options
       #
       # @return [String]
       #
       # @api public
-      def to_json(only: nil, except: nil, context: nil, pretty: false)
+      def to_json(only: nil, except: nil, context: nil, pretty: false, **json_options)
         self.class.to_json(
           self,
           only: only,
           except: except,
           context: context,
-          pretty: pretty
+          pretty: pretty,
+          **json_options
         )
       end
 
@@ -1019,12 +1029,13 @@ module Shale
       # @param [Array<Symbol>] only
       # @param [Array<Symbol>] except
       # @param [any] context
+      # @param [Hash] yaml_options
       #
       # @return [String]
       #
       # @api public
-      def to_yaml(only: nil, except: nil, context: nil)
-        self.class.to_yaml(self, only: only, except: except, context: context)
+      def to_yaml(only: nil, except: nil, context: nil, **yaml_options)
+        self.class.to_yaml(self, only: only, except: except, context: context, **yaml_options)
       end
 
       # Convert Object to TOML
@@ -1032,12 +1043,13 @@ module Shale
       # @param [Array<Symbol>] only
       # @param [Array<Symbol>] except
       # @param [any] context
+      # @param [Hash] toml_options
       #
       # @return [String]
       #
       # @api public
-      def to_toml(only: nil, except: nil, context: nil)
-        self.class.to_toml(self, only: only, except: except, context: context)
+      def to_toml(only: nil, except: nil, context: nil, **toml_options)
+        self.class.to_toml(self, only: only, except: except, context: context, **toml_options)
       end
 
       # Convert Object to CSV
@@ -1045,6 +1057,8 @@ module Shale
       # @param [Array<Symbol>] only
       # @param [Array<Symbol>] except
       # @param [any] context
+      # @param [true, false] headers
+      # @param [Hash] csv_options
       #
       # @return [String]
       #

data/lib/shale/type/date.rb

@@ -69,5 +69,7 @@ module Shale
         value&.iso8601
       end
     end
+
+    register(:date, Date)
   end
 end

data/lib/shale/type/float.rb

@@ -25,5 +25,7 @@ module Shale
         end
       end
     end
+
+    register(:float, Float)
   end
 end

data/lib/shale/type/integer.rb

@@ -17,5 +17,7 @@ module Shale
         value&.to_i
       end
     end
+
+    register(:integer, Integer)
   end
 end

data/lib/shale/type/string.rb

@@ -17,5 +17,7 @@ module Shale
         value&.to_s
       end
     end
+
+    register(:string, String)
   end
 end

data/lib/shale/type/time.rb

@@ -69,5 +69,7 @@ module Shale
         value&.iso8601
       end
     end
+
+    register(:time, Time)
   end
 end

data/lib/shale/type.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Shale
+  module Type
+    class << self
+      # Register a symbol alias for a Shale::Type::Value class
+      #
+      # @param [Symbol] type Short type alias
+      # @param [Shale::Type::Value] klass Class to register
+      #
+      # @raise [NotATypeValueError] when klass is not a Shale::Type::Value
+      #
+      # @example
+      #   class UnixTimestamp < Shale::Type::Value
+      #     def self.cast(value)
+      #       Time.at(value.to_i)
+      #     end
+      #   end
+      #
+      #   Shale::Type.register(:unix_timestamp, UnixTimestamp)
+      #
+      # @api public
+      def register(type, klass)
+        @registry ||= {}
+
+        unless klass < Value
+          raise NotATypeValueError, "class '#{klass}' is not a valid Shale::Type::Value"
+        end
+
+        @registry[type] = klass
+      end
+
+      # Lookup a Shale::Type::Value class by type alias
+      #
+      # @param [Symbol] type Type alias
+      #
+      # @raise [UnknownTypeError] when type is not registered
+      #
+      # @return [Shale::Type::Value] Class registered for type
+      #
+      # @example
+      #
+      #  Shale::Type.lookup(:unix_timestamp)
+      #  # => UnixTimestamp
+      #
+      # @api public
+      def lookup(type)
+        klass = @registry[type]
+
+        raise UnknownTypeError, "unknown type '#{type}'" unless klass
+
+        klass
+      end
+    end
+  end
+end

data/lib/shale/version.rb

@@ -2,5 +2,5 @@
 
 module Shale
   # @api private
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/shale.rb

@@ -4,6 +4,7 @@ require 'yaml'
 
 require_relative 'shale/mapper'
 require_relative 'shale/adapter/json'
+require_relative 'shale/type'
 require_relative 'shale/type/boolean'
 require_relative 'shale/type/date'
 require_relative 'shale/type/float'
@@ -80,16 +81,17 @@ module Shale
     # @api public
     attr_writer :yaml_adapter
 
-    # TOML adapter accessor.
+    # TOML adapter accessor. Available adapters are Shale::Adapter::Tomlib
+    # and Shale::Adapter::TomRB
     #
-    # @param [@see Shale::Adapter::TomlRB] adapter
+    # @param [@see Shale::Adapter::Tomlib] adapter
     #
     # @example setting adapter
-    #   Shale.toml_adapter = Shale::Adapter::TomlRB
+    #   Shale.toml_adapter = Shale::Adapter::Tomlib
     #
     # @example getting adapter
     #   Shale.toml_adapter
-    #   # => Shale::Adapter::TomlRB
+    #   # => Shale::Adapter::Tomlib
     #
     # @api public
     attr_accessor :toml_adapter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shale
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -49,6 +49,7 @@ files:
 - lib/shale/adapter/rexml/document.rb
 - lib/shale/adapter/rexml/node.rb
 - lib/shale/adapter/toml_rb.rb
+- lib/shale/adapter/tomlib.rb
 - lib/shale/attribute.rb
 - lib/shale/error.rb
 - lib/shale/mapper.rb
@@ -104,6 +105,7 @@ files:
 - lib/shale/schema/xml_generator/schema.rb
 - lib/shale/schema/xml_generator/typed_attribute.rb
 - lib/shale/schema/xml_generator/typed_element.rb
+- lib/shale/type.rb
 - lib/shale/type/boolean.rb
 - lib/shale/type/complex.rb
 - lib/shale/type/date.rb