improve_typography 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5b3b3bf0752a4501e4412ef570b94d69b527c27
+  data.tar.gz: e3bd253d727c4cfc48edc76e97d497a718e095a1
+SHA512:
+  metadata.gz: 43cf82d01e7aa50d8eb8abd4c19d3caa3a31739f4762598ae3353d2e10d2bc513b5e39a48f56dc4024b90d76f75e54caeeb937f18f5f7fea9b64a4c0f93d64b3
+  data.tar.gz: 52fa0221abc1a9a085c7327de4e6082fa6cc93cbeb1024e8084b9b6293e9410fad6172844e21608927630db862f66e30326665f4eda1daf9d627a88df0ee86bb

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+script: 'bundle exec rake'
+rvm:
+  - 2.2.5
+before_install:
+  - gem install bundler -v 1.12.5
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in improve_typography.gemspec
+gemspec
+
+gem 'rb-readline'

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomas Celizna
+
+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,124 @@
+# Improve Typography
+
+[![Build Status](https://travis-ci.org/tomasc/improve_typography.svg)](https://travis-ci.org/tomasc/improve_typography) [![Gem Version](https://badge.fury.io/rb/improve_typography.svg)](http://badge.fury.io/rb/improve_typography) [![Coverage Status](https://img.shields.io/coveralls/tomasc/improve_typography.svg)](https://coveralls.io/r/tomasc/improve_typography)
+
+Improves typography (quotes, hyphens, etc.) of a given string. Works well with I18n.
+
+Easy to extend by the way of locale files and processors. **Pull requests are welcome!**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'improve_typography'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install improve_typography
+
+## Usage
+
+```ruby
+ImproveTypography::Base.call("'so it isn't authorless'") # => "‘so it isn’t authorless’"
+```
+
+Only text inside XHTML tags is corrected (quotes around attributes etc. are preserved).
+
+### Locale
+
+The replacements are locale-specific (corresponding to `I18n.locale`), with a fallback to default `:en`.
+
+Locale can be also provided locally as:
+
+```ruby
+ImproveTypography::Base.call("'so it isn't authorless'", locale: :cs)
+```
+
+### Extending locales
+
+There are two options how to provide locale-specific replacements:
+
+#### Via locale files (preferred)
+
+Create or override locale files in your application. See the locale files in the `locales` folder.
+
+#### Via custom class
+
+For more complex replacements, where the above method is not sufficient, it is possible to create locale-specific classes and override default behavior. For example:
+
+```ruby
+module ImproveTypography
+  module Processors
+    module CS # locale name in upcase
+      class SingleQuotes < Processor
+        def call
+          # custom behavior
+        end
+      end
+    end
+  end
+end
+```
+
+### Configuation
+
+You can configure applied processors (and their order).
+
+#### Globally
+
+```ruby
+ImproveTypography.configure do |config|
+  processors = [ImproveTypography::Processors::Ellipsis]
+end
+```
+
+#### Locally
+
+```ruby
+ImproveTypography::Base.call("'so it isn't authorless'", processors: [ImproveTypography::Processors::Ellipsis])
+```
+
+## Available processors
+
+* `Apostrophe`
+* `DoubleQuotes`
+* `Ellipsis`
+* `EmDash`
+* `EnDash`
+* `MultiplySign`
+* `Numbers`
+* `SingleQuotes`
+* `Units`
+* `WordLineSeparator`
+
+## Supported locales
+
+* `:en` (Int. English)
+* `:cs` (Czech)
+
+## Resources and inspiration
+
+* [SmartyPants](https://michelf.ca/projects/php-smartypants)
+* [Truty](https://github.com/mkj-is/Truty)
+* [Typogruby](https://avdgaag.github.io/typogruby)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tomasc/improve_typography.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "improve_typography"
+
+# 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

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/improve_typography.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'improve_typography/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'improve_typography'
+  spec.version       = ImproveTypography::VERSION
+  spec.authors       = ['Tomas Celizna']
+  spec.email         = ['tomas.celizna@gmail.com']
+
+  spec.summary       = 'Improves typography (quotes, hyphens, etc.) of a given string. Works well with I18n.'
+  spec.homepage      = 'https://github.com/tomasc/improve_typography'
+  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 'i18n'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/config/locales/cs.yml

@@ -0,0 +1,4 @@
+cs:
+  improve_typography:
+    single_quotes: '‚‘'
+    double_quotes: '„“'

data/lib/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  improve_typography:
+    apostrophe_sign: 'ʼ'
+    ellipsis_sign: '…'
+    multiply_sign: ' × '
+    em_dash_sign: '—'
+    en_dash_sign: ' – '
+    single_quotes: '‘’'
+    double_quotes: '“”'

data/lib/improve_typography/base.rb

@@ -0,0 +1,61 @@
+require 'nokogiri'
+
+module ImproveTypography
+  class Base < Struct.new(:str, :options)
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(str, options = {})
+      super(str, options)
+    end
+
+    def call
+      text_nodes.each do |node|
+        processor_classes.each do |processor|
+          node.content = processor.call(node.content, options)
+        end
+      end
+
+      CGI.unescapeHTML doc.to_html.gsub(/\A<div>/, '').gsub(/<\/\s*div>\z/, '').chomp
+    end
+
+    private # =============================================================
+
+    def doc
+      @doc ||= Nokogiri::HTML::DocumentFragment.parse("<div>#{str}</div>")
+    end
+
+    def text_nodes
+      doc.xpath('.//text()')
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def processors
+      options.fetch(:processors, configuration.processors)
+    end
+
+    def processor_classes
+      @processor_classes ||= processors.map do |klass|
+        processor_for_locale(klass)
+      end
+    end
+
+    def all_processor_classes
+      @all_processor_classes ||= ObjectSpace.each_object(Class).select { |klass| klass < Processor }
+    end
+
+    def processor_for_locale(klass)
+      name = klass.to_s.split('::').last
+      locale_specific_klass = "ImproveTypography::Processors::#{locale.to_s.upcase}::#{name}"
+      all_processor_classes.detect { |cls| cls.to_s == locale_specific_klass } || klass
+    end
+
+    def locale
+      options.fetch(:locale, I18n.locale)
+    end
+  end
+end

data/lib/improve_typography/configuration.rb

@@ -0,0 +1,22 @@
+require 'i18n'
+
+module ImproveTypography
+  class Configuration
+    attr_accessor :processors
+
+    def initialize
+      @processors = [
+        Processors::WordLineSeparator,
+        Processors::Ellipsis,
+        Processors::EnDash,
+        Processors::EmDash,
+        Processors::MultiplySign,
+        Processors::Numbers,
+        Processors::SingleQuotes,
+        Processors::DoubleQuotes,
+        Processors::Apostrophe,
+        Processors::Units
+      ]
+    end
+  end
+end

data/lib/improve_typography/processor.rb

@@ -0,0 +1,25 @@
+module ImproveTypography
+  class Processor < Struct.new(:str, :options)
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(str, options = {})
+      super(str, options)
+    end
+
+    def call
+      str
+    end
+
+    private
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def locale
+      options.fetch :locale, I18n.locale
+    end
+  end
+end

data/lib/improve_typography/processors/apostrophe.rb

@@ -0,0 +1,21 @@
+module ImproveTypography
+  module Processors
+    class Apostrophe < Processor
+      REGEXP = /(\w+)'(\w*)/i
+
+      def call
+        replace_apostrophe
+      end
+
+      private
+
+      def replace_apostrophe
+        str.gsub(REGEXP, "\\1#{apostrophe_sign}\\2")
+      end
+
+      def apostrophe_sign
+        options.fetch(:apostrophe_sign, I18n.t(:apostrophe_sign, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/double_quotes.rb

@@ -0,0 +1,21 @@
+module ImproveTypography
+  module Processors
+    class DoubleQuotes < Processor
+      REGEXP = /["](.*)["]/i
+
+      def call
+        replace_double_quotes
+      end
+
+      private
+
+      def replace_double_quotes
+        str.gsub(REGEXP, "#{double_quotes[0]}\\1#{double_quotes[1]}" )
+      end
+
+      def double_quotes
+        options.fetch(:double_quotes, I18n.t(:double_quotes, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/ellipsis.rb

@@ -0,0 +1,19 @@
+module ImproveTypography
+  module Processors
+    class Ellipsis < Processor
+      REGEXP = /\.{3,}/i
+
+      def call
+        return str unless ellipsis_sign
+
+        str.gsub(REGEXP, ellipsis_sign)
+      end
+
+      private
+
+      def ellipsis_sign
+        options.fetch(:ellipsis_sign, I18n.t(:ellipsis_sign, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/em_dash.rb

@@ -0,0 +1,17 @@
+module ImproveTypography
+  module Processors
+    class EmDash < Processor
+      REGEXP = /(\w+?)\s+-{1,3}\s+(\w+?)/i
+
+      def call
+        str.gsub(REGEXP, '\1'+em_dash_sign+'\2')
+      end
+
+      private
+
+      def em_dash_sign
+        options.fetch(:em_dash_sign, I18n.t(:em_dash_sign, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/en_dash.rb

@@ -0,0 +1,17 @@
+module ImproveTypography
+  module Processors
+    class EnDash < Processor
+      REGEXP = /(\w+?)\s+-{1,2}\s+(\w+?)/i
+
+      def call
+        str.gsub(REGEXP, '\1'+en_dash_sign+'\2')
+      end
+
+      private
+
+      def en_dash_sign
+        options.fetch(:en_dash_sign, I18n.t(:en_dash_sign, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/multiply_sign.rb

@@ -0,0 +1,19 @@
+module ImproveTypography
+  module Processors
+    class MultiplySign < Processor
+      REGEXP = /(\d+)(\s*)x(\s*)(\d+)/i
+
+      def call
+        return str unless multiply_sign
+
+        str.gsub(REGEXP, '\1'+multiply_sign+'\4')
+      end
+
+      private
+
+      def multiply_sign
+        options.fetch(:multiply_sign, I18n.t(:multiply_sign, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/numbers.rb

@@ -0,0 +1,6 @@
+module ImproveTypography
+  module Processors
+    class Numbers < Processor
+    end
+  end
+end

data/lib/improve_typography/processors/single_quotes.rb

@@ -0,0 +1,21 @@
+module ImproveTypography
+  module Processors
+    class SingleQuotes < Processor
+      REGEXP = /['](.*)[']/i
+
+      def call
+        replace_single_quotes
+      end
+
+      private
+
+      def replace_single_quotes
+        str.gsub(REGEXP, "#{single_quotes[0]}\\1#{single_quotes[1]}")
+      end
+
+      def single_quotes
+        options.fetch(:single_quotes, I18n.t(:single_quotes, scope: %i(improve_typography), locale: locale))
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/units.rb

@@ -0,0 +1,11 @@
+module ImproveTypography
+  module Processors
+    class Units < Processor
+      REGEXP = /(\d\s*)(m|mm|cm|km)(2|3)/
+
+      def call
+        str.gsub(REGEXP, '\1\2<sup>\3</sup>')
+      end
+    end
+  end
+end

data/lib/improve_typography/processors/word_line_separator.rb

@@ -0,0 +1,11 @@
+module ImproveTypography
+  module Processors
+    class WordLineSeparator < Processor
+      REGEXP = /\u2028/
+
+      def call
+        str.gsub(REGEXP, "\n")
+      end
+    end
+  end
+end

data/lib/improve_typography/version.rb

@@ -0,0 +1,3 @@
+module ImproveTypography
+  VERSION = '0.1.0'.freeze
+end

data/lib/improve_typography.rb

@@ -0,0 +1,13 @@
+require 'i18n'
+require 'i18n/backend/fallbacks'
+
+require 'improve_typography/base'
+require 'improve_typography/configuration'
+require 'improve_typography/processor'
+
+Dir["#{File.dirname(__FILE__)}/improve_typography/processors/**/*.rb"].each { |f| require f }
+
+I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+I18n.load_path += Dir.glob(File.join( File.dirname(__FILE__), 'config', 'locales', '*.yml' ))
+
+require 'improve_typography/version'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: improve_typography
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: 
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- improve_typography.gemspec
+- lib/config/locales/cs.yml
+- lib/config/locales/en.yml
+- lib/improve_typography.rb
+- lib/improve_typography/base.rb
+- lib/improve_typography/configuration.rb
+- lib/improve_typography/processor.rb
+- lib/improve_typography/processors/apostrophe.rb
+- lib/improve_typography/processors/double_quotes.rb
+- lib/improve_typography/processors/ellipsis.rb
+- lib/improve_typography/processors/em_dash.rb
+- lib/improve_typography/processors/en_dash.rb
+- lib/improve_typography/processors/multiply_sign.rb
+- lib/improve_typography/processors/numbers.rb
+- lib/improve_typography/processors/single_quotes.rb
+- lib/improve_typography/processors/units.rb
+- lib/improve_typography/processors/word_line_separator.rb
+- lib/improve_typography/version.rb
+homepage: https://github.com/tomasc/improve_typography
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Improves typography (quotes, hyphens, etc.) of a given string. Works well
+  with I18n.
+test_files: []