web-utils 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca8ae69eb4a0fde95c62144ea4ad33f8ddd26477
-  data.tar.gz: aa1896fd54255e252501c67c95bc65641de3c49e
+  metadata.gz: 9092bbc88a4edc5b36139415b3ab2696b94a2cf1
+  data.tar.gz: ef75ff41c727b948930fd406b11c9c4ed568c2e7
 SHA512:
-  metadata.gz: cd1edd091b80284111396eff8ce88d4d60de03612d06234a1ec62e4d1e63692816d02b819a96a9899670bea648fbb7be63c1b95b8b58b6fc57be5c2da5f0a5b7
-  data.tar.gz: a0b99d48ff654863b1cdbe233c5f16af8a43fcce966a7564593a9faa77f6a70fbfb352d3c5c2d4fe11672b91166af6f60f254e7373b0d8756838bb45823e7400
+  metadata.gz: ccb2d2015f992091d2ca80dddb580820789ecd946944e46c683bec2324db658182d57f19821b1f3550cab62d3c98b1b4475fb06b97f8e1dc5c9d6e85756d1a1d
+  data.tar.gz: 24e85f2f6d86858861d9b6d872abee962c1ac39e431e264ed41adbbfe820731f3073a5fd4e1afe3f787bc02f605e999a7f17f1a7073accad9df73909a9e6b247

data/README.md

@@ -238,5 +238,23 @@ You basically pass the `Request` object to the method and it
 looks at the referrer and returns true if it was not on the same
 domain. Essentially tells you if the visitor just arrived.
 
+`beeing_crawled?(request)`
+--------------------------
+
+While this method is useful is only checks the presence of
+these words `/bot|crawl|slurp|spider/i` to determine if the user
+agent is a crawler or not. So it is pretty weak. If you have a 
+better way, please make a pull request.
+
+`h(text)`
+---------
+
+Just the usual shortcut for `Rack::Utils.escape_html`.
+
+`u(text)`
+---------
+
+Just the usual shortcut for `Rack::Utils.escape` for escaping 
+what you want to put in a URL.
 
 

data/lib/web_utils.rb

@@ -106,12 +106,17 @@ module WebUtils
   end
   module_function :ensure_key
 
-  ACCENTS_FROM = 
+  ACCENTS = 
     "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞ"
-  ACCENTS_TO = 
+  WITHOUT_ACCENTS = 
     "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssT"
   def slugify s, force_lower=true
-    s = s.to_s.tr(ACCENTS_FROM,ACCENTS_TO).tr(' .,;:?!/\'"()[]{}<>','-').gsub(/&/, 'and').gsub(/-+/,'-').gsub(/(^-|-$)/,'')
+    s = s.to_s
+      .tr(ACCENTS, WITHOUT_ACCENTS)
+      .tr(' .,;:?!/\'"()[]{}<>','-')
+      .gsub(/&/, 'and')
+      .gsub(/-+/,'-')
+      .gsub(/(^-|-$)/,'')
     s = s.downcase if force_lower
     escape(s)
   end
@@ -135,15 +140,26 @@ module WebUtils
   end
   module_function :each_stub
 
-  def automatic_typecast str, casted=[:bool,:nil,:int,:float] 
+  TYPECASTABLE = [:bool, :boolean, :nil, :int, :integer, :float]
+  def automatic_typecast str, casted=TYPECASTABLE 
     return str unless str.is_a?(String)
-    if casted.include?(:bool) and str=='true'
+    casted = casted.map do |sym|
+      case sym
+      when :int
+        :integer
+      when :bool
+        :boolean
+      else
+        sym
+      end
+    end
+    if casted.include?(:boolean) and str=='true'
       true
-    elsif casted.include?(:bool) and str=='false'
+    elsif casted.include?(:boolean) and str=='false'
       false
     elsif casted.include?(:nil) and str==''
       nil
-    elsif casted.include?(:int) and str=~/^-?\d+$/
+    elsif casted.include?(:integer) and str=~/^-?\d+$/
       str.to_i
     elsif casted.include?(:float) and str=~/^-?\d*\.\d+$/
       str.to_f
@@ -181,38 +197,53 @@ module WebUtils
   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>'
     replaced = s.to_s.
-    gsub(/\b((https?:\/\/|ftps?:\/\/|www\.)([A-Za-z0-9\-_=%&@\?\.\/]+))\b/) do |str|
+    gsub(LINK_REGEX) do |str|
       url = complete_link $1
       "<a href='#{url}' target='_blank'>#{$1}</a>"
     end.
-    gsub(/([^\s]+@[^\s]*[a-zA-Z])/) do |str|
+    gsub(EMAIL_REGEX) do |str|
       "<a href='mailto:#{$1.downcase}'>#{$1}</a>"
     end
     nl2br(replaced,br).gsub("@", "&#64;")
   end
   module_function :automatic_html
 
+  TAG_REGEX = /<[^>]*>/
   def truncate s,c=320,ellipsis='...'
-    s.to_s.gsub(/<[^>]*>/, '').gsub(/\n/, ' ').sub(/^(.{#{c}}\w*).*$/m, '\1'+ellipsis)
+    s.to_s
+      .gsub(TAG_REGEX, '')
+      .gsub(/\n/, ' ')
+      .sub(/^(.{#{c}}\w*).*$/m, '\1'+ellipsis)
   end
   module_function :truncate
 
   def display_price int
-    raise(TypeError, 'The price needs to be the price in cents/pence as an integer') unless int.is_a?(Integer)
-    ("%.2f" % (int/100.0)).sub(/\.00/, '').reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+    unless int.is_a?(Integer)
+      raise(TypeError, 'The price needs to be the price in cents/pence as an integer') 
+    end
+    ("%.2f" % (int/100.0))
+      .sub(/\.00/, '')
+      .reverse
+      .gsub(/(\d{3})(?=\d)/, '\\1,')
+      .reverse
   end
   module_function :display_price
 
   def parse_price string
-    raise(TypeError, 'The price needs to be parsed from a String') unless string.is_a?(String)
+    unless string.is_a?(String)
+      raise(TypeError, 'The price needs to be parsed from a String') 
+    end
     ("%.2f" % string.gsub(/[^\d\.\-]/, '')).gsub(/\./,'').to_i
   end
   module_function :parse_price
 
   def branded_filename path, brand='WebUtils'
-    "#{File.dirname(path)}/#{brand}-#{File.basename(path)}".sub(/^\.\//,'')
+    "#{File.dirname(path)}/#{brand}-#{File.basename(path)}"
+      .sub(/^\.\//,'')
   end
   module_function :branded_filename
 
@@ -228,5 +259,21 @@ module WebUtils
   end
   module_function :initial_request?
 
+  BOT_REGEX = /bot|crawl|slurp|spider/i
+  def beeing_crawled? request
+    request.user_agent =~ BOT_REGEX
+  end
+  module_function :beeing_crawled?
+
+  def h text
+    escape_html text
+  end
+  module_function :h
+
+  def u text
+    escape text
+  end
+  module_function :u
+
 end
 

data/test/test_web_utils.rb

@@ -329,6 +329,8 @@ describe WebUtils do
       it 'Can change what is typecasted' do
         assert_equal '10', utils.automatic_typecast('10', [:bool,:nil])
         assert_equal true, utils.automatic_typecast('true', [:bool,:nil])
+        assert_equal '10', utils.automatic_typecast('10', [])
+        assert_equal '10', utils.automatic_typecast('10', [:fake])
       end
     end
     describe 'when not a string' do
@@ -520,5 +522,41 @@ describe WebUtils do
     end
   end
 
+  describe '#beeing_crawled?' do
+    let(:req) { 
+      Rack::Request.new(
+        Rack::MockRequest.env_for(
+          '/path', 
+          {'HTTP_USER_AGENT'=>user_agent}
+        )
+      ) 
+    }
+    describe 'When user agent matches' do
+      let(:user_agent) {'Mega Bot from hell Version 6.6.6'}
+      it 'Returns true' do
+        assert utils.beeing_crawled?(req)
+      end
+    end
+    describe 'When user does not match' do
+      let(:user_agent) {'Firefox'}
+      it 'Returns false' do
+        refute utils.beeing_crawled?(req)
+      end
+    end
+  end
+
+  describe '#h' do
+    it 'Is sugar for Rack::Utils#escape_html' do
+      assert_equal '&lt;tag&gt;Boom&lt;&#x2F;tag&gt;', utils.h('<tag>Boom</tag>')
+    end
+  end
+
+  describe '#u' do
+    it 'Is sugar for Rack::Utils#escape' do
+      assert_equal '%2Ffilthy%2Furl%3Fmother%3Dfucker', utils.u('/filthy/url?mother=fucker')
+    end
+  end
+
+
 end
 

data/web-utils.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
 
   s.name = 'web-utils'
-  s.version = '0.0.2'
+  s.version = '0.0.3'
   s.summary = 'Web Utils'
   s.description = 'Useful web-related helper methods for models, views or controllers.'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web-utils
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mickael Riga