standalone_typograf 2.0.2 → 3.0.0

data/lib/standalone_typograf.rb

@@ -1,58 +1,102 @@
 # encoding: UTF-8
 
-require 'standalone_typograf/version'
-require 'standalone_typograf/dasherize'
-require 'standalone_typograf/signs'
-require 'standalone_typograf/quotes'
-require 'standalone_typograf/dots'
-require 'standalone_typograf/endash'
-require 'standalone_typograf/nbspace'
-require 'standalone_typograf/fractions'
-
-module StandaloneTypograf
+require 'active_support/all'
+
+module StandaloneTypograf #:nodoc:
+  extend ActiveSupport::Autoload
+
+  @@processors = {}
+
+  class << self
+    # Processor registration like { :dasherize => StandaloneTypograf::Dasherize::Processor}
+    def register_processor(_module)
+      @@processors[_module.to_s.split('::').second.downcase.to_sym] = _module
+    end
+
+    def processors
+      @@processors
+    end
+  end
+
+  autoload :Version
+
+  eager_autoload do
+    autoload :Dashes
+    autoload :Mnemonics
+    autoload :Fractions
+    autoload :Nbspaces
+    autoload :Ellipsis
+    autoload :Quotes
+  end
+
+  include Dashes
+  include Mnemonics
+  include Fractions
+  include Nbspaces
+  include Ellipsis
+  include Quotes
+
+  ##
+  # === Options
+  # * mode [Symbol]
+  #   typograf supports <b>html</b> and </b>utf</b> mods.
+  #   The default one is UTF. It means all special symbols
+  #   will be represents as UTF sequence.
+  #
   class Typograf
-    include StandaloneTypograf::Dasherize
-    include StandaloneTypograf::Signs
-    include StandaloneTypograf::Quotes
-    include StandaloneTypograf::Dots
-    include StandaloneTypograf::Endash
-    include StandaloneTypograf::Nbspace
-    include StandaloneTypograf::Fractions
+    attr_accessor :text
+    attr_reader   :mode
 
     def initialize(text, options={})
-      options[:signs] ||= SIGNS
-      options[:signs_ru] ||= SIGNS_RU
-      options[:quotes] ||= QUOTES
-      # except - массив с названием методов, которые необходимо исключить при выполнении
-      # *prepare*
-      @except = options[:except]
-      @signs, @signs_ru = SIGNS.merge(options[:signs]), SIGNS_RU.merge(options[:signs_ru])
-      @quotes = QUOTES.merge(options[:quotes])
+      options.assert_valid_keys(:mode, :exclude)
       @text = text
+      @mode = validate_option(options[:mode].try(:to_sym), in: [:html, :utf]) || :utf
+      exclude(options[:exclude]) if options[:exclude].present?
+    end
+
+    # Call a <b>separate</b> processor or <b>several</b> processors
+    # @return [String] 
+    def processor(*names)
+      names.each do |name|
+        validate_option(name, in: processors.keys)
+        processors[name].send(:compile, text, mode)
+      end
+      return text
+    end
+
+    # @return [Hash]
+    def processors
+      @processors ||= StandaloneTypograf.processors.deep_dup
     end
 
+    # @return [String]
     def prepare
-      call_method :dasherize
-      call_method :signs
-      call_method :quotes
-      call_method :dots
-      call_method :endash
-      call_method :nbspace
-      call_method :fractions
-      @text
+      processor(*processors.keys)
+    end
+
+    def exclude(list)
+      list = Array(list) unless list.is_a?(Array)
+      list.each do |name|
+        validate_option(name, in: processors.keys)
+        processors.delete(name)
+      end
     end
 
-    # PRIVATE
-    #
     private
 
-    # Выполняет метод только если он не был передан в параметре 'except'
-    # при создании объекта.
-    #
-    def call_method(name)
-      if @except.nil? || !@except.include?(name)
-        self.send(name)
+      # Validate initialization options that have been passed thought the params.
+      # 
+      # Available validations:
+      #   * in [Array] 
+      #     provided param should be in array, for example:
+      #    `validate_option(:hello, in: [:hello, :world])`
+      #
+      def validate_option(param, options={})
+        return unless param.present?
+        if options[:in].present?
+          raise ArgumentError.new("Wrong argument `#{param}`, should be in `#{options[:in].join(', ')}`") unless options[:in].include?(param)
+        end
+        return param
       end
-    end
   end
 end

data/spec/processors/dashes_spec.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Dashes::Processor do
+
+  def typograf(text, mode)
+    described_class::compile(text, mode)
+  end
+
+  texts = {
+    :utf => [
+      ['Сушка - процесс удаления влаги', 'Сушка — процесс удаления влаги'],
+      ['- А что Казбич? - спросил я', '— А что Казбич? — спросил я'],
+    ],
+    :html => [
+      ['Вода - бинарное неорганическое соединение', 'Вода — бинарное неорганическое соединение'],
+      ['- Как пройти в библиотеку?', '— Как пройти в библиотеку?'],
+      ['1-1=0', '1-1=0'], # no changes
+      ['-1', '-1'], # no changes
+    ]
+  }
+
+  it 'works' do 
+    texts.each_pair do |mode, array|
+      array.each do|text_pair|  
+        typograf(text_pair[0], mode).should == text_pair[1]
+      end
+    end 
+  end
+end

data/spec/processors/ellipsis_spec.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Ellipsis::Processor do
+
+  def typograf(text, mode)
+    described_class::compile(text, mode)
+  end
+
+  texts = {
+    :utf => [
+      ['He was sleeping... Hey! You..',  'He was sleeping… Hey! You..']
+    ],
+    :html => [
+      ['Он молчал... ', 'Он молчал… '],
+      ['1...3', '1...3'], # should not work with digits
+    ]
+  }
+
+  it 'works' do 
+    texts.each_pair do |mode, array|
+      array.each do|text_pair|  
+        typograf(text_pair[0], mode).should == text_pair[1]
+      end
+    end 
+  end
+end

data/spec/processors/fractions_spec.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Fractions::Processor do
+
+  it 'works on Html mode' do
+    described_class.compile(' 134/334', :html).should == ' <sup>134</sup>&frasl;<sub>334</sub>'
+  end
+
+  it 'does not on Utf mode' do
+    described_class.compile('2/4', :utf).should == '2/4'
+  end
+
+  it 'does not when last char is not space' do
+    described_class.compile('2/4*', :html).should == '2/4*'
+  end
+end

data/spec/processors/mnemonics_spec.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Mnemonics::Processor do
+
+  def typograf(text, mode)
+    described_class::compile(text, mode)
+  end
+
+  texts = {
+    # in <b>utf</b> section please test signs on English
+    :utf => [
+      ['Cafero (c) 2013', 'Cafero © 2013'],
+      ['iPhone (r)', 'iPhone ®'],
+      ['Право -> там', 'Право → там'],
+      ['Температура ~= 10', 'Температура ≈ 10'],
+    ],
+    # in <b>html</b> section please test signs on Russian
+    :html => [
+      ['(tm) Windows', '&trade; Windows'],
+      ['Принеси +- 1 штуку', 'Принеси &plusmn; 1 штуку'],
+      ['Лево <- там', 'Лево &larr; там'],
+    ]
+  }
+
+  it 'works' do 
+    texts.each_pair do |mode, array|
+      array.each do|text_pair|  
+        typograf(text_pair[0], mode).should == text_pair[1]
+      end
+    end 
+  end
+end

data/spec/processors/nbspaces_spec.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Nbspaces::Processor do
+
+  def typograf(text, mode)
+    described_class::compile(text, mode)
+  end
+
+  texts = {
+    :utf => [
+        ['В Украине', 'В Украине']
+    ],
+    :html => [
+      ['Форточка в окне', 'Форточка в окне'],
+      ['Иди по краю', 'Иди по краю'],
+      ['Исключительно Великолепно', 'Исключительно Великолепно'],
+      ['Пить - здоровью предить', 'Пить - здоровью предить'],
+      ['Лес — источник древесины', 'Лес — источник древесины'],
+    ]
+  }
+
+  it 'works' do 
+    texts.each_pair do |mode, array|
+      array.each do|text_pair|  
+        typograf(text_pair[0], mode).should == text_pair[1]
+      end
+    end 
+  end
+end

data/spec/processors/quotes_spec.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Quotes::Processor do
+
+  def typograf(text, mode)
+    described_class::compile(text, mode)
+  end
+
+  texts = {
+    :utf => [
+      ['Он сказал: "Привет, Михалыч"', 'Он сказал: «Привет, Михалыч»'],
+      [' "Михась! Или "Мишаня", а?!",- крикнул он ', ' «Михась! Или „Мишаня“, а?!»,- крикнул он '],
+      ['"Привет тебе, "Путник""', '«Привет тебе, „Путник“»'],
+      ['""Гномы", - вскрикнул Бильбо", - сказал Толкиен', '«„Гномы“, - вскрикнул Бильбо», - сказал Толкиен'],
+      ['"Один", "Два", "Три"', '«Один», «Два», «Три»']
+    ],
+    :html => [
+      ['"Привет"', '«Привет»' ],
+      ['"Два "вида" "кавычек"" "Жесть"', '«Два „вида“ „кавычек“» «Жесть»' ],
+    ]
+  }
+
+  it 'works' do 
+    texts.each_pair do |mode, array|
+      array.each do|text_pair|  
+        typograf(text_pair[0], mode).should == text_pair[1]
+      end
+    end 
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+require 'standalone_typograf'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/standalone_typograf_spec.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf do
+
+  describe 'implementation' do 
+    it 'registers processors' do
+      described_class.processors.length.should > 0
+    end
+  end
+end

data/spec/typograf_spec.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe StandaloneTypograf::Typograf do
+
+  context 'argument errors' do
+    describe 'options validation' do
+      def with_otion(key, value)
+        described_class.new('', key => value)
+      end
+
+      it { expect { with_otion(:mode, :stub) }.to    raise_error(ArgumentError) }
+      it { expect { with_otion(:exclude, :stub) }.to raise_error(ArgumentError) }
+    end
+  end
+
+  context 'arguments' do
+    describe 'modes' do
+      it 'has UTF-mode by default' do
+        t = described_class.new('')
+        t.mode.should == :utf
+      end
+
+      it 'can be passed as param' do
+        t = described_class.new('', mode: :html)
+        t.mode.should == :html
+      end
+    end
+
+    describe 'exclude' do
+      it 'excludes processor' do
+        t = described_class.new('', exclude: :dashes)
+        t.processors.include?(:dashes).should be_false
+      end
+    end
+  end
+
+  context 'implementation' do
+    describe '.processors' do
+      it 'raises an error on unknown processor' do
+        t = described_class.new('')
+        expect { t.processor(:unknown) }.to raise_error(ArgumentError)
+      end
+
+      it 'response on separate processor' do
+        t = described_class.new('Типограф - это круто, +-', mode: :html)
+        t.processor(:mnemonics).should == 'Типограф - это круто, ±'
+      end
+
+      it 'response on several processors' do
+        t = described_class.new('Типограф - это круто, +-', mode: :html)
+        t.processor(:mnemonics, :dashes).should == 'Типограф — это круто, ±'
+      end
+    end
+  end
+end

data/standalone_typograf.gemspec

@@ -1,5 +1,4 @@
-#encoding: UTF-8
-
+# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'standalone_typograf/version'
@@ -11,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = 'sashapashamasha@gmail.com'
   spec.description   = "Standalone (offline) client of the ArtLebedev's Studio Typograf service. http://typograf.herokuapp.com"
   spec.summary       = 'Very Fast&Simple Typograf fot the Russian text.'
