turkish_support 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 290cce063477228d7a8032087805c068b467af96
-  data.tar.gz: 5fb69af5c2164fdbc3101da288c0beac801da65c
+SHA256:
+  metadata.gz: bf5b94d930d37d61a0712cf5153278d446977829e4a8f6b10f95d0e237953bb3
+  data.tar.gz: 46bf4bd9b65029b24979315db8a5e0595665e267d9d739530ad9d77d39b2b2ec
 SHA512:
-  metadata.gz: '018f11e35079fb843da1fa9f955b9f8dac21fa3bffc80b05a23aa9eba75447a09a4fcd2f15613218e272bca91485158084ecdc9b43a0672b975b37705d8f77e3'
-  data.tar.gz: f2c51ae7bf25e8170b71e628b257b880a3db7d6a7a96cc001baed4db9db7ee518a493704907396dfaf250a07f74c80a42dc17b4066e33eca9a29f29a27598ec8
+  metadata.gz: 9b200823ace98c49c4e2c7be185771bb9bb9390ba3b6c693786a99b2caef83bbbd399a6df4af45358087016e45c39e4097f0697c4db6aca31950bdb6990f5f70
+  data.tar.gz: e6d100a4395f0fc6c792aa2a105a7f9b739b34b97677e25693ab46ab152fffa2f345b9ce3ba14811b20ac27ebf8d3b1fa9b9d4246531fd9ab44d02b1455bb030

data/.rubocop.yml

@@ -5,3 +5,5 @@ Documentation:
 DotPosition:
   EnforcedStyle: leading
   Enabled: true
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/LICENSE.txt

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

data/README.md

@@ -2,7 +2,6 @@
 
 [![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`.
 
@@ -11,7 +10,7 @@ Turkish character support for core ruby methods. This gem provides support nearl
 * Ruby  >= 2.0.0
 * Rails >= 4.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,6 +18,7 @@ __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)
@@ -123,6 +123,15 @@ If you want to use original set of the core methods in the same scope, you can u
 
 ## String Methods
 
+### <=> (spaceship)
+```ruby
+  'Cahit' <=> 'Çağla' # => -1
+  'Sıtkı' <=> 'Ömer'  # =>  1
+  'Eren'  <=> 'Eren'  # =>  0
+  'c'     <=> 'ca'    # => -1
+```
+
+
 ### [] and []=
 
 ```ruby

data/lib/turkish_support/array_methods.rb

@@ -4,8 +4,7 @@ module TurkishSupport
       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
+            ASCII_ALPHABET[ch]
           else
             ch.ord
           end

data/lib/turkish_support/constants.rb

@@ -7,7 +7,12 @@ module TurkishSupportHelpers
   }.freeze
 
   ALPHABET = ALPHA[:upper] + ALPHA[:lower]
-
+  
+  ASCII_ALPHABET = ALPHABET.chars.map.with_index do |ch, i|
+    # Add 65 to put special chars and numbers in correct order
+    [ch, i + 65]
+  end.to_h
+  
   META_CHARS = {
     '\w' => '[\p{Latin}\d_]',
     '\W' => '[^\p{Latin}\d_]'

data/lib/turkish_support/helpers.rb

@@ -24,7 +24,7 @@ module TurkishSupportHelpers
   end
 
   def prepare_for(meth, string)
-    valid_meths = %i(upcase downcase capitalize)
+    valid_meths = %i[upcase downcase capitalize]
     unless valid_meths.include?(meth) && string.is_a?(String)
       raise ArgumentError, 'Invalid arguments for method `prepare_for`!'
     end

data/lib/turkish_support/string_methods.rb

@@ -1,5 +1,5 @@
 module TurkishSupport
-  refine String do
+  refine String do # rubocop:disable Metrics/BlockLength
     (RE_RE_METHS + RE_OP_METHS).each do |meth|
       define_method meth do |*args|
         extend(TurkishSupportHelpers)
@@ -56,5 +56,23 @@ module TurkishSupport
     def casecmp(other_string)
       upcase.public_send(:casecmp, other_string.upcase)
     end
+
+    def <=>(other_string)
+      return nil unless other_string.is_a? String
+
+      each_char.with_index do |ch, i|
+        position1 = ASCII_ALPHABET[ch]
+        position2 = ASCII_ALPHABET[other_string[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_string.length
+      return -1 if length < other_string.length
+      return  1
+      
+    end
   end
 end

data/lib/turkish_support/version.rb

@@ -1,3 +1,3 @@
 module TurkishSupport
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/turkish_support_spec.rb

@@ -15,7 +15,7 @@ module TurkishSupport # rubocop:disable Metrics/ModuleLength
     let(:upcased_english_alphabet)   { [*'A'..'Z'].join }
 
     let(:turkish_words) do
-      %w(çamur ıhlamur insan ördek şahika ümraniye)
+      %w[çamur ıhlamur insan ördek şahika ümraniye]
     end
 
     describe '#[]' do
@@ -279,7 +279,7 @@ module TurkishSupport # rubocop:disable Metrics/ModuleLength
           capitalized_words = turkish_words.map { |w| w.capitalize }
 
           expect(capitalized_words)
-            .to eq(%w(Çamur Ihlamur İnsan Ördek Şahika Ümraniye))
+            .to eq(%w[Çamur Ihlamur İnsan Ördek Şahika Ümraniye])
         end
 
         it 'capitalizes the first character of a string and downcase others' do
@@ -554,19 +554,66 @@ module TurkishSupport # rubocop:disable Metrics/ModuleLength
         end
       end
     end
+
+    describe "#<=>" do
+      let(:sorted_equal_length_strings) { %w[Cahit Çağla Ömer Sıtkı Şakir] }
+      let(:sorted_different_length_strings) { %w[c ca falan om saki sıt] }
+      context "with equal length strings" do
+        it "works for smaller test" do
+          0.upto(sorted_equal_length_strings.length - 2) do |i|
+            expect(sorted_equal_length_strings[i] <=> sorted_equal_length_strings[i+1]).to eq(-1)
+          end
+        end
+
+        it "works for bigger test" do
+          (sorted_equal_length_strings.length-1).downto(1) do |i|
+            expect(sorted_equal_length_strings[i] <=> sorted_equal_length_strings[i-1]).to eq(1)
+          end
+        end
+
+        it "works for equals test" do
+          sorted_equal_length_strings.each do |str| 
+            expect(str <=> str).to eq(0)
+          end
+        end
+      end
+
+      context "with different length strings" do
+        it "works for smaller test" do
+          0.upto(sorted_different_length_strings.length - 2) do |i|
+            expect(sorted_different_length_strings[i] <=> sorted_different_length_strings[i+1]).to eq(-1)
+          end
+        end
+
+        it "works for bigger test" do
+          (sorted_different_length_strings.length-1).downto(1) do |i|
+            expect(sorted_different_length_strings[i] <=> sorted_different_length_strings[i-1]).to eq(1)
+          end
+        end
+      end
+
+      context "invalid comparisons" do
+        it "returns nil" do
+          expect("a" <=> 3.5).to eq(nil)
+          expect("a" <=> true).to eq(nil)
+          expect("a" <=> Object.new).to eq(nil)
+          expect("a" <=> 1).to eq(nil)
+        end
+      end
+    end
   end
 
   describe Array do
     let(:unsorted_array1) do
-      %w(bağcılar bahçelievler şimdi çüNKÜ olmalı üç\ kere düş ılık duy)
+      %w[bağcılar bahçelievler şimdi çüNKÜ olmalı üç\ kere düş ılık duy]
     end
 
     let(:sorted_array1) do
-      %w(bağcılar bahçelievler çüNKÜ duy düş ılık olmalı şimdi üç\ kere)
+      %w[bağcılar bahçelievler çüNKÜ duy düş ılık olmalı şimdi üç\ kere]
     end
 
-    let(:unsorted_array2) { %w(iki Üç dört ılık İğne iyne Ul) }
-    let(:sorted_array2)   { %w(İğne Ul Üç dört ılık iki iyne) }
+    let(:unsorted_array2) { %w[iki Üç dört ılık İğne iyne Ul] }
+    let(:sorted_array2)   { %w[İğne Ul Üç dört ılık iki iyne] }
 
     let(:unsorted_array3) do
       ['Sıtkı1 Bağdat', 'Sıtkı Bağdat', 'a', '3s', '2 b', 'ab ']
@@ -578,6 +625,12 @@ module TurkishSupport # rubocop:disable Metrics/ModuleLength
 
     describe '#sort' do
       context 'with non-destructive version' do
+        let(:unsorted_array_for_block_using) {
+          %w[ağa aça aşa aöa aüa aua afa aba]
+        }
+        let(:sorted_array_for_block_using) {
+          %w[aba aça afa ağa aöa aşa aua aüa]
+        }
         it 'does not change the original value of the array' do
           expect { unsorted_array1.sort }.to_not change { unsorted_array1 }
         end
@@ -593,6 +646,10 @@ module TurkishSupport # rubocop:disable Metrics/ModuleLength
         it 'sorts an array that include special chars, numbers, etc.' do
           expect(unsorted_array3.sort).to eq(sorted_array3)
         end
+
+        it 'sorts array for random conditions' do
+          expect(unsorted_array_for_block_using.sort {|a, b| a[1] <=> b[1]}).to eq(sorted_array_for_block_using)
+        end
       end
 
       context 'with destructive version' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turkish_support
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Sıtkı Bağdat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Turkish character support for core ruby methods.