ggoodale-attr_private 0.1.0

data/CHANGES

@@ -0,0 +1 @@
+0.1.0 - Initial release

data/README.rdoc

@@ -0,0 +1,22 @@
+= attr_private
+
+attr_private is a way to hide fields on an ActiveRecord model such
+that they are inaccessible to external callers.  fields declared
+private are protected from most access methods provided by AR. 
+Attempts to access a private field will raise a NoMethodError as 
+though the field did not exist.
+
+== Using attr_private
+=== app/models/my_model.rb
+  class MyModel < ActiveRecord::Base
+    attr_private :my_field, :some_other_field
+  end
+
+== Limitations
+
+Currently, attr_private doesn't prevent reading via the attributes hash.
+
+
+== Special Thanks To
+* reQall for letting me hack in Ruby
+* Evan Light for pushing me to make this a gem (my first!)

data/Rakefile

@@ -0,0 +1,29 @@
+require "rake"
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+desc "Runs the Rspec suite"
+task(:default) do
+  run_suite
+end
+ 
+desc "Runs the Rspec suite"
+task(:spec) do
+  run_suite
+end
+ 
+def run_suite
+  dir = File.dirname(__FILE__)
+  system("ruby #{dir}/spec/spec_suite.rb --options #{dir}/spec/spec.opts") || raise("Spec Suite failed")
+end
+ 
+spec = eval(File.read("#{File.dirname(__FILE__)}/attr_private.gemspec"))
+PKG_NAME = spec.name
+PKG_VERSION = spec.version
+ 
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/lib/attr_private.rb

@@ -0,0 +1,60 @@
+require 'activerecord'
+
+module AttrPrivate
+  def self.included(base)
+    base.extend(SingletonMethods)
+  end
+  
+  # This provides the ability to mark a field on a record as private, preventing access from 
+  # outside an instance of the class.
+  #
+  module SingletonMethods
+    
+    def attr_private(*fields)
+
+      write_inheritable_attribute :private_fields, fields
+      class_inheritable_reader :private_fields
+
+      extend ClassMethods
+
+      fields.each {|field|
+        column = connection.columns(table_name, "AttrPrivate").detect{|column| column.name.to_sym == field.to_sym} 
+        raise ActiveRecord::ActiveRecordError, "Unknown field #{field}" if column.nil?
+
+        puts "protecting #{field}"
+        # prevent bulk assignment
+        attr_protected field
+        
+        # prevent use of the standard accessors
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def #{field}
+            raise ::NoMethodError, "undefined method \`#{field}' for \#{self}"
+          end
+          def #{field}=(x)
+            raise ::NoMethodError, "undefined method \`#{field}=' for \#{self}"
+          end
+          def #{field}?
+            raise ::NoMethodError, "undefined method \`#{field}?' for \#{self}"
+          end
+        end_eval
+      }
+    end
+            
+    module ClassMethods
+      def method_missing_with_parameter_exclusion(name, *args)
+        private_fields.each do |field|
+          raise ::NoMethodError, "undefined method `#{name}' for #{self}" if /_#{field}_|_#{field}$/.match(name.to_s)
+        end
+        method_missing_without_parameter_exclusion(name, args) 
+      end
+
+      alias_method :method_missing_without_parameter_exclusion, :method_missing
+      alias_method :method_missing, :method_missing_with_parameter_exclusion
+    end
+        
+  end
+end
+
+class ActiveRecord::Base
+  include AttrPrivate
+end

data/spec/attr_private/attr_private_spec.rb

@@ -0,0 +1 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")

data/spec/environment_fixture_setup.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "spec"
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift "#{dir}/../lib"
+require "attr_private"
+require "pp"
+gem "activerecord", ">= 2.1.0"

data/spec/spec.opts

@@ -0,0 +1,14 @@
+--colour
+--format
+progress
+--format
+failing_examples:previous_failures.txt
+--example
+previous_failures.txt
+--loadby
+mtime
+--reverse
+--timeout
+20
+--diff
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/environment_fixture_setup"
+ 
+Spec::Runner.configure do |config|
+  # Nothing yet
+end
+ 

data/spec/spec_suite.rb

@@ -0,0 +1,13 @@
+class AttrPrivateSuite
+  def run
+    files = Dir["#{File.dirname(__FILE__)}/**/*_spec.rb"]
+    puts "Running AttrPrivate Suite"
+    files.each do |file|
+      require file
+    end
+  end
+end
+ 
+if $0 == __FILE__
+  AttrPrivateSuite.new.run
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: ggoodale-attr_private
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Grant Goodale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: attr_private provides a way of making fields on an ActiveRecord model inaccessible to users of that model.
+email: grant@reqall.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGES
+files: 
+- CHANGES
+- Rakefile
+- README.rdoc
+- lib/attr_private.rb
+- spec/environment_fixture_setup.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/spec_suite.rb
+- spec/attr_private/attr_private_spec.rb
+has_rdoc: true
+homepage: http://reqall.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+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.2.0
+signing_key: 
+specification_version: 2
+summary: attr_private provides a way of making fields on an ActiveRecord model inaccessible to users of that model.
+test_files: 
+- spec/attr_private/attr_private_spec.rb