url_regex 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b54cf0655c5a8a50fa9fd49b1a2de6886a040f8b
-  data.tar.gz: ef1c34438f36acf88975b0ead1ce81bfd30b7982
+  metadata.gz: 0908e7a609c4471a328ebe341b1cbfab0c231439
+  data.tar.gz: 21ad64e6a6f5f69f864c7a41d87c7559e6c7d714
 SHA512:
-  metadata.gz: c32d4b0eda559e9753d38432e63328989a38b7f6991ec978f3a854d21544f06df4a1a68e6f7cf91a11ac8e6b4f255b2405e010dd1b31dec21da74c71e32a07d6
-  data.tar.gz: 07718688349b9cebbc4a353db0d60e328d52acdfd9683eb0713e80697bb6ef044dd6a1e04ef471f31383a687ce6ef7bd6e7be59fb4e85cffee848a0add650e10
+  metadata.gz: 0ce85ec9ee8f114b56637b32ce42ff78a0072806b3c99442f4317675d0917b1f70de123e876e754c812add2d00497711c6aeaf8d5d36fc110ff00ecff6581e33
+  data.tar.gz: bad8abe5797ca1790f1be3cc190ec6ca4d0f04ab3c9f0ee7fc8fb34868473c88662d5d5cc44d778c59b96715c7f27a5eaf70db582cb39d69cd6ac0be7a33b03b

data/README.md

