ukrainian_sort 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf4a1519b5061ffa3b00fcc5a025233fc4a471f765bfd5ecde0171aca0615959
+  data.tar.gz: 01cbaf85442b91e9ed76303041af78e3367e517f5c714fe0e327cf2a56f3d34f
+SHA512:
+  metadata.gz: a8b4fa753ebf07c7062cc5b60238b7aee0d4bdbe23827f4f3d21ad11fd478f23d10f19bfc064b34142d4fdf6ef3cc4330146788c594c0275af93126605539f39
+  data.tar.gz: 65071371b1d97351e846ecc59dddc0a4bffe8c5c9c267e867592307578dae67c169917b7f3e7e4e408e78c25f49926cfc533d1d4be0e1f74d04f548ccb103ab9

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/) and [Keep a Changelog](https://keepachangelog.com/).
+
+---
+
+## [0.1.0] - 2025-07-18
+
+### Added
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 mykbren
+
+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,78 @@
+# Ukrainian Sort Gem
+
+## Мотивація
+Сортування українського тексту не працює у Ruby через стандартний механізм сортування, який базується на Unicode-кодах. Результат не відповідає порядку українського алфавіту.
+
+Ця бібліотека забезпечує правильне сортування відповідно до українського алфавіту, вирішуючи проблеми, як-от розташування 'ґ' та 'є'.
+
+## Motivation
+Sorting Ukrainian text correctly is a challenge with Ruby's default sorting mechanism. By default, Ruby sorts strings based on Unicode code points, which does not align with the Ukrainian alphabet.
+
+This gem ensures proper sorting according to the Ukrainian alphabet, addressing discrepancies like the placement of 'ґ' and 'є'.
+
+### Приклад / Example
+- Стандартне сортування Ruby / Default sort in Ruby:
+```
+["г", "е", "и", "й", "є", "і", "ї", "ґ"]
+```
+- ukrainian_sort gem:
+```
+["г", "ґ", "е", "є", "и", "і", "ї", "й"]
+```
+
+### Unicode значення / Unicode values
+- г -> 1075
+- ґ -> 1169
+- е -> 1077
+- є -> 1108
+- и -> 1080
+- і -> 1110
+- й -> 1081
+- ї -> 1111
+
+### Сортування за Unicode-кодами (стандартне для Ruby) / Sort by Unicode (default in Ruby)
+```
+["г", "е", "и", "й", "є", "і", "ї", "ґ"]
+```
+### ukrainian_sort gem:
+```
+["г", "ґ", "е", "є", "и", "і", "ї", "й"]
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ukrainian_sort'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install ukrainian_sort
+```
+
+## Usage
+To sort an array of Ukrainian strings:
+
+```ruby
+require 'ukrainian_sort'
+
+words = ["яблуко", "ґава", "виноград", "єдинорог"]
+sorted_words = UkrainianSort.sort(words)
+puts sorted_words
+```
+
+## Testing
+Run the test suite to ensure everything is working correctly:
+
+```bash
+$ rspec
+```

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ukrainian_sort'
+
+# 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.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ukrainian_sort/sorter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module UkrainianSort
+  class Sorter
+    # Ukrainian alphabet in correct order - each letter position with lowercase first
+    UKRAINIAN_ALPHABET = %w[
+      а б в г ґ д е є ж з и і
+      ї й к л м н о п р с т у
+      ф х ц ч ш щ ь ю я
+    ].freeze
+
+    # Create a mapping from each lowercase Ukrainian character to its position
+    CHAR_ORDER = UKRAINIAN_ALPHABET.each_with_index.to_h.freeze
+
+    def initialize
+      @char_order = CHAR_ORDER
+    end
+
+    # Sort an array of strings using Ukrainian alphabet order
+    def sort(array)
+      array.sort { |a, b| compare(a, b) }
+    end
+
+    # Sort an array of strings in descending order
+    def sort_desc(array)
+      array.sort { |a, b| compare(b, a) }
+    end
+
+    # Compare two strings according to Ukrainian alphabet order
+    def compare(str1, str2)
+      return 0 if str1 == str2
+
+      chars1 = normalize(str1)
+      chars2 = normalize(str2)
+
+      [chars1.length, chars2.length].min.times do |i|
+        order1 = char_order_position(chars1[i])
+        order2 = char_order_position(chars2[i])
+        return order1 <=> order2 if order1 != order2
+      end
+
+      # If all compared characters equal, shorter wins
+      chars1.length <=> chars2.length
+    end
+
+    private
+
+    def normalize(str)
+      str.downcase.chars.grep(/\p{L}/) # keep all letters
+    end
+
+    def char_order_position(char)
+      if @char_order.key?(char)
+        @char_order[char]
+      else
+        1000 + char.ord # sort non-Ukrainian letters after Ukrainian ones
+      end
+    end
+  end
+end

data/lib/ukrainian_sort/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UkrainianSort
+  VERSION = '0.1.0'
+end

data/lib/ukrainian_sort.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module UkrainianSort
+  class Error < StandardError; end
+end
+
+require_relative 'ukrainian_sort/version'
+require_relative 'ukrainian_sort/sorter'
+
+module UkrainianSort
+  # Convenience method for sorting arrays of strings
+  def self.sort(array)
+    Sorter.new.sort(array)
+  end
+
+  # Convenience method for sorting arrays of strings in descending order
+  def self.sort_desc(array)
+    Sorter.new.sort_desc(array)
+  end
+
+  # Convenience method for comparing two strings
+  def self.compare(str1, str2)
+    Sorter.new.compare(str1, str2)
+  end
+end

data/ukrainian_sort.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ukrainian_sort/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ukrainian_sort'
+  spec.version       = UkrainianSort::VERSION
+  spec.authors       = ['mykbren']
+  spec.email         = ['myk.bren@gmail.com']
+
+  spec.summary       = 'Provides sorting functionality for Ukrainian language strings.'
+  spec.description = <<~DESC.strip
+    A Ruby gem that implements sorting algorithms specifically designed for Ukrainian language strings,
+    ensuring proper handling of unique characters and collation rules.
+  DESC
+  spec.homepage      = 'https://github.com/mykbren/ukrainian_sort'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+  spec.metadata['homepage_uri']     = spec.homepage
+  spec.metadata['source_code_uri']  = spec.homepage
+  spec.metadata['changelog_uri']    = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  # Includes all files tracked by git
+  spec.files = Dir.glob('lib/**/*') + Dir.glob('bin/*') + ['README.md', 'CHANGELOG.md', 'LICENSE.txt',
+                                                           'ukrainian_sort.gemspec']
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['console', 'setup']
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ukrainian_sort
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mykbren
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-18 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  A Ruby gem that implements sorting algorithms specifically designed for Ukrainian language strings,
+  ensuring proper handling of unique characters and collation rules.
+email:
+- myk.bren@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/ukrainian_sort.rb
+- lib/ukrainian_sort/sorter.rb
+- lib/ukrainian_sort/version.rb
+- ukrainian_sort.gemspec
+homepage: https://github.com/mykbren/ukrainian_sort
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mykbren/ukrainian_sort
+  source_code_uri: https://github.com/mykbren/ukrainian_sort
+  changelog_uri: https://github.com/mykbren/ukrainian_sort/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: Provides sorting functionality for Ukrainian language strings.
+test_files: []