rubysl-ostruct 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25ef06576d34ac774a46a52f900e3b3057d0e9d5
-  data.tar.gz: 365deda9a3abdef2615f0057f3e0a7f229a7f24b
+  metadata.gz: c12ce42389ead852a5244a59e2fe7d438d304cf8
+  data.tar.gz: 4b56e31554e57999035e36558074638397ac0468
 SHA512:
-  metadata.gz: bdce30cac56bc487845665ef339d436dcc8147be59bbb9587c2b1a1a2a7aad5486153869a72a05533ad29db3b26ee715f08d853633a3f241af9f6bf898f4ad53
-  data.tar.gz: 407fe1f2dba5e83592e9701eefa25bf429534676db0d9ab297c948cf7e559f14b22522c724a2c2d418c0671480597fa8ab2741fdf12c4b8ccd4b11a88b85ecfb
+  metadata.gz: f05918ea27221e21c2a35c65a0583b0bcbc969270b1345cf5685a45efd122c55a5ecf2f4a4dd1deda9a0de90f9df25a67600a0f2b512ca44f93c568b4b8ea83e
+  data.tar.gz: 04ab76f6dadd4019e8b9ca33b5fc7e049368fa67ca8cc3cf63b26c61876f165956f0f4dfb03de562ecd33aba9b81612944011e74c3038cdda0ff8bba6815bd56

data/.travis.yml

@@ -1,6 +1,14 @@
 language: ruby
 env:
   - RUBYLIB=lib
-script: bundle exec mspec spec
+  - RUBYLIB=
+script: mspec spec
 rvm:
-  - rbx-nightly-19mode
+  - 2.0.0
+  - rbx-2.2.1
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      env: RUBYLIB=lib
+    - rvm: rbx-2.2.1
+      env: RUBYLIB=

data/MRI_LICENSE

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/lib/rubysl/ostruct/ostruct.rb

@@ -30,12 +30,6 @@
 # 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>
 #
@@ -67,8 +61,8 @@
 #
 # == 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
+# An OpenStruct utilizes Ruby's method lookup structure to 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
@@ -80,7 +74,8 @@ class OpenStruct
   # 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.
+  # The optional +hash+, if given, will generate attributes and values
+  # (can be a Hash, an OpenStruct or a Struct).
   # For example:
   #
   #   require 'ostruct'
@@ -89,16 +84,10 @@ class OpenStruct
   #
   #   p data        # -> <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>
-  #
   def initialize(hash=nil)
     @table = {}
     if hash
-      for k,v in hash
+      hash.each_pair do |k, v|
         @table[k.to_sym] = v
         new_ostruct_member(k)
       end
@@ -115,37 +104,39 @@ class OpenStruct
   #
   # Converts the OpenStruct to a hash with keys representing
   # each attribute (as symbols) and their corresponding values
+  # Example:
+  #
+  #   require 'ostruct'
+  #   data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
+  #   data.to_h   # => {:country => "Australia", :population => 20000000 }
+  #
   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.
+  # Yields all attributes (as a symbol) along with the corresponding values
+  # or returns an enumerator if not block is given.
+  # Example:
   #
-  #    require 'ostruct'
+  #   require 'ostruct'
+  #   data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
+  #   data.each_pair.to_a  # => [[:country, "Australia"], [:population, 20000000]]
   #
-  #    person = OpenStruct.new
-  #    person.name = 'John Smith'
-  #    person.age  = 70
+  def each_pair
+    return to_enum __method__ unless block_given?
+    @table.each_pair { |p| yield p }
+  end
+
   #
-  #    person.marshal_dump # => { :name => 'John Smith', :age => 70 }
+  # Provides marshalling support for use by the Marshal library.
   #
   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'
+  # Provides marshalling support for use by the Marshal library.
   #
   def marshal_load(x)
     @table = x
@@ -153,8 +144,8 @@ class OpenStruct
   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.
+  # Used internally to check if the OpenStruct is able to be
+  # modified before granting access to the internal Hash table to be modified.
   #
   def modifiable
     begin
@@ -167,39 +158,58 @@ class OpenStruct
   protected :modifiable
 
   #
-  # new_ostruct_member is used internally to defined properties on the
+  # 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.
+  # define_singleton_method for both the getter method and the setter method.
   #
   def new_ostruct_member(name)
     name = name.to_sym
-    unless self.respond_to?(name)
-      class << self; self; end.class_eval do
-        define_method(name) { @table[name] }
-        define_method("#{name}=") { |x| modifiable[name] = x }
-      end
+    unless respond_to?(name)
+      define_singleton_method(name) { @table[name] }
+      define_singleton_method("#{name}=") { |x| modifiable[name] = x }
     end
     name
   end
+  protected :new_ostruct_member
 
   def method_missing(mid, *args) # :nodoc:
     mname = mid.id2name
     len = args.length
-    if mname.chomp!('=') && mid != :[]=
+    if mname.chomp!('=')
       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 && mid != :[]
+    elsif len == 0
       @table[mid]
     else
       raise NoMethodError, "undefined method `#{mid}' for #{self}", caller(1)
     end
   end
 
+  # Returns the value of a member.
   #
-  # Remove the named field from the object. Returning the value that the field
-  # contained if it has defined.
+  #   person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
+  #   person[:age] # => 70, same as ostruct.age
+  #
+  def [](name)
+    @table[name.to_sym]
+  end
+
+  #
+  # Sets the value of a member.
+  #
+  #   person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
+  #   person[:age] = 42 # => equivalent to ostruct.age = 42
+  #   person.age # => 42
+  #
+  def []=(name, value)
+    modifiable[new_ostruct_member(name)] = value
+  end
+
+  #
+  # Remove the named field from the object. Returns the value that the field
+  # contained if it was defined.
   #
   #   require 'ostruct'
   #
@@ -209,8 +219,8 @@ class OpenStruct
   #
   def delete_field(name)
     sym = name.to_sym
-    @table.delete sym
     singleton_class.__send__(:remove_method, sym, "#{name}=")
+    @table.delete sym
   end
 
   InspectKey = :__inspect_key__ # :nodoc:
@@ -246,11 +256,28 @@ class OpenStruct
 
   #
   # 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
+  # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
   # equal.
   #
   def ==(other)
-    return false unless(other.kind_of?(OpenStruct))
-    return @table == other.table
+    return false unless other.kind_of?(OpenStruct)
+    @table == other.table
+  end
+
+  #
+  # Compares this object and +other+ for equality.  An OpenStruct is eql? to
+  # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
+  # eql?.
+  #
+  def eql?(other)
+    return false unless other.kind_of?(OpenStruct)
+    @table.eql?(other.table)
+  end
+
+  # Compute a hash-code for this OpenStruct.
+  # Two hashes with the same content will have the same hash code
+  # (and will be eql?).
+  def hash
+    @table.hash
   end
 end

data/lib/rubysl/ostruct/version.rb

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

data/rubysl-ostruct.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 2.0"
 end

data/spec/each_pair_spec.rb

@@ -0,0 +1,19 @@
+require 'ostruct'
+
+describe "OpenStruct#each_pair" do
+  before :each do
+    @os = OpenStruct.new("a" => 1, :b => 2)
+  end
+
+  it "returns an enumerator if no block given" do
+    enum = @os.each_pair
+    enum.should be_an_instance_of(enumerator_class)
+    enum.to_a.should == [[:a, 1], [:b, 2]]
+  end
+
+  it "yields the key and value of each pair to a block expecting |key, value|" do
+    all_args = []
+    @os.each_pair { |key, value| all_args << [key, value] }
+    all_args.sort.should == [[:a, 1], [:b, 2]]
+  end
+end

data/spec/element_reference_spec.rb

@@ -2,19 +2,14 @@ require "ostruct"
 
 describe "OpenStruct#[]" do
   before :each do
-    @os = OpenStruct.new
+    @os = OpenStruct.new(:foo => 42)
   end
 
-  ruby_version_is ""..."2.0" do
-    it "raises a NoMethodError" do
-      lambda { @os[:foo] }.should raise_error(NoMethodError)
-    end
+  it "returns the associated value using a symbol" do
+    @os[:foo].should == 42
   end
 
-  ruby_version_is "2.0" do
-    it "returns the associated value" do
-      @os.foo = 42
-      @os[:foo].should == 42
-    end
+  it "returns the associated value using a string" do
+    @os["foo"].should == 42
   end
 end

data/spec/element_set_spec.rb

@@ -2,20 +2,26 @@ require "ostruct"
 
 describe "OpenStruct#[]=" do
   before :each do
-    @os = OpenStruct.new
+    @os = OpenStruct.new(:bar => 100)
   end
 
-  ruby_bug "redmine:4179", "1.9.2" do
-    ruby_version_is ""..."2.0" do
-      it "raises a NoMethodError" do
-        lambda { @os[:foo] = 2 }.should raise_error(NoMethodError)
-      end
-    end
-    ruby_version_is "2.0" do
-      it "sets the associated value" do
-        @os[:foo] = 42
-        @os.foo.should == 42
-      end
-    end
+  it "sets the associated value using a symbol" do
+    @os[:foo] = 42
+    @os.foo.should == 42
+  end
+
+  it "sets the associated value using a string" do
+    @os["foo"] = 42
+    @os.foo.should == 42
+  end
+
+  it "updates the associated value using a symbol" do
+    @os[:bar] = 42
+    @os.bar.should == 42
+  end
+
+  it "updates the associated value using a string" do
+    @os["bar"] = 42
+    @os.bar.should == 42
   end
 end

data/spec/eql_spec.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+
+describe "OpenStruct#eql?" do
+  before :each do
+    @os = OpenStruct.new(:a => 1, :b => 2)
+  end
+
+  it "returns true when the passed argument is an OpenStruct and contains the same hash table" do
+    os2 = OpenStruct.new(:a => 1, :b => 2)
+    @os.should eql(os2)
+  end
+
+  it "returns false when the passed argument is an OpenStruct and contains a different hash table" do
+    os2 = OpenStruct.new(:a => 2, :b => 2)
+    @os.should_not eql(os2)
+  end
+
+  it "returns false when the passed argument isn't an OpenStruct" do
+    h = {:a => 1, :b => 2}
+    @os.should_not eql(h)
+  end
+end

data/spec/hash_spec.rb

@@ -0,0 +1,19 @@
+require 'ostruct'
+
+describe "OpenStruct#hash" do
+  before :each do
+    @os  = OpenStruct.new(:a => 1)
+    @os2 = OpenStruct.new
+  end
+
+  it "returns a fixnum" do
+    @os.hash.should be_an_instance_of(Fixnum)
+  end
+
+  it "returns the same fixnum for OpenStruct with the same content" do
+    @os.hash.should_not == @os2.hash
+
+    @os2.a = 1
+    @os.hash.should == @os2.hash
+  end
+end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-ostruct
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-07 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
+  type: :development
+  prerelease: false
   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
+  type: :development
+  prerelease: false
   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: mspec
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubysl-prettyprint
   type: :development
   prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 description: Ruby standard library ostruct.
 email:
 - brixen@gmail.com
@@ -59,10 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
+- MRI_LICENSE
 - README.md
 - Rakefile
 - lib/ostruct.rb
@@ -71,11 +86,14 @@ files:
 - lib/rubysl/ostruct/version.rb
 - rubysl-ostruct.gemspec
 - spec/delete_field_spec.rb
+- spec/each_pair_spec.rb
 - spec/element_reference_spec.rb
 - spec/element_set_spec.rb
+- spec/eql_spec.rb
 - spec/equal_value_spec.rb
 - spec/fixtures/classes.rb
 - spec/frozen_spec.rb
+- spec/hash_spec.rb
 - spec/initialize_copy_spec.rb
 - spec/initialize_spec.rb
 - spec/inspect_spec.rb
@@ -98,27 +116,30 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby standard library ostruct.
 test_files:
 - spec/delete_field_spec.rb
+- spec/each_pair_spec.rb
 - spec/element_reference_spec.rb
 - spec/element_set_spec.rb
+- spec/eql_spec.rb
 - spec/equal_value_spec.rb
 - spec/fixtures/classes.rb
 - spec/frozen_spec.rb
+- spec/hash_spec.rb
 - spec/initialize_copy_spec.rb
 - spec/initialize_spec.rb
 - spec/inspect_spec.rb
@@ -131,4 +152,3 @@ test_files:
 - spec/table_spec.rb
 - spec/to_h_spec.rb
 - spec/to_s_spec.rb
-has_rdoc: