activemodel-warnings 1.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+nbproject

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-warnings.gemspec
+gemspec

data/README

@@ -0,0 +1,63 @@
+This gem allows you to mark some validations as optional using very simple syntax
+and let them be skipped by setting one attribute. 
+
+Works with active model and active record.
+
+Example:
+
+class OptionalData < Struct.new(:telephone, :address)
+  include ActiveModel::Validations
+  include ActiveModel::Warnings
+
+  validates_presence_of :telephone, :warning => true
+  warnings do
+    validates_presence_of :address
+  end
+end
+
+data = OptionalData.new()
+data.valid? => false
+data.skip_warnings = true
+data.valid? => true
+
+You have three ways of activating the gem:
+
+1)
+require 'activemodel-warnings'
+to use regular attr_writer :skip_warnings for storing the value.
+
+With bundler:
+# Gemfile
+gem 'activemodel-warnings', '~> 1.0.0'
+
+
+The two other ways are useful if skip_warnings attribute is set by user on form checkbox generated by rails:
+
+2)
+require 'activemodel-warnings/boolean'
+if you want the attribute of skip_warning=(attribute) method to be parsed with global Boolean() method
+ex. provided by global_boolean gem after activating it with "GlobalBoolean.kernel!"
+
+With bundler:
+# Gemfile
+gem 'global_boolean', '~> 0.1.1'
+gem 'activemodel-warnings', '~> 1.0.0', :require => "activemodel-warnings/boolean"
+
+# application.rb
+GlobalBoolean.kernel!
+
+3)
+require 'activemodel-warnings/global_boolean'
+if you want the attribute of skip_warnings=(attribute) to be parsed with GlobalBoolean.Boolean() method
+ex. provided by global_boolean gem but without messing with Kernel namespace
+
+With bundler:
+# Gemfile
+gem 'global_boolean', '~> 0.1.1'
+gem 'activemodel-warnings', '~> 1.0.0', :require => "activemodel-warnings/global_boolean"
+
+
+
+Be sure to require global_boolean (if using it) before requiring this gem.
+If using bundler then just put the declaration of global_boolean in Gemfile above the declaration
+of activemodel-warnings.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the activemodel-warnings plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the activemodel-warnings plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Active Model Warnings'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+

data/TODO

@@ -0,0 +1 @@
+switch to: require active_model-warnings ?

data/activemodel-warnings.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "activemodel-warnings/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activemodel-warnings"
+  s.version     = ActiveModel::Warnings::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Robert Pankowecki (Gavdi Pollska)"]
+  s.email       = ["robert.pankowecki@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Mark some validations as warnings and let them be easily skipped}
+  s.description = %q{Mark some validations as warnings and let them be easily skipped}
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.rubyforge_project         = "global_boolean"
+
+  s.add_dependency "activemodel", "~> 3.0.3"
+  
+  s.add_development_dependency "bundler", "~> 1.0.7"
+  s.add_development_dependency "mocha"
+
+  # s.add_optional_dependency "global_boolean", "~> 0.1.1" # There is no such thing as add_optional_dependency. Just to notify the users
+  # Read http://yehudakatz.com/2010/04/17/ruby-require-order-problems/
+  # Read README file to learn about how to use the gem with or without global_boolean support
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/activemodel-warnings/boolean.rb

@@ -0,0 +1,9 @@
+require 'activemodel-warnings'
+
+module ActiveModel
+  module Warnings
+    def skip_warnings=(v)
+      @skip_warnings = Boolean(v)
+    end
+  end
+end

data/lib/activemodel-warnings/global_boolean.rb

@@ -0,0 +1,10 @@
+require 'activemodel-warnings'
+require 'global_boolean'
+
+module ActiveModel
+  module Warnings
+    def skip_warnings=(v)
+      @skip_warnings = GlobalBoolean.Boolean(v)
+    end
+  end
+end

data/lib/activemodel-warnings/version.rb

@@ -0,0 +1,7 @@
+module ActiveModel
+
+  module Warnings
+    VERSION = "1.0.1"
+  end
+  
+end

data/lib/activemodel-warnings.rb

@@ -0,0 +1,51 @@
+require 'active_model'
+
+module ActiveModel
+
+  module Warnings
+
+    attr_accessor :skip_warnings
+    
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      
+      def warnings()
+        @warnings_block = true
+        yield
+      ensure
+        @warnings_block = false
+      end
+
+      def validate(*args, &block)
+        options = args.extract_options!
+        
+        if options[:warning] || @warnings_block
+          options = options.dup
+          options[:warning] ||= @warnings_block
+          options[:if] = Array.wrap(options[:if])
+          options[:if] << "skip_warnings != true"
+        end
+        args << options
+
+        super
+      end
+
+      def validates_with(*args, &block)
+        options = args.extract_options!
+
+        if options[:warning] || @warnings_block
+          options = options.dup
+          options[:warning] ||= @warnings_block
+        end
+        args << options
+        super
+      end
+
+    end # ClassMethods
+  
+  end # Warnings
+
+end # ActiveModel

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'activemodel-warnings'
+
+require 'test/unit'
+require 'active_support/test_case'
+require 'mocha'

data/test/warnings_test.rb

@@ -0,0 +1,50 @@
+load File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+
+class WarningsTest < ActiveSupport::TestCase
+
+  class TestMe < Struct.new(:one, :two, :three)
+    include ActiveModel::Validations
+    include ActiveModel::Warnings
+
+    validates_presence_of :one
+    validates_presence_of :two, :warning => true
+    warnings do
+      validates_presence_of :three
+    end
+
+  end
+
+  setup do
+    @valid = TestMe.new("one", "two", "three")
+    @invalid = TestMe.new()
+  end
+
+  test "without skipping" do
+    @valid.errors.expects(:add).never
+    @valid.valid?
+
+    @invalid.errors.expects(:add).with(:one, :blank, anything)
+    @invalid.errors.expects(:add).with(:two, :blank, anything)
+    @invalid.errors.expects(:add).with(:three, :blank, anything)
+    @invalid.valid?
+  end
+
+  test "with skipping" do
+    @valid.skip_warnings = true
+    @valid.errors.expects(:add).never
+    @valid.valid?
+
+    @invalid.skip_warnings = true
+    @invalid.errors.expects(:add).with(:one, :blank, anything)
+    @invalid.valid?
+  end
+
+  test "validator recives the warning option" do
+    assert ! TestMe.validators_on(:one).first.options[:warning]
+    assert TestMe.validators_on(:two).first.options[:warning]
+    assert TestMe.validators_on(:three).first.options[:warning]
+  end
+
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: activemodel-warnings
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Robert Pankowecki (Gavdi Pollska)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Mark some validations as warnings and let them be easily skipped
+email: 
+- robert.pankowecki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- TODO
+- activemodel-warnings.gemspec
+- lib/activemodel-warnings.rb
+- lib/activemodel-warnings/boolean.rb
+- lib/activemodel-warnings/global_boolean.rb
+- lib/activemodel-warnings/version.rb
+- test/test_helper.rb
+- test/warnings_test.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: global_boolean
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mark some validations as warnings and let them be easily skipped
+test_files: []
+