byk 0.4.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2fb4e839b91bf3348e5c59e0e52b97bbbaec43de
-  data.tar.gz: 1a5d496e1fe684cba330eed517c3b8de5ad573a0
+SHA256:
+  metadata.gz: 5cb843eb31c5c618dc10608759b5668bd8db46eb38911381bacd693f9b4635bf
+  data.tar.gz: '0085a83cbf114273d5fc9b64cca6d8d4c19542a36614eb8d89c80eb0b036176f'
 SHA512:
-  metadata.gz: 9fc2e29e20dad1e0c517afd3c35d60340f256ce44bcda71a9e2fb344be4b685c2fa3b85350dd347e890143c6f9a84a94896eec9df0bfb8ec9b7be8811907053f
-  data.tar.gz: c81f02b4075cdc5b82b3f17f47fb4ea74dbcfa29bbe466731c685ec5a7b3d1c54b329075eb8c2d1731b76f03b9bf9b24646ea3aeff88f8ab17577297d0bae960
+  metadata.gz: 4fc4c750b29da3cf64b5d0cea0275f41e7f5cae4192a223e0d1f344505e8ab6c045b1b772f29d954ca4310062b9ff7ac1b07d1d6dc17a5c6d8969f03f7f94340
+  data.tar.gz: f8909c3816411619ca8a2239b07d0bc9aa48663ac5395f4a8d6fd6735d5c8f252ff98977dcba970b5a3c21eae9bf55f63fd40e75ad0918f4f670a5e2b24ca239

data/CHANGELOG.md

@@ -1,9 +1,29 @@
 # Changelog
 
+### Byk 1.1.0 (2022-02-02)
+
+* Removed string tainting, it is deprecated and planned for removal
+* Upgraded development dependencies and required Ruby version
+
+### Byk 1.0.0 (2016-04-09)
+
+* Introduced `#to_cyrillic` and `#to_cyrillic!`
+* Introduced console utility
+
+### Byk 0.6.0 (2015-04-25)
+
+* Introduced module methods and the optional safe require
+* Documented the methods
+* Upgraded spec suite
+
+### Byk 0.5.0 (2015-04-18)
+
+* Performance tuning and refactoring, up to 5x speedup
+* Dropped the unused optional arg
+
 ### Byk 0.4.0 (2015-04-17)
 
-* Performance tuning and refactoring, ~10% speedup
-* Updated benchmark
+* Performance tuning and refactoring
 * Introduced changelog
 
 ### Byk 0.3.0 (2015-04-16)

data/README.md

