shale 0.1.0

data/lib/shale/type/date.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative 'base'
+
+module Shale
+  module Type
+    # Cast value to Date
+    #
+    # @api public
+    class Date < Base
+      # @param [any] value Value to cast
+      #
+      # @return [Date, nil]
+      #
+      # @api private
+      def self.cast(value)
+        if value.is_a?(::String)
+          return if value.empty?
+          ::Date.parse(value)
+        elsif value.respond_to?(:to_date)
+          value.to_date
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/shale/type/float.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Shale
+  module Type
+    # Cast value to Float
+    #
+    # @api public
+    class Float < Base
+      # @param [#to_f, String, nil] value Value to cast
+      #
+      # @return [Float, nil]
+      #
+      # @api private
+      def self.cast(value)
+        return if value.nil?
+
+        case value
+        when ::Float then value
+        when 'Infinity' then ::Float::INFINITY
+        when '-Infinity' then -::Float::INFINITY
+        when 'NaN' then ::Float::NAN
+        else value.to_f
+        end
+      end
+    end
+  end
+end

data/lib/shale/type/integer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Shale
+  module Type
+    # Cast value to Integer
+    #
+    # @api public
+    class Integer < Base
+      # @param [#to_i, nil] value Value to cast
+      #
+      # @return [Integer, nil]
+      #
+      # @api private
+      def self.cast(value)
+        value&.to_i
+      end
+    end
+  end
+end

data/lib/shale/type/string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Shale
+  module Type
+    # Cast value to String
+    #
+    # @api public
+    class String < Base
+      # @param [#to_s, nil] value Value to cast
+      #
+      # @return [String, nil]
+      #
+      # @api private
+      def self.cast(value)
+        value&.to_s
+      end
+    end
+  end
+end

data/lib/shale/type/time.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'time'
+require_relative 'base'
+
+module Shale
+  module Type
+    # Cast value to Time
+    #
+    # @api public
+    class Time < Base
+      # @param [any] value Value to cast
+      #
+      # @return [Time, nil]
+      #
+      # @api private
+      def self.cast(value)
+        if value.is_a?(::String)
+          return if value.empty?
+          ::Time.parse(value)
+        elsif value.respond_to?(:to_time)
+          value.to_time
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/shale/utils.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Shale
+  # Utitlity functions
+  #
+  # @api private
+  module Utils
+    # Convert word to under score
+    #
+    # @param [String] word
+    #
+    # @example
+    #   Shale::Utils.underscore('FooBar') # => foo_bar
+    #   Shale::Utils.underscore('Namespace::FooBar') # => namespace:foo_bar
+    #
+    # @api private
+    def self.underscore(word)
+      word
+        .gsub('::', ':')
+        .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .downcase
+    end
+  end
+end

data/lib/shale/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Shale
+  # @api private
+  VERSION = '0.1.0'
+end

