safe_attributes 1.0.2 → 1.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 C. Brian Jones
+Copyright (c) 2010,2011 C. Brian Jones
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -26,6 +26,8 @@ that this module does not prevent the creation of:
 
 These largely should not run afoul of Ruby or ActiveRecord in most cases.
 
+== Accessing Attributes
+
 To access an attribute in ActiveRecord without its normal getter or setter
 you can use a couple of different approaches.
 
@@ -35,6 +37,13 @@ you can use a couple of different approaches.
 
 You can read more about reserved words[http://oldwiki.rubyonrails.org/rails/pages/ReservedWords] and magic field names[http://oldwiki.rubyonrails.org/rails/pages/MagicFieldNames] on Rails' wiki pages.
 
+== Validations 
+
+By including safe_attributes, an instance method read_attribute_for_validation
+is defined in a way that will work for all attributes instead of the 
+default implementation that relies upon the default accessors. In other
+words, `validates_presence_of :class' will work as of version 1.0.3.
+
 == Installing
 
   gem install safe_attributes
@@ -60,10 +69,12 @@ Add safe_attributes to your Gemfile.
 
 SafeAttributes is included into ActiveRecord::Base automatically.  While
 nothing else should be necessary, you can still add to the list of bad
-attributes if you find it necessary.
+attributes if you find it necessary.  This list is a list of method names
+not to generate.
 
   class MyModel < ActiveRecord::Base
     bad_attribute_names :my_attr
+    validates_presence_of :my_attr
   end
 
 === Outside of Rails
@@ -84,4 +95,8 @@ attributes if you find it necessary.
 
 == Copyright
 
-Copyright (c) 2010 C. Brian Jones. See LICENSE for details.
+Copyright (c) 2010,2011 C. Brian Jones. See LICENSE for details.
+
+== Thanks
+
+* Jaime Bellmyer - http://kconrails.com

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/lib/safe_attributes.rb

@@ -1,47 +1,54 @@
 module SafeAttributes
-    extend ActiveSupport::Concern
+  extend ActiveSupport::Concern
 
-    module ClassMethods
-        # 
-        # Within your model call this method once with a list of 
-        # methods matching either attribute() or attribute=() for 
-        # attributes (column names) you do not want to create the
-        # the normal method for.  You should not need to do this
-        # but the option is there in case the default list is 
-        # inadequate
-        #
-        def bad_attribute_names(*attrs)
-            @bad_attribute_names ||= lambda {
-                methods = Array.new(attrs.collect { |x| x.to_s })
-                methods += ActiveRecord::Base.public_instance_methods
-                methods += ActiveRecord::Base.protected_instance_methods
-                methods += ActiveRecord::Base.private_instance_methods
-                methods -= ['id']
-                return methods
-            }.call
-        end
+  module ClassMethods
+    # 
+    # Within your model call this method once with a list of 
+    # methods matching either attribute() or attribute=() for 
+    # attributes (column names) you do not want to create the
+    # the normal method for.  You should not need to do this
+    # but the option is there in case the default list is 
+    # inadequate.
+    #
+    def bad_attribute_names(*attrs)
+      @bad_attribute_names ||= lambda {
+        methods = Array.new(attrs.collect { |x| x.to_s })
+        methods += ActiveRecord::Base.public_instance_methods
+        methods += ActiveRecord::Base.protected_instance_methods
+        methods += ActiveRecord::Base.private_instance_methods
+        methods -= ['id']
+        return methods
+      }.call
+    end
 
-        # 
-        # Override the default implementation to not create the
-        # attribute() method if that method name is in the list of
-        # bad names
-        #
-        def define_method_attribute(attr_name)
-            return if (bad_attribute_names.include?(attr_name))
-            super(attr_name)
-        end
+    # 
+    # Override the default implementation to not create the
+    # attribute() method if that method name is in the list of
+    # bad names
+    #
+    def define_method_attribute(attr_name)
+      return if (bad_attribute_names.include?(attr_name))
+      super(attr_name)
+    end
 
-        #
-        # Override the default implementation to not create the
-        # attribute= method if that method name is in the list of
-        # bad names
-        #
-        def define_method_attribute=(attr_name)
-            method = attr_name + '='
-            return if (bad_attribute_names.include?(method))
-            super(attr_name)
-        end
+    #
+    # Override the default implementation to not create the
+    # attribute= method if that method name is in the list of
+    # bad names
+    #
+    def define_method_attribute=(attr_name)
+      method = attr_name + '='
+      return if (bad_attribute_names.include?(method))
+      super(attr_name)
     end
+  end
+
+  module InstanceMethods
+    def read_attribute_for_validation(attr)
+      self[attr.to_sym]
+    end
+  end
+
 end
 
 require 'safe_attributes/railtie.rb' if defined?(Rails)

data/safe_attributes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{safe_attributes}
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Jones"]
-  s.date = %q{2011-01-24}
+  s.date = %q{2011-02-01}
   s.description = %q{Better support for legacy database schemas for ActiveRecord, such as columns named class, or any other name that conflicts with an instance method of ActiveRecord.}
   s.email = %q{cbj@gnu.org}
   s.extra_rdoc_files = [

data/spec/safe_attributes/safe_attributes_spec.rb

@@ -3,90 +3,99 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 # create the table for the test in the database
 ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'my_models'")
 ActiveRecord::Base.connection.create_table(:my_models) do |t|
-    t.string :class
-    t.string :bad_attribute
-    t.string :good_attribute
+  t.string :class
+  t.string :bad_attribute
+  t.string :good_attribute
 end
 
 class MyModel < ActiveRecord::Base
-    include SafeAttributes
-    bad_attribute_names :bad_attribute, :bad_attribute=
+  include SafeAttributes
+  bad_attribute_names :bad_attribute, :bad_attribute=
+  validates_presence_of :class
 end
 
 describe MyModel do
 
-    before(:each) do
-        ActiveRecord::Base.connection.increment_open_transactions
-        ActiveRecord::Base.connection.begin_db_transaction
-        @model = MyModel.new
-    end
-
-    after(:each) do
-        ActiveRecord::Base.connection.rollback_db_transaction
-        ActiveRecord::Base.connection.decrement_open_transactions
-    end
-
-    it "inspecting class returns expected attribute names" do
-        MyModel.inspect.should match 'class: string'
-    end
-
-    it "inspecting instance returns expected attribute names" do
-        @model.inspect.should match 'class: nil'
-    end
-
-    it "does not redefine class()" do
-        @model.class.name.should == 'MyModel'
-    end
-
-    it "defines class=()" do
-        @model.respond_to?('class=') # to force method generation
-        @model.methods.include?('class=').should be_true
-    end
-
-    it "does not define bad_attribute()" do
-        @model.respond_to?('bad_attribute') # to force method generation
-        @model.methods.include?('bad_attribute').should be_false
-    end
-
-    it "does not define bad_attribute=()" do
-        @model.respond_to?('bad_attribute=') # to force method generation
-        @model.methods.include?('bad_attribute=').should be_false
-    end
-
-    it "does define good_attribute()" do
-        @model.respond_to?('good_attribute') # to force method generation
-        @model.methods.include?('good_attribute').should be_true
-    end
-
-    it "does define good_attribute=()" do
-        @model.respond_to?('good_attribute=') # to force method generation
-        @model.methods.include?('good_attribute=').should be_true
-    end
-
-    it "does define id()" do
-        @model.respond_to?('id') # to force method generation
-        @model.methods.include?('id').should be_true
-    end
-    
-    it "can create instance in database with special attribute name" do
-        m = MyModel.create(:class => 'Foo')
-        m = MyModel.find(m.id)
-        m[:class].should == 'Foo'
-    end
-
-    it "has class attribute" do
-        MyModel.new().has_attribute?('class').should be_true
-    end
-
-    it "can call class= without error" do
-        m = MyModel.new()
-        m.class = 'Foo'
-        m[:class].should == 'Foo'
-    end
-
-    it "can use finders with attribute" do
-        m = MyModel.find_all_by_class('Foo')
-        m.size.should == 0
-    end
+  before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+    @model = MyModel.new
+  end
+
+  after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
+  it "inspecting class returns expected attribute names" do
+    MyModel.inspect.should match 'class: string'
+  end
+
+  it "inspecting instance returns expected attribute names" do
+    @model.inspect.should match 'class: nil'
+  end
+
+  it "does not redefine class()" do
+    @model.class.name.should == 'MyModel'
+  end
+
+  it "defines class=()" do
+    @model.respond_to?('class=') # to force method generation
+    @model.methods.include?('class=').should be_true
+  end
+
+  it "does not define bad_attribute()" do
+    @model.respond_to?('bad_attribute') # to force method generation
+    @model.methods.include?('bad_attribute').should be_false
+  end
+
+  it "does not define bad_attribute=()" do
+    @model.respond_to?('bad_attribute=') # to force method generation
+    @model.methods.include?('bad_attribute=').should be_false
+  end
+
+  it "does define good_attribute()" do
+    @model.respond_to?('good_attribute') # to force method generation
+    @model.methods.include?('good_attribute').should be_true
+  end
+
+  it "does define good_attribute=()" do
+    @model.respond_to?('good_attribute=') # to force method generation
+    @model.methods.include?('good_attribute=').should be_true
+  end
+
+  it "does define id()" do
+    @model.respond_to?('id') # to force method generation
+    @model.methods.include?('id').should be_true
+  end
+
+  it "can create instance in database with special attribute name" do
+    m = MyModel.create(:class => 'Foo')
+    m = MyModel.find(m.id)
+    m[:class].should == 'Foo'
+  end
+
+  it "has class attribute" do
+    MyModel.new().has_attribute?('class').should be_true
+  end
+
+  it "can call class= without error" do
+    m = MyModel.new()
+    m.class = 'Foo'
+    m[:class].should == 'Foo'
+  end
+
+  it "can use finders with attribute" do
+    m = MyModel.find_all_by_class('Foo')
+    m.size.should == 0
+  end
+
+  it "validates presence of class" do
+    @model.valid?.should be_false
+    Array(@model.errors[:class]).include?("can't be blank").should be_true
+
+    m = MyModel.new(:class => 'Foo')
+    m.valid?.should be_true
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: safe_attributes
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Brian Jones
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-24 00:00:00 -05:00
+date: 2011-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency