attrs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 831e360a852a5219f76a80451787e234b1d2945c
+  data.tar.gz: c19032b5e3cf6888752e6068efb0770422d77a27
+SHA512:
+  metadata.gz: 793ca776c058b0577bec1fc744f4283087b5350371c39d5fd94ec892a385c4820f3c7a4b686ac613e7bf8d6733ab59576f8261a6f14b567ca32c460470816bec
+  data.tar.gz: 00dc67d08c02a0a3aad66d5adb916dca0115eaf773991035acb2d1bac0c0ad73e6d0fa62c40d436f75e1ec5c0fe50e6b723162d7f51bc619fc8fbdbf2343b22c

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/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wojciech Mach
+
+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,93 @@
+# Attrs
+
+[![Build Status](https://secure.travis-ci.org/wojtekmach/attrs.png?branch=master)](http://travis-ci.org/wojtekmach/attrs)
+
+Yet another attributes on steroids gem.
+
+Heavily inspired by [Virtus](https://github.com/solnic/virtus) and
+[Values](https://github.com/tcrayford/Values) which both are great projects.
+
+The purpose of this project is to have a small & simple codebase and minimum number of features.
+For a more complex solution I strongly recommend **Virtus** which I'm happily using in production.
+
+## Features
+
+* immutability
+* all attributes must be specified on initialisation. Hopefully less `nil`'s flying around
+* uses `attr_reader` and `attr_writer`. Can be easily overwritten
+* just ~50 LOC (not including coercion support)
+* no external dependencies (again, not counting coercion which requires coercible gem)
+
+## Usage
+
+Let's write a `Person` class:
+
+```ruby
+require 'attrs'
+
+class Person < Attrs(:name, :age)
+  private
+
+  def age=(new_age)
+    super(new_age.to_i)
+  end
+end
+
+person = Person.new(name: 'John Doe', age: '26')
+```
+
+with this code we can:
+
+* get the attributes hash:    `person.attributes      # => {:name => "John Doe", :age => 26}`
+* get the attribute names:    `Person.attribute_names # => [:name, :age]`
+* compare with other objects: `person == {:name => "John Doe", :age => 26} # => true`
+
+and more! See: <https://github.com/wojtekmach/attrs/blob/master/test/attrs_test.rb>
+
+### Coercion
+
+Notice in previous example we added custom `age=` writer to coerce argument to integer.
+
+One of my favourite features of **Virtus** is attribute coercion, and you can use it here too.
+In fact it's using the same library that was extracted out from **Virtus**: <https://github.com/solnic/coercible>
+
+```
+gem install coercible
+```
+
+```ruby
+require 'attrs/coercible'
+
+class Person < Attrs(name: String, age: Integer)
+end
+```
+
+or, simply:
+
+```ruby
+Person = Attrs(name: String, age: Integer)
+```
+
+(note, using 2nd style you won't be able to use `super` when overwriting methods)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attrs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attrs
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/attrs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attrs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attrs"
+  spec.version       = Attrs::VERSION
+  spec.authors       = ["Wojciech Mach"]
+  spec.email         = ["wojtek@wojtekmach.pl"]
+  spec.description   = "Yet another attributes on steroids gem"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/wojtekmach/attrs"
+  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"
+  spec.add_development_dependency "minitest", "~> 5.0.0"
+  spec.add_development_dependency "coercible", "~> 0.2.0"
+end

data/lib/attrs.rb

@@ -0,0 +1,48 @@
+require 'attrs/version'
+
+def Attrs(*args, &block)
+  Attrs.new(*args, &block)
+end
+
+module Attrs
+  def self.new(*attribute_names, &block)
+    Class.new do
+      const_set(:ATTRIBUTE_NAMES, attribute_names)
+
+      def self.attribute_names
+        self::ATTRIBUTE_NAMES
+      end
+
+      def self.attr(name)
+        attr_accessor name
+        private :"#{name}="
+      end
+
+      attribute_names.each { |name| attr name }
+
+      def initialize(attributes)
+        self.class.attribute_names.each do |name|
+          self.send("#{name}=", attributes.fetch(name))
+        end
+      end
+
+      def inspect
+        "#<#{self.class.name} #{attributes.inspect}>"
+      end
+
+      def ==(other)
+        to_hash == other.to_hash
+      end
+
+      def attributes
+        self.class.attribute_names.each_with_object({}) do |name, hash|
+          hash[name] = send(name)
+        end
+      end
+
+      alias_method :to_hash, :attributes
+
+      class_eval(&block) if block_given?
+    end
+  end
+end

data/lib/attrs/coercible.rb

@@ -0,0 +1,37 @@
+begin
+  require 'coercible'
+rescue LoadError => e
+  puts "Coercion support requires coercible: gem install coercible"
+  raise e
+end
+
+def Attrs(*attributes, &block)
+  if attributes.size == 1 && attributes.first.is_a?(Hash)
+    CoercibleAttrs.new(attributes.first, &block)
+  else
+    Attrs.new(*attributes, &block)
+  end
+end
+
+module CoercibleAttrs
+  def self.new(attributes, &block)
+    Attrs.new(*attributes.keys) do
+      const_set(:ATTRIBUTES, attributes)
+      const_set(:COERCER, Coercible::Coercer.new)
+
+      def self.attr(name, type)
+        define_method :"#{name}=" do |val|
+          coercion = "to_" + self.class::ATTRIBUTES[name].name.downcase
+          val = self.class::COERCER[val.class].send(coercion, val)
+          instance_variable_set(:"@#{name}", val)
+        end
+
+        private :"#{name}="
+      end
+
+      attributes.each { |name, type| attr(name, type) }
+
+      class_eval(&block) if block_given?
+    end
+  end
+end

data/lib/attrs/version.rb

@@ -0,0 +1,3 @@
+module Attrs
+  VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).chomp
+end

data/test/attrs_test.rb

@@ -0,0 +1,73 @@
+require 'minitest/autorun'
+require 'attrs'
+
+class Person < Attrs(:name, :age)
+  private
+
+  def age=(new_age)
+    super(new_age.to_i)
+  end
+end
+
+class PersonTest < Minitest::Spec
+  let(:valid_attributes) { {name: "John Doe", age: 26} }
+  let(:klass) { Person }
+
+  it "responds to .attribute_names" do
+    klass.attribute_names.must_equal [:name, :age]
+  end
+
+  it "can be instantiated" do
+    klass.new(valid_attributes).must_be_kind_of klass
+  end
+
+  it "has string representation" do
+    str = klass.new(valid_attributes).inspect
+    str.must_equal "#<#{klass} #{valid_attributes.inspect}>"
+  end
+
+  it "must be instantiated with all attributes" do
+    proc {
+      klass.new(age: 26)
+    }.must_raise KeyError
+  end
+
+  it "can access individual attributes" do
+    klass.new(valid_attributes).name.must_equal "John Doe"
+  end
+
+  it "can return all attributes" do
+    klass.new(valid_attributes).attributes.must_equal valid_attributes
+  end
+
+  it "can overwrite setting of an attribute" do
+    klass.new(valid_attributes.merge(age: '26')).age.must_equal 26
+  end
+
+  it "cannot mutate attributes" do
+    person = klass.new(valid_attributes)
+
+    proc {
+      person.name = 'Joe'
+    }.must_raise NoMethodError
+  end
+
+  it "is equal to an object with the same attributes" do
+    klass.new(valid_attributes).must_equal klass.new(valid_attributes)
+
+    klass.new(valid_attributes).must_equal valid_attributes
+  end
+
+  it "is equal to hash of the same attributes" do
+    klass.new(valid_attributes).must_equal valid_attributes
+  end
+end
+
+require 'attrs/coercible'
+
+class Person2 < Attrs(name: String, age: Integer)
+end
+
+class Person2Test < PersonTest
+  let(:klass) { Person2 }
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: attrs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wojciech Mach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-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.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: coercible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Yet another attributes on steroids gem
+email:
+- wojtek@wojtekmach.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- attrs.gemspec
+- lib/attrs.rb
+- lib/attrs/coercible.rb
+- lib/attrs/version.rb
+- test/attrs_test.rb
+homepage: https://github.com/wojtekmach/attrs
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Yet another attributes on steroids gem
+test_files:
+- test/attrs_test.rb