web-utils 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51f28f3490e185eefa169866d88af1b0cf15ce3a61f7a8fbdb9acf955dd160a
-  data.tar.gz: b047825464803b6a4c49f79dae32d8159b38f5e3edef97c9712f647bf258a920
+  metadata.gz: 74c9972b2a2cfeb97d05475c3833378dfe7b83350e5764e281888c3f7e206b67
+  data.tar.gz: 82f8929a62f9b94e130514f9191f0be756b7f7ef49ab1e6e5105113d53068ce4
 SHA512:
-  metadata.gz: f3cecb91f83b58fe4c03fceb8941afe56c4dd43d0996adb4a0a92d90cbd413309c4af23c047ba199647a00f14640993becb5765903d07378e78922797d6c5b44
-  data.tar.gz: 9227bf1102a6747c5375386ceba11982b929025b83078850e15817d3876d4f1f5817dff32c401ddf2320de40febcf6abe3c89e843912cbf9452955c5b1f1420c
+  metadata.gz: 4488aa8e08eddc957a2626662bc3eda75b59c049435e9f4b37eb2cbd6574335d178373c0cf97e289797b9451966838017753f2c2e15e21f4fe751cb4bde55def
+  data.tar.gz: 144b9995c41472af73386bfe7ffa1a4e0f4df5f5dca6d929dbd10a0118c42a265b0d99ef753f2916935535e182580038b1c51fcf85c679c84a69ffa17f2f4ed1

data/lib/web_utils.rb

@@ -5,59 +5,104 @@ require 'uri'
 
 module WebUtils
 
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'.freeze
 
   # Most methods are supposed to be as simple as possible
   # and just cover most cases.
-  # I would rather override specific cases rather than making
+  # I would rather override specific cases than making
   # complicated methods.
 
   extend Rack::Utils
 
+  # Global string constants
+  EMPTY_STRING = ''.freeze
+  IES_STRING = 'ies'.freeze
+  E_STRING = 'e'.freeze
+  S_STRING = 's'.freeze
+  Y_STRING = 'y'.freeze
+  X_STRING = 'x'.freeze
+  XES_STRING = 'xes'.freeze
+  SPACE = ' '.freeze
+  DASH = '-'.freeze
+  UNDERSCORE = '_'.freeze
+  AMPERSAND = '&'.freeze
+  PERCENT = '%'.freeze
+  PIPE = '|'
+  DOT = '.'.freeze
+  COMMA = ','.freeze
+  CONST_SEP = '::'.freeze
+  ELLIPSIS = '...'
+  AND_STRING = 'and'.freeze
+  SPACE_PERCENT_STRING = ' percent'.freeze
+  TRUE_STRING = 'true'.freeze
+  FALSE_STRING = 'false'.freeze
+  BR_TAG = '<br>'.freeze
+  ARG1_SUB = '\1'.freeze
+
+  # From then on, constants preceed the methods they are
+  # used on.
+
+  BLANK_RE = /\A[[:space:]]*\z/.freeze
+
   def blank? s
-    s.to_s.strip==''
+    return true if s.nil?
+    # Not much difference with strip on benchmarks
+    # return (s.empty? or BLANK_RE.match?(s)) if s.is_a?(String)
+    return (s.strip.empty?) if s.is_a?(String)
+    return s.empty? if s.respond_to?(:empty?)
+    return true if s==false
+    false
   end
   module_function :blank?
 
+  PLURAL_RE = /([b-df-hj-np-tv-z])ys\z/.freeze
+  PLURAL_SUB = '\1ies'.freeze
+
   def pluralize s
-    s<<'e' if s[-1,1]=='x'
-    s<<'s'
-    s.sub(/([b-df-hj-np-tv-z])ys$/,'\1ies')
+    s = s.dup
+    s<<E_STRING if s[-1,1]==X_STRING
+    s<<S_STRING
+    s.sub PLURAL_RE, PLURAL_SUB
   end
   module_function :pluralize
 
+  SINGULAR_RE = /ies\z/.freeze
+
   def singularize s
-    case s
-    when /xes$/
+    if s.end_with? XES_STRING
       s[0..-3]
-    when /ies$/
-      s.sub(/ies$/, 'y')
-    when /s$/
+    elsif s.end_with? IES_STRING
+      s.sub(SINGULAR_RE, Y_STRING)
+    elsif s.end_with? S_STRING
       s[0..-2]
     else
-      s
+      s.dup
     end
   end
   module_function :singularize
 
+  UPPER_OR_NUM_RE = /([A-Z]|\d+)/.freeze
+
   def dasherize_class_name s
-    s.gsub(/([A-Z]|\d+)/){|str|"-#{str.downcase}"}[1..-1].gsub('::','-')
+    s.gsub(UPPER_OR_NUM_RE) {|str| "-#{str.downcase}" }[1..-1].gsub(CONST_SEP, DASH)
   end
   module_function :dasherize_class_name
 
+  DASH_LOWER_OR_NUM_RE = /\-([a-z0-9])/.freeze
+
   def undasherize_class_name s
-    s.capitalize.gsub(/\-([a-z0-9])/){|str|$1.upcase}.gsub('-','::')
+    s.capitalize.gsub(DASH_LOWER_OR_NUM_RE) {|str| $1.upcase }.gsub(DASH, CONST_SEP)
   end
   module_function :undasherize_class_name
 
   def resolve_class_name s, context=Kernel
-    current, *payload = s.to_s.split('::')
+    current, *payload = s.to_s.split(CONST_SEP)
     raise(NameError) if current.nil?
     const = context.const_get(current)
     if payload.empty?
       const
     else
-      resolve_class_name(payload.join('::'),const)
+      resolve_class_name(payload.join(CONST_SEP),const)
     end
   end
   module_function :resolve_class_name
@@ -67,12 +112,15 @@ module WebUtils
   end
   module_function :resolve_dasherized_class_name
 
+  START_UPPER_RE = /^[A-Z]/.freeze
+  START_LOWER_RE = /^[a-z]/.freeze
+
   def guess_related_class_name context, clue
     context.respond_to?(:name) ? context.name : context.to_s
     clue = clue.to_s
-    return clue if clue=~/^[A-Z]/
-    if clue=~/^[a-z]/
-      clue = undasherize_class_name singularize(clue).gsub('_','-')
+    return clue if clue =~ START_UPPER_RE
+    if clue =~ START_LOWER_RE
+      clue = undasherize_class_name singularize(clue).gsub(UNDERSCORE, DASH)
       clue = "::#{clue}"
     end
     "#{context}#{clue}"
@@ -96,39 +144,43 @@ module WebUtils
   module_function :deep_copy
 
   def ensure_key! h, k, v
-    h[k] = v unless h.key?(k)
-    h[k]
+    h.fetch(k) {|k| h.store(k, v) }
   end
   module_function :ensure_key!
 
   def ensure_key h, k, v
-    new_h = h.dup
-    self.ensure_key! new_h, k, v
-    new_h
+    {k=>v}.merge h
   end
   module_function :ensure_key
 
-  ACCENTS = "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž"
-  WITHOUT_ACCENTS = "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz"
+  ACCENTS = "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž".freeze
+  WITHOUT_ACCENTS = "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz".freeze
+  DASHIFY_RE = /(\-|[^0-9a-zA-Z])+/.freeze
+  EDGE_DASH_RE = /(\A-|-\z)/.freeze
+
   def slugify s, force_lower=true
     s = s.to_s
       .tr(ACCENTS, WITHOUT_ACCENTS)
-      .gsub(/&/, 'and')
-      .gsub(/%/, ' percent')
-      .gsub(/(\-|[^0-9a-zA-Z])+/,'-')
-      .gsub(/(^-|-$)/,'')
+      .gsub(AMPERSAND, AND_STRING)
+      .gsub(PERCENT, SPACE_PERCENT_STRING)
+      .gsub(DASHIFY_RE, DASH)
+      .gsub(EDGE_DASH_RE, EMPTY_STRING)
     s = s.downcase if force_lower
     escape(s)
   end
   module_function :slugify
 
