bartzon-validates_blacklist 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bart Zonneveld
+
+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,28 @@
+= validates_blacklist
+
+Validation of Rails models against a database, supporting scoped validation.
+
+= Install
+Add the following to config/environment.rb
+
+  config.gem "bartzon-validates_blacklist", :lib => "validates_blacklist"
+	
+And run
+
+  rake gems:install
+
+After these steps, generate a migration with:
+
+  script/generate blacklists
+
+= Usage
+Add the follow to each model you want to have validated:
+
+  class User < ActiveRecord::Base
+
+    validates_blacklist
+      :fields => [:name] # required, specify the fields to validate
+      :message => "" # optional, defaults to "is not allowed"
+      :scope => nil # optional, set this to for instance a class name to allow blacklist validation per class
+
+  end

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bartzon-validates_blacklist"
+    gem.summary = %Q{Validate Rails models against a database table}
+    gem.description = %Q{Validate Rails models against a database table}
+    gem.email = "loop@superinfinite.com"
+    gem.homepage = "http://github.com/bartzon/validates_blacklist"
+    gem.authors = ["Bart Zonneveld"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "validates_blacklist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/generators/blacklists/blacklists_generator.rb

@@ -0,0 +1,7 @@
+class BlacklistsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template('blacklists.rb', 'db/migrate', :migration_file_name => 'create_blacklists')
+    end
+  end
+end

data/generators/blacklists/templates/blacklists.rb

@@ -0,0 +1,12 @@
+class CreateBlacklists < ActiveRecord::Migration
+  def self.up
+    create_table :blacklists do |t|
+      t.string :value, :null => false
+      t.string :scope
+    end
+  end
+  
+  def self.down
+    drop_table :blacklists
+  end
+end

data/lib/validates_blacklist.rb

@@ -0,0 +1,4 @@
+require 'validates_blacklist/validates'
+require 'validates_blacklist/blacklist'
+
+ActiveRecord::Base.extend ValidatesBlacklist::Validates

data/lib/validates_blacklist/blacklist.rb

@@ -0,0 +1,7 @@
+module ValidatesBlacklist
+  class Blacklist < ActiveRecord::Base
+    validates_uniqueness_of :value, :scope => 'scope'
+    
+    named_scope :by_scope, lambda { |scope| { :conditions => {:scope => scope} } }
+  end
+end

data/lib/validates_blacklist/validates.rb

@@ -0,0 +1,47 @@
+module ValidatesBlacklist
+  module Validates
+    def validates_blacklist(options={})
+      options.reverse_merge!(
+        :message => "is not allowed",
+        :columns => [],
+        :scope => nil)
+
+      unless included_modules.include? InstanceMethods
+        class_inheritable_accessor :blacklist_options
+
+        extend ClassMethods
+        include InstanceMethods
+
+        validate :blacklisted_columns
+      end
+      
+      self.blacklist_options = options
+    end
+
+    module ClassMethods
+      def blacklisted?(value)
+        blacklist.include?(value)
+      end
+
+      def blacklist
+        if scope = blacklist_options[:scope]
+          list = ValidatesBlacklist::Blacklist.by_scope(scope.to_s)
+        else
+          list = ValidatesBlacklist::Blacklist.all
+        end
+        list.map(&:value)
+      end
+    end
+
+    module InstanceMethods
+      private
+        def blacklisted_columns
+          blacklist_options[:columns].each do |field|
+            if self.class.blacklisted?(self.send(field))
+              errors.add(field, blacklist_options[:message])
+            end
+          end
+        end
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+
+require 'validates_blacklist'
+begin
+  require 'sqlite3'
+rescue MissingSourceFile => e
+  puts "Gem sqlite3-ruby could not be found, please install it"
+  exit
+end
+
+require 'spec'
+require 'spec/autorun'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")  
+
+# AR keeps printing annoying schema statements
+$stdout = StringIO.new
+
+def setup_db
+  ActiveRecord::Base.logger
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.string :name
+    end
+    create_table :blacklists do |t|
+      t.string :value
+      t.string :scope
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+Spec::Runner.configure do |config|
+end

data/spec/validates_blacklist_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class UserWithoutOptions < ActiveRecord::Base
+  set_table_name 'users'
+  validates_blacklist
+end
+
+class User < UserWithoutOptions
+  validates_blacklist :columns => [:name]
+end
+
+class UserWithAllOptions < UserWithoutOptions
+  validates_blacklist :columns => [:name], 
+                      :message => 'is blacklisted', 
+                      :scope => 'User'
+end
+
+describe "ValidatesBlacklist" do
+  def create_blacklist(value, scope=nil)
+    ValidatesBlacklist::Blacklist.create!(:value => value, :scope => scope)
+  end
+  
+  def delete_blacklists
+    ValidatesBlacklist::Blacklist.destroy_all
+  end
+
+  before(:all) do
+    setup_db
+  end
+
+  after(:all) do
+    teardown_db
+  end
+  
+  before(:each) do
+    delete_blacklists
+  end
+
+  describe "validating a model" do
+    it "should not have any errors if no columns are checked" do
+      user = UserWithoutOptions.new
+      user.valid?
+      user.errors.should be_empty
+    end
+      
+    it "should not have any errors without blacklists" do
+      user = User.new
+      user.errors.should be_empty
+    end
+
+    describe "a model with blacklists" do
+      before(:each) do
+        create_blacklist('bad')
+        @user = User.new(:name => 'bad')
+        @user.valid?
+      end
+      
+      it "should not be valid with a blacklisted value" do  
+        @user.should_not be_valid
+      end
+      
+      it "should add the default error message" do
+        @user.errors.on(:name).should == 'is not allowed'
+      end
+      
+      it "should allow setting of custom error messages" do
+        create_blacklist('bad', 'User')
+        user = UserWithAllOptions.new(:name => 'bad')
+        user.should_not be_valid
+        user.errors.on(:name).should == 'is blacklisted'
+      end
+      
+      it "should be valid if the blacklisted value has a different scope" do
+        create_blacklist('scoped', 'Article')
+        user = UserWithAllOptions.new(:name => 'scoped')
+        user.should be_valid
+      end
+    end
+  end
+  
+  describe "Class methods" do
+    before(:each) do
+      create_blacklist('bad')
+      create_blacklist('a_scoped', 'Article')
+      create_blacklist('u_scoped', 'User')
+    end
+    
+    it "should return true if a value is blacklisted" do
+      User.blacklisted?('bad').should be_true
+    end
+    
+    it "should return false if a value isn't blacklisted" do
+      User.blacklisted?('good').should be_false
+    end
+    
+    it "should return the correct blacklist" do
+      User.blacklist.should == ['bad', 'a_scoped', 'u_scoped']
+    end
+    
+    it "should return the correct scoped blacklist" do
+      UserWithAllOptions.blacklist.should == ['u_scoped']
+    end
+  end
+end

data/validates_blacklist.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validates_blacklist}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bart Zonneveld"]
+  s.date = %q{2010-02-19}
+  s.description = %q{Validate Rails models against a database table}
+  s.email = %q{loop@superinfinite.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/blacklists/blacklists_generator.rb",
+     "generators/blacklists/templates/blacklists.rb",
+     "lib/validates_blacklist.rb",
+     "lib/validates_blacklist/blacklist.rb",
+     "lib/validates_blacklist/validates.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/validates_blacklist_spec.rb",
+     "validates_blacklist.gemspec"
+  ]
+  s.homepage = %q{http://github.com/bartzon/validates_blacklist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Validate Rails models against a database table}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/validates_blacklist_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: bartzon-validates_blacklist
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bart Zonneveld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Validate Rails models against a database table
+email: loop@superinfinite.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/blacklists/blacklists_generator.rb
+- generators/blacklists/templates/blacklists.rb
+- lib/validates_blacklist.rb
+- lib/validates_blacklist/blacklist.rb
+- lib/validates_blacklist/validates.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/validates_blacklist_spec.rb
+- validates_blacklist.gemspec
+has_rdoc: true
+homepage: http://github.com/bartzon/validates_blacklist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Validate Rails models against a database table
+test_files: 
+- spec/spec_helper.rb
+- spec/validates_blacklist_spec.rb