strict_struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b6bb2125a155d3e7bdaeeec1911f866b2794a06
+  data.tar.gz: b3a9be0fb018a7eb7a44bb51eeee5169a64a29cf
+SHA512:
+  metadata.gz: 29092b1f8a93d319377f94bf71c900e28c52e2f30fd1da03a0160c8c90e40656c3432f5b09eeedfea1cc91a3486bb10de2e34064ad78e2747de01e755fef5c02
+  data.tar.gz: 1f98e60cec646a207424cd0efda65d2e2cbad1031247ff71c477e346839adbbfa1c47b6096f1bacd74267ffb85377a69c7e0d9a60ac3d1926036333992899ccd

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,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - rbx
+  - jruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark IJbema
+
+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,64 @@
+# StrictStruct [![Build Status](https://travis-ci.org/markijbema/strict_struct.png)](https://travis-ci.org/markijbema/strict_struct) [![Code Climate](https://codeclimate.com/github/markijbema/strict_struct.png)](https://codeclimate.com/github/markijbema/strict_struct)
+
+This gems aims to provide a modern version of Struct.
+While Struct is a nice easy way to create a light-weight
+value object, it has some drawbacks
+
+* You need to remember the order of arguments
+* The object is mutable by default
+
+This gem aims to avoid these drawbacks, while providing the
+ease of use of Struct.
+
+## Usage
+
+If you want to create a simple object, just declare it like
+you would declare a Struct:
+
+```ruby
+Rectangle = StrictStruct.new(:x, :y) do
+  def area
+    x * y
+  end
+end
+```
+
+This would conceptually create the following object:
+
+```ruby
+class Rectange
+  attr_reader :x, :y
+
+  def initialize(x:, y:)
+  end
+
+  def area
+    x * y
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'strict_struct'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strict_struct
+
+
+TODO: Write usage instructions here
+
+## 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 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+# Make running the tests the default task.
+task(default: :spec)

data/lib/strict_struct/version.rb

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

data/lib/strict_struct.rb

@@ -0,0 +1,46 @@
+#require "strict_struct/version"
+
+module StrictStruct
+  module Helper
+    def self.assert_keyword_error type, keywords
+      if keywords.length == 1
+        raise ArgumentError, "#{type} keyword: " + keywords.first.to_s
+      elsif keywords.length > 1
+        raise ArgumentError, "#{type} keywords: " + keywords.join(', ')
+      end
+    end
+
+    def self.validate_arguments given, expected
+      missing_arguments = expected.reject {|name| given.include? name }
+      Helper.assert_keyword_error "missing", missing_arguments
+
+      extra_arguments = given.reject {|name| expected.include? name }
+      Helper.assert_keyword_error "unknown", extra_arguments
+    end
+  end
+
+  def self.new(*attributes, &block)
+    klass = Class.new do
+      @@attributes = attributes
+
+      define_method :initialize do |hash={}|
+        @hash = hash
+        Helper.validate_arguments(@hash.keys, @@attributes)
+      end
+
+      attributes.each do |attribute|
+        define_method(attribute) {|| @hash[attribute] }
+      end
+
+      def to_h
+        @hash
+      end
+
+      def == (other)
+        @@attributes.all? {|name| self.send(name) == other.send(name)}
+      end
+    end
+    klass.class_eval(&block) if block_given?
+    klass
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+$LOAD_PATH << './lib/'

data/spec/strict_struct_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+require 'strict_struct'
+
+describe 'StrictStruct' do
+  describe 'initialization' do
+    it "works without parameters" do
+      foo = StrictStruct.new
+
+      a_foo = foo.new
+
+      a_foo.should_not be_nil
+    end
+
+    it "works with parameters" do
+      foo = StrictStruct.new(:bar)
+
+      a_foo = foo.new(bar: 'baz')
+
+      a_foo.should_not be_nil
+    end
+
+    it "raises an error when an argument is missing" do
+      foo = StrictStruct.new(:x)
+
+      expect do
+        foo.new()
+      end.to raise_error ArgumentError, "missing keyword: x"
+    end
+
+    it "raises an error when multiple arguments are missing" do
+      foo = StrictStruct.new(:x, :y, :z)
+
+      expect do
+        foo.new(z: 'bar')
+      end.to raise_error ArgumentError, "missing keywords: x, y"
+    end
+
+    it "raises an error when an unknown argument is passed in" do
+      foo = StrictStruct.new(:x)
+
+      expect do
+        foo.new(x: 'foo', z: 'bar')
+      end.to raise_error ArgumentError, "unknown keyword: z"
+    end
+
+    it "raises an error when multiple unknown argument are passed in" do
+      foo = StrictStruct.new(:x)
+
+      expect do
+        foo.new(x: 'foo', z: 'bar', w: 'baz')
+      end.to raise_error ArgumentError, "unknown keywords: z, w"
+    end
+
+    it "raises a missing error when both missing arguments and unknown arguments are passed in" do
+      foo = StrictStruct.new(:x, :y)
+
+      expect do
+        foo.new(x: 'foo', w: 'baz')
+      end.to raise_error ArgumentError, "missing keyword: y"
+    end
+  end
+
+  describe 'defining one' do
+    it "allows to define methods using block" do
+      rectangle_class = StrictStruct.new(:x, :y) do
+        def area
+          x * y
+        end
+      end
+
+      rectangle = rectangle_class.new(x: 3, y: 5)
+
+      rectangle.area.should == 15
+    end
+  end
+
+  describe "attribute readers" do
+    it "returns the value initialized with" do
+      foo = StrictStruct.new(:bar)
+
+      a_foo = foo.new(bar: 'baz')
+
+      a_foo.bar.should eq 'baz'
+      a_foo.should respond_to 'bar'
+    end
+
+    it "is not defined when the value isn't defined by the class" do
+      foo = StrictStruct.new(:bar)
+
+      a_foo = foo.new(bar: 'baz')
+
+      a_foo.should_not respond_to 'gerard'
+    end
+
+    it "raises a NoMethodError when called for a value which isn't defined" do
+      foo = StrictStruct.new(:x)
+      a_foo = foo.new(x: 3)
+
+      expect do
+        a_foo.y
+      end.to raise_error NoMethodError, "undefined method `y' for #{a_foo.inspect}"
+    end
+  end
+
+
+  describe '#to_h' do
+    it "returns all the values the object is defined by" do
+      foo = StrictStruct.new(:bar, :baz)
+
+      a_foo = foo.new(bar: 'baz', baz: 3)
+
+      a_foo.to_h.should eq({bar: 'baz', baz: 3})
+    end
+  end
+
+  describe '#==' do
+    it "returns true if the values are the same" do
+      foo = StrictStruct.new(:bar)
+
+      a_foo = foo.new(bar: 'baz')
+      another_foo = foo.new(bar: 'baz')
+
+      a_foo.should eq another_foo
+    end
+    it "returns true if the values are the same" do
+      foo = StrictStruct.new(:bar)
+
+      a_foo = foo.new(bar: 'baz')
+      another_foo = foo.new(bar: 'not_baz')
+
+      a_foo.should_not eq another_foo
+    end
+  end
+end

data/strict_struct.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strict_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "strict_struct"
+  spec.version       = StrictStruct::VERSION
+  spec.authors       = ["Mark IJbema"]
+  spec.email         = ["markijbema@gmail.com"]
+  spec.description   = %q{Extremely simple value objects}
+  spec.summary       = %q{StrictStruct is an immutable, named parameters based, replacement for Struct}
+  spec.homepage      = "https://github.com/markijbema/strict_struct"
+  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 "rspec"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: strict_struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark IJbema
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Extremely simple value objects
+email:
+- markijbema@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/strict_struct.rb
+- lib/strict_struct/version.rb
+- spec/spec_helper.rb
+- spec/strict_struct_spec.rb
+- strict_struct.gemspec
+homepage: https://github.com/markijbema/strict_struct
+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.1
+signing_key: 
+specification_version: 4
+summary: StrictStruct is an immutable, named parameters based, replacement for Struct
+test_files:
+- spec/spec_helper.rb
+- spec/strict_struct_spec.rb