key_struct 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ronen Barzel
+
+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.rdoc

@@ -0,0 +1,71 @@
+= key_struct
+
+Defines KeyStruct, which is the same as ruby's Struct, but the initializer
+takes keyword args (using a hash, rails-style).  Use it to define a class via:
+
+  Name = KeyStruct[:first, :last]
+
+or as an anonymous base class for your own enhanced struct:
+
+  class Name < KeyStruct[:first, :last]
+    def to_s
+      "#{@last}, #{@first}"
+    end
+  end
+
+Then you can create an instance of the class using keywords for the parameters:
+
+  name = Name.new(:first => "Jack", :last => "Ripper")
+
+and you have the usal readers and writers:
+
+  name.first            --> "Jack"
+  name.last             --> "Ripper"
+  name.last = "Sprat"
+  name.last             --> "Sprat"
+  name.to_s             --> "Sprat, Jack" for the enhanced class example
+
+If you leave off a keyword when instantiating, normally the value is nil:
+
+  name = Name.new(:first => "Jack")
+  name.last             --> nil
+
+But the class definition can specify defaults, e.g.
+
+  Name = KeyStruct[:first, :last => "Doe"]
+  name = Name.new(:first => "John")
+  name.first            --> "John"
+  name.last             --> "Doe"
+
+The struct initializer checks for invalid arguments:
+
+  name = Name.new(:middle => "Xaviar")  --> raises ArgumentError
+
+The gem actually provides two types of KeyStruct classes
+
+  KeyStruct.accesor(*keys)      # aliased as KeyStruct[]
+  KeyStruct.reader(*keys)       # class has readers but not writers
+
+== Tested on
+
+MRI 1.9.2, 1.9.3
+
+== History
+
+Future: I hope that this gem will be obviated in future versions of ruby.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.  Make sure that the coverage report
+  (generated automatically when you run rspec) is at 100%
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
+== Copyright
+
+Released under the MIT License.  See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+end

data/key_struct.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/key_struct/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["ronen barzel"]
+  gem.email         = ["ronen@barzel.org"]
+  gem.description   = %q{Defines KeyStruct analogous to Struct, but constructor takes keyword arguments}
+  gem.summary       = %q{Defines KeyStruct analogous to Struct, but constructor takes keyword arguments}
+  gem.homepage      = 'http://github.com/ronen/key_struct'
+  gem.extra_rdoc_files = [
+    'LICENSE',
+    'README.rdoc',
+  ]
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "key_struct"
+  gem.require_paths = ["lib"]
+  gem.version       = KeyStruct::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'simplecov-gem-adapter'
+end

data/lib/key_struct.rb

@@ -0,0 +1,36 @@
+require "key_struct/version"
+
+module KeyStruct
+
+  def self.reader(*keys)
+    define_key_struct(:attr_reader, keys)
+  end
+
+  def self.accessor(*keys)
+    define_key_struct(:attr_accessor, keys)
+  end
+
+  instance_eval do
+    alias :[] :accessor
+  end
+
+  private
+
+  def self.define_key_struct(access, keys) 
+    klass = Class.new
+    klass.class_eval do
+      keyvalues = Hash[*keys.map{|key| (Hash === key) ? key.to_a : [key, nil]}.flatten]
+      keys = keyvalues.keys
+      send access, *keys
+      define_method(:initialize) do |args={}|
+        args = keyvalues.merge(args)
+        keys.each do |key|
+          instance_variable_set("@#{key}", args.delete(key))
+        end
+        raise ArgumentError, "Invalid argument(s): #{args.keys.map(&:inspect).join(' ')}; KeyStruct accepts #{keys.map(&:inspect).join(' ')}" if args.any?
+      end
+    end
+    klass
+  end
+
+end

data/lib/key_struct/version.rb

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

data/spec/key_struct_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe "KeyStruct" do
+
+  it "creates a class using KeyStruct.accessor" do
+    Class.should === KeyStruct.accessor(:a, :b, :c => 3)
+  end
+
+  it "creates a class using KeyStruct.reader" do
+    Class.should === KeyStruct.reader(:a, :b, :c => 3)
+  end
+
+  it "creates a class using KeyStruct[]" do
+    Class.should === KeyStruct[:a, :b, :c => 3]
+  end
+
+  it "[] should be an alias for accessor" do
+    KeyStruct.method(:[]).should == KeyStruct.method(:accessor)
+  end
+
+  context "reader" do
+    before(:all) do 
+      @klass = KeyStruct.reader(:a, :b, :c => 3)
+    end
+
+    it "provides getters" do
+      @klass.instance_methods.should include(:a)
+      @klass.instance_methods.should include(:b)
+      @klass.instance_methods.should include(:c)
+    end
+
+    it "does not provide setters" do
+      @klass.instance_methods.should_not include(:"a=")
+      @klass.instance_methods.should_not include(:"b=")
+      @klass.instance_methods.should_not include(:"c=")
+    end
+
+    it "initializer accepts all key args" do
+      expect { @klass.new(:a => 1, :b => 2, :c => 3) }.should_not raise_error
+    end
+
+    it "initializer accepts some key args" do
+      expect { @klass.new(:a => 1) }.should_not raise_error
+    end
+
+    it "initializer accepts no args" do
+      expect { @klass.new }.should_not raise_error
+    end
+
+    it "initializer raises error for invalid args" do
+      expect { @klass.new(:d => 4) }.should raise_error
+    end
+
+    it "getters returns initial/default argument values" do
+      reader = @klass.new(:a => 1)
+      reader.a.should == 1
+      reader.b.should be_nil
+      reader.c.should == 3
+    end
+  end
+
+  context "accessor" do
+    before(:all) do 
+      @klass = KeyStruct.accessor(:a, :b, :c => 3)
+    end
+
+    it "provides getters" do
+      @klass.instance_methods.should include(:a)
+      @klass.instance_methods.should include(:b)
+      @klass.instance_methods.should include(:c)
+    end
+
+    it "provides setters" do
+      @klass.instance_methods.should include(:"a=")
+      @klass.instance_methods.should include(:"b=")
+      @klass.instance_methods.should include(:"c=")
+    end
+
+    it "initializer accepts all key args" do
+      expect { @klass.new(:a => 1, :b => 2, :c => 3) }.should_not raise_error
+    end
+
+    it "initializer accepts some key args" do
+      expect { @klass.new(:a => 1) }.should_not raise_error
+    end
+
+    it "initializer accepts no args" do
+      expect { @klass.new }.should_not raise_error
+    end
+
+    it "initializer raises error for invalid args" do
+      expect { @klass.new(:d => 4) }.should raise_error
+    end
+
+    it "getters return initial argument values" do
+      reader = @klass.new(:a => 1)
+      reader.a.should == 1
+      reader.b.should be_nil
+      reader.c.should == 3
+    end
+
+    it "setters work as expected" do
+      reader = @klass.new(:a => 1)
+      reader.b = 2
+      reader.c = 4
+      reader.a.should == 1
+      reader.b.should == 2
+      reader.c.should == 4
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+if RUBY_VERSION > "1.9"
+  require 'simplecov'
+  require 'simplecov-gem-adapter'
+  SimpleCov.start 'gem'
+end
+
+require 'rspec'
+require 'key_struct'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: key_struct
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov-gem-adapter
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Defines KeyStruct analogous to Struct, but constructor takes keyword arguments
+email: 
+- ronen@barzel.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- key_struct.gemspec
+- lib/key_struct.rb
+- lib/key_struct/version.rb
+- spec/key_struct_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ronen/key_struct
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Defines KeyStruct analogous to Struct, but constructor takes keyword arguments
+test_files: 
+- spec/key_struct_spec.rb
+- spec/spec_helper.rb