improve_typography 0.1.13 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a15353e5f98379ad53b4cba25f1bb06a9e871d87525400cbcaef028288a3b7cb
-  data.tar.gz: 6449e0f1ef011b5178d8a9a9429b7854d22875e44048f191313d11bfe1bd9163
+  metadata.gz: d6d3cfe8e809e1e21fcc9eb90c85e6eab6704d96160dab03e3708a88981ac0e9
+  data.tar.gz: 2e94d39063ec4ecadbdb034015adca8f70c3c6aae9167756696a38305b80a620
 SHA512:
-  metadata.gz: 5263165ffa75b7aad4ae268c52cd2f7db550997c9880a645db074ef16756990abb77c45333db1cc43029fc462735894c517377bfecadf81d091b12027848e0f3
-  data.tar.gz: 99035ac8f242688c1b3171672ec16e63045d60f5d702bc0be3b561c8a343bfee1792e1d97702dbddc8e62ed6c33a55d9dc0816c3be869345540f7bc988026f9a
+  metadata.gz: f4104301d85835ceabe273e522c690dfdd24d19ee644fc98d2864fa2261c241ac0a705e622c7d741fedff1aa633270d4e8fd05b4dafc18a46272c6091939f771
+  data.tar.gz: 559c315c4eef1bd0ea29634d84aa02c9d9560119c5cd5cf135ba6147fd5cdced0038dbf71cf724aab645005f7df6f48a1765d14161255be0f83a00b5ec3255c4

data/.travis.yml

@@ -2,7 +2,7 @@ sudo: false
 language: ruby
 script: 'bundle exec rake'
 rvm:
-  - 2.2.5
+  - 2.5.1
 before_install:
   - gem install bundler -v 1.12.5
 notifications:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 0.1.16
+
+* guard for missing `i18n` translations (@asgerb)
+* refactor inheritance logic (@asgerb)
+
+## 0.1.15
+
+* fix the `ImproveTypography.configure` method
+
+## 0.1.14
+
+* first run simplest `match?` before `gsub` to make sure the replacement is actually needed
+
 ## 0.1.13
 
 * skip processing if no processor classes defined

data/README.md

@@ -74,7 +74,7 @@ You can configure applied processors (and their order).
 
 ```ruby
 ImproveTypography.configure do |config|
-  processors = [ImproveTypography::Processors::Ellipsis]
+  config.processors = [ImproveTypography::Processors::Ellipsis]
 end
 ```
 

data/improve_typography.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'i18n'
   spec.add_dependency 'nokogiri'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'bundler'
   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'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/lib/config/locales/da.yml

@@ -0,0 +1,2 @@
+da:
+  foo: bar

data/lib/improve_typography/base.rb

@@ -2,8 +2,20 @@ require 'nokogiri'
 
 module ImproveTypography
   class Base < Struct.new(:str, :options)
-    def self.call(*args)
-      new(*args).call
+    class << self
+      def all_processor_classes
+        @@all_processor_classes ||= []
+      end
+
+      def add_processor_class(klass)
+        unless all_processor_classes.include?(klass)
+          all_processor_classes << klass
+        end
+      end
+
+      def call(*args)
+        new(*args).call
+      end
     end
 
     def initialize(str, options = {})
@@ -30,12 +42,8 @@ module ImproveTypography
       @doc ||= Nokogiri::HTML::DocumentFragment.parse("<div>#{str}</div>")
     end
 
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
     def processors
-      options.fetch(:processors, configuration.processors)
+      options.fetch(:processors, ImproveTypography.configuration.processors)
     end
 
     def processor_classes
@@ -45,7 +53,7 @@ module ImproveTypography
     end
 
     def all_processor_classes
-      @all_processor_classes ||= ObjectSpace.each_object(Class).select { |klass| klass < Processor }
+      self.class.all_processor_classes
     end
 
     def processor_for_locale(klass)

data/lib/improve_typography/processor.rb

@@ -1,7 +1,14 @@
 module ImproveTypography
   class Processor < Struct.new(:str, :options)
-    def self.call(*args)
-      new(*args).call
+    class << self
+      def call(*args)
+        new(*args).call
+      end
+
+      def inherited(klass)
+        ImproveTypography::Base.add_processor_class(klass)
+        super
+      end
     end
 
     def initialize(str, options = {})
@@ -14,6 +21,14 @@ module ImproveTypography
 
     private
 
+    def translation(key)
+      I18n.t(key, scope: %i(improve_typography), locale: locale)
+    end
+
+    def sign_exists?(sign)
+      !sign.nil? && !sign.match?(/translation missing/)
+    end
+
     def configuration
       @configuration ||= Configuration.new
     end

data/lib/improve_typography/processors/apostrophe.rb

@@ -4,6 +4,8 @@ module ImproveTypography
       REGEXP = /(\w+)'(\w*)/i
 
       def call
+        return str unless sign_exists?(apostrophe_sign)
+        return str unless str.match?(/'/)
         replace_apostrophe
       end
 
@@ -14,7 +16,7 @@ module ImproveTypography
       end
 
       def apostrophe_sign
-        options.fetch(:apostrophe_sign, I18n.t(:apostrophe_sign, scope: %i(improve_typography), locale: locale))
+        options.fetch(:apostrophe_sign, translation(:apostrophe_sign))
       end
     end
   end

data/lib/improve_typography/processors/double_quotes.rb

@@ -2,6 +2,8 @@ module ImproveTypography
   module Processors
     class DoubleQuotes < Processor
       def call
+        return str unless sign_exists?(double_quotes)
+        return str unless str.match?(/[\"#{double_quotes[0]}#{double_quotes[1]}]/)
         replace_double_quotes
       end
 
@@ -16,7 +18,7 @@ module ImproveTypography
       end
 
       def double_quotes
-        options.fetch(:double_quotes, I18n.t(:double_quotes, scope: %i(improve_typography), locale: locale))
+        options.fetch(:double_quotes, translation(:double_quotes))
       end
     end
   end

data/lib/improve_typography/processors/ellipsis.rb

@@ -4,7 +4,8 @@ module ImproveTypography
       REGEXP = /(\.\s*?){3,}/i
 
       def call
-        return str unless ellipsis_sign
+        return str unless sign_exists?(ellipsis_sign)
+        return str unless str.match?(REGEXP)
 
         str.gsub(REGEXP, ellipsis_sign)
       end
@@ -12,7 +13,7 @@ module ImproveTypography
       private
 
       def ellipsis_sign
-        options.fetch(:ellipsis_sign, I18n.t(:ellipsis_sign, scope: %i(improve_typography), locale: locale))
+        options.fetch(:ellipsis_sign, translation(:ellipsis_sign))
       end
     end
   end

data/lib/improve_typography/processors/em_dash.rb

@@ -4,13 +4,15 @@ module ImproveTypography
       REGEXP = /(\w+?)\s+-{1,3}\s+(\w+?)/i
 
       def call
+        return str unless sign_exists?(em_dash_sign)
+        return str unless str.match?(/-{1,3}/)
         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))
+        options.fetch(:em_dash_sign, translation(:em_dash_sign))
       end
     end
   end

data/lib/improve_typography/processors/en_dash.rb

@@ -4,13 +4,15 @@ module ImproveTypography
       REGEXP = /(\w+?)\s+-{1,2}\s+(\w+?)/i
 
       def call
+        return str unless sign_exists?(en_dash_sign)
+        return str unless str.match?(/-{1,3}/)
         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))
+        options.fetch(:en_dash_sign, translation(:en_dash_sign))
       end
     end
   end

data/lib/improve_typography/processors/multiply_sign.rb

@@ -4,7 +4,8 @@ module ImproveTypography
       REGEXP = /(\d+|[½⅓¼⅔⅛⅜⅝⅞])(\s*)x(\s*)(\d+|[½⅓¼⅔⅛⅜⅝⅞])/i
 
       def call
-        return str unless multiply_sign
+        return str unless sign_exists?(multiply_sign)
+        return str unless str.match?(REGEXP)
 
         str.gsub(REGEXP, '\1'+multiply_sign+'\4')
       end
@@ -12,7 +13,7 @@ module ImproveTypography
       private
 
       def multiply_sign
-        options.fetch(:multiply_sign, I18n.t(:multiply_sign, scope: %i(improve_typography), locale: locale))
+        options.fetch(:multiply_sign, translation(:multiply_sign))
       end
     end
   end

data/lib/improve_typography/processors/nbsp.rb

@@ -2,6 +2,8 @@ module ImproveTypography
   module Processors
     class Nbsp < Processor
       def call
+        return str unless str.match?(/(\A|\s+)(\S|\d+)([\.?!]?)(\s+|\z)/)
+
         str
           .gsub(/(\s+)(\S|\d+|\S\.)(\s+)(\S)/, '\1\2&nbsp;\4') # in the middle of string
           .gsub(/\A(\w|\d+|\w\.)(\s+)(\S)/, '\1&nbsp;\3') # at the beginning of string

data/lib/improve_typography/processors/single_quotes.rb

@@ -2,6 +2,8 @@ module ImproveTypography
   module Processors
     class SingleQuotes < Processor
       def call
+        return str unless sign_exists?(single_quotes)
+        return str unless str.match?(/[\'#{single_quotes[0]}#{single_quotes[1]}]/)
         replace_single_quotes
       end
 
@@ -16,7 +18,7 @@ module ImproveTypography
       end
 
       def single_quotes
-        options.fetch(:single_quotes, I18n.t(:single_quotes, scope: %i(improve_typography), locale: locale))
+        options.fetch(:single_quotes, translation(:single_quotes))
       end
     end
   end

data/lib/improve_typography/processors/units.rb

@@ -4,6 +4,7 @@ module ImproveTypography
       REGEXP = /(\d\s*)(m|mm|cm|km)(2|3)/
 
       def call
+        return str unless str.match?(REGEXP)
         str.gsub(REGEXP, '\1\2<sup>\3</sup>')
       end
     end

data/lib/improve_typography/processors/word_line_separator.rb

@@ -4,6 +4,7 @@ module ImproveTypography
       REGEXP = /\u2028/
 
       def call
+        return str unless str.match?(REGEXP)
         str.gsub(REGEXP, "\n")
       end
     end

data/lib/improve_typography/version.rb

@@ -1,3 +1,3 @@
 module ImproveTypography
-  VERSION = '0.1.13'.freeze
+  VERSION = '0.1.16'.freeze
 end

data/lib/improve_typography.rb

@@ -8,6 +8,24 @@ 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' ))
+I18n.load_path += Dir.glob(File.join(File.dirname(__FILE__), 'config', 'locales', '*.yml'))
 
 require 'improve_typography/version'
+
+module ImproveTypography
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: improve_typography
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.16
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-12 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: 
 email:
 - tomas.celizna@gmail.com
@@ -127,6 +127,7 @@ files:
 - bin/setup
 - improve_typography.gemspec
 - lib/config/locales/cs.yml
+- lib/config/locales/da.yml
 - lib/config/locales/en.yml
 - lib/improve_typography.rb
 - lib/improve_typography/base.rb
@@ -163,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Improves typography (quotes, hyphens, etc.) of a given string. Works well