active_attr 0.5.0.alpha2 → 0.5.0

data/.rvmrc

@@ -6,10 +6,25 @@
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
 environment_id="ruby-1.9.2-p290@active_attr"
 
+#
+# Uncomment the following lines if you want to verify rvm version per project
+#
+# rvmrc_rvm_version="1.10.1" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+#
+
 #
 # Uncomment following line if you want options to be set only for given project.
 #
 # PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
 
 #
 # First we attempt to load the desired environment directly from the environment
@@ -31,7 +46,7 @@ else
   if ! rvm --create use  "$environment_id"
   then
     echo "Failed to create RVM environment '${environment_id}'."
-    exit 1
+    return 1
   fi
 fi
 
@@ -47,9 +62,20 @@ fi
 # fi
 
 # If you use bundler, this might be useful to you:
-# if command -v bundle && [[ -s Gemfile ]]
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
 # then
-#   bundle
+#   bundle install
 # fi
 
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi
 

data/.travis.yml

@@ -1,3 +1,4 @@
+language: ruby
 rvm:
   - ree
   - 1.9.2

data/CHANGELOG.md

@@ -1,12 +1,25 @@
-# ActiveAttr 0.5.0 (unreleased) #
+# ActiveAttr 0.5.0 (March 11, 2012) #
 
+* ActiveAttr is now Ruby warning free
 * Added AttributeDefaults
 * Added AttributeDefinition#[]
 * Added Attributes.attribute_names
+* Added Matchers::HaveAttributeMatcher#of_type
 * Added Matchers::HaveAttributeMatcher#with_default_value_of
 * Added TypecastedAttributes
 * Added Typecasting
+* Added Typecasting::BigDecimalTypecaster
+* Added Typecasting::Boolean
+* Added Typecasting::BooleanTypecaster
+* Added Typecasting::DateTimeTypecaster
+* Added Typecasting::DateTypecaster
+* Added Typecasting::FloatTypecaster
+* Added Typecasting::IntegerTypecaster
+* Added Typecasting::ObjectTypecaster
+* Added Typecasting::StringTypecaster
 * Changed Attributes.attributes return value from an Array to a Hash
+* Changed HaveAttributeMatcher to return spec failures when the model is
+  missing ActiveAttr modules
 * Changed redefining an attribute to actually redefine the attribute
 * Removed StrictMassAssignment, instead use MassAssignmentSecurity with
   ActiveModel v3.2 which allows assigning mass_assignment_sanitizer to

data/Gemfile

@@ -9,9 +9,10 @@ group :development do
   gem "guard-rspec"
   gem "rb-fsevent"
   gem "rdiscount"
-  gem "rdoc", "~> 3.9.4"
+  gem "rdoc"
   gem "ruby-debug",    :platforms => :mri_18
   gem "ruby-debug19",  :platforms => :mri_19 if RUBY_VERSION < "1.9.3"
   gem "spec_coverage", :platforms => :mri_19
+  gem "travis-lint"
   gem "yard"
 end

data/README.md

@@ -1,6 +1,6 @@
 # ActiveAttr #
 
-[![Build History][2]][1]
+[![Build History][2]][1] [![Dependency Status][5]][4]
 
 ActiveAttr is a set of modules that makes it easy to create plain old ruby
 models with functionality found in ORMs, like ActiveRecord, without
@@ -14,19 +14,11 @@ ActiveAttr is distributed as a rubygem [on rubygems.org][3].
 [1]: http://travis-ci.org/cgriego/active_attr
 [2]: https://secure.travis-ci.org/cgriego/active_attr.png?branch=master
 [3]: http://rubygems.org/gems/active_attr
+[4]: https://gemnasium.com/cgriego/active_attr
+[5]: https://gemnasium.com/cgriego/active_attr.png
 
 ## Modules ##
 
-### Model ###
-
-The Model module is a shortcut for incorporating the most common model
-functionality into your model with one include. All of the following modules
-are included when you include Model.
-
-    class Person
-      include ActiveAttr::Model
-    end
-
 ### Attributes ###
 
 Including the Attributes module into your class gives you a DSL for defining
@@ -79,7 +71,8 @@ providing instance methods for querying your attributes.
 
 #### TypecastedAttributes ####
 
-TODO documentation
+Including the TypecastedAttributes module into your class builds on Attributes
+by providing type conversion for your attributes.
 
     class Person
       include ActiveAttr::TypecastedAttributes
@@ -166,7 +159,7 @@ MassAssignment methods to honor any declared mass assignment permission
 blacklists or whitelists including support for mass assignment roles.
 
     class Person
-      include ActiveAttr::MassAssignment
+      include ActiveAttr::MassAssignmentSecurity
       attr_accessor :first_name, :last_name
       attr_protected :last_name
     end
@@ -175,6 +168,16 @@ blacklists or whitelists including support for mass assignment roles.
     person.first_name #=> "Chris"
     person.last_name #=> nil
 
