babosa 0.3.11 → 2.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ee04fad8c458a32dea08b5f6483d817d359dab4
-  data.tar.gz: 22385c9ae0e279fc6531a6ad6e9851ec3d4f4e81
+SHA256:
+  metadata.gz: ef1346a05f1b3a1104af8a095b7829eaa853427927335c7905d41d5ab47b2e9c
+  data.tar.gz: 54e543a250c7eff0c9613bea3f22d2e79317707f60cbb364e6e68979237c4c53
 SHA512:
-  metadata.gz: ad5f5a7e2bbfd63ab2e0a89878b54dc52a96f6929f68dbb94070d86e7b0515d7f3fb0e6e30d4e3152320a07fe7684833f23135569e7200e4aad0f9930bb3b261
-  data.tar.gz: 95e010b9b9c5138af14454258f332a0e32e735354ad49a65ed4f22514110e159909e4a4e714a06443a02f4d9f64edfe00ac2cf48f10036488beb2f4a4abde977
+  metadata.gz: d4f6732579088cda9d4514b4d1dddd32f2cd933f2818ed4c74bf0f00168ccc3b20e6ce220bc1c473a0453d29ef50de256689ed17e1f809b42dcb8956377c0e76
+  data.tar.gz: 797887db1d626a92b28249883f2dcc55e3b92d9f423aa23052ba74cc45856a15ace2b6c823c983b6e6baa0907cfc3d467b9a52e05cd9de9d9fcf37c779bd0647

data/Changelog.md

@@ -1,19 +1,119 @@
 # Babosa Changelog
 
