turkish_support 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5b94d930d37d61a0712cf5153278d446977829e4a8f6b10f95d0e237953bb3
-  data.tar.gz: 46bf4bd9b65029b24979315db8a5e0595665e267d9d739530ad9d77d39b2b2ec
+  metadata.gz: e52aee159fcb443687f4d18c2dd77181c0bf4633dc4cdc38a123a8d8522e8865
+  data.tar.gz: 6e4c1d6ee4ac28d67eaef74df372dd6fc14bf1bdde81555008a24295ce21363e
 SHA512:
-  metadata.gz: 9b200823ace98c49c4e2c7be185771bb9bb9390ba3b6c693786a99b2caef83bbbd399a6df4af45358087016e45c39e4097f0697c4db6aca31950bdb6990f5f70
-  data.tar.gz: e6d100a4395f0fc6c792aa2a105a7f9b739b34b97677e25693ab46ab152fffa2f345b9ce3ba14811b20ac27ebf8d3b1fa9b9d4246531fd9ab44d02b1455bb030
+  metadata.gz: b597463d4655ad862c8ba64c0c9020c543b4a85ea606acefb350f8c03164caa2395a1a06b77963c660fe9fb765f15c447e94272a95b722fc6a84c916f7f77d93
+  data.tar.gz: 863aefb578b72b6cee9380c53b13f5ccb275263dd52a846c8afe4647c25448642dca816ce3f762809dffa9e0b9ffb3660a645c569b506025afa491fc294830c8

data/.gitignore

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

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,9 +1,14 @@
-StringLiterals:
-  EnforcedStyle: single_quotes
-Documentation:
-  Enabled: false
-DotPosition:
+AllCops:
+  TargetRubyVersion: 2.7
+  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/.travis.yml

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

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/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/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/LICENSE.txt

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

data/README.md

@@ -1,26 +1,24 @@
-# 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.0.0
-* Rails >= 4.0.0
-
-__Notice:__ TurkishSupport uses __refinements__ instead of monkey patching.
+* Ruby  >= 2.7.0
+* Rails >= 6.0.0
 
 * [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-)
-  * [#=~](#-equal-tilda)
   * [capitalize](#capitalize-and-capitalize)
   * [casecmp](#casecmp)
   * [downcase](#downcase-and-downcase)
@@ -40,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
 
@@ -67,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
@@ -97,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)
@@ -131,22 +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"
 ```
 
-### =~ (equal-tilda)
-
-```ruby
-  'Bağlarbaşı Çarşı Kalabalık' =~ (/[s-ü]+/i) # => 8
-```
-
 ### capitalize and capitalize!
-
 ```ruby
   str = 'türkÇE desteĞİ'
 
@@ -155,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'
 
@@ -170,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ğı">
@@ -202,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"]
@@ -229,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"]
@@ -245,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"
@@ -268,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!
@@ -296,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