uri_format_validator 0.1.0 → 0.2.1

data/.travis.yml

@@ -7,13 +7,13 @@ before_install:
 
 script:
   - bundle exec rspec
+  - bundle exec cucumber
 
 rvm:
   - "2.4"
   - "2.3"
   - "2.2.2"
   - "ruby-head"
-  - "rbx-3"
   - "jruby"
   - "jruby-head"
 

data/CHANGELOG.adoc

@@ -1,6 +1,13 @@
 == Not released yet
 
-== 1.0.0
+== 0.2.0
+
+* Drop support for Rubinius
+* Rename validator from `uri_format` to `uri`
+* Add first Cucumber + Aruba living documentation
+* Switch to Addressable's URI parser
+
+== 0.1.0
 
 * Improve error message in English, add Polish translation
 * First useful version

data/README.adoc

@@ -31,7 +31,7 @@ in your models, like that:
 [source,ruby]
 ----
 class User < ActiveRecord::Base
-  validates :home_site_url, uri_format: true
+  validates :home_site_url, uri: true
 end
 ----
 
@@ -53,28 +53,28 @@ and fragment.
 
 [source,ruby]
 ----
-validates :home_site_url, uri_format: { scheme: /https?/ }
-validates :home_site_url, uri_format: { scheme: %w[ssh telnet] }
+validates :home_site_url, uri: { scheme: /https?/ }
+validates :home_site_url, uri: { scheme: %w[ssh telnet] }
 
-validates :home_site_url, uri_format: { authority: /\.example\./ }
-validates :home_site_url, uri_format: { authority: %w[example.com example.test] }
+validates :home_site_url, uri: { authority: /\.example\./ }
+validates :home_site_url, uri: { authority: %w[example.com example.test] }
 
 # require path component (`/` is not enough)
-validates :home_site_url, uri_format: { path: true }
+validates :home_site_url, uri: { path: true }
 # disallow presence of path component
-validates :home_site_url, uri_format: { path: false }
+validates :home_site_url, uri: { path: false }
 # match path against regular expression
-validates :home_site_url, uri_format: { path: /regexp/ }
+validates :home_site_url, uri: { path: /regexp/ }
 
 # require query component
-validates :home_site_url, uri_format: { query: true }
+validates :home_site_url, uri: { query: true }
 # disallow presence of query component
-validates :home_site_url, uri_format: { query: false }
+validates :home_site_url, uri: { query: false }
 
 # require fragment component
-validates :home_site_url, uri_format: { fragment: true }
+validates :home_site_url, uri: { fragment: true }
 # disallow presence of fragment component
-validates :home_site_url, uri_format: { fragment: false }
+validates :home_site_url, uri: { fragment: false }
 ----
 
 When `scheme` option is unspecified, only http and https are allowed.
@@ -86,7 +86,7 @@ to allow relative and disallow absolute URLs:
 
 [source,ruby]
 ----
-validates :home_site_url, uri_format: { authority: false }
+validates :home_site_url, uri: { authority: false }
 ----
 
 === Reachable URLs
@@ -97,7 +97,7 @@ with 2xx status code.  Otherwise, given value is considered invalid.
 
 [source,ruby]
 ----
-validates :home_site_url, uri_format: { retrievable: true }
+validates :home_site_url, uri: { retrievable: true }
 ----
 
 === Error messages
@@ -106,7 +106,7 @@ You can also override the default error message:
 
 [source,ruby]
 ----
-validates :my_url_attribute, uri_format: true, message: 'is not a valid URL'
+validates :my_url_attribute, uri: true, message: 'is not a valid URL'
 ----
 
 Alternatively, you can provide your own localization string for

data/bin/cucumber

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'cucumber' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("cucumber", "cucumber")

data/gemfiles/common.gemfile

@@ -1,7 +1,10 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec path: '..'
+gemspec path: ".."
 
-gem 'codecov', require: false, group: :test
-gem 'rubocop', require: false
-gem 'simplecov', require: false, group: :test
+# These ones are specified here because we don't want them to be autorequired
+# for some reasons.  For instance, Rubocop won't work under Rubinius
+# (dependencies do utilize refinements).
+gem "codecov", require: false
+gem "rubocop", require: false
+gem "simplecov", require: false

data/gemfiles/rails-4.0.gemfile

@@ -1,3 +1,4 @@
-eval File.read(File.expand_path('../common.gemfile', __FILE__))
+# rubocop:disable Security/Eval
+eval File.read(File.expand_path("../common.gemfile", __FILE__))
 
-gem 'activemodel', '~> 4.0.0'
+gem "activemodel", "~> 4.0.0"

data/gemfiles/rails-4.1.gemfile

@@ -1,3 +1,4 @@
-eval File.read(File.expand_path('../common.gemfile', __FILE__))
+# rubocop:disable Security/Eval
+eval File.read(File.expand_path("../common.gemfile", __FILE__))
 
-gem 'activemodel', '~> 4.1.0'
+gem "activemodel", "~> 4.1.0"

data/gemfiles/rails-4.2.gemfile

@@ -1,3 +1,4 @@
-eval File.read(File.expand_path('../common.gemfile', __FILE__))
+# rubocop:disable Security/Eval
+eval File.read(File.expand_path("../common.gemfile", __FILE__))
 
-gem 'activemodel', '~> 4.2.0'
+gem "activemodel", "~> 4.2.0"

data/gemfiles/rails-5.0.gemfile

@@ -1,3 +1,4 @@
-eval File.read(File.expand_path('../common.gemfile', __FILE__))
+# rubocop:disable Security/Eval
+eval File.read(File.expand_path("../common.gemfile", __FILE__))
 
-gem 'activemodel', '~> 5.0.0'
+gem "activemodel", "~> 5.0.0"

data/gemfiles/rails-5.1.gemfile

@@ -1,3 +1,4 @@
-eval File.read(File.expand_path('../common.gemfile', __FILE__))
+# rubocop:disable Security/Eval
+eval File.read(File.expand_path("../common.gemfile", __FILE__))
 
-gem 'activemodel', '~> 5.1.0'
+gem "activemodel", "~> 5.1.0"

data/gemfiles/rails-head.gemfile

@@ -1,3 +1,4 @@
-eval File.read(File.expand_path('../common.gemfile', __FILE__))
+# rubocop:disable Security/Eval
+eval File.read(File.expand_path("../common.gemfile", __FILE__))
 
-gem 'activemodel', github: 'rails/rails'
+gem "activemodel", github: "rails/rails"

data/lib/uri_format_validator/validators.rb

@@ -1,7 +1,7 @@
 # (c) Copyright 2017 Ribose Inc.
 #
 
-require "uri_format_validator/validators/uri_format_validator"
+require "uri_format_validator/validators/uri_validator"
 require "uri_format_validator/validators/helper_methods"
 
 module UriFormatValidator

data/lib/uri_format_validator/validators/helper_methods.rb

@@ -12,7 +12,7 @@ module UriFormatValidator
       #     validates_uri_format_of :permalink
       #   end
       def validates_uri_format_of(*attr_names)
-        validates_with UriFormatValidator, _merge_attributes(attr_names)
+        validates_with UriValidator, _merge_attributes(attr_names)
       end
     end
   end

data/lib/uri_format_validator/validators/{uri_format_validator.rb → uri_validator.rb}

@@ -2,7 +2,7 @@
 #
 
 require "active_model"
-require "uri"
+require "addressable"
 require "active_support/core_ext"
 require "net/http"
 require "resolv"
@@ -12,7 +12,7 @@ module UriFormatValidator
     #
     # TODO: documentation
     #
-    class UriFormatValidator < ::ActiveModel::EachValidator
+    class UriValidator < ::ActiveModel::EachValidator
       SCHEMES = %w[
         aaa aaas about acap acct cap cid coap coaps crid data dav dict dns
         example file ftp geo go gopher h323 http https iax icap im imap info ipp
@@ -68,12 +68,9 @@ module UriFormatValidator
         validate_against_options(uri, :path, :query, :fragment)
       end
 
-      # Warning!  The +URI+ method behaviour is inconsistent across VMs.
-      # For instance, Rubinius allows leading and trailing spaces.  Non-nil
-      # return value doesn't guarantee that URI is indeed well-formed.
       def string_to_uri(uri_string)
-        URI(uri_string)
-      rescue URI::InvalidURIError
+        Addressable::URI.parse(uri_string)
+      rescue Addressable::URI::InvalidURIError
         nil
       end
 

data/lib/uri_format_validator/version.rb

@@ -2,5 +2,5 @@
 #
 
 module UriFormatValidator
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.1".freeze
 end

data/uri_format_validator.gemspec

@@ -25,8 +25,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.2.2"
 
   spec.add_runtime_dependency "activemodel", ">= 4.0.0", "< 6"
+  spec.add_runtime_dependency "addressable", "~> 2.5"
 
+  spec.add_development_dependency "aruba", "~> 0.14"
   spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "cucumber", "~> 3.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uri_format_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -30,6 +30,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -149,11 +191,11 @@ files:
 - ROADMAP.adoc
 - Rakefile
 - bin/console
+- bin/cucumber
 - bin/rake
 - bin/rspec
 - bin/rubocop
 - bin/setup
-- examples/basic.rb
 - gemfiles/common.gemfile
 - gemfiles/rails-4.0.gemfile
 - gemfiles/rails-4.1.gemfile
@@ -168,7 +210,7 @@ files:
 - lib/uri_format_validator/reacher.rb
 - lib/uri_format_validator/validators.rb
 - lib/uri_format_validator/validators/helper_methods.rb
-- lib/uri_format_validator/validators/uri_format_validator.rb
+- lib/uri_format_validator/validators/uri_validator.rb
 - lib/uri_format_validator/version.rb
 - uri_format_validator.gemspec
 homepage: https://github.com/riboseinc/uri_format_validator

data/examples/basic.rb

@@ -1,5 +0,0 @@
-class MyModel
-  validates :favourite_website_url, uri_format: { resolvability: :retrievable }
-  validates :resume_cv_url, uri_format: { resolvability: :reachable }
-  validates :friend_website_url, uri_format: { scheme: %w[http https ftp] }
-end