iso639-validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0e2c2713cf11ac3f15e9fc64805b5b83211ec4f
+  data.tar.gz: 666f08151765a4a0f660e4a262a64bb714e9cd96
+SHA512:
+  metadata.gz: 8d7f871c7767b3cd3f0302e352ab3b120fbe298834f48180e22502926344f6bf324275f2914960548cea4eadaaea36e2cb3317c7657602f6f68f16f1de1c625d
+  data.tar.gz: 885754b347ebce7782604185ab60e13c62f92d7f8b99e30d4082bc69a7a9873bbaffd3098ec161cc57556a154639ac07a9dd97fbee3e1f00a137dbd56b17e7c1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "activerecord", ">=0"
+gem 'iso-639', :git=>'https://github.com/merlos/iso-639.git'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  #gem "minitest", ">=0"
+  #gem "shoulda", ">= 0"
+  #gem "rdoc", "~> 3.12"
+  #gem "bundler", "~> 1.0"
+  #gem "jeweler", "~> 2.0.1"
+  #gem "simplecov", ">= 0"
+end
+
+# Specify your gem's dependencies in iso639-validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 merlos
+
+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,62 @@
+# Iso639::Validator
+A Rails gem that provides the ISO 639-2 and ISO 639-1 data validations. 
+
+The data comes from the LOC ISO 639-2 UTF-8 (http://www.loc.gov/standards/iso639-2/ascii_8bits.html) data set which provided by the gem 'iso-639' created by William Melody.
+
+Please note that this gem is in an early stage of development and testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'iso639-validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iso639-validator
+
+## Usage
+
+In your model:
+
+    class TestModel < ActiveRecord::Base
+      include Iso639::Validator
+      
+      # validate alfa-2 codes like 'es', 'en' 
+      validates :alfa2_code, iso639Code: true, length: { is: 2 } 
+      
+      # validate alfa-3 codes like 'esp', 'eng' only if present.
+      validates :alfa3_code, iso639Code: true, length: { is: 3 }, if: "alfa3_code.present?" 
+      
+      # validate a French name like 'français'
+      validates :french, iso639FrenchName: true 
+      
+      # Validate an English name like 'English'
+      validates :french, iso639EnglishName: true 
+    end
+
+
+Please note that validations are *case sensitive*. For example, 'es' is a valid code, but 'ES' is not. 'français' is a valid French name, but 'Français' is not.
+
+English and French names shall be exactly the same string as in the specification.
+
+The validator launches an :invalid, message by default.
+
+
+## Contributing
+
+Contributions and bug fixings are really appreciated 
+
+1. Fork it ( http://github.com/merlos/iso639-validator/fork )
+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 new Pull Request
+
+## License
+
+Copyright (c) 2014 Juan M. Merlos under MIT License

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+# test ---
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+ end
+  
+desc "Run tests"
+task :default => :test
+# ----  

data/iso639-validator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iso639/validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iso639-validator"
+  spec.version       = Iso639::Validator::VERSION
+  spec.authors       = ["merlos"]
+  spec.email         = ["jmmerlos@merlos.org"]
+  spec.summary       = %q{Validates if a value is an existing ISO-631
+entry}
+  spec.description   = %q{Validates that a value is either an alfa-2
+code, alfa-3 code, French name or English name}
+  spec.homepage      = "https://github.com/merlos/iso639-validator.git"
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/iso639/validator.rb

@@ -0,0 +1,41 @@
+require "iso639/validator/version"
+
+require 'active_model'
+require "iso-639"
+
+module Iso639
+  module Validator
+        
+    class Iso639CodeValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        if ISO_639.find_by_code(value).nil? 
+          record.errors.add(attribute, options[:message] || :invalid)
+        end 
+    	end
+    end
+ 
+    
+    #checks that the value exists in the database and is unique
+    class Iso639EnglishNameValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)   
+        if ISO_639.find_by_english_name(value).nil? 
+          record.errors.add(attribute, options[:message] || :invalid)
+        end 
+        return true
+    	end
+    end
+    
+    
+    # Checks that the value exists in the database and is unique 
+    class Iso639FrenchNameValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value) 
+        if ISO_639.find_by_french_name(value).nil?
+          record.errors.add(attribute, options[:message] || :invalid)
+        end 
+        return true
+    	end
+    end
+    
+    
+  end
+end

data/lib/iso639/validator/version.rb

@@ -0,0 +1,5 @@
+module Iso639
+  module Validator
+    VERSION = "0.0.1"
+  end
+end

