shale 1.0.0 → 1.2.0

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
 
@@ -373,6 +381,7 @@ module Shale
         #
         # @api public
         def from_csv(csv, only: nil, except: nil, context: nil, headers: false, **csv_options)
+          validate_csv_adapter
           data = Shale.csv_adapter.load(csv, **csv_options.merge(headers: csv_mapping.keys.keys))
 
           data.shift if headers
@@ -398,6 +407,7 @@ module Shale
         #
         # @api public
         def to_csv(instance, only: nil, except: nil, context: nil, headers: false, **csv_options)
+          validate_csv_adapter
           data = as_csv([*instance], only: only, except: except, context: context)
 
           cols = csv_mapping.keys.values
@@ -892,6 +902,15 @@ module Shale
           raise AdapterError, XML_ADAPTER_NOT_SET_MESSAGE unless Shale.xml_adapter
         end
 
+        # Validate CSV adapter
+        #
+        # @raise [AdapterError]
+        #
+        # @api private
+        def validate_csv_adapter
+          raise AdapterError, CSV_ADAPTER_NOT_SET_MESSAGE unless Shale.csv_adapter
+        end
+
         # Convert array with attributes to a hash
         #
         # @param [Array] ary
@@ -989,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
 
@@ -1008,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
@@ -1021,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
@@ -1034,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/utils.rb

@@ -31,7 +31,7 @@ module Shale
     # @api private
     def self.classify(str)
       # names may include a period, which will need to be stripped out
-      str = str.to_s.gsub(/\./, '')
+      str = str.to_s.gsub('.', '')
 
       str = str.sub(/^[a-z\d]*/) { |match| upcase_first(match) || match }
 

data/lib/shale/version.rb

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

data/lib/shale.rb

@@ -3,8 +3,8 @@
 require 'yaml'
 
 require_relative 'shale/mapper'
-require_relative 'shale/adapter/csv'
 require_relative 'shale/adapter/json'
+require_relative 'shale/type'
 require_relative 'shale/type/boolean'
 require_relative 'shale/type/date'
 require_relative 'shale/type/float'
@@ -52,6 +52,12 @@ require_relative 'shale/version'
 #   Shale.xml_adapter = Shale::Adapter::Ox
 #   Shale.xml_adapter # => Shale::Adapter::Ox
 #
+# @example setting CSV adapter for handling CSV documents
+#   require 'shale/adapter/csv'
+#
+#   Shale.csv_adapter = Shale::Adapter::CSV
+#   Shale.csv_adapter # => Shale::Adapter::CSV
+#
 # @api public
 module Shale
   class << self
@@ -75,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
@@ -93,11 +100,15 @@ module Shale
     #
     # @param [.load, .dump] adapter
     #
-    # @example
+    # @example setting adapter
     #   Shale.csv_adapter = Shale::Adapter::CSV
     #
+    # @example getting adapter
+    #   Shale.csv_adapter
+    #   # => Shale::Adapter::CSV
+    #
     # @api public
-    attr_writer :csv_adapter
+    attr_accessor :csv_adapter
 
     # XML adapter accessor. Available adapters are Shale::Adapter::REXML,
     # Shale::Adapter::Nokogiri and Shale::Adapter::Ox
@@ -139,18 +150,5 @@ module Shale
     def yaml_adapter
       @yaml_adapter || YAML
     end
-
-    # Return CSV adapter. By default CSV is used
-    #
-    # @return [.load, .dump]
-    #
-    # @example
-    #   Shale.csv_adapter
-    #   # => Shale::Adapter::CSV
-    #
-    # @api public
-    def csv_adapter
-      @csv_adapter || Adapter::CSV
-    end
   end
 end

data/shale.gemspec

@@ -26,5 +26,7 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = 'shaleb'
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.add_runtime_dependency 'bigdecimal'
+
+  spec.required_ruby_version = '>= 3.0.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: shale
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
-dependencies: []
+date: 2024-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby object mapper and serializer for XML, JSON, TOML, CSV and YAML.
 email:
 - beerkg@gmail.com
@@ -35,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
@@ -90,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
@@ -118,14 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby object mapper and serializer for XML, JSON, TOML, CSV and YAML.