translighterate 0.0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 702abdb37c389df4421a0b0e337ea946dfd838c3
-  data.tar.gz: a1330ad9a48e6c9c8a7a0f0a8e616acf755beece
+SHA256:
+  metadata.gz: 517bd6a4f3df331190cde122301b9240e04a4354b1294b4e5143a48e2c38d5f4
+  data.tar.gz: cd79f3e4bc4e5723bc45f5f91f12ed5a61bffc13dec9ad84e4371c66b8215e0f
 SHA512:
-  metadata.gz: c08ef0b945c23cf01aff56ea4b55f5d011316ddb0e35bd36d30b69f5b358712f869cb04119b445ef9ea9276165364cb3ff0927d56b13e6c8670efd1882709066
-  data.tar.gz: 643c4f1bacaac643553767dd2c1022409e721a532a4fa8e47c75d19ab83892e7bbfd73209926230e11951bcf376857fe65f96e61c989b8863ae68827a0702e55
+  metadata.gz: b488c79f9a5913d25b1eeaefeb7ec9511e6281a81b7876d70e5f5e3e3a0a1d11bc117cc01b0069d5736e9c514934444a6c7aacc51f7ca7b6ad5ce50ff4358437
+  data.tar.gz: aaa55ff30a6c6823105a185ca703a2e7d02c5b8245c47cb24ebff58696a92a67daa5a5c6b6c42ddb1fa2deb3d262315692cd856a37c75b34a836b4df27ccad0b

data/.github/workflows/main.yml

@@ -0,0 +1,12 @@
+name: Run tests
+on: [push]
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.1
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bin/rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in translighterate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeremy Fleischman
+
+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,70 @@
+# translighterate = transliterate + highlight [![Build Status](https://github.com/jfly/translighterate/actions/workflows/main.yml/badge.svg)](https://github.com/jfly/translighterate/actions/workflows/main.yml)
+
+(Created after getting no responses to this [Stack Overflow question](http://stackoverflow.com/questions/34166987/rails-gem-for-transliterate-highlight).)
+
+This is a version of Rails's [highlight](http://apidock.com/rails/ActionView/Helpers/TextHelper/highlight) that is transliteration aware.
+
+For example, highlighting 'duss' in 'Düsseldorf' will actually match something:
+
+```ruby
+irb(main):001:0> require 'translighterate'
+=> true
+irb(main):002:0> Translighterate.highlight("Düsseldorf", "duss")
+=> "<mark>Düss</mark>eldorf"
+```
+
+as opposed to this behavior with Rails's [highlight](http://apidock.com/rails/ActionView/Helpers/TextHelper/highlight):
+
+```ruby
+irb(main):002:0> require 'action_view'
+=> true
+irb(main):004:0> include ActionView::Helpers::TextHelper
+=> Object
+irb(main):005:0> highlight("Düsseldorf", "duss")
+=> "Düsseldorf"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'translighterate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install translighterate
+
+## Usage
+
+We have one class `Translighterate` with one method `highlight`.
+
+```ruby
+irb(main):001:0> require 'translighterate'
+=> true
+irb(main):002:0> Translighterate.highlight("Düsseldorf", "duss")
+=> "<mark>Düss</mark>eldorf"
+```
+
+## 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).
+
+### Testing
+
+`bin/rspec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jfly/translighterate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "translighterate"
+
+# 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/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/translighterate.rb

@@ -1,7 +1,10 @@
+require "translighterate/version"
 require 'action_view'
 include ActionView::Helpers::TextHelper
 
-class Translighterate
+module Translighterate
+  # Copied (and modified!) from
+  #  https://github.com/rails/rails/blob/495ef4124e292dcc7062e3e1f04f623053113101/actionview/lib/action_view/helpers/text_helper.rb#L130
   def self.highlight(text, phrases, options = {})
     text = sanitize(text) if options.fetch(:sanitize, true)
 
@@ -14,16 +17,45 @@ class Translighterate
 
       # Transliteration trick from:
       #  https://github.com/cubing/worldcubeassociation.org/issues/238#issuecomment-234702800
-      transliterated = text.mb_chars.normalize(:kd).gsub(/[\p{Mn}]/,'').to_s
-      transliterated.gsub(/(#{match})(?![^<]*?>)/i) do |found|
-        original_text_found = text[Range.new(*$~.offset(0), true)]
-        if block_given?
-          yield original_text_found
-        else
-          highlighter = options.fetch(:highlighter, '<mark>\1</mark>')
-          highlighter.gsub(/\\1/, original_text_found)
-        end
+      transliterated = text.chars.map { |ch| transliterate_char(ch) }.join
+
+      previous_match_end_index = 0
+      result = ""
+      transliterated.scan(/(#{match})(?![^<]*?>)/i) do
+        match_range = $~.offset(0)
+        result += text[previous_match_end_index...match_range[0]]
+        original_text_found = text[Range.new(*match_range, true)]
+        previous_match_end_index = match_range[1]
+
+        result += if block_given?
+                    yield original_text_found
+                  else
+                    highlighter = options.fetch(:highlighter, '<mark>\1</mark>')
+                    highlighter.gsub(/\\1/, original_text_found)
+                  end
       end
+      result += text[previous_match_end_index..-1]
     end.html_safe
   end
 end
+
+def transliterate_char(ch)
+  raise if ch.length != 1
+  original_char = ch
+
+  mappings = {
+    "ł" => "l",
+    "Ł" => "L",
+  }
+
+  ch = if mappings.key?(ch)
+         mappings[ch]
+       else
+         ch.mb_chars.unicode_normalize(:nfkd).gsub(/[\p{Mn}]/, '').unicode_normalize(:nfc).to_s
+       end
+  if ch.length != 1
+    original_char
+  else
+    ch
+  end
+end

data/lib/translighterate/version.rb

@@ -0,0 +1,3 @@
+module Translighterate
+  VERSION = "0.3.0"
+end

data/translighterate.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "translighterate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "translighterate"
+  spec.version       = Translighterate::VERSION
+  spec.authors       = ["Jeremy Fleischman"]
+  spec.email         = ["jeremyfleischman@gmail.com"]
+
+  spec.summary       = "A version of Rails's highlight that is transliteration aware."
+  spec.description   = "For example, highlighting 'duss' in 'Düsseldorf' will actually match something."
+  spec.homepage      = "https://github.com/jfly/translighterate"
+
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionview", ">= 6.0"
+
+  spec.add_development_dependency "bundler", ">= 2.2"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", ">= 3.10"
+  spec.add_development_dependency "byebug", ">= 11.1"
+end

metadata

@@ -1,84 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: translighterate
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Jeremy Fleischman
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '11.1'
 description: For example, highlighting 'duss' in 'Düsseldorf' will actually match
   something.
-email: jeremyfleischman@gmail.com
+email:
+- jeremyfleischman@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
 - lib/translighterate.rb
+- lib/translighterate/version.rb
+- translighterate.gemspec
 homepage: https://github.com/jfly/translighterate
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,9 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A version of Rails's highlight that is transliteration aware.
 test_files: []