active_attr 0.7.0 → 0.8.0

data/.travis.yml

@@ -3,17 +3,27 @@ rvm:
   - ree
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 bundler_args: --without development
 gemfile:
   - Gemfile
   - gemfiles/rails_3_0.gemfile
   - gemfiles/rails_3_1.gemfile
+  - gemfiles/rails_3_2.gemfile
   - gemfiles/rails_head.gemfile
 matrix:
   allow_failures:
     - gemfile: gemfiles/rails_head.gemfile
   exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails_head.gemfile
     - rvm: ree
       gemfile: gemfiles/rails_head.gemfile
     - rvm: 1.9.2
-      gemfile: gemfiles/rails_head.gemfile
+      gemfile: Gemfile
+    - rvm: ree
+      gemfile: Gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_3_1.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_3_0.gemfile

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# ActiveAttr 0.8.0 (May 2, 2013) #
+
+* ActiveAttr now supports Rails 4.0.0
+* ActiveAttr now supports Ruby 2.0.0
+* HaveAttributeMatcher failure messages now use an expected/got format
+* Removed MassAssignmentSecurity, sanitizer support has been merged into
+  MassAssignment. Include the ActiveModel::MassAssignmentSecurity module or
+  ActiveModel::ForbiddenAttributesProtection depending on your Rails version
+
 # ActiveAttr 0.7.0 (December 15, 2012) #
 
 * Added Serialization

data/Gemfile

@@ -2,12 +2,10 @@ source "https://rubygems.org"
 
 gemspec :development_group => :test
 
-if RUBY_VERSION < "1.9.2"
-  gem "factory_girl", "< 3.0", :group => :test
-  gem "strong_parameters", :git => "git://github.com/rails/strong_parameters.git", :group => :test
-else
-  gem "strong_parameters"
-end
+gem "activemodel",   ">= 4.0.0.rc1"
+gem "activesupport", ">= 4.0.0.rc1"
+gem "actionpack",    ">= 4.0.0.rc1", :group => :test
+gem "protected_attributes", :group => :test
 
 group :development do
   gem "debugger",  :platforms => :mri_19

data/README.md

@@ -18,12 +18,13 @@ ActiveAttr is distributed as a rubygem [on rubygems.org][rubygems].
 * [Contributors][contributors]
 
 [api]: http://rubydoc.info/gems/active_attr
-[codeclimate badge]: https://codeclimate.com/badge.png
+[codeclimate badge]: https://codeclimate.com/github/cgriego/active_attr.png
 [codeclimate]: https://codeclimate.com/github/cgriego/active_attr
 [contributors]: https://github.com/cgriego/active_attr/contributors
 [railscast poster]: http://railscasts.com/static/episodes/stills/326-activeattr.png
 [railscast]: http://railscasts.com/episodes/326-activeattr
 [rubygems]: http://rubygems.org/gems/active_attr
+[protected_attributes]: https://github.com/rails/protected_attributes
 [strong_parameters]: https://github.com/rails/strong_parameters
 [speakerdeck slide]: https://speakerd.s3.amazonaws.com/presentations/4f31f1dec583b4001f008ec3/thumb_slide_0.jpg
 [speakerdeck]: https://speakerdeck.com/u/cgriego/p/models-models-every-where
@@ -165,14 +166,30 @@ are silently ignored.
     person.first_name #=> "Chris"
     person.last_name #=> "Griego"
 
-#### MassAssignmentSecurity ####
+MassAssignment supports mass assignment security/sanitization if a sanitizer
+is included in the model. If using Rails 4.0, include ActiveModel's forbidden
+attributes protection module to get support for strong parameters.
 
-Including the MassAssignmentSecurity module into your class extends the
-MassAssignment methods to honor any declared mass assignment permission
-blacklists or whitelists including support for mass assignment roles.
+    class Person
+      include ActiveAttr::MassAssignment
+      include ActiveModel::ForbiddenAttributesProtection
+      attr_accessor :first_name, :last_name
+    end
+
+    person = Person.new(ActionController::Parameters.new({
+      :first_name => "Chris",
+      :last_name => "Griego",
+    }).permit(:first_name))
+    person.first_name #=> "Chris"
+    person.last_name #=> nil
+
+If using Rails 3.x or the [Protected Attributes gem][protected_attributes],
+include ActiveModel's mass assignment security module to get support for
+protected attributes, including support for mass assignment roles.
 
     class Person
-      include ActiveAttr::MassAssignmentSecurity
+      include ActiveAttr::MassAssignment
+      include ActiveModel::MassAssignmentSecurity
       attr_accessor :first_name, :last_name
       attr_protected :last_name
     end
