corrector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b840557d16354f3fe065e83e369989379096a7e
+  data.tar.gz: 6807ca775443e5c58ecc2fb739b36e80a6f9c860
+SHA512:
+  metadata.gz: 7c545c92bc3405f417bcc31035fd3aa5e93c3448017d3bb30bcda96583fd01b114bedd519bece232c344c163d4581e01a4d233ceb75b1a35f85a90610b1263e7
+  data.tar.gz: 6cbd1701c9419b6bbe5d6661a98e59ba13c46ea9f897d7b17df03cb165fe90afbd7cc139fc58f4b3b8519395521748113c12caa520aeeac68629983ca70222a7

data/.rubocop.yml

@@ -0,0 +1,67 @@
+AllCops:
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'Rakefile'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/RescueException:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'db/**/*'
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'db/**/*'
+
+Style/EmptyLinesAroundBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Exclude:
+    - 'spec/**/*'
+
+Style/PredicateName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'Gemfile'
+    - '*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.rdoc

@@ -0,0 +1,13 @@
+= CHANGELOG
+
+== 2014-10-15 0.0.1-alpha
+
+=== Added
+
+=== Deleted
+
+=== Fixed
+
+=== Deprecated
+
+=== Security

data/LICENSE.rdoc

@@ -0,0 +1,21 @@
+= The MIT License
+
+Copyright (c) 2014 Andrew Kozin, https://github.com/nepalez
+
+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.rdoc

@@ -0,0 +1,81 @@
+= Corrector
+
+{<img src="http://img.shields.io/gem/v/corrector.svg?style=flat" alt="Gem Version" />}[https://rubygems.org/gems/corrector]
+{<img src="http://img.shields.io/travis/nepalez/corrector.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/corrector]
+{<img src="http://img.shields.io/codeclimate/github/nepalez/corrector.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/corrector]
+{<img src="http://img.shields.io/gemnasium/nepalez/corrector.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/corrector]
+{<img src="http://img.shields.io/coveralls/nepalez/corrector.svg?style=flat" alt="Coverage Status" />}[https://coveralls.io/r/nepalez/corrector]
+{<img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" />}[https://github.com/nepalez/corrector/blob/master/LICENSE.rdoc]
+
+== About
+
+Rails plugin for cyrillic texts correction using words and phrases dictionary.
+
+It defines two dictionaries:
+
++Word+::   A dictionary of words
++Prefix+:: A dictionary of word prefixes
++Phrase+:: A dictionary of phrases
+
+and a service +Parse+ that:
+
+* converts a source text to uppercase cyrillic one;
+* breaks it to words;
+* corrects any single word using +Prefix+ and +Word+ dictionaries;
+* puts corrected words back to sentence;
+* corrects the sentence using the +Phrase+ dictionary;
+* returns the result.
+
+The model is expected to be used as a part of various classificators - to allow
+searching items by words in Russian.
+
+=== Example
+
+After adding some words and phrases:
+    
+    Prefix.create! from: "КИЛО",    to: "К",       source: "UNITS"
+    Word.create!   from: "МЕТРОВ",  to: "М",       source: "UNITS"
+    Word.create!   from: "СЕКУНДУ", to: "С",       source: "UNITS"
+    Phrase.create! from: "КМ В С",  to: "ТЫС М/С", source: "UNITS"
+
+the phrase can be corrected properly:
+
+    Parse.new "килоmетров в секyndу", source: "UNITS" # => "ТЫС М/С"
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem "corrector"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install corrector
+
+== Initialization
+
+You should copy db migrations to your project and then run the migrations.
+
+=== in a Rails application
+
+    $ rake corrector:install
+
+=== in a Rails mountable engine
+
+    $ rake app:corrector:install
+
+== Contributing
+
+1. Fork it ( https://github.com/nepalez/corrector/fork )
+2. Create your feature branch (<tt>git checkout -b my-new-feature</tt>)
+3. Commit your changes (<tt>git commit -am 'Add some feature'</tt>)
+4. Push to the branch (<tt>git push origin my-new-feature</tt>)
+5. Create a new Pull Request
+
+== License
+
+The plugin is distributed under {MIT license}[https://github.com/nepalez/corrector/blob/master/LICENSE.rdoc]

data/Rakefile

@@ -0,0 +1,43 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+begin
+  require "rdoc/task"
+rescue LoadError
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Corrector"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include "README.rdoc"
+  rdoc.rdoc_files.include "lib/**/*.rb"
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path "../spec/dummy/Rakefile", __FILE__
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new :spec
+task :default do
+  sh "bundle exec rake db:migrate RAILS_ENV=test"
+  sh "bundle exec rspec spec"
+end
+
+task :full do
+  sh "coveralls report"
+  sh "rubocop"
+  sh "metric_fu"
+  sh "rails_best_practices"
+  sh "inch --pedantic"
+end

data/app/models/corrector/base.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Corrector
+
+  # Stores a list of translations (words or phrases).
+  class Base < ActiveRecord::Base
+
+    validates :from, :to, :scope, presence: true
+    validates :from, uniqueness: { scope: :scope }, allow_nil: true
+
+    # Selects records in a requested scope.
+    #
+    # @example
+    #   Base.by_scope "UNITS" # Returns all units translations
+    #
+    # Params:
+    # +value+:: the scope to select records in
+    #
+    # Returns an <tt>ActiveRecord::Association</tt> object.
+    scope :by_scope, ->(value) { where scope: value }
+
+    # Scans the dictionary for source string translation.
+    # Returns the source if no translation found.
+    #
+    # @example
+    #   Base.scan "КИЛОМЕТР" # => "КМ"
+    #
+    # Params:
+    # +value+:: a string to be scanned
+    #
+    # Returns a translation or the source itself if no translation found.
+    def self.scan(value)
+      where(from: value).first.try(:to) || value
+    end
+  end
+end

data/app/models/corrector/phrase.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require_relative "base"
+
+module Corrector
+
+  # Stores phrases translations.
+  class Phrase < Base
+  end
+end

data/app/models/corrector/prefix.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require_relative "base"
+
+module Corrector
+
+  # Stores words translations.
+  class Prefix < Base
+    validates :from, format: { without: /\s/ }, allow_nil: false
+
+    # Separates all prefixes in a scanned string.
+    #
+    # @example:
+    #     Prefix.scan "КИЛОМЕТР" # => ["КИЛО", "^", "МЕТР"]
+    #
+    # Params:
+    # +value+: a word to be scanned for prefixes and splitted
+    #
+    # Returns an array of recognized word's parts.
+    def self.scan(value)
+      all.reduce(value.dup) { |str, prefix| prefix.send :scan, str }.split(" ")
+    end
+
+    private
+
+    # Separates a prefix in a scanned value.
+    def scan(value)
+      value.gsub Regexp.new("^#{ from }"), "#{ to } ^ "
+    end
+  end
+end

data/app/models/corrector/word.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require_relative "base"
+
+module Corrector
+
+  # Stores words translations.
+  class Word < Base
+    validates :from, format: { without: /\s/ }, allow_nil: false
+  end
+end

data/app/services/corrector/cyrillic.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Corrector
+
+  # Converts string to uppercase and its latin letters to cyrillic ones.
+  class Cyrillic < String
+
+    # The source line for conversion.
+    #
+    # @example
+    #     str = Cyrillic.new "mapc" # => "МАРС"
+    #     str.source # => "mapc"
+    #
+    attr_reader :source
+
+    # Converts letters in the source string to uppercase cyrillic ones.
+    #
+    # @example
+    #     Cyrillic.new "mapka" # => "МАРКА"
+    #
+    # Params:
+    # +value+:: The source string to be converted.
+    #
+    # Returns a converted string.
+    def initialize(value)
+      @source = value
+      super line
+    end
+
+    private
+
+    def line
+      source.to_s.mb_chars.upcase.tr("ABCDEHKMNOPTXY", "АВСДЕНКМ№ОРТХУ")
+    end
+  end
+end

data/app/services/corrector/parse.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module Corrector
+
+  # Converts a source to string using stored prefixes, words and phrases
+  class Parse < String
+
+    # Returns the source string having been parsed.
+    #
+    # @example
+    #     str = Parse.new "километра в час", scope: "UNITS" # => "КМ/Ч"
+    #     str.source # => "километра в час"
+    #
+    attr_reader :source
+
+    # Parses given string, caches and returns the result of parsing.
+    #
+    # @example
+    #     Parse.new "километра в час", scope: "UNITS" # => "КМ/Ч"
+    #
+    # Params:
+    # +value+:: a string to be parsed
+    # +scope+:: a scope (dictionary) for translations
+    #
+    # Returns a converted string with a +source+ method containing the source
+    # string and +scope+ containing the scope for translation.
+    def initialize(value = "", scope:)
+      @source, @scope = value.to_s, scope
+      super phrase
+    end
+
+    private
+
+    attr_reader :scope
+
+    def cyrillic
+      @cyrillic ||= Cyrillic.new source
+    end
+
+    def words
+      @words ||= Words.new(cyrillic)
+    end
+
+    def parts
+      @parts ||= words.map do |word|
+        Prefix.by_scope(scope).scan(word) || word
+      end
+    end
+
+    def line
+      @line ||= parts.map do |part|
+        Word.by_scope(scope).scan(part) || part
+      end.to_s
+    end
+
+    def cache_key
+      @cache ||= [scope, cyrillic]
+    end
+
+    def phrase
+      Rails.cache.fetch cache_key do
+        Phrase.by_scope(scope).scan(line) || line
+      end
+    end
+  end
+end

data/app/services/corrector/words.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+module Corrector
+
+  # Breaks source string to words.
+  class Words < Array
+
+    # The source array or string for the current words list.
+    #
+    # @example:
+    #     words = Words.new "М В С2" # => #< Words ["М", "В", "С", "2"]>
+    #     words.source # => "М В С2"
+    #
+    #     words = Wrods.new ["М", "В", "С2"] # => #< Words ["М", "В", "С2"]>
+    #     words.source # => ["М", "В", "С2"]
+    #
+    # Returns either array or string.
+    attr_reader :source
+
+    # Initializes the array containing words from the source array or string.
+    #
+    # @example
+    #     Words.new                  # => #<Words []>
+    #     Words.new "М В С2"         # => #<Words ["М", "В", "С", "2"]>
+    #     Words.new ["М", "В", "С2"] # => #<Words ["М", "В", "С2"]>
+    #
+    # Params:
+    # +value+:: An array of words or a string to be splitted to words.
+    #           Default value: <tt>[]</tt>.
+    #
+    # Returns the array of recognized words from the initial string.
+    # Both the +map+ and +to_s+ methods of the array are redefined.
+    def initialize(value = [])
+      @source = value
+      value.is_a?(Array) ? super(value) : super(words)
+    end
+
+    # Maps +Words+ class object.
+    #
+    # @example
+    #     words =     Words.new(%w(РАЗ ДВА)).map { |i| i }
+    #     words.is_a? Words # => true
+    #
+    # Returns the mapped +Words+ object.
+    def map
+      Words.new super.flatten
+    end
+
+    # Converts words list to a string. Joins words divided by the +^+ symbol
+    # and removes spaces around the slash.
+    #
+    # @example
+    #     words = Words.new %w(К ^ М / C ^ 2)
+    #     words.to_s # => "КМ/С2"
+    #
+    # Returns a converted string with +source+ method to check the source.
+    def to_s
+      map(&:strip).join(" ").gsub(/\s*\^\s*/, "").gsub(/\s*\/\s*/, "/")
+    end
+
+    private
+
+    def line
+      @line ||= source.to_s.gsub(/\,/, ".").gsub(/\|/, "/")
+    end
+
+    def words
+      line.scan(/[А-ЯA-Z]+|\d+\.\d+|\d+|№|\/|%|\$|\^/)
+    end
+  end
+end

data/db/migrate/20141014223624_create_corrector_bases.rb

@@ -0,0 +1,13 @@
+class CreateCorrectorBases < ActiveRecord::Migration
+  def change
+    create_table :corrector_bases do |t|
+      t.string :type, limit: 6
+      t.string :from, null: false
+      t.string :to,   null: false
+      t.string :scope
+    end
+
+    add_index :corrector_bases, [:scope, :from], unique: true
+    add_index :corrector_bases, :type
+  end
+end

data/lib/corrector/engine.rb

@@ -0,0 +1,12 @@
+module Corrector
+
+  # Rails Engine settings
+  class Engine < ::Rails::Engine
+    isolate_namespace Corrector
+
+    config.generators do |generator|
+      generator.test_framework :rspec, fixture: true, view_specs: true
+      generator.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+  end
+end

data/lib/corrector/version.rb

@@ -0,0 +1,6 @@
+# Namespace for the corrector module
+module Corrector
+
+  # Current release
+  VERSION = "0.0.1"
+end

data/lib/corrector.rb

@@ -0,0 +1,6 @@
+require "rails"
+require "corrector/engine"
+
+# Namespace for the corrector module
+module Corrector
+end

data/lib/tasks/corrector_tasks.rake

@@ -0,0 +1,7 @@
+namespace :corrector do
+
+  desc "Installs the corrector"
+  task install: %w(install:migrations) do
+    sh "rake db:migrate SCOPE=corrector"
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run