snils 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d078496a9e5e3d59cf848f8e688e77684a5df62
-  data.tar.gz: 400e756356573821582f4d66b4d78238bec532cf
+  metadata.gz: 91cdf5ebb2a1c759d2a516c727f57b76608a0c6d
+  data.tar.gz: b09a5d8567ea381ba33266f35675e62f3d9d1f20
 SHA512:
-  metadata.gz: 32824e28abc137a157b0bd7399726a58e96df0c213eecd2b893c28fb095059161036915ff1718d12a1590a1cc62d7adf8f62878a41bf05c190516fd1d5d104de
-  data.tar.gz: 140f05aa7c5dbf5aedac2643ef6ef591b77cfb88a218902c9c817ae102ba1b4115b5979e35c23a38c9836e35eb893d2e98f97ca8e7acd0776a91aa71e975d409
+  metadata.gz: 68e09826f0a41d26ee283eb7f84c39bf4df40a87662a7830879e465922a4cada26845bdc1780e586832756b3a362e5bc1a478bfdeb61a2b7934105b0ac3e871d
+  data.tar.gz: d190281341892789efde45ecabe5398886bfa57b0825016e9785a6db0856a600a83ff24ee5242cd61cb3d112f5644951960dfc12477ea1b11521640d0003bd14

data/README.md

@@ -51,26 +51,63 @@ Snils.new("216471647").errors
 
 Validating Rails model attributes:
 
+ 1. Modify your gemfile to require `snils/rails`
+
+    ```ruby
+    gem 'snils', require: 'snils/rails'
+    ```
+
+ 2. Add `:snils` validation to SNILS attributes
+
+    ```ruby
+    validates :snils, presence: true, uniqueness: true, snils: true
+    ```
+
+Generating SNILSes in factories for tests:
+
 ```ruby
-require 'snils'
-
-class User < ActiveRecord::Base
-  validates :snils, presence: true, uniqueness: true
-  validate  :snils_validation
-  
-  protected
-  
-  def snils_validation
-    validated_snils = Snils.new(snils)
-    unless validated_snils.valid?
-      validated_snils.errors.each do |error|
-        errors.add(:snils, *error)
-      end
-    end
+FactoryGirl.define do
+  sequence :snils do |_|
+    Snils.new.to_s
+  end
+
+  factory :user do
+    snils
   end
 end
 ```
 
+### Recommended workflow for Ruby on Rails projects
+
+ 1. Use [draper] gem to format SNILS for views
+
+    ```ruby
+    # app/decorators/user_decorator.rb
+    class UserDecorator < Draper::Decorator
+      delegate_all
+
+      def snils
+        @formatted_snils ||= Snils.new(object.snils).formatted
+      end
+    end
+    ```
+
+ 2. Sanitize SNILSes on attribute write
+
+    ```ruby
+    # app/models/user.rb
+    class User < ActiveRecord::Base
+      validates :snils, presence: true, uniqueness: true, snils: true
+
+      def snils=(value)
+        Snils.new(value).raw
+      end
+    end
+    ```
+
+With this setup you will always store raw (only digits) value in database and always will show pretty formatted SNILS to users.
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/Envek/snils/fork )
@@ -79,4 +116,5 @@ end
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+[draper]: https://github.com/drapergem/draper
 [SNILS]: http://en.wikipedia.org/wiki/SNILS_(Russia) "Insurance individual account number"

data/README.ru.md

@@ -46,26 +46,63 @@ Snils.new("216471647").errors
 
 Валидация в Ruby on Rails для атрибутов моделей:
 
+1. Измените Gemfile, чтобы он подключал `snils/rails`
+
+    ```ruby
+    gem 'snils', require: 'snils/rails'
+    ```
+
+ 2. Добавьте валидацию `:snils` к требуемым атрибутам
+
+    ```ruby
+    validates :snils, presence: true, uniqueness: true, snils: true
+    ```
+
+Генерация СНИЛСов в фабриках для тестов:
+
 ```ruby
-require 'snils'
-
-class User < ActiveRecord::Base
-  validates :snils, presence: true, uniqueness: true
-  validate  :snils_validation
-  
-  protected
-  
-  def snils_validation
-    validated_snils = Snils.new(snils)
-    unless validated_snils.valid?
-      validated_snils.errors.each do |error|
-        errors.add(:snils, *error)
-      end
-    end
+FactoryGirl.define do
+  sequence :snils do |_|
+    Snils.new.to_s
+  end
+
+  factory :user do
+    snils
   end
 end
 ```
 
+### Рекомендуемый рабочий процесс для проектов на Ruby on Rails
+
+ 1. Используйте [draper], чтобы форматировать СНИЛС для отображения
+
+    ```ruby
+    # app/decorators/user_decorator.rb
+    class UserDecorator < Draper::Decorator
+      delegate_all
+
+      def snils
+        @formatted_snils ||= Snils.new(object.snils).formatted  if object.snils
+      end
+    end
+    ```
+
+ 2. Очищайте СНИЛС при записи в атрибут модели
+
+    ```ruby
+    # app/models/user.rb
+    class User < ActiveRecord::Base
+      validates :snils, presence: true, uniqueness: true, snils: true
+
+      def snils=(value)
+        Snils.new(value).raw
+      end
+    end
+    ```
+
+С такой настройкой вы всегда будете хранить в БД значение, состоящее только из цифр, а пользователю всегда будете отображать красиво форматированный СНИЛС.
+
+
 ## Помощь в разработке
 
 1. Сделайте форк проекта в своём github-аккаунте. ( https://github.com/Envek/snils/fork )
@@ -74,4 +111,5 @@ end
 4. Запушьте изменения (`git push origin my-new-feature`)
 5. Создайте новый Pull Request
 
+[draper]: https://github.com/drapergem/draper
 [СНИЛС]: http://ru.wikipedia.org/wiki/%D0%A1%D1%82%D1%80%D0%B0%D1%85%D0%BE%D0%B2%D0%BE%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80_%D0%B8%D0%BD%D0%B4%D0%B8%D0%B2%D0%B8%D0%B4%D1%83%D0%B0%D0%BB%D1%8C%D0%BD%D0%BE%D0%B3%D0%BE_%D0%BB%D0%B8%D1%86%D0%B5%D0%B2%D0%BE%D0%B3%D0%BE_%D1%81%D1%87%D1%91%D1%82%D0%B0

data/lib/snils.rb

@@ -19,7 +19,7 @@ class Snils
   # Calculates checksum (last 2 digits) of a number
   def checksum
     digits = @snils.split('').take(9).map(&:to_i)
-    checksum = digits.each.with_index.inject(0) do |sum, (digit, index)|
+    checksum = digits.each.with_index.reduce(0) do |sum, (digit, index)|
       sum + digit * (9 - index)
     end
     while checksum > 101 do
@@ -59,7 +59,7 @@ class Snils
 
   # Generates new random valid SNILS
   def self.generate
-    digits = Array.new(9).map{ rand(10) }.join
+    digits = Array.new(9).map { rand(10) }.join
     sum = self.new(digits).checksum
     "#{digits}#{sum}"
   end
@@ -67,10 +67,9 @@ class Snils
   protected
 
   def validate
-    @errors << [:wrong_length, {:count => 11}]  unless @snils.length == 11
+    @errors << [:wrong_length, { :count => 11 }]  unless @snils.length == 11
     @errors << :invalid  unless @snils[-2..-1] == self.checksum
     @validated = true
   end
 
 end
-

data/lib/snils/all.rb

@@ -0,0 +1,2 @@
+require 'snils'
+require 'snils/rails'

data/lib/snils/rails.rb

@@ -0,0 +1,26 @@
+require 'snils'
+
+# SNILS validation for Active Model (Active Record and Ruby on Rails)
+#
+# Usage:
+#
+# 1. Modify your gemfile to require 'snils/rails'
+#
+#     gem 'snils', require: 'snils/rails'
+#
+# 2. Add +:snils+ validation to SNILS attributes
+#
+#    validates :snils, presence: true, uniqueness: true, snils: true
+#
+class SnilsValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    snils = Snils.new(value)
+    if snils.errors.any? && options[:message]
+      record.errors.add(attribute, options[:message])
+    else
+      snils.errors.each do |error|
+        record.errors.add(attribute, *error)
+      end
+    end
+  end
+end

data/lib/snils/version.rb

@@ -1,3 +1,3 @@
 class Snils
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/spec/snils_spec.rb

@@ -68,12 +68,12 @@ describe Snils do
 
     it 'should not validate invalid snils (with wrong length)' do
       snils = described_class.new('963-117-158 080')
-      expect(snils.errors).to include [:wrong_length, {:count => 11}]
+      expect(snils.errors).to include [:wrong_length, { :count => 11 }]
     end
 
     it 'should not validate invalid snils (with wrong length)' do
       snils = described_class.new('963-117-158')
-      expect(snils.errors).to include [:wrong_length, {:count => 11}]
+      expect(snils.errors).to include [:wrong_length, { :count => 11 }]
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snils
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,8 @@ files:
 - README.ru.md
 - Rakefile
 - lib/snils.rb
+- lib/snils/all.rb
+- lib/snils/rails.rb
 - lib/snils/version.rb
 - snils.gemspec
 - spec/snils_spec.rb