immutable_struct 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.mdown
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Theo Hultberg
+
+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.mdown

@@ -0,0 +1,20 @@
+# ImmutableStruct
+
+An immutable implementation of Ruby's `Struct` class. It works just as Struct, but there are no setters, and you can't use `[]=`.
+
+    class Spaceship < ImmutableStruct.new(:name, :max_speed)
+    end
+    
+    ship = Spaceship.new('Enterprise', 'Warp 9')
+
+    puts ship.max_speed # => Warp 9
+    
+    ship.max_speed = '299792458 m/s' # raises NoMethodError
+    
+In addition to the above, `ImmutableStruct` enhances the constructor to accept a hash (but as you can see above the `Struct` behaviour works too):
+
+    ship = Spaceship.new(:max_speed => '∞', :name => 'The TARDIS')
+    
+    puts ship.max_speed # => ∞
+    
+I'm surprised every time I look at the RDoc for `Struct` that it doesn't do this.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+
+begin
+  require 'lib/immutable_struct'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'immutable_struct'
+    gem.summary = %Q{An immutable version of Ruby's Struct class}
+    gem.description = %Q{An immutable implementation of Ruby's `Struct` class. It works just as Struct, but there are no setters, and you can't use `[]=`. As a bonus feature the constructor of classes inheriting from ImmutableStruct can take named parameters in the form of a hash.}
+    gem.email = 'theo@iconara.net'
+    gem.homepage = 'http://github.com/iconara/immutable_struct'
+    gem.authors = ['Theo Hultberg']
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    gem.add_development_dependency 'yard', '>= 0'
+    gem.version = ImmutableStruct::VERSION
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort 'YARD is not available. In order to run yardoc, you must: sudo gem install yard'
+  end
+end

data/lib/immutable_struct.rb

@@ -0,0 +1,40 @@
+class ImmutableStruct
+  VERSION = '1.0.1'
+  
+  def self.new(*attrs)
+    struct = Struct.new(*attrs)
+    make_immutable!(struct)
+    optionalize_constructor!(struct)
+    struct
+  end
+  
+private
+
+  def self.make_immutable!(struct)
+    struct.send(:undef_method, "[]=".to_sym)
+    struct.members.each do |member|
+      struct.send(:undef_method, "#{member}=".to_sym)
+    end
+  end
+  
+  def self.optionalize_constructor!(struct)
+    struct.class_eval do
+      alias_method :struct_initialize, :initialize
+
+      def initialize(*attrs)
+        if attrs && attrs.size == 1 && attrs.first.is_a?(Hash)
+          struct_initialize(*members.map { |m| attrs.first[m.to_sym] })
+        else
+          struct_initialize(*attrs)
+        end
+      end
+      
+      def to_h
+        members.inject({}) do |h, m|
+          h[m.to_sym] = self[m]
+          h
+        end
+      end
+    end
+  end
+end

data/spec/immutable_struct_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+
+describe ImmutableStruct do
+  
+  class ImmutableItem < ImmutableStruct.new(:a, :b); end
+  
+  it 'can be used as a superclass just like Struct' do
+    obj = ImmutableItem.new(1, 2)
+    obj.a.should == 1
+  end
+  
+  it 'creates no setters' do
+    obj = ImmutableItem.new(1, 2)
+    running { obj.a = 3 }.should raise_error
+  end
+  
+  it 'does not allow [] to be used to mutate the instance' do
+    obj = ImmutableItem.new(1, 2)
+    running { obj[:a] = 3 }.should raise_error
+  end
+  
+  it 'creates a constructor that works like the one Struct creates' do
+    obj = ImmutableItem.new(1, 2)
+    obj.a.should == 1
+    obj.b.should == 2
+    obj = ImmutableItem.new(1)
+    obj.a.should == 1
+    obj.b.should == nil
+  end
+  
+  it 'creates a constructor that takes a hash' do
+    obj = ImmutableItem.new(:a => 1, :b => 2)
+    obj.a.should == 1
+    obj.b.should == 2
+    obj = ImmutableItem.new(:b => 2)
+    obj.a.should == nil
+    obj.b.should == 2
+  end
+  
+  it 'adds #to_h that returns a hash representation of the object' do
+    obj = ImmutableItem.new(:a => 1, :b => 2)
+    obj.to_h.should have_key(:a)
+    obj.to_h.should have_key(:b)
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'spec'
+require 'spec/autorun'
+
+require 'immutable_struct'
+
+
+alias :running :lambda
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: immutable_struct
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Theo Hultberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: An immutable implementation of Ruby's `Struct` class. It works just as Struct, but there are no setters, and you can't use `[]=`. As a bonus feature the constructor of classes inheriting from ImmutableStruct can take named parameters in the form of a hash.
+email: theo@iconara.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.mdown
+- Rakefile
+- lib/immutable_struct.rb
+- spec/immutable_struct_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/iconara/immutable_struct
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An immutable version of Ruby's Struct class
+test_files: 
+- spec/immutable_struct_spec.rb
+- spec/spec_helper.rb