paranoid_starlight 1.0.0

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paranoid_starlight.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivan Stana
+
+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,61 @@
+# ParanoidStarlight
+
+This piece of gem contains some custom validators and converters for ActiveModel.
+
+It have validations for email and name (European style).
+And validation and converter (to international format) of telephone number. (CZ/SK format)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paranoid_starlight'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paranoid_starlight
+
+## Usage
+
+    class MyModel
+      include ActiveModel::Validations
+      include ParanoidStarlight::Validations
+      
+      attr_accessor :email
+      validates_email_format_of :email
+    end
+
+    model = MyModel.new
+    model.email = 'example@example.org'
+    model.valid?
+
+or put this into /config/initializers/paranoid.rb
+
+    ActiveRecord::Base.send(:include, ParanoidStarlight::Validations)
+    ActiveRecord::Base.send(:include, ParanoidStarlight::Converters)
+
+Now you have them available globally for models
+
+    class Person < ActiveRecord::Base
+      attr_accessible :name, :telephone, :email
+      validates_email_format_of :email
+      validates_name_format_of :name
+      validates_telephone_format_of :telephone
+      # or validates :email, :email => true
+
+      before_save :convert_telephone_number(:telephone)
+    end
+
+
+## Contributing
+
+1. Fork it
+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

data/lib/paranoid_starlight/version.rb

@@ -0,0 +1,3 @@
+module ParanoidStarlight
+  VERSION = "1.0.0"
+end

data/lib/paranoid_starlight.rb

@@ -0,0 +1,136 @@
+# -*- coding: UTF-8 -*-
+
+require "paranoid_starlight/version"
+require 'active_model'
+require 'twitter_cldr'
+require 'fast_gettext'
+
+module ParanoidStarlight
+
+  module Validators
+    class EmailValidator < ::ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        # username in email may have @ in string
+        # username should be case sensitive, domain is not
+        unless value =~ %r{\A([^\s]+)@((?:[-a-zA-Z0-9]+\.)+[a-zA-Z]{2,})\z}
+          record.errors[attribute] << (options[:message] || 'is not an email')
+        end
+      end
+    end
+    
+    class NameValidator < ::ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        fullname = '\p{Letter}+(-\p{Letter}+)*'
+        surname = fullname
+        short = '\p{Letter}\.'
+        unless value =~ /\A(?:#{fullname} ((#{fullname}|#{short}) )*#{surname})\z/
+          record.errors[attribute] << (options[:message] || 'is not a name')
+        end
+      end
+    end
+    
+    class TelephoneValidator < ::ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        # SK/CZ format
+        valid = ::ParanoidStarlight::Converters.convert_telephone(value) rescue nil 
+        unless valid
+          record.errors[attribute] << (options[:message] || 'is not a telephone number')
+        end
+      end
+    end
+  end # end validators
+    
+  module Validations
+    def self.included(base)
+      base.send(:extend, self)
+    end
+  
+    def validates_email_format_of(*attr_names)
+      # _merge_attributes extracts options and flatten attrs
+      # :attributes => {attr_names} is lightweight option
+      validates_with ::ParanoidStarlight::Validators::EmailValidator, _merge_attributes(attr_names)
+    end
+    
+    def validates_name_format_of(*attr_names)
+      validates_with ::ParanoidStarlight::Validators::NameValidator, _merge_attributes(attr_names)
+    end
+    
+    def validates_telephone_number_of(*attr_names)
+      validates_with ::ParanoidStarlight::Validators::TelephoneValidator, _merge_attributes(attr_names)
+    end
+  end # end validations
+    
+    
+  module Converters
+    def self.convert_telephone(num, prefixcc = 421)
+      telephone = num.to_s
+      prefixcc = prefixcc.to_s
+      
+      # convert logic
+      # possible formats, with or without spaces
+        
+      # mobile (CZ/SK)
+      # CZ/SK have always 9 numbers
+      # (1) +421 949 123 456
+      # (2) 00421 949 123 456
+      # (3) 0949 123 456 (10 with leading zero, only SK)
+      # (4) 949 123 456
+      
+      # landline always 9 numbers
+      # other regions - 04x
+      # (3) 045 / 6893121
+      # bratislava - 02
+      # (3) 02 / 44250320
+      # (1) 421-2-44250320
+      # (1) +421 (2) 44250320
+      # (x) ()44 250 320 (no chance to guess NDC (geographic prefix here))
+      # and other formats from above
+      
+        
+      # output is integer
+      # 421949123456
+      
+      # remove all non-number characters
+      telephone.gsub!(/\D/, '')
+      
+      cc = '420|421'
+      
+      # + is stripped
+      if match = /\A((?:#{cc})\d{9})\z/.match(telephone)
+        return match[1]
+      elsif match = /\A00((?:#{cc})\d{9})\z/.match(telephone)
+        return match[1]
+      elsif match = /\A0(\d{9})\z/.match(telephone)
+        return prefixcc + match[1]
+      # number cannot begin with 0, when has 9 numbers
+      elsif match = /\A([1-9]\d{8})\z/.match(telephone)
+        return prefixcc + match[1]
+        
+      else
+        raise("Number is invalid")
+      end
+    end
+  
+    def convert_telephone_number(inattr, outattr = '')
+      inattr = inattr.to_s
+      outattr = outattr.to_s
+      
+      if self.respond_to? inattr.to_sym
+        outattr = inattr if outattr == ''
+        raise("Attribute #{outattr} does not exist.") unless self.respond_to? outattr.to_sym
+        setter = "#{outattr}=".to_sym
+        
+        telephone = self.send(inattr.to_sym)
+
+        num = ::ParanoidStarlight::Converters.convert_telephone(telephone, 
+          TwitterCldr::Shared::PhoneCodes.code_for_territory(FastGettext.locale.to_sym)
+        ) rescue nil
+        
+        self.send(setter, num) unless num.nil?
+      else
+        raise("Attribute #{inattr} does not exist.")
+      end
+    end
+    
+  end # end converters
+end 

data/paranoid_starlight.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paranoid_starlight/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "paranoid_starlight"
+  gem.version       = ParanoidStarlight::VERSION
+  gem.author       = 'Ivan Stana'
+  gem.email         = 'stiipa@centrum.sk'
+  gem.summary       = "Pack of custom validations and converters for ActiveModel"
+  gem.description   = <<-EOF
+    Validators for name and email. Converter and validator for
+    telephone number (CZ/SK format). ActiveModel. Specs included.
+  EOF
+  
+  gem.homepage      = "http://github.com/istana/paranoid_starlight"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency("activemodel", ["~> 3.2"])
+  gem.add_dependency("twitter_cldr", ["~> 2.0"])
+  gem.add_dependency("fast_gettext", ["~> 0.6"])
+
+  gem.add_development_dependency("rspec")
+  gem.required_ruby_version = '>= 1.9.2'
+end

data/specs/paranoid_starlight_spec.rb

@@ -0,0 +1,240 @@
+require_relative '../lib/paranoid_starlight'
+require 'rspec'
+
+#ActiveRecord::Base.send(:include, ParanoidStarlight::Validators)
+#ActiveRecord::Base.send(:include, ParanoidStarlight::Converters)
+
+class Fangirl
+  include ::ParanoidStarlight::Converters
+  attr_accessor :telephone_from_form, :telephone
+end
+
+describe ParanoidStarlight::Converters do
+  before :all do
+    @p = ParanoidStarlight::Converters
+  end
+  
+  describe 'convert_telephone' do
+
+    it 'accepts all objects, which have to_s' do
+      ['421123456789',
+       421123456789,
+       :"421123456789"].each do |num|
+        @p.convert_telephone(num).should == '421123456789'
+      end
+    end
+    
+    it 'removes non-numeric characters' do
+      @p.convert_telephone(' +421 123 / 456789A').should == '421123456789'
+    end
+    
+    it 'tests (un)polished valid formats' do
+      ['+421 123 456 789',
+       '00421 123 456 789',
+       '123 456 789',
+       '0123 456 789'].each { |num|
+         @p.convert_telephone(num).should == '421123456789'
+      }
+      @p.convert_telephone('043/5867890').should == '421435867890'
+    end
+    
+    it 'tests some of invalid formats' do
+      ['043/586789',
+       '123',
+       '4211234567890'
+      ].each { |num|
+        expect {@p.convert_telephone(num)}.to raise_error('Number is invalid')
+      }
+    end
+    
+    it 'tests with custom country code prefix' do
+      @p.convert_telephone('+421 123 456 789', 410).should == '421123456789'
+      @p.convert_telephone('123 456 789', 410).should == '410123456789'
+      @p.convert_telephone('0123 456 789', 410).should == '410123456789'
+    end
+    
+  end
+  
+  describe 'convert_telephone_number' do
+    before :each do
+      FastGettext.locale = 'sk'      
+      @test = Fangirl.new
+      @test.telephone_from_form = '+421 123 456 789'
+    end
+    
+    context 'with two parameters - input and output attribute' do
+      it 'should store result in second parameter' do
+        @test.convert_telephone_number(:telephone_from_form, :telephone)
+        @test.telephone.should == '421123456789'
+      end
+    end
+    
+    context 'with only one parameter' do
+      it 'should convert telephone number and overwrite original' do
+        @test.convert_telephone_number(:telephone_from_form)
+        @test.telephone_from_form.should == '421123456789'
+      end
+    end
+  
+  end
+end
+  
+describe 'ParanoidStarlight::Validations' do
+  before(:each) do
+    @validators = ParanoidStarlight::Validators
+    
+    @mock = mock('model')
+    @mock.stub("errors").and_return([])
+    @mock.errors.stub('[]').and_return({})  
+    @mock.errors[].stub('<<')
+  end
+    
+    describe 'EmailValidator' do
+      before :each do
+        @email = @validators::EmailValidator.new({:attributes => {}})
+      end
+      
+      it "should validate valid email address" do
+        @mock.should_not_receive('errors')
+        @email.validate_each(@mock, "email", "example@example.org")
+        @email.validate_each(@mock, "email", "example@@example.org")
+        @email.validate_each(@mock, "email", "l0~gin@sub.examp-le.org")
+      end
+
+      it "should validate invalid email address" do
+        @mock.errors[].should_receive('<<')
+        @email.validate_each(@mock, "email", "notvalid")
+        @email.validate_each(@mock, "email", "x@exa$mple.org")
+      end
+    end  
+    
+    describe 'NameValidator' do
+      before :each do
+        @name = @validators::NameValidator.new({:attributes => {}})
+      end
+      
+      it "should validate valid name" do
+        @mock.should_not_receive('errors')
+        [
+          'Ivan Stana', 'Ivan R. Stana', 'Ivan Ronon Stana',
+          'Jean Claude Van Damme', 'Jean-Pierre Cassel',
+          'Tatyana Sukhotina-Tolstaya',
+          'John R. R. Tolkien'
+        ].each {
+          |name| @name.validate_each(@mock, "name", name)
+        }
+      end
+
+      it "should validate invalid name" do
+        @mock.errors[].should_receive('<<')
+        [
+          'J. R. R. Tolkien', 'J.R.R. Tolkien', 'Tolkien'
+        ].each {
+          |name| @name.validate_each(@mock, "name", name)
+        }
+      end
+    end 
+    
+    describe 'TelephoneValidator' do
+      before :each do
+        @telephone = @validators::TelephoneValidator.new({:attributes => {}})
+      end
+      
+      it "should validate valid telephone" do
+        @mock.should_not_receive('errors')
+        @telephone.validate_each(@mock, "telephone", '+421123456789')
+      end
+    
+      it "should validate invalid telephone" do
+        @mock.errors[].should_receive('<<')
+        @telephone.validate_each(@mock, "telephone", '123')
+      end
+    end
+
+    describe 'model Validators of' do
+      class TestEmail
+        include ActiveModel::Validations
+        include ParanoidStarlight::Validations
+        attr_accessor :email_field
+        validates_email_format_of :email_field
+      end
+    
+      class TestName
+        include ActiveModel::Validations
+        include ParanoidStarlight::Validations
+        attr_accessor :name_field
+        validates_name_format_of :name_field
+      end
+      
+      class TestName
+        include ActiveModel::Validations
+        include ParanoidStarlight::Validations
+        attr_accessor :name_field
+        validates_name_format_of :name_field
+      end
+      
+      class TestTelephone
+        include ActiveModel::Validations
+        include ParanoidStarlight::Validations
+        attr_accessor :telephone
+        validates_telephone_number_of :telephone
+      end
+      # I don't test multiple attributes as argument
+      # it works, because it is copied from rails
+      
+      
+      describe 'Email' do
+        subject { TestEmail.new() }
+        
+        before { subject.email_field = email_value }
+        
+        context 'is valid' do
+          let(:email_value) {'example@my.example.org'}
+          it {should be_valid }
+        end
+        
+        context 'is invalid' do
+          let(:email_value) {'example'}
+          it { should be_invalid }
+        end
+      end
+      
+      describe 'Name' do
+        subject { TestName.new() }
+        
+        before do
+          subject.name_field = name
+        end
+        
+        context 'is valid' do
+          let(:name) {'Geralt of Rivia'}
+          it { should be_valid }
+        end
+        
+        context 'is invalid' do
+          let(:name) {'Shakespeare'}
+          it { should be_invalid }
+        end
+      end
+      
+      describe 'Telephone' do
+        subject { TestTelephone.new() }
+        
+        before do
+          subject.telephone = telephone
+        end
+        
+        context 'is valid' do
+          let(:telephone) {'+421123456789'}
+          it { should be_valid }
+        end
+        
+        context 'is invalid' do
+          let(:telephone) {'1111'}
+          it { should be_invalid }
+        end
+      end
+            
+    end
+  
+end # end validations

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: paranoid_starlight
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Stana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: twitter_cldr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fast_gettext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Validators for name and email. Converter and validator for\n    telephone
+  number (CZ/SK format). ActiveModel. Specs included.\n"
+email: stiipa@centrum.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/paranoid_starlight.rb
+- lib/paranoid_starlight/version.rb
+- paranoid_starlight.gemspec
+- specs/paranoid_starlight_spec.rb
+homepage: http://github.com/istana/paranoid_starlight
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Pack of custom validations and converters for ActiveModel
+test_files: []