jekyll-microtypo 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0628e2b5c2f6a7fa37b390567655df106eaad46f'
-  data.tar.gz: 5f85d6275246f9e39c6a612b781e112c6da7befd
+  metadata.gz: 374c7bf0a7bcb54cf2dc2621b7957e350e027531
+  data.tar.gz: 0aa11e13446becdabac1645ade47b7af6196dc1d
 SHA512:
-  metadata.gz: f4884f750e414590c4f90a7b1bad3a07ec2445b7b8f0f57bc8ea32866790f9a28b73d16a13e930e61e2ed30bd0ef522769b15aa134c66fdd0cfb2f97e37e089d
-  data.tar.gz: 5533853d81f6e15c26ea6226d182fb4a2d0043471b31b5e5cccff520dc646cf027c8349d7b89b3e009fc5f05ed73b501017edd0a96b1adabae510d6dbb6de796
+  metadata.gz: b9047fd528c42e6b25b458d209c281423fcfa4d0e7939475419b613b376ab7324c870929c1c0b43714d2055451e0da446a92d3005be62c11f8606726e17fe106
+  data.tar.gz: 9d0e85b371725a224f71756f7dddb256dc1f78683cdb9a3f5b8cdc65b5197c13d4d6b25d59ad3042ec889c2ffb8112501fe2de453a9e83df608b1a38ba244659

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in jekyll-post-files.gemspec
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Boris Schapira
+Copyright (c) 2016-present Boris Schapira and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,4 +3,196 @@
 [![Gem Version](https://badge.fury.io/rb/jekyll-microtypo.svg)](https://badge.fury.io/rb/jekyll-microtypo)
 [![Gem Downloads](https://img.shields.io/gem/dt/jekyll-microtypo.svg?style=flat)](http://rubygems.org/gems/jekyll-microtypo)
 
+## Table of contents / Table des matières
+
+- [Jekyll microtypo plugin tag](#jekyll-microtypo-plugin-tag)
+  - [Table of contents / Table des matières](#table-of-contents--table-des-mati%C3%A8res)
+  - [English](#english)
+    - [en_US fixings](#enus-fixings)
+    - [Installation](#installation)
+    - [Global use](#global-use)
+    - [Configuration](#configuration)
+    - [Ignore code sections](#ignore-code-sections)
+  - [Français](#fran%C3%A7ais)
+    - [Corrections fr_FR](#corrections-frfr)
+    - [Installation](#installation)
+    - [Utilisation générique](#utilisation-g%C3%A9n%C3%A9rique)
+    - [Configuration](#configuration)
+    - [Ignorer des portions de code](#ignorer-des-portions-de-code)
+
+## English
+
 `jekyll-microtypo` is a [Jekyll](http://jekyllrb.com/) plugin that attempts to fix microtypography for french and english languages.
+
+It provides a new filter which takes into parameter the locale of the text to be improved:
+
+```
+{{ content | microtypo: 'en_US' }}
+```
+
+For the moment, `jekyll-microtypo` only sypports fr_FR and en_US.
+
+### en_US fixings
+
+- Removal of unnecessary spaces before certain punctuation marks
+- Use of opening and closing single quotation marks
+- Removing unnecessary spaces between amount and currency
+- Replacement of "..." with "..."
+- Use of special characters like ©, ®, ™ or ℗ by typing the letter with parenthesis
+
+### Installation
+
+Add `gem 'jekyll-microtypo'` to the `jekyll_plugin` group in your `Gemfile`:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'jekyll'
+
+group :jekyll_plugins do
+  gem 'jekyll-microtypo'
+end
+```
+
+Then run `bundle` to install the gem.
+
+### Global use
+
+A simple way to use `jekyll-microtypo` is to use it into a master layout.
+
+Add a `microtypo.html` file to your `_layouts` folder, containing the following snippet:
+
+```liquid
+{{ content | microtypo: page.locale  }}
+```
+
+Then, modify all your top-level layouts to inherit from this one. For example, if your only previous top-level layout was `default.html`, add this header:
+
+```
+---
+layout: microtypo
+---
+
+… The previous content of default.html …
+```
+
+### Configuration
+
+There is no configuration needed for **en_US**.  
+For **fr_FR**, you can add a configuration **if you want to hide the inclusive median point abbreviation to screen readers**.
+
+Add `microtypo` to your `_config.yml`:
+
+```yaml
+microtypo:
+  median: true
+```
+* Before : `Il·Elle est intéressé·e.`
+* After : `Il<span aria-hidden="true">·Elle</span> est intéressé<span aria-hidden="true">·e</span>.`
+
+### Ignore code sections
+
+It is possible to tell `jekyll-microtypo` to ignore one or more sections of code in its corrective operation. To do this, just place the code to ignore between these two comments:
+
+```html
+This content will be fixed.
+
+<!-- nomicrotypo -->
+This content will not be fixed
+<!-- endnomicrotypo -->
+
+This content will be fixed.
+```
+
+## Français
+
+`jekyll-microtypo` est un plugin [Jekyll](http://jekyllrb.com/) qui permet de corriger la microtypographie de contenus rédigés en anglais ou en français.
+
+Il fournit un nouveau filtre qui prend en paramètre la locale du texte à corriger:
+
+```
+{{ content | microtypo: 'en_US' }}
+```
+
+Pour le moment, `jekyll-microtypo` ne supporte que fr_FR et en_US.
+
+### Corrections fr_FR
+
+- Remplacement des ordinnaux "1er, 2e" par "1<sup>er</sup>, 2<sup>e</sup>"
+- Remplacement de "n°3" par "n<sup>o</sup>&#8239;3"
+- Utilisation des guillemets à la français
+- Utilisation des guillemets simples ouvrants et fermants
+- Remplacement des pontuations spéciales "?!", "!?", "!!" par les signes adaptés "&#8264;", "&#8265;", "&#8252;"
+- Ajout d'une espace insécable ou fine insécable devant les signes de ponctuation qui le nécessitent
+- Remplacement de l'espace entre des chiffres et certaines unités par une espace fine insécable (attention, l'espace doit être présente à l'origine)
+- Ajout d'une espace insécable avant le montant et les signes "€" ou "$"
+- Ajout d'une espace insécable après un tiret long
+- Remplacement du "x" par un "&times;" dans les multiplications
+- Remplacement de "..." par une vrai éllipse "..."
+- Utilisation de caractères spéciaux comme ©, ®, ™ ou ℗ en utilisant une lettre entourée de parenthèses.
+- **Si configuré** : masquage de la notation abbréviative à base de point médian pour les lecteurs d'écran 
+
+### Installation
+
+Ajoutez `gem 'jekyll-microtypo'` au groupe `jekyll_plugin` de votre `Gemfile`:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'jekyll'
+
+group :jekyll_plugins do
+  gem 'jekyll-microtypo'
+end
+```
+
+Puis exécutez `bundle` pour installer la gem.
+
+### Utilisation générique
+
+Une manière simple d'utiliser `jekyll-microtypo` est de l'appliquer sur un *layout* de plus haut niveau.
+
+Ajoutez un fichier `microtypo.html` à votre dossier `_layouts`, contenant la portion de code suivante:
+
+```liquid
+{{ content | microtypo: page.locale  }}
+```
+
+Puis modifier vos autres *layout* de plus haut niveau pour qu'ils héritent de ce *layout*. Par exemple, si votre *layout* de plus haut niveau était `default.html`, ajoutez-lui cet en-tête:
+
+```
+---
+layout: microtypo
+---
+
+… Le contenu de default.html avant intervention …
+```
+
+### Configuration
+
+Aucune configuration n'est nécessaire pour la locale **en_US**.  
+Pour la locale **fr_FR**, vous pouvez ajouter une configuration dans le seul cas où vous voudriez **masquer la syntaxe abbréviative à base de point médian aux lecteurs d'écran**.
+
+Dans ce cas, ajoutez `microtypo` à votre `_config.yml`:
+
+```yaml
+microtypo:
+  median: true
+```
+
+* Avant : `Il·Elle est intéressé·e.`
+* Après : `Il<span aria-hidden="true">·Elle</span> est intéressé<span aria-hidden="true">·e</span>.`
+
+### Ignorer des portions de code
+
+Il est possible d'indiquer à `jekyll-microtypo` d'ignorer une ou plusieurs portions de code dans son opération de correction. Pour cela, il suffit de placer la portion de code entre deux commentaires :
+
+```html
+Ce contenu sera corrigé.
+
+<!-- nomicrotypo -->
+Celui-ci ne sera pas corrigé.
+<!-- endnomicrotypo -->
+
+Ce contenu sera corrigé.
+```

data/Rakefile

@@ -1,8 +1,24 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+# frozen_string_literal: true
 
-task :default => :spec
+require "rubygems"
+require "bundler"
+require "bundler/gem_tasks"
 
-Rake::TestTask.new do |t|
-    t.libs << 'test'
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+
+require "rake"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/test_*.rb"
+  test.warning = false
+end
+
+task :default => :test

data/lib/jekyll-microtypo.rb

@@ -1 +1,3 @@
-require 'jekyll/microtypo'
+# frozen_string_literal: true
+
+require "jekyll/microtypo"

data/lib/jekyll/microtypo.rb

@@ -103,9 +103,25 @@ module Jekyll
 
             end
 
+            # single quotes
+            input.gsub!(/(\s)'([[:alpha:]])/, '\1‘\2'.freeze)
+            input.gsub!(/([[:alpha:]])'(\s)/, '\1’\2'.freeze)
+            input.gsub!(/(\d)''/, '\1’’'.freeze)
+            input.gsub!(/(\d)'/, '\1’'.freeze)
+
+            # Apostrophe
+            input.gsub!(/([[:alpha:]])'([[:alpha:]])/, '\1’\2'.freeze)
+
             # Elipsis
             input.gsub!('...', '…'.freeze)
 
+            # Special characters
+            input.gsub!(/\([c|C]\)/, '©'.freeze)
+            input.gsub!(/\([p|P]\)/, '℗'.freeze)
+            input.gsub!(/\([r|R]\)/, '®'.freeze)
+            input.gsub!(/\((tm|TM)\)/, '™'.freeze)
+            input.gsub!(/\+-/, '±'.freeze)
+
             array_response.push input
           end
         end
@@ -113,8 +129,8 @@ module Jekyll
 
       # Clean empty lines
       array_response.join.gsub(/\A\s*\n$/, ''.freeze)
+    end
   end
-  end
-  end
+end
 
 Liquid::Template.register_filter(Jekyll::Microtypo)

data/lib/jekyll/microtypo/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Microtypo
-    VERSION = '0.1.2'.freeze
+    VERSION = "0.2.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-microtypo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Boris Schapira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -36,76 +36,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '5.8'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 5.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.4
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.51.0
 description: "    Jekyll plugin that improves microtypography\n"
 email:
 - contact@borisschapira.com
@@ -132,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -140,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin that improves microtypography