pbbuilder 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ea3598ad1ed31172d0b3154c6968649f63073f23de0d94abf191a07dbdbf4e0
-  data.tar.gz: 7285883ae069eeff4f1860eb9b4c4a727585e6762b3bfd974ce1fb9e51928086
+  metadata.gz: 9f241a460f2ab7e8383c37db199821f8cb5e8d2f69c262f38c7c462a4d7827e0
+  data.tar.gz: 3e8c43a8d0c0362049a9cb8a709c86eac64d86e12366812f2b996b1e81d73c23
 SHA512:
-  metadata.gz: e051d79882379fb30f3f0b4bab503e6591034d1cc16639918d685a0ef19e6f7cc42ea224954bf755db739f6a2b2c2c86a8c7666e23065ce337aafb862486b4f6
-  data.tar.gz: 90f2266161a9a101fd4b67afb71130a009b17ec9a5139dc583db18d02a1a32a2bd7730f1ea872c3d4b77a4d64f953b1a34e72cb35f845dc6a879f117f7c3c5ec
+  metadata.gz: '03691d015507cb98d862c4f1c352a08c20e0968f0fae3a23795bec6e6ffdbef6b3e54dca9057364c32e353bfc561e8f117cf02219ad2c73725ae004b7fd1590b'
+  data.tar.gz: b52b5324090887effbaba0ae6ff79ebe9cc7c08ffae945037883d42375bca4ec53bd5a37dc4a9d144c488a6ba5e7ffce88d05f3e9f7ba1a260af5f0ed55107ed

data/.github/workflows/test.yml

@@ -13,15 +13,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "3.3"]
-        gemfile: [ "rails_6_1", "rails_7_0", "rails_7_2"]
-        exclude:
-          - ruby: "3.0"
-            gemfile: "rails_7_2"
+        ruby: ["3.2.2"]
+        gemfile: ["rails_7_2", "rails_8_0"]
         experimental: [false]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:

data/.gitignore

@@ -18,5 +18,5 @@ gemfiles/*.lock
 Gemfile.lock
 .ruby-version
 pkg
-
+.vscode/
 

data/Appraisals

@@ -1,11 +1,9 @@
-appraise "rails-6-1" do
-  gem "rails", "~> 6.1.0"
-end
-
-appraise "rails-7-0" do
-  gem "rails", "~> 7.0.0"
-end
-
 appraise "rails-7-2" do
   gem "rails", "~> 7.2.0"
+  gem "google-protobuf", "~> 3.25", "< 4.0"
 end
+
+appraise "rails-8-0" do
+  gem "rails", "~> 8.0.2"
+  gem "google-protobuf", "~> 4.0", "< 5.0"
+end

data/CHANGELOG.md

@@ -1,69 +1,55 @@
-# Pbbuilder Changelog
-All notable changes to this project will be documented in this file.
+## Unreleased
 
-This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+- Remove official support for Rails 7.0 and Rails 6.x, add Appraisal config for Rails 8.x
+- Bump actions/checkout from 3 to 4 (#40)
+- Drop support for rails v6.* versions (#60)
+- Regenerate Appraisals, drop Rails 7.0
+- Allow usage of google-protobuf 4.x
+- Use an actual .proto for testing
+- Test with both google-protobuf 3.25 and 4.x
+- Remove --verbose when running rake test
 
 ## 0.19.0
-### Added
-- Add support for rails 7.2, but leave out rails 7.1 support. This is because ActionView has a breaking bug in 7.1 that renders the template back as a string
-instead of an object, like we need for Pbbuilder https://github.com/rails/rails/pull/51023
+- Add support for rails 7.2, but leave out rails 7.1 support. This is because ActionView has a breaking bug in 7.1 that renders the template back as a string instead of an object, like we need for Pbbuilder https://github.com/rails/rails/pull/51023 This also removes the uses of the Rails variant of BasicObject in favor of the Ruby built-in.
 
 ## 0.18.0
-### Added
 - Allow literal assignment of protos to fields
 
 ## 0.17.0
-### Changed
 - Instead of appending to repeated enum message, we're replacing it to avoid issues in case output will be rendered twice
 - If one field was defined twice, only last definition will end up in output
-
-## Fixed
 - Fixed CI by locking 3 version or lower of google-protobuf dependency.
 
 ## 0.16.2
-### Added
 - Add support for partial as a first argument , e.g.`pb.friends "racers/racer", as: :racer, collection: @racers`
 - Add tests to verify that fragment caching is operational
 
 ## 0.16.1
-### Changed
 - Deal properly with recursive protobuf messages while using ActiveView::CollectionRenderer
 
 ## 0.16.0
-### Added
 - Added support for new collection rendering, that is backed by ActiveView::CollectionRenderer.
-
-### Changed
 - Refactoring and simplification of #merge! method without a change in functionality.
 
 ## 0.15.1
-### Fixed
 - #merge! method to handle repeated unintialized message object
 
 ## 0.15.0
-### Changed
 - #merge! method was refactored to accomodate caching for all data types (especially those that are :repeated)
 
 ## 0.14.0
-### Added
 - Adding `frozen_string_literal: true` to all files.
 
-## 0.13.2 2023.02.3
-### Fixed
+## 0.13.2
 - In case ActiveSupport::Cache::FileStore in Rails is used as a cache, File.atomic_write can have a race condition and fail to rename temporary file. We're attempting to recover from that, by catching this specific error and returning a value.
 
-## 0.13.1 2023.01.24
-### Added
+## 0.13.1
 - #merge! to support boolean values
 
-## 0.13.0 2023.01.18
-### Added
+## 0.13.0
 - #merge! method added for PbbuilderTemplate class
 - ActiveSupport added as a dependency for gem
 - Fragment Caching support added, with #cache! and #cache_if! methods in PbbuilderTemplate class.
-
-
-### Changed
 - Appraisal is properly configured to run against all rubies and rails combinations.
 - Supported ruby version's are 2.7, 3.0, 3.1
 - Superclass for pbbuilder is now active_support/proxy_object, with a fallback to active_support/basic_object.
@@ -71,10 +57,7 @@ instead of an object, like we need for Pbbuilder https://github.com/rails/rails/
   - `rails` from version 6.1.4.4 to 6.1.7, and from version 7.0.1 to 7.0.4
   - `google-protobuf` is let loose
   - `bundler` from version 2.3.4 to 2.3.22
-
-### Removed
-- TestUnit dependency
-
+- TestUnit dependency removed
 
 ## 0.12.0 Prior to 2022-10-14
 

data/README.md

@@ -1,11 +1,14 @@
 # Pbbuilder
 PBBuilder generates [Protobuf](https://developers.google.com/protocol-buffers) Messages with a simple DSL similar to the [JBuilder](https://rubygems.org/gems/jbuilder) gem.
 
+## Requirements
+This gem only supports Rails 7.0 and Rails 7.2, **7.1 is not supported**.
 
-At least Rails 6.1 is required and rails 7.1 is currently not supported.
 There currently is a regression in ActionView (the part of Rails which renders) that forces rendered objects into strings, but for Pbbuilder we need the raw objects.
 This is only present in Rails 7.1, and a fix is released in Rails 7.2. https://github.com/rails/rails/pull/51023
 
+It might work on rails v6 (it worked previously), but we don't guarantee that and don't test against these versions anymore.
+
 ## Compatibility with jBuilder
 We don't aim to have 100% compitability and coverage with jbuilder gem, but we closely follow jbuilder's API design to maintain familiarity.
 
@@ -154,14 +157,26 @@ Seen in:
 [Errors](lib/pbbuilder/errors.rb)
 
 ## Testing
-Running `bundle exec appraisal rake test` locally will run the entire testsuit with all versions of rails.
-To run tests only for a certain rails version do the following `bundle exec appraisal rails-7-0 rake test`
 
-To run only one tests from file - use `m` utility. Like this:
-`bundle exec appraisal rails-7-0 m test/pbbuilder_template_test.rb:182`
+`pbbuilder` is set up with Appraisal so that we can test a couple Rails and google-protobuf versions against our changes. To run the tests for all setups:
+
+```bash
+$ bundle exec appraisal install
+$ bundle exec appraisal rake test
+
+To run tests only for a certain pre-set Gemfile (check the `Appraisals` file to see what's defined):
+
+```bash
+$ bundle exec appraisal rails-7-2 rake test`
+```
+
+To run only one test use `m` utility. Like this:
+`bundle exec appraisal rails-7-2 m test/pbbuilder_template_test.rb:182`
 
 ## Contributing
+
 Everyone is welcome to contribute.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -21,7 +21,7 @@ else
     file_name = ARGV[1]
     test_name = ARGV[2]&.tr(" ", "_")
 
-    ENV["TESTOPTS"] = "--verbose"
+    ENV["TESTOPTS"] = ""
 
     t.test_files = if file_name
       if test_name

data/gemfiles/rails_7_2.gemfile

@@ -5,5 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "appraisal"
 gem "rails", "~> 7.2.0"
+gem "google-protobuf", "~> 3.25", "< 4.0"
 
 gemspec path: "../"

data/gemfiles/{rails_6.gemfile → rails_8_0.gemfile}

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "appraisal"
-gem "rails", "~> 6.0"
+gem "rails", "~> 8.0.2"
+gem "google-protobuf", "~> 4.0", "< 5.0"
 
 gemspec path: "../"

data/pbbuilder.gemspec

@@ -2,20 +2,21 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.19.0"
-  spec.authors = ["Bouke van der Bijl"]
-  spec.email = ["bouke@cheddar.me"]
+  spec.version = "0.20.0"
+  spec.authors = ["Bouke van der Bijl", "Julik Tarkhanov", "Stas Katkov", "Sebastian van Hesteren"]
+  spec.email = ["julik@cheddar.me"]
   spec.homepage = "https://github.com/cheddar-me/pbbuilder"
-  spec.summary = "Generate Protobuf Messages with a simple DSL similar to JBuilder"
+  spec.summary = "Generate Protobuf messages with a simple DSL similar to JBuilder"
   spec.license = "MIT"
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.2'
 
   spec.files = `git ls-files`.split("\n")
   spec.test_files = `git ls-files -- test/*`.split("\n")
 
-  spec.add_dependency "google-protobuf", "~> 3.25"
+  spec.add_dependency "google-protobuf", ">= 3.25", "< 5.0"
   spec.add_dependency "activesupport"
-  spec.add_development_dependency 'm'
+  spec.add_development_dependency "m"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
 end

data/test/test_helper.rb

@@ -21,28 +21,14 @@ require "pry"
 
 ActiveSupport.test_order = :random
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("pbbuilder.proto", syntax: :proto3) do
-    add_message "pbbuildertest.Person" do
-      optional :name, :string, 1
-      repeated :friends, :message, 2, "pbbuildertest.Person"
-      optional :best_friend, :message, 3, "pbbuildertest.Person"
-      repeated :nicknames, :string, 4
-      optional :field_mask, :message, 5, "google.protobuf.FieldMask"
-      map :favourite_foods, :string, :string, 6
-      repeated :tags, :string, 7
-      optional :last_name, :string, 8
-      optional :boolean_me, :bool, 9
-      optional :logo, :message, 10, "pbbuildertest.Asset"
-    end
-
-    add_message "pbbuildertest.Asset" do
-      optional :url, :string, 1
-      optional :url_2x, :string, 2
-      optional :url_3x, :string, 3
-    end
-  end
+# Regenerate Ruby descriptors from proto if needed, and require them.
+# This does require protoc to be installed
+proto_file = File.expand_path("test_proto.proto", __dir__)
+ruby_out = File.expand_path("test_proto_pb.rb", __dir__)
+if !File.exist?(ruby_out) || File.mtime(ruby_out) < File.mtime(proto_file)
+  system("protoc --proto_path=#{File.dirname(proto_file)} --ruby_out=#{File.dirname(ruby_out)} #{proto_file}")
 end
+require_relative "test_proto_pb"
 
 module API
   Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass

data/test/test_proto.proto

@@ -0,0 +1,27 @@
+// This is the source proto file from which Ruby proto descriptors are generated.
+// See test/test_helper.rb for the generation process.
+
+syntax = "proto3";
+
+package pbbuildertest;
+
+import "google/protobuf/field_mask.proto";
+
+message Person {
+  string name = 1;
+  repeated Person friends = 2;
+  Person best_friend = 3;
+  repeated string nicknames = 4;
+  google.protobuf.FieldMask field_mask = 5;
+  map<string, string> favourite_foods = 6;
+  repeated string tags = 7;
+  string last_name = 8;
+  bool boolean_me = 9;
+  Asset logo = 10;
+}
+
+message Asset {
+  string url = 1;
+  string url_2x = 2;
+  string url_3x = 3;
+} 

data/test/test_proto_pb.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: test_proto.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/field_mask_pb'
+
+
+descriptor_data = "\n\x10test_proto.proto\x12\rpbbuildertest\x1a google/protobuf/field_mask.proto\"\x81\x03\n\x06Person\x12\x0c\n\x04name\x18\x01 \x01(\t\x12&\n\x07\x66riends\x18\x02 \x03(\x0b\x32\x15.pbbuildertest.Person\x12*\n\x0b\x62\x65st_friend\x18\x03 \x01(\x0b\x32\x15.pbbuildertest.Person\x12\x11\n\tnicknames\x18\x04 \x03(\t\x12.\n\nfield_mask\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\x12\x42\n\x0f\x66\x61vourite_foods\x18\x06 \x03(\x0b\x32).pbbuildertest.Person.FavouriteFoodsEntry\x12\x0c\n\x04tags\x18\x07 \x03(\t\x12\x11\n\tlast_name\x18\x08 \x01(\t\x12\x12\n\nboolean_me\x18\t \x01(\x08\x12\"\n\x04logo\x18\n \x01(\x0b\x32\x14.pbbuildertest.Asset\x1a\x35\n\x13\x46\x61vouriteFoodsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"4\n\x05\x41sset\x12\x0b\n\x03url\x18\x01 \x01(\t\x12\x0e\n\x06url_2x\x18\x02 \x01(\t\x12\x0e\n\x06url_3x\x18\x03 \x01(\tb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Pbbuildertest
+  Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass
+  Asset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Asset").msgclass
+end

metadata

@@ -1,29 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Bouke van der Bijl
+- Julik Tarkhanov
+- Stas Katkov
+- Sebastian van Hesteren
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +75,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
-- bouke@cheddar.me
+- julik@cheddar.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,12 +108,8 @@ files:
 - bin/appraisal
 - bin/test
 - gemfiles/.bundle/config
-- gemfiles/rails_6.gemfile
-- gemfiles/rails_6_1.gemfile
-- gemfiles/rails_7.gemfile
-- gemfiles/rails_7_0.gemfile
 - gemfiles/rails_7_2.gemfile
-- gemfiles/rails_head.gemfile
+- gemfiles/rails_8_0.gemfile
 - lib/pbbuilder.rb
 - lib/pbbuilder/collection_renderer.rb
 - lib/pbbuilder/errors.rb
@@ -103,6 +122,8 @@ files:
 - test/pbbuilder_test.rb
 - test/protobuf_extension_test.rb
 - test/test_helper.rb
+- test/test_proto.proto
+- test/test_proto_pb.rb
 homepage: https://github.com/cheddar-me/pbbuilder
 licenses:
 - MIT
@@ -115,19 +136,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Generate Protobuf Messages with a simple DSL similar to JBuilder
+summary: Generate Protobuf messages with a simple DSL similar to JBuilder
 test_files:
 - test/pbbuilder_template_test.rb
 - test/pbbuilder_test.rb
 - test/protobuf_extension_test.rb
 - test/test_helper.rb
+- test/test_proto.proto
+- test/test_proto_pb.rb

data/gemfiles/rails_6_1.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "rails", "~> 6.1.0"
-
-gemspec path: "../"

data/gemfiles/rails_7.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "rails", "~> 7.0"
-
-gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "rails", "~> 7.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_head.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "rails", github: "rails/rails", branch: "main"
-
-gemspec path: "../"