representable 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3a1388b7570e31d62c555a87d6165793e9d095cf1bed18c04cb8cbe86bc2ba2
-  data.tar.gz: 43e418db52478d3d4fc33f505ce86d840fcb666a8abc83e20269bbfab4c53a3a
+  metadata.gz: 2bb7b8770886210c259064f3d2ba30d7fd3b4e50350e0a9cbd98640261ac3879
+  data.tar.gz: 664ee784de146034f31308b2207a121e0a1fbeea38ca3989fc09a1fe04016bc1
 SHA512:
-  metadata.gz: 39e957975d24f76894ef9a7186fff69155525e5f777c120a77e2ecee8a7dcdccee62b2140ed8ab34ebc9de916a9098d9da846e0befda2c90fa32e4a9ff470ecc
-  data.tar.gz: cf309756f2470854283c09bbca25b3200b26ba1702b75e533573382dabd2f33a6f3eeaee963c2cc2bb0ddb9d3bdf026bf7dacba6da3f22f44dc805bc8d1ca505
+  metadata.gz: 1ecad360b289f31fa0ed925369e3541cb580154c158c1f6b21dd0c0e9ebd98945fe1534292e882521ef3d6c0a24447f55a1b1267deb29282af0d7d1d0b8970c9
+  data.tar.gz: dce51b8db19df9005a598272847b55088a9f0ee91c6e4f5aed33075ac43bc28b8edac1a76a020be2e195c3358dc13b1a698ae78cb0d323ce2c3c4ede4a52c912

data/.github/workflows/ci.yml

@@ -1,23 +1,30 @@
+## This file is managed by Terraform.
+## Do not modify this file directly, as it may be overwritten.
+## Please open an issue instead.
 name: CI
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-
+on: [push, pull_request]
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', "3.1"]
+        ruby: ["3.0", "3.1", "3.2", '3.3', '3.4', '4.0']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v7
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - run: bundle exec rake
+
+  test-head:
+    continue-on-error: true
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v7
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: head
+        bundler-cache: true
+    - run: bundle exec rake

data/.github/workflows/ci_jruby.yml

