tinycus 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff64b058ca64944f6b13a0fad6ed92d49b08da8611ca454ae37100a3d94a753f
-  data.tar.gz: 10c0ef5a67e9324f32c41668a8eb3104e6508c4bbf0bbef2471c5c1f6631fffe
+  metadata.gz: 321cf855e7c31e2a3d7cae41f0554543dbe27eb2c1d2a59cc2070c6c77645a73
+  data.tar.gz: cb663b8bbf7617886c4866b92ad9a76c6ef676bf885da265ce305a37dd1da20a
 SHA512:
-  metadata.gz: a9348bc09c79487faf8406077e6ec981ef9bd94a709c49f5383ec8ad591235cd1dd9bdc370143d58eee2bb9b76bcf55dec1dc188e0340772fe59961235e58158
-  data.tar.gz: 6a09f32fd84c9fd866ab13871722efd4cd02814e614c9022b3f0296ea5821e2493fd955b317afc1af8f2c93a2741eac707cf79f6699ffab212008db9aebda506
+  metadata.gz: '028fb9942a10556132e68af6f12aef6799e8aa531ae88150a045161f541ec800b37b48f82a4501f4d9aefd7dd6fd5b5022633ec03e02c70d92083cdac84ed677'
+  data.tar.gz: f964fb644a236ba1cc54236688fb72a211a0fbfa9d5aae127d8352f1040df24eaeed587cf19ebb281fdc4daf6d13c6af208db85bafc25bf28cdeae938ae3cc7d

data/LICENSE

@@ -0,0 +1 @@
+GPL v3, (c) 2023 Benjamin Crowell

data/README.md

@@ -0,0 +1,90 @@
+Tinycus
+=======
+
+This is a ruby library to do some string functions efficiently that
+would otherwise be slow or require a huge footprint. For example,
+it can remove accents from strings, or alphabetize strings in polytonic
+Greek. 
+
+The current implementation is about 2-3 times faster for these tasks
+than what I initially came up with naively. The footprint is about 1000
+times smaller than that of the ICU library (30 Mb), which also doesn't
+have bindings for ruby.  The name Tinycus is meant to evoke "tiny
+ICU."  Tinycus supports polytonic Greek, which GNU libc doesn't.
+
+If you're using Tinycus and have comments or suggestions, please
+[contact me](http://lightandmatter.com/area4author.html).
+
+Installation
+--------
+
+### On linux, using make
+
+    sudo make install
+    make test
+
+### Using rubygems
+
+    gem install tinycus
+
+Use
+---
+
+Examples:
+
+    require './tinycus.rb';
+    puts Tinycus::Tr.remove_accents_from_euro('ἄγε, vámonos',n:true)
+    --> αγε, vamonos
+    puts Tinycus.sort_greek("Μῆνιν ἄειδε, θεά, Πηληϊάδεω Ἀχιλῆος οὐλομένην".split(/\s+/)).join(' ')
+    --> ἄειδε, Ἀχιλῆος θεά, Μῆνιν οὐλομένην Πηληϊάδεω
+
+All input strings are expected to be utf-8 normalized to NFC form, and
+all returned values are also in this encoding. Many functions have an
+optional argument n which defaults to false. If you set n:true, as in
+the first example above, then your inputs will be normalized to NFC
+for you. This is safer but slower. Since the whole point of the
+library is speed, the library is set up to make it convenient for you
+if you simply massage all strings into the required form at the time
+when they're created or read in, then do all your manipulations. If
+your inputs to Tinycus are not NFC normalized, and you don't do
+n:true, then the results will be incorrect. If your inputs are in some
+other encoding such as ISO-8859-1, then the library may either give
+incorrect results or raise an exception.
+
+When there is an error in a constructor, the object that is created has
+a .err property that is an error message. If there is no error, then
+the .err is set to nil.
+
+Real-world sources of polytonic Greek text are usually incredibly messy,
+containing all kinds of weird crap that someone typed on a keyboard
+and looks OK by eye, but is actually wrong and not suitable for
+machine processing. This type of stuff is legal unicode, but it's
+the wrong way of representing the word. For instance, I've seen the vowel
+that's supposed to look like ά might be written with two accents on the same
+character: both an accented alpha unicode
+character and, superimposed on that, a combining accent. It looks OK on the screen
+because the two marks are on top of each other. I've collected a large number of these
+awfulnesses in the wild. The function Cleanup.clean_up_grotty_greek()
+is meant to correct them all. It's slow. It has a bunch of options.
+There are also various more fine-tuned or specialized functions, such as
+Cleanup.standardize_greek_punctuation().
+
+Beta code conversion
+--------------------
+Beta code is an obsolete way of encoding Greek characters: https://en.wikipedia.org/wiki/Beta_Code .
+Tinycus can handle conversion of a subset of beta code using the functions Tinycus.greek_unicode_to_beta_code
+and Tinycus.greek_beta_code_to_unicode. There are other libraries that can do this, such as the
+ruby library https://github.com/perseids-tools/beta-code-rb as well as standalone
+software such as the debian package unibetacode. I only rolled my own implementation because
+it seemed pretty easy to do, and I wanted to be sure that it would generate utf-8 encoded
+according to modern standards and in a way that would be compatible with the rest of Tinycus.
+
+There is also a function Cleanup.clean_up_greek_beta_code that is meant to clean up stray
+beta code in documents that were supposed to have been converted to unicode but still have
+some beta code lingering in them.
+
+Performance
+-----
+
+See comments at the top of scripts/benchmark.rb for some notes on algorithms
+I tried and their performance.

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: tinycus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Benjamin Crowell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-14 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies: []
-description: String manipulation for languages including polytonic Greek. High performance,
-  small footprint, pure ruby. Typical uses would be removing accents from ancient
-  Greek words, or alphabetizing words in ancient Greek.
+description: "This is a ruby library to do some string functions efficiently that\nwould
+  otherwise be slow or require a huge footprint. For example,\nit can remove accents
+  from strings, or alphabetize strings in polytonic Greek. \n"
 email: 
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- LICENSE
+- README.md
 - tinycus.rb
 homepage: https://bitbucket.org/ben-crowell/tinycus
 licenses:
 - GPL-3.0-only
 metadata:
   contact_uri: http://lightandmatter.com/area4author.html
+  documentation_uri: https://bitbucket.org/ben-crowell/tinycus
+  homepage_uri: https://bitbucket.org/ben-crowell/tinycus
+  source_code_uri: https://bitbucket.org/ben-crowell/tinycus
 post_install_message: 
 rdoc_options: []
 require_paths: