acts_as_wrapped_class 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,7 @@
+== 1.0.1 / 2007-10-25
+
+* Added "allowed_methods to XWrappers"
+
 == 1.0.0 / 2007-10-22
 
 * Release of the initial version of the gem  

data/README.txt

@@ -12,22 +12,22 @@ ActsAsWrappedClass is designed to automatically generate a wrapper for an object
 
 == SYNOPSIS:
 
-class Something
-  acts_as_wrapped_class :methods => [:safe_method]
-  # SomethingWrapper is now defined
+	class Something
+	  acts_as_wrapped_class :methods => [:safe_method]
+	  # SomethingWrapper is now defined
   
-  def safe_method  # allowed to access this method through SomethingWrapper
-    Something.new
-  end
-
-  def unsafe_method  # not allowed to access this method through SomethingWrapper
-  end
-end
-
-s = Something.new
-wrapper = s.to_wrapper
-wrapper.safe_method    # returns a new SomethingWrapper
-wrapper.unsafe_method  # raises an exception
+	  def safe_method  # allowed to access this method through SomethingWrapper
+	    Something.new
+	  end
+
+	  def unsafe_method  # not allowed to access this method through SomethingWrapper
+	  end
+	end
+
+	s = Something.new
+	wrapper = s.to_wrapper
+	wrapper.safe_method    # returns a new SomethingWrapper
+	wrapper.unsafe_method  # raises an exception
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -12,6 +12,9 @@ Hoe.new('acts_as_wrapped_class', ActsAsWrappedClass::VERSION) do |p|
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.rubyforge_name = "wrapped-class"
+	p.remote_rdoc_dir = '' # Release to root
+  p.rsync_args << ' --exclude=statsvn/'
 end
 
 # vim: syntax=Ruby

data/lib/acts_as_wrapped_class.rb

@@ -1,7 +1,7 @@
 require "erb"
 
 module ActsAsWrappedClass
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
   WRAPPED_CLASSES = []
   
   module InstanceMethods
@@ -61,10 +61,11 @@ module ActsAsWrappedClass
   # * options[:constants] contains a list of constant names (symbols) to allow access to
   # * options[:except_constants] contains a list of constant names (symbols) to not allow access to
   def acts_as_wrapped_class(options = {})
+    
     raise "Can't specify methods to allow and to deny." if options[:methods] && options[:except_methods]
     raise "Can't specify constants to allow and to deny." if options[:constants] && options[:except_constants]
-    options[:methods] ||= :all
-    options[:constants] ||= :all
+    options[:methods] ||= :all unless options[:except_methods]
+    options[:constants] ||= :all unless options[:except_constants]
     
     WRAPPED_CLASSES << self
     
@@ -76,7 +77,7 @@ module ActsAsWrappedClass
     if options[:constants] == :all
       options.delete(:constants)
       options[:except_constants] = []
-    end
+    end    
     
     meths = options[:methods] || options[:except_methods]
     consts = options[:constants] || options[:except_constants]
@@ -129,11 +130,21 @@ module ActsAsWrappedClass
     
     method_defs = ERB.new(method_defs_erb).result(binding)
     
+    allowed_methods = <<-EOF
+      def self.allowed_methods
+          #{ options[:except_methods] ? 
+                ("#{self.name}.public_instance_methods - [" + (meths + WrapperBase::ALLOWED_METHODS + ["to_wrapper"]).collect{|m| "\"#{m}\"" }.join(", ") + "]") :
+                ("[" + meths.collect{|m| "\"#{m}\""}.join(", ") + "]")
+            }
+      end
+    EOF
+        
     wrapper_class_code = <<-EOF
       class #{self.name}Wrapper < WrapperBase
-        #{method_defs}        
+        #{method_defs}
+        #{allowed_methods}
       end
-EOF
+    EOF
 
     eval wrapper_class_code, TOPLEVEL_BINDING
   end

data/lib/wrapper_base.rb

@@ -1,5 +1,7 @@
 class WrapperBase
-  eval((public_instance_methods - ["__id__","__send__", "is_a?", "kind_of?", "hash", "class", "inspect"]).collect{|meth| "undef "+meth}.join("; "))
+  ALLOWED_METHODS = ["__id__","__send__", "is_a?", "kind_of?", "hash", "class", "inspect"]
+  
+  eval((public_instance_methods - ALLOWED_METHODS).collect{|meth| "undef "+meth}.join("; "))
 
   # Create a wrapper, passing in an object to wrap
   def initialize(wrapped_object)

data/test/test_acts_as_wrapped_class.rb

@@ -28,7 +28,7 @@ end
 class OtherClass
   SAMPLE_CLASS = SampleClass.new
   
-  acts_as_wrapped_class :methods => :all, :constants => :all
+  acts_as_wrapped_class :except_methods => [:unsafe_method], :constants => :all
 
   attr_reader :value
 
@@ -48,6 +48,10 @@ class OtherClass
     6.6
   end
   
+  def unsafe_method
+    6.666
+  end
+  
   def hash
     @value
   end
@@ -117,6 +121,14 @@ class ActsAsWrappedCodeTest < Test::Unit::TestCase
     assert !NotWrappedClass.wrapped_class?    
   end
   
+  def test_allowed_methods
+    assert SampleClassWrapper.allowed_methods.is_a?(Array)
+    assert_equal ["get_other_class", "other_method"], SampleClassWrapper.allowed_methods
+    assert !OtherClassWrapper.allowed_methods.include?("unsafe_method")
+    assert OtherClassWrapper.allowed_methods.include?("another_method")
+    assert OtherClassWrapper.allowed_methods.include?("get_hash")
+  end
+  
   def assert_contents_same(array1, array2)
     assert_equal array1.length, array2.length, "#{array1.inspect} != #{array2.inspect}"
     array1.each { |a| assert array2.include?(a), "#{array2.inspect} does not contain #{a.inspect}" }

metadata

@@ -3,14 +3,14 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: acts_as_wrapped_class
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-10-22 00:00:00 -07:00
+  version: 1.0.1
+date: 2007-10-25 00:00:00 -07:00
 summary: automatically generate wrapper classes which restrict access to methods and constants in the wrapped class
 require_paths: 
 - lib
 email: ds@elctech.com
 homepage: "    by David Stevenson "
-rubyforge_project: acts_as_wrapped_class
+rubyforge_project: wrapped-class
 description: "== FEATURES/PROBLEMS:  *  Wrappers do not dispatch const_missing yet, so constants are not accessible yet.  == SYNOPSIS:  class Something acts_as_wrapped_class :methods => [:safe_method] # SomethingWrapper is now defined  def safe_method  # allowed to access this method through SomethingWrapper Something.new end  def unsafe_method  # not allowed to access this method through SomethingWrapper end end"
 autorequire: 
 default_executable: