tc_kimlik_no_dogrulama 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 770c4b6419fc28d6ab8b98cdefb8d95e0e0a9f70
-  data.tar.gz: 551d0e8a585ee5c1a5bc4b89d73d506e3e78497b
+SHA256:
+  metadata.gz: 01ec80d63c60295169ff84259cd6f23d5279feecdc7ed6ca30e628e06eee9f25
+  data.tar.gz: 90fd2d82c5d763d40f0afead2ef2144e7bcfe3a4fe23904fe96a7e6d91b97956
 SHA512:
-  metadata.gz: 1766b45d7f98b5ac0b8779bbe8f2c498cb324f9bb0afc41a4fb63aa06e2f1d53ba81b956306251e62c8f765be6d2d2e868869cc73cd1cc7b6c182a740d04ad82
-  data.tar.gz: 5611901502de0dfc075ec18a04cef8107815f1405fbb41583c48078fba3b9c9e844a0d6678dd3f185d39a8c8d79e18f9380ebfacc3adb9a877843acddc96305c
+  metadata.gz: 7961a3233334f164ca68647ede832bae2fc0c88cf5bc61c0565b7942ed8314202cfeea364eb43b77c74e737b36ac4c96c2909a745547c8c9ec88922848b3765e
+  data.tar.gz: 61d06a47c023ab59e0c070878130d11c567334230e4a175fb653732373de72b8afe78b453018dbf6e5d99c5d2c2873e690b0b096668d0dffe614c20ab5ab0928

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+version: "2"
+checks:
+  method-complexity:
+    config:
+      threshold: 8

data/.gitignore

@@ -3,6 +3,7 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
+/test/coverage/
 /doc/
 /pkg/
 /spec/reports/

data/.travis.yml

@@ -0,0 +1,15 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=1ab5ea0a8b53d6cc573cab7cbe2f9c29c33ee4fee596d8880626d9a2e44e1a10
+language: ruby
+rvm:
+  - 2.5.3
+before_install: gem install bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,44 +1,31 @@
-# T.C. Kimlik No Doğrulama
+# Identity Number Verifier for Turkish Citizens
+[![Gem Version](https://badge.fury.io/rb/tc_kimlik_no_dogrulama.svg)](https://rubygems.org/gems/tc_kimlik_no_dogrulama)
+[![Maintainability](https://api.codeclimate.com/v1/badges/046c9404ab8ed2b56c7e/maintainability)](https://codeclimate.com/github/tgezginis/tc_kimlik_no_dogrulama/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/tgezginis/tc_kimlik_no_dogrulama/badge.svg)](https://coveralls.io/github/tgezginis/tc_kimlik_no_dogrulama)
+[![License](https://img.shields.io/github/license/tgezginis/tc_kimlik_no_dogrulama.svg)](https://opensource.org/licenses/MIT)
 
-Ruby için T.C. Kimlik Numarası doğrulama sistemi
+## Installation
 
-## Kurulum
-
-Gemfile dosyasına aşağıdaki kodu ekleyin:
+Add it to your Gemfile:
 
 ```ruby
 gem 'tc_kimlik_no_dogrulama'
 ```
 
-ve terminalde çalıştırın:
+and run on terminal:
 
     $ bundle
 
-ya da gem paketini terminalden manuel olarak kurun:
+or install the gem on terminal.
 
     $ gem install tc_kimlik_no_dogrulama
 
-## Kullanım
+## Usage
 
 ```ruby
 require 'tc_kimlik_no_dogrulama'
-TcKimlikNoDogrulama::verify(18071470110)
-# Sonuç true ya da false dönecektir.
-```
-
 
-**Rails 4**
-```ruby
-TcKimlikNoDogrulama::verify(18071470110)
-# Sonuç true ya da false dönecektir.
+TcKimlikNoDogrulama.verify(18071470110) # true or false
 ```
 
-
-## Algoritma ve kontroller
- - T.C. Kimlik numarası 11 karakter olmalıdır.
- - T.C. Kimlik numarası 0 ile başlayamaz.
- - T.C. Kimlik numarasının tüm karakterleri sayı olmalıdır.
- - 1 3 5 7 ve 9 hanelerinin toplamının 7 katından, 2 4 6 ve 8 hanelerin toplamı çıkartıldığında, elde edilen sonucun 10'a bölümünden kalan sayı, yani Mod 10'u bize 10. haneyi vermelidir.
- - 1 2 3 4 5 6 7 8 9 ve 10 hanelerinin toplamından elde edilen sonucun 10'a bölümünden kalan sayı, yani Mod 10'u bize 11. haneyi vermelidir.
-
- *Algoritma kuralları için [Murat Çorlu](http://muratcorlu.com/post/python-ile-tc-kimlik-numarasi-dogrulama/)'ya teşekkürler.*
+ *Thanks to [Murat Çorlu](http://muratcorlu.com/post/python-ile-tc-kimlik-numarasi-dogrulama/) for verification algorithms.*

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task default: :test

data/lib/tc_kimlik_no_dogrulama.rb

@@ -1,46 +1,11 @@
-require "tc_kimlik_no_dogrulama/version"
+# frozen_string_literal: true
 
-module TcKimlikNoDogrulama
-  def self.verify(tcKimlikNo)
-    tcKimlikNo = tcKimlikNo.to_s
-
-    # Kontrol 1: TC Kimlik numarası boş olmamalıdır.
-    # Kontrol 2: T.C. Kimlik numarası 11 karakter olmalıdır.
-    # Kontrol 3: T.C. Kimlik numarasının tüm karakterleri sayı olmalıdır.
-    # Kontrol 4: T.C. Kimlik numarası 0 ile başlayamaz.
-    if ((!tcKimlikNo.nil?) && (tcKimlikNo.length == 11) && (numeric?(tcKimlikNo)) && (tcKimlikNo[0] != 0))
-      digits = tcKimlikNo.each_char.map(&:to_i)
-
-      sum = 0
-      sum_odd = 0
-      sum_even = 0
-      digits[0..9].each_with_index do |value, i|
-        sum += value
-        if i.even?
-          sum_even += value
-        else
-          sum_odd += value
-        end
-      end
+require 'tc_kimlik_no_dogrulama/version'
+require 'tc_kimlik_no_dogrulama/verifier'
 
-      # 2 Adet Kontrol
-      # Kontrol #1: 1 3 5 7 ve 9 hanelerinin toplamının 7 katından, 2 4 6 ve 8 hanelerin toplamı çıkartıldığında,
-      # elde edilen sonucun 10'a bölümünden kalan sayı,
-      # yani Mod 10'u bize 10. haneyi vermelidir.
-      # Kontrol #2: 1 2 3 4 5 6 7 8 9 ve 10 hanelerinin toplamından elde edilen sonucun
-      # 10'a bölümünden kalan sayı, yani Mod 10'u bize 11. haneyi vermelidir.
-      if (((sum_odd * 7 - sum_even) % 10 == digits[9]) || (sum % 10 == digits[10]))
-        return true
-      else
-        return false
-      end
-    else
-      return false
-    end
-  end
-
-  private
-  def self.numeric?(str)
-    !!(str =~ /\A[[:digit:]]+\Z/)
+module TcKimlikNoDogrulama
+  def self.verify(identifier)
+    verifier = TcKimlikNoDogrulama::Verifier.new(identifier)
+    verifier.valid?
   end
-end
+end

data/lib/tc_kimlik_no_dogrulama/validations/format.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module TcKimlikNoDogrulama::Validations
+  class Format
+    def initialize(value)
+      @value = value.to_s
+      @sum = 0
+      @sum_odd = 0
+      @sum_even = 0
+    end
+
+    def valid?
+      return false if starts_with_zero?
+
+      # Kontrol 1: 1 3 5 7 ve 9 hanelerinin toplamının 7 katından, 2 4 6 ve 8
+      # hanelerin toplamı çıkartıldığında, elde edilen sonucun 10'a bölümünden
+      # kalan sayı, yani Mod 10'u bize 10. haneyi vermelidir.
+      # Kontrol 2: 1 2 3 4 5 6 7 8 9 ve 10 hanelerinin toplamından elde edilen sonucun
+      # 10'a bölümünden kalan sayı, yani Mod 10'u bize 11. haneyi vermelidir.
+
+      calculate_sums
+      (sum_odd * 7 - sum_even) % 10 == digits[9] && sum % 10 == digits[10]
+    end
+
+    private
+
+    attr_accessor :sum, :sum_odd, :sum_even
+
+    def starts_with_zero?
+      # T.C. Kimlik numarası 0 ile başlayamaz.
+      @value.chr == '0'
+    end
+
+    def digits
+      @digits ||= @value.each_char.map(&:to_i)
+    end
+
+    def calculate_sums
+      digits[0..9].each.with_index(1) do |number, index|
+        @sum += number
+        next if index > 9
+
+        index.even? ? @sum_even += number : @sum_odd += number
+      end
+    end
+  end
+end

data/lib/tc_kimlik_no_dogrulama/validations/length.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TcKimlikNoDogrulama::Validations
+  class Length
+    CHARACTER_LENGTH = 11
+
+    def initialize(value)
+      @value = value.to_s
+    end
+
+    def valid?
+      # T.C. Kimlik numarası 11 karakter olmalıdır.
+      @value.length == CHARACTER_LENGTH
+    end
+  end
+end

data/lib/tc_kimlik_no_dogrulama/validations/numericality.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TcKimlikNoDogrulama::Validations
+  class Numericality
+    REGEX = /\A[[:digit:]]+\Z/.freeze
+
+    def initialize(value)
+      # T.C. Kimlik numarasının tüm karakterleri sayı olmalıdır.
+      @value = value.to_s
+    end
+
+    def valid?
+      REGEX.match?(@value)
+    end
+  end
+end

data/lib/tc_kimlik_no_dogrulama/verifier.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'validations', '*.rb')].sort.each { |file| require file }
+
+module TcKimlikNoDogrulama
+  class Verifier
+    VALIDATORS =
+      [
+        TcKimlikNoDogrulama::Validations::Length,
+        TcKimlikNoDogrulama::Validations::Format,
+        TcKimlikNoDogrulama::Validations::Numericality
+      ].freeze
+
+    attr_reader :identifier
+
+    def initialize(identifier)
+      @identifier = identifier
+    end
+
+    def valid?
+      VALIDATORS.all? do |validator|
+        validator.new(identifier).valid?
+      end
+    end
+  end
+end

data/lib/tc_kimlik_no_dogrulama/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TcKimlikNoDogrulama
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/tc_kimlik_no_dogrulama.gemspec

@@ -1,24 +1,26 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tc_kimlik_no_dogrulama/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tc_kimlik_no_dogrulama"
+  spec.name          = 'tc_kimlik_no_dogrulama'
   spec.version       = TcKimlikNoDogrulama::VERSION
-  spec.authors       = ["Tolga Gezginiş"]
-  spec.email         = ["tolga@gezginis.com"]
-  spec.summary       = %q{T.C. Kimlik No Doğrulama}
-  spec.description   = %q{Ruby için T.C. Kimlik Numarası doğrulama sistemi}
-  spec.homepage      = "https://github.com/tgezginis/tc_kimlik_no_dogrulama"
-  spec.license       = "MIT"
+  spec.authors       = ['Tolga Gezginiş']
+  spec.email         = ['tolga@gezginis.com']
+  spec.summary       = 'T.C. Kimlik No Doğrulama'
+  spec.description   = 'Ruby için T.C. Kimlik Numarası doğrulama sistemi'
+  spec.homepage      = 'https://github.com/tgezginis/tc_kimlik_no_dogrulama'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
 end

data/test/tc_kimlik_no_dogrulama_test.rb

@@ -1,15 +1,19 @@
-require 'minitest/autorun'
+# frozen_string_literal: true
+
+require_relative 'test_helper'
 require 'tc_kimlik_no_dogrulama'
 
 class TcKimlikNoDogrulamaTest < Minitest::Test
-  def test_dogru_numaralar
-    assert_equal true, TcKimlikNoDogrulama::verify(18071470110)
-    assert_equal true, TcKimlikNoDogrulama::verify(74091671050)
-    assert_equal true, TcKimlikNoDogrulama::verify(68461383032)
+  def test_success
+    assert_equal true, TcKimlikNoDogrulama.verify(18071470110)
+    assert_equal true, TcKimlikNoDogrulama.verify(74091671050)
+    assert_equal true, TcKimlikNoDogrulama.verify(68461383032)
   end
-  def test_yanlis_numaralar
-    assert_equal false, TcKimlikNoDogrulama::verify(0)
-    assert_equal false, TcKimlikNoDogrulama::verify("string")
-    assert_equal false, TcKimlikNoDogrulama::verify(30402050302)
+
+  def test_fail
+    assert_equal false, TcKimlikNoDogrulama.verify('01234567890')
+    assert_equal false, TcKimlikNoDogrulama.verify('string')
+    assert_equal false, TcKimlikNoDogrulama.verify(30402050302)
+    assert_equal false, TcKimlikNoDogrulama.verify(1234)
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'minitest/autorun'

data/test/validations/format_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require 'tc_kimlik_no_dogrulama/validations/format'
+
+class FormatValidatorTest < Minitest::Test
+  def test_success
+    assert_equal true, TcKimlikNoDogrulama::Validations::Format.new(18071470110).valid?
+    assert_equal true, TcKimlikNoDogrulama::Validations::Format.new(74091671050).valid?
+    assert_equal true, TcKimlikNoDogrulama::Validations::Format.new(68461383032).valid?
+  end
+
+  def test_starts_with_zero
+    assert_equal false, TcKimlikNoDogrulama::Validations::Format.new('01234567890').valid?
+  end
+
+  def test_modulo_check
+    assert_equal false, TcKimlikNoDogrulama::Validations::Format.new(30402050302).valid?
+    assert_equal false, TcKimlikNoDogrulama::Validations::Format.new(12345678901).valid?
+  end
+
+  def test_digits
+    identifier = '30402050302'
+    digits = identifier.each_char.map(&:to_i)
+    assert_equal digits, TcKimlikNoDogrulama::Validations::Format.new(identifier).send('digits')
+  end
+end

data/test/validations/length_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require 'tc_kimlik_no_dogrulama/validations/length'
+
+class LengthValidatorTest < Minitest::Test
+  def test_success
+    assert_equal true, TcKimlikNoDogrulama::Validations::Length.new(12345678901).valid?
+    assert_equal true, TcKimlikNoDogrulama::Validations::Length.new('string01234').valid?
+  end
+
+  def test_fail
+    assert_equal false, TcKimlikNoDogrulama::Validations::Length.new(1234).valid?
+  end
+end

data/test/validations/numericality_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require 'tc_kimlik_no_dogrulama/validations/numericality'
+
+class NumericalityValidatorTest < Minitest::Test
+  def test_success
+    assert_equal true, TcKimlikNoDogrulama::Validations::Numericality.new(123).valid?
+  end
+
+  def test_fail
+    assert_equal false, TcKimlikNoDogrulama::Validations::Numericality.new('abc123').valid?
+    assert_equal false, TcKimlikNoDogrulama::Validations::Numericality.new('string').valid?
+  end
+end

data/test/verifier_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'tc_kimlik_no_dogrulama/verifier'
+
+class VerifierTest < Minitest::Test
+  def sample_verifier
+    TcKimlikNoDogrulama::Verifier.new(18071470110)
+  end
+
+  def test_valid?
+    assert_equal true, sample_verifier.valid?
+  end
+
+  def test_validators
+    assert_equal 3, TcKimlikNoDogrulama::Verifier::VALIDATORS.count
+    assert_equal true, TcKimlikNoDogrulama::Verifier::VALIDATORS == [
+      TcKimlikNoDogrulama::Validations::Length,
+      TcKimlikNoDogrulama::Validations::Format,
+      TcKimlikNoDogrulama::Validations::Numericality
+    ]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tc_kimlik_no_dogrulama
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tolga Gezginiş
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,30 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 description: Ruby için T.C. Kimlik Numarası doğrulama sistemi
 email:
 - tolga@gezginis.com
@@ -59,15 +73,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tc_kimlik_no_dogrulama.rb
+- lib/tc_kimlik_no_dogrulama/validations/format.rb
+- lib/tc_kimlik_no_dogrulama/validations/length.rb
+- lib/tc_kimlik_no_dogrulama/validations/numericality.rb
+- lib/tc_kimlik_no_dogrulama/verifier.rb
 - lib/tc_kimlik_no_dogrulama/version.rb
 - tc_kimlik_no_dogrulama.gemspec
 - test/tc_kimlik_no_dogrulama_test.rb
+- test/test_helper.rb
+- test/validations/format_test.rb
+- test/validations/length_test.rb
+- test/validations/numericality_test.rb
+- test/verifier_test.rb
 homepage: https://github.com/tgezginis/tc_kimlik_no_dogrulama
 licenses:
 - MIT
@@ -87,10 +112,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: T.C. Kimlik No Doğrulama
 test_files:
 - test/tc_kimlik_no_dogrulama_test.rb
+- test/test_helper.rb
+- test/validations/format_test.rb
+- test/validations/length_test.rb
+- test/validations/numericality_test.rb
+- test/verifier_test.rb