latex-decode 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f075a3a6e28fdeb92c9dba6486f56c461936a5a9
-  data.tar.gz: 27de3bebcc186f328d8bb6122357933a51baef51
+SHA256:
+  metadata.gz: 1c01f8f064a264d72d7d3a94e4f1b1b9f911756390eb2bc669e4586674b4d2ae
+  data.tar.gz: 8305a76f2fe47be9c3027f24d7c9354fdafebf90c8a1c4e3b27421934517cfb0
 SHA512:
-  metadata.gz: 6810f6ecdddf8d2b27e0bc8b9b80ef1277b3ac1270fa0901f1936edb057a0e19471c8a61768623df8e33661106103a1bebb00963425f324f68fde763a3aada53
-  data.tar.gz: 93f809598a9dbb63331c52c6e0b76a866a68103cdca6783ec468eced7b23e937907eae56fcd3f54230fc8b17f45d9047671a0fffe273555896b53efa8f62b7fb
+  metadata.gz: e53e8ee74e70d711b337a5ef81734a921b5dd89ef9e41e50d94f4a6f2cbd8b9834ff0930a822659a42b87b6c2771104e947d5315a2cd5c22c9b4d66d451daf6e
+  data.tar.gz: c50fa7ef133fdb373b2ea9399dd46c1a7181cd01a697a11299735956525fec8e551028d7db018f4e02deb81fb91bf6f4b2d717196002c4593ee6932c1f9c801a

data/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: ci
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    environment: CI
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - 'jruby'
+
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Upload coverage results
+        if: matrix.ruby-version == '3.1'
+        continue-on-error: true
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ github.token }}

data/.simplecov

@@ -0,0 +1,18 @@
+require 'simplecov-lcov'
+
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.output_directory = 'coverage'
+  c.lcov_file_name = 'lcov.info'
+  c.report_with_single_file = true
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::LcovFormatter
+])
+
+SimpleCov.start do
+  add_filter 'features/'
+
+  enable_coverage :branch
+end

data/Gemfile

@@ -3,19 +3,14 @@ gemspec
 
 group :test do
   gem 'rake'
-  gem 'rspec', '~> 3.0'
-  gem 'cucumber', '~> 1.3'
+  gem 'rspec'
+  gem 'cucumber'
+  gem 'simplecov', platform: 'mri'
+  gem 'simplecov-lcov', platform: 'mri'
 end
 
 group :debug do
-	gem 'debugger', :platforms => :mri_19
-	gem 'byebug', :platforms => :mri if RUBY_VERSION > '2.0'
-
-  gem 'rubinius-debugger', :require => false, :platforms => :rbx
-  gem 'rubinius-compiler', :require => false, :platforms => :rbx
+	gem 'debug', platform: 'mri'
 end
 
-gem 'unicode', '~> 0.4', :platforms => [:mri, :rbx, :mswin, :mingw] if RUBY_VERSION < '2.4'
 gem 'ritex', '~> 1.0.1'
-
-gem 'rubysl', '~> 2.0', :platforms => :rbx

data/README.md

@@ -1,38 +1,30 @@
 LaTeX::Decode
 =============
