safe_attributes 1.0.1

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'activesupport', '~> 3.0.0'
+gem 'activerecord', '~> 3.0.0'
+
+group :development do
+  gem 'jeweler', '>=1.5.2'
+  gem 'rake', '>=0.8.7'
+  gem 'rspec', '>= 2.3.0'
+  gem 'rcov'
+  gem 'sqlite3-ruby'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 C. Brian Jones
+
+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,81 @@
+= SafeAttributes
+
+By default Rails creates attribute accessors for all database table columns
+in each model.  Columns with specific names cause errors because they result
+in Rails redefining a key method within either Ruby or Rails in an 
+incompatible way.  A classic example for me has been tables with a column 
+named 'class', though there are many other possible examples.
+
+Using this gem enhances activerecord to change the default behavior for
+the creation of attribute accessors.  Methods in ActiveRecord::Base and
+its superclasses, except for 'id', are combined into a list.  This list
+is checked before the creation of two types of attribute accessors: 
+attribute() and attribute=().  
+
+You can add to this list by calling bad_attribute_names with a list of
+method names you do not want generated.  Rails generates additional methods
+that this module does not prevent the creation of: 
+
+* attribute_before_type_cast
+* attribute_changed?
+* attribute_was
+* attribute_will_change!
+* attribute?
+
+These largely should not run afoul of Ruby or ActiveRecord in most cases.
+
+To access an attribute in ActiveRecord without its normal getter or setter
+you can use a couple of different approaches.
+
+* model_instance[:attribute]  # works as both getter and setter like a hash
+* model_instance.read_attribute('attribute')
+* model_instance.write_attribute('attribute', value)
+
+== Installing
+
+  gem install safe_attributes --force
+
+The --force flag is here because I believe rubygems to have some sort of
+dependency tracking issue.  Without it, it wants to install the newest
+activemodel (3.0.3 at this time) and arel.  These are not necessary 
+for the gem and this should not be happening.  As long as you have 
+activerecord 3.0.0 or better it should work.  Here's the error message
+in case you see it.
+
+  ERROR:  Error installing safe_attributes:
+    activemodel requires activesupport (= 3.0.3, runtime)
+
+== Using
+
+=== Rails
+Add safe_attributes to your Gemfile.
+
+  gem 'safe_attributes'
+
+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.
+
+  class MyModel < ActiveRecord::Base
+    bad_attribute_names :my_attr
+  end
+
+=== Outside of Rails
+  require 'safe_attributes'
+  class MyModel < ActiveRecord::Base
+    include SafeAttributes
+  end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 C. Brian Jones. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+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'
+
+version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "safe_attributes"
+  gem.version = version
+  gem.homepage = "http://github.com/bjones/safe_attributes"
+  gem.license = "MIT"
+  gem.summary = %Q{Add support for reserved word column names with ActiveRecord}
+  gem.description = %Q{If your schema has columns named type, or class, or any other name that conflicts with a method of ActiveRecord or one of its superclasses, you will need this gem to use Rails 3 with that database.}
+  gem.email = "cbj@gnu.org"
+  gem.authors = ["Brian Jones"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "SafeAttributes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/safe_attributes.rb

@@ -0,0 +1,47 @@
+module SafeAttributes
+    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
+
+        # 
+        # 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
+    end
+end
+
+require 'safe_attributes/railtie.rb' if defined?(Rails)

data/lib/safe_attributes/railtie.rb

@@ -0,0 +1,12 @@
+require 'safe_attributes'
+require 'rails'
+
+module SafeAttributes
+  class Railtie < ::Rails::Railtie
+    initializer "safeattributes.active_record" do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, SafeAttributes
+      end
+    end
+  end
+end

data/safe_attributes.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{safe_attributes}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Jones"]
+  s.date = %q{2010-12-25}
+  s.description = %q{If your schema has columns named type, or class, or any other name that conflicts with a method of ActiveRecord or one of its superclasses, you will need this gem to use Rails 3 with that database.}
+  s.email = %q{cbj@gnu.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/safe_attributes.rb",
+    "lib/safe_attributes/railtie.rb",
+    "safe_attributes.gemspec",
+    "spec/safe_attributes/safe_attributes_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bjones/safe_attributes}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Add support for reserved word column names with ActiveRecord}
+  s.test_files = [
+    "spec/safe_attributes/safe_attributes_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_development_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+    s.add_dependency(%q<rake>, [">= 0.8.7"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+  end
+end
+

data/spec/safe_attributes/safe_attributes_spec.rb

@@ -0,0 +1,92 @@
+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
+end
+
+class MyModel < ActiveRecord::Base
+    include SafeAttributes
+    bad_attribute_names :bad_attribute, :bad_attribute=
+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
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+gem 'activerecord', '>= 3.0.0'
+require 'active_record'
+gem 'activesupport', '>= 3.0.0'
+require 'active_support'
+
+require 'safe_attributes'
+require 'rspec'
+require 'rspec/autorun'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3", 
+  :database => "#{root}/db/safeattributes.db"
+)
+
+RSpec.configure do |config|
+end
+

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: safe_attributes
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Brian Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activerecord
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3-ruby
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+description: If your schema has columns named type, or class, or any other name that conflicts with a method of ActiveRecord or one of its superclasses, you will need this gem to use Rails 3 with that database.
+email: cbj@gnu.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/safe_attributes.rb
+- lib/safe_attributes/railtie.rb
+- safe_attributes.gemspec
+- spec/safe_attributes/safe_attributes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bjones/safe_attributes
+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: Add support for reserved word column names with ActiveRecord
+test_files: 
+- spec/safe_attributes/safe_attributes_spec.rb
+- spec/spec_helper.rb