-* 0.3.11 - Added support for Vietnamese
-* 0.3.10 - Fixed Macedonian "S/S". Don't `include JRuby` unnecessarily.
-* 0.3.9 - Added missing Greek vowels with diaeresis.
-* 0.3.8 - Correct and improve Macedonian support.
-* 0.3.7 - Fix compatibility with Ruby 1.8.7. Add Swedish support.
-* 0.3.6 - Allow multiple transliterators. Add Greek support.
-* 0.3.5 - Don't strip underscores from identifiers.
-* 0.3.4 - Add Romanian support.
-* 0.3.3 - Add Norwegian support.
-* 0.3.2 - Improve Macedonian support.
-* 0.3.1 - Small fixes to Cyrillic.
-* 0.3.0 - Cyrillic support. Improve support for various Unicode spaces and dashes.
-* 0.2.2 - Fix for "smart" quote handling.
-* 0.2.1 - Implement #empty? for compatiblity with Active Support's #blank?.
-* 0.2.0 - Added support for Danish. Added method to generate Ruby identifiers. Improved performance.
-* 0.1.1 - Added support for Serbian.
-* 0.1.0 - Initial extraction from FriendlyId.
+## 2.0.0
+
+This release contains no important changes. I had a week off from work and
+decided to refactor the code.  However there are some small breaking changes so
+I have released it as 2.0.0.
+
+* Refactor internals for simplicity
+* Use built-in Ruby UTF-8 support in places of other gems.
+* Drop support for Ruby < 2.5.0.
+* `Babosa::Identifier#word_chars` no longer removes dashes
+* `Babosa::Identifier#to_ruby_method` default argument `allow_bangs` is now a keyword argument
+
+## 1.0.4
+
+* Fix nil being cast to frozen string (https://github.com/norman/babosa/pull/52)
+
+## 1.0.3
+
+* Fix Active Support 6 deprecations (https://github.com/norman/babosa/pull/50)
+
+## 1.0.2
+
+* Fix regression in ActiveSupport UTF8 proxy.
+
+## 1.0.1
+
+* Fix error with tidy_bytes on Rubinius.
+* Simplify Active Support UTF8 proxy.
+* Fix `allow_bangs` argument to to_ruby_method being silently ignored.
+* Raise error when generating an impossible Ruby method name.
+
+## 1.0.0
+
+* Adopt semantic versioning.
+* When using Active Support, require 3.2 or greater.
+* Require Ruby 2.0 or greater.
+* Fix Ruby warnings.
+* Improve support for Ukrainian.
+* Support some additional punctuation characters used by Chinese and others.
+* Add Polish spec.
+* Use native Unicode normalization on Ruby 2.2 in UTF8::DumbProxy.
+* Invoke Ruby-native upcase/downcase in UTF8::DumbProxy.
+* Proxy `tidy_bytes` method to Active Support when possible.
+* Remove SlugString constant.
+
+## 0.3.11
+
+*  Add support for Vietnamese.
+
+## 0.3.10
+
+*  Fix Macedonian "S/S". Don't `include JRuby` unnecessarily.
+
+## 0.3.9
+
+* Add missing Greek vowels with diaeresis.
+
+## 0.3.8
+
+* Correct and improve Macedonian support.
+
+## 0.3.7
+
+* Fix compatibility with Ruby 1.8.7.
+* Add Swedish support.
+
+## 0.3.6
+
+* Allow multiple transliterators.
+* Add Greek support.
+
+## 0.3.5
+
+* Don't strip underscores from identifiers.
+
+## 0.3.4
+
+* Add Romanian support.
+
+## 0.3.3
+
+* Add Norwegian support.
+
+## 0.3.2
+
+* Improve Macedonian support.
+
+## 0.3.1
+
+* Small fixes to Cyrillic.
+
+## 0.3.0
+
+* Cyrillic support.
+* Improve support for various Unicode spaces and dashes.
+
+## 0.2.2
+
+* Fix for "smart" quote handling.
+
+## 0.2.1
+
+* Implement #empty? for compatiblity with Active Support's #blank?.
+
+## 0.2.0
+
+* Add support for Danish.
+* Add method to generate Ruby identifiers.
+* Improve performance.
+
+## 0.1.1
+
+* Add support for Serbian.
+
+## 0.1.0
+
+* Initial extraction from FriendlyId.

data/README.md

@@ -15,12 +15,16 @@ FriendlyId.
 
 ### Transliterate UTF-8 characters to ASCII
 
-    "Gölcük, Turkey".to_slug.transliterate.to_s #=> "Golcuk, Turkey"
+```ruby
+"Gölcük, Turkey".to_slug.transliterate.to_s #=> "Golcuk, Turkey"
+```
 
 ### Locale sensitive transliteration, with support for many languages
 
-    "Jürgen Müller".to_slug.transliterate.to_s           #=> "Jurgen Muller"
-    "Jürgen Müller".to_slug.transliterate(:german).to_s  #=> "Juergen Mueller"
+```ruby
+"Jürgen Müller".to_slug.transliterate.to_s           #=> "Jurgen Muller"
+"Jürgen Müller".to_slug.transliterate(:german).to_s  #=> "Juergen Mueller"
+```
 
 Currently supported languages include:
 
@@ -28,6 +32,7 @@ Currently supported languages include:
 * Danish
 * German
 * Greek
+* Hindi
 * Macedonian
 * Norwegian
 * Romanian
@@ -35,124 +40,125 @@ Currently supported languages include:
 * Serbian
 * Spanish
 * Swedish
+* Turkish
 * Ukrainian
+* Vietnamese
+
+Additionally there are generic transliterators for transliterating from the
+Cyrillic alphabet and Latin alphabet with diacritics. The Latin transliterator
+can be used, for example, with Czech. There is also a transliterator named
+"Hindi" which may be sufficient for other Indic languages using Devanagari, but
+I do not know enough to say whether the transliterations would make sense.
 
 I'll gladly accept contributions from fluent speakers to support more languages.
 
 ### Strip non-ASCII characters
 
-    "Gölcük, Turkey".to_slug.to_ascii.to_s #=> "Glck, Turkey"
+```ruby
+"Gölcük, Turkey".to_slug.to_ascii.to_s #=> "Glck, Turkey"
+```
 
 ### Truncate by characters
 
-    "üüü".to_slug.truncate(2).to_s #=> "üü"
+```ruby
+"üüü".to_slug.truncate(2).to_s #=> "üü"
+```
 
 ### Truncate by bytes
 
 This can be useful to ensure the generated slug will fit in a database column
 whose length is limited by bytes rather than UTF-8 characters.
 
-    "üüü".to_slug.truncate_bytes(2).to_s #=> "ü"
+```ruby
+"üüü".to_slug.truncate_bytes(2).to_s #=> "ü"
+```
 
 ### Remove punctuation chars
 
-    "this is, um, **really** cool, huh?".to_slug.word_chars.to_s #=> "this is um really cool huh"
+```ruby
+"this is, um, **really** cool, huh?".to_slug.word_chars.to_s #=> "this is um really cool huh"
+```
 
 ### All-in-one
 
-    "Gölcük, Turkey".to_slug.normalize.to_s #=> "golcuk-turkey"
+```ruby
+"Gölcük, Turkey".to_slug.normalize.to_s #=> "golcuk-turkey"
+```
 
 ### Other stuff
 
-#### Using Babosa With FriendlyId 4
-
-    require "babosa"
+#### Using Babosa With FriendlyId 4+
 
-    class Person < ActiveRecord::Base
-      friendly_id :name, use: :slugged
-
-      def normalize_friendly_id(input)
-        input.to_s.to_slug.normalize(transliterations: :russian).to_s
-      end
-    end
+```ruby
+require "babosa"
 
-#### Pedantic UTF-8 support
+class Person < ActiveRecord::Base
+  friendly_id :name, use: :slugged
 
-Babosa goes out of its way to handle [nasty Unicode issues you might never think
-you would have](https://github.com/norman/enc/blob/master/equivalence.rb) by
-checking, sanitizing and normalizing your string input.
+  def normalize_friendly_id(input)
+    input.to_s.to_slug.normalize(transliterations: :russian).to_s
+  end
+end
+```
 
-It will automatically use whatever Unicode library you have loaded before
-Babosa, or fall back to a simple built-in library. Supported
-Unicode libraries include:
+#### UTF-8 support
 
-* Java (only on JRuby of course)
-* Active Support
-* [Unicode](https://github.com/blackwinter/unicode)
-* Built-in
-
-This built-in module is much faster than Active Support but much slower than
-Java or Unicode. It can only do **very** naive Unicode composition to ensure
-that, for example, "é" will always be composed to a single codepoint rather than
-an "e" and a "´" - making it safe to use as a hash key.
-
-But seriously - save yourself the headache and install a real Unicode library.
-If you are using Babosa with a language that uses the Cyrillic alphabet, Babosa
-requires either Unicode, Active Support or Java.
+Babosa normalizes all input strings [to NFC](https://en.wikipedia.org/wiki/Unicode_equivalence#Normal_forms).
 
 #### Ruby Method Names
 
-Babosa can also generate strings for Ruby method names. (Yes, Ruby 1.9 can use
+Babosa can generate strings for Ruby method names. (Yes, Ruby 1.9+ can use
 UTF-8 chars in method names, but you may not want to):
 
 
-    "this is a method".to_slug.to_ruby_method! #=> this_is_a_method
-    "über cool stuff!".to_slug.to_ruby_method! #=> uber_cool_stuff!
+```ruby
+"this is a method".to_slug.to_ruby_method! #=> this_is_a_method
+"über cool stuff!".to_slug.to_ruby_method! #=> uber_cool_stuff!
 
-    # You can also disallow trailing punctuation chars
-    "über cool stuff!".to_slug.to_ruby_method(false) #=> uber_cool_stuff
+# You can also disallow trailing punctuation chars
+"über cool stuff!".to_slug.to_ruby_method(allow_bangs: false) #=> uber_cool_stuff
+```
 
 #### Easy to Extend
 
 You can add custom transliterators for your language with very little code. For
 example here's the transliterator for German:
 
-    # encoding: utf-8
-    module Babosa
-      module Transliterator
-        class German < Latin
-          APPROXIMATIONS = {
-            "ä" => "ae",
-            "ö" => "oe",
-            "ü" => "ue",
-            "Ä" => "Ae",
-            "Ö" => "Oe",
-            "Ü" => "Ue"
-          }
-        end
-      end
+```ruby
+module Babosa
+  module Transliterator
+    class German < Latin
+      APPROXIMATIONS = {
+        "ä" => "ae",
+        "ö" => "oe",
+        "ü" => "ue",
+        "Ä" => "Ae",
+        "Ö" => "Oe",
+        "Ü" => "Ue"
+      }
     end
+  end
+end
+```
 
 And a spec (you can use this as a template):
 
-    # encoding: utf-8
-    require File.expand_path("../../spec_helper", __FILE__)
-
-    describe Babosa::Transliterator::German do
+```ruby
+require "spec_helper"
 
-      let(:t) { described_class.instance }
-      it_behaves_like "a latin transliterator"
+describe Babosa::Transliterator::German do
+  let(:t) { described_class.instance }
+  it_behaves_like "a latin transliterator"
 
-      it "should transliterate Eszett" do
-        t.transliterate("ß").should eql("ss")
-      end
-
-      it "should transliterate vowels with umlauts" do
-        t.transliterate("üöä").should eql("ueoeae")
-      end
-
-    end
+  it "should transliterate Eszett" do
+    t.transliterate("ß").should eql("ss")
+  end
 
+  it "should transliterate vowels with umlauts" do
+    t.transliterate("üöä").should eql("ueoeae")
+  end
+end
+```
 
 ### Rails 3.x and higher
 
@@ -167,46 +173,6 @@ and
 [parameterize](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize)
 to see if they suit your needs.
 
-### Babosa vs. Stringex
-
-Babosa provides much of the functionality provided by the
-[Stringex](https://github.com/rsl/stringex) gem, but in the subjective opinion
-of the author, is for most use cases a better choice.
-
-#### Fewer Features
-
-Stringex offers functionality for storing slugs in an Active Record model, like
-a simple version of [FriendlyId](http://github.com/norman/friendly_id), in
-addition to string processing. Babosa only does string processing.
-
-#### Less Aggressive Unicode Transliteration
-
-Stringex uses an agressive Unicode to ASCII mapping which outputs gibberish for
-almost anything but Western European langages and Mandarin Chinese. Babosa
-supports only languages for which fluent speakers have provided
-transliterations, to ensure that the output makes sense to users.
-
-#### Unicode Support
-
-Stringex does no Unicode normalization or validation before transliterating
-strings, so if you pass in strings with encoding errors or with different
-Unicode normalizations, you'll get unpredictable results.
-
-#### No Locale Assumptions
-
-Babosa avoids making assumptions about locales like Stringex does, so it doesn't
-offer transliterations like this out of the box:
-
-    "$12 worth of Ruby power".to_url => "12-dollars-worth-of-ruby-power"
-
-This is because the symbol "$" is used in many Latin American countries for the
-peso. Stringex does this in many places, for example, transliterating all Han
-characters into Pinyin, effectively treating Japanese text as if it were
-Mandarin Chinese.
-
-
-### More info
-
 Please see the [API docs](http://rubydoc.info/github/norman/babosa/master/frames) and source code for
 more info.
 
@@ -218,9 +184,6 @@ Babosa can be installed via Rubygems:
 
 You can get the source code from its [Github repository](http://github.com/norman/babosa).
 
-Babosa is tested to be compatible with Ruby 1.8.7-2.0.0, JRuby 1.4+, and
-Rubinius 1.0+ It's probably compatible with other Rubies as well.
-
 ## Reporting bugs
 
 Please use Babosa's [Github issue
@@ -229,7 +192,7 @@ tracker](http://github.com/norman/babosa/issues).
 
 ## Misc
 
-"Babosa" means slug in Spanish.
+"Babosa" means "slug" in Spanish.
 
 ## Author
 
@@ -239,6 +202,7 @@ tracker](http://github.com/norman/babosa/issues).
 
 Many thanks to the following people for their help:
 
+* [Dmitry A. Ilyashevich](https://github.com/dmitry-ilyashevich) - Deprecation fixes
 * [anhkind](https://github.com/anhkind) - Vietnamese support
 * [Martins Zakis](https://github.com/martins) - Bug fixes
 * [Vassilis Rodokanakis](https://github.com/vrodokanakis) - Greek support
@@ -255,10 +219,9 @@ Many thanks to the following people for their help:
 * [Molte Emil Strange Andersen](https://github.com/molte) - Danish support
 * [Milan Dobrota](https://github.com/milandobrota) - Serbian support
 
-
 ## Copyright
 
-Copyright (c) 2010-2013 Norman Clarke
+Copyright (c) 2010-2020 Norman Clarke
 
 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
@@ -276,4 +239,4 @@ 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.
+SOFTWARE.