protective 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "activerecord"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    sqlite3 (1.3.3)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Pascal Zumkehr
+
+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 @@
+= protective
+
+In your ActiveRecord models, you used to protect the instances from being destroyed as follows:
+
+  before_destroy :protect_if_has_attachments
+  
+  def protect_if_has_attachments
+    unless attachments.empty?
+      errors.add(:base, "Record has attachments and cannot be destroyed")
+    end
+  end
+
+With +protective+, this is reduced to:
+
+  protect_if :attachments, "Record has attachments and cannot be destroyed"
+
+Of course, you may pass the name of any defined method. If its result evaluates to +present?+, the record is not going to be destroyed. No exception is thrown, but a message is added to the +errors+ object of your model. This may then be used further on.
+
+To use protective, simply add it to your +Gemfile+:
+
+  gem 'protective'
+
+
+== Copyright
+
+Copyright (c) 2011 Pascal Zumkehr. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+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 = "protective"
+  gem.homepage = "http://github.com/codez/protective"
+  gem.license = "MIT"
+  gem.summary = %Q{Protect records from being destroyed in a declarative way}
+  gem.description = %Q{Protect records from being destroyed in a declarative way. Simply add 'protect_if :dont_delete, "Record is marked as not deletable"' to your ActiveRecord model. Your record will no be destroyed and the given message is added to the errors object.}
+  gem.email = "spam@codez.ch"
+  gem.authors = ["Pascal Zumkehr"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'activerecord'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "protective #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/protective.rb

@@ -0,0 +1,61 @@
+require 'active_record'
+
+# Protect active records from being destroyed in a declarative way.
+module Protective
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+  
+  module ClassMethods
+    # Protects a record from being destroyed if the passed method
+    # evaluates to #present? upon destruction. If a messag is given,
+    # it is added to the corresponding #errors object.
+    def protect_if(method, message = nil)
+      unless self < InstanceMethods
+        class_attribute :protect_if_methods
+        self.protect_if_methods = {}
+
+        before_destroy :destruction_allowed? 
+        send :include, InstanceMethods
+      end
+      
+      protect_if_methods[method] = message
+    end
+  end
+   
+  module InstanceMethods
+  
+    # Returns true if this record cannot be destroyed.
+    def protected?
+      protect_if_methods.keys.any? do |method|
+        !protect_method_allows_destruction(method)
+      end
+    end
+  
+    # Returns true if this record may be destroyed or
+    # adds possible error messages to the #errors object otherwise.
+    def destruction_allowed?
+      protect_if_methods.all? do |method, message|
+        unless allowed = protect_method_allows_destruction(method)
+          errors.add(:base, message) if message
+        end
+        allowed
+      end
+    end
+    
+    private
+    
+    def protect_method_allows_destruction(method)
+      value = send(method)
+      if value.respond_to?(:empty?) # ar *_many association
+        value.empty?
+      else
+        value.blank?
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, Protective

data/rails/init.rb

@@ -0,0 +1 @@
+require 'protective'

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: test/protective_plugin.sqlite3.db

data/test/helper.rb

@@ -0,0 +1,26 @@
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'protective'
+
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+
+  ActiveRecord::Base.establish_connection(config['sqlite3'])
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+
+
+class Test::Unit::TestCase
+end

data/test/protective_test.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+class ProtectiveTest < Test::Unit::TestCase
+  load_schema
+ 
+  class Subject < ActiveRecord::Base
+    has_many :attachments
+    
+    protect_if :attachments, "Still has attachments"
+    protect_if :marked
+  end
+ 
+  class Attachment < ActiveRecord::Base
+    belongs_to :subjects
+  end
+  
+  def test_setup
+    assert_equal [], Subject.all
+    assert_equal 2, Subject.protect_if_methods.size
+  end
+  
+  def test_empty_subject_may_be_destroyed
+    s = Subject.create! :name => 'test'
+    assert !s.protected?
+    assert s.destroy
+  end
+  
+  def test_marked_subject_may_not_be_destroyed
+    s = Subject.create! :name => 'test', :marked => true
+    assert s.protected?
+    assert !s.destroy
+    assert_equal 0, s.errors.count
+  end
+  
+  def test_subject_may_not_be_destroyed_with_attachements
+    s = Subject.create! :name => 'test'
+    s.attachments.create! :name => 'att'
+    assert s.attachments.respond_to?(:empty?)
+    assert_equal 1, s.attachments.count
+    assert s.protected?
+    assert !s.destroy
+    assert_equal ["Still has attachments"], s.errors[:base]    
+    assert !s.destruction_allowed?
+  end
+  
+  def teardown
+    Subject.delete_all
+    Attachment.delete_all
+  end
+  
+end

data/test/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :subjects, :force => true do |t|
+    t.string :name
+    t.boolean :marked
+  end
+  create_table :attachments, :force => true do |t|
+    t.string :name
+    t.integer :subject_id
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: protective
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pascal Zumkehr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: activerecord
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: sqlite3
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: activerecord
+  prerelease: false
+  version_requirements: *id006
+description: Protect records from being destroyed in a declarative way. Simply add 'protect_if :dont_delete, "Record is marked as not deletable"' to your ActiveRecord model. Your record will no be destroyed and the given message is added to the errors object.
+email: spam@codez.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/protective.rb
+- rails/init.rb
+- test/database.yml
+- test/helper.rb
+- test/protective_test.rb
+- test/schema.rb
+has_rdoc: true
+homepage: http://github.com/codez/protective
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Protect records from being destroyed in a declarative way
+test_files: 
+- test/helper.rb
+- test/protective_test.rb
+- test/schema.rb