translighterate 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8193c5a842a9d40a6bf6a94d80f2d7f24df87cc
-  data.tar.gz: aab40fb8c8a1149e36b5da2e93be0eef2217ead1
+  metadata.gz: db4370d7bb61f58ce95b79a8551bc5170a575207
+  data.tar.gz: d322eee9e0245d64f4ac4398fe2890e2dc6dfb9c
 SHA512:
-  metadata.gz: a351519c1f9dae18f20eebe59946f376e4a3de8f2d74c4e96f8a88deab728bd9183a99a5a5757f3090159348e876bd7bc62ec416e8b00e93f974f802a024ae0c
-  data.tar.gz: 62b4f5680ff0fd6f609fae9ed9c8ce2450459127ca2092cbf0d0949e53c2ce72274f027a961fe079d5cf455e03f35976ebbdb839d357c5daebd5e4456860d0aa
+  metadata.gz: 46f026bdcdfc91e5a939ac527fbd502f832cb89e4a4f768ad4ace6578db8eecf7110c2d58d7e9cf28603eb4152ff7e561d3b7cea2ad9c211da802e992cc8b5fd
+  data.tar.gz: d32220fb84ef787126a40e23be718f2d235c44cdbe4bf4eb102846467be9f25bb401af63226a7fce18cdf7b89aecbc4e2bea1b2d18385c3a9d4d36db064131fc

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

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
+
+(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)
 
@@ -15,15 +18,25 @@ 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 = transliterated.gsub "ł", "l"
+      transliterated = transliterated.gsub "Ł", "L"
+
+      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

data/lib/translighterate/version.rb

@@ -0,0 +1,3 @@
+module Translighterate
+  VERSION = "0.2.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", ">= 4.0", "< 6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9.0"
+end

metadata

@@ -1,79 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: translighterate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Fleischman
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '9.0'
 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:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- 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
@@ -94,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A version of Rails's highlight that is transliteration aware.