rubysl-ostruct 1.0.0 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cec4600c9a826de169dba5d1d1fc1001deb47131
-  data.tar.gz: 2c55660cb71f7a1e0e4f0def92394ad110403c65
+  metadata.gz: 25ef06576d34ac774a46a52f900e3b3057d0e9d5
+  data.tar.gz: 365deda9a3abdef2615f0057f3e0a7f229a7f24b
 SHA512:
-  metadata.gz: eadd488f253fda93f4bbe152d78c4e1b197d80f64da0b1cd0ab8edfbc58564641ca5161ee01fef51791ee746212dd68d8a7f10504b53ea6e88578605eddcf609
-  data.tar.gz: bd53d995542bf0d11e579abfd4b219ef6565b2384f449468efe22cd3a92f943534889ed66814b9b243b91ca9906467d5e5d051cd3a51c010234fea3d02eb0473
+  metadata.gz: bdce30cac56bc487845665ef339d436dcc8147be59bbb9587c2b1a1a2a7aad5486153869a72a05533ad29db3b26ee715f08d853633a3f241af9f6bf898f4ad53
+  data.tar.gz: 407fe1f2dba5e83592e9701eefa25bf429534676db0d9ab297c948cf7e559f14b22522c724a2c2d418c0671480597fa8ab2741fdf12c4b8ccd4b11a88b85ecfb

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 env:
   - RUBYLIB=lib
-script: bundle exec mspec
+script: bundle exec mspec spec
 rvm:
-  - 1.8.7
-  - rbx-nightly-18mode
+  - rbx-nightly-19mode

data/lib/rubysl/ostruct/ostruct.rb

@@ -9,31 +9,79 @@
 #
 
 #
-# OpenStruct allows you to create data objects and set arbitrary attributes.
-# For example:
+# An OpenStruct is a data structure, similar to a Hash, that allows the
+# definition of arbitrary attributes with their accompanying values. This is
+# accomplished by using Ruby's metaprogramming to define methods on the class
+# itself.
 #
-#   require 'ostruct' 
+# == Examples:
 #
-#   record = OpenStruct.new
-#   record.name    = "John Smith"
-#   record.age     = 70
-#   record.pension = 300
-#   
-#   puts record.name     # -> "John Smith"
-#   puts record.address  # -> nil
+#   require 'ostruct'
 #
-# It is like a hash with a different way to access the data.  In fact, it is
-# implemented with a hash, and you can initialize it with one.
+#   person = OpenStruct.new
+#   person.name    = "John Smith"
+#   person.age     = 70
+#   person.pension = 300
 #
-#   hash = { "country" => "Australia", :population => 20_000_000 }
-#   data = OpenStruct.new(hash)
+#   puts person.name     # -> "John Smith"
+#   puts person.age      # -> 70
+#   puts person.address  # -> nil
 #
-#   p data        # -> <OpenStruct country="Australia" population=20000000>
+# An OpenStruct employs a Hash internally to store the methods and values and
+# can even be initialized with one:
+#
+#   country_data = { :country => "Australia", :population => 20_000_000 }
+#   australia = OpenStruct.new(country_data)
+#   p australia   # -> <OpenStruct country="Australia" population=20000000>
+#
+# You may also define the hash in the initialization call:
+#
+#   australia = OpenStruct.new(:country => "Australia", :population => 20_000_000)
+#   p australia   # -> <OpenStruct country="Australia" population=20000000>
+#
+# Hash keys with spaces or characters that would normally not be able to use for
+# method calls (e.g. ()[]*) will not be immediately available on the
+# OpenStruct object as a method for retrieval or assignment, but can be still be
+# reached through the Object#send method.
+#
+#   measurements = OpenStruct.new("length (in inches)" => 24)
+#   measurements.send("length (in inches)")  # -> 24
+#
+#   data_point = OpenStruct.new(:queued? => true)
+#   data_point.queued?                       # -> true
+#   data_point.send("queued?=",false)
+#   data_point.queued?                       # -> false
+#
+# Removing the presence of a method requires the execution the delete_field
+# method as setting the property value to +nil+ will not remove the method.
+#
+#   first_pet = OpenStruct.new(:name => 'Rowdy', :owner => 'John Smith')
+#   first_pet.owner = nil
+#   second_pet = OpenStruct.new(:name => 'Rowdy')
+#
+#   first_pet == second_pet   # -> false
+#
+#   first_pet.delete_field(:owner)
+#   first_pet == second_pet   # -> true
+#
+#
+# == Implementation:
+#
+# An OpenStruct utilizes Ruby's method lookup structure to and find and define
+# the necessary methods for properties. This is accomplished through the method
+# method_missing and define_method.
+#
+# This should be a consideration if there is a concern about the performance of
+# the objects that are created, as there is much more overhead in the setting
+# of these properties compared to using a Hash or a Struct.
 #
 class OpenStruct
   #
-  # Create a new OpenStruct object.  The optional +hash+, if given, will
-  # generate attributes and values.  For example.
+  # Creates a new OpenStruct object.  By default, the resulting OpenStruct
+  # object will have no attributes.
+  #
+  # The optional +hash+, if given, will generate attributes and values.
+  # For example:
   #
   #   require 'ostruct'
   #   hash = { "country" => "Australia", :population => 20_000_000 }
@@ -41,7 +89,11 @@ class OpenStruct
   #
   #   p data        # -> <OpenStruct country="Australia" population=20000000>
   #
-  # By default, the resulting OpenStruct object will have no attributes. 
+  # You may also define the hash in the initialization call:
+  #
+  #   australia = OpenStruct.new(:country => "Australia",
+  #                              :population => 20_000_000)
+  #   p australia   # -> <OpenStruct country="Australia" population=20000000>
   #
   def initialize(hash=nil)
     @table = {}
@@ -53,28 +105,72 @@ class OpenStruct
     end
   end
 
-  # Duplicate an OpenStruct object members. 
+  # Duplicate an OpenStruct object members.
   def initialize_copy(orig)
     super
     @table = @table.dup
+    @table.each_key { |key| new_ostruct_member(key) }
+  end
+
+  #
+  # Converts the OpenStruct to a hash with keys representing
+  # each attribute (as symbols) and their corresponding values
+  def to_h
+    @table.dup
   end
 
+  #
+  # Provides marshalling support for use by the Marshal library. Returning the
+  # underlying Hash table that contains the functions defined as the keys and
+  # the values assigned to them.
+  #
+  #    require 'ostruct'
+  #
+  #    person = OpenStruct.new
+  #    person.name = 'John Smith'
+  #    person.age  = 70
+  #
+  #    person.marshal_dump # => { :name => 'John Smith', :age => 70 }
+  #
   def marshal_dump
     @table
   end
+
+  #
+  # Provides marshalling support for use by the Marshal library. Accepting
+  # a Hash of keys and values which will be used to populate the internal table
+  #
+  #    require 'ostruct'
+  #
+  #    event = OpenStruct.new
+  #    hash = { 'time' => Time.now, 'title' => 'Birthday Party' }
+  #    event.marshal_load(hash)
+  #    event.title # => 'Birthday Party'
+  #
   def marshal_load(x)
     @table = x
     @table.each_key{|key| new_ostruct_member(key)}
   end
 
+  #
+  # #modifiable is used internally to check if the OpenStruct is able to be
+  # modified before granting access to the internal Hash table to be augmented.
+  #
   def modifiable
-    if self.frozen?
-      raise TypeError, "can't modify frozen #{self.class}", caller(2)
+    begin
+      @modifiable = true
+    rescue
+      raise TypeError, "can't modify frozen #{self.class}", caller(3)
     end
     @table
   end
   protected :modifiable
 
+  #
+  # new_ostruct_member is used internally to defined properties on the
+  # OpenStruct. It does this by using the metaprogramming function
+  # define_method for both the getter method and the setter method.
+  #
   def new_ostruct_member(name)
     name = name.to_sym
     unless self.respond_to?(name)
@@ -89,23 +185,32 @@ class OpenStruct
   def method_missing(mid, *args) # :nodoc:
     mname = mid.id2name
     len = args.length
-    if mname.chomp!('=') && mname != "[]"
+    if mname.chomp!('=') && mid != :[]=
       if len != 1
         raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
       end
       modifiable[new_ostruct_member(mname)] = args[0]
-    elsif len == 0
+    elsif len == 0 && mid != :[]
       @table[mid]
     else
-      raise NoMethodError, "undefined method `#{mname}' for #{self}", caller(1)
+      raise NoMethodError, "undefined method `#{mid}' for #{self}", caller(1)
     end
   end
 
   #
-  # Remove the named field from the object.
+  # Remove the named field from the object. Returning the value that the field
+  # contained if it has defined.
+  #
+  #   require 'ostruct'
+  #
+  #   person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
+  #
+  #   person.delete_field('name')  # => 'John Smith'
   #
   def delete_field(name)
-    @table.delete name.to_sym
+    sym = name.to_sym
+    @table.delete sym
+    singleton_class.__send__(:remove_method, sym, "#{name}=")
   end
 
   InspectKey = :__inspect_key__ # :nodoc:
@@ -140,7 +245,9 @@ class OpenStruct
   protected :table
 
   #
-  # Compare this object and +other+ for equality.
+  # Compares this object and +other+ for equality.  An OpenStruct is equal to
+  # +other+ when +other+ is an OpenStruct and the two object's Hash tables are
+  # equal.
   #
   def ==(other)
     return false unless(other.kind_of?(OpenStruct))

data/lib/rubysl/ostruct/version.rb

@@ -1,5 +1,5 @@
 module RubySL
-  module OpenStruct
-    VERSION = "1.0.0"
+  class OpenStruct
+    VERSION = "2.0.4"
   end
 end

data/rubysl-ostruct.gemspec

@@ -16,6 +16,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-ostruct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.4
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: Ruby standard library ostruct.
 email:
 - brixen@gmail.com
@@ -84,9 +98,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ~>
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -117,3 +131,4 @@ test_files:
 - spec/table_spec.rb
 - spec/to_h_spec.rb
 - spec/to_s_spec.rb
+has_rdoc: