web-utils 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9092bbc88a4edc5b36139415b3ab2696b94a2cf1
-  data.tar.gz: ef75ff41c727b948930fd406b11c9c4ed568c2e7
+  metadata.gz: fe05079e7ef8fd8cb746476a6c91cfa6ca4a76db
+  data.tar.gz: 4adc890b7732c60962b739ad908eef2c8b3ce4ff
 SHA512:
-  metadata.gz: ccb2d2015f992091d2ca80dddb580820789ecd946944e46c683bec2324db658182d57f19821b1f3550cab62d3c98b1b4475fb06b97f8e1dc5c9d6e85756d1a1d
-  data.tar.gz: 24e85f2f6d86858861d9b6d872abee962c1ac39e431e264ed41adbbfe820731f3073a5fd4e1afe3f787bc02f605e999a7f17f1a7073accad9df73909a9e6b247
+  metadata.gz: ada4be5ff78d2747e405a7f71a1649d3bae9708a3c84b1d0cbd16b8e28ceda8e77b46fda60d929b3df9cb900b083ff4d69206a9eee5046f3dfaf48242ca9b553
+  data.tar.gz: 8a14f5837d0298616675d3504fec6ada2993a8264da9167e419b5e206ace34c48b1c3065d4031e67eadecd875b60db80e89f33d8c2d17fe1475935de14016866

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 gemspec
-gem 'minitest', '>=5.8.0'
 

data/README.md

@@ -6,8 +6,8 @@ methods that are quite common to have in a web project.
 It is organized like `Rack::Utils` and actually extends it.
 
 Some of the methods are similar to methods you would have 
-in `Active::Support` but without monkey patching. Although it
-is only a coincidence. The purpose is not to build an alternative.
+in `Active::Support` but without monkey patching. Nevertheless it
+is only a coincidence. The purpose is not to create an alternative.
 
 Here is how you would use it with `Sinatra`:
 
@@ -27,7 +27,7 @@ class Main < Sinatra::Base
 end
 ```
 
-Some methods are also useful on the model side.
+Some methods are also useful on the model side of your app.
 
 Here is a list of the available methods and what they do:
 
@@ -39,31 +39,34 @@ Just tells you if the string is blank or not.
 `pluralize(string)`
 -------------------
 
-Pluralize simple words. Just override when necessary.
+Find a plural version for words. It is meant to deal with most common cases 
+and therefore is not exhaustive.
 
 `singularize(string)`
 -------------------
 
-Singularize simple words. Just override when necessary.
+Basically the opposite of `pluralize`.
 
 `dasherize_class_name(string)`
 ------------------------------
 
-Dasherize class names. Module separator is a double dash. 
-So `BlogArticle::Comment` becomes `blog-article--comment`. 
-Also for simplicity, it does not gather accronyms. e.g. `net--f-t-p`.
+Turns class names into a dasherized version (e.g. `"web-utils"`). 
+Module separator is a double dash. 
+So `"BlogArticle::Comment"` becomes `"blog-article--comment"`. 
+Also for simplicity, it does not try to be clever with accronyms. 
+So `"Net::FTP"` returns `"net--f-t-p"`.
 This is useful for urls or creating CSS class names or IDs.
 
 `undasherize_class_name(string)`
 --------------------------------
 
-Basically the opposite.
+Basically the opposite of `dasherize_class_name`.
 
 `resolve_class_name(string, context=Kernel)`
 --------------------------------------------
 
 It takes the class name as a string and returns the class.
-You can pass a class name with modules as well (e.g. "Net::FTP").
+You can pass a class name with modules as well (e.g. `"Net::FTP"`).
 This is actually the main reason why there is a `context`
 argument, because it uses recursion to do this.
 But `context` is still useful otherwise.
@@ -81,7 +84,7 @@ Useful for resolving a class from a URL param.
 It is mainly used for guessing the class name of a 
 children class with a plural name. 
 So `guess_related_class_name(BlogArticle, :comments)` 
-will return `'BlogArticle::Comment'`.
+will return `"BlogArticle::Comment"`.
 
 `get_value(value, target=Kernel)`
 ----------------------------------
@@ -120,7 +123,7 @@ default value. And this value is also returned by the method.
 --------------------------------------
 
 Same as `ensure_key!` except that it does not change the original
-hash. It returns a new one.
+hash. It returns a new one (following the bang convention).
 
 `slugify(string, force_lowercase=true)`
 -----------------
@@ -128,14 +131,15 @@ hash. It returns a new one.
 This makes the strings ready to be used as a slug in a URL. 
 It removes the accents, replaces a lot of separators with 
 dashes and escapes it. By default it forces the output to 
-be lowercase, but if you pass `false` as a second argument, 
+be lowercase, but if you pass `false` as the second argument, 
 it will not change the case of letters.
 
 `label_for_field(string_or_symbol)`
 -----------------------------------
 
 Returns a human readable version of a field name.
-It says `field`, but it could be any kind of symbol I guess.
+So `:label_for_field` returns `"Label for field"`.
+It says `field`, but it could be used with any kind of symbol.
 
 `each_stub(nested_object) {|object,key_or_index,value| ... }`
 -------------------------------------------------------------
@@ -154,7 +158,7 @@ simple things like `true`, `false`, integers and floats.
 And an empty string is always `nil`.
 
 The second argument is the list of things you want to typecast.
-By default there is everything, but you only want to typecast
+By default there is everything, but if you only want to typecast
 integers and floats, you can pass `[:int, :float]`.
 
 `generate_random_id(size)` 
@@ -176,17 +180,18 @@ Just in case you want self-closing tags.
 -----------------------
 
 This just makes sure that a link is complete. Very often 
-people tend to enter a URL like `www.google.com` which is a 
-controversial `href` for some browsers, so it changes it to 
-`//www.google.com`. Already seemingly complete links are not
+people tend to enter a URL like `"www.google.com"` which is a 
+controversial `href` for some browsers. This method would change it for
+`"//www.google.com"`. Already seemingly complete links are not
 affected by the method.
 
 `external_link?(string)` 
 ------------------------
 
 This tells you if a link is pointing to the current site or 
-an external one. This is useful when you want to create a link 
-tag and want to decide if target is `'_blank'` or `'_self'`.
+an external one (based on the presence of a domain name or not). 
+This is useful when you want to create a link 
+tag and want to decide if target is `"_blank"` or `"_self"`.
 
 `automatic_html(string, br="<br>")`
 -----------------------------------
@@ -199,16 +204,27 @@ is quite useful, should it be only for turning an email into a link.
 --------------------------------------------
 
 It truncates a string like what you have in blog summaries. 
-It automatically removes tags and line breaks. The length is 
+It automatically removes tags and line breaks. The size is 
 320 by default. When the original string was longer, it puts 
 an ellipsis at the end which can be replaced by whatever you put 
-as a 3rd argument. e.g. `'...and more'`.
+as a 3rd argument. e.g. `"...and more"`.
+
+`regex_for_query(query, exhaustive=true)`
+-----------------------------------------
+
+It takes a query string (potentially from a search field) and
+builds a regex for matching a string which contains all the words
+of the query, whatever order they appear in.
+
+If you pass `false` as the second argument, the regex will match
+if the text contains at least one word of the query instead of all.
+
 
 `display_price(int)` 
 --------------------
 
 It changes a price in cents/pence into a formated string 
-like `49,425.40` when you pass `4942540`.
+like `"49,425.40"` when you pass `4942540`.
 
 `parse_price(string)`
 ---------------------
@@ -221,29 +237,29 @@ order to return a price in cents/pence.
 
 It takes the path to a file and add the brand/prefix and a dash 
 before the file name (really the file name, not the path). 
-By default, the brand/prefix is `WebUtils`.
+By default, the brand/prefix is `"WebUtils"`.
 
 `filename_variation(path, variation, ext)`
 ------------------------------------------
 
-For example you have a file `/path/to/image.jpg` and you want 
-to create its `thumbnail` in `png`, you can create the thumnail 
+For example you have a file `"/path/to/image.jpg"` and you want 
+to create its `thumbnail` in `png`, you can create the thumbnail 
 path with `filename_variation(path, :thumbnail, :png)` and it 
-will return `/path/to/image.thumbnail.png`.
+will return `"/path/to/image.thumbnail.png"`.
 
 `initial_request?(request)`
 ---------------------------
 
 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.
+domain. Essentially tells you if the visitor just arrived on your website.
 
-`beeing_crawled?(request)`
+`being_crawled?(request)`
 --------------------------
 
-While this method is useful is only checks the presence of
+While this method is useful, it only checks for 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 
+agent is a crawler or not. So it is pretty basic. If you have a 
 better way, please make a pull request.
 
 `h(text)`

data/lib/web_utils.rb

@@ -5,6 +5,8 @@ require 'uri'
 
 module WebUtils
 
+  VERSION = '0.0.4'
+
   # Most methods are supposed to be as simple as possible
   # and just cover most cases.
   # I would rather override specific cases rather than making
@@ -221,6 +223,14 @@ module WebUtils
   end
   module_function :truncate
 
+  def regex_for_query query, exhaustive=true
+    atoms = query.split(/[^a-zA-Z0-9\&]+/)
+    atom_patterns = atoms.map{|a| "(?=.*\\b#{a})" }
+    sep = exhaustive ? '' : '|'
+    regex = /#{atom_patterns.join(sep)}/i
+  end
+  module_function :regex_for_query
+
   def display_price int
     unless int.is_a?(Integer)
       raise(TypeError, 'The price needs to be the price in cents/pence as an integer') 
@@ -260,10 +270,10 @@ module WebUtils
   module_function :initial_request?
 
   BOT_REGEX = /bot|crawl|slurp|spider/i
-  def beeing_crawled? request
+  def being_crawled? request
     request.user_agent =~ BOT_REGEX
   end
-  module_function :beeing_crawled?
+  module_function :being_crawled?
 
   def h text
     escape_html text

data/test/test_web_utils.rb

@@ -434,6 +434,40 @@ describe WebUtils do
     end
   end
 
+  describe '#regex_for_query' do
+    it 'Builds a Regex for matching all words in any order' do
+      [
+        ['hello', 'hello'],
+        ['hello', 'say hello to me'],
+        ['hello world', 'hello world'],
+        ['hello world', 'the world says hello'],
+        ['hello/world', 'the world says hello'],
+      ].each do |i|
+        assert_match utils.regex_for_query(i[0]), i[1]
+      end
+      [
+        ['hello', 'say aloha to me'],
+        ['hello world', 'say hello to me'],
+        ['hello', ''],
+      ].each do |i|
+        refute_match utils.regex_for_query(i[0]), i[1]
+      end
+    end
+    it 'Builds a Regex for matching at least one word if exhautive is false' do
+      [
+        ['hello world', 'say hello to me'],
+        ['hello aloha say', 'say hello to me'],
+      ].each do |i|
+        assert_match utils.regex_for_query(i[0], false), i[1]
+      end
+      [
+        ['hello world', 'say aloha to me'],
+      ].each do |i|
+        refute_match utils.regex_for_query(i[0], false), i[1]
+      end
+    end
+  end
+
   describe '#display_price' do
     it 'Turns a price number in cents/pence into a displayable one' do
       assert_equal '45.95', utils.display_price(4595)
@@ -522,7 +556,7 @@ describe WebUtils do
     end
   end
 
-  describe '#beeing_crawled?' do
+  describe '#being_crawled?' do
     let(:req) { 
       Rack::Request.new(
         Rack::MockRequest.env_for(
@@ -534,13 +568,13 @@ describe WebUtils do
     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)
+        assert utils.being_crawled?(req)
       end
     end
     describe 'When user does not match' do
       let(:user_agent) {'Firefox'}
       it 'Returns false' do
-        refute utils.beeing_crawled?(req)
+        refute utils.being_crawled?(req)
       end
     end
   end

data/web-utils.gemspec

@@ -1,3 +1,9 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift lib
+require 'web_utils'
+
 Gem::Specification.new do |s|
 
   s.authors = ['Mickael Riga']
@@ -6,7 +12,7 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
 
   s.name = 'web-utils'
-  s.version = '0.0.3'
+  s.version = WebUtils::VERSION
   s.summary = 'Web Utils'
   s.description = 'Useful web-related helper methods for models, views or controllers.'
 
@@ -14,7 +20,11 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n").sort
   s.test_files = s.files.grep(/^test\//)
   s.require_paths = ['lib']
-  s.add_dependency('rack', [">= 1.0"])
+
+  s.add_dependency 'rack', '>= 1.0'
+
+  s.add_development_dependency 'bundler', '~> 1.13'
+  s.add_development_dependency 'minitest', '~> 5.8'
 
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web-utils
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mickael Riga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
 description: Useful web-related helper methods for models, views or controllers.
 email:
 - mig@mypeplum.com
@@ -58,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Web Utils