@@ -181,12 +198,13 @@ blacklists or whitelists including support for mass assignment roles.
     person.first_name #=> "Chris"
     person.last_name #=> nil
 
-If you prefer the [Strong Paramters][strong_parameters] approach,
-include the ActiveModel::ForbiddenAttributesProtection module after
-including the MassAssignmentSecurity model.
+If using the [Strong Paramters gem][strong_parameters] with Rails 3.2,
+include the forbidden attributes protection module after including
+the mass assignment security module.
 
     class Person
-      include ActiveAttr::MassAssignmentSecurity
+      include ActiveAttr::MassAssignment
+      include ActiveModel::MassAssignmentSecurity
       include ActiveModel::ForbiddenAttributesProtection
     end
 
@@ -196,7 +214,7 @@ The Serialization module is a shortcut for incorporating ActiveModel's
 serialization functionality into your model with one include.
 
     class Person
-      include ActiveAttr::Model
+      include ActiveAttr::Serialization
     end
 
 ### Model ###

data/active_attr.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "activesupport", ">= 3.0.2", "< 4.1"
 
   gem.add_development_dependency "bundler",      "~> 1.0"
-  gem.add_development_dependency "factory_girl", ">= 2.2", "< 4.0"
-  gem.add_development_dependency "rake",         "~> 0.9.0"
-  gem.add_development_dependency "rspec",        "~> 2.6"
+  gem.add_development_dependency "factory_girl", ">= 2.2", "< 5.0"
+  gem.add_development_dependency "rake",         ">= 0.9.0", "< 10.1"
+  gem.add_development_dependency "rspec",        "~> 2.11"
   gem.add_development_dependency "tzinfo",       "~> 0.3.29"
 end

data/gemfiles/rails_3_2.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec :development_group => :test, :path => ".."
+
+if RUBY_VERSION < "1.9.2"
+  gem "factory_girl", "< 3.0", :group => :test
+end
+
+gem "activemodel",   "~> 3.2.0"
+gem "activesupport", "~> 3.2.0"
+gem "strong_parameters", ">= 0.2.0", :group => :test

data/gemfiles/rails_head.gemfile

@@ -5,4 +5,7 @@ gemspec :development_group => :test, :path => ".."
 git "git://github.com/rails/rails.git" do
   gem "activemodel"
   gem "activesupport"
+  gem "actionpack", :group => :test
 end
+
+gem "protected_attributes", :git => "git://github.com/rails/protected_attributes.git", :group => :test

data/lib/active_attr.rb

@@ -18,7 +18,6 @@ module ActiveAttr
   autoload :Error
   autoload :Logger
   autoload :MassAssignment
-  autoload :MassAssignmentSecurity
   autoload :Model
   autoload :QueryAttributes
   autoload :Serialization

data/lib/active_attr/mass_assignment.rb

@@ -26,13 +26,20 @@ module ActiveAttr
     #
     # @param [Hash{#to_s => Object}, #each] attributes Attributes used to
     #   populate the model
+    # @param [Hash, #[]] options Options that affect mass assignment
+    #
+    # @option options [Symbol] :as (:default) Mass assignment role
+    # @option options [true, false] :without_protection (false) Bypass mass
+    #   assignment security if true
     #
     # @since 0.1.0
     def assign_attributes(new_attributes, options={})
-      new_attributes.each do |name, value|
+      sanitized_new_attributes = sanitize_for_mass_assignment_if_sanitizer new_attributes, options
+
+      sanitized_new_attributes.each do |name, value|
         writer = "#{name}="
         send writer, value if respond_to? writer
-      end if new_attributes
+      end if sanitized_new_attributes
     end
 
     # Mass update a model's attributes
@@ -63,5 +70,26 @@ module ActiveAttr
       assign_attributes attributes, options
       super
     end
+
+    private
+
+    # @since 0.8.0
+    def sanitize_for_mass_assignment_if_sanitizer(new_attributes, options={})
+      if new_attributes && !options[:without_protection] && respond_to?(:sanitize_for_mass_assignment, true)
+        sanitize_for_mass_assignment_with_or_without_role new_attributes, options
+      else
+        new_attributes
+      end
+    end
+
+    # Rails 3.0 and 4.0 do not take a role argument for the sanitizer
+    # @since 0.7.0
+    def sanitize_for_mass_assignment_with_or_without_role(new_attributes, options)
+      if method(:sanitize_for_mass_assignment).arity.abs > 1
+        sanitize_for_mass_assignment new_attributes, options[:as] || :default
+      else
+        sanitize_for_mass_assignment new_attributes
+      end
+    end
   end
 end