-  spec.homepage      = 'https://github.com/shlima/StandaloneTypograf'
+  spec.homepage      = 'https://github.com/shlima/standalone_typograf'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -21,4 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'fuubar'
+
+  spec.add_runtime_dependency 'activesupport'
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: standalone_typograf
 version: !ruby/object:Gem::Version
-  version: 2.0.2
-  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors:
 - Alex Shilov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-20 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +27,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: fuubar
+  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: activesupport
+  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'
 description: Standalone (offline) client of the ArtLebedev's Studio Typograf service.
@@ -50,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
 - .gitignore
-- .rvmrc
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -61,60 +98,54 @@ files:
 - doc/logo.png
 - doc/logo.psd
 - lib/standalone_typograf.rb
-- lib/standalone_typograf/dasherize.rb
-- lib/standalone_typograf/dots.rb
-- lib/standalone_typograf/endash.rb
+- lib/standalone_typograf/dashes.rb
+- lib/standalone_typograf/ellipsis.rb
 - lib/standalone_typograf/fractions.rb
-- lib/standalone_typograf/nbspace.rb
+- lib/standalone_typograf/mnemonics.rb
+- lib/standalone_typograf/nbspaces.rb
 - lib/standalone_typograf/quotes.rb
-- lib/standalone_typograf/signs.rb
 - lib/standalone_typograf/version.rb
+- spec/processors/dashes_spec.rb
+- spec/processors/ellipsis_spec.rb
+- spec/processors/fractions_spec.rb
+- spec/processors/mnemonics_spec.rb
+- spec/processors/nbspaces_spec.rb
+- spec/processors/quotes_spec.rb
+- spec/spec_helper.rb
+- spec/standalone_typograf_spec.rb
+- spec/typograf_spec.rb
 - standalone_typograf.gemspec
-- test/test_dash.rb
-- test/test_dots.rb
-- test/test_endash.rb
-- test/test_fractions.rb
-- test/test_nbspace.rb
-- test/test_prepare.rb
-- test/test_quotes.rb
-- test/test_signs.rb
-homepage: https://github.com/shlima/StandaloneTypograf
+homepage: https://github.com/shlima/standalone_typograf
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1958121828042888037
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1958121828042888037
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Very Fast&Simple Typograf fot the Russian text.
 test_files:
-- test/test_dash.rb
-- test/test_dots.rb
-- test/test_endash.rb
-- test/test_fractions.rb
-- test/test_nbspace.rb
-- test/test_prepare.rb
-- test/test_quotes.rb
-- test/test_signs.rb
+- spec/processors/dashes_spec.rb
+- spec/processors/ellipsis_spec.rb
+- spec/processors/fractions_spec.rb
+- spec/processors/mnemonics_spec.rb
+- spec/processors/nbspaces_spec.rb
+- spec/processors/quotes_spec.rb
+- spec/spec_helper.rb
+- spec/standalone_typograf_spec.rb
+- spec/typograf_spec.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@standalone_typograf --create

data/lib/standalone_typograf/dasherize.rb

@@ -1,12 +0,0 @@
-# encoding: UTF-8
-
-module StandaloneTypograf
-  module Dasherize
-    def dasherize
-      # В ситуации, когда тире с отбивкой с обоих сторон,
-      # левый пробел - неразрывный.
-      @text = @text.gsub(/\s-\s/i, ' — ')
-      @text = @text.gsub(/- /i, '— ')
-    end
-  end
-end

data/lib/standalone_typograf/dots.rb

@@ -1,9 +0,0 @@
-# encoding: UTF-8
-
-module StandaloneTypograf
-  module Dots
-    def dots
-      @text = @text.gsub(/[.][.][.]/i, '…')
-    end
-  end
-end

data/lib/standalone_typograf/endash.rb

@@ -1,9 +0,0 @@
-# encoding: UTF-8
-
-module StandaloneTypograf
-  module Endash
-    def endash
-      @text = @text.gsub(/(\d+)([-])(\d+)/i, '\1'+'–'+'\3')
-    end
-  end
-end