@@ -2,100 +2,151 @@ Byk
 ===
 
 [![Gem Version](https://badge.fury.io/rb/byk.svg)](https://rubygems.org/gems/byk)
-[![Build Status](https://travis-ci.org/topalovic/byk.svg?branch=master)](https://travis-ci.org/topalovic/byk)
+[![tests](https://github.com/topalovic/byk/actions/workflows/tests.yml/badge.svg)](https://github.com/topalovic/byk/actions/workflows/tests.yml)
 
-Ruby gem for fast transliteration of Serbian Cyrillic into Latin
-<br />
-<sub>Inspired by @dejan's
-[nice little gem](https://github.com/dejan/srbovanje),
-this one comes with a C-optimized twist</sub>
+Руби пакет за брзо пресловљавање ћирилице у латиницу и обратно
 
 ![byk](https://cloud.githubusercontent.com/assets/626128/7155207/07545960-e35d-11e4-804e-5fdee70a3e30.png)
 
+[[English, please!](README.en.md)]
 
-## Installation
+## Инсталација
 
-Add this line to your application's Gemfile:
+Byk се може користити као самостални конзолни алат или као `String` додатак у Руби програмима. Не зависи ни од каквих пакета поред програмског језика Руби и стандардних алата за компајлирање <sup>1</sup>.
+
+Можеш га инсталирати директно:
+
+```ruby
+$ gem install byk
+```
+
+или додати у `Gemfile` своје апликације:
 
 ```ruby
 gem "byk"
 ```
 
-And then execute:
+<sub><sup>1</sup> За Windows, види [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit)</sub>
+
+
+## Употреба
+
+### Као самостални алат
+
+Ево прегледа могућности конзолног алата:
 
 ```
-$ bundle
+$ byk --help
+usage: byk [options] [files]
+
+options:
+  -c, --cyrillic       convert input to Cyrillic (default)
+  -l, --latin          convert input to Latin
+  -a, --ascii          convert input to "ASCII Latin"
+  -v, --version        show version
 ```
 
-Or install it yourself as:
+За превод "у лету", проследи текст команди:
 
+```sh
+$ byk -a <<< "Вук Стефановић Караџић"
+Vuk Stefanovic Karadzic
 ```
-$ gem install byk
+
+Алтернативно, позови команду, унеси текст за превод и обележи крај уноса помоћу <kbd>Ctrl</kbd> <kbd>D</kbd>:
+
+```sh
+$ byk
+a u ruke Mandušića Vuka
+biće svaka puška ubojita!
+^D
+а у руке Мандушића Вука
+биће свака пушка убојита!
+```
+
+Превод се шаље на стандардни излаз, те га можеш преусмерити по потреби. На пример, за превод текстуалне датотеке на ћирилицу и чување превода:
+
+```sh
+$ byk lat.txt > cir.txt
 ```
 
 
-## Usage
+### Као `String` додатак
 
-First, make sure to require the gem in your initializer:
+У случају да не користиш Bundler, увези пакет "ручно":
 
 ```ruby
 require "byk"
 ```
 
-This will extend `String` with a couple of simple methods:
+што ће проширити `String` новим методама:
 
 ```ruby
-"Шеширџија".to_latin         # => "Šeširdžija"
-"Шеширџија".to_ascii_latin   # => "Sesirdzija"
-"Šeširdžija".to_ascii_latin  # => "Sesirdzija"
+"Šeširdžija".to_cyrillic   #=> "Шеширџија"
+"Шеширџија".to_latin       #=> "Šeširdžija"
+"Шеширџија".to_ascii_latin #=> "Sesirdzija"
 ```
 
-There's also a destructive variant of each:
+и њиховим деструктивним верзијама:
 
 ```ruby
-text = "Жвазбука"
-text.to_latin!        # => "Žvazbuka"
-text                  # => "Žvazbuka"
-text.to_ascii_latin!  # => "Zvazbuka"
-text                  # => "Zvazbuka"
+text = "Šeširdžija"
+text.to_ascii_latin! #=> "Sesirdzija"
+text                 #=> "Sesirdzija"
 ```
 
-Note that these methods take into account the
-[two-letter capitalization rules](http://sr.wikipedia.org/wiki/Gajica#Abeceda):
+#### "Безбедан" увоз
+
+У случају да не желиш да проширујеш `String`, можеш извршити "безбедан" увоз:
+
+```ruby
+# унутар Gemfile-а:
+gem "byk", require: "byk/safe"
+
+# иначе:
+require "byk/safe"
+```
+
+па се ослонити на методе модула:
 
 ```ruby
-"ЉИЉА Љиљановић".to_latin        # => "LJILJA Ljiljanović"
-"ĐORĐE Đorđević".to_ascii_latin  # => "DJORDJE Djordjevic"
+Byk.to_latin("Жвазбука") #=> "Žvazbuka"
 ```
 
 
-## How fast is fast?
+## Напомене
 
-About [7-8x faster](benchmark) than the baseline Ruby implementation on
-my hardware. YMMV of course.
+Ретки случајеви диграфа које треба сачувати код превођења у ћирилицу нису узети у разматрање: _Танјуг_, _надживети_ и слично.
 
+С друге стране, методе за латинизацију исправно преводе [велике диграфе](http://sr.wikipedia.org/wiki/Гајица#.D0.94.D0.B8.D0.B3.D1.80.D0.B0.D1.84.D0.B8):
 
-## Raison d'être
+```ruby
+"ЉИЉА Љ. Љиљановић".to_latin       #=> "LJILJA Lj. Ljiljanović"
+"ĐORĐE Đ. Đorđević".to_ascii_latin #=> "DJORDJE Dj. Djordjevic"
+```
 
-This kind of speed-up might be worthwhile for massive localization
-projects, e.g. sites supporting dual script content. Remember,
-`Benchmark` is your friend.
 
-I found transliteration to be a straightforward little problem that
-lends itself well to optimization. It also gave me an excuse to play
-with Ruby extensions, so there :smile_cat:
+## Колико брзо је "брзо" пресловљавање?
+
+Byk је [10-30x бржи](benchmark) од [наивне Руби имплементације](https://github.com/dejan/srbovanje), у зависности од састава улаза и смера превођења.
+
+
+## Тестирање
+
+Клонирај пројекат и покрени тестове:
+
+```
+$ bundle && bundle exec rake
+```
 
 
-## Compatibility
+## Компатибилност
 
-Byk is supported under MRI Ruby >= 1.9.2. I don't plan to support
-1.8.7 or older due to substantial C API changes between 1.8 and
-1.9. It doesn't build under Rubinius currently, but I intend to
-support it in future releases.
+Byk је подржан само на стандардном Рубију (MRI).
 
 
-## License
+## Лиценца
 
-This gem is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+Овај пакет је објављен под [МИТ лиценцом](LICENSE).
 
 Уздравље!

data/exe/byk

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "byk/safe"
+require "optparse"
+
+trap "SIGINT" do
+  exit 130
+end
+
+method_name = :to_cyrillic
+
+opts = OptionParser.new do |opt|
+  opt.banner = "usage: byk [options] [files]"
+  opt.summary_width = 20
+
+  opt.separator ""
+  opt.separator "options:"
+
+  opt.on("-c", "--cyrillic", "convert input to Cyrillic (default)") do
+    method_name = :to_cyrillic
+  end
+
+  opt.on("-l", "--latin", "convert input to Latin") do
+    method_name = :to_latin
+  end
+
+  opt.on("-a", "--ascii", 'convert input to "ASCII Latin"') do
+    method_name = :to_ascii_latin
+  end
+
+  opt.on_tail("-v", "--version", "show version") do
+    puts Byk::VERSION
+    exit
+  end
+end
+
+begin
+  opts.parse!
+rescue OptionParser::InvalidOption => e
+  puts e
+  puts
+  puts opts
+  exit 1
+end
+
+begin
+  puts Byk.send(method_name, ARGF.read)
+rescue => e
+  puts e
+  exit 1
+end