st_tools 0.3.2

data/lib/st_tools/common.rb

@@ -0,0 +1,30 @@
+module StTools
+  class Common
+
+    # Функция переводит хеши с несколькими уровнями вложения в плоский хэш, в котором
+    # глубина структуры заменяется ключами, разделенными точкой
+    # Источник: https://gist.github.com/lucabelmondo/4161211
+    #
+    # @param [Hash] hash для перевода ключей в плоский вид, разделенный точками
+    # @return [Hash] Hash вида "key.subkey.subsubkey" => value
+    def self.flatten_hash(hash)
+      result_iter = {}
+      paths = hash.keys.map { |key| [key] }
+
+      until paths.empty?
+        path = paths.shift
+        value = hash
+        path.each { |step| value = value[step] }
+
+        if value.respond_to?(:keys)
+          value.keys.each { |key| paths << path + [key] }
+        else
+          result_iter[path.join(".")] = value
+        end
+      end
+
+      result_iter
+    end
+
+  end
+end

data/lib/st_tools/fias.rb

@@ -0,0 +1,111 @@
+module StTools
+  class Fias
+
+    #-------------------------------------------------------------
+    #
+    # Функции получения aoguid адресного объекта
+    #
+    #-------------------------------------------------------------
+    # Функция возвращает aoguid Москвы в системе ФИАС
+    #
+    # @return [String] aoguid г. Москва
+    def self.moscow_aoguid
+      return self.federal_cities['msk']
+    end
+
+    # Функция возвращает aoguid Санкт-Питербурга в системе ФИАС
+    #
+    # @return [String] aoguid г. Санкт-Питербурга
+    def self.spb_aoguid
+      return self.federal_cities['spb']
+    end
+
+    # Функция возвращает aoguid Севастополя в системе ФИАС
+    #
+    # @return [String] aoguid г. Севастополь
+    def self.sevastopol_aoguid
+      return self.federal_cities['svs']
+    end
+
+    # Функция возвращает aoguid Байконура в системе ФИАС
+    #
+    # @return [String] aoguid г. Байконур
+    def self.baikonur_aoguid
+      return self.federal_cities['bai']
+    end
+
+    #-------------------------------------------------------------
+    #
+    # Функции валидации типа адресного объекта
+    #
+    #-------------------------------------------------------------
+    def self.federal?(aoguid)
+      return true if self.federal_cities.values.include?(aoguid)
+      return false
+    end
+
+    def self.moscow?(aoguid)
+      return true if self.federal_cities['msk'] == aoguid
+      return false
+    end
+
+    # @param [aoguid] aoguid адресного объекта из таблицы addrobj ФИАС
+    # @return [bool] true, если объект - Санкт-Петербург
+    def self.spb?(aoguid)
+      return true if self.federal_cities['spb'] == aoguid
+      return false
+    end
+
+    def self.sevastopol?(aoguid)
+      return true if self.federal_cities['svs'] == aoguid
+      return false
+    end
+
+    def self.baikonur?(aoguid)
+      if self.federal_cities['bai'] == aoguid
+        return true
+      end
+      return false
+    end
+
+
+    #--------------------------------------------------------------
+    #
+    # Функции определения типа переданного значения
+    #
+    #--------------------------------------------------------------
+    def self.uuid?(id)
+      if id.match(/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}/i)
+        return true
+      end
+      return false
+    end
+
+    def self.postalcode?(id)
+      if id.to_s.strip.match(/^\d{6}$/)
+        return true
+      end
+      return false
+    end
+
+    #--------------------------------------------------------------
+    #
+    # Вспомогательные функции
+    #
+    #--------------------------------------------------------------
+    private
+
+    # noinspection RubyClassVariableUsageInspection
+    def self.federal_cities
+      self_federal_cities = Hash.new
+
+      self_federal_cities['msk'] = '0c5b2444-70a0-4932-980c-b4dc0d3f02b5' # Москва
+      self_federal_cities['spb'] = 'c2deb16a-0330-4f05-821f-1d09c93331e6' # Санкт-Петербург
+      self_federal_cities['svs'] = '63ed1a35-4be6-4564-a1ec-0c51f7383314' # Байконур
+      self_federal_cities['bai'] = '6fdecb78-893a-4e3f-a5ba-aa062459463b' # Севастополь
+
+      return self_federal_cities
+    end
+
+  end
+end

data/lib/st_tools/human.rb

@@ -0,0 +1,140 @@
+module StTools
+  class Human
+
+
+    # Функция возвращает форматированную строку из любого числа с суффиксом тыс., млн. и пр.
+    #
+    # @param [Integer] val значение
+    # @return [String] строка вида "512,4 кило"
+    def self.number(val)
+      # todo: локлаизовать через i18N
+      # noinspection RubyStringKeysInHashInspection
+      arr = {'' => 1000, 'тыс.' => 1000 * 1000, 'млн.' => 1000 * 1000 * 1000,
+             'млрд.' => 1000 * 1000 * 1000 * 1000, 'трлн.' => 1000 * 1000 * 1000 * 1000 * 1000}
+
+      arr.each_pair do |e, s|
+        if val < s
+          if ['', ' тыс.'].include?(e)
+            return "#{(val.to_f / (s / 1000)).round(0)} #{e}"
+          else
+            return "#{(val.to_f / (s / 1000)).round(1)} #{e}"
+          end
+        end
+      end
+    end
+
+    # Функция возвращает форматированную строку из любого числа с объемом памяти.
+    #
+    # @param [Integer] val значение в байтах
+    # @return [String] строка вида "512,4 Мбайт"
+    def self.bytes(val)
+      # todo: локлаизовать через i18N
+      # noinspection RubyStringKeysInHashInspection
+      arr = {'байт' => 1024, 'кбайт' => 1024 * 1024, 'Мбайт' => 1024 * 1024 * 1024,
+             'Гбайт' => 1024 * 1024 * 1024 * 1024, 'Тбайт' => 1024 * 1024 * 1024 * 1024 * 1024}
+
+      arr.each_pair do |e, s|
+        if val < s
+          if %w(байт кбайт).include?(e)
+            return "#{(val.to_f / (s / 1024)).round(0)} #{e}"
+          else
+            return "#{(val.to_f / (s / 1024)).round(1)} #{e}"
+          end
+        end
+      end
+    end
+
+    # Функция возвращает форматированную строку с объемом памяти, занимаемым текущим процессом (pid).
+    #
+    # @return [String] строка вида "512,4 Мбайт"
+    def self.memory
+      val = ::StTools::System.memory
+      return self.bytes(val)
+    end
+
+    # Функция переводит DateTime в строку на русском или иных языках вида "4 дня 23 часа назад".
+    # Предварительно необходимо вызвать StTools.setup(:ru).
+    #
+    # @param [DateTime] time время и дата
+    # @param [Boolean] ago добавление слова "назад" в конец строки
+    # @return [String] строка вида "3 дня 12 часов" или "3 дня 12 часов назад"
+    def self.ago_in_words(time, ago = true)
+      now = self.to_time(Time.now.strftime('%Y-%m-%d %H:%M:%S UTC'))
+      slf = self.to_time(time.strftime('%Y-%m-%d %H:%M:%S UTC'))
+      secs = (now - slf).to_i
+      return I18n.t('common.ago.very_long') if time.year < 1800
+      return I18n.t('common.ago.just_now') if secs > -1 && secs < 1
+      return '' if secs <= -1
+      pair = self.ago_in_words_pair(secs)
+      pair << I18n.t("common.ago.ago_word") if ago == true
+      pair.join(' ')
+    end
+
+    # Функция переводит DateTime в строку на русском или иных языках. Предварительно необходимо вызвать
+    # StTools.setup(:ru).
+    #
+    # @param [DateTime] time время и дата
+    # @param [Sym] type формат возвращаемого результата
+    # @option :full форматирует дату и время (по умолчанию)
+    # @option :date форматирует только дату
+    # @option :time форматирует только время
+    # @return [String] строка с форматированными датой и временем
+    def self.format_time(time, what, type)
+      if [:full, :date, :time].include?(what) == false
+        warn "WARNING: what ':#{what.to_s}' must be in [:full, :date, :time]. Use ':full' now (at line #{__LINE__} of StTools::#{File.basename(__FILE__)})"
+        what = :full
+      end
+      return I18n.l(time, :format => "#{what.to_s}_#{type.to_s}".to_sym)
+    end
+
+    private
+
+    def self.ago_in_words_pair(secs)
+      mins = (secs / 60).to_i
+      hours = (mins / 60).to_i
+      days = (hours / 24).to_i
+      years = (days / 365).to_i
+      months = (days / (365/12)).to_i
+      # puts "#{secs}, #{mins}, #{hours}, #{days}, #{months}, #{years}"
+
+      return ago_in_words_one_pair(years, months - (years*12), "year", "month") if (months > 12)
+      return ago_in_words_one_pair(months, days - (months*(365/12)), "month", "day") if (days > 28)
+      return ago_in_words_one_pair(days, hours - (days*24), "day", "hour") if (hours > 24)
+      return ago_in_words_one_pair(hours, mins - (hours*60), "hour", "minute") if (mins > 60)
+      return ago_in_words_one_pair(mins, secs - (mins*60), "minute", "second") if (secs > 60)
+      return [ago_in_words_one_value(secs, "second")]
+    end
+
+    def self.ago_in_words_one_pair(val1, val2, tag1, tag2)
+      return [ago_in_words_one_value(val1, tag1), ago_in_words_one_value(val2, tag2)]
+    end
+
+    def self.ago_in_words_one_value(val, tag)
+      num100 = val % 100
+      num10 = val % 10
+      return val.to_s + " " + I18n.t("common.ago.#{tag}.other") if (num100 >=5 && num100 <= 20)
+      return val.to_s + " " + I18n.t("common.ago.#{tag}.one") if (num10 == 1)
+      return val.to_s + " " + I18n.t("common.ago.#{tag}.two") if ([2, 3, 4].include?(num10))
+      return val.to_s + " " + I18n.t("common.ago.#{tag}.other")
+    end
+
+    def self.to_time(time, form = :local)
+      parts = Date._parse(time, false)
+      return if parts.empty?
+
+      now = Time.now
+      time = Time.new(
+          parts.fetch(:year, now.year),
+          parts.fetch(:mon, now.month),
+          parts.fetch(:mday, now.day),
+          parts.fetch(:hour, 0),
+          parts.fetch(:min, 0),
+          parts.fetch(:sec, 0) + parts.fetch(:sec_fraction, 0),
+          parts.fetch(:offset, form == :utc ? 0 : nil)
+      )
+
+      form == :utc ? time.utc : time.getlocal
+    end
+
+  end
+end

data/lib/st_tools/progress_bar.rb

@@ -0,0 +1,73 @@
+module StTools
+  class ProgressBar
+    attr_reader :usage, :progress, :executed_at
+
+    # Инициализация прогресс-бара
+    #
+    # @param [Hash] opts параметры настройки прогресс-бара
+    # @option opts [String] :title заголовок прогресс-бара
+    # @option opts [Integer] :max максимальное значение
+    # @option opts [Integer] :progress текущее значение (по умолчанию 0)
+    # @option opts [String] :footer резюмирующая строка. Допускает два шаблона: [memory] и [executed_at]
+    # @option opts [Integer] :step шаг кратно которому реально перерисовывается прогресс-бар
+    # @return [Object] нет
+    def initialize(opts = {})
+      @title = opts[:title] || ''
+      @max = opts[:max] || 100
+      @progress = opts[:progress] || 0
+      @footer = opts[:footer] || ''
+      @step = opts[:step] || 100
+
+      @usage = 1
+      @executed_at = 0
+      @start_at = ::Time.now
+
+      init_progress_bar
+    end
+
+    # Функция устанавливает новое значение прогресс-бара
+    #
+    # @param [Integer] val новое значение прогресс-бара. Если равно max - то вызывается функция вывода футера
+    # @return [Object] нет
+    def progress=(val)
+      return if val > @max
+      return if val == @value
+      return if val % @step != 0 && (@max - val) >= @step
+
+      @progress = val
+      @pbar.progress = val
+      @usage += 1
+
+      if val > @max - 1
+        puts_footer
+      end
+    end
+
+    private
+
+
+    def init_progress_bar
+      puts @title if @title != ''
+
+      @pbar = ::ProgressBar.create(:starting_at => 0, :total => @max, :progress_mark => '=',
+                                   :format => "%a |%B| %E", :throttle_rate => 1, :remainder_mark => '.')
+    end
+
+    def puts_footer
+      @executed_at = (::Time.now - @start_at).to_f
+
+      return if @footer == ''
+
+      @executed_at_txt = @executed_at.to_i
+      @executed_at_txt = @executed_at.round(1).to_s if @executed_at < 60
+      @executed_at_txt = @executed_at.round(5).to_s if @executed_at < 1
+
+      @footer.gsub!(/\[memory\]/i, ::StTools::Human.memory) if @footer.match(/\[memory\]/i)
+      @footer.gsub!(/\[executed_at\]/i, @executed_at_txt) if @footer.match(/\[executed_at\]/i)
+
+      puts @footer
+    end
+
+
+  end
+end

data/lib/st_tools/string.rb

@@ -0,0 +1,170 @@
+module StTools
+  class String
+
+    # Функция преобразует текст в транслит
+    #
+    # @param [String] text исходная строка с русскими буквами
+    # @return [String] строка в транслите
+    def self.translit(text)
+      return nil if text.nil?
+      translited = text.tr('абвгдеёзийклмнопрстуфхэыь', 'abvgdeezijklmnoprstufhey\'\'')
+      translited = translited.tr('АБВГДЕЁЗИЙКЛМНОПРСТУФХЭЫЬ', 'ABVGDEEZIJKLMNOPRSTUFHEY\'\'')
+
+      translited = translited.gsub(/[жцчшщъюяЖЦЧШЩЪЮЯ]/, 'ж' => 'zh', 'ц' => 'ts', 'ч' => 'ch', 'ш' => 'sh', 'щ' => 'sch',
+                                   'ъ' => '', 'ю' => 'ju', 'я' => 'ja',
+                                   'Ж' => 'Zh', 'Ц' => 'Ts', 'Ч' => 'Ch', 'Ш' => 'Sh', 'Щ' => 'Sch',
+                                   'Ъ' => '', 'Ю' => 'Ju', 'Я' => 'Ja')
+      translited.gsub!('\'', '')
+      return translited
+    end
+
+    # Функция с хорошей производительностью преобразует строку в нижний регистр.
+    # Одновременно буква 'ё' замещается на 'е'
+    #
+    # @param [String] text строка в произвольном регистре
+    # @return [String] строка в нижнем регистре
+    def self.downcase(text)
+      return nil if text.nil?
+      return text.tr('QWERTYUIOPASDFGHJKLZXCVBNMАБВГДЕЁЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯ',
+                     'qwertyuiopasdfghjklzxcvbnmабвгдеёжзийклмнопрстуфхцчшщъыьэюя').gsub('ё', 'е')
+    end
+
+    # Функция с хорошей производительностью преобразует строку в верхний регистр.
+    # Одновременно буква 'Ё' замещается на 'Е'
+    #
+    # @param [String] text строка в произвольном регистре
+    # @return [String] строка в нижнем регистре
+    def self.upcase(text)
+      return nil if text.nil?
+      return text.tr('qwertyuiopasdfghjklzxcvbnmабвгдеёжзийклмнопрстуфхцчшщъыьэюя',
+                     'QWERTYUIOPASDFGHJKLZXCVBNMАБВГДЕЁЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯ').gsub('Ё', 'Е')
+    end
+
+    # Функция заменяет в исходной строке символы английские, но похожие
+    # на русские на соответстующие русские. То есть это похоже на ситуацию,
+    # когда Google меняет случайно написанное английскими буквами на русское
+    #
+    # @param [String] text текст со смесью английских и русских букв
+    # @return [String] текст только с русскими буквами
+    def self.delat(text)
+      return nil if text.nil?
+      return text.tr('ёЁEeHCcTOoPpAHKXxBM', 'еЕЕеНСсТОоРрАНКХхВМ')
+    end
+
+    # Данную функцию рекомендуется вызывать каждый раз, как юзер вводит текст,
+    # для того, чтобы:
+    # - убрать букву 'ё'
+    # - перевести строку в нижний регистр
+    # - заменить случайно введенные английские буквы на русские
+    # - убрать лидирующие и завершающие пробелы
+    # - оставить в строке только один пробел между слов
+    #
+    # @param [String] text строка, введенная пользователям
+    # @return [String] строка без 'ё', в нижнем регистре, без английских букв
+    def self.normalize(text)
+      return nil if text.nil?
+      return self.downcase(self.delat(text)).strip.gsub(/\s{1,100}/, ' ')
+    end
+
+    # Для целей выдачи информации клиенту в неполном объеме, данная функция позволяет
+    # закрыть часть строки звездочками. При этом число звездочек в строке определеяется
+    # ее длиной. Чем строка дилинее - тем больше в ней звездочек
+    #
+    # @param [String] text строка, которую необходимо закрыть звездочками
+    # @return [String] строка, часть символов которой заменена звездочками
+    def self.hide_text(text)
+      return nil if text.nil?
+      len = text.length - 3
+      0.upto((len/4).to_i) do
+        pos = rand(len)
+        text[pos,1] = '*'
+      end
+      return text
+    end
+
+    # Функция аналогична обычной функции split, однако дополнительно может выполнять следующие действия
+    # - strip каждого элемента
+    # - normalize соответсвующей функцией (#normalize)
+    # - сортировка в прямом порядке
+    # - удаление дубликотов
+    #
+    # @param [String] text исходная строка
+    # @param [String] separator сепаратор (по умолчанию нет - необходимо явное указание)
+    # @param [Hash] opts опции преобразования
+    # @option opts [Boolean] :normalize - применить к каждому элементу массива функцию #normalize
+    # @option opts [Boolean] :sort - сортировать выходной массив
+    # @option opts [Boolean] :uniq - удалить из массива дубликаты
+    # @return [Array] массив элементов из строки
+    def self.split(text, separator, opts = {})
+      return nil if text.nil?
+      out = text.split(separator)
+      out.map! { |x| x.strip }
+      out.map! { |x| self.normalize(x) } if opts[:normalize]
+      out.uniq! if opts[:uniq]
+      out.sort! if opts[:sort]
+
+      return out
+    rescue
+      return []
+    end
+
+    # Функция возвращает полный массив Array [1, 4, 5, 6, 7, 456] для строк вида '1, 4, 5-7, 456'.
+    # Дополнительно осуществляется:
+    # - сортировка в прямом порядке
+    # - удаление дубликотов
+    #
+    # @param [String] text исходная строка
+    # @param [Hash] opts
+    # @option opts [Boolean] :sort - сортировать выходной массив
+    # @option opts [Boolean] :uniq - удалить из массива дубликаты
+    # @return [Array] массив чисел
+    def self.to_range(text, opts = {})
+      return nil if text.nil?
+      out = Array.new
+
+      tmp = self.split(text, ',')
+      tmp.each do |one|
+        if one.match(/\-/)
+          d = one.split(/\-/)
+          out += Range.new(d.first.to_i, d.last.to_i).to_a
+        else
+          out << one.to_i
+        end
+      end
+
+      out.uniq! if opts[:uniq]
+      out.sort! if opts[:sort]
+
+      return out
+    end
+
+    # Функция делает заглавной первую букву в словах, разделенных пробелами или тире.
+    # Подключеие ActiveSupport не требуется
+    #
+    # @param [String] text исходная строка
+    # @return [String] строка с первыми заглавными буквами
+    def self.caps(text)
+      return nil if text.nil?
+      str = self.downcase(text).split(/[\-\s]/).map { |x| self.upcase(x[0]) + x[1,x.length] }
+      str = str.join(' ')
+      for i in 0..str.length
+        str[i] = '-' if (text.to_s[i,1] == '-')
+      end
+
+      return str
+    rescue
+      return text
+    end
+
+    # Функция формирует boolean значение из строки
+    #
+    # @param [String] text исходная строка, содержащая 'true/false', 'on/off', '1/0'
+    # @return [Boolean] true или false
+    def self.to_bool(text)
+      return false if text.nil?
+      return true if ['true', 'on', '1'].include?(self.downcase(text.to_s))
+      false
+    end
+
+  end
+end