+### Model ###
+
+The Model module is a shortcut for incorporating the most common model
+functionality into your model with one include. All of the above modules
+are included when you include Model.
+
+    class Person
+      include ActiveAttr::Model
+    end
+
 ## Integrations ##
 
 ### Ruby on Rails ###
@@ -193,5 +196,9 @@ your models. The matchers also work with compatible frameworks like Shoulda.
     require "active_attr/rspec"
 
     describe Person do
-      it { should have_attribute(:first_name).with_default_value_of("John") }
+      it do
+        should have_attribute(:first_name).
+          of_type(String).
+          with_default_value_of("John")
+      end
     end

data/lib/active_attr/chainable_initialization.rb

@@ -4,8 +4,8 @@ module ActiveAttr
   # Many ActiveAttr modules enhance the behavior of the \#initialize method,
   # and in doing so, these methods need to accept arguments. However, Ruby's
   # Object and BasicObject classes, in most versions of Ruby, do not allow any
-  # arguments to be passed in. This module halts the propgation of
-  # initialization arguments before invoking the Object classes'
+  # arguments to be passed in. This module halts the propagation of
+  # initialization arguments before invoking the Object class'
   # initialization.
   #
   # In order to still allow a subclass mixing in this module (directly or

data/lib/active_attr/matchers/have_attribute_matcher.rb

@@ -25,34 +25,24 @@ module ActiveAttr
       attr_reader :attribute_name, :default_value
       private :attribute_name, :default_value
 
-      # Specify that the attribute should have the given default value
-      #
-      # @example Person's first name should default to John
-      #   describe Person do
-      #     it do
-      #       should have_attribute(:first_name).with_default_value_of("John")
-      #     end
-      #   end
-      #
-      # @param [Object]
-      #
-      # @since 0.5.0
-      def with_default_value_of(default_value)
-        @default_value_set = true
-        @default_value = default_value
-        self
-      end
-
       # @return [String] Description
       # @private
       def description
-        "have attribute named #{attribute_name}#{ " with a default value of #{default_value.inspect}" if @default_value_set}"
+        "has #{attribute_description}"
       end
 
       # @return [String] Failure message
       # @private
       def failure_message
-        "Expected #{@model_class} to #{description}"
+        if !includes_attributes?
+          "expected #{@model_class.name} to include ActiveAttr::Attributes"
+        elsif !includes_defaults?
+          "expected #{@model_class.name} to include ActiveAttr::AttributeDefaults"
+        elsif !includes_typecasting?
+          "expected #{@model_class.name} to include ActiveAttr::TypecastedAttributes"
+        else
+          "expected #{@model_class.name} to have #{attribute_description}"
+        end
       end
 
       # @param [Symbol, String, #to_sym] attribute_name
@@ -61,27 +51,99 @@ module ActiveAttr
         raise TypeError, "can't convert #{attribute_name.class} into Symbol" unless attribute_name.respond_to? :to_sym
         @attribute_name = attribute_name.to_sym
         @default_value_set = false
+        @type = nil
+      end
+
+      # Specify that the attribute should have the given type
+      #
+      # @example Person's first name should be a String
+      #   describe Person do
+      #     it { should have_attribute(:first_name).of_type(String) }
+      #   end
+      #
+      # @param [Class] type The expected type
+      #
+      # @return [HaveAttributeMatcher] The matcher
+      #
+      # @since 0.5.0
+      def of_type(type)
+        @type = type
+        self
       end
 
       # @private
       def matches?(model_or_model_class)
         @model_class = class_from(model_or_model_class)
+
+        return false if !includes_attributes? || !includes_defaults? || !includes_typecasting?
+
         @attribute_definition = @model_class.attributes[attribute_name]
 
-        !!(@attribute_definition && (!@default_value_set || @attribute_definition[:default] == default_value))
+        !!(@attribute_definition && default_matches? && type_matches?)
       end
 
       # @return [String] Negative failure message
       # @private
       def negative_failure_message
-        "Expected #{@model_class} to not #{description}"
+        "expected #{@model_class.name} to not have #{attribute_description}"
+      end
+
+      # Specify that the attribute should have the given default value
+      #
+      # @example Person's first name should default to John
+      #   describe Person do
+      #     it do
+      #       should have_attribute(:first_name).with_default_value_of("John")
+      #     end
+      #   end
+      #
+      # @param [Object] default_value The expected default value
+      #
+      # @return [HaveAttributeMatcher] The matcher
+      #
+      # @since 0.5.0
+      def with_default_value_of(default_value)
+        @default_value_set = true
+        @default_value = default_value
+        self
       end
 
       private
 