@@ -1,18 +1,18 @@
 [![Build Status](https://travis-ci.org/amogil/url_regex.svg?branch=master)](https://travis-ci.org/amogil/url_regex)
 [![Code Climate](https://codeclimate.com/github/amogil/url_regex/badges/gpa.svg)](https://codeclimate.com/github/amogil/url_regex)
-[![GitHub version](https://badge.fury.io/gh/amogil%2Furl_regex.svg)](https://badge.fury.io/gh/amogil%2Furl_regex)
+[![Gem Version](https://badge.fury.io/rb/url_regex.svg)](https://badge.fury.io/rb/url_regex)
 [![Dependency Status](https://gemnasium.com/badges/github.com/amogil/url_regex.svg)](https://gemnasium.com/github.com/amogil/url_regex)
 
 # UrlRegex
 
 Provides the best known regex for validating and extracting URLs.
-It uses amazing job done by [Diego Perini](https://gist.github.com/dperini/729294) 
+It builds on amazing work done by [Diego Perini](https://gist.github.com/dperini/729294)
 and [Mathias Bynens](https://mathiasbynens.be/demo/url-regex).
 
-Why do we need a gem for this regex? 
+Why do we need a gem for this regex?
 
-- You don't need to watch changes and improvements of original regex.
-- You have an ability to slightly customize the regex: a scheme can be optional, can get the regex for validation or parsing.
+- You don't need to follow changes and improvements of original regex.
+- You can slightly customize the regex: a scheme can be optional, and you can get the regex for validation or parsing.
 
 ## Installation
 
@@ -33,12 +33,12 @@ Or install it yourself as:
 Get the regex:
 
     UrlRegex.get(options)
-    
+
 where options are:
 
 - `scheme_required` indicates that schema is required, defaults to `true`.
 
-- `mode` can gets either `:validation` or `:parsing`, defaults to `:validation`.
+- `mode` can gets either `:validation`, `:parsing` or `:javascript`, defaults to `:validation`.
 
 `:validation` asks to return the regex for validation, namely, with `\A` prefix, and with `\z` postfix.
 That means, it matches whole text:
@@ -47,17 +47,27 @@ That means, it matches whole text:
     # => false
     UrlRegex.get(mode: :validation).match('link: https://www.google.com').nil?
     # => true
-    
+
 `:parsing` asks to return the regex for parsing:
 
     str = 'links: google.com https://google.com?t=1'
     str.scan(UrlRegex.get(mode: :parsing))
     # => ["https://google.com?t=1"]
-        
+
     # schema is not required
     str.scan(UrlRegex.get(scheme_required: false, mode: :parsing))
     # => ["google.com", "https://google.com?t=1"]
 
+`:javascript` asks to return the regex formatted for use in Javascript files or as `pattern` attribute values on HTML inputs. For this purpose, you'd use the `source` method on the Regexp object instance in order to produce a string that Javascript will understand. These examples make use of the Rails `text_field` method to generate HTML input elements.
+
+    regex = UrlRegex.get(mode: :javascript)
+    text_field(:site, :url, pattern: regex.source)
+    # => <input type="text" id="site_url" name="site[url]" pattern="[javascript URL regex]" />
+
+    regex = UrlRegex.get(scheme_required: false, mode: :javascript)
+    text_field(:site, :url, pattern: regex.source)
+    # => <input type="text" id="site_url" name="site[url]" pattern="[javascript URL regex with optional scheme]" />
+
 `UrlRegex.get` returns regular Ruby's [Regex](http://ruby-doc.org/core-2.0.0/Regexp.html) object,
 so you can use it as usual.
 
@@ -66,18 +76,18 @@ All regexes are case-insensitive.
 ## FAQ
 
 Q: Hey, I want to parse HTML, but it doesn't work:
-    
+
     str = '<a href="http://google.com?t=1">Link</a>'
     str.scan(UrlRegex.get(mode: :parsing))
     # => "http://google.com?t=1">Link</a>"
-    
-A: Well, you probably know that parsing HTML with regex is 
+
+A: Well, you probably know that parsing HTML with regex is
 [a bad idea](https://stackoverflow.com/questions/1732348/regex-match-open-tags-except-xhtml-self-contained-tags).
 It requires matching corresponding open and close brackets, that makes the regex even more complicated.
 
 Q: How can I speed up processing?
 
-A: Generated regex depends only on options, so you can get the regex only once and cache it. 
+A: Generated regex depends only on options, so you can get the regex only once and cache it.
 
 ## Contributing
 
@@ -85,4 +95,4 @@ A: Generated regex depends only on options, so you can get the regex only once a
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request

data/lib/url_regex.rb

@@ -3,7 +3,6 @@ require 'url_regex/version'
 # Provides the best known regex for validating and extracting URLs.
 # It uses amazing job done by [Diego Perini](https://gist.github.com/dperini/729294)
 # and [Mathias Bynens](https://mathiasbynens.be/demo/url-regex).
-
 module UrlRegex
   # Returns the regex for URLs parsing or validating.
   #
@@ -12,49 +11,66 @@ module UrlRegex
   # @return [Regex] regex for parsing or validating
   def self.get(scheme_required: true, mode: :validation)
     raise ArgumentError, "wrong mode: #{mode}" if MODES.index(mode).nil?
+
     scheme = scheme_required ? PROTOCOL_IDENTIFIER : PROTOCOL_IDENTIFIER_OPTIONAL
-    mode == :validation ? /\A#{scheme} #{BASE}\z/xi : /#{scheme} #{BASE}/xi
+
+    case mode
+    when :validation
+      /\A#{scheme} #{BASE}\z/xi
+    when :parsing
+      /#{scheme} #{BASE}/xi
+    when :javascript
+      /^#{scheme}#{JAVASCRIPT_BASE}$/
+    end
   end
 
   BASE = '
-    # user:pass authentication
-    (?:\S+(?::\S*)?@)?
+  # user:pass authentication
+  (?:\S+(?::\S*)?@)?
 
-    (?:
-      # IP address exclusion
-      # private & local networks
-      (?!(?:10|127)(?:\.\d{1,3}){3})
-      (?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})
-      (?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})
-      # IP address dotted notation octets
-      # excludes loopback network 0.0.0.0
-      # excludes reserved space >= 224.0.0.0
-      # excludes network & broadcast addresses
-      # (first & last IP address of each class)
-      (?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])
-      (?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}
-      (?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))
-      |
-      # host name
-      (?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)
-      # domain name
-      (?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*
-      # TLD identifier
-      (?:\.(?:[a-z\u00a1-\uffff]{2,}))
-      # TLD may end with dot
-      \.?
-    )
-
-    # port number
-    (?::\d{2,5})?
-
-    # resource path
-    (?:[/?#]\S*)?
-  '.freeze
+  (?:
+    # IP address exclusion
+    # private & local networks
+    (?!(?:10|127)(?:\.\d{1,3}){3})
+    (?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})
+    (?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})
+    # IP address dotted notation octets
+    # excludes loopback network 0.0.0.0
+    # excludes reserved space >= 224.0.0.0
+    # excludes network & broadcast addresses
+    # (first & last IP address of each class)
+    (?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])
+    (?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}
+    (?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))
+    |
+    # host name
+    (?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)
+    # domain name
+    (?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*
+    # TLD identifier
+    (?:\.(?:[a-z\u00a1-\uffff]{2,}))
+    # TLD may end with dot
+    \.?
+  )
+
+  # port number
+  (?::\d{2,5})?
+
+  # resource path
+  (?:[/?#]\S*)?
+'.freeze
+
+  JAVASCRIPT_BASE = '
+    (?:\S+(?::\S*)?@)?
+    (?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})
+    (?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])
+    (?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|
+    (?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*
+    (?:\.(?:[a-z\u00a1-\uffff]{2,}))\.?)(?::\d{2,5})?(?:[/?#]\S*)?'.gsub(/\s+/, '').freeze
 
   PROTOCOL_IDENTIFIER = '(?:(?:https?|ftp)://)'.freeze
   PROTOCOL_IDENTIFIER_OPTIONAL = '(?:(?:https?|ftp)://)?'.freeze
-  MODES = [:validation, :parsing].freeze
+  MODES = [:validation, :parsing, :javascript].freeze
 
   private_constant :BASE, :PROTOCOL_IDENTIFIER, :PROTOCOL_IDENTIFIER_OPTIONAL, :MODES
 end

data/lib/url_regex/version.rb

@@ -1,3 +1,3 @@
 module UrlRegex
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/spec/url_regex_spec.rb

@@ -6,8 +6,9 @@ describe UrlRegex do
       expect(UrlRegex.get(mode: :parsing)).to be
     end
 
-    it 'should raise ArgumentError if mode neither :validation nor :parsing' do
+    it 'should raise ArgumentError if mode neither :validation nor :parsing nor :javascript' do
       expect { UrlRegex.get(mode: nil) }.to raise_error ArgumentError
+      expect { UrlRegex.get(mode: :hahaha) }.to raise_error ArgumentError
     end
   end
 
@@ -56,6 +57,10 @@ describe UrlRegex do
       it "should match #{valid_url}" do
         expect(UrlRegex.get(scheme_required: true)).to match valid_url
       end
+
+      it "should match #{valid_url} against Javascript regex" do
+        expect(UrlRegex.get(scheme_required: true, mode: :javascript)).to match valid_url
+      end
     end
 
     [
@@ -100,6 +105,10 @@ describe UrlRegex do
       it "should not match #{invalid_url}" do
         expect(UrlRegex.get(scheme_required: true)).to_not match invalid_url
       end
+
+      it "should not match #{invalid_url} against Javascript regex" do
+        expect(UrlRegex.get(scheme_required: true, mode: :javascript)).to_not match invalid_url
+      end
     end
   end
 
@@ -149,6 +158,10 @@ describe UrlRegex do
       it "should match #{valid_url}" do
         expect(UrlRegex.get(scheme_required: false)).to match valid_url
       end
+
+      it "should match #{valid_url} against Javascript regex" do
+        expect(UrlRegex.get(scheme_required: false, mode: :javascript)).to match valid_url
+      end
     end
 
     [
@@ -191,6 +204,10 @@ describe UrlRegex do
       it "should not match #{invalid_url}" do
         expect(UrlRegex.get(scheme_required: false)).to_not match invalid_url
       end
+
+      it "should not match #{invalid_url} against Javascript regex" do
+        expect(UrlRegex.get(scheme_required: false, mode: :javascript)).to_not match invalid_url
+      end
     end
   end
 

data/url_regex.gemspec

@@ -6,7 +6,7 @@ require 'url_regex/version'
 Gem::Specification.new do |spec|
   spec.name          = 'url_regex'
   spec.version       = UrlRegex::VERSION
-  spec.authors       = ['Alexey Mogilnikov']
+  spec.authors       = ['Alexey Mogilnikov', 'Michael Bester']
   spec.email         = ['alexey@mogilnikov.name']
   spec.summary       = 'Provides the best regex for validating or extracting URLs.'
   spec.description   = 'Provides the best regex for validating or extracting URLs.'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: url_regex
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexey Mogilnikov
+- Michael Bester
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides the best regex for validating or extracting URLs.