activemodel-base64_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7b40f967847819db430991f7d79079ae395f583
+  data.tar.gz: 8336d743b91775585d2ba0197eccb87e363d655a
+SHA512:
+  metadata.gz: 6b78d9f162c19d49558c4f9b9485a8044714d079e64cfab3dcd9b78bcac2262dae6a3ebfde7b73e54477441d7bc5be8855e56d8f5ce312bc7373f0e2e3d152ef
+  data.tar.gz: 34fc57a20d4bf3d9eb07d9d65f4372321150bdce0304649ae2807650044afbc34b316d389f7458b8a61ba1619aa4a51b0332d02b6721132e25866289b567b627

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in base64_encoded_validator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# activemodel-base64_validator
+
+[![Build Status](https://travis-ci.org/increments/activemodel-base64_validator.svg?branch=master)](https://travis-ci.org/increments/activemodel-base64_validator)
+
+## Usage
+
+Add to your Gemfile:
+
+```rb
+gem 'activemodel-base64_validator'
+```
+
+Run:
+
+```
+bundle install
+```
+
+Then add the following to your model:
+
+```rb
+validates :my_base64_attribute, base64: true
+```
+
+## Validation outside a model
+
+If you need to validate a base64 outside a model, you can get the regexp:
+
+```rb
+Base64Validator::REGEXP
+Base64Validator.valid?(string)  # true or false
+```
+
+## Credit
+
+Regular Expression based on http://stackoverflow.com/a/475217/1297336

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/activemodel-base64_validator.gemspec

@@ -0,0 +1,22 @@
+file = File.open(File.expand_path('../lib/base64_validator/version.rb', __FILE__))
+version = file.read.scan(/\d+\.\d+\.\d+/).first
+file.close
+
+Gem::Specification.new do |spec|
+  spec.name            = 'activemodel-base64_validator'
+  spec.version         = version
+  spec.authors         = ['Yuku Takahashi']
+  spec.email           = ['yuku@qiita.com']
+  spec.summary         = 'A base64 validator for Rails 3 and 4.'
+  spec.homepage        = 'https://github.com/increments/activemodel-base64_validator'
+  spec.license         = 'MIT'
+
+  spec.files           = `git ls-files -z`.split("\x0")
+  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'
+end

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      invalid_base64: is invalid Base64 encoding.

data/config/locales/ja.yml

@@ -0,0 +1,4 @@
+ja:
+  errors:
+    messages:
+      invalid_base64: は有効なBase64形式ではありません。

data/lib/activemodel-base64_validator.rb

@@ -0,0 +1,3 @@
+require 'base64_validator'
+require 'base64_validator/version'
+require 'base64_validator/engine'

data/lib/base64_validator.rb

@@ -0,0 +1,13 @@
+class Base64Validator < ActiveModel::EachValidator
+  REGEXP = %r<\A(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?\z>
+
+  def self.valid?(value)
+    !!(value =~ REGEXP)
+  end
+
+  def validate_each(record, attribute, value)
+    unless self.class.valid?(value)
+      record.errors.add(attribute, options[:message] || :invalid_base64)
+    end
+  end
+end

data/lib/base64_validator/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+class Base64Validator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/base64_validator/version.rb

@@ -0,0 +1,3 @@
+class Base64Validator
+  VERSION = '0.0.1'
+end

data/spec/base64_validator_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+shared_context 'valid base64 string is given', given: :valid do
+  let(:value) do
+    Base64.strict_encode64("Now is the time for all good coders\nto learn Ruby")
+  end
+end
+
+shared_context 'invalid base64 string is given', given: :invalid do
+  let(:value) do
+    "Now is the time for all good coders\nto learn Ruby"
+  end
+end
+
+shared_context 'nil is given', given: nil do
+  let(:value) do
+    nil
+  end
+end
+
+describe Base64Validator do
+  describe '.valid?' do
+    subject do
+      described_class.valid?(value)
+    end
+
+    context 'when a valid base64 string is given', given: :valid do
+      it { should be_truthy }
+    end
+
+    context 'when a invalid base64 string is given', given: :invalid do
+      it { should be_falsey }
+    end
+  end
+
+  describe 'validation' do
+    subject do
+      model_class.new(attr: value)
+    end
+
+    context 'when option is true' do
+      let(:model_class) do
+        Class.new(TestModel) do
+          validates :attr, base64: true
+        end
+      end
+
+      context 'and a valid base64 string is given', given: :valid do
+        it { should be_valid }
+      end
+
+      context 'and a invalid base64 string is given', given: :invalid do
+        it { should be_invalid }
+      end
+
+      context 'and nil is given', given: nil do
+        it { should be_invalid }
+      end
+    end
+
+    context 'when option is { allow_nil: true }' do
+      let(:model_class) do
+        Class.new(TestModel) do
+          validates :attr, base64: { allow_nil: true }
+        end
+      end
+
+      context 'and a valid base64 string is given', given: :valid do
+        it { should be_valid }
+      end
+
+      context 'and a invalid base64 string is given', given: :invalid do
+        it { should be_invalid }
+      end
+
+      context 'and nil is given', given: nil do
+        it { should be_valid }
+      end
+    end
+
+    context 'when option is { allow_nil: false }' do
+      let(:model_class) do
+        Class.new(TestModel) do
+          validates :attr, base64: { allow_nil: false }
+        end
+      end
+
+      context 'and a valid base64 string is given', given: :valid do
+        it { should be_valid }
+      end
+
+      context 'and a invalid base64 string is given', given: :invalid do
+        it { should be_invalid }
+      end
+
+      context 'and nil is given', given: nil do
+        it { should be_invalid }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'base64'
+require 'active_model'
+require 'base64_validator'
+
+RSpec.configure do |config|
+  config.color = true
+  config.run_all_when_everything_filtered = true
+end
+
+class TestModel
+  include ActiveModel::Validations
+
+  def self.name
+    'TestModel'
+  end
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-base64_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuku Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuku@qiita.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activemodel-base64_validator.gemspec
+- config/locales/en.yml
+- config/locales/ja.yml
+- lib/activemodel-base64_validator.rb
+- lib/base64_validator.rb
+- lib/base64_validator/engine.rb
+- lib/base64_validator/version.rb
+- spec/base64_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/increments/activemodel-base64_validator
+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: A base64 validator for Rails 3 and 4.
+test_files: []