typefactory 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74e9982c0c479738a2eff67898054cec39372d32
+  data.tar.gz: 74fed332d7ea2a61d3cd9cc883ca195c2f840578
+SHA512:
+  metadata.gz: 88bfa03086c7e5d967fabd2b5d8b330db826bd5eaa2e9095fc349590184b802bc85f168d2f96584b56e0629aacd9d75425cc0dc15a473e96cd0248d5f910be69
+  data.tar.gz: fad05207ff3b16574d110d641309cd6b2096f12210269b7bc262ccc5cb7137c38ecf4741beb2e563012b096e720aab5776c95e6daad7ab79bdae4d126db9c89b

data/.gitignore

@@ -0,0 +1,23 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.yardopts

@@ -0,0 +1,2 @@
+--private
+--protected

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright 2014 Evgeny Boyko, Boandmedia
+
+MIT License
+
+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,44 @@
+# Typefactory
+
+This simple plugin helps you to prepare your texts for publishing on the web. Typefactory was created for Russian grammar and punctuation but can be used in other languages (such as English or German).
+
+_This is my first gem and I'll be glad to hear from you any advices about Ruby/Rails as well as about my English :-)_
+
+## Abilities
+
+Current beta version has only methods for processing three levels of quote marks. All used glyphs can be customized.
+
+## Install
+
+### Ruby on Rails
+
+	$ gem "typefactory", "~> 0.0.10"
+	$ bundle install
+	
+
+### Extension for `String`
+
+Typefactory adds method `prepare` for standard Ruby class `String`. You can use this feature as well as default way.
+
+	'Some text here'.prepare
+	<%= @description.prepare %>
+
+
+## Customize
+
+Need customization? Please use generator:
+	$ rails generate typefactory config
+Now you can modify `config/initializers/typefactory.rb`
+
+## Help to improve
+
+If you have text where parsing algorithm makes mistakes, send it to me (eboyko@eboyko.ru), please.
+
+## Contribute
+
+1. Fork it https://github.com/eboyko/typefactory/fork
+2. Create your feature branch `git checkout -b my-new-feature`
+3. Commit your changes `git commit -am 'Add some feature'`
+4. Push to the branch `git push origin my-new-feature`
+5. Create a new pull request
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/lib/generators/typefactory/templates/initializer.rb

@@ -0,0 +1,9 @@
+Typefactory.setup do |config|
+
+  config.quote_marks = [
+    { :left => '«', :right => '»' },
+    { :left => '„', :right => '“' },
+    { :left => '‘', :right => '’' }
+  ]
+
+end

data/lib/generators/typefactory/typefactory_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record'
+
+class TypefactoryGenerator < ActiveRecord::Generators::Base
+
+  def self.source_root
+    @source_root = File.expand_path("../templates", __FILE__)
+  end
+
+  def config
+    copy_file "initializer.rb", "config/initializers/typefactory.rb"
+  end
+
+end

data/lib/typefactory.rb

@@ -0,0 +1,46 @@
+require 'typefactory/core_ext'
+require 'active_support/dependencies'
+
+module Typefactory
+
+  autoload :Processor, 'typefactory/processor'
+
+  @@quote_marks = [
+    { :left => '«', :right => '»' },
+    { :left => '„', :right => '“' },
+    { :left => '‘', :right => '’' }
+  ]
+  mattr_accessor :quote_marks
+
+  @@glyphs = {
+    nbsp:  { mark: ' ', sign: ' ', letter_code: ' ', digital_code: ' ' },
+    quot:  { mark: '"', sign: '"', letter_code: '"', digital_code: '"' },
+    mdash: { mark: '-', sign: '—', letter_code: '—', digital_code: '—' }
+    # :nbsp       => ' ',
+    # :ndash      => '–',
+    # :mdash      => '—',
+    # :minus      => '−',
+    # :section    => '§',
+    # :paragraph  => '¶',
+    # :copy       => '©',
+    # :registered => '®',
+    # :trademark  => '™',
+    # :degree     => '°',
+    # :inch       => '″',
+    # :multiple   => '×',
+    # :middot     => '·',
+    # :bullit     => '•',
+    # :quot       => '"'
+  }
+  mattr_accessor :glyphs
+
+  def self.setup
+    yield self
+  end
+
+  # @note In next versions here will be `settings`
+  def self.prepare(text)
+    Processor.new(text).prepare
+  end
+
+end

data/lib/typefactory/core_ext.rb

@@ -0,0 +1,7 @@
+String.class_eval do
+
+  def prepare
+    Typefactory::prepare(self)
+  end
+
+end

data/lib/typefactory/processor.rb

@@ -0,0 +1,116 @@
+module Typefactory
+
+  class Processor
+
+    @buffer = nil
+
+    # @param original [String] a text for preparing
+    def initialize(original)
+      @buffer = original
+    end
+
+    # @return [String] web-prepared text
+    def prepare
+      cleanup
+      escape_html
+      quotes
+      descape_html
+      emdashes
+      short_words
+      @buffer
+    end
+
+    private
+
+    # Purging text from already replaced glyphs (includes quotation marks of whole levels)
+    def cleanup
+
+      # Replacing all special chars to human-like marks
+      Typefactory::glyphs.each do |glyph, settings|
+        @buffer.gsub!(/#{settings[:sign]}|#{settings[:letter_code]}|#{settings[:digital_code]}/, settings[:mark])
+      end
+
+      # Replacing quote marks
+      expression = String.new
+      Typefactory::quote_marks.each do |mark|
+        expression += "#{mark[:left]}|#{mark[:right]}|"
+      end
+      @buffer.gsub!(/#{expression[0..-2]}/, Typefactory::glyphs[:quot][:mark])
+
+    end
+
+    def escape_html
+      @buffer.gsub!(/<([^\/].*?)>/) { |block| block.gsub(/"/, '\'') }
+    end
+
+    def descape_html
+      @buffer.gsub!(/<([^\/].*?)>/) { |block| block.gsub(/'/, '"') }
+    end
+
+    # Quotes
+    def quotes
+      result = String.new
+      level  = -1
+      @buffer.split('').each_with_index do |character, index|
+        if character == '"'
+          side = quote_mark_side(index)
+          if side == :left
+            level  += 1
+            result += Typefactory::quote_marks[level][side]
+          else
+            result += Typefactory::quote_marks[level][side]
+            level  -= 1
+          end
+        else
+          result += character
+        end
+      end
+      @buffer.replace result
+    end
+
+    def quote_mark_side(index)
+      before = space_before_position(index)
+      after  = space_after_position(index)
+      if !before.nil? and !after.nil?
+        (before < after) ? :left : :right
+      elsif !before.nil? and after.nil?
+        :left
+      elsif before.nil? and !after.nil?
+        :right
+      else
+        :right
+      end
+    end
+
+    def space_before_position(index, length = 4)
+      to       = (index-1 < 0) ? 0 : index-1
+      from     = (index-length < 0) ? 0 : index-length
+      position = @buffer[from..to].rindex(/\s|\-|>/)
+      if position.nil?
+        index < length ? 0 : nil
+      else
+        length - position
+      end
+    end
+
+    def space_after_position(index, length = 4)
+      to       = (index+length > @buffer.length) ? @buffer.length : index+length
+      from     = (index+1 > @buffer.length) ? @buffer.length : index+1
+      position = @buffer[from..to].index(/\s|\-|<|,/)
+      if position.nil?
+        length if index > @buffer.length - length
+      else
+        position
+      end
+    end
+
+    def short_words
+      @buffer.gsub!(/\s([a-zA-Z,а-яА-Я]{1,2})\s/) { |word| " #{$1}#{Typefactory::glyphs[:nbsp][:sign]}" }
+    end
+
+    def emdashes
+      @buffer.gsub!(/\s\-\s/, "#{Typefactory::glyphs[:nbsp][:sign]}#{Typefactory::glyphs[:mdash][:sign]} ")
+    end
+
+  end
+end

data/lib/typefactory/version.rb

@@ -0,0 +1,3 @@
+module Typefactory
+  VERSION = '0.0.10'
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'typefactory'

data/spec/typefactory_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe 'Typefactory' do
+
+  describe 'Core' do
+    it 'Parameters can be updated successfully' do
+      Typefactory.setup do |config|
+        config.quote_marks = [
+          { :left => '«', :right => '»' },
+          { :left => '„', :right => '“' },
+          { :left => '‘', :right => '’' }
+        ]
+        expect(config.quote_marks.class).to eq(Array)
+        expect(config.quote_marks[2][:right]).to eq('’')
+      end
+    end
+  end
+
+  describe 'Quotation (basic examples)' do
+    it 'Processing first level' do
+      example = 'Типовой "текст" в кавычках'
+      expect(example.prepare).to eq('Типовой «текст» в кавычках')
+    end
+
+    it 'Processing second level' do
+      example = '"Различные "ученые" от пикап-индустрии"'
+      expect(example.prepare).to eq('«Различные „ученые“ от пикап-индустрии»')
+    end
+
+    it 'Processing third level' do
+      example = '"Быть может, когда-нибудь "все мы будем жить в "лучшем" мире""'
+      expect(example.prepare).to eq('«Быть может, когда-нибудь „все мы будем жить в ‘лучшем’ мире“»')
+    end
+  end
+
+
+  describe 'Quotation (complicated exampled)' do
+    it 'processing marks in start/end positions' do
+      example = '"""Никакой" другой" типограф"'
+      expect(example.prepare).to eq('«„‘Никакой’ другой“ типограф»')
+    end
+
+    it 'Корректно распознает один уровень кавычек в составных словах с дефисом' do
+      example = 'Кавычки-"елочки"'
+      expect(example.prepare).to eq('Кавычки-«елочки»')
+
+      example = '"Елочки"-сосны'
+      expect(example.prepare).to eq('«Елочки»-сосны')
+    end
+
+    it 'Расставляет неразрывные пробелы' do
+      example = 'Едет Санта на оленях'
+      expect(example.prepare).to eq('Едет Санта на оленях')
+    end
+  end
+
+  describe 'Glyphs' do
+    it 'Process long dashes' do
+      example = 'Писец - не только ценный мех'
+      expect(example.prepare).to eq('Писец — не только ценный мех')
+    end
+  end
+
+end

data/typefactory.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typefactory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'typefactory'
+  spec.version       = Typefactory::VERSION
+  spec.authors       = ['Evgeny Boyko', 'Boandmedia']
+  spec.email         = ['eboyko@eboyko.ru']
+  spec.summary       = 'Helps you to prepare your texts for publishing on the web'
+  spec.description   = 'Soon'
+  spec.homepage      = 'http://boandmedia.com'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '~> 4.1', '>= 4.1.0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.1', '>= 10.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: typefactory
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- Evgeny Boyko
+- Boandmedia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Soon
+email:
+- eboyko@eboyko.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/typefactory/templates/initializer.rb
+- lib/generators/typefactory/typefactory_generator.rb
+- lib/typefactory.rb
+- lib/typefactory/core_ext.rb
+- lib/typefactory/processor.rb
+- lib/typefactory/version.rb
+- spec/spec_helper.rb
+- spec/typefactory_spec.rb
+- typefactory.gemspec
+homepage: http://boandmedia.com
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Helps you to prepare your texts for publishing on the web
+test_files:
+- spec/spec_helper.rb
+- spec/typefactory_spec.rb
+has_rdoc: