moorage-xml_protected 0.0.2 → 0.0.3

data/README.textile

@@ -15,6 +15,9 @@ class Model < ActiveRecord::Base
 end
 </pre>
 
+You can also access these attributes from the added class method:
+
+<code>protected_xml_attributes</code>
 
 h3. In Conjunction with <code>attr_protected</code>
 
@@ -53,6 +56,26 @@ Optionally, to unpack it into your application, just run:
 </pre>
 
 
+h2. How it works
+
+Two methods are extended onto your active record class:
+
+1. <code>xml_protected(*attributes)</code>
+2. <code>protected_xml_attributes</code>
+
+1. Adds to the inheritable attribute "xml_protected_attrs" the attributes that are speicified in this call.  If this is the first time the method is called, it also aliases the old to_xml, and specified a new one which reads from these xml_protected_attrs
+
+2. Simply returns the values currently in "xml_protected_attrs".
+
+One method is included into your active record class, which is pretty self explanatory:
+
+<pre>
+  def to_xml(options = {})
+    options[:except] ||= []
+    xml_protected_to_xml(options.merge(:except => options[:except].concat(self.class.protected_xml_attributes)))
+  end
+</pre>
+
 h2. Copyright & License
 
 Copyright (c) 2008 ThriveSmart, LLC, released under the MIT license

data/Rakefile

@@ -7,7 +7,7 @@ require 'date'
  
 GEM = "xml_protected"
 HUMANIZED_GEM = "XmlProtected"
-GEM_VERSION = "0.0.2"
+GEM_VERSION = "0.0.3"
 AUTHOR = "ThriveSmart, LLC"
 EMAIL = "developers@thrivesmart.com"
 HOMEPAGE = "http://www.github.com/moorage/xml_protected"

data/lib/xml_protected.rb

@@ -6,23 +6,28 @@ module XmlProtected
   end
 
   module ActMethods
-    def xml_protected(*attrs)
-      # doing these shenanigans so that the option hash passed in is available to the outside world
-      class_inheritable_accessor :xml_protected_attrs
-      self.xml_protected_attrs = attrs
-
+    
+    def xml_protected(*attributes)
+      write_inheritable_attribute("xml_protected_attrs", Set.new(attributes.map(&:to_s)) + (protected_xml_attributes || []))
+      
       # only need to define these once on a class
       unless included_modules.include?(InstanceMethods)
         alias_method :xml_protected_to_xml, :to_xml
         include InstanceMethods
       end
     end
+
+    # Returns an array of all the attributes that have been protected (excluded) from default to_xml output.
+    def protected_xml_attributes # :nodoc:
+      read_inheritable_attribute("xml_protected_attrs")
+    end
+    
   end
 
   module InstanceMethods
     def to_xml(options = {})
       options[:except] ||= []
-      xml_protected_to_xml(options.merge(:except => options[:except].concat(self.xml_protected_attrs)))
+      xml_protected_to_xml(options.merge(:except => options[:except].concat(self.class.protected_xml_attributes)))
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: moorage-xml_protected
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - ThriveSmart, LLC