phonofy 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b628ab1214d8aaf8e00487444e04d5bcb54346296a29ed9b50ff5a838f6639ff
-  data.tar.gz: c2641d00024c02b51d724a960f7e8cd8b603ecc79f1168961b315adb070e3fd3
+  metadata.gz: d6ee55367de1d368ab0abacce9dbabf589f6da2a5a8ed458f1541c75f3f26605
+  data.tar.gz: 05004a1aa71520d8c5303817ce77891f1062ceed4e42a0e04c45af9d692294c9
 SHA512:
-  metadata.gz: d2f7e112092e433f2db4513aa0ae8317632ffcf485e6f9bdb29b086de8e733e26d1a6859944e876fd08c20f5cc3e1d4298b4e4ffa2ad66fdb91cd3672b30fed2
-  data.tar.gz: 3ef7d410590278075723b4c263a9ef146f503ca7df101f507834060c08db1de671b9842089d3f67e446e1584682eaec07df25e5b545134842b50e0d8b1f6c775
+  metadata.gz: 0c59eab2f6525b0204123f17b1a7b8a77646ab22820dc8f9d03f17cabfa07eba95fcbb53da2a5b50a751640a629225cf199adbf9a25de39615b139b975a6a115
+  data.tar.gz: 69b17995effa660b2b540dff26449a118f206360d4ef9073fc3dc57ccf003342038e71278f7b3fbf3fdf0e4d3ccf172e2be7e168b7e8c09ef3c39d098f3a2e41

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-04-24
+
+- Added compatibility with Rails 8.0
+- Replaced Rails Engine with Railtie for lighter integration
+- Improved code organization and dependency management
+- Enhanced test coverage for international phone numbers
+- Fixed validator loading
+
 ## [0.1.0] - 2023-03-30
 
 - Initial release

data/Gemfile

@@ -10,3 +10,8 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+group :test do
+  gem "activerecord"
+  gem "sqlite3", "~> 2.6"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phonofy (0.1.1)
+    phonofy (0.2.0)
       activerecord
       i18n
       phonelib
@@ -9,30 +9,178 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
-    concurrent-ruby (1.2.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.1)
+    crass (1.0.6)
+    date (3.4.1)
     diff-lcs (1.5.0)
+    drb (2.2.1)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.6.3)
+    logger (1.7.0)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
     minitest (5.18.0)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.7-arm64-darwin)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
     phonelib (0.7.7)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.13)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.0.6)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
     regexp_parser (2.7.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -60,18 +208,34 @@ GEM
     rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sqlite3 (2.6.0-arm64-darwin)
+    stringio (3.1.6)
+    thor (1.3.2)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-24
 
 DEPENDENCIES
+  activerecord
   phonofy!
+  rails (>= 6.0, < 9.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  sqlite3 (~> 2.6)
 
 BUNDLED WITH
    2.4.10

data/README.md

@@ -1,6 +1,6 @@
 # Phonofy
 
-Phonofy is a Ruby gem that simplifies phone number formatting in Rails applications using the Phonelib library. With Phonofy, you can easily parse and format phone number data according to international standards, ensuring that your phone number data is consistent and valid across your application.
+Phonofy is a Ruby gem that simplifies phone number formatting in Ruby applications using the Phonelib library. It integrates seamlessly with Rails applications (compatible with Rails 6.0 through 8.0) but can also be used in non-Rails environments. With Phonofy, you can easily parse and format phone number data according to international standards, ensuring that your phone number data is consistent and valid across your application.
 
 ## Installation
 
@@ -31,7 +31,7 @@ class User < ApplicationRecord
 end
 ```
 
-This will add phone number validation and formatting to the **phone_number** attribute of the **Driver** model.
+This will add phone number validation and formatting to the **phone_number** attribute of the **User** model.
 
 You can also specify a custom attribute name for the phone number:
 
@@ -62,11 +62,30 @@ You can configure phonofy by creating an initializer file in your Rails applicat
 # config/initializers/phonofy.rb
 Phonofy.configure do |config|
   config.default_phonelib_options = { countries: [:us, :ca], types: [:mobile] }
-  config.default_twilio_options = { lookup: { type: :carrier_type } }
 end
 ```
 
-This will set the default options for phonofy to validate only US and Canada mobile phone numbers using the Phonelib library, and perform a Twilio lookup to get carrier information for the phone number.
+This will set the default options for phonofy to validate only US and Canada mobile phone numbers using the Phonelib library.
+
+## **International Phone Number Support**
+
+Phonofy supports international phone numbers through the Phonelib gem. You can validate and format phone numbers for specific countries by including the country codes in the countries option:
+
+```ruby
+class User < ApplicationRecord
+  phonofy :phone, phonelib: { countries: [:us, :gb, :fr] }
+end
+```
+
+Example usage:
+
+```ruby
+user = User.new(phone: "+14155552671")
+user.phone(:e164)          # => "+14155552671"
+user.phone(:international) # => "+1 415-555-2671"
+user.phone(:national)      # => "(415) 555-2671"
+user.phone_is_valid?       # => true
+```
 
 ## **Contributing**
 

data/lib/model/class_methods.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
-# require_relative "phonofy/fy/version"
 
 module Phonofy
   module Model
     module ClassMethods
-
-      DEFAULTS = { phonelib: { allow_blank: true, validation_options: {} } }.freeze
+      DEFAULTS = {
+        phonelib: {
+          allow_blank: true,
+          validation_options: {}
+        }
+      }.deep_merge(Phonofy.config.default_phonelib_options || {}).freeze
 
       def phonofy(column_name = :phone_number, **options)
         options = DEFAULTS.deep_merge(options)
@@ -15,7 +18,7 @@ module Phonofy
           self.phonofy_configs = { _counter: {} }
         end
 
-        counter                                 = (phonofy_configs[:_counter][column_name] ||= 0)
+        counter = (phonofy_configs[:_counter][column_name] ||= 0)
         phonofy_configs[:_counter][column_name] += 1
 
         phonofy_configs["#{column_name}_#{counter}"] = options.dup

data/lib/phonofy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phonofy
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/phonofy.rb

@@ -1,22 +1,44 @@
 # frozen_string_literal: true
 
 require_relative "phonofy/version"
-
-require "active_record"
-require "model/instance_dynamic_methods"
 require "phonelib"
-require "model"
 
 module Phonofy
   class Error < StandardError; end
 
-  class Engine < ::Rails::Engine
-    initializer "phonofy.initialize" do
-      ActiveSupport.on_load(:active_record) do
-        include Phonofy::Model
-      end
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.config
+    configuration
+  end
+
+  class Configuration
+    attr_accessor :default_phonelib_options
 
-      config.i18n.load_path += Dir[config.root.join("config", "locales", "**", "*.{rb,yml}")]
+    def initialize
+      @default_phonelib_options = {}
     end
   end
+
+  # Initialize default configuration
+  self.configuration = Configuration.new
 end
+
+# Load ActiveRecord-related code
+require "active_record"
+require_relative "model/instance_dynamic_methods"
+require_relative "model"
+
+# Only load the Railtie if Rails is available
+if defined?(Rails)
+  require_relative "railtie"
+end
+
+# Model is already required above

data/lib/railtie.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails"
+require "pathname"
+require_relative "model"
+
+module Phonofy
+  class Railtie < Rails::Railtie
+    initializer "phonofy.initialize" do
+      ActiveSupport.on_load(:active_record) do
+        include Phonofy::Model
+      end
+    end
+
+    initializer "phonofy.load_translations" do
+      # Use Rails.root if available, otherwise use the gem's path
+      if defined?(Rails.root) && Rails.root
+        config.i18n.load_path += Dir[Rails.root.join("config", "locales", "**", "*.{rb,yml}")]
+      else
+        # Fallback to the gem's own translations
+        gem_root = Pathname.new(File.expand_path("../", __dir__))
+        config.i18n.load_path += Dir[gem_root.join("config", "locales", "**", "*.{rb,yml}")]
+      end
+    end
+  end
+end

data/lib/validators/extended_phone_validator.rb

@@ -2,6 +2,7 @@
 
 require_relative "../validators"
 require "#{Gem::Specification.find_by_name("phonelib").gem_dir}/lib/validators/phone_validator"
+require "active_model/version"
 
 module Phonofy
   module Validators
@@ -13,7 +14,16 @@ module Phonofy
         valid  = countries.present? ? valid_country? : phone_valid?
         valid  = valid && valid_types? && valid_extensions?
 
-        record.errors.add(attribute, message(error_message), options) unless valid
+        unless valid
+          # Rails 8.0+ compatibility - errors.add no longer accepts options as a third argument
+          if ActiveModel.version >= Gem::Version.new('8.0.0')
+            # For Rails 8.0+, use the new API
+            record.errors.add(attribute, message(error_message), **options)
+          else
+            # For older Rails versions, use the old API
+            record.errors.add(attribute, message(error_message), options)
+          end
+        end
       end
 
       private

data/sig/phonofy/configuration.rbs

@@ -0,0 +1,7 @@
+module Phonofy
+  class Configuration
+    attr_accessor default_phonelib_options: Hash[Symbol, untyped]
+
+    def initialize: () -> void
+  end
+end

data/sig/phonofy/model/class_methods.rbs

@@ -0,0 +1,9 @@
+module Phonofy
+  module Model
+    module ClassMethods
+      DEFAULTS: Hash[Symbol, untyped]
+
+      def phonofy: (?Symbol column_name, **untyped options) -> void
+    end
+  end
+end

data/sig/phonofy/model/instance_dynamic_methods.rbs

@@ -0,0 +1,11 @@
+module Phonofy
+  module Model
+    class InstanceDynamicMethods < Module
+      DEFAULT_PHONE_FORMAT: Symbol
+      SUPPORTED_FORMATS: Array[Symbol]
+
+      def initialize: (Symbol column_name, Hash[Symbol, untyped] options) -> void
+      def included: (Class base) -> void
+    end
+  end
+end

data/sig/phonofy/model.rbs

@@ -0,0 +1,5 @@
+module Phonofy
+  module Model
+    def self.included: (Class base) -> void
+  end
+end

data/sig/phonofy/railtie.rbs

@@ -0,0 +1,5 @@
+module Phonofy
+  class Railtie < Rails::Railtie
+    # No need to define initializers in RBS
+  end
+end

data/sig/phonofy/validators/extended_phone_validator.rbs

@@ -0,0 +1,16 @@
+module Phonofy
+  module Validators
+    class ExtendedPhoneValidator < PhoneValidator
+      def validate_each: (untyped record, Symbol attribute, untyped value) -> void
+      def check_rails_version: () -> bool
+
+      private
+
+      def message: (?Symbol custom) -> Symbol
+
+      def error_message: () -> Symbol
+
+      def valid_country?: () -> bool
+    end
+  end
+end

data/sig/phonofy/validators.rbs

@@ -0,0 +1,4 @@
+module Phonofy
+  module Validators
+  end
+end

data/sig/phonofy.rbs

@@ -1,4 +1,15 @@
 module Phonofy
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
+
+  class << self
+    attr_accessor configuration: Configuration
+  end
+
+  # These methods are already defined by the attr_accessor above
+
+  def self.configure: () { (Configuration) -> void } -> void
+  def self.config: () -> Configuration
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: phonofy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Khaled AbuShqear
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -52,10 +51,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Phonofy is a Ruby gem that simplifies phone number formatting in Rails
-  applications using the Phonelib library. With Phonofy, you can easily parse and
-  format phone number data according to international standards, ensuring that your
-  phone number data is consistent and valid across your application.
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Phonofy is a Ruby gem that simplifies phone number formatting in Ruby
+  applications using the Phonelib library. It integrates seamlessly with Rails applications
+  but can also be used in non-Rails environments. With Phonofy, you can easily parse
+  and format phone number data according to international standards, ensuring that
+  your phone number data is consistent and valid across your application.
 email:
 - qmax93@gmail.com
 executables: []
@@ -78,9 +98,17 @@ files:
 - lib/model/instance_dynamic_methods.rb
 - lib/phonofy.rb
 - lib/phonofy/version.rb
+- lib/railtie.rb
 - lib/validators.rb
 - lib/validators/extended_phone_validator.rb
 - sig/phonofy.rbs
+- sig/phonofy/configuration.rbs
+- sig/phonofy/model.rbs
+- sig/phonofy/model/class_methods.rbs
+- sig/phonofy/model/instance_dynamic_methods.rbs
+- sig/phonofy/railtie.rbs
+- sig/phonofy/validators.rbs
+- sig/phonofy/validators/extended_phone_validator.rbs
 homepage: https://github.com/shqear93/phonofy
 licenses:
 - MIT
@@ -88,7 +116,6 @@ metadata:
   homepage_uri: https://github.com/shqear93/phonofy
   source_code_uri: https://github.com/shqear93/phonofy
   changelog_uri: https://github.com/shqear93/phonofy/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Phonofy integrates with rails ActiveRecord to provide formatting functionalities.
+summary: Phonofy integrates with ActiveRecord to provide phone number formatting functionalities.
 test_files: []