+[![ci](https://github.com/inukshuk/latex-decode/actions/workflows/ci.yml/badge.svg)](https://github.com/inukshuk/latex-decode/actions/workflows/ci.yml)
+[![coverage](https://coveralls.io/repos/github/inukshuk/latex-decode/badge.svg?branch=main)](https://coveralls.io/github/inukshuk/latex-decode?branch=main)
 
-[![Build Status](https://travis-ci.org/inukshuk/latex-decode.png?branch=master)](https://travis-ci.org/inukshuk/latex-decode)
-
-LaTeX::Decode is a Ruby gem to convert LaTeX input to Unicode. Its original
-use was as an input filter for [BibTeX-Ruby](http://rubygems.org/gems/bibtex-ruby)
-but can be used independently to decode LaTeX. Many of the patterns used by
-this Ruby gem are based on François Charette's equivalent Perl module
-[LaTeX::Decode](https://github.com/fc7/LaTeX-Decode).
+LaTeX::Decode is a Ruby gem to convert LaTeX input to Unicode.
+Its original use was as an input filter for [BibTeX-Ruby][]
+but it can be used independently to decode LaTeX.
+Many of the patterns used by this Ruby gem
+are based on François Charette's equivalent Perl module [LaTeX::Decode][].
 
 Quickstart
 ----------
-
     $ [sudo] gem install latex-decode
     $ irb
     >> require 'latex/decode'
     >> LaTeX.decode "dipl\\^{o}me d'\\'{e}tudes sup\\'erieures"
     => "diplôme d'études supérieures"
 
-Compatibility
--------------
-
-Unicode handling is one of the major differences between Ruby 1.8 and newer
-version; LaTeX::Decode; nevertheless, we try to support 1.8 as best as possible.
 
 Issues
 ------
-
-Please use the tracker of the project's
-[GitHub repository](https://github.com/inukshuk/latex-decode) to report any
-issues. When describing intended behaviour, please use the extremely simple
-syntax of the Cucumber features used by LaTeX::Decode; for instance, you could
-describe the example above as:
-
+Please use the tracker of the project's [repository][] to report any issues.
+When describing intended behaviour,
+please use the syntax of the Cucumber features used by LaTeX::Decode.
+For instance, you could describe the example above as:
+```Gherkin
     Feature: Decode LaTeX accents
       As a hacker who works with LaTeX
       I want to be able to decode LaTeX accents
@@ -40,26 +32,19 @@ describe the example above as:
       Scenario: A French sentence
         When I decode the string "dipl\\^{o}me d'\\'{e}tudes sup\\'erieures"
         Then the result should be "diplôme d'études supérieures"
+```
 
 Credits
 -------
+Kudos and thanks to all [contributors][] who have made LaTeX::Decode possible!
 
-Kudos and thanks to all [contributors](https://github.com/inukshuk/latex-decode/contributors)
-who have made LaTeX::Decode possible!
-
-Copyright (C) 2011-2015 [Sylvester Keil](sylvester.keil.or.at)
-
+Copyright (C) 2011-2022 Sylvester Keil
 Copyright (C) 2010 François Charette
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+[BibTeXRuby]: http://rubygems.org/gems/bibtex-ruby
+[LaTeX::Decode]: https://github.com/fc7/LaTeX-Decode
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+[repository]: https://github.com/inukshuk/latex-decode 
+[contributors]: https://github.com/inukshuk/latex-decode/contributors
+[LICENSE]: https://github.com/inukshuk/latex-decode/blob/main/LICENSE

data/Rakefile

@@ -29,13 +29,10 @@ Cucumber::Rake::Task.new(:cucumber)
 
 task :release do |t|
   system "gem build latex-decode.gemspec"
-  system "git tag #{LaTeX::Decode::VERSION}"
+  system "git tag v#{LaTeX::Decode::VERSION}"
   system "git push --tags"
   system "gem push latex-decode-#{LaTeX::Decode::VERSION}.gem"
   system "rm latex-decode-#{LaTeX::Decode::VERSION}.gem"
-  system "jgem build latex-decode.gemspec"
-  system "jgem push latex-decode-#{LaTeX::Decode::VERSION}.gem"
-  system "rm latex-decode-#{LaTeX::Decode::VERSION}-java.gem"
 end
 
 task :default => :cucumber

data/cucumber.yml

@@ -1 +1 @@
-default: --format progress --require features --color
+default: --format progress --require features --color --publish-quiet

data/features/step_definitions/latex.rb

@@ -5,3 +5,8 @@ end
 Then /^the result should be ('|")(.*)\1$/ do |quote,value|
   expect(@result).to eq(value)
 end
+
+# For whitespace or other characters that are hard to read in source code:
+Then /^I should get '([^']*)' \+ U\+(\h{4,}) \+ '([^']*)'$/ do |pre,code,post|
+  expect(@result).to eq(pre + code.hex.chr(Encoding::UTF_8) + post)
+end

data/features/support/env.rb

@@ -1,12 +1,11 @@
 begin
-  case
-  when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
-    require 'rubinius/debugger'
-  when RUBY_VERSION > '2.0'
-    require 'byebug'
-  else
-    require 'debugger'
-  end
+  require 'simplecov'
+rescue LoadError
+  # ignore
+end
+
+begin
+  require 'debug'
 rescue LoadError
   # ignore
 end

data/features/symbols.feature

@@ -12,10 +12,3 @@ Feature: Decode LaTeX symbol directives
     | \\uparrow            | ↑       |
     | \\downarrow          | ↓       |
     | \\rightarrow         | →       |
-
-  Scenarios: Whitespace
-    | latex | unicode | description        |
-    | x\\,x | x x     | small space        |
-    | x~x   | x x     | non-breaking space |
-    | ~x    |  x      | non-breaking space |
-

data/features/whitespace.feature

@@ -0,0 +1,28 @@
+Feature: Decode LaTeX whitespace directives
+  As a hacker who works with LaTeX
+  I want to be able to decode LaTeX whitespace
+
+  Scenario Outline: LaTeX to Unicode transformation
+    When I decode the string '<latex>'
+    Then I should get <pre> + U+<code> + <post>
+
+  Scenarios: Whitespace
+    | latex | pre | code | post | description                |
+    | x~x   | 'x' | 00A0 | 'x'  | non-breaking space         |
+    | ~y    | ''  | 00A0 | 'y'  | leading non-breaking space |
+    | z\\,z | 'z' | 202F | 'z'  | narrow no-break space      |
+
+    # In LaTeX, `\,` produces a kern that is ⅙ em wide. A kern is a
+    # non-breaking space that is not subject to compression or expansion when
+    # determining optimal line breaks. The ideal representation might be a
+    # non-breaking variant of U+2006 Six-Per-Em Space, but the best option
+    # that exists seems to be U+202F Narrow No-Break Space. While U+202F
+    # doesn't have an explicit width, Unicode Standard Annex #14, “Unicode
+    # Line Breaking Algorithm,” revision 47, says:
+    #
+    # > When expanding or compressing interword space according to common
+    # > typographical practice, only the spaces marked by U+0020 SPACE and
+    # > U+00A0 NO-BREAK SPACE are subject to compression, and only spaces
+    # > marked by U+0020 SPACE, U+00A0 NO-BREAK SPACE, and occasionally spaces
+    # > marked by U+2009 THIN SPACE are subject to expansion. All other space
+    # > characters normally have fixed width.

data/latex-decode.gemspec

@@ -8,17 +8,11 @@ Gem::Specification.new do |s|
   s.name        = 'latex-decode'
   s.version     = LaTeX::Decode::VERSION.dup
   s.authors     = ['Sylvester Keil']
-  s.email       = ['http://sylvester.keil.or.at']
   s.homepage    = 'http://github.com/inukshuk/latex-decode'
   s.summary     = 'Decodes LaTeX to Unicode.'
   s.description = 'Decodes strings formatted in LaTeX to equivalent Unicode strings.'
   s.license     = 'GPL-3.0'
-
-  if RUBY_PLATFORM =~ /java/
-    s.platform    = 'java'
-  else
-    s.platform    = 'ruby'
-  end
+  s.platform    = 'ruby'
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/latex/decode/base.rb

@@ -7,7 +7,7 @@ module LaTeX
       class << self
         attr_reader :patterns, :map
 
-        def inherited (base)
+        def inherited(base)
           subclasses << base
         end
 
@@ -15,11 +15,11 @@ module LaTeX
           @subclasses ||= []
         end
 
-        def decode (string)
+        def decode(string)
           decode!(string.dup)
         end
 
-        def decode! (string)
+        def decode!(string)
           patterns.each do |pattern|
             string.gsub!(pattern) { |m| [$2,map[$1],$3].compact.join }
           end
@@ -32,7 +32,7 @@ module LaTeX
 
       module_function
 
-      def normalize (string)
+      def normalize(string)
         string.gsub!(/\\(?:i|j)\b/) { |m| m == '\\i' ? 'ı' : 'ȷ' }
 
         # \foo\ bar -> \foo{} bar
@@ -50,7 +50,7 @@ module LaTeX
         string
       end
 
-      def strip_braces (string)
+      def strip_braces(string)
         string.gsub!(/(^|[^\\])([\{\}]+)/, '\1')
         string.gsub!(/\\(\{|\})/, '\1')
         string

data/lib/latex/decode/compatibility.rb

@@ -33,7 +33,7 @@ if RUBY_PLATFORM == 'java'
   end
 
 else
-  if RUBY_VERSION >= '2.4'
+  if RUBY_VERSION >= '2.3'
     module LaTeX
       def self.normalize_C(string)
         string.unicode_normalize(:nfc)

data/lib/latex/decode/maths.rb

@@ -6,7 +6,7 @@ module LaTeX
         /\$([^\$]+)\$/
       ].freeze
 
-      def self.decode! (string)
+      def self.decode!(string)
         patterns.each do |pattern|
           string.gsub!(pattern) do
             LaTeX.to_math_ml($1)

data/lib/latex/decode/symbols.rb

@@ -211,7 +211,7 @@ module LaTeX
         tone2             ˨
         tone1             ˩
         ss                ß
-        ,                 \u2009
+        ,                 \u202F
       }.map { |s| LaTeX.to_unicode(s) }].freeze
 
 

data/lib/latex/decode/version.rb

@@ -1,5 +1,5 @@
 module LaTeX
   module Decode
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/latex/decode.rb

@@ -31,7 +31,7 @@ require 'latex/decode/greek'
 module LaTeX
 
   class << self
-    def decode (string)
+    def decode(string)
       return string unless string.respond_to?(:to_s)
 
       string = string.is_a?(String) ? string.dup : string.to_s

metadata

@@ -1,26 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: latex-decode
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sylvester Keil
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies: []
 description: Decodes strings formatted in LaTeX to equivalent Unicode strings.
 email:
-- http://sylvester.keil.or.at
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".simplecov"
 - Gemfile
 - LICENSE
 - README.md
@@ -37,6 +37,7 @@ files:
 - features/support/env.rb
 - features/symbols.feature
 - features/umlauts.feature
+- features/whitespace.feature
 - latex-decode.gemspec
 - lib/latex/decode.rb
 - lib/latex/decode/accents.rb
@@ -52,7 +53,7 @@ homepage: http://github.com/inukshuk/latex-decode
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -74,9 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Decodes LaTeX to Unicode.
 test_files:
@@ -91,3 +91,4 @@ test_files:
 - features/support/env.rb
 - features/symbols.feature
 - features/umlauts.feature
+- features/whitespace.feature

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-bundler_args: --without debug
-sudo: false
-cache: bundler
-rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.4.0
-  - jruby-19mode
-  - jruby-head
-  - rbx-2
-notifications:
-  email:
-    recipients:
-      - sylvester@keil.or.at
-    on_success: change
-    on_failure: always