turkish_ranges 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07df9bccb8c08e73eaccb0bdea30a7ff2f1a2b3e5b81b3c5caba3c7642f4acca
-  data.tar.gz: c6d1c09a6062e25c5123f50ef949367756d84e9f9a78c839fec2f5e168546a42
+  metadata.gz: 541ad676ae6e965932c387cc84ab9792636b640da5c5490ec0e456805a76c0d8
+  data.tar.gz: '0428644d1d5f0b167ed91235013ba23b5a465c5aad7be2150fb9c553982d4a55'
 SHA512:
-  metadata.gz: d24e2990d53bd263a86aa48cc0ca3913eb544786f673b78d9496930feb0175ccae846648296ecda33ff1125464b5d865898f5a6d526b6f0a1e341124d8ce0e3f
-  data.tar.gz: 9bda5d5ad151562a846cd99f351edfd204aca214cd1290251b4aa439b58ea7ec507c158ad4031aaaabd3dea2c34f76c7e2251ef008372f54c697623b1e036569
+  metadata.gz: 1eab65f0fc36146349dfe13dd72782f7b06e00386f83ddd8e07677b4a78b2736c9ce73bcfc85b9663fa969ca76ba4eb1e01ab0ca8be88a6ba0eb3ec7bb5fb419
+  data.tar.gz: 504e32de91f19004c41f95898da7a22f2d9a3c8b93928cd117aa424d70a5c736249e45dd3c779cb74ad2253fae4ea46a36ffd496a8a11676a650c91b536b216c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+Layout/DotPosition:
+  EnforcedStyle: leading
+  Enabled: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/AsciiComments:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'bin/console'
+    - 'Rakefile'
+Metrics/BlockLength:
+  ExcludedMethods:
+    - 'describe'
+    - 'context'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Version 0.0.1](https://github.com/sbagdat/turkish_ranges/releases/tag/v0.1.0) (2020-11-23)
+
+### New features
+
+- Capability to create ranges containing turkish characters [`f1f4c5b`](https://github.com/sbagdat/turkish_ranges/commit/f1f4c5b)
+- Capability to compare string containing turkish characters [`f1f4c5b`](https://github.com/sbagdat/turkish_ranges/commit/f1f4c5b)
+- Creating strings with TrText#new [`f1f4c5b`](https://github.com/sbagdat/turkish_ranges/CHANGELOG.md/commit/f1f4c5b)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    turkish_ranges (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  turkish_ranges!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sıtkı Bağdat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# TurkishRanges
+
+[![Gem Version](https://badge.fury.io/rb/turkish_ranges.svg)](https://badge.fury.io/rb/turkish_ranges)
+[![Build Status](https://travis-ci.org/sbagdat/turkish_ranges.svg?branch=main)](https://travis-ci.org/sbagdat/turkish_ranges)
+[![Code Climate](https://codeclimate.com/github/sbagdat/turkish_ranges/badges/gpa.svg)](https://codeclimate.com/github/sbagdat/turkish_ranges)
+
+
+Ranges and comparisons meet Turkish language. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'turkish_ranges'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install turkish_ranges
+
+## Usage
+
+```ruby
+require 'turkish_ranges'
+
+include TurkishRanges
+
+# Creating new texts
+TrText.new('Türkçe')
+
+# Comparing texts containing Turkish letters
+TrText.new('Ğ')      > TrText.new('Ü')       # false
+TrText.new('abbası') < TrText.new('abbasi')  # true
+
+# Creating ranges containing Turkish letters
+full_upcase_range = TrText.new('A')..TrText.new('Z')
+full_upcase_range.to_a  
+# => [A, B, C, Ç, D, E, F, G, Ğ, H, I, İ, J, K, L, M, 
+#     N, O, Ö, P, Q, R, S, Ş, T, U, Ü, V, W, X, Y, Z]
+
+full_downcase_range = TrText.new('A')..TrText.new('Z')
+full_downcase_range.to_a  
+# => [a, b, c, ç, d, e, f, g, ğ, h, ı, i, j, k, l, m,
+#     n, o, ö, p, q, r, s, ş, t, u, ü, v, w, x, y, z]
+
+(TrText.new('aa')..TrText.new('ax')).to_a
+# => [aa, ab, ac, aç, ad, ae, af, ag, ağ, ah, aı, ai, aj, ak, al, 
+#     am, an, ao, aö, ap, aq, ar, as, aş, at, au, aü, av, aw, ax]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sbagdat/turkish_ranges. 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/[USERNAME]/turkish_ranges/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 TurkishRanges project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/turkish_ranges/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'turkish_ranges'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/turkish_ranges.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'turkish_ranges/version'
+require 'turkish_ranges/tr_text'
+
+# Responsible for generating ranges include Turkish specific chars
+# like ş, ç, ğ, ...
+module TurkishRanges
+end
+

data/lib/turkish_ranges/tr_text.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module TurkishRanges
+  # Represents a character sequence in Turkish language
+  class TrText
+    include Comparable
+
+    # Sets the letters for the `TrText`.
+    # @return [String] character sequence
+    attr_reader :letters
+
+    private :letters
+
+    # Using for character mapping
+    MAP = 'DHJPTVdhiptvÈğıØşÝèĠIJøŠý'.chars.zip('ÇĞİÖŞÜçğıöşüDHJPTVdhiptv'.chars).to_h.freeze
+
+    # Using for calculating character codes
+    ASCII_ALPHABET = 'ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZabcçdefgğhıijklmnoöpqrsştuüvwxyz'
+                     .chars.map.with_index { [_1, _2 + 65] }.to_h.freeze
+
+    # A new instance of TrText
+    #
+    # @param [String] letters
+    # @return [TrText]
+    def initialize(letters)
+      @letters = letters
+    end
+
+    # Using for object comparison
+    #
+    # @param [TrText] other
+    # # @return [Integer] 1, 0 or -1
+    def <=>(other)
+      codepoints_sum <=> other.codepoints_sum
+    end
+
+    # Calculates codepoint of a single characacter based on ASCII_ALPHABET
+    #
+    # @return [Integer]
+    def code
+      ASCII_ALPHABET[letters] || letters&.ord.to_i
+    end
+
+    # Calculates the sum of codepoints in letters
+    #
+    # @return [Integer]
+    def codepoints_sum
+      letters.chars.map { TrText.new(_1) }.map(&:code).inject(:+)
+    end
+
+    # Calculates the successor string from `letters`
+    #
+    # @return [String]
+    def succ_letter
+      successor = letters.succ
+      change = successor.delete(letters)
+      successor.sub!(change, MAP[change]) if change.length == 1 && MAP.key?(change)
+      successor
+    end
+
+    # Next successor character sequence
+    #
+    # @return [TrText]
+    def succ
+      TrText.new(succ_letter)
+    end
+
+    # Overloading Object#to_s
+    #
+    # @return [String]
+    def to_s
+      letters
+    end
+
+    # Overloading Object#inspect
+    #
+    # @return [String]
+    def inspect
+      letters
+    end
+  end
+end
+
+(TurkishRanges::TrText.new("a")..TurkishRanges::TrText.new("z")).to_a

data/lib/turkish_ranges/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TurkishRanges
+  # Version of TurkishRanges
+  VERSION = '0.1.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'turkish_ranges'
+require 'turkish_ranges/tr_text'
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = '.rspec_status'
+  config.disable_monkey_patching!
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/tr_text_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include TurkishRanges
+  include TurkishRanges
+end
+
+RSpec.describe 'TrLetterSpec' do
+  context '#new' do
+    it 'creates new object' do
+      expect(TrText.new('Ü')).not_to be nil
+    end
+  end
+
+  context '#code' do
+    it 'returns correct extended ascii code' do
+      expect(TrText.new('A').code).to eq 65
+      expect(TrText.new('ş').code).to eq 120
+    end
+  end
+
+  context '#codepoints_sum' do
+    it 'returns total codepoints of letters' do
+      expect(TrText.new('ABCÇ').codepoints_sum).to eq 65 + 66 + 67 + 68
+    end
+  end
+
+  context 'when doing comparisons' do
+    it 'can compare two letters' do
+      expect(TrText.new('Ş') > TrText.new('Ğ')).to  be true
+      expect(TrText.new('ç') < TrText.new('d')).to  be true
+      expect(TrText.new('z') < TrText.new('ö')).to  be false
+      expect(TrText.new('ğ') < TrText.new('ü')).to  be true
+      expect(TrText.new('ş') < TrText.new('ü')).to  be true
+      expect(TrText.new('U') > TrText.new('ç')).to  be false
+      expect(TrText.new('H') > TrText.new('Ğ')).to  be true
+      expect(TrText.new('ç') != TrText.new('Ç')).to be true
+      expect(TrText.new('Ğ') == TrText.new('ğ'.upcase(:turkic))).to be true
+    end
+  end
+
+  context 'when creating ranges' do
+    it 'creates a full ranges of single character' do
+      a_to_z_lower_case = 'abcçdefgğhıijklmnoöpqrsştuüvwxyz'
+      a_to_z_upper_case = 'ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZ'
+      lower_case_range = TrText.new('a')..TrText.new('z')
+      upper_case_range = TrText.new('A')..TrText.new('Z')
+
+      expect(lower_case_range.to_a.join).to eq a_to_z_lower_case
+      expect(upper_case_range.to_a.join).to eq a_to_z_upper_case
+    end
+
+    it 'creates partial ranges of single character' do
+      c_to_s_lower_case = 'çdefgğhıijklmnoöpqrsş'
+      g_to_u_upper_case = 'ĞHIİJKLMNOÖPQRSŞTUÜ'
+      lower_case_range = TrText.new('ç')..TrText.new('ş')
+      upper_case_range = TrText.new('Ğ')..TrText.new('Ü')
+
+      expect(lower_case_range.to_a.join).to eq c_to_s_lower_case
+      expect(upper_case_range.to_a.join).to eq g_to_u_upper_case
+    end
+
+    it 'creates ranges of mutliple characters' do
+      z_to_ad_lower_case = 'zaaabacaçad'
+      z_to_ad_upper_case = 'ZAAABACAÇAD'
+      lower_case_range = TrText.new('z')..TrText.new('ad')
+      upper_case_range = TrText.new('Z')..TrText.new('AD')
+
+      expect(lower_case_range.to_a.join).to eq z_to_ad_lower_case
+      expect(upper_case_range.to_a.join).to eq z_to_ad_upper_case
+    end
+  end
+end

data/spec/turkish_ranges_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe TurkishRanges do
+  it 'has a version number' do
+    expect(TurkishRanges::VERSION).not_to be nil
+  end
+end

data/turkish_ranges.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.prepend(lib) unless $LOAD_PATH.include?(lib)
+require 'turkish_ranges/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'turkish_ranges'
+  spec.version       = TurkishRanges::VERSION
+  spec.authors       = ['Sıtkı Bağdat']
+  spec.email         = ['sbagdat@gmail.com']
+
+  spec.summary       = 'Ranges and string comparisons meet Turkish language'
+  spec.description   = 'Ranges and string comparisons meet Turkish language. You can use ' \
+                       'it anywhere in your code, Range, Regexp, etc..'
+  spec.homepage      = 'https://github.com/sbagdat/turkish_ranges'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  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.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.require_paths = ['lib']
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turkish_ranges
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sıtkı Bağdat
@@ -14,10 +14,32 @@ description: Ranges and string comparisons meet Turkish language. You can use it
   in your code, Range, Regexp, etc..
 email:
 - sbagdat@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/turkish_ranges.rb
+- lib/turkish_ranges/tr_text.rb
+- lib/turkish_ranges/version.rb
+- spec/spec_helper.rb
+- spec/tr_text_spec.rb
+- spec/turkish_ranges_spec.rb
+- turkish_ranges.gemspec
 homepage: https://github.com/sbagdat/turkish_ranges
 licenses:
 - MIT
@@ -25,7 +47,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/sbagdat/turkish_ranges
   source_code_uri: https://github.com/sbagdat/turkish_ranges
-  changelog_uri: https://github.com/sbagdat/turkish_ranges/CHANGELOG.md
+  changelog_uri: https://github.com/sbagdat/turkish_ranges/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -45,4 +67,7 @@ rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ranges and string comparisons meet Turkish language
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/tr_text_spec.rb
+- spec/turkish_ranges_spec.rb