@@ -0,0 +1,21 @@
+## This file is managed by Terraform.
+## Do not modify this file directly, as it may be overwritten.
+## Please open an issue instead.
+name: CI JRuby
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [jruby, jruby-head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v7
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake
+      env:
+        JRUBY_OPTS: --profile.api

data/.github/workflows/ci_truffleruby.yml

@@ -0,0 +1,19 @@
+## This file is managed by Terraform.
+## Do not modify this file directly, as it may be overwritten.
+## Please open an issue instead.
+name: CI TruffleRuby
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [truffleruby, truffleruby-head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v7
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 3.3.0
+
+* Drop support for Ruby < 3.0.0.
+* Fix deprecations with `MultiJson`.
+
 # 3.2.0
 * Drop support for Virtus Coercion
 * Fix deprecation warning with Nokogiri 1.13.0

data/Gemfile

@@ -6,6 +6,6 @@ group :test do
   gem "minitest-line"
   gem "multi_json", require: false
   gem "nokogiri", require: false
+  gem "ostruct"
 end
-gem 'pry-byebug'
 

data/README.md

@@ -1,7 +1,6 @@
 # Representable
 
 Representable maps Ruby objects to documents and back.
-
 ![Build
 Status](https://github.com/trailblazer/representable/actions/workflows/ci.yml/badge.svg?branch=master)
 [![Gem Version](https://badge.fury.io/rb/representable.svg)](http://badge.fury.io/rb/representable)

data/lib/representable/hash/binding.rb

@@ -10,6 +10,7 @@ module Representable
       end
 
       def read(hash, as)
+        return FragmentNotFound unless hash
         hash.has_key?(as) ? hash[as] : FragmentNotFound
       end
 

data/lib/representable/json.rb

@@ -6,6 +6,18 @@ require "representable"
 module Representable
   # Brings #to_json and #from_json to your object.
   module JSON
+    if Kernel.const_defined?(:MultiJson) # Ruby 3.0
+      module MultiJSON
+        def self.generate(*args)
+          MultiJson.dump(*args)
+        end
+
+        def self.parse(*args)
+          MultiJson.load(*args)
+        end
+      end
+    end
+
     autoload :Collection, "representable/json/collection"
 
     extend Hash::ClassMethods
@@ -33,13 +45,13 @@ module Representable
 
     # Parses the body as JSON and delegates to #from_hash.
     def from_json(data, *args)
-      data = MultiJson.load(data)
+      data = MultiJSON.parse(data)
       from_hash(data, *args)
     end
 
     # Returns a JSON string representing this object.
     def to_json(*args)
-      MultiJson.dump to_hash(*args)
+      MultiJSON.generate to_hash(*args)
     end
 
     alias_method :render, :to_json

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/lib/representable/xml/binding.rb

@@ -2,13 +2,6 @@ require 'representable/binding'
 
 module Representable
   module XML
-    module_function def Node(document, name, attributes={})
-      node = Nokogiri::XML::Node.new(name.to_s, document) # Java::OrgW3cDom::DOMException: NAMESPACE_ERR: An attempt is made to create or change an object in a way which is incorrect with regard to namespaces.
-
-      attributes.each { |k, v| node[k] = v } # TODO: benchmark.
-      node
-    end
-
     class Binding < Representable::Binding
       def self.build_for(definition)
         return Collection.new(definition)      if definition.array?

data/lib/representable/xml.rb

@@ -9,6 +9,13 @@ module Representable
     autoload :Collection, 'representable/xml/collection'
     autoload :Namespace, 'representable/xml/namespace'
 
+    module_function def Node(document, name, attributes={})
+      node = document.create_element(name.to_s)
+
+      attributes.each { |k, v| node[k] = v } # TODO: benchmark.
+      node
+    end
+
     def self.included(base)
       base.class_eval do
         include Representable

data/representable.gemspec

@@ -19,16 +19,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.license       = "MIT"
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency "uber",               "< 0.2.0"
   spec.add_dependency "declarative",        "< 0.1.0"
   spec.add_dependency "trailblazer-option", ">= 0.1.1", "< 0.2.0"
 
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "test_xml", ">= 0.1.6"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "virtus"
   spec.add_development_dependency "dry-types"
   spec.add_development_dependency "ruby-prof" if RUBY_ENGINE == "ruby" # mri
 end

data/test/as_test.rb

@@ -1,16 +1,14 @@
-require 'test_helper'
+require "test_helper"
 
-class AsTest < MiniTest::Spec
+class AsTest < Minitest::Spec
   for_formats(
-    :hash => [Representable::Hash, {"title" => "Wie Es Geht"}, {"title" => "Revolution"}],
+    :hash => [Representable::Hash, {"title" => "Wie Es Geht"}, {"title" => "Revolution"}]
     # :xml  => [Representable::XML, "<open_struct>\n  <song>\n    <name>Alive</name>\n  </song>\n</open_struct>", "<open_struct><song><name>You've Taken Everything</name></song>/open_struct>"],
     # :yaml => [Representable::YAML, "---\nsong:\n  name: Alive\n", "---\nsong:\n  name: You've Taken Everything\n"],
   ) do |format, mod, input, output|
-
     let(:song) { representer.prepare(Song.new("Revolution")) }
     let(:format) { format }
 
-
     describe "as: with :symbol" do
       representer!(:module => mod) do
         property :name, :as => :title
@@ -20,32 +18,29 @@ class AsTest < MiniTest::Spec
       it { _(parse(song, input).name).must_equal "Wie Es Geht" }
     end
 
-
     describe "as: with lambda" do
       representer!(:module => mod) do
-        property :name, :as => lambda { |*| "#{self.class}" }
+        property :name, :as => ->(*) { self.class.to_s }
       end
 
       it { render(song).must_equal_document({"Song" => "Revolution"}) }
       it { _(parse(song, {"Song" => "Wie Es Geht"}).name).must_equal "Wie Es Geht" }
     end
 
-
     describe "lambda arguments" do
       representer! do
-        property :name, :as => lambda { |options| options[:user_options].inspect }
+        property :name, :as => ->(options) { options[:user_options].inspect }
       end
 
-      it { render(song, user_options:{volume: 1}).must_equal_document({"{:volume=>1}" => "Revolution"}) }
-      it { _(parse(song, {"{:volume=>1}" => "Wie Es Geht"}, user_options: {volume: 1}).name).must_equal "Wie Es Geht" }
+      it { render(song, user_options: {volume: 1}).must_equal_document({{volume: 1}.inspect => "Revolution"}) }
+      it { _(parse(song, {{volume: 1}.inspect => "Wie Es Geht"}, user_options: {volume: 1}).name).must_equal "Wie Es Geht" }
     end
   end
 end
 
-
 # hash: to_hash(wrap: ) is representation_wrap
 
-class AsXmlTest < MiniTest::Spec
+class AsXmlTest < Minitest::Spec
   Band  = Struct.new(:name, :label)
   Album = Struct.new(:band)
   Label = Struct.new(:name)

data/test/benchmarking.rb

@@ -1,11 +1,10 @@
-require 'test_helper'
-require 'benchmark'
+require "test_helper"
+require "benchmark"
 
 SONG_PROPERTIES = 1000.times.collect do |i|
   "property_#{i}"
 end
 
-
 module SongRepresenter
   include Representable::JSON
 
@@ -26,7 +25,7 @@ module AlbumRepresenter
 end
 
 def random_song
-  attrs = Hash[SONG_PROPERTIES.collect { |n| [n,n] }]
+  attrs = Hash[SONG_PROPERTIES.collect { |n| [n, n] }]
   OpenStruct.new(attrs)
 end
 
@@ -49,30 +48,26 @@ puts times.join("")
 ## 100 songs, 1000 attrs
 #  0.470000   0.010000   0.480000 (  0.483708)
 
-
 ### without binding cache:
-  # 2.790000   0.030000   2.820000 (  2.820190)
-
-
+# 2.790000   0.030000   2.820000 (  2.820190)
 
 ### with extend: on Song, with binding cache>
-  # 2.490000   0.030000   2.520000 (  2.517433) 2.4-3.0
-  ### without skip?
-  # 2.030000   0.020000   2.050000 (  2.050796) 2.1-2.3
-
-    ### without :writer
-    # 2.270000   0.010000   2.280000 (  2.284530 1.9-2.2
-      ### without :render_filter
-      #   2.020000   0.000000   2.020000 (  2.030234) 1.5-2.0
-        ###without default_for and skipable?
-        #   1.730000   0.010000   1.740000 (  1.735597 1.4-1.7
-          ### without :serialize
-          #   1.780000   0.010000   1.790000 (  1.786791) 1.4-1.7
-          ### using decorator
-          # 1.400000   0.030000   1.430000 (  1.434206) 1.4-1.6
-            ### with prepare AFTER  representable?
-            # 1.330000   0.010000   1.340000 (  1.335900) 1.1-1.3
-
+# 2.490000   0.030000   2.520000 (  2.517433) 2.4-3.0
+### without skip?
+# 2.030000   0.020000   2.050000 (  2.050796) 2.1-2.3
+
+### without :writer
+# 2.270000   0.010000   2.280000 (  2.284530 1.9-2.2
+### without :render_filter
+#   2.020000   0.000000   2.020000 (  2.030234) 1.5-2.0
+# ##without default_for and skipable?
+#   1.730000   0.010000   1.740000 (  1.735597 1.4-1.7
+### without :serialize
+#   1.780000   0.010000   1.790000 (  1.786791) 1.4-1.7
+### using decorator
+# 1.400000   0.030000   1.430000 (  1.434206) 1.4-1.6
+### with prepare AFTER  representable?
+# 1.330000   0.010000   1.340000 (  1.335900) 1.1-1.3
 
 # representable 2.0
 # 3.000000   0.020000   3.020000 (  3.013031) 2.7-3.0

data/test/binding_test.rb

@@ -1,6 +1,6 @@
-require 'test_helper'
+require "test_helper"
 
-class BindingTest < MiniTest::Spec
+class BindingTest < Minitest::Spec
   Binding = Representable::Binding
   let(:render_nil_definition) { Representable::Definition.new(:song, :render_nil => true) }
 
@@ -20,7 +20,6 @@ class BindingTest < MiniTest::Spec
     it { _(Binding.new(Representable::Definition.new(:song)).skipable_empty_value?("Fatal Flu")).must_equal false }
   end
 
-
   describe "#default_for" do
     let(:definition) { Representable::Definition.new(:song, :default => "Insider") }
     let(:binding) { Binding.new(definition) }
@@ -38,9 +37,18 @@ class BindingTest < MiniTest::Spec
     it { _(Binding.new(render_nil_definition).default_for(nil)).must_be_nil }
 
     # return nil when value nil and render_nil: true, even when :default is set" do
-    it { _(Binding.new(Representable::Definition.new(:song, :render_nil => true, :default => "The Quest")).default_for(nil)).must_be_nil }
+    it {
+      _(
+        Binding.new(
+          Representable::Definition.new(
+            :song, :render_nil => true,
+                   :default    => "The Quest"
+          )
+        ).default_for(nil)
+      ).must_be_nil
+    }
 
     # return nil if no :default
     it { _(Binding.new(Representable::Definition.new(:song)).default_for(nil)).must_be_nil }
   end
-end
+end

data/test/cached_test.rb

@@ -1,30 +1,36 @@
 require "test_helper"
 
 class Profiler
+  SUPPORTED_ENGINES = %w[ruby jruby].freeze
+
+  def self.available?
+    SUPPORTED_ENGINES.include?(RUBY_ENGINE)
+  end
+
   def self.profile(&block)
     case RUBY_ENGINE
-    when "ruby"
-      require 'ruby-prof'
-
-      output = StringIO.new
-      profile_result = RubyProf.profile(&block)
-      printer = RubyProf::FlatPrinter.new(profile_result)
-      printer.print(output)
-      output.string
-    when "jruby"
-      require 'jruby/profiler'
-
-      output_stream  = java.io.ByteArrayOutputStream.new
-      print_stream   = java.io.PrintStream.new(output_stream)
-      profile_result = JRuby::Profiler.profile(&block)
-      printer = JRuby::Profiler::FlatProfilePrinter.new(profile_result)
-      printer.printProfile(print_stream)
-      output_stream.toString
+      when "ruby"
+        require "ruby-prof"
+
+        output = StringIO.new
+        profile_result = RubyProf::Profile.profile(&block)
+        printer = RubyProf::FlatPrinter.new(profile_result)
+        printer.print(output)
+        output.string
+      when "jruby"
+        require "jruby/profiler"
+
+        output_stream  = java.io.ByteArrayOutputStream.new
+        print_stream   = java.io.PrintStream.new(output_stream)
+        profile_result = JRuby::Profiler.profile(&block)
+        printer = JRuby::Profiler::FlatProfilePrinter.new(profile_result)
+        printer.printProfile(print_stream)
+        output_stream.toString
     end
   end
 end
 
-class CachedTest < MiniTest::Spec
+class CachedTest < Minitest::Spec
   # TODO: also test with feature(Cached)
 
   module Model
@@ -37,7 +43,7 @@ class CachedTest < MiniTest::Spec
     include Representable::Hash
     feature Representable::Cached
 
-    property :title, render_filter: lambda { |input, options| "#{input}:#{options[:options][:user_options]}" }
+    property :title, render_filter: ->(input, options) { "#{input}:#{options[:options][:user_options]}" }
     property :composer, class: Model::Artist do
       property :name
     end
@@ -51,9 +57,13 @@ class CachedTest < MiniTest::Spec
     collection :songs, decorator: SongRepresenter, class: Model::Song
   end
 
-
   describe "serialization" do
-    let(:album_hash) { {"name"=>"Louder And Even More Dangerous", "songs"=>[{"title"=>"Southbound:{:volume=>10}"}, {"title"=>"Jailbreak:{:volume=>10}"}]} }
+    let(:album_hash) do
+      {
+        "name"  => "Louder And Even More Dangerous",
+        "songs" => [{"title" => "Southbound:#{{volume: 10}.inspect}"}, {"title" => "Jailbreak:#{{volume: 10}.inspect}"}]
+      }
+    end
 
     let(:song) { Model::Song.new("Jailbreak") }
     let(:song2) { Model::Song.new("Southbound") }
@@ -64,8 +74,15 @@ class CachedTest < MiniTest::Spec
       # album2 = Model::Album.new("Louder And Even More Dangerous", [song2, song])
 
       # makes sure options are passed correctly.
-      _(representer.to_hash(user_options: {volume: 9})).must_equal({"name"=>"Live And Dangerous",
-        "songs"=>[{"title"=>"Jailbreak:{:volume=>9}"}, {"title"=>"Southbound:{:volume=>9}"}, {"title"=>"Emerald:{:volume=>9}"}]}) # called in Deserializer/Serializer
+      _(representer.to_hash(user_options: {volume: 9})).must_equal(
+        {
+          "name"  => "Live And Dangerous",
+          "songs" => [
+            {"title" => "Jailbreak:#{{volume: 9}.inspect}"}, {"title" => "Southbound:#{{volume: 9}.inspect}"},
+            {"title" => "Emerald:#{{volume: 9}.inspect}"}
+          ]
+        }
+      ) # called in Deserializer/Serializer
 
       # representer becomes reusable as it is stateless.
       # representer.update!(album2)
@@ -76,6 +93,8 @@ class CachedTest < MiniTest::Spec
 
     # profiling
     it do
+      skip "no profiler available for #{RUBY_ENGINE}" unless Profiler.available?
+
       representer.to_hash
 
       data = Profiler.profile { representer.to_hash }
@@ -88,30 +107,29 @@ class CachedTest < MiniTest::Spec
       #   - "3  Representable::Decorator.prepare"           -> At JRuby
 
       # 3 nested decorator is instantiated for 3 Songs, though.
-      _(data).must_match(/3\s*(<Class::)?Representable::Decorator\>?[\#.]prepare/m)
+      _(data).must_match(/3\s*(<Class::)?Representable::Decorator>?[\#.]prepare/m)
       # no Binding is instantiated at runtime.
       _(data).wont_match "Representable::Binding#initialize"
       # 2 mappers for Album, Song
       # data.must_match "2   Representable::Mapper::Methods#initialize"
       # title, songs, 3x title, composer
-      _(data).must_match(/8\s*Representable::Binding[#\.]render_pipeline/m)
+      _(data).must_match(/8\s*Representable::Binding[#.]render_pipeline/m)
       _(data).wont_match "render_functions"
       _(data).wont_match "Representable::Binding::Factories#render_functions"
     end
   end
 
-
   describe "deserialization" do
-    let(:album_hash) {
+    let(:album_hash) do
       {
-        "name"=>"Louder And Even More Dangerous",
-        "songs"=>[
-          {"title"=>"Southbound", "composer"=>{"name"=>"Lynott"}},
-          {"title"=>"Jailbreak", "composer"=>{"name"=>"Phil Lynott"}},
+        "name"  => "Louder And Even More Dangerous",
+        "songs" => [
+          {"title" => "Southbound", "composer" => {"name"=>"Lynott"}},
+          {"title" => "Jailbreak", "composer" => {"name"=>"Phil Lynott"}},
           {"title"=>"Emerald"}
         ]
       }
-    }
+    end
 
     it do
       album = Model::Album.new
@@ -131,6 +149,8 @@ class CachedTest < MiniTest::Spec
     end
 
     it "xxx" do
+      skip "no profiler available for #{RUBY_ENGINE}" unless Profiler.available?
+
       representer = AlbumRepresenter.new(Model::Album.new)
       representer.from_hash(album_hash)
 
@@ -139,12 +159,12 @@ class CachedTest < MiniTest::Spec
       # only 2 nested decorators are instantiated, Song, and Artist.
       # Didn't like the regexp?
       # MRI and JRuby has different output formats. See note above.
-      _(data).must_match(/5\s*(<Class::)?Representable::Decorator>?[#\.]prepare/)
+      _(data).must_match(/5\s*(<Class::)?Representable::Decorator>?[#.]prepare/)
       # a total of 5 properties in the object graph.
       _(data).wont_match "Representable::Binding#initialize"
 
       _(data).wont_match "parse_functions" # no pipeline creation.
-      _(data).must_match(/10\s*Representable::Binding[#\.]parse_pipeline/)
+      _(data).must_match(/10\s*Representable::Binding[#.]parse_pipeline/)
       # three mappers for Album, Song, composer
       # data.must_match "3   Representable::Mapper::Methods#initialize"
       # # 6 deserializers as the songs collection uses 2.
@@ -154,4 +174,4 @@ class CachedTest < MiniTest::Spec
       # printer.print(STDOUT)
     end
   end
-end
+end