attributable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8c95938ed6c4f51930505e6e11ec6f210bda51e
+  data.tar.gz: 338a2ba7e74b833aad96209d33f1a3ea0ee12ade
+SHA512:
+  metadata.gz: 2a0a0e877474b561c6870b72baa5f10467a819e7dc80f8a28cdfe36cdb84abaa3e6dae836f698010bc6769bfccaec996e66cb4675538db82989e520d12d98b11
+  data.tar.gz: fb026c2c07406c31dc902af89bad1c81f13a1de92e1d72202a4440e60e8750c657c52af3509c97eeb7871d8a732e56edd77fbffdac37bc486950658d4ae883e8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Louis Rose
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# 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)
+
+A tiny library that makes it easy to create value objects.
+
+## Basic usage
+
+    require "attributable"
+
+    class User
+      extend Attributable
+  
+      attributes :forename, :surname
+    end
+
+    john = User.new(forename: "John", surname: "Doe")
+    john.forename # => "John"
+    john.surname  # => "Doe"
+
+All attributes are read-only:
+
+    john.forename = "Jonathan" # => NoMethodError: undefined method `forename='
+
+Default values for attributes can be set via a hash argument to `attributes`:
+
+    class UserWithDefaults
+      extend Attributable
+
+      attributes :forename, :surname, active: true
+    end
+    
+    anon = UserWithDefaults.new
+    anon.active   # => true
+    anon.forename # => nil
+
+## Equality
+
+Attributable adds `eql?` and `==` methods to your class which compare attribute values and types.
+
+    john = User.new(forename: "John", surname: "Doe")
+    second_john = User.new(forename: "John", surname: "Doe")
+
+    john.eql? second_john # => true
+    john == second_john   # => true
+  
+The equality methods return false when compared to an object of the same type with different attribute values:
+
+    jane = User.new(forename: "Jane", surname: "Doe")
+    john.eql? jane # => false
+    john == jane   # => false
+  
+The equality methods return false when compared to an object of a different type, even if the attribute values are equal.
+
+    class Admin
+      extend Attributable
+
+      attributes :forename, :surname
+    end
+
+    admin_john = Admin.new(forename: "Jane", surname: "Doe")
+    john.eql? admin_john # => false
+    john == admin_john   # => false
+
+Because Attributable overrides `eql?` and `==`, it also overrides `hash`:
+
+    john.hash == second_john.hash # => true
+    john.hash == jane.hash        # => false
+    john.hash == admin_john.hash  # => false
+
+## Pretty printing
+
+Attributable adds an `inspect` method to your class which display attribute values.
+
+    john.inspect # => <User forename="John", surname="Doe">
+
+## Specialisation
+
+To allow reuse of attribute declarations, Attributable provides the `specialises` class method.
+
+    class Author
+      extend Attributable
+      
+      specialises User
+      attributes blogs: []
+    end
+    
+    ronson = Author.new(forename: "Jon", surname: "Ronson")
+    ronson.inspect # => <Author forename="Jon", surname="Ronson", blogs=[]>
+    
+Specialising classes can override the defaults set in specialised classes.
+
+    class Ronson
+      extend Attributable
+
+      specialises User
+      attributes surname: "Ronson"
+    end
+
+    Ronson.new(forename: "Jon").inspect # <Ronson forename="Jon", surname="Ronson">
+    Ronson.new(forename: "Mark").inspect # <Ronson forename="Mark", surname="Ronson">
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attributable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attributable
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: "test:unit"
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end

data/attributable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attributable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attributable"
+  spec.version       = Attributable::VERSION
+  spec.authors       = ["Louis Rose"]
+  spec.email         = ["louis.rose@york.ac.uk"]
+  spec.description   = %q{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.}
+  spec.summary       = %q{A tiny library that makes it easy to create value objects}
+  spec.homepage      = "https://github.com/mutiny/attributable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1.1"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "coveralls", "~> 0.7.0"
+end

data/lib/attributable.rb

@@ -0,0 +1,74 @@
+require "attributable/version"
+
+module Attributable
+  def attributes(*without_defaults, **with_defaults)
+    @predefined_attributes ||= {}
+    @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")
+    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
+  # 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)
+    {}.tap do |attributes|
+      without_defaults.each { |name| attributes[name] = nil }
+      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)
+    add_equality_methods(predefined_attributes.keys)
+    add_inspect_method(predefined_attributes.keys)
+  end
+
+  def add_constructor(predefined_attributes)
+    define_method "initialize" do |attributes = {}|
+      @attributes = predefined_attributes.merge(attributes)
+    end
+  end
+
+  def add_accessors(names)
+    names.each do |name|
+      define_method "#{name}" do
+        @attributes[name.to_sym]
+      end
+    end
+  end
+
+  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) }
+    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}" }
+        .join(", ")
+        
+      "<#{self.class.name} #{values}>"
+    end
+  end
+end

data/lib/attributable/version.rb

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

data/spec/attributable/accessors_spec.rb

@@ -0,0 +1,18 @@
+require "attributable"
+
+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')
+      expect(i.respond_to?(:address)).to be_false
+    end 
+  
+    it "should not have setters" do
+      i = User.new(forename: 'John')
+    
+      expect(i.respond_to?(:id=)).to be_false
+    end
+  end
+end

data/spec/attributable/construction_spec.rb

@@ -0,0 +1,31 @@
+require "attributable"
+
+class User; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+
+describe Attributable do
+  describe "construction" do
+    it "should accept a hash" do
+      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')
+    end
+
+    it "should set missing attributes to default" do
+      i = User.new(forename: 'John')
+      
+      expect(i.id).to be_nil
+      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')
+      
+      expect(i.id).to be_nil
+      expect(i.forename).to be_nil
+      expect(i.surname).to eq('Doe')
+    end
+  end
+end

data/spec/attributable/equality_spec.rb

@@ -0,0 +1,38 @@
+require "attributable"
+
+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')
+    
+      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')
+    
+      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')
+    
+      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')
+    
+      expect(i).not_to eql(j)
+      expect(i).not_to be == j
+    end
+  end
+end

data/spec/attributable/hash_spec.rb

@@ -0,0 +1,33 @@
+require "attributable"
+
+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')
+      
+      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 }
+      
+      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')
+      
+      expect(u.hash).not_to eq(p.hash)
+    end
+  end
+end

data/spec/attributable/inspect_spec.rb

@@ -0,0 +1,13 @@
+require "attributable"
+
+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')
+      
+      expect(i.inspect).to eq("<User id=1, forename=\"John\", surname=\"Doe\">")
+    end
+  end
+end

data/spec/attributable/specialisation_spec.rb

@@ -0,0 +1,76 @@
+require "attributable"
+
+class User; extend Attributable; attributes :id, :forename, surname: "Bloggs" end
+
+describe Attributable do
+  describe "specialisation" do
+    it "should pull in attributes from specified class" do
+      class SuperUser
+        extend Attributable
+
+        attributes :password, active: true
+        specialises User
+      end
+      
+      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.active).to be_false
+    end
+    
+    it "should be possible to declare specialisation before attributes" do
+      class SuperUser2
+        extend Attributable
+
+        specialises User
+        attributes :password, active: true
+      end
+      
+      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.active).to be_false
+    end
+    
+    it "should ensure that local attributes have greater precedence than specialised attributes" do
+      class SuperUser3
+        extend Attributable
+
+        specialises User
+        attributes surname: 'Smith'
+      end
+      
+      s = SuperUser3.new
+      
+      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
+      class SuperUser4
+        extend Attributable
+
+        attributes surname: 'Smith'
+        specialises User
+      end
+      
+      s = SuperUser4.new
+      
+      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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'coveralls'
+Coveralls.wear!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # 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.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

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: attributable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Louis Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+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.
+email:
+- louis.rose@york.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attributable.gemspec
+- lib/attributable.rb
+- lib/attributable/version.rb
+- spec/attributable/accessors_spec.rb
+- spec/attributable/construction_spec.rb
+- spec/attributable/equality_spec.rb
+- spec/attributable/hash_spec.rb
+- spec/attributable/inspect_spec.rb
+- spec/attributable/specialisation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mutiny/attributable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A tiny library that makes it easy to create value objects
+test_files:
+- spec/attributable/accessors_spec.rb
+- spec/attributable/construction_spec.rb
+- spec/attributable/equality_spec.rb
+- spec/attributable/hash_spec.rb
+- spec/attributable/inspect_spec.rb
+- spec/attributable/specialisation_spec.rb
+- spec/spec_helper.rb