prevent_blankification_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a1c71eeffc12d50966e67010d6558a9f6d113b3
+  data.tar.gz: ba6937486917c4dfb09611d7327369087a828316
+SHA512:
+  metadata.gz: 19c657f5ba95ae8020c2dd9a17b5d526117d1dd4f4448a10888c4fea6b797ea5e2aa7e539ca786795ff3270046b9c2affbfb8aba41e72bb22c8360427594af8f
+  data.tar.gz: 4cbdf5a2a05ab2719d0808244253d4fc63893c9184d09902e213ed8595ba0491b87f16ea8c5fdbd872da1d338eb17952d03dc6a2826f8c56bcbc97e52d8975a3

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+prevent_blankification

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gebhard Wöstemeyer
+
+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,52 @@
+# PreventBlankificationValidator
+
+[![Build Status](https://travis-ci.org/gewo/prevent_blankification_validator.png)](https://travis-ci.org/gewo/prevent_blankification_validator/)
+
+Rails 3 Validator, that prevents attributes from being changed to a blank value
+once they're present.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prevent_blankification_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prevent_blankification_validator
+
+## Usage
+
+```ruby
+class MyModel
+  validates :value, prevent_blankification: true
+end
+
+model.value = 'present'
+model.save             # => true
+
+model.value = ''
+model.valid?           # => false
+
+model.value = "\r    \n  "
+model.valid?           # => false
+
+model.value = nil
+model.valid?           # => false
+
+model.value = 'present as well'
+model.valid?           # => true
+
+```
+
+## 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/Rakefile

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

data/lib/active_model/validations/prevent_blankification_validator.rb

@@ -0,0 +1,35 @@
+require 'active_model/validations'
+
+module ActiveModel
+  module Validations
+
+    # This validator prevents fields that were previously set to be blanked.
+    # Thus, we can allow blank fields, but once a field is set the value cannot
+    # be deleted again.
+    #
+    # The record#attribute _must_ have dirty tracking enabled. With Mongoid all
+    # Documents get that by default.
+    #
+    # Usage: validates :field, prevent_blankification: true
+    class PreventBlankificationValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        must_have_dirty_tracking_enabled!(record, attribute)
+
+        dirty_value = record.send "#{attribute}_was"
+
+        if value.blank? && dirty_value.present?
+          record.errors.add(attribute, :cannot_be_blanked)
+        end
+      end
+
+      private
+
+      def must_have_dirty_tracking_enabled!(record, attribute)
+        unless record.respond_to? "#{attribute}_was"
+          raise "#{record.class.name} doesn't seem to have dirty tracking " +
+            "enabled for #{attribute}!"
+        end
+      end
+    end
+  end
+end

data/lib/prevent_blankification_validator.rb

@@ -0,0 +1,9 @@
+require 'active_support/i18n'
+require "prevent_blankification_validator/version"
+require 'active_model/validations/prevent_blankification_validator'
+
+module PreventBlankificationValidator
+end
+
+I18n.load_path += Dir[File.expand_path(File.join(File.dirname(__FILE__),
+                                                 '../locales', '*.yml')).to_s]

data/lib/prevent_blankification_validator/version.rb

@@ -0,0 +1,3 @@
+module PreventBlankificationValidator
+  VERSION = "0.0.1"
+end

data/locales/de.yml

@@ -0,0 +1,4 @@
+de:
+  errors:
+    messages:
+      cannot_be_blanked: darf nicht gelöscht werden

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      cannot_be_blanked: must not be deleted

data/prevent_blankification_validator.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prevent_blankification_validator/version'
+
+Gem::Specification.new do |s|
+  s.name          = "prevent_blankification_validator"
+  s.version       = PreventBlankificationValidator::VERSION
+  s.authors       = ["Gebhard Wöstemeyer"]
+  s.email         = ["g.woestemeyer@gmail.com"]
+  s.description   = %q{Rails 3 Validator, that prevents attributes from being changed to a blank value once they're present.}
+  s.summary       = %q{Rails 3 Validator, that prevents attributes from being changed to a blank value once they're present.}
+  s.homepage      = "https://github.com/gewo/prevent_blankification_validator/"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^spec/})
+  s.require_paths = ["lib"]
+
+
+  s.add_runtime_dependency 'activemodel', ['~> 3.0']
+
+  s.add_development_dependency 'activesupport', ['~> 3.0']
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+end

data/spec/prevent_blankification_validator_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ActiveModel::Validations::PreventBlankificationValidator do
+  before :each do
+    @validator = ActiveModel::Validations::PreventBlankificationValidator.
+      new({ attributes: {} })
+
+    @mock = mock('model')
+    @mock.stub('errors').and_return []
+    @mock.errors.stub('[]').and_return {}
+  end
+
+  BLANKS = [nil, '', " \n  "]
+
+  context "when attribute_was blank" do
+    BLANKS.each do |attribute_was|
+      it "passes validation when attribute_was == '#{attribute_was.inspect}'" do
+        @mock.stub('attribute_was').and_return attribute_was
+        @mock.should_not_receive :errors
+        @validator.validate_each(@mock, 'attribute', '')
+      end
+    end
+  end
+
+  context "when attribute_was !blank" do
+    before :each do
+      @mock.stub('attribute_was').and_return 'I was'
+    end
+
+    BLANKS.each do |new_value|
+      it "has errors when new_value == '#{new_value.inspect}'" do
+        @mock.errors.should_receive :add
+        @validator.validate_each(@mock, 'attribute', new_value)
+      end
+    end
+
+    it "passes validation when value is set to non-blank" do
+      @mock.should_not_receive :errors
+      @validator.validate_each(@mock, 'attribute', 'so I am')
+    end
+  end
+
+  it "raises an error when dirty tracking is disabled" do
+    @mock.stub('respond_to?').with('attribute_was').and_return(false)
+    expect {
+      @validator.validate_each(@mock, 'attribute', 'so I am')
+    }.to raise_error(/have dirty tracking enabled/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+if RUBY_VERSION =~ /1\.9/ && RUBY_ENGINE == 'ruby'
+  require 'simplecov'
+
+  SimpleCov.start do
+    add_filter "/spec"
+  end
+
+  SimpleCov.at_exit do
+    File.open(File.join(SimpleCov.coverage_path, 'percent.txt'), 'w') do |f|
+      f.write SimpleCov.result.covered_percent
+    end
+    SimpleCov.result.format!
+  end
+end
+
+require 'active_model'
+require 'prevent_blankification_validator'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: prevent_blankification_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gebhard Wöstemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Rails 3 Validator, that prevents attributes from being changed to a blank
+  value once they're present.
+email:
+- g.woestemeyer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_model/validations/prevent_blankification_validator.rb
+- lib/prevent_blankification_validator.rb
+- lib/prevent_blankification_validator/version.rb
+- locales/de.yml
+- locales/en.yml
+- prevent_blankification_validator.gemspec
+- spec/prevent_blankification_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gewo/prevent_blankification_validator/
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rails 3 Validator, that prevents attributes from being changed to a blank
+  value once they're present.
+test_files:
+- spec/prevent_blankification_validator_spec.rb
+- spec/spec_helper.rb