st_tools 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43ec9fa72dac604d2acb1fda81c52417ccf5c2cd
-  data.tar.gz: 04f54d9f33e84cf8f9cfa8ec05072ae58c56c436
+  metadata.gz: 10f93a2349223d5bd2a740ff842b74f9cee2430d
+  data.tar.gz: ae363ce67f9587fde735756bfbbd5b6087afa74c
 SHA512:
-  metadata.gz: a74cac459d7d97a7e3a9d5e4de5a9419a64f993b8a81a5e3ac24b9ce18db7de1d29f02ffae9f7007c5580e335164ddb90aa5b00c06d3093935e3bc26b54dd5a9
-  data.tar.gz: b3d422acf564373ecfc93de98307cdadc76ff8e644fbbb8a3262318674c138c7cab9c20539e068c410297ae79ea47e05084ee576ce509e4991733589a8140333
+  metadata.gz: 86ba45333dd1dba115edac9cd691c5e14190f49588bf4433719e82f8f4470f12b200bfb86bd81705fe3f3715b6b70f8d45cd71eff9f895a1783dbdbafe69bcc5
+  data.tar.gz: b7ae48dfb3505891d48e1753fd90a6ada5e5829afb12920face31dbd602cb601d031825e7f7e5e3b35927cabf1330f6d7d4d5963d161127534080016c951e9dd

data/README.md

@@ -130,18 +130,24 @@ Time.now.format_date(:short)                      # => 28/04/2015
 
 ### StTools::String
 
+#### translit
+
 Транслитерация строки из русского на английский
 
 ```ruby
 StTools::String.translit('Жмеринка')                  # => Zhmerinka
 ```
 
+#### delat
+
 Иногда пользователи вводят английские буквы, похожие на русские, чаще все - букву 'C'. Метод delat заменяет такие символы на русские
 
 ```ruby
 StTools::String.delat('Соль')                         # => Соль
 ```
 
+#### upcase/downcase
+
 Перевести строку в верхний или нижний регистр. Используется метод, не использующий :mb_chars
 
 ```ruby
@@ -149,6 +155,8 @@ StTools::String.downcase('Москва')                    # => москва
 StTools::String.upcase('Москва')                      # => МОСКВА
 ```
 
+#### normalize
+
 Иногда надо нормализовать строку и привести ее к виду, удобному для машинной обработки.
 Метод normalize последовательно делает: strip, delat, downcase
 
@@ -156,6 +164,8 @@ StTools::String.upcase('Москва')                      # => МОСКВА
 StTools::String.normalize('   Москва  ')              # => "москва"
 ```
 
+#### caps
+
 Следующий метод приводит строку к нижнему регистру, но делает первую букву заглавной.
 Удобно для нормализации имени и фамилии, вводимых пользователем
 
@@ -171,13 +181,17 @@ StTools::String.caps('н.а.римский-корсаков пришел в го
   #=> "Н.А.Римский-Корсаков Пришел В Гости К В.И. Ленину На Улицу Героев 1812-го Года"
 ```
 
-Для реализации деморежимов различных приложений иногда надо скрыть реальный результат.
-Для это можно использовать метод hide
+#### hide
+
+Для реализации деморежимов различных приложений иногда надо скрыть реальный результат. Для это можно
+использовать метод hide
 
 ```ruby
 StTools::String.hide('Краснодар')              # => "Кра*но*ар"
 ```
 
+#### to_bool
+
 В Ruby отсутствует метод перевода строки пользователя в тип Boolean.
 
 ```ruby
@@ -203,6 +217,8 @@ StTools::String.to_bool(params[:opt1], false)      #=> true
 StTools::String.to_bool(params[:opt2], true)       #=> true
 ```
 
+#### split
+
 Если пользователь введет в качестве входного параметра перечисление, следующий метод разобъет его на токены,
 с нормализацией при необходимости
 
@@ -212,6 +228,8 @@ StTools::String.split('ТАНЯ, маша, петя', ',', normalize: true)
 StTools::String.split('ТАНЯ, маша, петя', ',', normalize: true, sort: true)    # => ['маша', 'петя', 'таня']
 ```
 
+#### to_range
+
 Если от пользователя требуется ввести численные значения в виде перечисления или диапазоне, нужно использовать
 метод to_range
 
@@ -221,6 +239,8 @@ StTools::String.to_range('54, 3-6, 5, 1', uniq: true)                     # => [
 StTools::String.to_range('54, 3-6, 5, 1', uniq: true, sort: true)         # => [1, 3, 5, 6, 54]
 ```
 