data/lib/active_attr/matchers/have_attribute_matcher.rb

@@ -1,3 +1,5 @@
+require "active_attr/attribute_definition"
+
 module ActiveAttr
   module Matchers
     # Specify that a model should have an attribute matching the criteria. See
@@ -30,9 +32,10 @@ module ActiveAttr
       def initialize(attribute_name)
         raise TypeError, "can't convert #{attribute_name.class} into Symbol" unless attribute_name.respond_to? :to_sym
         @attribute_name = attribute_name.to_sym
+        @attribute_options = {}
         @description = "attribute named #{attribute_name}"
         @expected_ancestors = ["ActiveAttr::Attributes"]
-        @attribute_expectations = [lambda { attribute_definition }]
+        @attribute_expectations = [lambda { actual_attribute_definition }]
       end
 
       # Specify that the attribute should have the given type
@@ -48,6 +51,7 @@ module ActiveAttr
       #
       # @since 0.5.0
       def of_type(type)
+        @attribute_options[:type] = type
         @description << " of type #{type}"
         @expected_ancestors << "ActiveAttr::TypecastedAttributes"
         @attribute_expectations << lambda { @model_class._attribute_type(attribute_name) == type }
@@ -69,9 +73,10 @@ module ActiveAttr
       #
       # @since 0.5.0
       def with_default_value_of(default_value)
+        @attribute_options[:default] = default_value
         @description << " with a default value of #{default_value.inspect}"
         @expected_ancestors << "ActiveAttr::AttributeDefaults"
-        @attribute_expectations << lambda { attribute_definition[:default] == default_value }
+        @attribute_expectations << lambda { actual_attribute_definition[:default] == default_value }
         self
       end
 
@@ -92,6 +97,9 @@ module ActiveAttr
       def failure_message
         if missing_ancestors.any?
           "expected #{@model_class.name} to include #{missing_ancestors.first}"
+        elsif actual_attribute_definition
+          "expected: #{expected_attribute_definition.inspect}\n" +
+          "     got: #{actual_attribute_definition.inspect}"
         else
           "expected #{@model_class.name} to have #{@description}"
         end
@@ -100,15 +108,20 @@ module ActiveAttr
       # @return [String] Negative failure message
       # @private
       def negative_failure_message
-        "expected #{@model_class.name} to not have #{@description}"
+        "expected not: #{expected_attribute_definition.inspect}\n" +
+        "         got: #{actual_attribute_definition.inspect}"
       end
 
       private
 
-      def attribute_definition
+      def actual_attribute_definition
         @model_class.attributes[attribute_name]
       end
 
+      def expected_attribute_definition
+        AttributeDefinition.new @attribute_name, @attribute_options
+      end
+
       def missing_ancestors
         model_ancestor_names = @model_class.ancestors.map(&:name)
 

data/lib/active_attr/model.rb

@@ -2,7 +2,7 @@ require "active_attr/attribute_defaults"
 require "active_attr/basic_model"
 require "active_attr/block_initialization"
 require "active_attr/logger"
-require "active_attr/mass_assignment_security"
+require "active_attr/mass_assignment"
 require "active_attr/query_attributes"
 require "active_attr/serialization"
 require "active_attr/typecasted_attributes"
@@ -25,7 +25,7 @@ module ActiveAttr
     include BasicModel
     include BlockInitialization
     include Logger
-    include MassAssignmentSecurity
+    include MassAssignment
     include AttributeDefaults
     include QueryAttributes
     include TypecastedAttributes

data/lib/active_attr/typecasting/big_decimal_typecaster.rb

@@ -27,6 +27,8 @@ module ActiveAttr
       def call(value)
         if value.is_a? BigDecimal
           value
+        elsif value.is_a? Rational
+          value.to_f.to_d
         elsif value.respond_to? :to_d
           value.to_d
         else

data/lib/active_attr/typecasting/date_typecaster.rb

@@ -24,7 +24,7 @@ module ActiveAttr
       # @since 0.5.0
       def call(value)
         value.to_date if value.respond_to? :to_date
-      rescue NoMethodError
+      rescue NoMethodError, ArgumentError
       end
     end
   end

data/lib/active_attr/version.rb

@@ -1,5 +1,5 @@
 module ActiveAttr
   # Complete version string
   # @since 0.1.0
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/functional/active_attr/attribute_defaults_spec.rb

@@ -6,7 +6,7 @@ require "active_model"
 
 module ActiveAttr
   describe AttributeDefaults do
-    subject { model_class.new }
+    subject(:model) { model_class.new }
 
     let :model_class do
       Class.new.tap do |model_class|
