phonofy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab4c944e597b21fd5741b2fe4ae079894b23daef0b1ef5fb02591ea4f9656333
-  data.tar.gz: ad2f6ae7a63313ab311570c18dd3205cd9026237704cb95daa7b2d48e1e004d5
+  metadata.gz: b628ab1214d8aaf8e00487444e04d5bcb54346296a29ed9b50ff5a838f6639ff
+  data.tar.gz: c2641d00024c02b51d724a960f7e8cd8b603ecc79f1168961b315adb070e3fd3
 SHA512:
-  metadata.gz: 603aadd76e3845d374b472fce743f8bf553605715660a8d7a0926feeca4dd52d1def67bf0254ec433846a55d6722dc13373bd6278308db358d851b3bbb0afec1
-  data.tar.gz: 19da8320b25ab52c32c8baa4e1603e984b85ae28d1f56250e12e160f7bf9c9951a1ddf02a9b3876e8dcb1b02ec673a12c16242bfbfb067105e8626f7a3fcb62b
+  metadata.gz: d2f7e112092e433f2db4513aa0ae8317632ffcf485e6f9bdb29b086de8e733e26d1a6859944e876fd08c20f5cc3e1d4298b4e4ffa2ad66fdb91cd3672b30fed2
+  data.tar.gz: 3ef7d410590278075723b4c263a9ef146f503ca7df101f507834060c08db1de671b9842089d3f67e446e1584682eaec07df25e5b545134842b50e0d8b1f6c775

data/README.md

@@ -1,44 +1,81 @@
 # Phonofy
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/phonofy`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'phonofy'
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+And then execute:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```shell
+bundle
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
 
-## Usage
+```shell
+gem install phonofy
+```
 
-TODO: Write usage instructions here
+## **Usage**
+To use phonofy, simply call the **phonofy** method in your Rails model:
 
-To access configs:
+```ruby
+class User < ApplicationRecord
+  phonofy
+end
 ```
-User.phonofy_configs
+
+This will add phone number validation and formatting to the **phone_number** attribute of the **Driver** model.
+
+You can also specify a custom attribute name for the phone number:
+
+```ruby
+class Contact < ApplicationRecord
+  phonofy :mobile_number
+end
 ```
 
-## Development
+This will add phone number validation and formatting to the **mobile_number** attribute of the **Contact** model.
+
+You can also pass additional options to phonofy to customize its behavior:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+class User < ApplicationRecord
+  phonofy :phone, phonelib: { countries: [:us, :ca], types: [:mobile] }
+end
+```
+
+This will add phone number validation and formatting to the **phone** attribute of the **User** model, and restrict it to US and Canada mobile phone numbers.
+
+
+## **Configuration**
+
+You can configure phonofy by creating an initializer file in your Rails application and setting the default options:
+
+```ruby
+# 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
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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.
 
-## Contributing
+## **Contributing**
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phonofy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/phonofy/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/shqear93/phonofy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
 
-## License
+## **License**
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## **Credits**
 
-Everyone interacting in the Phonofy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phonofy/blob/main/CODE_OF_CONDUCT.md).
+phonofy was created by Khaled AbuShqear and is maintained by a community of contributors.

data/README.md.erb

@@ -1,13 +1,13 @@
-# <%= gem_name.capitalize %>
+# <%= spec.name.capitalize %>
 
-<%= gem_description %>
+<%= spec.description %>
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem '<%= gem_name %>'
+gem '<%= spec.name %>'
 ```
 
 And then execute:
@@ -19,11 +19,11 @@ bundle
 Or install it yourself as:
 
 ```shell
-gem install <%= gem_name %>
+gem install <%= spec.name %>
 ```
 
 ## **Usage**
-To use <%= gem_name %>, simply call the **phonofy** method in your Rails model:
+To use <%= spec.name %>, simply call the **phonofy** method in your Rails model:
 
 ```ruby
 class User < ApplicationRecord
@@ -43,7 +43,7 @@ end
 
 This will add phone number validation and formatting to the **mobile_number** attribute of the **Contact** model.
 
-You can also pass additional options to <%= gem_name %> to customize its behavior:
+You can also pass additional options to <%= spec.name %> to customize its behavior:
 
 ```ruby
 class User < ApplicationRecord
@@ -56,21 +56,21 @@ This will add phone number validation and formatting to the **phone** attribute
 
 ## **Configuration**
 
-You can configure <%= gem_name %> by creating an initializer file in your Rails application and setting the default options:
+You can configure <%= spec.name %> by creating an initializer file in your Rails application and setting the default options:
 
 ```ruby
-# config/initializers/<%= gem_name %>.rb
-<%= gem_module %>.configure do |config|
+# config/initializers/<%= spec.name %>.rb
+<%= spec.name.capitalize %>.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 <%= gem_name %> 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 <%= spec.name %> 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.
 
 ## **Contributing**
 
-Bug reports and pull requests are welcome on GitHub at <%= github_url %>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <%= spec.metadata["source_code_uri"] %>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
 
 ## **License**
 
@@ -78,4 +78,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## **Credits**
 
-<%= gem_name %> was created by <%= author_name %> and is maintained by a community of contributors.
+<%= spec.name %> was created by <%= spec.authors.first %> and is maintained by a community of contributors.

data/Rakefile

@@ -12,11 +12,12 @@ RuboCop::RakeTask.new
 task default: %i[spec rubocop]
 
 require "erb"
+spec = Gem::Specification.load("phonofy.gemspec")
 
 desc "Generate README.md from template"
 task :readme do
   template = File.read("README.md.erb")
-  readme = ERB.new(template).result(binding)
+  readme = ERB.new(template).result_with_hash({ spec: spec })
   File.write("README.md", readme)
 end
 

data/lib/phonofy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phonofy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Khaled AbuShqear