+#### pretty_list
+
 Следующий метод `pretty_list` позволяет сделать human-подобное оформление списков-перечислений.
 
 ```ruby
@@ -237,6 +257,8 @@ StTools::Setup.setup(:en)
     # => "Discount is <em>$100</em> or <em>$200</em>"
 ```
 
+#### prune
+
 В ряде случаев необходимо обрезать строку таким образом, чтобы на экране уместилась часть строки, и многоточие,
 которе показывает, что строка была сокращена. Для этого можно использовать метод `StTools::String.prune`.
 
@@ -253,6 +275,40 @@ StTools::String.prune("Привет мир!", 12, words: true)     #=> "Прив
 `word: true`, то произойдет более "умное" обрезание фразы - не посреди слова (как показано в примере выше), а по границе
 слова, то есть по пробелу между словами в меньшую сторону.
 
+#### to_float
+
+Метод `to_float` позволяет переводить различные строки, введенные пользователем, в тип `Float` языка Ruby.
+
+```ruby
+StTools::String.to_float('123.45678')                                 #=> 123.45678
+StTools::String.to_float('123.474565', round: 2)                      #=> 123.47
+StTools::String.to_float('123,474565', round: 2)                      #=> 123.47
+StTools::String.to_float('   123,47456564', round: 2)                 #=> 123.47
+StTools::String.to_float('   10 123,47456', round: 2)                 #=> 10123.47
+StTools::String.to_float(' -  10 123,474565', round: 2)               #=> -10123.47
+```
+
+Если у Вас уже есть число в формате `Float` или `Integer`, то все равно можно вызвать метод `to_float`. При этом
+произойдет только округление числа в соответствии с параметром `round`.
+
+```ruby
+StTools::String.to_float(145.5667, round: 2)                          #=> 145.57
+StTools::String.to_float(23, round: 2)                                #=> 23
+```
+
+Возможны ситуации, когда параметр переданный является `nil` или строкой, не содержащей числа. В этом случае возможны
+две модели поведения. Первая (установленная по умолчанию), выбрасывает Exception в случае, если переданная на вход
+метода строка не содержит цифр. Другая модель предусматривает возвращаение нулевого значения при ошибке. Для этого
+нужно установить параметр `stop` в значение `false`.
+
+```ruby
+StTools::String.to_float(nil) rescue 'fail')                          #=> "fail"
+StTools::String.to_float(nil, stop: false) rescue 'fail')             #=> 0
+StTools::String.to_float('no digits') rescue 'fail')                  #=> "fail"
+StTools::String.to_float('no digits', stop: false) rescue 'fail')     #=> 0
+```
+
+#### Расширение класса String (include StTools)
 
 Вы можете подмешать модуль `StTools::Module` в классы String, Integer, Time.
 

data/lib/modules/string.rb

@@ -103,6 +103,26 @@ module StTools
         ::StTools::String.prune(self, length, words, endwith)
       end
 
+      # Метод преобразует строковое выражение в число с плавающей запятой. При этом метод корректно преобразует
+      # числа вида "12.34" и "12,34", то есть с точкой и запятой (но будет некорректный результат в случае
+      # американских чисел, где запятая - разделитель тысяч, а не дробная часть).
+      #
+      # @param [Integer] round число цифр после запятой при округлении. По умолчанию - 6
+      # @param [Object] stop если true, то при ошибке будет выброшен "Exception", иначе при ошибках будет возвращаться "0". По умолчанию - true.
+      # @return [Float] число с плавающей запятой
+      # @example Примеры использования
+      #   '123.45678'.to_float                                 #=> 123.45678
+      #   '123.474565'.to_float(round: 2)                      #=> 123.47
+      #   '123,474565'.to_float(round: 2)                      #=> 123.47
+      #   '   123,47456564'.to_float(round: 2)                 #=> 123.47
+      #   '   10 123,47456'.to_float(round: 2)                 #=> 10123.47
+      #   ' -  10 123,474565'.to_float(round: 2)               #=> -10123.47
+      #   nil.to_float(round: 2) rescue 'fail'                 #=> "fail"
+      #   nil.to_float(round: 2, stop: false) rescue 'fail'    #=> 0
+      def to_float(round: 6, stop: true)
+        ::StTools::String.to_float(self, round, stop)
+      end
+
       # Метод переводит строку в значение boolean (true или false). True - если строка имеет одно из трех значений:
       # ['true', 'on', '1']
       #

data/lib/st_tools/string.rb

@@ -262,9 +262,52 @@ module StTools
       return text[0, length] if length <= endwith.length
 
       out = text.strip[0,length - endwith.length]
