orthotypo 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6462655e93e5e08b9e6e826e073448917e37460dcf452dff86d647ea935dd302
-  data.tar.gz: ab33135fd05d7c134f068750e3e5bad8d65e7eb4b5167e789bf1580ac88eb7ad
+  metadata.gz: b41b05766be4f11e6494a7e89823a6ab730910aec4a679d22b764ae96fb05f10
+  data.tar.gz: 0c2a072f5c3ebd8583b70c7ee4bf0eafe064c827d4e0af250728bcf5762dc5ae
 SHA512:
-  metadata.gz: 1ac660478d49943c2518edd98b29df944d5af2152f129073982fd080a0999982c1983b794d4b0d2fc1a49a4a88209aa6e42793d39cb182dbeb0469b2a28a3dac
-  data.tar.gz: 000c3879262745d51e3ee143711272a3a3f3ebbbf0bbc99b950db2cbf004883a9b20b645ca5b5ad91e05087ecea898556b406fb3a37e7791165573d19d62837e
+  metadata.gz: 20ff73ede6bf05d4b2b8842604b09267f36cf2d44fc17c6e4a467e9e703934a20f18616368cc5af88529122166130c8b868612af6caab95ff6f685236b862443
+  data.tar.gz: 55f9a2023f185176d52de197847f92ee61ea0e8ba20d70c920fec7e31b4d86dbae0ab87594adcd7c406fcdbbc2ef189fa8a113bcfeab9f60786c31dd77771f1e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-10-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at contact@arnaudlevy.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in orthotypo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    orthotypo (0.6.0)
+      htmlentities
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    byebug (11.1.3)
+    diff-lcs (1.5.0)
+    htmlentities (4.3.4)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-nc (0.3.0)
+      rspec (>= 3)
+      terminal-notifier (>= 1.4)
+    rspec-support (3.12.1)
+    rubocop (1.57.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    terminal-notifier (2.0.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-22
+
+DEPENDENCIES
+  byebug
+  orthotypo!
+  rake (~> 13.0)
+  rspec
+  rspec-nc
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 noesya
+
+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,57 @@
+# Orthotypo
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/16eb1f100538684deee0/maintainability)](https://codeclimate.com/github/noesya/orthotypo/maintainability)
+
+Il y a un corpus riche de règles typographiques, dépendant des langues. 
+Cette gem vise à intégrer ces règles et à automatiser leurs mises en application pour le web, quand cela est possible.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add orthotypo
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install orthotypo
+
+## Usage
+
+Ajout d'espace fine insécable avant les signes doubles en français.
+
+```
+"Un texte avec un signe double: mais il manque l'espace.".ortho
+> Un texte avec un signe double : mais il manque l'espace.
+
+```
+
+## Roadmap
+
+### v1
+1. S'adapter aux locales (détecter I18n)
+2. Ne pas endommager l'HTML et les HTML entities ( )
+
+### v2
+Permettre les configs
+
+## Sources
+
+- https://fr.wikipedia.org/wiki/Code_typographique
+- http://www.orthotypographie.fr/
+- https://www.scribbr.fr/elements-linguistiques/les-espaces/
+
+## Development
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/noesya/orthotypo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/orthotypo/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Orthotypo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/orthotypo/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "orthotypo"
+
+# 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/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/orthotypo/analyzer.rb

@@ -0,0 +1,18 @@
+module Orthotypo
+  class Analyzer
+
+    def self.url?(string)
+      (string =~ /\A#{URI::DEFAULT_PARSER.regexp[:ABS_URI]}\z/) && 
+      (string =~ /\A(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?\z/ix) ? true : false
+    end
+  
+    def self.email?(string)
+      string =~ /\A#{URI::MailTo::EMAIL_REGEXP}\z/ ? true : false
+    end
+
+    def self.precious?(string)
+      email?(string) || url?(string)
+    end
+    
+  end
+end

data/lib/orthotypo/composer/en.rb

@@ -0,0 +1,18 @@
+module Orthotypo
+  class Composer::En < Composer
+
+    def chars_with_space_after
+      [
+        ',',
+        '.',
+        '...',
+        '…',
+        ';',
+        ':',
+        '!',
+        '?'
+      ]
+    end
+
+  end
+end

data/lib/orthotypo/composer/en_gb.rb

@@ -0,0 +1,5 @@
+module Orthotypo
+  class Composer::EnGb < Composer::En
+
+  end
+end

data/lib/orthotypo/composer/fr.rb

@@ -0,0 +1,57 @@
+module Orthotypo
+  class Composer::Fr < Composer
+
+    protected
+
+    def chars_with_space_before
+      [
+        '%'
+      ]
+    end
+
+    def chars_with_space_after
+      [
+        ',',
+        '.',
+        '...',
+        '…'
+      ]
+    end
+    
+    def chars_with_space_around
+      [
+        ';',
+        ':',
+        '!',
+        '?'
+      ]
+    end
+
+    def chars_with_no_space_around
+      [
+        "'",
+        '’',
+        'ʼ'
+      ]
+    end
+
+    def pairs_with_space_around
+      [
+        '«»'
+      ]
+    end
+    
+    def pairs_with_no_space_around
+      [
+        '“”',
+        '‘’',
+        '‹›',
+        '""',
+        "''",
+        "()",
+        "{}",
+        "[]"
+      ]
+    end
+  end
+end

data/lib/orthotypo/composer/fr_ch.rb

@@ -0,0 +1,4 @@
+module Orthotypo
+  class Composer::FrCh < Composer::Fr
+  end
+end

data/lib/orthotypo/composer/fr_fr.rb

@@ -0,0 +1,4 @@
+module Orthotypo
+  class Composer::FrFr < Composer::Fr
+  end
+end

data/lib/orthotypo/composer.rb

@@ -0,0 +1,182 @@
+module Orthotypo
+  class Composer
+    attr_reader :string, :ortho
+
+    SPACE = ' '.freeze
+    NBSP = ' '.freeze
+    NNBSP = ' '.freeze
+    PRECIOUS_TOKEN = 'orthotypopreciousthing'
+
+    def initialize(string, html: nil)
+      @string = string
+      @html = html
+      parse
+    end
+
+    protected
+
+    def chars_with_space_before
+      []
+    end
+
+    def chars_with_space_after
+      [
+        ',',
+        '.'
+      ]
+    end
+    
+    def chars_with_space_around
+      []
+    end
+
+    def chars_with_no_space_around
+      []
+    end
+
+    def pairs_with_space_around
+      []
+    end
+    
+    def pairs_with_no_space_around
+      []
+    end
+
+    def is_html?
+      # TODO contains tags?
+      @html || contains_html_entities?
+    end
+
+    def contains_html_entities?
+      @contains_html_entities ||= html_entities.decode(string) != string
+    end
+
+    def prepare_ortho
+      @ortho = string.dup
+      # @ortho = html_entities.decode(@ortho) if contains_html_entities?
+      @nokogiri = Nokogiri::HTML.fragment @ortho
+    end
+
+    def clean_ortho
+      @ortho = @nokogiri.to_s
+      # @ortho = html_entities.encode(@ortho) if contains_html_entities?
+    end
+
+    def parse
+      prepare_ortho
+      preserve_precious_things
+      # Chars
+      parse_chars_with_space_before
+      parse_chars_with_space_after
+      parse_chars_with_space_around
+      parse_chars_with_no_space_around
+      # Pairs
+      parse_pairs_with_space_around
+      parse_pairs_with_no_space_around
+      # Numbers
+      parse_numbers
+      # 
+      clean_ortho
+      restore_precious_things
+    end
+
+    def preserve_precious_things
+      @precious_things = []
+      @nokogiri.traverse do |node|
+        next unless node.text?
+        new_content = node.content.split(SPACE).map { |fragment|
+          if Analyzer::precious?(fragment)
+            token = "#{PRECIOUS_TOKEN}#{@precious_things.length}"
+            @precious_things << fragment
+            token
+          else
+            fragment
+          end
+        }.join(SPACE)
+        node.content = new_content
+      end
+    end
+
+    def restore_precious_things
+      @precious_things.each_with_index do |value, index|
+        @ortho.gsub! "#{PRECIOUS_TOKEN}#{index}", value
+      end
+    end
+
+    def parse_chars_with_space_before
+      chars_with_space_before.each do |char|
+        # Espace normal avant -> espace fine insécable avant
+        fix(SPACE + '%', NNBSP + '%')
+        # Pas d'espace avant -> espace fine insécable avant
+        fix(/([[:alnum:]])%/, "\\1" + NNBSP + '%')
+      end
+    end
+
+    def parse_chars_with_space_after
+      chars_with_space_after.each do |char|
+        # Espace avant -> pas d'espace avant 
+        fix(SPACE + char, char)
+        # Pas d'espace après -> espace après
+        fix(/[#{char}]([[:alnum:]])/, char + SPACE + "\\1")
+      end
+    end
+
+    def parse_chars_with_space_around
+      chars_with_space_around.each do |char|
+        # Espace normal avant -> espace fine insécable avant
+        fix(SPACE + char, NNBSP + char)
+        # Pas d'espace avant -> espace fine insécable avant
+        fix(/([[:alnum:]])[#{char}]/, "\\1" + NNBSP + char)
+      end
+    end
+
+    def parse_chars_with_no_space_around
+      chars_with_no_space_around.each do |char|
+        # Espace avant -> pas d'espace avant 
+        fix(SPACE + char, char)
+        # Espace après -> pas d'espace après 
+        fix(char + SPACE, char)
+      end
+    end
+
+    def parse_pairs_with_space_around
+      pairs_with_space_around.each do |marks|
+        opening = marks.chars.first
+        closing = marks.chars.last
+        # Espace normal -> espace fine insécable
+        fix(opening + SPACE, opening + NNBSP)
+        fix(SPACE + closing, NNBSP + closing)
+        # Pas d'espace -> espace fine insécable
+        fix(/[#{opening}]([^[:space:]])/, opening + NNBSP + "\\1")
+        fix(/([^[:space:]])[#{closing}]/, "\\1" + NNBSP + closing)
+      end
+    end
+
+    def parse_pairs_with_no_space_around
+      pairs_with_no_space_around.each do |marks|
+        opening = marks.chars.first
+        closing = marks.chars.last
+        # Espace -> pas d'espace
+        fix(opening + SPACE, opening)
+        fix(SPACE + closing, closing)
+      end
+    end
+
+    def parse_numbers
+      ['.', ','].each do |char|
+        fix(/([[:digit:]])[#{char}][[:space:]]([[:digit:]])/, "\\1" + char + "\\2")
+      end
+    end
+
+    def html_entities
+      @html_entities ||= HTMLEntities.new(:expanded)
+    end
+
+    def fix(bad, good)
+      @nokogiri.traverse do |node|
+        next unless node.text?
+        node.content = node.content.gsub(bad, good)
+      end
+    end
+  end
+end

data/lib/orthotypo/core_ext.rb

@@ -0,0 +1,5 @@
+String.class_eval do
+  def ortho(locale: nil, html: nil)
+    @ortho ||= Orthotypo::Localizer.new(self, locale: locale, html: html).composer.ortho
+  end
+end

data/lib/orthotypo/localizer.rb

@@ -0,0 +1,32 @@
+module Orthotypo
+  class Localizer
+
+    DEFAULT_LOCALE = 'fr'
+
+    def initialize(string, locale: nil, html: nil)
+      @string = string
+      @locale = locale
+      @html = html
+    end
+
+    def composer
+      composer_class.new @string, html: @html
+    end
+
+    protected
+
+    def composer_class
+      composer_class = composer_class_for(@locale) unless @locale.nil?
+      composer_class ||= composer_class_for(DEFAULT_LOCALE)
+      composer_class
+    end
+
+    def composer_class_for(locale)
+      formatted_locale = locale.split('-').map(&:capitalize).join
+      class_name = "::Orthotypo::Composer::#{formatted_locale}"
+      Object.module_eval(class_name, __FILE__, __LINE__)
+    rescue
+      nil
+    end
+  end
+end

data/lib/orthotypo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Orthotypo
+  VERSION = "0.6.0"
+end

data/lib/orthotypo.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "htmlentities"
+require "nokogiri"
+require "uri"
+require_relative "orthotypo/analyzer"
+require_relative "orthotypo/composer"
+require_relative "orthotypo/composer/fr"
+require_relative "orthotypo/composer/fr_fr"
+require_relative "orthotypo/composer/fr_ch"
+require_relative "orthotypo/composer/en"
+require_relative "orthotypo/composer/en_gb"
+require_relative "orthotypo/core_ext"
+require_relative "orthotypo/localizer"
+require_relative "orthotypo/version"
+
+module Orthotypo
+  class Error < StandardError; end
+end

data/orthotypo.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/orthotypo/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "orthotypo"
+  spec.version = Orthotypo::VERSION
+  spec.authors = ["Arnaud Levy"]
+  spec.email = ["arnaud.levy@noesya.coop"]
+
+  spec.summary = "Pour un texte correctement typographié"
+  spec.description = "Il y a un corpus riche de règles typographiques, dépendant des langues. Cette gem vise à intégrer ces règles et à automatiser leur mise en application pour le web, quand cela est possible."
+  spec.homepage = "https://github.com/noesya/orthotypo"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/noesya/orthotypo"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = "lib"
+
+  spec.add_dependency "htmlentities"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "byebug"
+end

data/sig/orthotypo.rbs

@@ -0,0 +1,4 @@
+module Orthotypo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/analyzer_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Orthotypo::Analyzer do
+  it 'find urls' do
+    expect(Orthotypo::Analyzer.url?("https://unsplash.com/@lusvardi?utm_source=osuny")).to be true
+    expect(Orthotypo::Analyzer.url?("mot:")).to be false
+  end
+end

data/spec/composer/en_spec.rb

@@ -0,0 +1,17 @@
+
+require 'spec_helper'
+
+describe Orthotypo::Composer::En do
+  it 'removes spaces before double punctuation marks' do
+    expect("mot: suite".ortho(locale: 'en')).to eq "mot: suite"
+    expect("mot : suite".ortho(locale: 'en')).to eq "mot: suite"
+    expect("é: suite".ortho(locale: 'en')).to eq "é: suite"
+    expect("é : suite".ortho(locale: 'en')).to eq "é: suite"
+    expect("1: suite".ortho(locale: 'en')).to eq "1: suite"
+    expect("1 : suite".ortho(locale: 'en')).to eq "1: suite"
+    expect("mot; suite".ortho(locale: 'en')).to eq "mot; suite"
+    expect("mot ; suite".ortho(locale: 'en')).to eq "mot; suite"
+    expect("mot!".ortho(locale: 'en')).to eq "mot!"
+    expect("mot !".ortho(locale: 'en')).to eq "mot!"
+  end
+end

data/spec/composer/fr_spec.rb

@@ -0,0 +1,62 @@
+
+require 'spec_helper'
+
+describe Orthotypo::Composer::Fr do
+  it 'adds spaces before double punctuation marks' do
+    expect("mot: suite".ortho).to(eq("mot : suite"))
+    expect("é: suite".ortho).to(eq("é : suite"))
+    expect("1: suite".ortho).to(eq("1 : suite"))
+    expect("mot; suite".ortho).to(eq("mot ; suite"))
+    expect("mot!".ortho).to(eq("mot !"))
+    expect("mot !".ortho).to(eq("mot !"))
+  end
+
+  it 'transforms regular spaces before double punctuation marks' do
+    expect("mot : suite".ortho).to(eq("mot : suite"))
+    expect("é : suite".ortho).to(eq("é : suite"))
+    expect("1 : suite".ortho).to(eq("1 : suite"))
+  end
+  
+  it 'fixes space before simple punctuation' do
+    expect("mot , suite".ortho).to(eq("mot, suite"))
+    expect("mot . suite".ortho).to(eq("mot. suite"))
+    expect("l 'approche".ortho).to(eq("l'approche"))
+    expect("l' approche".ortho).to(eq("l'approche"))
+  end
+  
+  it 'fixes space after simple punctuation' do
+    expect("mot,suite".ortho).to(eq("mot, suite"))
+    expect("4,5".ortho).to(eq("4,5"))
+  end
+
+  it 'fixes quotation marks' do
+    expect("«mot»".ortho).to(eq("« mot »"))
+    expect("« mot »".ortho).to(eq("« mot »"))
+    expect("“ mot ”".ortho).to(eq("“mot”"))
+    expect("‘ mot ’".ortho).to(eq("‘mot’"))
+    expect("‹ mot ›".ortho).to(eq("‹mot›"))
+    expect("\" mot \"".ortho).to(eq("\"mot\""))
+    expect("' mot '".ortho).to(eq("'mot'"))
+  end
+
+  it 'fixes percent' do
+    expect("10%".ortho).to(eq("10 %"))
+    expect("10 %".ortho).to(eq("10 %"))
+  end
+
+  # https://www.scribbr.fr/elements-linguistiques/les-espaces/
+  it 'tests de Justine Debret' do
+    expect("Elle a vu son cousin,sa tante et son oncle.Ils allaient tous très bien.".ortho).to(eq("Elle a vu son cousin, sa tante et son oncle. Ils allaient tous très bien."))
+    expect("Elle dit: qui voudrait bien venir voir ce film? Il répond: moi; à moins qu’il ne fasse très beau!".ortho).to(eq("Elle dit : qui voudrait bien venir voir ce film ? Il répond : moi ; à moins qu’il ne fasse très beau !"))
+    expect("L’ hiver ne va pas durer toute l’année.".ortho).to(eq("L’hiver ne va pas durer toute l’année."))
+    expect("Elle ne disait plus rien…jusqu’au moment du repas.".ortho).to(eq("Elle ne disait plus rien… jusqu’au moment du repas."))
+    expect("Il a dit : «J’arrive ce matin ( ou plus tard ) à Paris [ rue de la République ] pour son anniversaire.»".ortho).to(eq("Il a dit : « J’arrive ce matin (ou plus tard) à Paris [rue de la République] pour son anniversaire. »"))
+    # Le test suivant n'est pas automatisable, parce qu'on ne peut distinguer un Paris-Brest (le gâteau) d'un Paris - Brest (le trajet)
+    # expect("Nous l’avons rencontré à Saint - Martin.".ortho).to(eq("Nous l’avons rencontré à Saint-Martin."))
+    # Le test suivant est-il automatisable ?
+    # expect("Il roule pendant 31, 5km.".ortho).to(eq("Il roule pendant 31,5 km."))
+    # Pas automatisable, rien ne permet de distinguer s'il s'agit d'un rang ou d'un nombre
+    # expect("Il en compte 1,000, 10,000, 36,742, 500,000, puis 1,000,000, 25,000,000, etc.".ortho).to(eq("Il en compte 1 000, 10 000, 36 742, 500 000, puis 1 000 000, 25 000 000, etc."))
+    # expect("Le numéro gagnant est le 3 541 672.".ortho).to(eq("Le numéro gagnant est le 3541672."))
+  end
+end

data/spec/localizer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Orthotypo do
+  it 'selects proper locale' do
+    expect(Orthotypo::Localizer.new('').composer).to be_a Orthotypo::Composer::Fr
+    expect(Orthotypo::Localizer.new('', locale: 'fr').composer).to be_a Orthotypo::Composer::Fr
+    expect(Orthotypo::Localizer.new('', locale: 'fr-FR').composer).to be_a Orthotypo::Composer::FrFr
+    expect(Orthotypo::Localizer.new('', locale: 'fr-CH').composer).to be_a Orthotypo::Composer::FrCh
+    expect(Orthotypo::Localizer.new('', locale: 'en').composer).to be_a Orthotypo::Composer::En
+    expect(Orthotypo::Localizer.new('', locale: 'en-GB').composer).to be_a Orthotypo::Composer::EnGb
+    expect(Orthotypo::Localizer.new('', locale: 'en-UNKNOWN').composer).to be_a Orthotypo::Composer::Fr
+  end
+end

data/spec/orthotypo_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Orthotypo do
+  it 'leaves html entities untouched' do
+    expect("test & test".ortho).to eq "test & test"
+  end
+  
+  it 'leaves html tags untouched' do
+    expect("<b>bold</b>".ortho).to eq "<b>bold</b>"
+  end
+
+  it 'leaves URLs untouched' do
+    expect("https://unsplash.com/@lusvardi?utm_source=osuny".ortho).to eq "https://unsplash.com/@lusvardi?utm_source=osuny"
+    expect("<a href=\"https://unsplash.com/@lusvardi?utm_source=osuny\">https://unsplash.com/@lusvardi?utm_source=osuny</a>".ortho).to eq "<a href=\"https://unsplash.com/@lusvardi?utm_source=osuny\">https://unsplash.com/@lusvardi?utm_source=osuny</a>"
+  end
+
+  it 'leaves URLs untouched' do
+    expect("prenom.nom@example.com".ortho).to eq "prenom.nom@example.com"
+    expect("<a href=\"mailto:prenom.nom@example.com\">prenom.nom@example.com</a>".ortho).to eq "<a href=\"mailto:prenom.nom@example.com\">prenom.nom@example.com</a>"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'byebug'
+require 'Orthotypo'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orthotypo
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Arnaud Levy
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +88,37 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/orthotypo.rb
+- lib/orthotypo/analyzer.rb
+- lib/orthotypo/composer.rb
+- lib/orthotypo/composer/en.rb
+- lib/orthotypo/composer/en_gb.rb
+- lib/orthotypo/composer/fr.rb
+- lib/orthotypo/composer/fr_ch.rb
+- lib/orthotypo/composer/fr_fr.rb
+- lib/orthotypo/core_ext.rb
+- lib/orthotypo/localizer.rb
+- lib/orthotypo/version.rb
+- orthotypo.gemspec
+- sig/orthotypo.rbs
+- spec/analyzer_spec.rb
+- spec/composer/en_spec.rb
+- spec/composer/fr_spec.rb
+- spec/localizer_spec.rb
+- spec/orthotypo_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/noesya/orthotypo
 licenses:
 - MIT