+      def attribute_description
+        "attribute named #{attribute_name}".tap do |result|
+          result << " of type #{@type}" if @type
+          result << " with a default value of #{default_value.inspect}" if @default_value_set
+        end
+      end
+
+      def includes_attributes?
+        model_ancestor_names.include?("ActiveAttr::Attributes")
+      end
+
+      def includes_defaults?
+        !@default_value_set || model_ancestor_names.include?("ActiveAttr::AttributeDefaults")
+      end
+
+      def includes_typecasting?
+        !@type || model_ancestor_names.include?("ActiveAttr::TypecastedAttributes")
+      end
+
+      def model_ancestor_names
+        @model_class.ancestors.map(&:name)
+      end
+
       def class_from(object)
         Class === object ? object : object.class
       end
+
+      def default_matches?
+        !@default_value_set || @attribute_definition[:default] == default_value
+      end
+
+      def type_matches?
+        !@type || @model_class._attribute_type(attribute_name) == @type
+      end
     end
   end
 end

data/lib/active_attr/model.rb

@@ -4,6 +4,7 @@ require "active_attr/block_initialization"
 require "active_attr/logger"
 require "active_attr/mass_assignment_security"
 require "active_attr/query_attributes"
+require "active_attr/typecasted_attributes"
 require "active_model"
 require "active_support/concern"
 
@@ -27,6 +28,7 @@ module ActiveAttr
     include MassAssignmentSecurity
     include AttributeDefaults
     include QueryAttributes
+    include TypecastedAttributes
 
     if defined? ActiveModel::Serializable
       include ActiveModel::Serializable::JSON

data/lib/active_attr/query_attributes.rb

@@ -29,8 +29,7 @@ module ActiveAttr
 
     # Test the presence of an attribute
     #
-    # Similar to an ActiveRecord model, when the attribute is a zero value or
-    # is a string that represents false, the method returns false.
+    # See {Typecasting::BooleanTypecaster#call} for more details.
     #
     # @example Query an attribute
     #   person.query_attribute(:name)

data/lib/active_attr/typecasted_attributes.rb

@@ -3,20 +3,26 @@ require "active_attr/typecasting"
 require "active_support/concern"
 
 module ActiveAttr
-  # TypecastedAttributes enhances attribute handling with typecasting
+  # TypecastedAttributes allows types to be declared for your attributes
+  #
+  # Types are declared by passing the :type option to the attribute class
+  # method. After a type is declared, attribute readers will convert any
+  # assigned attribute value to the declared type. If the assigned value
+  # cannot be cast, nil will be returned instead. You can access the original
+  # assigned value using the before_type_cast methods.
+  #
+  # See {Typecasting} for the currently supported types.
   #
   # @example Usage
   #   class Person
   #     include ActiveAttr::TypecastedAttributes
-  #     attribute :name
   #     attribute :age, :type => Integer
   #   end
   #
   #   person = Person.new
-  #   person.name = "Ben Poweski"
-  #   person.age  = "29"
-  #
+  #   person.age = "29"
   #   person.age #=> 29
+  #   person.age_before_type_cast #=> "29"
   #
   # @since 0.5.0
   module TypecastedAttributes
@@ -28,7 +34,17 @@ module ActiveAttr
       attribute_method_suffix "_before_type_cast"
     end
 
-    # TODO Documentation
+    # Read the raw attribute value
+    #
+    # @example Reading a raw age value
+    #   person.age = "29"
+    #   person.attribute_before_type_cast(:age) #=> "29"
+    #
+    # @param [String, Symbol, #to_s] name Attribute name
+    #
+    # @return [Object, nil] The attribute value before typecasting
+    #
+    # @since 0.5.0
     def attribute_before_type_cast(name)
       @attributes[name.to_s]
     end

data/lib/active_attr/typecasting.rb

@@ -1,3 +1,4 @@
+require "active_attr/typecasting/big_decimal_typecaster"
 require "active_attr/typecasting/boolean"
 require "active_attr/typecasting/boolean_typecaster"
 require "active_attr/typecasting/date_time_typecaster"
@@ -11,19 +12,30 @@ require "active_support/concern"
 module ActiveAttr
   # Typecasting provides methods to typecast a value to a different type
   #
+  # The following types are supported for typecasting:
+  # * BigDecimal
+  # * Boolean
+  # * Date
+  # * DateTime
+  # * Float
+  # * Integer
+  # * Object
+  # * String
+  #
   # @since 0.5.0
   module Typecasting
     extend ActiveSupport::Concern
 
     # @private
     TYPECASTERS = {
-      Boolean  => BooleanTypecaster,
-      Date     => DateTypecaster,
-      DateTime => DateTimeTypecaster,
-      Float    => FloatTypecaster,
-      Integer  => IntegerTypecaster,
-      Object   => ObjectTypecaster,
-      String   => StringTypecaster,
+      BigDecimal => BigDecimalTypecaster,
+      Boolean    => BooleanTypecaster,
+      Date       => DateTypecaster,
+      DateTime   => DateTimeTypecaster,
+      Float      => FloatTypecaster,
+      Integer    => IntegerTypecaster,
+      Object     => ObjectTypecaster,
+      String     => StringTypecaster,
     }
 
     # Typecasts a value using a Class