elasticsearch_distance_unit_validator 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0e2418367852d6d8a6e446ce84d4c7603ff4089
+  data.tar.gz: f16293ed9a7372e96cb558552b4b2e38c8496561
+SHA512:
+  metadata.gz: ea1fbac8d2ef0d0b1f2aced2ee9d56498a629a19a241ec857ddbb38f1c07f3e81520f8705ba083207dcc5614d9e16bc67497ae5e5bcb9335a951011d1448ba7c
+  data.tar.gz: ecc7a3676bb1b25cebbbf95022de968946d4f10052b9b6c2cb75db3017c3e19d5f827ee31a9dc72f3f7198c5ec51833eb92e079ed5da7b7f98549ba25ae4b1a7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+# Specify your gem's dependencies in elasticsearch_distance_units_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sean Devine
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# ElasticsearchDistanceUnitValidator
+
+[Elasticsearch](http://www.elasticsearch.org) uses [distance units](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/common-options.html#distance-units) for features such as its [geo distance filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-filter.html).
+
+Examples of Elasticsearch distance units include `10ft` and `44miles`.
+
+Use this validator to validate that a string conforms to the distance unit format.
+
+```ruby
+validates :distance, elasticsearch_distance_unit: true
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elasticsearch_distance_unit_validator'
+```
+
+## Quality
+[ ![Codeship Status for barelyknown/elasticsearch_distance_unit_validator](https://codeship.com/projects/9bddf450-8efa-0132-e9e0-5ef1dd5f157a/status?branch=master)](https://codeship.com/projects/61122)
+[![Code Climate](https://codeclimate.com/github/barelyknown/elasticsearch_distance_unit_validator/badges/gpa.svg)](https://codeclimate.com/github/barelyknown/elasticsearch_distance_unit_validator)
+[![Test Coverage](https://codeclimate.com/github/barelyknown/elasticsearch_distance_unit_validator/badges/coverage.svg)](https://codeclimate.com/github/barelyknown/elasticsearch_distance_unit_validator)
+
+## Credits
+
+Originally created by [@barelyknown](https://twitter.com/barelyknown).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/elasticsearch_distance_unit_validator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "elasticsearch_distance_unit_validator"
+  spec.version       = "0.1"
+  spec.authors       = ["Sean Devine"]
+  spec.email         = ["barelyknown@icloud.com"]
+  spec.summary       = %q{Validator for Elasticsearch distance units.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/exec/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' 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('rspec-core', 'rspec')

data/lib/elasticsearch_distance_unit_validator.rb

@@ -0,0 +1,48 @@
+require "active_model"
+
+class ElasticsearchDistanceUnitValidator < ActiveModel::EachValidator
+  VALID_UNITS = %w(
+    mi miles
+    yd yards
+    ft feet
+    in inches
+    km kilometers
+    m  meters
+    cm centimeters
+    mm millimeters
+    NM nmi nauticalmiles
+  )
+  INVALID_GENERAL_FORMAT_MESSAGE = "did not match the general format"
+  INVALID_NUMBER_MESSAGE = "is not greater than zero"
+  INVALID_UNIT_MESSAGE = "is not a valid distance unit"
+
+  def validate_each(record, attribute, value)
+    validate_format(record, attribute, value)
+    if record.errors[attribute].empty?
+      validate_number(record, attribute, value)
+      validate_units(record, attribute, value)
+    end
+  end
+
+  private
+
+  def validate_format(record, attribute, value)
+    unless value =~ /\A-?\d+[a-zA-Z]+\z/
+      record.errors.add(attribute, "#{value} #{INVALID_GENERAL_FORMAT_MESSAGE}")
+    end
+  end
+
+  def validate_number(record, attribute, value)
+    number = value[/\A[-,\d,.]+/]
+    unless number && BigDecimal(number) > 0
+      record.errors.add(attribute, "#{number} #{INVALID_NUMBER_MESSAGE}")
+    end
+  end
+
+  def validate_units(record, attribute, value)
+    units = value[/[a-zA-Z]+\z/]
+    unless VALID_UNITS.include?(units)
+      record.errors.add(attribute, "#{units} #{INVALID_UNIT_MESSAGE}")
+    end
+  end
+end

data/spec/lib/elasticsearch_distance_unit_validator_spec.rb

@@ -0,0 +1,78 @@
+RSpec.describe TestModel do
+  let :valid_units do
+    ElasticsearchDistanceUnitValidator::VALID_UNITS
+  end
+
+  let :invalid_units do
+    %w(hands smidges paces)
+  end
+
+  let :valid_numbers do
+    (1..10).to_a
+  end
+
+  let :invalid_numbers do
+    (-1..0).to_a
+  end
+
+  let :invalid_values do
+    [
+      valid_numbers[0].to_s + " " + valid_units[0].to_s, # space in the middle
+      "a" + valid_numbers[0].to_s + valid_units[0].to_s, # starts with a non digit
+      valid_numbers[0].to_s + valid_units[0].to_s + " ", # ends with a space
+      valid_numbers[0].to_s + valid_units[0].to_s + 1.to_s, #ends with a number
+    ]
+  end
+
+  def validate_error_for(subject, number, unit, *messages)
+    subject.distance = number.to_s + unit.to_s
+    subject.valid?
+    messages.each do |message|
+      expect(subject.errors[:distance]).to include Regexp.new(message)
+    end
+  end
+
+  context "when the general format is invalid" do
+    it "distance is invalid and has the correct error message" do
+      invalid_values.each do |value|
+        subject.distance = value
+        subject.valid?
+        expect(subject.errors[:distance]).to include Regexp.new(ElasticsearchDistanceUnitValidator::INVALID_GENERAL_FORMAT_MESSAGE)
+      end
+    end
+  end
+
+  context "when the number is valid" do
+    context "when the units is valid" do
+      it "distance is valid" do
+        valid_numbers.product(valid_units).each do |number, unit|
+          subject.distance = number.to_s + unit.to_s
+          expect(subject).to be_valid
+        end
+      end
+    end
+    context "when the units are invalid" do
+      it "distance is invalid and has the correct error message" do
+        valid_numbers.product(invalid_units).each do |number, unit|
+          validate_error_for(subject, number, unit, ElasticsearchDistanceUnitValidator::INVALID_UNIT_MESSAGE)
+        end
+      end
+    end
+  end
+  context "when the number is invalid" do
+    context "when the units is valid" do
+      it "distance is invalid and has the correct error message" do
+        invalid_numbers.product(valid_units).each do |number, unit|
+          validate_error_for(subject, number, unit, ElasticsearchDistanceUnitValidator::INVALID_NUMBER_MESSAGE)
+        end
+      end
+    end
+    context "when the units is invalid" do
+      it "distance is invalid and has the correct error message" do
+        invalid_numbers.product(invalid_units).each do |number, unit|
+          validate_error_for(subject, number, unit, ElasticsearchDistanceUnitValidator::INVALID_UNIT_MESSAGE, ElasticsearchDistanceUnitValidator::INVALID_NUMBER_MESSAGE)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "elasticsearch_distance_unit_validator"
+require "support/test_model"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = false
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/support/test_model.rb

@@ -0,0 +1,9 @@
+require "active_model"
+
+class TestModel
+  include ActiveModel::Validations
+
+  attr_accessor :distance
+
+  validates :distance, elasticsearch_distance_unit: true
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch_distance_unit_validator
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Sean Devine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Validator for Elasticsearch distance units.
+email:
+- barelyknown@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- elasticsearch_distance_unit_validator.gemspec
+- exec/rspec
+- lib/elasticsearch_distance_unit_validator.rb
+- spec/lib/elasticsearch_distance_unit_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_model.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Validator for Elasticsearch distance units.
+test_files:
+- spec/lib/elasticsearch_distance_unit_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_model.rb