solid-struct 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 522f1dbc238d5a05b441c2b629bdc0fa77f0121c
+  data.tar.gz: 39d3df78bd5f6f42f0399e3cf15226da38dc15da
+SHA512:
+  metadata.gz: 7cfae66fedc07c2aa086201b6ab99ddf7466c5026d42127a3efd20a1459f7e20158fddacf098bfb2f6e5975ac81375c38a7bc6fb6eb53ad8c8b274ea0fec4636
+  data.tar.gz: fb8efc37c401c7ff7f967af5ce9a6f346067dc7ae5915522e98bdddbf59246f590be82f559eb33b308dc1f90220ce5162986492a708900dc092e7619905bbc4d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 chemica
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Dunkley
+
+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,103 @@
+# Solid Struct
+
+A Ruby gem providing a Struct variant that allows initialisation with named parameters. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solid-struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solid-struct
+
+and require it in your Ruby code:
+
+````ruby
+require 'solid_struct'
+````
+
+
+## Usage
+
+```ruby
+Klass = SolidStruct.new(:param1, :param2, :param3)
+instance = Klass.new(param1: 1, param2: "foo", param3: "bar")
+instance.param1
+#=> 1
+instance.param2
+#=> "foo"
+instance.param3
+#=> "bar"
+```
+
+This allows for more readable code, especially when the struct definition is separated from the use. Named parameters intrinsically convey more meaning and reduce the need for comments.
+
+Using named arguments allows you to initialise parameters out of order, of course:
+
+```ruby
+Klass = SolidStruct.new(:param1, :param2, :param3)
+instance = Klass.new(param2: "foo", param1: 1, param3: "bar")
+instance.param1
+#=> 1
+instance.param2
+#=> "foo"
+instance.param3
+#=> "bar"
+```
+
+You can still use positional arguments if you choose to ignore the benefits of the gem:
+
+
+```ruby
+Klass = SolidStruct.new(:param1, :param2, :param3)
+instance = Klass.new(1, "foo", "bar")
+instance.param1
+#=> 1
+instance.param2
+#=> "foo"
+instance.param3
+#=> "bar"
+```
+
+Or you can define and initialise in one simple step:
+
+
+```ruby
+instance = SolidStruct.build(param1: 1, :param2: "foo", :param3: "bar")
+instance.param1
+#=> 1
+instance.param2
+#=> "foo"
+instance.param3
+#=> "bar"
+
+# Unlike an OpenStruct undefined arguments are not allowed:
+
+instance.pancake
+#=>NoMethodError: undefined method `pancake' for #<struct param1=1, param2="foo", param3="bar">
+```
+
+
+## Credits
+
+Partially based on Stack Overflow answers by clacke and Matt S:
+
+http://stackoverflow.com/questions/5407940/named-parameters-in-ruby-structs
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/named-struct/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+

data/lib/solid_struct.rb

@@ -0,0 +1,27 @@
+# Allow structs to be initialised using a hash
+module SolidStruct
+  VERSION = "0.0.2"
+
+  class NamedStruct < Struct
+    # Override the initialize to handle hashes of named parameters
+    def initialize *args
+      opts = args.last.is_a?(Hash) ? args.pop : Hash.new
+      super *args
+      opts.each_pair do |k, v|
+        self.send "#{k}=", v
+      end
+    end
+  end
+
+  def self.new(*args)
+    NamedStruct.new(*args)
+  end
+
+  def self.build(hash)
+    raise ArgumentError.new("Arguments must be defined as a hash") unless hash.is_a? Hash
+
+    klass = NamedStruct.new(*hash.keys)
+    klass.new(hash)
+  end
+
+end

data/solid-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 'solid_struct'
+
+Gem::Specification.new do |spec|
+  spec.name          = "solid-struct"
+  spec.version       = SolidStruct::VERSION
+  spec.authors       = ["Benjamin Dunkley"]
+  spec.email         = ["ben@chemica.co.uk"]
+  spec.summary       = %q{Structs with named parameters for initialisation and syntactic sugar}
+  spec.description   = %q{SolidStruct is a Struct variant that allows the use of named parameters (via a hash) for initialisation. Syntactic sugar is provided for simpler struct definitions.}
+  spec.homepage      = "https://github.com/chemica/solid-struct"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.7.0"
+end

data/test/solid_struct_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe SolidStruct do
+  it "allows named initialisation arguments" do
+    Klass1 = SolidStruct.new(:param1, :param2)
+    instance = Klass1.new(param1: "one", param2: "two")
+    instance.param1.must_equal "one"
+    instance.param2.must_equal "two"
+  end
+
+  it "allows positional initialisation arguments" do
+    Klass2 = SolidStruct.new(:param1, :param2)
+    instance = Klass2.new("one", "two")
+    instance.param1.must_equal "one"
+    instance.param2.must_equal "two"
+  end
+
+  it "allows named arguments in a different order" do
+    Klass3 = SolidStruct.new(:param1, :param2)
+    instance = Klass3.new(param2: "two", param1: "one")
+    instance.param1.must_equal "one"
+    instance.param2.must_equal "two"
+  end
+
+  it "builds an instance using a hash" do
+    instance = SolidStruct.build(param1: "one", param2: "two")
+    instance.param1.must_equal "one"
+    instance.param2.must_equal "two"
+  end
+
+  it "throws an exception if building using a non-hash" do
+    assert_raises ArgumentError do
+      SolidStruct.build(["I'm an array, fool!"])
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'solid_struct'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/spec'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: solid-struct
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Benjamin Dunkley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+description: SolidStruct is a Struct variant that allows the use of named parameters
+  (via a hash) for initialisation. Syntactic sugar is provided for simpler struct
+  definitions.
+email:
+- ben@chemica.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/solid_struct.rb
+- solid-struct.gemspec
+- test/solid_struct_test.rb
+- test/test_helper.rb
+homepage: https://github.com/chemica/solid-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.4.8
+signing_key: 
+specification_version: 4
+summary: Structs with named parameters for initialisation and syntactic sugar
+test_files:
+- test/solid_struct_test.rb
+- test/test_helper.rb