data/lib/st_tools/system.rb

@@ -0,0 +1,38 @@
+module StTools
+  class System
+
+    def self.memory
+      return `ps -o rss -p #{Process::pid}`.chomp.split("\n").last.strip.to_i
+    end
+
+    # Возвращает размер терминала - число строк в терминале или число символов в строке
+    #
+    # @param [Sym] size возвращаемый параметр
+    # @option size [Sym] :width вернуть число символов в строке терминала
+    # @option size [Sym] :height верунть число строк в терминале
+    # @return [Integer] число символов в строке терминала или число строк в терминале
+    def self.screen(size)
+      sizes = `stty size 2>/dev/null`.chomp.split(' ')
+      raise if sizes.count == 0
+      raise if sizes.first.match(/\d/).nil?
+      return sizes.last.to_i if size == :width
+      return sizes.first.to_i if size == :height
+    rescue
+      return (size == :width) ? 100 : 25
+    end
+
+    # Метод возвращает имя запускаемого скрипта (без пути), независимо от того, откуда данный метод вызывается.
+    #
+    # @return [String] имя скрипта или nil в случае ошибки
+    def self.exename
+      res = `ps -ef | grep #{Process.pid}`
+      lines = res.split(/[\r\n]/)
+      lines.each do |one|
+        res = one unless one.match(/grep/)
+      end
+      res = res.split(' ').last
+      File.basename(res)
+    end
+
+  end
+end

data/lib/st_tools/version.rb

@@ -0,0 +1,3 @@
+module StTools
+  VERSION = '0.3.2'
+end

data/lib/st_tools.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.join(__dir__, *%w[.. lib])
+
+require "st_tools/version"
+
+require 'ruby-progressbar'
+
+module StTools
+  require 'st_tools/common'
+  require 'st_tools/system'
+  require 'st_tools/human'
+  require 'st_tools/fias'
+  require 'st_tools/string'
+  require 'st_tools/progress_bar'
+
+  require 'modules/string'
+  require 'modules/integer'
+  require 'modules/time'
+  require 'modules/fias'
+
+  class Setup
+
+    def self.setup(locale)
+      self.setup_locale(locale)
+    end
+
+    def self.setup_locale(locale)
+      require 'i18n'
+      ::I18n.load_path += Dir[File.dirname(File.expand_path(__FILE__)) + '/i18n/**/*.yml']
+      ::I18n.backend.load_translations
+      ::I18n.available_locales = [:ru, :en]
+      ::I18n.locale = locale
+      ::I18n.default_locale = locale
+    end
+
+  end
+end