+  ALPHA_NUM_RE = /[a-zA-Z0-9]+/.freeze
+
   def label_for_field field_name
-    field_name.to_s.scan(/[a-zA-Z0-9]+/).map(&:capitalize).join(' ')
+    field_name.to_s.scan(ALPHA_NUM_RE).map(&:capitalize).join(SPACE)
   end
   module_function :label_for_field
 
+  EACH_STUB_ERR_MSG = 'WebUtils.each_stub expects an object which respond to each_with_index.'
+
   def each_stub obj, &block 
-    raise TypeError, 'WebUtils.each_stub expects an object which respond to each_with_index' unless obj.respond_to?(:each_with_index)
+    raise TypeError, EACH_STUB_ERR_MSG unless obj.respond_to?(:each_with_index)
     obj.each_with_index do |(k,v),i|
       value = v || k
       if value.is_a?(Hash) || value.is_a?(Array)
@@ -140,7 +192,10 @@ module WebUtils
   end
   module_function :each_stub
 
-  TYPECASTABLE = [:bool, :boolean, :nil, :int, :integer, :float]
+  TYPECASTABLE = [:bool, :boolean, :nil, :int, :integer, :float].freeze
+  INT_RE = /\A-?\d+\z/.freeze
+  FLOAT_RE = /\A-?\d*\.\d+\z/.freeze
+
   def automatic_typecast str, casted=TYPECASTABLE 
     return str unless str.is_a?(String)
     casted = casted.map do |sym|
@@ -153,15 +208,15 @@ module WebUtils
         sym
       end
     end
-    if casted.include?(:boolean) and str=='true'
+    if casted.include?(:boolean) and str == TRUE_STRING
       true
-    elsif casted.include?(:boolean) and str=='false'
+    elsif casted.include?(:boolean) and str == FALSE_STRING
       false
-    elsif casted.include?(:nil) and str==''
+    elsif casted.include?(:nil) and str == EMPTY_STRING
       nil
-    elsif casted.include?(:integer) and str=~/^-?\d+$/
+    elsif casted.include?(:integer) and str =~ INT_RE
       str.to_i
-    elsif casted.include?(:float) and str=~/^-?\d*\.\d+$/
+    elsif casted.include?(:float) and str =~ FLOAT_RE
       str.to_f
     else
       str
@@ -169,23 +224,29 @@ module WebUtils
   end
   module_function :automatic_typecast
 
-  ID_CHARS = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+  ID_CHARS = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a).freeze.map(&:freeze)
   ID_SIZE = 16
+  DEPRECATED_RANDOM_ID_STRING = 'WebUtils::generate_random_id is deprecated. Use standard SecureRandom instead.'.freeze
+
   def generate_random_id size=ID_SIZE
-    warn "WebUtils::generate_random_id is deprecated. Use standard SecureRandom instead."
-    id = ''
+    warn DEPRECATED_RANDOM_ID_STRING
+    id = String.new
     size.times{id << ID_CHARS[rand(ID_CHARS.size)]} 
     id
   end
   module_function :generate_random_id
 
-  def nl2br s, br='<br>'
-    s.to_s.gsub(/\r?\n/,br)
+  RN_RE = /\r?\n/.freeze
+
+  def nl2br s, br=BR_TAG
+    s.to_s.gsub(RN_RE, br)
   end
   module_function :nl2br
 
+  COMPLETE_LINK_RE = /^(\/|[a-z]*:)/.freeze
+
   def complete_link link
-    if blank?(link) or link=~/^(\/|[a-z]*:)/
+    if blank?(link) or link =~ COMPLETE_LINK_RE
       link
     else
       "//#{link}"
@@ -193,14 +254,17 @@ module WebUtils
   end
   module_function :complete_link
 
+  EXTERNAL_LINK_RE = /\A[a-z]*:?\/\//.freeze
+
   def external_link? link
