attributable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c95938ed6c4f51930505e6e11ec6f210bda51e
-  data.tar.gz: 338a2ba7e74b833aad96209d33f1a3ea0ee12ade
+  metadata.gz: 0ae2deaa3e88ed46bd80f2f96e721c71093f06ca
+  data.tar.gz: b0253f219bc607ccb07ac8b9bdedc76a7af16b97
 SHA512:
-  metadata.gz: 2a0a0e877474b561c6870b72baa5f10467a819e7dc80f8a28cdfe36cdb84abaa3e6dae836f698010bc6769bfccaec996e66cb4675538db82989e520d12d98b11
-  data.tar.gz: fb026c2c07406c31dc902af89bad1c81f13a1de92e1d72202a4440e60e8750c657c52af3509c97eeb7871d8a732e56edd77fbffdac37bc486950658d4ae883e8
+  metadata.gz: 133f45dda1e6cf016f88811a8d67813743c58e4b4b2873c2aac7c2fedc562576f47be47faeab67860088081847135e709750559d377c65cae9468154fa663ecd
+  data.tar.gz: 3b954192277be8bb214c55a953d6fac6475f395295b4eb0bea3b152727cd36773d002cb3af36e5d649d9d49f8e6fe7ca9dd209b14f2a81c2e0aed90a5e964285

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Includes:
+    - Gemfile
+    - Rakefile
+  Excludes:
+    - vendor/*
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+LineLength:
+  Max: 99
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -1,5 +1,5 @@
-ruby '2.0.0'
-source 'https://rubygems.org'
+ruby "2.0.0"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in attributable.gemspec
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# Attributable [![Build Status](https://travis-ci.org/louismrose/mutiny.png?branch=master)](https://travis-ci.org/louismrose/mutiny) [![Code Climate](https://codeclimate.com/github/louismrose/mutiny.png)](https://codeclimate.com/github/louismrose/mutiny) [![Dependency Status](https://gemnasium.com/louismrose/mutiny.png)](https://gemnasium.com/louismrose/mutiny) [![Coverage Status](https://coveralls.io/repos/louismrose/mutiny/badge.png?branch=master)](https://coveralls.io/r/louismrose/mutiny?branch=master)
+# Attributable [![Build Status](https://travis-ci.org/mutiny/attributable.png)](https://travis-ci.org/mutiny/attributable) [![Code Climate](https://codeclimate.com/github/mutiny/attributable.png)](https://codeclimate.com/github/mutiny/attributable) [![Dependency Status](https://gemnasium.com/mutiny/attributable.png)](https://gemnasium.com/mutiny/attributable) [![Coverage Status](https://coveralls.io/repos/mutiny/attributable/badge.png?branch=master)](https://coveralls.io/r/mutiny/attributable?branch=master)
 
 A tiny library that makes it easy to create value objects.
 
@@ -72,6 +72,34 @@ Attributable adds an `inspect` method to your class which display attribute valu
 
     john.inspect # => <User forename="John", surname="Doe">
 
+## Using with custom initialisation logic
+
+Attributable provides the `initialize_attributes` method which can be used if you need to specify your own `initialize` method. For example:
+
+    require "attributable"
+
+    class UserWithDerivedAttribute
+      extend Attributable
+      attributes :forename, :surname
+      
+      attr_accessor :fullname
+      
+      def initialize(attributes = {})
+        initialize_attributes(attributes)
+        @fullname = "#{forename} #{surname}"
+      end
+    end
+
+    john = UserWithDerivedAttribute.new(forename: "John", surname: "Doe")
+    john.forename # => "John"
+    john.fullname # => "John Doe"
+
+Note that, by default, Attributable adds the following `initialize` method:
+
+    def initialize(attributes = {})
+      initialize_attributes(attributes)
+    end
+
 ## Specialisation
 
 To allow reuse of attribute declarations, Attributable provides the `specialises` class method.

data/Rakefile

@@ -1,8 +1,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task default: "test:unit"
+task default: ["test:unit", "style:check"]
 
 namespace :test do
   RSpec::Core::RakeTask.new(:unit)
 end
+
+namespace :style do
+  require "rubocop/rake_task"
+
+  desc "Run RuboCop on the lib directory"
+  Rubocop::RakeTask.new(:check) do |task|
+    task.options = ["--auto-correct"]
+  end
+end

data/attributable.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.1.1"
   spec.add_development_dependency "rspec", "~> 2.14.1"
   spec.add_development_dependency "coveralls", "~> 0.7.0"
+  spec.add_development_dependency "rubocop", "~> 0.19.1"
 end

data/lib/attributable/version.rb

@@ -1,3 +1,3 @@
 module Attributable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/attributable.rb

@@ -6,19 +6,20 @@ module Attributable
     @predefined_attributes = @predefined_attributes.merge(from(without_defaults, with_defaults))
     add_instance_methods(@predefined_attributes)
   end
-  
+
   def specialises(clazz)
     unless clazz.kind_of? Attributable
-      raise ArgumentError.new("specialisation requires a class that extends Attributable")
+      fail ArgumentError, "specialisation requires a class that extends Attributable"
     end
-    
+
     super_attributes = clazz.new.instance_variable_get(:@attributes)
     @predefined_attributes ||= {}
     @predefined_attributes = super_attributes.merge(@predefined_attributes)
     add_instance_methods(@predefined_attributes)
   end
 
-private
+  private
+
   # Converts a list of attribute names and a hash of attribute names to default values
   # to a hash of attribute names to default values
   def from(without_defaults, with_defaults)
@@ -27,7 +28,7 @@ private
       with_defaults.each_pair { |name, default| attributes[name] = default }
     end
   end
-  
+
   def add_instance_methods(predefined_attributes)
     add_constructor(predefined_attributes)
     add_accessors(predefined_attributes.keys)
@@ -37,6 +38,10 @@ private
 
   def add_constructor(predefined_attributes)
     define_method "initialize" do |attributes = {}|
+      initialize_attributes(attributes)
+    end
+
+    define_method "initialize_attributes" do |attributes = {}|
       @attributes = predefined_attributes.merge(attributes)
     end
   end
@@ -52,22 +57,22 @@ private
   def add_equality_methods(names)
     define_method "eql?" do |other|
       other.is_a?(self.class) &&
-      names.all? { |name| other.send(name.to_sym) == self.send(name.to_sym) }
+      names.all? { |name| other.send(name.to_sym) == send(name.to_sym) }
     end
-    
+
     alias_method "==", "eql?"
-    
+
     define_method "hash" do
       self.class.hash + @attributes.hash
     end
   end
-  
+
   def add_inspect_method(names)
     define_method "inspect" do
       values = @attributes.keys
-        .map { |name| "#{name.to_s}=#{@attributes[name].inspect}" }
+        .map { |name| "#{name}=#{@attributes[name].inspect}" }
         .join(", ")
-        
+
       "<#{self.class.name} #{values}>"
     end
   end

data/spec/attributable/accessors_spec.rb

@@ -1,17 +1,20 @@
 require "attributable"
 
-class User; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+class User
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
 
 describe Attributable do
   describe "accessors" do
     it "should raise for an unknown attribute" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
+      i = User.new(id: 1, forename: "John", surname: "Doe")
       expect(i.respond_to?(:address)).to be_false
-    end 
-  
+    end
+
     it "should not have setters" do
-      i = User.new(forename: 'John')
-    
+      i = User.new(forename: "John")
+
       expect(i.respond_to?(:id=)).to be_false
     end
   end

data/spec/attributable/construction_spec.rb

@@ -1,31 +1,56 @@
 require "attributable"
 
-class User; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+class User
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
+
+class UserWithDerivedAttribute
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+  attr_reader :fullname
+
+  def initialize(attributes = {})
+    initialize_attributes(attributes)
+    @fullname = "#{forename} #{surname}"
+  end
+end
 
 describe Attributable do
   describe "construction" do
     it "should accept a hash" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+
       expect(i.id).to eq(1)
-      expect(i.forename).to eq('John')
-      expect(i.surname).to eq('Doe')
+      expect(i.forename).to eq("John")
+      expect(i.surname).to eq("Doe")
     end
 
     it "should set missing attributes to default" do
-      i = User.new(forename: 'John')
-      
+      i = User.new(forename: "John")
+
       expect(i.id).to be_nil
-      expect(i.forename).to eq('John')
-      expect(i.surname).to eq('Bloggs')
+      expect(i.forename).to eq("John")
+      expect(i.surname).to eq("Bloggs")
     end
-  
+
     it "should set missing attributes without defaults to nil" do
-      i = User.new(surname: 'Doe')
-      
+      i = User.new(surname: "Doe")
+
       expect(i.id).to be_nil
       expect(i.forename).to be_nil
-      expect(i.surname).to eq('Doe')
+      expect(i.surname).to eq("Doe")
+    end
+  end
+
+  describe "constructor" do
+    it "should be overridable" do
+      i = UserWithDerivedAttribute.new(id: 1, forename: "John", surname: "Doe")
+
+      expect(i.id).to eq(1)
+      expect(i.forename).to eq("John")
+      expect(i.surname).to eq("Doe")
+      expect(i.fullname).to eq("John Doe")
     end
   end
 end

data/spec/attributable/equality_spec.rb

@@ -1,36 +1,43 @@
 require "attributable"
 
-class User;    extend Attributable; attributes :id, :forename, surname: "Bloggs" end
-class Patient; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+class User
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
+
+class Patient
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
 
 describe Attributable do
   describe "equality" do
     it "should provide a working eql? method" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      j = User.new(id: 1, forename: 'John', surname: 'Doe')
-    
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+      j = User.new(id: 1, forename: "John", surname: "Doe")
+
       expect(i).to eql(j)
     end
-    
+
     it "should provide a working == method" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      j = User.new(id: 1, forename: 'John', surname: 'Doe')
-    
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+      j = User.new(id: 1, forename: "John", surname: "Doe")
+
       expect(i).to be == j
     end
-    
+
     it "should distinguish between objects with different attribute values" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      j = User.new(id: 1, forename: 'Jane', surname: 'Doe')
-    
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+      j = User.new(id: 1, forename: "Jane", surname: "Doe")
+
       expect(i).not_to eql(j)
       expect(i).not_to be == j
     end
-    
+
     it "should distinguish between objects with different types and same attribute values" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      j = Patient.new(id: 1, forename: 'John', surname: 'Doe')
-    
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+      j = Patient.new(id: 1, forename: "John", surname: "Doe")
+
       expect(i).not_to eql(j)
       expect(i).not_to be == j
     end

data/spec/attributable/hash_spec.rb

@@ -1,32 +1,39 @@
 require "attributable"
 
-class User;    extend Attributable; attributes :id, :forename, surname: "Bloggs" end
-class Patient; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+class User
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
+
+class Patient
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
 
 describe Attributable do
   describe "hash" do
     it "should ensure that objects with the same attribute values have the same hash" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      j = User.new(id: 1, forename: 'John', surname: 'Doe')
-      
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+      j = User.new(id: 1, forename: "John", surname: "Doe")
+
       expect(i.hash).to eq(j.hash)
     end
-    
+
     it "should ensure that objects with different attribute values have different hashes" do
-      a = User.new(id: 1, forename: 'John', surname: 'Doe')
-      b = User.new(id: nil, forename: 'John', surname: 'Doe')
-      c = User.new(id: 1, forename: nil, surname: 'Doe')
-      d = User.new(id: 1, forename: 'John', surname: nil)
-      
-      hashes = [a,b,c,d].map { |user| user.hash }
-      
+      a = User.new(id: 1, forename: "John", surname: "Doe")
+      b = User.new(id: nil, forename: "John", surname: "Doe")
+      c = User.new(id: 1, forename: nil, surname: "Doe")
+      d = User.new(id: 1, forename: "John", surname: nil)
+
+      hashes = [a, b, c, d].map { |user| user.hash }
+
       expect(hashes.uniq).to eq(hashes)
     end
-    
+
     it "should ensure that objects of different types different hashes" do
-      u = User.new(id: 1, forename: 'John', surname: 'Doe')
-      p = Patient.new(id: 1, forename: 'John', surname: 'Doe')
-      
+      u = User.new(id: 1, forename: "John", surname: "Doe")
+      p = Patient.new(id: 1, forename: "John", surname: "Doe")
+
       expect(u.hash).not_to eq(p.hash)
     end
   end

data/spec/attributable/inspect_spec.rb

@@ -1,12 +1,15 @@
 require "attributable"
 
-class User; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+class User
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
 
 describe Attributable do
   describe "inspect" do
     it "should emit type and attribute values" do
-      i = User.new(id: 1, forename: 'John', surname: 'Doe')
-      
+      i = User.new(id: 1, forename: "John", surname: "Doe")
+
       expect(i.inspect).to eq("<User id=1, forename=\"John\", surname=\"Doe\">")
     end
   end

data/spec/attributable/specialisation_spec.rb

@@ -1,6 +1,9 @@
 require "attributable"
 
-class User; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+class User
+  extend Attributable
+  attributes :id, :forename, surname: "Bloggs"
+end
 
 describe Attributable do
   describe "specialisation" do
@@ -11,16 +14,16 @@ describe Attributable do
         attributes :password, active: true
         specialises User
       end
-      
-      s = SuperUser.new(id: 1, forename: 'Bob', password: 'secret', active: false)
-      
+
+      s = SuperUser.new(id: 1, forename: "Bob", password: "secret", active: false)
+
       expect(s.id).to eq(1)
-      expect(s.forename).to eq('Bob')
-      expect(s.surname).to eq('Bloggs')
-      expect(s.password).to eq('secret')
+      expect(s.forename).to eq("Bob")
+      expect(s.surname).to eq("Bloggs")
+      expect(s.password).to eq("secret")
       expect(s.active).to be_false
     end
-    
+
     it "should be possible to declare specialisation before attributes" do
       class SuperUser2
         extend Attributable
@@ -28,49 +31,52 @@ describe Attributable do
         specialises User
         attributes :password, active: true
       end
-      
-      s = SuperUser2.new(id: 1, forename: 'Bob', password: 'secret', active: false)
-      
+
+      s = SuperUser2.new(id: 1, forename: "Bob", password: "secret", active: false)
+
       expect(s.id).to eq(1)
-      expect(s.forename).to eq('Bob')
-      expect(s.surname).to eq('Bloggs')
-      expect(s.password).to eq('secret')
+      expect(s.forename).to eq("Bob")
+      expect(s.surname).to eq("Bloggs")
+      expect(s.password).to eq("secret")
       expect(s.active).to be_false
     end
-    
-    it "should ensure that local attributes have greater precedence than specialised attributes" do
+
+    it "should ensure that local attributes precede specialised attributes" do
       class SuperUser3
         extend Attributable
 
         specialises User
-        attributes surname: 'Smith'
+        attributes surname: "Smith"
       end
-      
+
       s = SuperUser3.new
-      
-      expect(s.surname).to eq('Smith')
+
+      expect(s.surname).to eq("Smith")
     end
-    
-    it "should ensure that local attributes have greater precedence than specialised attributes, even if specialisation is declared after local attributes" do
+
+    it "should ensure that position of specialises does not affect precedence" do
       class SuperUser4
         extend Attributable
 
-        attributes surname: 'Smith'
+        attributes surname: "Smith"
         specialises User
       end
-      
+
       s = SuperUser4.new
-      
-      expect(s.surname).to eq('Smith')
+
+      expect(s.surname).to eq("Smith")
     end
-    
+
     it "should raise if specialising class is not an instance of Attributable" do
       expect do
         class SuperUser5
           extend Attributable
           specialises String
         end
-      end.to raise_error(ArgumentError, "specialisation requires a class that extends Attributable")
+      end.to raise_error(
+        ArgumentError,
+        "specialisation requires a class that extends Attributable"
+      )
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'coveralls'
+require "coveralls"
 Coveralls.wear!
 
 # This file was generated by the `rspec --init` command. Conventionally, all
@@ -16,12 +16,12 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
-  
+  config.order = "random"
+
   config.expect_with :rspec do |c|
     # Disable old "should" syntax for expressions
     c.syntax = :expect
   end
-  
+
   config.treat_symbols_as_metadata_keys_with_true_values = true # Prepare for RSpec 3
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Louis Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 description: Provides a Ruby module that can be extended by a class in order to provide
   class methods for defining attributes. Attributable automatically generates accessor,
   equality, hash and inspect methods.
@@ -77,6 +91,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A tiny library that makes it easy to create value objects