encodable_validator 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+notifications:
+  disabled: true

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'activemodel', '3.2.12'
+
+group :development do
+  gem "rspec", "~> 2.8"
+  gem "rdoc", "~> 4.0"
+  gem "bundler", "~> 1.3"
+  gem "jeweler", "~> 1.8"
+  gem "simplecov", "~> 0.7"
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.2.1)
+    git (1.2.5)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    multi_json (1.6.1)
+    rake (10.0.3)
+    rdoc (4.0.0)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (= 3.2.12)
+  bundler (~> 1.3)
+  jeweler (~> 1.8)
+  rdoc (~> 4.0)
+  rspec (~> 2.8)
+  simplecov (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Koji Ejiri
+
+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.rdoc

@@ -0,0 +1,39 @@
+= encodable_validator
+{<img src="https://travis-ci.org/eji/encodable_validator.png?branch=master" alt="Build Status" />}[https://travis-ci.org/eji/encodable_validator]
+{<img src="https://codeclimate.com/github/eji/encodable_validator.png" />}[https://codeclimate.com/github/eji/encodable_validator]
+{<img src="https://gemnasium.com/eji/encodable_validator.png" alt="Dependency Status" />}[https://gemnasium.com/eji/encodable_validator]
+
+A string validator for ActiveModel to verify it can be converted to the specified encodings.
+
+== Install
+
+In your Gemfile:
+  gem 'encodable_validator', :git => "git://github.com/eji/encodable_validator.git"
+
+== Usage
+
+In your model:
+  validates :name, :encodable => {:encodings => [Encoding::EUC_JP, Encoding::ISO_2022_JP]}
+or 
+  validates_encodable_of :name, :encodings => [Encoding::EUC_JP, Encoding::ISO_2022_JP]
+
+== Version
+
+see VERSION
+(using http://semver.org (... possible))
+
+== Contributing to encodable_validator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own 
+
+== Copyright
+
+Copyright (c) 2013 Koji Ejiri. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "encodable_validator"
+  gem.homepage = "http://github.com/eji/encodable_validator"
+  gem.license = "MIT"
+  gem.summary = "A string validator for ActiveModel to verify it can be converted to the specified encodings."
+  gem.description = "A string validator for ActiveModel to verify it can be converted to the specified encodings."
+  gem.email = "k.ejiri@gmail.com"
+  gem.authors = ["Koji Ejiri"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "encodable_validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/encodable_validator.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "encodable_validator"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Koji Ejiri"]
+  s.date = "2013-03-01"
+  s.description = "A string validator for ActiveModel to verify it can be converted to the specified encodings."
+  s.email = "k.ejiri@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "encodable_validator.gemspec",
+    "lib/active_model/validators/encodable_validator.rb",
+    "lib/encodable_validator.rb",
+    "locales/en.yml",
+    "locales/ja.yml",
+    "spec/encodable_validator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/eji/encodable_validator"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "A string validator for ActiveModel to verify it can be converted to the specified encodings."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, ["= 3.2.12"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.7"])
+    else
+      s.add_dependency(%q<activemodel>, ["= 3.2.12"])
+      s.add_dependency(%q<rspec>, ["~> 2.8"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<simplecov>, ["~> 0.7"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, ["= 3.2.12"])
+    s.add_dependency(%q<rspec>, ["~> 2.8"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<simplecov>, ["~> 0.7"])
+  end
+end
+

data/lib/active_model/validators/encodable_validator.rb

@@ -0,0 +1,54 @@
+require 'active_model/validations'
+
+module ActiveModel
+  module Validations
+    class EncodableValidator < ActiveModel::EachValidator
+      def check_validity!
+        values = options[:encodings]
+        unless values.respond_to?(:all?) and values.all? {|v| v.class <= Encoding} 
+          raise ArgumentError, ":encodings must be a array of Encodings"
+        end
+      end
+
+      def validate_each(record, attr_name, value)
+        return if options[:allow_nil] && value.nil?
+
+        unless value.respond_to?(:encode)
+          record.errors.add(attr_name, :not_a_encodable_object , options)
+          return
+        end
+
+        src_enc = value.encoding
+        last_enc = nil
+        begin
+          options[:encodings].each do |enc|
+            last_enc = enc
+            value.encode(enc, src_enc)
+          end
+        rescue Encoding::UndefinedConversionError
+          record.errors.add(attr_name, :can_not_be_encoded, options.merge(
+            :value => value,
+            :encoding => last_enc
+          ))
+          return
+        rescue Encoding::InvalidByteSequenceError
+          record.errors.add(attr_name, :included_invalid_byte_sequences, options)
+          return
+        end
+      end
+    end
+
+    module HelperMethods
+      # Usage:
+      #   class Person < ActiveRecord::Base
+      #     validates_encodable_of :name, :encodings => [Encoding::ISO_2022_JP, Encoding::EUC_JP]
+      #   end
+      #
+      # Configuration options:
+      # * <tt>:encodings</tt> - check that a text can be encoded to specified encodings.
+      def validates_encodable_of(*attr_names)
+        validates_with EncodableValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/encodable_validator.rb

@@ -0,0 +1,13 @@
+require 'active_model/validators/encodable_validator'
+require 'active_support/i18n'
+
+# EncodableValidator
+#
+# @example
+#   validates :username, :encodable => { :encodings => [Encoding::ISO_2022_JP, Encoding::Shift_JIS] }
+#   or
+#   validates_encodable_of :username, :encodings => [Encoding::ISO_2022_JP, Encoding::Shift_JIS]
+module EncodableValidator
+end
+
+I18n.load_path += Dir[File.expand_path(File.join(File.dirname(__FILE__), '../locales', '*.yml')).to_s]

data/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  errors:
+    messages:
+      not_a_encodable_object: "is not a encodable object"
+      can_not_be_encoded: "included charactors are not encoded to %{encoding}"
+      included_invalid_byte_sequences: "included invalid byte sequences"

data/locales/ja.yml

@@ -0,0 +1,6 @@
+ja:
+  errors:
+    messages:
+      not_a_encodable_object: "エンコーディングできないオブジェクトです"
+      can_not_be_encoded_to: "%{encoding} にエンコーディングできない文字を含んでいます"
+      included_invalid_byte_sequences: "不正なバイト列を含んでいます"

data/spec/encodable_validator_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'rspec'
+
+module ActiveModel
+
+  module Validations
+
+    describe "EncodableValidator" do
+      before do
+        I18n.backend.reload!
+        TestRecord.reset_callbacks(:validate)
+      end
+
+      describe ".validates" do
+
+        it "checks validity of the arguments" do
+          [Encoding::ASCII, nil, ["utf-8", "euc-jp"]].each do |wrong_argument|
+            expect {
+              TestRecord.validates :target_text, :encodable => { :encodings => wrong_argument }
+            }.to raise_error(ArgumentError, ":encodings must be a array of Encodings")
+          end
+        end
+
+        context "passed UTF_8 encoded text that is not encodable ISO_2022_JP" do
+          before do
+            TestRecord.validates :target_text, encodable: { encodings: [Encoding::ISO_2022_JP] }
+          end
+
+          ["\u2601", "\u2602", "\u2603", "\u2604"].each do |char|
+            it "invalid" do
+              sut = TestRecord.new(char)
+              sut.should be_invalid
+              sut.errors[:target_text].should == ["included charactors are not encoded to #{Encoding::ISO_2022_JP}"]
+            end
+          end
+        end
+
+        context "passed nil" do
+          context 'allow_nil' do
+            before do
+              TestRecord.validates :target_text, :encodable => { :encodings => [Encoding::ASCII] }, :allow_nil => true
+            end
+
+            it "valid" do
+              sut = TestRecord.new(nil)
+              sut.should be_valid
+            end
+          end
+
+          context 'not allow_nil' do
+            before do
+              TestRecord.validates :target_text, :encodable => { :encodings => [Encoding::ASCII] }, :allow_nil => false
+            end
+
+            it "invalid" do
+              sut = TestRecord.new(nil)
+              sut.should be_invalid
+              sut.errors[:target_text].should == ["is not a encodable object"]
+            end
+          end
+        end
+
+        context "passed string included invalid byte sequences" do
+          before do
+            TestRecord.validates :target_text, :encodable => { :encodings => [Encoding::UTF_16] }
+            @invalid_char = "\x82\xa0"
+            @invalid_char.should_receive(:encoding).and_return(Encoding::UTF_8)
+          end
+
+          it "invalid" do
+            sut = TestRecord.new(@invalid_char)
+            sut.should be_invalid
+            sut.errors[:target_text].should == ["included invalid byte sequences"]
+          end
+        end
+      end
+
+    end
+
+    describe "work with helper method" do
+      before do
+        I18n.backend.reload!
+        TestRecord.reset_callbacks(:validate)
+        TestRecord.validates_encodable_of :target_text, :encodings => [Encoding::ISO_2022_JP]
+      end
+
+      context "passed UTF_8 encoded text that is not encodable ISO_2022_JP" do
+        ["\u2601", "\u2602", "\u2603", "\u2604"].each do |char|
+          it "invalid" do
+            sut = TestRecord.new(char)
+            sut.should be_invalid
+            sut.errors[:target_text].should == ["included charactors are not encoded to #{Encoding::ISO_2022_JP}"]
+          end
+        end
+      end
+
+      context "passed UTF_8 encoded text that is encodable ISO_2022_JP" do
+        ["\u3041", "\u3042", "\u3043", "\u3044"].each do |char|
+          it "valid" do
+            sut = TestRecord.new(char)
+            sut.should be_valid
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'encodable_validator'
+require 'active_model'
+require 'simplecov'
+
+SimpleCov.start do
+  add_group 'Lib', 'lib'
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+class TestRecord
+  include ActiveModel::Validations
+  attr_accessor :target_text
+
+  def initialize(target_text)
+    @target_text = target_text
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: encodable_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Koji Ejiri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-01 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.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A string validator for ActiveModel to verify it can be converted to the
+  specified encodings.
+email: k.ejiri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- encodable_validator.gemspec
+- lib/active_model/validators/encodable_validator.rb
+- lib/encodable_validator.rb
+- locales/en.yml
+- locales/ja.yml
+- spec/encodable_validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/eji/encodable_validator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4585558783132829965
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A string validator for ActiveModel to verify it can be converted to the specified
+  encodings.
+test_files: []