turkish_support 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661daa780f4a86533a3e5b3d7607b5d131549c928ab65db35598f93fbf89c103
-  data.tar.gz: 6006aa50c352658fbac41af13e40e77c49e09ea9887bb2ac605457f0734f14ad
+  metadata.gz: e52aee159fcb443687f4d18c2dd77181c0bf4633dc4cdc38a123a8d8522e8865
+  data.tar.gz: 6e4c1d6ee4ac28d67eaef74df372dd6fc14bf1bdde81555008a24295ce21363e
 SHA512:
-  metadata.gz: 2b06283e2a0626719a52e3e18e26bc3c4555ecedc2f2e7b05dd998a15953ef0ddf0cbf0b00ce88364941e3c8451467f9d24b6a3ee972f52422e6133e67ff1a30
-  data.tar.gz: e1cffa240cec788281aee54e8a1435255f90e4757b945e5768d100d48408168071a3137e1ba1597d1ce46d8383635e2c426b9fdb9371b02fde58edf38aeb5af0
+  metadata.gz: b597463d4655ad862c8ba64c0c9020c543b4a85ea606acefb350f8c03164caa2395a1a06b77963c660fe9fb765f15c447e94272a95b722fc6a84c916f7f77d93
+  data.tar.gz: 863aefb578b72b6cee9380c53b13f5ccb275263dd52a846c8afe4647c25448642dca816ce3f762809dffa9e0b9ffb3660a645c569b506025afa491fc294830c8

data/.reek.yml

@@ -0,0 +1,8 @@
+---
+detectors:
+  IrresponsibleModule:
+    exclude:
+    - TurkishSupport
+  UncommunicativeVariableName:
+    exclude:
+    - TurkishSupport

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/.rubocop.yml

@@ -1,11 +1,14 @@
 AllCops:
   TargetRubyVersion: 2.7
-StringLiterals:
-  EnforcedStyle: single_quotes
-Documentation:
-  Enabled: false
-DotPosition:
+  NewCops: enable
+Layout/DotPosition:
   EnforcedStyle: leading
   Enabled: true
 Metrics/BlockLength:
   ExcludedMethods: ['describe', 'context']
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/AsciiComments:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+## [Version 2.1.0](https://github.com/sbagdat/turkish_support/releases/tag/v2.1.0) (2020-11-25)
+### Changed
+- Helpers module extracted into two seperate gems (turkish_ranges, turkish_regexps). [`a2a6261`](https://github.com/sbagdat/turkish_support/commit/a2a6261)
+- Too much refactoring. [`a2a6261`](https://github.com/sbagdat/turkish_support/commit/a2a6261)
+- Decided to keep a changelog file (this file).

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in turkish_support.gemspec
+source 'https://rubygems.org'
+ruby '~> 2.7.0'
 gemspec

data/README.md

@@ -1,24 +1,23 @@
-# TurkishSupport
+# TurkishSupport [![Gem Version](https://badge.fury.io/rb/turkish_support.svg)](https://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) [![Code Climate](https://codeclimate.com/github/sbagdat/turkish_support/badges/gpa.svg)](https://codeclimate.com/github/sbagdat/turkish_support)
 
-[![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)
-
-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`.
+Turkish character support for core ruby methods. This gem provides support nearly all `String` methods,
+such as `String#split`, `String#match`, `String#gsub`. It also provides support for `Array#sort`and some 
+bonus methods like `String#titleize`.
 
 ## Requirements
-
 * Ruby  >= 2.7.0
 * Rails >= 6.0.0
 
-__Notice:__ TurkishSupport uses __refinements__ instead of monkey patching.
-
 * [Installation](#installation)
 * [Usage](#usage)
   * [Using with ruby](#using-with-ruby)
   * [Using with ruby on rails](#using-with-ruby-on-rails)
-  * [Using Core Methods](#using-core-methods)
 * [String Methods](#string-methods)
   * [#<=>](#-spaceship)
+  * [#>](#----comparisons)
+  * [#>=](#----comparisons)
+  * [#<](#----comparisons)
+  * [#<=](#----comparisons)
   * [#[] and #[]=](#-and-)
   * [capitalize](#capitalize-and-capitalize)
   * [casecmp](#casecmp)
@@ -39,20 +38,24 @@ __Notice:__ TurkishSupport uses __refinements__ instead of monkey patching.
 * [Array Methods](#array-methods)
   * [sort](#sort-and-sort)
 
-
 ## Installation
-
 Add this line to your application's Gemfile:
 
-    gem 'turkish_support'
+```
+gem 'turkish_support'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install turkish_support
+```
+$ gem install turkish_support
+```
 
 ## Usage
 
@@ -66,25 +69,23 @@ After the installation of the gem, you should follow these steps.
   require 'turkish_support'
 ```
 
-* Add `using TurkishSupport` line to where you want to activate it.
-
-```ruby
-  using TurkishSupport
-```
+* Add `using TurkishSupport` line to a class or a module.
 
 Example usage inside a class:
 
 ```ruby
 require 'turkish_support'
 
-class Test
+class CanSpeakInTurkish
   using TurkishSupport
-  def up_me(str)
-    str.upcase
+
+  def split_me_up(string, sep)
+    string.split(sep)
   end
 end
 
-Test.new.up_me('içel')  # => "İÇEL"
+CanSpeakInTurkish.new.split_me_up('çar çarı çarşı', 'ç')
+# ['ar', 'arı', 'arşı']
 ```
 
 ### Using with ruby on rails
@@ -96,30 +97,22 @@ __Note:__ You don't need to require, because it is already required by the rails
 ```ruby
   using TurkishSupport
 
-  class SampleModel < ActiveRecord::Base
-    ...
+  class TopModel < ApplicationRecord
+    # your code goes here
   end
 ```
 
-* If you want to use TurkishSupport with a custom class or a module that is not inherited from any rails tie, you must add `using TurkishSupport` line to the class or module.
+* If you want to use TurkishSupport with a custom class or a module that is not inherited from any rails tie, 
+you must add `using TurkishSupport` line to the class or module.
 
 ```ruby
   class CustomClass
     using TurkishSupport
 
-    ...
+    # your code goes here
   end
 ```
 
-### Using Core Methods
-
-If you want to use original set of the core methods in the same scope, you can use `Object#public_send`:
-
-```ruby
-  str = 'Bağcılar'
-  str.public_send(:upcase)  # => "BAğCıLAR"
-```
-
 ## String Methods
 
 ### <=> (spaceship)
@@ -130,16 +123,21 @@ If you want to use original set of the core methods in the same scope, you can u
   'c'     <=> 'ca'    # => -1
 ```
 
+### <, <=, >, >= (comparisons)
+```ruby
+  'd'   >  'ç'     # => true
+  'aha' >= 'ağa'   # => true
+  'd'   <  'ç'     # => false
+  'ağa' <= 'aha'   # => true
+```
 
 ### [] and []=
-
 ```ruby
   'Türkiye Cumhuriyeti'[/\w+/] # => "Türkiye"
   'Çetin'[/[a-ğ]+/i]           # => "Çe"
 ```
 
 ### capitalize and capitalize!
-
 ```ruby
   str = 'türkÇE desteĞİ'
 
@@ -148,13 +146,11 @@ If you want to use original set of the core methods in the same scope, you can u
 ```
 
 ### casecmp
-
 ```ruby
   'sıtKI'.casecmp('SITkı')     # => 0
 ```
 
 ### downcase and downcase!
-
 ```ruby
   str = 'İSMAİL'
 
@@ -163,20 +159,17 @@ If you want to use original set of the core methods in the same scope, you can u
 ```
 
 ### gsub and gsub!
-
 ```ruby
- 'ağapaşaağa'.gsub(/[a-h]+/, 'bey')
+  'ağa paşa ağa'.gsub(/\b[a-h]+\b/, 'bey') # => "bey paşa bey"
 ```
 
 ### index
-
 ```ruby
   '?ç-!+*/-ğüı'.index(/\w+/)        # => 1
   '?ç-!+*/-ğüı'.index(/[a-z]+/, 2)  # => 8
 ```
 
 ### match
-
 ```ruby
   'Aşağı'.match(/\w+/)
   # => #<MatchData "Aşağı">
@@ -195,26 +188,22 @@ If you want to use original set of the core methods in the same scope, you can u
 ```
 
 ### partition
-
 ```ruby
   'Bağlarbaşı Çarşı'.partition(/\W+/) # => ["Bağlarbaşı", " ", "Çarşı"]
 ```
 
 ### rpartition
-
 ```ruby
   'Bağlarbaşı Çarşı Kalabalık'.rpartition(/\W+/)
   # => ["Bağlarbaşı Çarşı", " ", "Kalabalık"]
 ```
 
 ### rindex
-
 ```ruby
   'şç-!+*/-ğüı'.rindex(/\w+/, 7)  # => 1
 ```
 
 ### scan
-
 ```ruby
   'Bağlarbaşı Çarşı Kalabalık'.scan(/[a-z]+/i)
   # => ["Bağlarbaşı", "Çarşı", "Kalabalık"]
@@ -222,13 +211,11 @@ If you want to use original set of the core methods in the same scope, you can u
 
 
 ### slice and slice!
-
 ```ruby
   'Duayen'.slice(/[^h-ö]+/) # => "Duaye"
 ```
 
 ### split
-
 ```ruby
   'Bağlarbaşı Çarşı Kalabalık'.split(/\W+/)
   # => ["Bağlarbaşı", "Çarşı", "Kalabalık"]
@@ -238,22 +225,18 @@ If you want to use original set of the core methods in the same scope, you can u
 ```
 
 ### sub and sub!
-
 ```ruby
   'ağapaşaağa'.sub(/[a-h]+/, 'bey')  # => "beypaşaağa"
 ```
 
 ### swapcase and swapcase!
-
 ```ruby
   'TuğÇE'.swapcase    # => "tUĞçe"
   'TuğÇE'.swapcase!   # => "tUĞçe"
 ```
 
 ### titleize and titleize!
-
 *These methods are not core methods of ruby, but they are accepted as useful in most situations.*
-
 ```ruby
   'türkÇE desteĞİ'.titleize           # => "Türkçe Desteği"
   'türkÇE desteĞİ'.titleize!          # => "Türkçe Desteği"
@@ -261,11 +244,6 @@ If you want to use original set of the core methods in the same scope, you can u
   # Parenthesis, quotes, etc. support
   "rUBY roCkS... (really! 'tRUSt' ME)".titleize
   # => "Ruby Rocks... (Really! 'Trust' Me)"
-
-  # If you don't want to capitalize conjuctions,
-  # simply pass a false value as parameter
-  "kerem VE aslı VeYa leyla İlE mecnun".titleize(false)
-  # => "Kerem ve Aslı veya Leyla ile Mecnun"
 ```
 
 ### upcase and upcase!
@@ -289,10 +267,18 @@ If you want to use original set of the core methods in the same scope, you can u
   # => ["dört", "ılık", "iğne", "iki", "iyne", "üç"]
 ```
 
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
 ## Contributing
 
-1. Fork it ( http://github.com/sbagdat/turkish_support/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/sbagdat/turkish_support. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sbagdat/turkish_suppport/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TurkishSupport project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct]

data/Rakefile

@@ -1,6 +1,14 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+task :cops do
+  sh 'rubocop'
+  puts '-' * 50
+  sh 'reek'
+end
+
 task default: :spec

data/lib/turkish_support.rb

@@ -1,9 +1,39 @@
+# frozen_string_literal: true
+
+require 'turkish_ranges'
+require 'turkish_regexps'
+
 require 'turkish_support/version'
 require 'turkish_support/constants'
-require 'turkish_support/helpers'
-
 require 'turkish_support/string_methods'
 require 'turkish_support/array_methods'
 
+# The TurkishSupport module responsible for making some String and Array
+# methods compatible with Turkish language by using Ruby language's refinements
+# feature.
+#
+# You can check refinements at
+# https://docs.ruby-lang.org/en/master/doc/syntax/refinements_rdoc.html
+#
+# === Refined Methods
+# * String#<=>
+# * String#[]
+# * String#[]=
+# * String#capitalize
+# * String#casecmp
+# * String#downcase
+# * String#gsub
+# * String#index
+# * String#match
+# * String#partition
+# * String#rpartition
+# * String#rindex
+# * String#scan
+# * String#slice
+# * String#split
+# * String#sub
+# * String#swapcase
+# * String#titleize
+# * String#upcase
 module TurkishSupport
 end

data/lib/turkish_support/array_methods.rb

@@ -1,15 +1,12 @@
+# frozen_string_literal: true
+
 module TurkishSupport
+  # :nodoc:
   refine Array do
     def sort
-      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
+      return super if block_given?
+
+      sort_by { _1.chars.map { |ch| TurkishRanges::TrText.new(ch).code } }
     end
 
     def sort!

data/lib/turkish_support/constants.rb

@@ -1,38 +1,30 @@
 # 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]
-  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
+module TurkishSupport
+  CASE_METHODS = %i[downcase
+                    downcase!
+                    upcase
+                    upcase!
+                    capitalize
+                    capitalize!
+                    swapcase
+                    swapcase!].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{("'}
+  REGEX_METHODS = %i[[]
+                     []=
+                     index
+                     gsub
+                     gsub!
+                     match
+                     rindex
+                     partition
+                     rpartition
+                     scan
+                     slice
+                     slice!
+                     split
+                     sub
+                     sub!
+                     gsub
+                     gsub!].freeze
 end