valuables 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42a28204127e78a53b98cb474d99647083f6a2d1
+  data.tar.gz: c9e9ae645d5845b84eb0bf72a67de525dd16d896
+SHA512:
+  metadata.gz: 79c3f9a2c91f5debfec1af2128b0181f46ea04ec2c50dec7eea9db56682e9acab8fc94c536d0d376c6c8e2db5c5ab7e7d4b5733671d8166c45cc6b076c56015e
+  data.tar.gz: 7110281df5e13ac135ff0c47dc501fd69e916f8683ce9a68a6072f6e4ad608a07aac967b065ab882153a2a7f10e957afeaca4ebd25f85265dd16162c28402326

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valuables.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Arjan van der Gaag
+
+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,84 @@
+# Valuables
+
+Sometimes, your objects are only data and no behaviour. These are value objects,
+and they are defined by their _contents_. These objects are immutable, so it is
+safe to let them propagate throughout the system.
+
+Being immutable, value objects cannot be modified; their contents are set once
+on initialisation. Also, being identified by their contents, two entities with
+the same contents are considered equal.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valuables'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install valuables
+
+## Usage
+
+```ruby
+class Article
+  include Valuables::Entity
+  attributes :title, :author, :created_at
+
+  def human_created_at
+    super.strftime '%c'
+  end
+end
+
+article = Article.new(title: 'On Values', author: 'J. Example', created_at: Time.now)
+article.title
+# => 'On Values'
+
+article = Article.new(title: 'On Values')
+# => ArgumentError: missing attributes: author, created_at
+
+article = Article.new(title: 'On Values', author: 'J. Example', created_at: Time.now, tags: ['news'])
+# => ArgumentError: unexpected attributes: tags
+
+article1 = Article.new(title: 'On Values', author: 'J. Example', created_at: Time.now)
+article2 = Article.new(title: 'On Values', author: 'J. Example', created_at: Time.now)
+article1 == article2
+# => true
+
+article3 = Article.new(title: 'On Values', author: 'J. Example', created_at: Time.now)
+article4 = Article.new(title: 'More Values', author: 'R. Demo', created_at: Time.now)
+article3 == article4
+# => false
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/avdgaag/valuables. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+RDoc::Task.new :doc do |t|
+  t.main = 'README.md'
+  t.rdoc_files.include('README.md', 'LICENSE.txt', 'CODE_OF_CONDUCT.md', 'lib/**/*.rb')
+  t.rdoc_dir = 'doc'
+  t.options << '--exclude=test/.* --quiet'
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "valuables"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/valuables.rb

@@ -0,0 +1,5 @@
+require 'valuables/version'
+require 'valuables/entity'
+
+module Valuables
+end

data/lib/valuables/deep_freeze.rb

@@ -0,0 +1,35 @@
+module Valuables
+  ##
+  # Deep freezing functionality for Ruby objects
+  #
+  # Freeze Ruby objects like a regular +#freeze+ would do, but also freeze any
+  # included values. This comes with support for commonly used Ruby classes,
+  # such as +Hash+, +Array+ and +Range+.
+  #
+  # To make custom objects work with +DeepFreeze+, define a +#deep_freeze+
+  # method.
+  module DeepFreeze
+    module_function
+
+    # Like Ruby's +#freeze+ but recurses into contained values.
+    def deep_freeze(obj)
+      if obj.respond_to?(:deep_freeze)
+        obj.deep_freeze
+      elsif obj.kind_of?(Hash)
+        obj.reduce({}) do |acc, (key, value)|
+          acc.merge deep_freeze(key) => deep_freeze(value)
+        end.freeze
+      elsif obj.kind_of?(Array)
+        obj.reduce([]) do |acc, value|
+          acc << deep_freeze(value)
+        end.freeze
+      elsif obj.kind_of?(Range)
+        deep_freeze(obj.begin)..deep_freeze(obj.end).freeze
+      elsif obj.kind_of?(Symbol)
+        obj
+      else
+        obj.dup.freeze
+      end
+    end
+  end
+end

data/lib/valuables/entity.rb

@@ -0,0 +1,88 @@
+require_relative './deep_freeze'
+
+module Valuables
+  ##
+  # Include +Entity+ to make a class an immutable value object.
+  module Entity
+    def self.included(cls) # :nodoc:
+      cls.extend ClassMethods
+    end
+
+    module ClassMethods
+      ##
+      # Define an explicit list of attribute names.
+      #
+      # When you explicitly define attributes, you ensure objects can only be
+      # created with those attributes. Missing or unexpected attributes will
+      # trigger an +ArgumentError+.
+      def attributes(*names)
+        return @attributes unless names.any?
+        @attributes = names
+        mod = Module.new do
+          names.each do |name|
+            define_method(name) do
+              @attributes.fetch(name)
+            end
+          end
+        end
+        include mod
+      end
+    end
+
+    attr_reader :hash # :nodoc:
+
+    attr_reader :attributes # :nodoc:
+    protected :attributes
+
+    ##
+    # Initialize a new entity
+    #
+    # Provide the entity's attributes as key/value pairs in +kwargs+. Any
+    # attributes you provide will be duplicated and frozen, so you need not
+    # worry about later modifications to any values passed in.
+    def initialize(**kwargs)
+      assert_required_attributes(kwargs)
+      assert_no_extra_attributes(kwargs)
+      @attributes = Valuables::DeepFreeze.deep_freeze(kwargs)
+      @hash = self.class.hash ^ @attributes.hash
+      freeze
+    end
+
+    # Comparse two objects
+    #
+    # Two entities are considered equal if they are instances of the same class
+    # and their internal attributes are equal.
+    def ==(other)
+      self.class == other.class &&
+        attributes == other.attributes
+    end
+    alias_method :eql?, :==
+
+    # Get a Hash representation of this entity.
+    def to_h
+      @attributes
+    end
+
+    def inspect # :nodoc:
+      "#<#{self.class} #{attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(' ')}>"
+    end
+
+    private
+
+    def assert_required_attributes(attrs)
+      return unless self.class.attributes
+      missing_attributes = self.class.attributes - attrs.keys
+      if missing_attributes.any?
+        raise ArgumentError, 'Missing attributes: ' + missing_attributes.join(', ')
+      end
+    end
+
+    def assert_no_extra_attributes(attrs)
+      return unless self.class.attributes
+      extra_attributes = attrs.keys - self.class.attributes
+      if extra_attributes.any?
+        raise ArgumentError, 'Unexpected attributes: ' + extra_attributes.join(', ')
+      end
+    end
+  end
+end

data/lib/valuables/version.rb

@@ -0,0 +1,3 @@
+module Valuables
+  VERSION = '0.1.0'.freeze
+end

data/valuables.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'valuables/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'valuables'
+  spec.version       = Valuables::VERSION
+  spec.authors       = ['Arjan van der Gaag']
+  spec.email         = ['arjan.vandergaag@gmail.com']
+
+  spec.summary       = %q{Immutable value objects in Ruby}
+  spec.description   = <<-EOS
+Sometimes, your objects are only data and no behaviour. These are value
+objects, and they are defined by their _contents_. These objects are immutable,
+so it is safe to let them propagate throughout the system.
+
+Being immutable, value objects cannot be modified; their contents are set once
+on initialisation. Also, being identified by their contents, two entities with
+the same contents are considered equal.
+EOS
+
+  spec.homepage      = 'http://avdgaag.github.io/valuables'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: valuables
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: |
+  Sometimes, your objects are only data and no behaviour. These are value
+  objects, and they are defined by their _contents_. These objects are immutable,
+  so it is safe to let them propagate throughout the system.
+
+  Being immutable, value objects cannot be modified; their contents are set once
+  on initialisation. Also, being identified by their contents, two entities with
+  the same contents are considered equal.
+email:
+- arjan.vandergaag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/valuables.rb
+- lib/valuables/deep_freeze.rb
+- lib/valuables/entity.rb
+- lib/valuables/version.rb
+- valuables.gemspec
+homepage: http://avdgaag.github.io/valuables
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Immutable value objects in Ruby
+test_files: []
+has_rdoc: