okei 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff65991eed851bbc0d94adecc0f7f69c42926775
+  data.tar.gz: 618886df241a9e412715b0c74a5a95fb90b400b3
+SHA512:
+  metadata.gz: 1fe760dccd23afc881a70df294650ec9853b7067574e1dbe3257b6944fcb825f159e8479183084f6e3565b59309024ba876b78740d84ef771d556f8adf1ebc77
+  data.tar.gz: c5a7197958e49539f73f941564a4e46b9fc80822d0f4b61c511cb308dbf2e94ec1876e4e0e4640ae7b4e4af982dfd97840b4a66c3d2c073a9464945b054a89df

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'Rakefile'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/RescueException:
+  Exclude:
+    - 'spec/**/*'
+
+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/MethodLength:
+  Exclude:
+    - 'db/**/*'
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+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-04 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,91 @@
+= Единицы измерения
+
+{<img src="http://img.shields.io/travis/nepalez/okei.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/okei]
+{<img src="http://img.shields.io/codeclimate/github/nepalez/okei.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/okei]
+{<img src="http://img.shields.io/gemnasium/nepalez/okei.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/okei]
+{<img src="http://img.shields.io/coveralls/nepalez/okei.svg?style=flat" alt="Coverage Status" />}[https://coveralls.io/r/nepalez/okei]
+{<img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" />}[https://github.com/nepalez/okei/blob/master/LICENSE.rdoc]
+
+== О проекте
+
+Модуль описывает единицы измерения по стандартам, действующим в Российской Федерации.
+Является плагином Rails 4.1 и выше.
+
+В список включены единицы измерения в соответствии со следующими стандартами:
+
+* {ОКЕИ}[https://ru.wikipedia.org/wiki/%D0%9E%D0%B1%D1%89%D0%B5%D1%80%D0%BE%D1%81%D1%81%D0%B8%D0%B9%D1%81%D0%BA%D0%B8%D0%B9_%D0%BA%D0%BB%D0%B0%D1%81%D1%81%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80_%D0%B5%D0%B4%D0%B8%D0%BD%D0%B8%D1%86_%D0%B8%D0%B7%D0%BC%D0%B5%D1%80%D0%B5%D0%BD%D0%B8%D1%8F] (Общероссийский классификатор единиц измерения);
+* {ГОСT 8.417-2002}[https://ru.wikipedia.org/wiki/%D0%93%D0%9E%D0%A1%D0%A2_8.417] (Государственная система обеспечения единства измерений. Единицы величин);
+* {Рекомендация № 20 РГ 4 ЕЭК ООН}[http://www.unece.org/tradewelcome/areas-of-work/un-centre-for-trade-facilitation-and-e-business-uncefact/outputs/cefactrecommendationsrec-index/list-of-trade-facilitation-recommendations-n-16-to-20.html] "Коды единиц измерения, используемых в международной торговле" (Версия 9).
+
+Модуль объявляет:
+
+* Модель единиц измерения (<tt>Okei::Unit</tt>);
+* Набор сервисов (use cases) для работы с единицами измерения;
+* RESTful public API для доступа к списку единиц измерения и отдельным записям.
+
+=== Модель единиц измерения
+
+<tt>Okei::Unit</tt>:: Описывает единицу измерения согласно действующим стандартам. Единица идентифицируется уникальным кодом по {стандарту UUID}[https://ru.wikipedia.org/wiki/UUID].
+
+=== Сервисы (use cases)
+
+<tt>Okei::GetUnit</tt>::  Возвращает единицу измерения по указанному <tt>uuid</tt>
+<tt>Okei::GetUnits</tt>:: Возвращает список всех единиц с возможностью отбора по виду измерений.
+<tt>Okei::FindUnit</tt>:: Возвращает единицу измерения по названию.
+
+=== RESTful public API
+
+API содержит следующие маршруты для доступа к единицам измерения:
+
+<tt>GET /api/v1/units</tt>:: Перечень единиц с возможностью отбора по виду измерений.
+<tt>GET /api/v1/units/{uuid}</tt>:: Поиск единицы измерения по <tt>uuid</tt>.
+<tt>GET /api/v1/units/seach</tt>:: Поиск единицы измерения по названию.
+
+Подробное описание см. в { API Blueprint }[http://docs.unitsapi.apiary.io].
+
+При установке модуля рекомендуется использовать соответствующее поле имен
+(например, <tt>/okei</tt>).
+
+== Установка модуля
+
+Добавьте строку в Gemfile:
+
+    gem "okei"
+
+и затем вызовите из командной строки:
+
+    $ bundle
+
+или установите модуль вручную:
+
+    $ gem install okei
+
+После установки выполните в командной строке:
+
+    $ rake okei:install
+
+При этом в файл <tt>/config/routes.rb</tt> проекта будет добавлена строка,
+добавляющая адреса RESTful public API модуля. По умолчанию адреса добавляются
+в поле имен <tt>/okei</tt>, т.ч. API становится доступен по адресам:
+
+* <tt>GET {адрес вашего проекта}/okei/api/v1/units</tt>
+* <tt>GET {адрес вашего проекта}/okei/api/v1/units/{uuid}</tt>
+* <tt>GET {адрес вашего проекта}/okei/api/v1/units/search</tt>
+
+== Contributing (en)
+
+1. Fork it ( https://github.com/nepalez/okei/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
+
+== Лицензия
+
+Модуль распространяется на условиях свободной {лицензии MIT}[LICENSE.rdoc].
+
+== Язык документации
+
+Помимо данного описания и { API Blueprint }[http://docs.unitsapi.apiary.io],
+выполненных на русском языке, остальная документация доступна только
+по-английски.

data/Rakefile

@@ -0,0 +1,52 @@
+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    = "Okei"
+  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 :migrate do
+  sh "bundle exec rake db:migrate RAILS_ENV=test"
+end
+
+task default: [:migrate] do
+  sh "mkdir spec/dummy/tmp" do |*|
+    nunitSuccessFlag = false
+  end
+  sh "mkdir spec/dummy/tmp/cache" do |*|
+    nunitSuccessFlag = false
+  end
+  sh "bundle exec rspec spec"
+end
+
+task :full do
+  sh "coveralls report"
+  sh "rubocop"
+  sh "metric_fu"
+  sh "inch"
+end

data/app/controllers/okei/api/v1/responder.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Okei
+  module Api
+    module V1
+
+      # Responds to client depending on use case results
+      class Responder < ::ApplicationController
+
+        # Renders list of units of measure.
+        def on_success(units)
+          @units = units
+          render "index"
+        end
+
+        # Renders a unit of measure.
+        def on_found(unit)
+          @unit = unit
+          render "show"
+        end
+
+        # Renders an error message.
+        def on_not_found(messages)
+          @messages = messages
+          render "errors", status: 404
+        end
+      end
+    end
+  end
+end

data/app/controllers/okei/api/v1/units_controller.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Okei
+  module Api
+    module V1
+
+      # Controller for getting units
+      class UnitsController < Responder
+
+        # Returns either all units of measure or units of given measure.
+        def index
+          run_case GetUnits, with: :measure
+        end
+
+        # Finds a unit of measure by uuid.
+        def show
+          run_case GetUnit, with: :uuid
+        end
+
+        # Finds a unit of measure by text
+        def search
+          run_case FindUnit, with: :text
+        end
+
+        private
+
+        # Initializes a corresponding use case (service) with allowed params,
+        # subscribes for its results and then runs a use case.
+        #
+        # After running, the use case will call a method defined in the
+        # `Responder` parent class.
+        #
+        def run_case(klass, with:)
+          use_case = klass.new params.permit(*with)
+          use_case.subscribe self, prefix: :on
+          use_case.run
+        end
+      end
+    end
+  end
+end

data/app/models/okei/line.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Okei
+
+  # Converts source string to standardized line of text with:
+  #
+  # * cyrillic letters un upper register
+  # * numbers
+  # * ^ - a symbol of word break
+  # * slashes
+  # * spaces
+  # * %
+  #
+  #     Line.new "1000шт в условн.эквивал."
+  #     # => "1000 ШТ В УСЛОВН ЭКВИВАЛ"
+  #
+  class Line < String
+
+    def initialize(str = "")
+      super str.to_s.mb_chars.upcase
+      to_cyrillic
+      remove_dots_and_commas
+      clear_text
+      add_breaks
+    end
+
+    private
+
+    # Converts latin letters to corresponding cyrillic
+    def to_cyrillic
+      {
+        "A" => "А", "B" => "В", "C" => "С", "D" => "Д", "E" => "Е",
+        "G" => "Д", "H" => "Н", "K" => "К", "M" => "М", "N" => "П",
+        "O" => "О", "P" => "Р", "Q" => "Д", "R" => "Г", "T" => "Т",
+        "U" => "И", "X" => "Х", "Y" => "У"
+      }.each { |lat, cyr| gsub! lat, cyr }
+    end
+
+    # Remove dots and commas except for dots between digits
+    def remove_dots_and_commas
+      gsub!(/\.+/, ",")
+      gsub!(/(\d),(\d)/, '\1.\2')
+      gsub!(/,/, " ")
+    end
+
+    # Removes unwanted symbols.
+    def clear_text
+      gsub!(/\%-[^\s]+/, "%")
+      gsub!(/[^А-Я\d\.\s\/\%]/, " ")
+      gsub!(/\A[^А-Я\d]+|[^А-Я\d]+\z/, " ")
+      gsub!(/\s{2,}/, " ")
+      strip!
+    end
+
+    # Add ^ to mark word breaks
+    def add_breaks
+      gsub!(
+        /\A(НАНО|МИКРО|МИЛЛИ|САНТИ|ПОЛ|ДЕКА|ДЕЦИ|ГЕКТО|КИЛО|МЕГА|ТЕРА)/, '\1 ^ '
+      )
+      gsub!(/([А-Я])[\s\.^]*(2|3)(?!\d)/, '\1 ^ \2')
+    end
+  end
+end

data/app/models/okei/unit.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Okei
+
+  # Stores and validates units of measure
+  class Unit < ActiveRecord::Base
+
+    UUID_FORMAT = /\A[\d|a-f]{8}-([\d|a-f]{4}-){3}[\d|a-f]{12}\z/
+    NUM_FORMAT  = /\A\d{3}\z/
+
+    validates :uuid, :code, :name, :base, :factor, :measure, presence: true
+    validates :uuid, :code, :name, uniqueness: true, allow_nil: true
+    validates :factor, allow_nil: true, numericality: { greater_than: 0.0 }
+    validates :num,    allow_nil: true, format: { with: NUM_FORMAT }
+    validates :uuid,   allow_nil: true, format: { with: UUID_FORMAT }
+  end
+end

data/app/models/okei/word.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Okei
+
+  # Stores dictionary of words:
+  #
+  #     Word.new synonym: "МЕТРЫ", text: "М"
+  #     Word.new synonym: "МЕТР",  text: "М"
+  #
+  # ...and units in their standard representation:
+  #
+  #     Word.new synonym: "КВ М", text: "М2"
+  #     Word.new synonym: "М КВ", text: "М2"
+  #
+  class Word < ActiveRecord::Base
+
+    validates :synonym, :text, presence: true
+    validates :synonym, uniqueness: { case_sensitive: false }, allow_nil: true
+
+    # Translates the line if a translation exists.
+    # Otherwise returns source line unchanged.
+    def self.translate(line)
+      find_by_synonym(line).try(:text) || line
+    end
+  end
+end

data/app/models/okei/words.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Okei
+
+  # Breaks the source string to words properly:
+  #
+  #   Words.new "М3 96% ЧИСТОГО СПИРТА /ЧЕЛ"
+  #   # => ["М", "^", "3", "96", "%", "ЧИСТОГО", "СПИРТА", "/", "ЧЕЛ"]
+  #
+  class Words < Array
+
+    def initialize(line = "")
+      @line = line.to_s
+      super @line.scan(/[А-Я]+|\d+.\d+|\d+|\/|\^|\%/)
+    end
+
+    # Maps words back to `Words` (not a base `Array`):
+    #
+    #   ["9.8", "М", "/", "С", "^", "2"].map { |i| i }.class
+    #   # => Words
+    #
+    # The method can be combined with `to_s`:
+    #
+    #   ["9.8", "М", "/", "С", "^", "2"].map { |i| i.lower }.to_s
+    #   # => "9.8 м/с2"
+    #
+    def map
+      Words.new super
+    end
+
+    # Joins words back to string when necessary:
+    #
+    #   ["М", "^", "3", "96", "ПРОЦ", "ЧИСТОГО", "СПИРТА", "/", "ЧЕЛ"].to_s
+    #   # => "М3 96 ПРОЦ ЧИСТОГО СПИРТА/ЧЕЛ"
+    #
+    def to_s
+      join(" ").gsub(" ^ ", "").gsub(" / ", "/")
+    end
+  end
+end