exposable_attributes 0.0.1

data/README.rdoc

@@ -0,0 +1,45 @@
+
+== exposable_attributes
+
+Exposable Attributes plugin is designed to control ActiveRecord::Base to_xml and to_json methods output.
+It might be useful with plugins like inherited_resources.
+
+
+== Resources
+
+Source
+
+* git://github.com/nikolaeff/exposable_attributes
+
+
+== Example
+
+Redefine to_xml() and to_json() with def params as :only => [:id, :login, :password]
+
+  class User < ActiveRecord::Base
+    exposable_attributes :id, :login, :password
+  end
+
+
+Redefine to_json method only, to_xml will be defined as usual
+
+  class User < ActiveRecord::Base
+    exposable_attributes :json, :only => [:id, :login]
+  end
+
+
+Redefine to_xml only with "except" statement
+
+  class User < ActiveRecord::Base
+    exposable_attributes :xml,  :except => [:encrypted_password, :salt, :single_access_token]
+  end
+
+
+Redefine both to_xml and to_json
+
+  class User < ActiveRecord::Base
+    exposable_attributes :json, :xml, :except => [:encrypted_password, :salt, :single_access_token]
+  end
+
+
+Copyright (c) 2010 nikolaeff, released under the MIT license

data/lib/exposable_attributes/version.rb

@@ -0,0 +1,3 @@
+module ExposableAttributes
+  VERSION = "0.0.1".freeze
+end

data/lib/exposable_attributes.rb

@@ -0,0 +1,76 @@
+# ExposableAttributes
+module ExposableAttributes
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  DEFAULT_ACCESS_METHODS = [:xml, :json]
+
+  module ClassMethods
+    # Defines exposable attributes for AR object.
+    #
+    # == Examples
+    # 
+    #   class User < ActiveRecord::Base
+    #     exposable_attributes :json, :only => [:id, :login]
+    #     exposable_attributes :xml,  :except => [:encrypted_password, :salt, :single_access_token]
+    #     exposable_attributes :json, :xml, :except => [:encrypted_password, :salt, :single_access_token]
+    #   end
+    def exposable_attributes(*attributes)
+      init_default_accessors unless already_initialized?
+      access_methods, options = parse_attributes(attributes)
+      access_methods.each {|method_name| define_accessor(method_name, options) }
+      send :include, InstanceMethods
+    end
+
+    private
+      def init_default_accessors
+        DEFAULT_ACCESS_METHODS.each {|method_name| define_accessor(method_name, {}) }
+        set_initialization_flag
+      end
+
+      def set_initialization_flag
+        cattr_accessor :exposable_attributes_initialized
+        self.exposable_attributes_initialized = true
+      end
+
+      def already_initialized?
+        self.respond_to? :exposable_attributes_initialized
+      end
+
+      def define_accessor(accessor_name, options)
+        access_method_accessor = "exposable_#{accessor_name.to_s}_attributes"
+        self.send(:cattr_accessor, access_method_accessor) 
+        self.send("#{access_method_accessor}=", options)
+      end
+
+      def parse_attributes(attributes)
+        access_methods = []
+        options = {}
+
+        if attributes.last.is_a?(Hash) then
+           options = attributes.pop
+          access_methods = attributes
+        else
+          options = { :only => attributes }
+          access_methods = DEFAULT_ACCESS_METHODS
+        end
+
+        [access_methods, options]
+      end
+  end
+
+  module InstanceMethods
+    def to_xml(options = {})
+      super(exposable_xml_attributes.merge(options))
+    end
+
+    def to_json(options = {})
+      super(exposable_json_attributes.merge(options))
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, ExposableAttributes

data/rails/init.rb

@@ -0,0 +1 @@
+require 'exposable_attributes'

data/tasks/exposable_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :exposable_attributes do
+#   # Task goes here
+# end

data/test/exposable_attributes_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ExposableAttributesTest < ActiveSupport::TestCase
+  test "the truth" do
+    assert true
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/fixtures'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: exposable_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrey Nikolaev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-18 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: Ruby on Rails plugin designed to control ActiveRecord::Base to_xml and to_json methods output
+email: nikolaeff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/exposable_attributes.rb
+- lib/exposable_attributes/version.rb
+- rails/init.rb
+- tasks/exposable_attributes_tasks.rake
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/nikolaeff/exposable_attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Make ActiveRecord attributes exposable
+test_files: 
+- test/exposable_attributes_test.rb
+- test/test_helper.rb