data/test/test_iso639-validator.rb

@@ -0,0 +1,152 @@
+require 'rubygems'
+require "minitest/autorun"
+require 'active_record'
+require 'active_model'
+require 'iso639/validator'
+
+module Iso639
+  module Validator
+
+    #
+    # Helper class to test Code
+    #
+    class TestCode
+      include ActiveModel::Validations
+      include Iso639::Validator
+      attr_accessor :code
+      
+      validates :code, iso639Code: true 
+      
+      def initialize(attrs = {})
+          attrs.each_pair { |k,v| send("#{k}=", v) }
+        end
+    end
+    
+    # this class is to test a code with other conditions, for docummentation.
+    #
+    class TestCode3
+      include ActiveModel::Validations
+      include Iso639::Validator
+      attr_accessor :code
+    
+      # validate alfa-3 codes like 'esp', 'eng' only if present.
+      validates :code, iso639Code: true, length: { is: 3 }, if: "code.present?" 
+      
+      def initialize(attrs = {})
+          attrs.each_pair { |k,v| send("#{k}=", v) }
+        end
+    end
+    
+    #
+    # Helper class to test French Name
+    #
+    class TestFrench
+      include ActiveModel::Validations
+      include Iso639::Validator
+      attr_accessor :french
+      
+      validates :french, iso639FrenchName: true 
+      
+      def initialize(attrs = {})
+          attrs.each_pair { |k,v| send("#{k}=", v) }
+        end
+    end
+    
+    #
+    # Helper class to test English Name
+    #
+    class TestEnglish
+      include ActiveModel::Validations
+      include Iso639::Validator
+      attr_accessor :english
+      
+      validates :english, iso639EnglishName: true 
+      
+      def initialize(attrs = {})
+          attrs.each_pair { |k,v| send("#{k}=", v) }
+      end
+    end
+    
+    #
+    # Tests
+    #
+    class Iso639ValidatorTests < Minitest::Test #Test::Unit::TestCase
+      
+      # Code Tests
+      def test_a_valid_code
+        t = TestCode.new(code:'es')   
+        assert t.valid?
+        #puts t.valid?
+        #t.errors.each do |f| puts f end      
+        t1 = TestCode.new(code:'en')   
+        assert t1.valid?
+        #puts t.valid?
+        #t.errors.each do |f| puts f end      
+      end
+  
+      def test_an_empty_code
+        t = TestCode.new()
+        assert (not t.valid?)
+      end
+      
+      def test_a_non_existing_code 
+        t = TestCode.new(code:'zz')
+        assert (not t.valid?)
+      end
+      
+      def test_a_name_with_find_by_code
+        t = TestCode.new(code:'espagnol');
+        assert (not t.valid?)
+        t.code = 'Spanish'
+        assert (not t.valid?)
+      end
+      
+      
+      def test_an_empty_code_conditional_presence
+        t = TestCode3.new()
+        assert t.valid? #it's ok is empty
+      end
+      
+      def test_a_code2_requiring_length3_presence
+        t = TestCode3.new()
+        assert t.valid? #it's ok, is empty
+        t.code='es'
+        assert (not t.valid?) 
+      end
+      
+      def test_a_code2_requiring_length3_presence
+        t = TestCode3.new(code:'esp')
+        assert t.valid? #it's ok is empty
+        assert (not t.valid?) 
+      end
+      
+      
+      # French tests 
+      def test_valid_french_name
+        t = TestFrench.new(french:'français')
+        assert t.valid?
+      end
+      
+      def test_invalid_french_name
+        t = TestFrench.new(french:'Español')
+        assert (not t.valid?)
+      end
+      
+      # English 
+      def test_valid_english_name
+        t = TestEnglish.new(english:'Russian')
+        assert t.valid?
+      end
+      
+      def test_invalid_english_name
+        t = TestEnglish.new(english:'Español')
+        assert (not t.valid?)
+      end
+      
+    end
+
+  end #validator module
+end #iso
+
+
+  

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: iso639-validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- merlos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Validates that a value is either an alfa-2
+  code, alfa-3 code, French name or English name
+email:
+- jmmerlos@merlos.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- iso639-validator.gemspec
+- lib/iso639/validator.rb
+- lib/iso639/validator/version.rb
+- test/test_iso639-validator.rb
+homepage: https://github.com/merlos/iso639-validator.git
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Validates if a value is an existing ISO-631 entry
+test_files:
+- test/test_iso639-validator.rb