normalizer_jp 0.4.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06946b93936ba980a881277a6f049cd0893a02d949cd64036f9675b9595f7079'
-  data.tar.gz: 527403d8104f15b8b539c5e71a8fa0eeec6a0af749a92ca17447c47ac2d69c76
+  metadata.gz: 417d64efbb124b0e5372e05baeeeef03adacb7813ac02ed4a7a457ddcd903e9c
+  data.tar.gz: 30e5c9a1dd10f7836e5f28da2d9efde85165071ee0ea29eb78f0dd8ed4afef08
 SHA512:
-  metadata.gz: c24260b8608952af7a0e389e5591b1f9297e15cb26c470e662b081f37c2e4fed7068c84f195011e26841ce700e0d08357c3fe22bf81f959ff5f0d5eeeb4f6167
-  data.tar.gz: d807333e9d1f220f762471aaa19c7565c003a8aff6aad57b8a6d90b2bbc7b2c4da3d912242b5788d89085539ad32184076e9862ce718293ada1c2ebbe4372d86
+  metadata.gz: c9610ae79fe74310a87159c992f9250a4cdb528a78513b6789ef6eb52ec44aeca34a616fd84d23e573e3d61cb1f84fa190966a255437f1ee6bf00b6392d993f6
+  data.tar.gz: f6faec9b08413e0ee6c1d678f9a76d0fa3c6b351e792f896a08138097725d5585a35befecb50c8d9d80468fca1e4ed0e08b7d38c491cfb95ed5738891a2b9ef0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    normalizer_jp (0.4.3)
+    normalizer_jp (0.4.4)
       activerecord (~> 5.0)
       activesupport (~> 5.0)
 

data/README.md

@@ -1,8 +1,9 @@
 # NormalizerJp
 
-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/normalizer_jp`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem a provites a simple and flexible way to normalize attributes of
+Ruby Object. NormalizerJP includes a word JP(stands for Japanese), but this gem
+is useful for the other(not Japanese) because you can user custom Normalizer.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -12,23 +13,57 @@ Add this line to your application's Gemfile:
 gem 'normalizer_jp'
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install normalizer_jp
 
 ## Usage
 
-TODO: Write usage instructions here
+### ActiveRecord
+you can use normalizers of this gem.
+```ruby
+class User < ActiveRecord
+  include NormalizerJp::Normalizers
 
-## Development
+  mount_normalizer :name_kana, HiraganaNormalizer
+end
+```
+normlizer works as following:
+```ruby
+user = User.new
+user.name_kana = 'イトウアサコ'
+user.name_kana #=> 'いとうあさこ'
+```
 
-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.
+you can use custom normalizer. customer normalizer's responsibility is implementation of call method as class method. It's super cool.
+```ruby
+# app/normalizers/upcase_normalizer.rb
+class UpcaseNormalizer < NormalizerJp::Normalizers::Base
+  class << self
+    def call(attribute_value)
+      attribute_value.to_s.upcase
+    end
+  end
+end
+
+# app/models/blog.rb
+class Blog < ActiveRecord
+  mount_normalizer :title, UpcaseNormalizer
+end
+```
+
+custom normalizer works as following:
+```ruby
+blog = Blog.new
+blog.title = 'awesome title'
+blog.title #=> 'AWESOME TITLE'
+```
+### Plain Old Ruby Object
+this gem dose not depends active_record, which mean we use this gem in
+Plain Old Ruby Object.
 
-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).
+## Versioning
+This project uses [Semantic Versioning](https://semver.org/) for release numbering.
 
 ## Contributing
 

data/lib/normalizer_jp/normalizers/hankaku_normalizer.rb

@@ -1,6 +1,6 @@
 module NormalizerJp
   module Normalizers
-    class HankakuNormalizer
+    class HankakuNormalizer < Base
       class << self
         def call(atrribute_value)
           convert_alphabet_and_nubmer_to_hankaku(atrribute_value)

data/lib/normalizer_jp/normalizers/hiragana_normalizer.rb

@@ -1,6 +1,6 @@
 module NormalizerJp
   module Normalizers
-    class HiraganaNormalizer
+    class HiraganaNormalizer < Base
       class << self
         def call(attribute_value)
           convert_katakana_to_hiragana(attribute_value)

data/lib/normalizer_jp/normalizers/katakana_normalizer.rb

@@ -1,6 +1,6 @@
 module NormalizerJp
   module Normalizers
-    class KatakanaNormalizer
+    class KatakanaNormalizer < Base
       class << self
         def call(attribute_value)
           convert_hiragana_to_katakana(attribute_value)

data/lib/normalizer_jp/normalizers.rb

@@ -1,9 +1,16 @@
-require "normalizer_jp/normalizers/hankaku_normalizer"
-require "normalizer_jp/normalizers/katakana_normalizer"
-require "normalizer_jp/normalizers/hiragana_normalizer"
-
 module NormalizerJp
   module Normalizers
+    class Base
+      class << self
+        def call(attribute_value)
+          raise NotImplementedError,
+                'Normalizer must implement call methods as class method'
+        end
+      end
+    end
   end
 end
 
+require "normalizer_jp/normalizers/hankaku_normalizer"
+require "normalizer_jp/normalizers/katakana_normalizer"
+require "normalizer_jp/normalizers/hiragana_normalizer"

data/lib/normalizer_jp/version.rb

@@ -1,3 +1,3 @@
 module NormalizerJp
-  VERSION = "0.4.4"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: normalizer_jp
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 1.0.0
 platform: ruby
 authors:
 - koukikitamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler