attr_encodable 0.0.6 → 0.1.0

data/lib/attr_encodable.rb

@@ -80,33 +80,36 @@ module Encodable
 
   module InstanceMethods
     def serializable_hash(options = {})
+      options ||= {}
+      original_except = if options[:except]
+        options[:except] = Array(options[:except]).map(&:to_sym)
+      else
+        options[:except] = []
+      end
+
+      # Convert :only to :except
       if options && options[:only]
-        # We DON'T want to fuck with :only and :except showing up in the same call. This is a disaster.
-        super
+        options[:except].push *self.class.default_attributes - Array(options.delete(:only).map(&:to_sym))
+      end
+
+      # This is a little bit confusing. ActiveRecord's default behavior is to apply the :except arguments you pass
+      # in to any :include options UNLESS it's overridden on the :include option. In the event that we have some
+      # *default* excepts that come from Encodable, we want to ignore those and pass only whatever the original
+      # :except options from the user were on down to the :include guys.
+      inherited_except = original_except - self.class.default_attributes
+      case options[:include]
+      when Array, Symbol
+        # Convert includes arrays or singleton symbols into a hash with our original_except scope
+        includes = Array(options[:include])
+        options[:include] = Hash[*includes.map{|association| [association, {:except => inherited_except}]}.flatten]
       else
-        options ||= {}
-        original_except = if options[:except]
-          options[:except] = Array(options[:except]).map(&:to_sym)
-        else
-          options[:except] = []
-        end
-        # This is a little bit confusing. ActiveRecord's default behavior is to apply the :except arguments you pass
-        # in to any :include options UNLESS it's overridden on the :include option. In the event that we have some
-        # *default* excepts that come from Encodable, we want to ignore those and pass only whatever the original
-        # :except options from the user were on down to the :include guys.
-        inherited_except = original_except - self.class.default_attributes
-        case options[:include]
-        when Array, Symbol
-          # Convert includes arrays or singleton symbols into a hash with our original_except scope
-          includes = Array(options[:include])
-          options[:include] = Hash[*includes.map{|association| [association, {:except => inherited_except}]}.flatten]
-        else
-          options[:include] ||= {}
-        end
-        # Exclude the black-list
-        options[:except].push *self.class.unencodable_attributes
-        # Include any default :include or :methods arguments that were passed in earlier
-        self.class.default_attributes.each do |attribute, as|
+        options[:include] ||= {}
+      end
+      # Exclude the black-list
+      options[:except].push *self.class.unencodable_attributes
+      # Include any default :include or :methods arguments that were passed in earlier
+      self.class.default_attributes.each do |attribute, as|
+        unless options[:except].include?(attribute)
           if association = self.class.reflect_on_association(attribute)
             options[:include][attribute] = {:except => inherited_except}
           elsif respond_to?(attribute) && !self.class.column_names.include?(attribute.to_s)
@@ -114,14 +117,16 @@ module Encodable
             options[:methods].push attribute
           end
         end
-        as_json = super(options)
-        unless self.class.renamed_encoded_attributes.empty?
-          self.class.renamed_encoded_attributes.each do |attribute, as|
+      end
+      as_json = super(options)
+      unless self.class.renamed_encoded_attributes.empty?
+        self.class.renamed_encoded_attributes.each do |attribute, as|
+          if as_json.has_key?(attribute) || as_json.has_key?(attribute.to_s)
             as_json[as.to_s] = as_json.delete(attribute) || as_json.delete(attribute.to_s)
           end
         end
-        as_json
       end
+      as_json
     end
   end
 end

data/spec/attr_encodable_spec.rb

@@ -1,4 +1,5 @@
-require "lib/attr_encodable"
+require File.join(File.dirname(__FILE__), '..', 'lib', 'attr_encodable')#{}"../lib/attr_encodable"
+require 'active_support'
 
 describe Encodable do
   it "should automatically extend ActiveRecord::Base" do
@@ -38,7 +39,7 @@ describe Encodable do
       :first_name => "flip",
       :last_name => "sasser",
       :email => "flip@foobar.com",
-      :encrypted_password => ActiveSupport::SecureRandom.hex(30),
+      :encrypted_password => SecureRandom.hex(30),
       :developer => true,
       :admin => true,
       :password_set => true,
@@ -69,15 +70,15 @@ describe Encodable do
 
   describe "at the parent model level" do
     it "should not mess with to_json unless when attr_encodable and attr_unencodable are not set" do
-      @user.as_json == @user.attributes
+      @user.as_json.should == @user.attributes
     end
 
     it "should not mess with :include options" do
-      @user.as_json(:include => :permissions) == @user.attributes.merge(:permissions => @user.permissions.as_json)
+      @user.as_json(:include => :permissions).should == @user.attributes.merge(:permissions => @user.permissions.as_json)
     end
 
     it "should not mess with :methods options" do
-      @user.as_json(:methods => :foobar) == @user.attributes.merge(:foobar => "baz")
+      @user.as_json(:methods => :foobar).should == @user.attributes.merge(:foobar => "baz")
     end
 
     it "should allow me to whitelist attributes" do
@@ -90,6 +91,7 @@ describe Encodable do
       @user.as_json.should == @user.attributes.except('login', 'first_name', 'last_name')
     end
 
+
     # Of note is the INSANITY of ActiveRecord in that it applies :only / :except to :include as well. Which is
     # obviously insane. Similarly, it doesn't allow :methods to come along when :only is specified. Good god, what
     # a shame.
@@ -109,13 +111,13 @@ describe Encodable do
     end
   end
 
-  describe "at the child model level when the paren model has attr_encodable set" do
+  describe "at the child model level when the parent model has attr_encodable set" do
     before :each do
       User.attr_encodable :login, :first_name, :last_name
     end
 
     it "should not mess with to_json unless when attr_encodable and attr_unencodable are not set on the child, but are on the parent" do
-      @user.permissions.as_json == @user.permissions.map(&:attributes)
+      @user.permissions.as_json.should == @user.permissions.map(&:attributes)
     end
 
     it "should not mess with :include options" do
@@ -153,6 +155,16 @@ describe Encodable do
     @user.as_json.should == @user.attributes.slice('login', 'first_name', 'id').merge(:foobar => "baz")
   end
 
+  it "should allow me to only request certain whitelisted attributes and methods" do
+    User.attr_encodable :login, :first_name, :last_name, :foobar
+    @user.as_json(:only => [:login, :foobar]).should == {'login' => 'flipsasser', :foobar => 'baz'}
+  end
+
+  it "should allow me to use :only with aliased methods and attributes" do
+    User.attr_encodable :login => :login_eh, :first_name => :foist, :last_name => :last, :foobar => :baz
+    @user.as_json(:only => [:login, :foobar]).should == {'login_eh' => 'flipsasser', 'baz' => 'baz'}
+  end
+
   describe "reassigning" do
     it "should let me reassign attributes" do
       User.attr_encodable :id => :identifier

metadata

@@ -1,101 +1,69 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: attr_encodable
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Flip Sasser
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-15 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 0
-        - 9
-        - 9
-        version: 0.9.9
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
-  type: :development
-  version_requirements: *id002
-description: "\n    attr_encodable enables you to set up defaults for what is included or excluded when you serialize an ActiveRecord object. This is especially useful for protecting private attributes when building a public API.\n  "
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ! "\n    attr_encodable enables you to set up defaults for what is included
+  or excluded when you serialize an ActiveRecord object. This is especially useful\n
+  \   for protecting private attributes when building a public API.\n  "
 email: flip@x451.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
+files:
 - LICENSE
 - README.md
 - lib/attr_encodable.rb
 - spec/attr_encodable_spec.rb
-has_rdoc: true
 homepage: http://github.com/Plinq/attr_encodable
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: An attribute black- or white-list for ActiveRecord serialization
-test_files: 
+test_files:
 - spec/attr_encodable_spec.rb