@@ -20,20 +20,20 @@ module ActiveAttr
       before { model_class.attribute :first_name, :default => "John" }
 
       it "the attribute getter returns the string by default" do
-        subject.first_name.should == "John"
+        model.first_name.should == "John"
       end
 
       it "#attributes includes the default attributes" do
-        subject.attributes["first_name"].should == "John"
+        model.attributes["first_name"].should == "John"
       end
 
       it "#read_attribute returns the string by default" do
-        subject.read_attribute("first_name").should == "John"
+        model.read_attribute("first_name").should == "John"
       end
 
       it "assigning nil sets nil as the attribute value" do
-        subject.first_name = nil
-        subject.first_name.should be_nil
+        model.first_name = nil
+        model.first_name.should be_nil
       end
 
       it "mutating the default value does not mutate the attribute definition" do
@@ -46,7 +46,7 @@ module ActiveAttr
       before { model_class.attribute :admin, :default => false }
 
       it "the attribute getter returns false by default" do
-        subject.admin.should == false
+        model.admin.should == false
       end
     end
 
@@ -54,7 +54,7 @@ module ActiveAttr
       before { model_class.attribute :remember_me, :default => true }
 
       it "the attribute getter returns true by default" do
-        subject.remember_me.should == true
+        model.remember_me.should == true
       end
     end
 
@@ -62,7 +62,7 @@ module ActiveAttr
       before { model_class.attribute :roles, :default => [] }
 
       it "the attribute getter returns an empty array by default" do
-        subject.roles.should == []
+        model.roles.should == []
       end
     end
 
@@ -70,11 +70,11 @@ module ActiveAttr
       before { model_class.attribute :created_at, :default => lambda { Time.now } }
 
       it "the attribute getter returns a Time instance" do
-        subject.created_at.should be_a_kind_of Time
+        model.created_at.should be_a_kind_of Time
       end
 
       it "the attribute default is only evaulated once per instance" do
-        subject.created_at.should == subject.created_at
+        model.created_at.should == model.created_at
       end
 
       it "the attribute default is different per instance" do
@@ -86,7 +86,7 @@ module ActiveAttr
       before { model_class.attribute :id, :default => lambda { object_id } }
 
       it "the attribute getter returns the default based on the instance" do
-        subject.id.should == subject.object_id
+        model.id.should == model.object_id
       end
     end
 

data/spec/functional/active_attr/attributes_spec.rb

@@ -23,10 +23,10 @@ module ActiveAttr
         end
       end
 
-      subject { model_class.new }
+      subject(:model) { model_class.new }
 
       it "correctly defines methods for the attributes instead of relying on method_missing" do
-        subject.id.should be_nil
+        model.id.should be_nil
       end
     end
 
@@ -95,7 +95,7 @@ module ActiveAttr
     context "serializing a model" do
       let(:first_name) { "Chris" }
 
-      let :instance do
+      let :model do
         model_class.new.tap do |model|
           model.first_name = first_name
         end
@@ -129,34 +129,34 @@ module ActiveAttr
         end
 
         it "includes unassigned, defined attributes" do
-          subject.keys.should include("last_name")
-          subject["last_name"].should be_nil
+          serialized_model.keys.should include("last_name")
+          serialized_model["last_name"].should be_nil
         end
       end
 
       describe "#as_json" do
-        subject { instance.as_json["person"] }
+        subject(:serialized_model) { model.as_json["person"] }
         include_examples "serialization method"
       end
 
       describe "#serializable_hash" do
-        subject { instance.serializable_hash }
+        subject(:serialized_model) { model.serializable_hash }
         include_examples "serialization method"
       end
 
       describe "#to_json" do
-        subject { ActiveSupport::JSON.decode(instance.to_json)["person"] }
+        subject(:serialized_model) { ActiveSupport::JSON.decode(model.to_json)["person"] }
         include_examples "serialization method"
       end
 
       describe "#to_xml" do
-        subject { Hash.from_xml(instance.to_xml)["person"] }
+        subject(:serialized_model) { Hash.from_trusted_xml(model.to_xml)["person"] }
         include_examples "serialization method"
       end
     end
 
     context "building with FactoryGirl" do
-      subject { FactoryGirl.build(:person) }
+      subject(:model) { FactoryGirl.build(:person) }
 
       before do
         Object.const_set("Person", model_class)
@@ -187,8 +187,8 @@ module ActiveAttr
       end
 
       it "sets the attributes" do
-        subject.first_name.should eq "Chris"
-        subject.last_name.should == "Griego"
+        model.first_name.should eq "Chris"
+        model.last_name.should == "Griego"
       end
     end