-      out.gsub!(/\s.+\z/, '') if words
+      out.gsub!(/\s[^\s]+?\z/, '') if words
       out.strip + endwith
     end
 
+    # Метод преобразует строковое выражение в число с плавающей запятой. При этом метод корректно преобразует
+    # числа вида "12.34" и "12,34", то есть с точкой и запятой (но будет некорректный результат в случае
+    # американских чисел, где запятая - разделитель тысяч, а не дробная часть).
+    #
+    # @param [String, Float, Integer] text строка или число, которое нужно преобразовать в Float
+    # @param [Integer] round число цифр после запятой при округлении. По умолчанию - 6
+    # @param [Object] stop если true, то при ошибке будет выброшен "Exception", иначе при ошибках будет возвращаться "0". По умолчанию - true.
+    # @return [Float] число с плавающей запятой
+    # @example Примеры использования
+    #   StTools::String.to_float('123.45678')                                 #=> 123.45678
+    #   StTools::String.to_float('123.474565', round: 2)                      #=> 123.47
+    #   StTools::String.to_float('123,474565', round: 2)                      #=> 123.47
+    #   StTools::String.to_float('   123,47456564', round: 2)                 #=> 123.47
+    #   StTools::String.to_float('   10 123,47456', round: 2)                 #=> 10123.47
+    #   StTools::String.to_float(' -  10 123,474565', round: 2)               #=> -10123.47
+    #   StTools::String.to_float(nil, round: 2) rescue 'fail')                #=> "fail"
+    #   StTools::String.to_float(nil, round: 2, stop: false) rescue 'fail')   #=> 0
+    #   StTools::String.to_float(145.5667, round: 2)                          #=> 145.57
+    #   StTools::String.to_float(23, round: 2)                                #=> 23
+    def self.to_float(text, round: 6, stop: true)
+      # http://stackoverflow.com/questions/1034418/determine-if-a-string-is-a-valid-float-value
+      if text.nil?
+        stop ? (raise TypeError, "can't convert nil into Float") : (return 0)
+      end
+
+      if text.is_a?(::Float) || text.is_a?(::Integer)
+        return text.to_f.round(round)
+      end
+
+      if text.is_a?(::String)
+        str = text.strip.gsub(/\,/, '.').gsub(/\s/, '')
+        if str.match(/\A\s*[+-]?((\d+_?)*\d+(\.(\d+_?)*\d+)?|\.(\d+_?)*\d+)(\s*|([eE][+-]?(\d+_?)*\d+)\s*)\z/)
+          begin
+            return str.to_f.round(round)
+          rescue Exception => e
+            stop ? (raise ArgumentError, "invalid value for Float(): #{str.inspect}") : (return 0)
+          end
+        end
+      end
+
+      stop ? (raise ArgumentError, "invalid value for Float(): #{text.inspect}") : (return 0)
+    end
+
   end
 end

data/lib/st_tools/version.rb

@@ -1,3 +1,3 @@
 module StTools
-  VERSION = '0.3.9'
+  VERSION = '0.3.10'
 end

data/test/string_lib_spec.rb

@@ -154,4 +154,19 @@ describe 'Проверка методов StTools::String.*' do
     expect(test).to eq('Привет...')
   end
 
+  it 'to_float' do
+    expect(::StTools::String.to_float('123.45')).to eq(123.45)
+    expect(::StTools::String.to_float('123.474565647335', round: 2)).to eq(123.47)
+    expect(::StTools::String.to_float('123,474565647335', round: 2)).to eq(123.47)
+    expect(::StTools::String.to_float('   123,474565647335', round: 2)).to eq(123.47)
+    expect(::StTools::String.to_float('   10 123,474565647335', round: 2)).to eq(10123.47)
+    expect(::StTools::String.to_float(' -  10 123,474565647335', round: 2)).to eq(-10123.47)
+    expect((::StTools::String.to_float(nil, round: 2) rescue 'fail')).to eq('fail')
+    expect((::StTools::String.to_float(nil, round: 2, stop: false) rescue 'fail')).to eq(0)
+    expect((::StTools::String.to_float('no_digits', round: 2) rescue 'fail')).to eq('fail')
+    expect((::StTools::String.to_float('no_digits', round: 2, stop: false) rescue 'fail')).to eq(0)
+    expect(::StTools::String.to_float(145.5667, round: 2)).to eq(145.57)
+    expect(::StTools::String.to_float(23, round: 2)).to eq(23)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: st_tools
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Stan Zhuravlev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler