turkish_support 1.0.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 290cce063477228d7a8032087805c068b467af96
-  data.tar.gz: 5fb69af5c2164fdbc3101da288c0beac801da65c
+SHA256:
+  metadata.gz: 661daa780f4a86533a3e5b3d7607b5d131549c928ab65db35598f93fbf89c103
+  data.tar.gz: 6006aa50c352658fbac41af13e40e77c49e09ea9887bb2ac605457f0734f14ad
 SHA512:
-  metadata.gz: '018f11e35079fb843da1fa9f955b9f8dac21fa3bffc80b05a23aa9eba75447a09a4fcd2f15613218e272bca91485158084ecdc9b43a0672b975b37705d8f77e3'
-  data.tar.gz: f2c51ae7bf25e8170b71e628b257b880a3db7d6a7a96cc001baed4db9db7ee518a493704907396dfaf250a07f74c80a42dc17b4066e33eca9a29f29a27598ec8
+  metadata.gz: 2b06283e2a0626719a52e3e18e26bc3c4555ecedc2f2e7b05dd998a15953ef0ddf0cbf0b00ce88364941e3c8451467f9d24b6a3ee972f52422e6133e67ff1a30
+  data.tar.gz: e1cffa240cec788281aee54e8a1435255f90e4757b945e5768d100d48408168071a3137e1ba1597d1ce46d8383635e2c426b9fdb9371b02fde58edf38aeb5af0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 todo.txt
+.idea/*

data/.rubocop.yml

@@ -1,3 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.7
 StringLiterals:
   EnforcedStyle: single_quotes
 Documentation:
@@ -5,3 +7,5 @@ Documentation:
 DotPosition:
   EnforcedStyle: leading
   Enabled: true
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.7.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at sbagdat@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2016 Sıtkı Bağdat
+Copyright (c) 2014-2020 Sıtkı Bağdat
 
 MIT License
 

data/README.md

@@ -2,16 +2,15 @@
 
 [![Gem Version](https://badge.fury.io/rb/turkish_support.svg)](http://badge.fury.io/rb/turkish_support)
 [![Build Status](https://travis-ci.org/sbagdat/turkish_support.svg?branch=master)](https://travis-ci.org/sbagdat/turkish_support)
-[![Gitter chat](https://badges.gitter.im/sbagdat/turkish_support.png)](https://gitter.im/sbagdat/turkish_support)
 
 Turkish character support for core ruby methods. This gem provides support nearly all `String` methods, such as `String#upcase`, `String#downcase`, `String#match`, `String#gsub`. It also provides support for `Array#sort`and some bonus methods like `String#titleize`.
 
 ## Requirements
 
-* Ruby  >= 2.0.0
-* Rails >= 4.0.0
+* Ruby  >= 2.7.0
+* Rails >= 6.0.0
 
-__Notice:__ TurkishSupport uses refinements instead of monkey patching. ~~Refinements come with Ruby 2.0.0 as a new feature and also, it is an experimental feature for now. If you want to more information about refinements, you can see the doc at [http://www.ruby-doc.org/core-2.0.0/doc/syntax/refinements_rdoc.html](http://www.ruby-doc.org/core-2.0.0/doc/syntax/refinements_rdoc.html)~~ *Refinements are not an experimental feature, it is a core feature now.*
+__Notice:__ TurkishSupport uses __refinements__ instead of monkey patching.
 
 * [Installation](#installation)
 * [Usage](#usage)
@@ -19,8 +18,8 @@ __Notice:__ TurkishSupport uses refinements instead of monkey patching. ~~Refine
   * [Using with ruby on rails](#using-with-ruby-on-rails)
   * [Using Core Methods](#using-core-methods)
 * [String Methods](#string-methods)
+  * [#<=>](#-spaceship)
   * [#[] and #[]=](#-and-)
-  * [#=~](#-equal-tilda)
   * [capitalize](#capitalize-and-capitalize)
   * [casecmp](#casecmp)
   * [downcase](#downcase-and-downcase)
@@ -123,17 +122,20 @@ If you want to use original set of the core methods in the same scope, you can u
 
 ## String Methods
 
-### [] and []=
-
+### <=> (spaceship)
 ```ruby
-  'Türkiye Cumhuriyeti'[/\w+/] # => "Türkiye"
-  'Çetin'[/[a-ğ]+/i]           # => "Çe"
+  'Cahit' <=> 'Çağla' # => -1
+  'Sıtkı' <=> 'Ömer'  # =>  1
+  'Eren'  <=> 'Eren'  # =>  0
+  'c'     <=> 'ca'    # => -1
 ```
 
-### =~ (equal-tilda)
+
+### [] and []=
 
 ```ruby
-  'Bağlarbaşı Çarşı Kalabalık' =~ (/[s-ü]+/i) # => 8
+  'Türkiye Cumhuriyeti'[/\w+/] # => "Türkiye"
+  'Çetin'[/[a-ğ]+/i]           # => "Çe"
 ```
 
 ### capitalize and capitalize!

data/lib/turkish_support/array_methods.rb

@@ -1,13 +1,12 @@
 module TurkishSupport
   refine Array do
     def sort
-      sort_by do |item|
-        item.chars.map do |ch|
-          if ALPHABET.include?(ch)
-            # Add 65 to put special chars and numbers in correct order
-            ALPHABET.index(ch) + 65
-          else
-            ch.ord
+      if block_given?
+        super
+      else
+        sort_by do |item|
+          item.chars.map do |ch|
+            ALPHABET.include?(ch) ? ASCII_ALPHABET[ch] : ch.ord
           end
         end
       end

data/lib/turkish_support/constants.rb

@@ -1,51 +1,38 @@
-module TurkishSupportHelpers
-  ALPHA = {
-    lower:    'abcçdefgğhıijklmnoöpqrsştuüvwxyz',
-    upper:    'ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZ',
-    tr_lower: 'çğıiöşü',
-    tr_upper: 'ÇĞIİÖŞÜ'
-  }.freeze
+# frozen_string_literal: true
 
+module TurkishSupportHelpers
+  ALPHA = { lower: 'abcçdefgğhıijklmnoöpqrsştuüvwxyz',
+      upper: 'ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZ',
+      tr_lower: 'çğıiöşü',
+      tr_upper: 'ÇĞIİÖŞÜ' }.freeze
   ALPHABET = ALPHA[:upper] + ALPHA[:lower]
-
-  META_CHARS = {
-    '\w' => '[\p{Latin}\d_]',
-    '\W' => '[^\p{Latin}\d_]'
-  }.freeze
-
-  # Regexp required methods
-  RE_RE_METHS = %i(match scan).freeze
-
-  # Regexp optional methods
-  RE_OP_METHS = %i(
-    []
-    []=
-    =~
-    index
-    rindex
-    partition
-    rpartition
-    slice
-    slice!
-    split
-    sub
-    sub!
-    gsub
-    gsub!
-  ).freeze
-
-  CASE_RELATED_METHS = %i(
-    downcase
-    downcase!
-    upcase
-    upcase!
-    capitalize
-    capitalize!
-  ).freeze
-
-  RANGE_REGEXP = /\[[^\]]*?([#{ALPHABET}]-[#{ALPHABET}])[^\[]*?\]/
-
-  CONJUCTIONS = %w(ve ile veya).freeze
-
-  SPECIAL_CHARS = %q{("'}.freeze
+  ASCII_ALPHABET = ALPHABET.chars.map.with_index { |ch, i| [ch, i + 65] }.to_h
+  META_CHARS = { '\w' => '[\p{Latin}\d_]', '\W' => '[^\p{Latin}\d_]' }.freeze
+
+  CASE_RELATED_METHS = %i[downcase
+                          downcase!
+                          upcase
+                          upcase!
+                          capitalize
+                          capitalize!].freeze
+
+  REGEX_REQUIRED_METHODS = %i[match scan].freeze
+  REGEX_OPTIONAL_METHODS = %i[[]
+                              []=
+                              index
+                              rindex
+                              partition
+                              rpartition
+                              slice
+                              slice!
+                              split
+                              sub
+                              sub!
+                              gsub
+                              gsub!].freeze
+  REGEX_METHS = REGEX_REQUIRED_METHODS + REGEX_OPTIONAL_METHODS
+  RANGE_REGEXP = /\[[^\]]*?([#{ALPHABET}]-[#{ALPHABET}])[^\[]*?\]/.freeze
+
+  CONJUCTION = %w[ve ile veya].freeze
+  SPECIAL_CHARS = %q{("'}
 end

data/lib/turkish_support/helpers.rb

@@ -6,7 +6,7 @@ module TurkishSupportHelpers
 
     while re.match(RANGE_REGEXP)
       re.scan(RANGE_REGEXP).flatten.compact.each do |matching|
-        re.gsub! matching, translate_range(matching, pattern.casefold?)
+        re.gsub! matching, translate_range(matching, casefold: pattern.casefold?)
       end
     end
 
@@ -14,38 +14,28 @@ module TurkishSupportHelpers
     Regexp.new(re.force_encoding('UTF-8'), Regexp::FIXEDENCODING | options)
   end
 
-  def translate_range(range_as_string, casefold = false)
+  def translate_range(range_as_string, casefold: false)
     return '' unless range_as_string
 
-    range_as_string.gsub!(/\[\]/, '')
+    range_as_string = range_as_string.gsub(/\[\]/, '')
     first, last = range_as_string.split('-')
-
     expand_range(first, last, casefold)
   end
 
-  def prepare_for(meth, string)
-    valid_meths = %i(upcase downcase capitalize)
-    unless valid_meths.include?(meth) && string.is_a?(String)
-      raise ArgumentError, 'Invalid arguments for method `prepare_for`!'
-    end
-
-    method("prepare_for_#{meth}").call(string)
+  def tr_char?(char)
+    tr_lower?(char) || tr_upper?(char)
   end
 
-  def tr_char?(ch)
-    tr_lower?(ch) || tr_upper?(ch)
+  def tr_lower?(char)
+    ALPHA[:tr_lower].include? char
   end
 
-  def tr_lower?(ch)
-    ALPHA[:tr_lower].include? ch
-  end
-
-  def tr_upper?(ch)
-    ALPHA[:tr_upper].include? ch
+  def tr_upper?(char)
+    ALPHA[:tr_upper].include? char
   end
 
   def conjuction?(string)
-    CONJUCTIONS.include? string
+    CONJUCTION.include? string
   end
 
   def start_with_a_special_char?(string)
@@ -54,21 +44,6 @@ module TurkishSupportHelpers
 
   private
 
-  def prepare_for_upcase(string)
-    string.tr(ALPHA[:tr_lower], ALPHA[:tr_upper])
-  end
-
-  def prepare_for_downcase(string)
-    string.tr(ALPHA[:tr_upper], ALPHA[:tr_lower])
-  end
-
-  def prepare_for_capitalize(string)
-    [
-      prepare_for(:upcase, string.chr).upcase,
-      prepare_for(:downcase, self[1..-1]).downcase
-    ].join
-  end
-
   def expand_range(first, last, casefold)
     if lower.include?(first) && lower.include?(last)
       downcase_range(first, last, casefold)
@@ -91,6 +66,7 @@ module TurkishSupportHelpers
 
   def lower(first = nil, last = nil)
     return ALPHA[:lower] if first.nil? || last.nil?
+
     ALPHA[:lower][ALPHA[:lower].index(first)..ALPHA[:lower].index(last)]
   end
 
@@ -100,6 +76,7 @@ module TurkishSupportHelpers
 
   def upper(first = nil, last = nil)
     return ALPHA[:upper] if first.nil? || last.nil?
+
     ALPHA[:upper][ALPHA[:upper].index(first)..ALPHA[:upper].index(last)]
   end
 

data/lib/turkish_support/string_methods.rb

@@ -1,50 +1,46 @@
+# frozen_string_literal: true
+
 module TurkishSupport
-  refine String do
-    (RE_RE_METHS + RE_OP_METHS).each do |meth|
+  refine String do # rubocop:disable Metrics/BlockLength
+    REGEX_METHS.each do |meth|
       define_method meth do |*args|
-        extend(TurkishSupportHelpers)
-
-        if RE_RE_METHS.include?(meth) || args[0].is_a?(Regexp)
-          args[0] = translate_regexp(args[0])
-        end
+        extend TurkishSupportHelpers
 
-        super(*args)
+        args[0] = translate_regexp(args[0]) if REGEX_REQUIRED_METHODS.include?(meth) || args[0].is_a?(Regexp)
+        instance_exec { super(*args) }
       end
     end
 
     CASE_RELATED_METHS.each do |meth|
-      non_destructive = meth.to_s.chomp('!').to_sym
-      define_method(meth) do
-        extend(TurkishSupportHelpers)
-        str = prepare_for(non_destructive, self).public_send(non_destructive)
-        return meth.to_s.end_with?('!') ? public_send(:replace, str) : str
-      end
+      define_method(meth) { super(:turkic) }
     end
 
-    def titleize(conjuctions = true) # rubocop:disable Metrics/AbcSize
-      split.map do |word|
-        word.downcase!
-        if conjuction?(word) && !conjuctions
+    def titleize(conjuction: true)
+      extend TurkishSupportHelpers
+
+      downcase.split.map do |word|
+        if !conjuction && conjuction?(word)
           word
         elsif start_with_a_special_char?(word)
-          word.size > 1 ? word[0] + word[1..-1].capitalize : word.chr
+          word.chr + (word.length > 1 ? word[1..].capitalize : '')
         else
           word.capitalize
         end
       end.join(' ')
     end
 
-    def titleize!(conjuctions = true)
-      replace(titleize(conjuctions))
+    def titleize!(conjuction: true)
+      replace(titleize(conjuction: conjuction))
     end
 
     def swapcase
-      extend(TurkishSupportHelpers)
-      chars.map do |ch|
-        if tr_char?(ch)
-          tr_lower?(ch) ? ch.upcase : ch.downcase
+      extend TurkishSupportHelpers
+
+      chars.map do |c|
+        if tr_char?(c)
+          tr_lower?(c) ? c.upcase : c.downcase
         else
-          ch.public_send(:swapcase)
+          c.instance_exec { super }
         end
       end.join
     end
@@ -53,8 +49,26 @@ module TurkishSupport
       replace(swapcase)
     end
 
-    def casecmp(other_string)
-      upcase.public_send(:casecmp, other_string.upcase)
+    def casecmp(other)
+      upcase.instance_exec { super(other.upcase) }
+    end
+
+    def <=>(other)
+      return nil unless other.is_a? String
+
+      each_char.with_index do |ch, i|
+        position1 = ASCII_ALPHABET[ch]
+        position2 = ASCII_ALPHABET[other[i]]
+
+        return (position2.nil? ? 0 : -1) if position1.nil?
+        return 1 if position2.nil?
+        return (position1 < position2 ? -1 : 1) if position1 != position2
+      end
+
+      return 0 if length == other.length
+      return -1 if length < other.length
+
+      1
     end
   end
 end