thrivesmart-xml_protected 0.0.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,83 @@
+h1. XmlProtected
+
+Keeps specified attributes of a model out of to_xml, by aliasing to_xml, and automatically sending in the correct <code>:excludes</code> to the original <code>to_xml</code> method, e.g. <code>:excludes => [:attr1, :attr2, ...]</code>
+
+NOTE: as of this time, it doesn't protect these attributes from reading.  For that, use this in conjunction with <code>:attr_protected</code>
+
+
+h2. Usage
+
+An ActiveRecord Model:
+
+<pre>
+class Model < ActiveRecord::Base
+  include XmlProtected # Required because it's a gemmefied plugin
+  xml_protected :attr1, :attr2, :attr3
+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>
+
+
+<pre>
+class Model < ActiveRecord::Base
+  include XmlProtected # Required because it's a gemmefied plugin
+  attr_protected :attr1, :attr2, :attr3
+  xml_protected :attr1, :attr2, :attr3
+end
+</pre>
+
+h2. Installation
+
+To enable the library your Rails 2.1 (or greater) project, use the gem configuration method in "<code>config/environment.rb</code>"
+
+<pre>
+Rails::Initializer.run do |config|
+  config.gem 'thrivesmart-xml_protected', :lib => 'xml_protected', :source => 'http://gems.github.com'
+end
+</pre>
+
+The <code>:lib</code> is important, because rails gets confused when the name of the gem is different from the library.
+
+And of course, run 
+
+<pre>
+  rake gems:install
+</pre>
+
+To get them installed on your system.
+
+Optionally, to unpack it into your application, just run:
+
+<pre>
+  rake gems:unpack GEM=thrivesmart-xml_protected
+</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

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rubygems/specification'
+# require 'spec/rake/spectask'
+require 'date'
+ 
+GEM = "xml_protected"
+HUMANIZED_GEM = "XmlProtected"
+GEM_VERSION = "0.0.5"
+AUTHOR = "ThriveSmart, LLC"
+EMAIL = "developers@thrivesmart.com"
+HOMEPAGE = "http://www.github.com/thrivesmart/xml_protected"
+SUMMARY = "Keeps specified attributes of a model out of to_xml.  Do so by aliasing to_xml, and automatically sending in the correct :excludes to the original to_xml method, e.g. :excludes => [:attr1, :attr2, ...]"
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = GEM
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.textile', 'LICENSE']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+ 
+desc "Run Specs"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Generate Documentation"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = HUMANIZED_GEM
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << HUMANIZED_GEM
+  rdoc.rdoc_files.include(FileList[ 'lib/**/*.rb', 'README.textile', 'LICENSE'])
+end
+ 
+task :default => :spec
+task :specs => :spec
+ 
+# desc "Run all examples"
+# Spec::Rake::SpecTask.new('spec') do |t|
+#   t.spec_opts = ['--options','spec/spec.opts']
+#   t.spec_files = FileList['spec/**/*.rb']
+#   t.rcov = true
+# end
+ 
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+ 
+task :bugs do
+  sh %{ditz html ; open html/index.html}
+end

data/lib/xml_protected.rb

@@ -0,0 +1,35 @@
+# Usage: xml_protected :attr1, :attr2, :attr3
+module XmlProtected
+
+  def self.included(klass)
+    klass.extend ActMethods
+  end
+
+  module ActMethods
+    
+    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 = {})
+      xml_protected_to_xml(
+        options.merge(
+          :except => self.class.protected_xml_attributes + (options[:except] || [])
+      ))
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: thrivesmart-xml_protected
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- ThriveSmart, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Keeps specified attributes of a model out of to_xml.  Do so by aliasing to_xml, and automatically sending in the correct :excludes to the original to_xml method, e.g. :excludes => [:attr1, :attr2, ...]
+email: developers@thrivesmart.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- lib/xml_protected.rb
+has_rdoc: true
+homepage: http://www.github.com/thrivesmart/xml_protected
+post_install_message: 
+rdoc_options: []
+
+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: xml_protected
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Keeps specified attributes of a model out of to_xml.  Do so by aliasing to_xml, and automatically sending in the correct :excludes to the original to_xml method, e.g. :excludes => [:attr1, :attr2, ...]
+test_files: []
+