pico_phone-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a77136e5c4b12dd9a039e2fc5fb3a417bd6eae8e353c937f9c05b8c7b768fea4
-  data.tar.gz: 6979e2642a4793889171a5de42a7f5bf209b486a4845488fd296b8af54821425
+  metadata.gz: 84738b06cba145a9e86bedc83516cd76511f8eeb275157a6807b22bc8b646c99
+  data.tar.gz: be4865cf109ea61e834dc4f69d24c7937de912872915bc7014947d12f53f2b3c
 SHA512:
-  metadata.gz: 8ee3cebc17f0fa5fa98ad427b763b024ad97114738d40e774739a50c04abe2c5c9082177fdefb31bd6e9a1a89ef9d026da6c1a0a7aafbca5c1c30473dd456366
-  data.tar.gz: dffc493a5abe2b513629b9fa29cc7ac741d5181f7e128add7d592baeab92e4b3c757f3e9d5ecc2faf82067b76810498f681b15a5d0400dde53e5cd5e0d53d809
+  metadata.gz: d13dae58efa40a2d05affceb83b3da6c2b5f15576c9ee45c07856a1e0f31c83d7b483f2abed929ba1b205f6b7534cd615d0a3edb2958a39cd6e5a4741cbfb581
+  data.tar.gz: 1636311abdb2f94b9e7adac696d3ef6f13bcc7f3d840a8d40c935e4a9d6d498559c6df830dd1e11660d0c2ce455128864b930a1719815d6caf09450265850164

data/README.md

@@ -1,8 +1,8 @@
 # pico_phone-rails
 
 Rails integration for [`pico_phone`](https://github.com/gjack/pico_phone): an
-ActiveRecord attribute type, an ActiveModel validator, and a before-validation
-normalizer for phone numbers.
+ActiveRecord attribute type, an ActiveModel validator, a before-validation
+normalizer, and an ActiveJob serializer for phone numbers.
 
 ## Installation
 
@@ -52,6 +52,17 @@ A `before_validation` callback that rewrites the column to E.164 when it parses
 as valid, so formatting noise ("(510) 274-5656") is stripped before the
 validator runs. Pairs naturally with the validator above.
 
+### ActiveJob serializer
+
+```ruby
+MyJob.perform_later(phone: PicoPhone.parse("+15102745656", "US"))
+```
+
+A `PicoPhone::PhoneNumber` passed as a job argument survives the round trip
+through your queue backend (Sidekiq, Solid Queue, GoodJob, etc.) without
+manually converting to/from a string — `perform` receives back a real
+`PhoneNumber`, not the E.164 string it was serialized as.
+
 ## Development
 
 ```bash

data/lib/pico_phone/rails/railtie.rb

@@ -17,6 +17,13 @@ module PicoPhone
         end
       end
 
+      initializer "pico_phone_rails.active_job_serializer" do
+        ActiveSupport.on_load(:active_job) do
+          require "pico_phone/rails/serializers/phone_number_serializer"
+          ActiveJob::Serializers.add_serializers(PicoPhone::Rails::Serializers::PhoneNumberSerializer)
+        end
+      end
+
       initializer "pico_phone_rails.i18n" do |app|
         app.config.i18n.load_path += Dir[File.expand_path("locale/*.yml", __dir__)]
       end

data/lib/pico_phone/rails/serializers/phone_number_serializer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module PicoPhone
+  module Rails
+    module Serializers
+      # Registered with ActiveJob::Serializers in the railtie, only once
+      # ActiveJob itself has loaded. Lets a PhoneNumber survive as a job
+      # argument without the caller manually converting to/from a string:
+      #
+      #   MyJob.perform_later(phone: PicoPhone.parse("+15102745656", "US"))
+      #
+      # #to_s alone is enough to round-trip losslessly: E.164 is
+      # region-independent for valid numbers, and for invalid/unparseable
+      # input #to_s already falls back to the original string, which
+      # reparses to the same #to_s/#valid? regardless of region.
+      class PhoneNumberSerializer < ActiveJob::Serializers::ObjectSerializer
+        def serialize(phone_number)
+          super("value" => phone_number.to_s)
+        end
+
+        def deserialize(hash)
+          PicoPhone.parse(hash["value"])
+        end
+
+        # Public since ActiveJob 8.1: Serializers.serializer_for builds a
+        # lookup index keyed by this, and warns (raising from 8.2 on) if
+        # it's private.
+        def klass
+          PicoPhone::PhoneNumber
+        end
+      end
+    end
+  end
+end

data/lib/pico_phone/rails/version.rb

@@ -2,6 +2,6 @@
 
 module PicoPhone
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pico_phone-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabi Jack
@@ -67,6 +67,7 @@ files:
 - lib/pico_phone/rails/locale/en.yml
 - lib/pico_phone/rails/normalizer.rb
 - lib/pico_phone/rails/railtie.rb
+- lib/pico_phone/rails/serializers/phone_number_serializer.rb
 - lib/pico_phone/rails/type.rb
 - lib/pico_phone/rails/version.rb
 homepage: https://github.com/gjack/pico_phone-rails