normalize_digits 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71f47e65081d82f5024e730b131c9ba7d2b8e969761f0ec542cc5e5d1f4e96b
-  data.tar.gz: d1e42c7c0c1452c552ca2e8fd8b918bd7e5b41bc6c5ab292651da78601ed2a4e
+  metadata.gz: 778e0a62279930e47ef74cd21d2807d4c7cb720dcb0deb6ea7861d4025ebf43e
+  data.tar.gz: 8fbf501a76462502277d5dc665cf0aae8748fec28a833bc96d23c66f97de23da
 SHA512:
-  metadata.gz: f0f10717beb08f93a12d9c759e2218c5df6df9a381215b0f589af92cdd39e11e52831e312f0beda8a9e0c2bc0a37117dd17a5859a7085989ba740553a73e6de0
-  data.tar.gz: 907e8a91a39c8224c54484e563045582f4db0dcb36b1303c3fdf3de0d4322892df712cab7d8cfbe63c93c95f71f3d80c2d9cf955107f2d85b78f27c33fae5a8f
+  metadata.gz: 9374156d16f29ca671f8341f78f628b8123eda4c8158d6dd1f884e90f9511aa9b6cad616b30cb8666f67655518584c4ed8c7f452a96bd8da78a756dbfa070191
+  data.tar.gz: 217be1503fc313bd359a55a5d59c2f204816335c96b10976f9a68b566504eb99314cc676b50a170aad70c21414d984ebfaf825b902f3700ea025edcd0dab8b4d

data/README.md

@@ -1,8 +1,16 @@
 # NormalizeDigits
 
-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/normalize_digits`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/normalize_digits.svg)](https://badge.fury.io/rb/normalize_digits)
 
-TODO: Delete this and the text above, and describe your gem
+NormalizeDigits is a lightweight ActiveModel extension that automatically converts non-English digits (like Arabic,
+Persian, etc.) to standard English digits (`0-9`) before validation. This is useful for applications where users might
+input localized numerals, and consistent numeric formatting is required.
+
+## Features
+
+- Automatically normalizes any non-English digits to ASCII numerals.
+- Integrates seamlessly with ActiveModel or ActiveRecord attributes.
+- Useful for form inputs, APIs, and user-generated content.
 
 ## Installation
 
@@ -14,30 +22,58 @@ gem 'normalize_digits'
 
 And then execute:
 
-    $ bundle
+```shell
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install normalize_digits
+```shell
+gem install normalize_digits
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Simply include the concern in your model and specify which attributes you want to normalize:
 
-## Development
+```ruby
 
-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.
+class User < ApplicationRecord
+  include NormalizeDigits
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  normalize_digits
+  # normalize_digits only: [:username]
+  # normalize_digits except: [:username]
+end
+```
 
-## Contributing
+Before validation, any non-English digits in the specified fields will be converted to standard 0-9.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/normalize_digits. 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.
+### Example
 
-## License
+```ruby
+user = User.new(phone_number: "٠٥٠١٢٣٤٥٦٧")
+user.valid?
+user.phone_number
+# => "0501234567"
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+### Supported Digit Sets
 
-## Code of Conduct
+The gem currently supports:
+• Arabic-Indic digits: `٠١٢٣٤٥٦٧٨٩`
+• Eastern Arabic digits: `۰۱۲۳۴۵۶۷۸۹`
+• Can be extended easily via the matchers.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/your-username/normalize_digits.
+1. Fork the repo
+2. Create your feature branch (git checkout -b feature/awesome)
+3. Commit your changes (git commit -am 'Add awesome feature')
+4. Push to the branch (git push origin feature/awesome)
+5. Create a new Pull Request
+
+## License
 
-Everyone interacting in the NormalizeDigits project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/normalize_digits/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the MIT License.

data/lib/normalize_digits/matchers.rb

@@ -28,7 +28,7 @@ module NormalizeDigits
 
       # RSpec 3.x
       def failure_message
-        "Expected to be englishized from #{@attribute}, but it was not"
+        "Expected to be normalized from #{@attribute}, but it was not"
       end
 
       # RSpec 1.2, 2.x
@@ -36,7 +36,7 @@ module NormalizeDigits
 
       # RSpec 3.x
       def failure_message_when_negated
-        "Expected to remain on #{@attribute}, but it was englishized"
+        "Expected to remain on #{@attribute}, but it was normalized"
       end
 
       # RSpec 1.2, 2.x

data/lib/normalize_digits/version.rb

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

data/spec/normalize_digits_spec.rb

@@ -68,7 +68,7 @@ RSpec.describe NormalizeDigits do
   context "Englishize all attrs" do
     subject { instance_for(EnglishizeAll) }
 
-    it "should englishize strings" do
+    it "should normalize strings" do
       is_expected.to normalize_digits_for(:a)
       is_expected.to normalize_digits_for(:b)
       is_expected.to normalize_digits_for(:d)
@@ -90,7 +90,7 @@ RSpec.describe NormalizeDigits do
   context "Englishize only one attr" do
     subject { instance_for(EnglishizeOnlyOne) }
 
-    it "should englishize included strings" do
+    it "should normalize included strings" do
       is_expected.to normalize_digits_for(:a)
     end
 
@@ -102,7 +102,7 @@ RSpec.describe NormalizeDigits do
   context "Englishize only two attrs" do
     subject { instance_for(EnglishizeOnlyTwo) }
 
-    it "should englishize included strings" do
+    it "should normalize included strings" do
       is_expected.to normalize_digits_for(:a)
       is_expected.to normalize_digits_for(:b)
     end
@@ -115,7 +115,7 @@ RSpec.describe NormalizeDigits do
   context "Englishize except one attr" do
     subject { instance_for(EnglishizeExceptOne) }
 
-    it "should englishize included strings" do
+    it "should normalize included strings" do
       is_expected.to normalize_digits_for(:b)
     end
 
@@ -127,7 +127,7 @@ RSpec.describe NormalizeDigits do
   context "Englishize except two attrs" do
     subject { instance_for(EnglishizeExceptTwo) }
 
-    it "should englishize included strings" do
+    it "should normalize included strings" do
       is_expected.to normalize_digits_for(:d)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: normalize_digits
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - aalyahya