-    !!(link =~ /^[a-z]*:?\/\//)
+    !!(link =~ EXTERNAL_LINK_RE)
   end
   module_function :external_link?
 
-  EMAIL_REGEX = /([^\s]+@[^\s]*[a-zA-Z])/
-  LINK_REGEX = /\b((https?:\/\/|ftps?:\/\/|www\.)([A-Za-z0-9\-_=%&@\?\.\/]+))\b/
-  def automatic_html s, br='<br>'
+  EMAIL_REGEX = /([^\s]+@[^\s]*[a-zA-Z])/.freeze
+  LINK_REGEX = /\b((https?:\/\/|ftps?:\/\/|www\.)([A-Za-z0-9\-_=%&@\?\.\/]+))\b/.freeze
+
+  def automatic_html s, br=BR_TAG
     replaced = s.to_s.
     gsub(LINK_REGEX) do |str|
       url = complete_link $1
@@ -213,51 +277,69 @@ module WebUtils
   end
   module_function :automatic_html
 
-  TAG_REGEX = /<[^>]*>/
-  def truncate s,c=320,ellipsis='...'
+  TAG_REGEX = /<[^>]*>/.freeze
+  NL_RE = /\n/.freeze
+
+  def truncate s, c=320, ellipsis=ELLIPSIS
     s.to_s
-      .gsub(TAG_REGEX, '')
-      .gsub(/\n/, ' ')
-      .sub(/^(.{#{c}}\w*).*$/m, '\1'+ellipsis)
+      .gsub(TAG_REGEX, EMPTY_STRING)
+      .gsub(NL_RE, SPACE)
+      .sub(/^(.{#{c}}\w*).*$/m, ARG1_SUB+ellipsis)
   end
   module_function :truncate
 
+  QUERY_SPLITTER = /[^a-zA-Z0-9\&]+/.freeze
+
   def regex_for_query query, exhaustive=true
-    atoms = query.split(/[^a-zA-Z0-9\&]+/)
+    atoms = query.split(QUERY_SPLITTER)
     atom_patterns = atoms.map{|a| "(?=.*\\b#{a})" }
-    sep = exhaustive ? '' : '|'
-    regex = /#{atom_patterns.join(sep)}/i
+    sep = exhaustive ? EMPTY_STRING : PIPE
+    /#{atom_patterns.join(sep)}/i.freeze
   end
   module_function :regex_for_query
 
+  PRICE_ERR_MSG = 'The price needs to be the price in cents/pence as an integer'.freeze
+  PRICE_FMT = '%.2f'.freeze
+  NO_CENTS_RE = /\.00/.freeze
+  THOUSANDS_RE = /(\d{3})(?=\d)/.freeze
+  THOUSANDS_SUB = '\1,'.freeze
+
   def display_price int
     unless int.is_a?(Integer)
-      raise(TypeError, 'The price needs to be the price in cents/pence as an integer') 
+      raise(TypeError, PRICE_ERR_MSG)
     end
-    ("%.2f" % (int/100.0))
-      .sub(/\.00/, '')
+    (PRICE_FMT % (int/100.0))
+      .sub(NO_CENTS_RE, EMPTY_STRING)
       .reverse
-      .gsub(/(\d{3})(?=\d)/, '\\1,')
+      .gsub(THOUSANDS_RE, THOUSANDS_SUB)
       .reverse
   end
   module_function :display_price
 
+  PRICE_PARSE_ERR_MSG = 'The price needs to be parsed from a String'.freeze
+  SWITCH_DOT_COMMA_TR = ['.,'.freeze, ',.'.freeze].freeze
+  COMMA_BASED_PRICE_RE = /(\.\d\d\d|,\d\d?)\z/.freeze
+  NON_PRICE_CHARS_RE = /[^\d\.\-,]/.freeze
+
   def parse_price string
     unless string.is_a?(String)
-      raise(TypeError, 'The price needs to be parsed from a String') 
+      raise(TypeError, PRICE_PARSE_ERR_MSG) 
     end
-    string = string.gsub(/[^\d\.\-,]/, '')
-    if string[/\.\d\d\d$/] or string[/,\d\d?$/]
+    string = string.gsub(NON_PRICE_CHARS_RE, EMPTY_STRING)
+    if string[COMMA_BASED_PRICE_RE]
       # comma-based price 
-      string = string.tr '.,', ',.'
+      string = string.tr(*SWITCH_DOT_COMMA_TR)
     end
-    ("%.2f" % string.gsub(/,/, '')).gsub(/\./,'').to_i
+    (PRICE_FMT % string.gsub(COMMA, EMPTY_STRING)).gsub(DOT, EMPTY_STRING).to_i
   end
   module_function :parse_price
 
-  def branded_filename path, brand='WebUtils'
+  DEFAULT_BRAND = self.name
+  START_DOT_SLASH_RE = /\A\.\//.freeze
+
+  def branded_filename path, brand=DEFAULT_BRAND
     "#{File.dirname(path)}/#{brand}-#{File.basename(path)}"
-      .sub(/^\.\//,'')
+      .sub(START_DOT_SLASH_RE, EMPTY_STRING)
   end
   module_function :branded_filename
 
@@ -268,12 +350,14 @@ module WebUtils
   module_function :filename_variation
 
   def initial_request? request
-    return true unless request.referer=~URI.regexp
     URI.parse(request.referer).host!=request.host
+  rescue URI::InvalidURIError
+    return true
   end
   module_function :initial_request?
 
-  BOT_REGEX = /bot|crawl|slurp|spider/i
+  BOT_REGEX = /bot|crawl|slurp|spider/i.freeze
+
   def being_crawled? request
     request.user_agent =~ BOT_REGEX
   end

data/test/test_web_utils.rb

@@ -26,6 +26,9 @@ describe WebUtils do
     describe 'with nil' do
       it('is true') { assert utils.blank?(nil) }
     end
+    describe 'with false' do
+      it('is true') { assert utils.blank?(false) }
+    end
     describe 'with non-blank strings' do
       it 'is false' do
         ['a','abc', '  abc  '].each do |s|
@@ -54,6 +57,11 @@ describe WebUtils do
         assert_equal 'copies', utils.pluralize('copy')
       end
     end
+    it "Does not mutate input" do
+      input = 'bag'
+      utils.pluralize(input)
+      assert_equal 'bag', input
+    end
 
   end
 
@@ -72,6 +80,14 @@ describe WebUtils do
         assert_equal 'copy', utils.singularize('copies')
       end
     end
+    describe "The word does not seem plural" do
+      it "Returns the same" do
+        input = 'bag'
+        output = utils.singularize(input)
+        assert_equal 'bag', output
+        refute_same input, output
+      end
+    end
 
   end
 
@@ -350,14 +366,14 @@ describe WebUtils do
 
   describe '#generate_random_id' do
     it 'Has the correct format' do
-      out, err = capture_io do
-        assert_match /[a-zA-Z0-9]{16}/, utils.generate_random_id
+      _, err = capture_io do
+        assert_match(/[a-zA-Z0-9]{16}/, utils.generate_random_id )
       end
       assert_match "WebUtils::generate_random_id is deprecated", err
     end
     it 'Can have a specific length' do
-      out, err = capture_io do
-        assert_match /[a-zA-Z0-9]{32}/, utils.generate_random_id(32)
+      _, err = capture_io do
+        assert_match(/[a-zA-Z0-9]{32}/, utils.generate_random_id(32) )
       end
       assert_match "WebUtils::generate_random_id is deprecated", err
     end
@@ -508,13 +524,13 @@ describe WebUtils do
       assert_equal 2800, utils.parse_price('28')
     end
     it 'Ignores visual help but works with negative prices' do
-      assert_equal -1234567890, utils.parse_price('   £-12,345,678.90   ')
+      assert_equal(-1234567890, utils.parse_price('   £-12,345,678.90   ') )
     end
     it 'Parses comma-based prices - french/german style' do
       assert_equal 2390, utils.parse_price('23,90')
       assert_equal 2390, utils.parse_price('23,9')
       assert_equal 2000000, utils.parse_price('20.000')
-      assert_equal -1234567890, utils.parse_price('   £-12.345.678,90   ')
+      assert_equal(-1234567890, utils.parse_price('   £-12.345.678,90   ') )
     end
     it 'Raises when argument is not string' do
       assert_raises(TypeError) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mickael Riga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack