portrayal 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acf906a0356260f40fbe25b94b12f72f8c696ee723dff3c2f7dc0f3817154fd0
-  data.tar.gz: 0bb4b5a5d4982a59f6e66cd7fa2fe7eeec93b7880537c9e605c47f2d1b0df009
+  metadata.gz: dd6f188d345ad88e1da91277955947e32f1b7dfc9b0d0f840b4164bd0ad17930
+  data.tar.gz: a087113263a3ec551fa4d0c2ba3ab529172ff8252a5782fcc495a838a9f30e8c
 SHA512:
-  metadata.gz: 5d3543a802ba4dad5b8c746fa2e187b0debb95bd52354509bb29c2d88e6977d622aeafc8fca3db0a65811a9918c7044985c3355bea78799a0b7730b84da28e21
-  data.tar.gz: 66f61afd2be1633c12739d49db088265d90279b622b4f4bf050bba2c4d7dc6444ce232e16be00485702ef9285fe2507758d8fdfee447414ac35bc44fe07a5e89
+  metadata.gz: 278094b098ec368126dd078903d4a523dd2344dadee05195f0712a47daaab186638a385c45f822b993d35e4aef3f5bf56f2ec5b3722b348efa1e0f553277887a
+  data.tar.gz: fbb5ce904eb704669e8a59990b7a2c959e2559f265f6a38ce9be5b1aff19b4363bbdd4fb982ac8e465aa483c883ebc91e18c3c0fd7c641a316048da304fc9a29

data/.github/workflows/rspec.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.2' ]
+        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.2', '3.3', '3.4' ]
 
     name: Ruby ${{ matrix.ruby }}
     steps:

data/CHANGELOG.md

@@ -2,6 +2,11 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## 0.9.1 - 2025-01-28
+
+* Add aliases for all redefined methods to suppress method redefinition warnings.
+* Add `+''` to mutated strings to suppress Ruby 3.4 frozen string literal warnings.
+
 ## 0.9.0 - 2023-05-06
 
 None of these changes should break anything for you, only speed things up, unless you're doing something very weird.

data/README.md

@@ -8,7 +8,7 @@ Inspired by:
   - Piotr Solnica's [virtus](https://github.com/solnic/virtus)
   - Everything [Michel Martens](https://github.com/soveran)
 
-Portrayal is a minimalist gem (~110 loc, no dependencies) for building struct-like classes. It provides a small yet powerful step up from plain ruby with its one and only `keyword` method.
+Portrayal is a minimalist gem (~122 loc, no dependencies) for building struct-like classes. It provides a small yet powerful step up from plain ruby with its one and only `keyword` method.
 
 ```ruby
 class Person < MySuperClass
@@ -56,24 +56,25 @@ class Person < MySuperClass
     @address = address
   end
 
-  def eql?(other)
-    self.class == other.class && self == other
-  end
-
   def ==(other)
-    { name: name, age: age, favorite_fruit: favorite_fruit, address: address } ==
-      { name: other.name, age: other.age, favorite_fruit: other.favorite_fruit, address: other.address }
+    self.class == other.class &&
+      @name == other.instance_variable_get('@name') &&
+      @age == other.instance_variable_get('@age') &&
+      @favorite_fruit == other.instance_variable_get('@favorite_fruit') &&
+      @address == other.instance_variable_get('@address')
   end
 
+  alias eql? ==
+
   def hash
-    [ self.class, { name: name, age: age, favorite_fruit: favorite_fruit, address: address } ].hash
+    [ self.class, { name: @name, age: @age, favorite_fruit: @favorite_fruit, address: @address } ].hash
   end
 
   def freeze
-    name.freeze
-    age.freeze
-    favorite_fruit.freeze
-    address.freeze
+    @name.freeze
+    @age.freeze
+    @favorite_fruit.freeze
+    @address.freeze
     super
   end
 
@@ -86,18 +87,18 @@ class Person < MySuperClass
   end
 
   def initialize_dup(source)
-    @name = source.name.dup
-    @age = source.age.dup
-    @favorite_fruit = source.favorite_fruit.dup
-    @address = source.address.dup
+    @name = source.instance_variable_get('@name').dup
+    @age = source.instance_variable_get('@age').dup
+    @favorite_fruit = source.instance_variable_get('@favorite_fruit').dup
+    @address = source.instance_variable_get('@address').dup
     super
   end
 
   def initialize_clone(source)
-    @name = source.name.clone
-    @age = source.age.clone
-    @favorite_fruit = source.favorite_fruit.clone
-    @address = source.address.clone
+    @name = source.instance_variable_get('@name').clone
+    @age = source.instance_variable_get('@age').clone
+    @favorite_fruit = source.instance_variable_get('@favorite_fruit').clone
+    @address = source.instance_variable_get('@address').clone
     super
   end
 
@@ -114,21 +115,21 @@ class Person < MySuperClass
       "#{street}, #{city}"
     end
 
-    def eql?(other)
-      self.class == other.class && self == other
-    end
-
     def ==(other)
-      { street: street, city: city } == { street: other.street, city: other.city }
+      self.class == other.class && 
+        @street == other.instance_variable_get('@street') &&
+        @city == other.instance_variable_get('@city')
     end
 
+    alias eql? ==
+
     def hash
-      [ self.class, { street: street, city: city } ].hash
+      [ self.class, { street: @street, city: @city } ].hash
     end
 
     def freeze
-      street.freeze
-      city.freeze
+      @street.freeze
+      @city.freeze
       super
     end
 
@@ -141,14 +142,14 @@ class Person < MySuperClass
     end
 
     def initialize_dup(source)
-      @street = source.street.dup
-      @city = source.city.dup
+      @street = source.instance_variable_get('@street').dup
+      @city = source.instance_variable_get('@city').dup
       super
     end
 
     def initialize_clone(source)
-      @street = source.street.clone
-      @city = source.city.clone
+      @street = source.instance_variable_get('@street').clone
+      @city = source.instance_variable_get('@city').clone
       super
     end
   end
@@ -394,7 +395,7 @@ Since a portrayal object is read-only (nothing stops you from adding writers, bu
 class Address < ApplicationStruct
   class << self
     def from_form(params)
-      raise ArgumentError, 'invalid postcode' unless postcode =~ /\A\d+\z/
+      raise ArgumentError, 'invalid postcode' if params[:postcode] !~ /\A\d+\z/
 
       new \
         street:   params[:street].to_s,
@@ -490,6 +491,16 @@ def deconstruct_keys(keys)
   filtered_keys &= keys if Array === keys
   Hash[filtered_keys.map { |k| [k, public_send(k)] }]
 end
+alias initialize initialize
+alias hash hash
+alias == ==
+alias eql? eql?
+alias freeze freeze
+alias initialize_dup initialize_dup
+alias initialize_clone initialize_clone
+alias deconstruct deconstruct
+alias deconstruct_keys deconstruct_keys
+alias street street; alias street= street=; alias city city; alias city= city=; alias postcode postcode; alias postcode= postcode=; alias country country; alias country= country=
 ```
 
 #### Implementation decisions

data/bin/bench

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+# This file is a set of benchmarks directly or tangentially related to
+# implementation decisions.
+
 require 'bundler/setup'
 require 'portrayal'
 require 'benchmark/ips'

data/bin/loc

@@ -1,2 +1,3 @@
 #!/usr/bin/env bash
+# Count LOC in the project for pasting into README.
 find lib -name '*.rb' | xargs wc -l

data/bin/module

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# This is a demo of what module code looks like, for pasting into README.
+
 require 'bundler/setup'
 require 'portrayal'
 

data/lib/portrayal/schema.rb

@@ -23,8 +23,8 @@ class Portrayal::Schema
   end
 
   def render_module_code
-    args, inits, syms, hash, eqls, dups, clones, setters, freezes =
-      '', '', '', '', '', '', '', '', ''
+    args, inits, syms, hash, eqls, dups, clones, setters, freezes, aliases =
+      +'', +'', +'', +'', +'', +'', +'', +'', +'', +'' # + keeps string unfrozen
 
     @schema.each do |k, default|
       args  << "#{k}:#{default && " self.class.portrayal.schema[:#{k}]"}, "
@@ -36,6 +36,7 @@ class Portrayal::Schema
       clones  << "@#{k} = src.instance_variable_get('@#{k}').clone; "
       setters << ":#{k}=, "
       freezes << "@#{k}.freeze; "
+      aliases << "alias #{k} #{k}; alias #{k}= #{k}=; "
     end
 
     args.chomp!(', ')    # key1:, key2: self.class.portrayal.schema[:key2]
@@ -47,7 +48,10 @@ class Portrayal::Schema
     clones.chomp!('; ')  # @key1 = src.instance_variable_get('@key1').clone;
     setters.chomp!(', ') # :key1=, :key2=
     freezes.chomp!('; ') # @key1.freeze; @key2.freeze
+    aliases.chomp!('; ') # alias key1 key1; alias key1= key1=
 
+    # Aliases at the bottom help prevent method redefinition warnings.
+    # See https://bugs.ruby-lang.org/issues/17055 for details.
     <<-RUBY
 attr_accessor #{syms}
 protected #{setters}
@@ -67,6 +71,16 @@ def deconstruct_keys(keys)
   filtered_keys &= keys if Array === keys
   Hash[filtered_keys.map { |k| [k, public_send(k)] }]
 end
+alias initialize initialize
+alias hash hash
+alias == ==
+alias eql? eql?
+alias freeze freeze
+alias initialize_dup initialize_dup
+alias initialize_clone initialize_clone
+alias deconstruct deconstruct
+alias deconstruct_keys deconstruct_keys
+#{aliases}
     RUBY
   end
 end

data/lib/portrayal/version.rb

@@ -1,3 +1,3 @@
 module Portrayal
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Max Chernyak
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-07 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -102,7 +101,6 @@ metadata:
   homepage_uri: https://github.com/maxim/portrayal
   source_code_uri: https://github.com/maxim/portrayal
   changelog_uri: https://github.com/maxim/portrayal/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A minimal builder for struct-like classes
 test_files: []