data/lib/shale.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require 'shale/mapper'
+require 'shale/adapter/json'
+require 'shale/adapter/rexml'
+require 'shale/type/boolean'
+require 'shale/type/date'
+require 'shale/type/float'
+require 'shale/type/integer'
+require 'shale/type/string'
+require 'shale/type/time'
+require 'shale/version'
+
+# Main library namespace
+#
+# Shale uses adapters for parsing and serializing documents.
+# For handling JSON and YAML, adapter must implement .load and .dump methods, so
+# e.g for handling JSON, MultiJson works out of the box.
+#
+# Adapters for XML handling are more complicated and must conform to [@see shale/adapter/rexml]
+# Shale provides adaters for most popular XML parsing libraries:
+# Shale::Adapter::REXML, Shale::Adapter::Nokogiri and Shale::Adapter::Ox
+#
+# By default Shale::Adapter::REXML is used so no external dependencies are needed, but it's
+# not as performant as Nokogiri or Ox, so you may want to change it.
+#
+# @example setting MultiJSON for handling JSON documents
+#   Shale.json_adapter = MultiJson
+#   Shale.json_adapter # => MultiJson
+#
+# @example setting YAML adapter for handling YAML documents
+#   Shale.yaml_adapter = MultiJson
+#   Shale.yaml_adapter # => MultiJson
+#
+# @example setting REXML adapter for handling XML documents
+#   Shale.xml_adapter = Shale::Adapter::REXML
+#   Shale.xml_adapter # => Shale::Adapter::REXML
+#
+# @example setting Nokogiri adapter for handling XML documents
+#   require 'shale/adapter/nokogiri'
+#
+#   Shale.xml_adapter = Shale::Adapter::Nokogir
+#   Shale.xml_adapter # => Shale::Adapter::Nokogir
+#
+# @example setting Ox adapter for handling XML documents
+#   require 'shale/adapter/ox'
+#
+#   Shale.xml_adapter = Shale::Adapter::Ox
+#   Shale.xml_adapter # => Shale::Adapter::Ox
+#
+# @api public
+module Shale
+  class << self
+    # Set JSON adapter
+    #
+    # @param [.load, .dump] adapter
+    #
+    # @example
+    #   Shale.json_adapter = Shale::Adapter::JSON
+    #
+    # @api public
+    attr_writer :json_adapter
+
+    # Set YAML adapter
+    #
+    # @param [.load, .dump] adapter
+    #
+    # @example
+    #   Shale.yaml_adapter = YAML
+    #
+    # @api public
+    attr_writer :yaml_adapter
+
+    # Set XML adapter
+    #
+    # @param [@see Shale::Adapter::REXML] adapter
+    #
+    # @example
+    #   Shale.xml_adapter = Shale::Adapter::REXML
+    #
+    # @api public
+    attr_writer :xml_adapter
+
+    # Return JSON adapter. By default Shale::Adapter::JSON is used
+    #
+    # @return [.load, .dump]
+    #
+    # @example
+    #   Shale.json_adapter
+    #   # => Shale::Adapter::JSON
+    #
+    # @api public
+    def json_adapter
+      @json_adapter || Adapter::JSON
+    end
+
+    # Return YAML adapter. By default YAML is used
+    #
+    # @return [.load, .dump]
+    #
+    # @example
+    #   Shale.yaml_adapter
+    #   # => YAML
+    #
+    # @api public
+    def yaml_adapter
+      @yaml_adapter || YAML
+    end
+
+    # Return XML adapter. By default Shale::Adapter::REXML is used.
+    # Available adapters are Shale::Adapter::REXML,
+    # Shale::Adapter::Nokogiri and Shale::Adapter::Ox
+    #
+    # @return [@see Shale::Adapter::REXML]
+    #
+    # @example
+    #   Shale.xml_adapter
+    #   # => Shale::Adapter::REXML
+    #
+    # @api public
+    def xml_adapter
+      @xml_adapter || Adapter::REXML
+    end
+  end
+end

data/shale.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/shale/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'shale'
+  spec.version = Shale::VERSION
+  spec.authors = ['Kamil Giszczak']
+  spec.email = ['beerkg@gmail.com']
+
+  spec.summary = 'Ruby object mapper and serializer for XML, JSON and YAML.'
+  spec.description = 'Ruby object mapper and serializer for XML, JSON and YAML.'
+  spec.homepage = 'https://github.com/kgiszczak/shale'
+  spec.license = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/kgiszczak/shale'
+  spec.metadata['source_code_uri'] = 'https://github.com/kgiszczak/shale'
+  spec.metadata['changelog_uri'] = 'https://github.com/kgiszczak/shale/blob/master/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/kgiszczak/shale/issues'
+
+  spec.files = Dir['CHANGELOG.md', 'LICENSE.txt', 'README.md', 'shale.gemspec', 'lib/**/*']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: shale
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kamil Giszczak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-30 00:00:00.000000000 Z
+dependencies: []
+description: Ruby object mapper and serializer for XML, JSON and YAML.
+email:
+- beerkg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/shale.rb
+- lib/shale/adapter/json.rb
+- lib/shale/adapter/nokogiri.rb
+- lib/shale/adapter/ox.rb
+- lib/shale/adapter/rexml.rb
+- lib/shale/attribute.rb
+- lib/shale/error.rb
+- lib/shale/mapper.rb
+- lib/shale/mapping/key_value.rb
+- lib/shale/mapping/xml.rb
+- lib/shale/type/base.rb
+- lib/shale/type/boolean.rb
+- lib/shale/type/complex.rb
+- lib/shale/type/date.rb
+- lib/shale/type/float.rb
+- lib/shale/type/integer.rb
+- lib/shale/type/string.rb
+- lib/shale/type/time.rb
+- lib/shale/utils.rb
+- lib/shale/version.rb
+- shale.gemspec
+homepage: https://github.com/kgiszczak/shale
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kgiszczak/shale
+  source_code_uri: https://github.com/kgiszczak/shale
+  changelog_uri: https://github.com/kgiszczak/shale/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kgiszczak/shale/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby object mapper and serializer for XML, JSON and YAML.
+test_files: []