model_attribute 2.0.0 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjY2MDhkZDI2ZjA0YjRjM2NkY2E5MTg0NWYxZmJhY2JmZTEyYWUzYg==
+    ZjQzN2Q4YWFiMzRhYTA1NTI0Y2RkNDNjOGZlZjg4Zjk3ZTU1NzlkMQ==
   data.tar.gz: !binary |-
-    MWRhZjRhOTUzNDQ5MzRhMWU5NTQwOTdkMmJjYmJlMDA1OTJhMzFiMA==
+    ZTc1NmViMDUxNDhiNmIzMGJiYmNiMzE5ZWM2ZDFjMGVmM2EwNjQxNg==
 SHA512:
   metadata.gz: !binary |-
-    ZjZmMjY3NzMzM2EyODAyMDM1MTA2NTgxNGRhOWJhNGNmMGJmZTA4NDVmMzJi
-    NWQ0MzEyYTFlZDNjZmI5N2I5Y2FjMDE3NWE0MDIyMDBlNWJmMzNkNzNmMjBh
-    YTQ2Y2MzMjU2ZGI4MzNhODE5NDJkMjEyMmZmNjU3NDUwYjAzNTI=
+    MzM1MDY3M2Q0ZDE4MWViNjcwNjY4ZjI5OTg1ZjJkYjY5N2JlNWM2MmQyMTUx
+    ODRjZWVmNDI2NzIxODk4MmY0YmQ0MTY3NGM0OTk5OGExMTFjY2UwM2Q0MzQ2
+    MzMyY2FlM2M3ZDk5Zjc3YjUzYTY5NmIwNjQ3NjU1NjYxYjMyMWM=
   data.tar.gz: !binary |-
-    ODg1MWVhYjI3N2ZmNDM0MWY1ZGE1NWVmYWM3YzI4ODdiZTEzMGY0MDQ5YjRh
-    YjA3MWNmMjlmYTJmNTU4ZjJjNzk2ZmUwOWRjZjhhMGJkYTUzNGZlZDZmZGNh
-    N2VhZGJjYWE1MzgxYjY4ZDQwNWI4YmE5ZGY0OWNjZjk4YmNjMGI=
+    MmE3NmY2MmMyYmU3MmRiNzY5ZGRhNjQ3MzYxMDhlMzdiZjhlZTFiMDVhOTY3
+    MDU0M2Q1OGJjZjRkZGM5YjA3ZGYyY2E0OTBkNDUwMDAxM2Y1NmQ2MTUzOWZi
+    N2VkMmM5MzViMGQ3OWYyODljNTg3Y2E4ZGExZTVhMmQzMzgzODc=

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.1.5"
+  - "2.2.1"

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.1.0
+
+- **New feature**: default values.  Allows you to specify a default value like
+  so:
+```
+class User
+  attribute :name, :string, default: 'Michelle'
+end
+
+User.new.name
+# => 'Michelle'
+```
+
 ## 2.0.0
 
 - **Breaking change**: Rename to `ModelAttribute` (no trailing 's') to avoid name

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
-source 'http://gems.int.yammer.com/'
 
 # Specify your gem's dependencies in model_attribute.gemspec
 gemspec

data/Guardfile

@@ -29,7 +29,7 @@ watch ("Guardfile") do
   exit 0
 end
 
-guard :rspec, cmd: "bundle exec rspec --format=Nc --format=documentation" do
+guard :rspec, cmd: "bundle exec rspec --format=Nc --format=documentation", all_on_start: true do
   require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -1,4 +1,4 @@
-# ModelAttribute
+# ModelAttribute [![Build Status](https://travis-ci.org/yammer/model_attribute.svg?branch=master)](https://travis-ci.org/yammer/model_attribute)
 
 Simple attributes for a non-ActiveRecord model.
 
@@ -6,6 +6,7 @@ Simple attributes for a non-ActiveRecord model.
  - Type casting and checking.
  - Dirty tracking.
  - List attribute names and values.
+ - Default values for attributes
  - Handles integers, booleans, strings and times - a set of types that are very
    easy to persist to and parse from JSON.
  - Supports efficient serialization of attributes to JSON.
@@ -164,6 +165,31 @@ class User
     events += new_event
   end
 end
+
+# Supporting default attributes
+
+class UserWithDefaults
+  extend ModelAttribute
+
+  attribute :name, :string, default: 'Charlie'
+end
+
+UserWithDefaults.attribute_defaults # => {:name=>"Charlie"}
+
+user = UserWithDefaults.new
+user.name # => "Charlie"
+user.read_attribute(:name) # => "Charlie"
+user.attributes # => {:name=>"Charlie"}
+# attributes_for_json omits defaults to keep the JSON compact
+user.attributes_for_json # => {}
+# you can add them back in if you need them
+user.attributes_for_json.merge(user.class.attribute_defaults) # => {:name=>"Charlie"}
+# A default isn't a change
+user.changes # => {}
+user.changes_for_json # => {}
+
+user.name = 'Bob'
+user.attributes # => {:name=>"Bob"}
 ```
 
 ## Installation

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
+task :default => :spec

data/lib/model_attribute.rb

@@ -1,5 +1,5 @@
 require "model_attribute/version"
-require "model_attribute/json"
+require "model_attribute/casts"
 require "model_attribute/errors"
 require "time"
 
@@ -8,17 +8,19 @@ module ModelAttribute
 
   def self.extended(base)
     base.send(:include, InstanceMethods)
-    base.instance_variable_set('@attribute_names', [])
-    base.instance_variable_set('@attribute_types', {})
+    base.instance_variable_set('@attribute_names',    [])
+    base.instance_variable_set('@attribute_types',    {})
+    base.instance_variable_set('@attribute_defaults', {})
   end
 
-  def attribute(name, type)
+  def attribute(name, type, opts = {})
     name = name.to_sym
     type = type.to_sym
     raise UnsupportedTypeError.new(type) unless SUPPORTED_TYPES.include?(type)
 
-    @attribute_names << name
-    @attribute_types[name] = type
+    @attribute_names          << name
+    @attribute_types[name]    = type
+    @attribute_defaults[name] = opts[:default] if opts.key?(:default)
 
     self.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
       def #{name}=(value)
@@ -47,6 +49,10 @@ module ModelAttribute
     @attribute_names
   end
 
+  def attribute_defaults
+    @attribute_defaults
+  end
+
   module InstanceMethods
     def write_attribute(name, value, type = nil)
       name = name.to_sym
@@ -56,7 +62,7 @@ module ModelAttribute
       type ||= self.class.instance_variable_get('@attribute_types')[name]
       raise InvalidAttributeNameError.new(name) unless type
 
-      value = cast(value, type)
+      value = Casts.cast(value, type)
       return if value == read_attribute(name)
 
       if changes.has_key? name
@@ -80,6 +86,8 @@ module ModelAttribute
         instance_variable_get(ivar_name)
       elsif !self.class.attributes.include?(name.to_sym)
         raise InvalidAttributeNameError.new(name)
+      else
+        self.class.attribute_defaults[name.to_sym]
       end
     end
 
@@ -106,19 +114,19 @@ module ModelAttribute
     alias_method :eql?, :==
 
     def changes
-      @changes ||= {} #HashWithIndifferentAccess.new
+      @changes ||= {}
     end
 
     # Attributes suitable for serializing to a JSON string.
     #
     #  - Attribute keys are strings (for 'strict' JSON dumping).
-    #  - Attributes with a nil value are omitted to speed serialization.
+    #  - Attributes with a default or nil value are omitted to speed serialization.
     #  - :time attributes are serialized as an Integer giving the number of
     #    milliseconds since the epoch.
     def attributes_for_json
       self.class.attributes.each_with_object({}) do |name, attributes|
         value = read_attribute(name)
-        unless value.nil?
+        if value != self.class.attribute_defaults[name.to_sym]
           value = (value.to_f * 1000).to_i if value.is_a? Time
           attributes[name.to_s] = value
         end
@@ -151,52 +159,5 @@ module ModelAttribute
       end.join(', ')
       "#<#{self.class} #{attribute_string}>"
     end
-
-    def cast(value, type)
-      return nil if value.nil?
-
-      case type
-      when :integer
-        int = Integer(value)
-        float = Float(value)
-        raise "Can't cast #{value.inspect} to an integer without loss of precision" unless int == float
-        int
-      when :boolean
-        if !!value == value
-          value
-        elsif value == 't'
-          true
-        elsif value == 'f'
-          false
-        else
-          raise "Can't cast #{value.inspect} to boolean"
-        end
-      when :time
-        case value
-        when Time
-          value
-        when Date, DateTime
-          value.to_time
-        when Integer
-          # Assume milliseconds since epoch.
-          Time.at(value / 1000.0)
-        when Numeric
-          # Numeric, but not an integer. Assume seconds since epoch.
-          Time.at(value)
-        else
-          Time.parse(value)
-        end
-      when :string
-        String(value)
-      when :json
-        if Json.valid?(value)
-          value
-        else
-          raise "JSON only supports nil, numeric, string, boolean and arrays and hashes of those."
-        end
-      else
-        raise UnsupportedTypeError.new(type)
-      end
-    end
   end
 end

data/lib/model_attribute/casts.rb

@@ -0,0 +1,74 @@
+module ModelAttribute
+  module Casts
+    class << self
+      def cast(value, type)
+        return nil if value.nil?
+
+        case type
+        when :integer
+          int = Integer(value)
+          float = Float(value)
+          raise "Can't cast #{value.inspect} to an integer without loss of precision" unless int == float
+          int
+        when :boolean
+          if !!value == value
+            value
+          elsif value == 't'
+            true
+          elsif value == 'f'
+            false
+          else
+            raise "Can't cast #{value.inspect} to boolean"
+          end
+        when :time
+          case value
+          when Time
+            value
+          when Date, DateTime
+            value.to_time
+          when Integer
+            # Assume milliseconds since epoch.
+            Time.at(value / 1000.0)
+          when Numeric
+            # Numeric, but not an integer. Assume seconds since epoch.
+            Time.at(value)
+          else
+            Time.parse(value)
+          end
+        when :string
+          String(value)
+        when :json
+          if valid_json?(value)
+            value
+          else
+            raise "JSON only supports nil, numeric, string, boolean and arrays and hashes of those."
+          end
+        else
+          raise UnsupportedTypeError.new(type)
+        end
+      end
+
+      private
+
+      def valid_json?(value)
+        (value == nil         ||
+         value == true        ||
+         value == false       ||
+         value.is_a?(Numeric) ||
+         value.is_a?(String)  ||
+         (value.is_a?(Array) && valid_json_array?(value)) ||
+         (value.is_a?(Hash)  && valid_json_hash?(value) ))
+      end
+
+      def valid_json_array?(array)
+        array.all? { |value| valid_json?(value) }
+      end
+
+      def valid_json_hash?(hash)
+        hash.all? do |key, value|
+          key.is_a?(String) && valid_json?(value)
+        end
+      end
+    end
+  end
+end

data/lib/model_attribute/version.rb

@@ -1,3 +1,3 @@
 module ModelAttribute
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/model_attribute.gemspec

@@ -9,6 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["David Waller"]
   spec.email         = ["dwaller@yammer-inc.com"]
   spec.summary       = %q{Attributes for non-ActiveRecord models}
+  spec.description   = <<-EOF
+    Attributes for non-ActiveRecord models.
+    Smaller and simpler than Virtus, and adds dirty tracking.
+  EOF
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -23,5 +27,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-nc",        "~> 0.2"
   spec.add_development_dependency "guard",           "~> 2.8"
   spec.add_development_dependency "guard-rspec",     "~> 4.3"
-  spec.add_development_dependency "pry-debugger"
 end

data/spec/model_attributes_spec.rb

@@ -1,10 +1,11 @@
 class User
   extend ModelAttribute
-  attribute :id,         :integer
-  attribute :paid,       :boolean
-  attribute :name,       :string
-  attribute :created_at, :time
-  attribute :profile,    :json
+  attribute :id,            :integer
+  attribute :paid,          :boolean
+  attribute :name,          :string
+  attribute :created_at,    :time
+  attribute :profile,       :json
+  attribute :reward_points, :integer, default: 0
 
   def initialize(attributes = {})
     set_attributes(attributes)
@@ -23,19 +24,29 @@ class UserWithoutId
 end
 
 RSpec.describe "a class using ModelAttribute" do
-  describe ".attributes" do
-    it "returns an array of attribute names as symbols" do
-      expect(User.attributes).to eq([:id, :paid, :name, :created_at, :profile])
+  describe "class methods" do
+    describe ".attribute" do
+      context "passed an unrecognised type" do
+        it "raises an error" do
+          expect do
+            User.attribute :address, :custom_type
+          end.to raise_error(ModelAttribute::UnsupportedTypeError,
+                             "Unsupported type :custom_type. " +
+                             "Must be one of :integer, :boolean, :string, :time, :json.")
+        end
+      end
     end
-  end
 
-  describe "defining an attribute with an invalid type" do
-    it "raises an error" do
-      expect do
-        User.attribute :address, :custom_type
-      end.to raise_error(ModelAttribute::UnsupportedTypeError,
-                         "Unsupported type :custom_type. " +
-                         "Must be one of :integer, :boolean, :string, :time, :json.")
+    describe ".attributes" do
+      it "returns an array of attribute names as symbols" do
+        expect(User.attributes).to eq([:id, :paid, :name, :created_at, :profile, :reward_points])
+      end
+    end
+
+    describe ".attribute_defaults" do
+      it "returns a hash of attributes that have non-nil defaults" do
+        expect(User.attribute_defaults).to eq({reward_points: 0})
+      end
     end
   end
 
@@ -295,6 +306,12 @@ RSpec.describe "a class using ModelAttribute" do
       end
     end
 
+    describe 'a defaulted attribute (reward_points)' do
+      it "returns the default when unset" do
+        expect(user.reward_points).to eq(0)
+      end
+    end
+
     describe "#write_attribute" do
       it "does the same casting as using the writer method" do
         user.write_attribute(:id, '3')
@@ -319,6 +336,12 @@ RSpec.describe "a class using ModelAttribute" do
         expect(user.read_attribute(:id)).to be_nil
       end
 
+      context "for an attribute with a default" do
+        it "returns the default if the attribute has not been set" do
+          expect(user.read_attribute(:reward_points)).to eq(0)
+        end
+      end
+
       it "raises an error if passed an invalid attribute name" do
         expect do
           user.read_attribute(:spelling_mistake)
@@ -330,7 +353,7 @@ RSpec.describe "a class using ModelAttribute" do
     describe "#changes" do
       let(:changes) { user.changes }
 
-      context "for a model instance created with no attributes" do
+      context "for a model instance created with no attributes except defaults" do
         it "is empty" do
           expect(changes).to be_empty
         end
@@ -408,7 +431,7 @@ RSpec.describe "a class using ModelAttribute" do
       end
     end
 
-    describe "id_changed?" do
+    describe "#id_changed?" do
       context "with no changes" do
         it "returns false" do
           expect(user.id_changed?).to eq(false)
@@ -470,8 +493,18 @@ RSpec.describe "a class using ModelAttribute" do
         expect(user.attributes_for_json).to include("profile" => json)
       end
 
-      it "omits attributes with a nil value" do
-        expect(user.attributes_for_json).to_not include("name")
+      it "omits attributes still set to the default value" do
+        expect(user.attributes_for_json).to_not include("name", "reward_points")
+      end
+
+      it "includes an attribute changed from its default value" do
+        user.name = "Fred"
+        expect(user.attributes_for_json).to include("name" => "Fred")
+      end
+
+      it "includes an attribute changed from its default value to nil" do
+        user.reward_points = nil
+        expect(user.attributes_for_json).to include("reward_points" => nil)
       end
     end
 
@@ -531,12 +564,16 @@ RSpec.describe "a class using ModelAttribute" do
         expect(user.inspect).to include('profile: {"interests"=>["coding", "social networks"], "rank"=>15}')
       end
 
+      it "includes defaulted attributes" do
+        expect(user.inspect).to include('reward_points: 0')
+      end
+
       it "includes the class name" do
         expect(user.inspect).to include("User")
       end
 
       it "looks like '#<User id: 1, paid: true, name: ..., created_at: ...>'" do
-        expect(user.inspect).to eq("#<User id: 1, paid: true, name: \"Fred\", created_at: 2014-12-25 08:00:00 +0000, profile: {\"interests\"=>[\"coding\", \"social networks\"], \"rank\"=>15}>")
+        expect(user.inspect).to eq("#<User id: 1, paid: true, name: \"Fred\", created_at: 2014-12-25 08:00:00 +0000, profile: {\"interests\"=>[\"coding\", \"social networks\"], \"rank\"=>15}, reward_points: 0>")
       end
     end
 

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'model_attribute'
-require 'pry-debugger'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_attribute
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - David Waller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,21 +94,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.3'
-- !ruby/object:Gem::Dependency
-  name: pry-debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description: ! "    Attributes for non-ActiveRecord models.\n    Smaller and simpler
+  than Virtus, and adds dirty tracking.\n"
 email:
 - dwaller@yammer-inc.com
 executables: []
@@ -117,6 +104,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -124,8 +112,8 @@ files:
 - README.md
 - Rakefile
 - lib/model_attribute.rb
+- lib/model_attribute/casts.rb
 - lib/model_attribute/errors.rb
-- lib/model_attribute/json.rb
 - lib/model_attribute/version.rb
 - model_attribute.gemspec
 - performance_comparison.rb

data/lib/model_attribute/json.rb

@@ -1,27 +0,0 @@
-module ModelAttribute
-  module Json
-    class << self
-      def valid?(value)
-        (value == nil         ||
-         value == true        ||
-         value == false       ||
-         value.is_a?(Numeric) ||
-         value.is_a?(String)  ||
-         (value.is_a?(Array) && valid_array?(value)) ||
-         (value.is_a?(Hash)  && valid_hash?(value) ))
-      end
-
-      private
-
-      def valid_array?(array)
-        array.all? { |value| valid?(value) }
-      end
-
-      def valid_hash?(hash)
-        hash.all? do |key, value|
-          key.is_a?(String) && valid?(value)
-        end
-      end
-    end
-  end
-end