ostruct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d125c51b4a6541c0dcb5422065b685c156e847218380e2c01f1ef8fac08e40dc
+  data.tar.gz: 7c5aa451998687071f22794e2e24ea644e7a6698e4eebe608ccd42a6cdf3199c
+SHA512:
+  metadata.gz: c58234c3f25e5eee4f47faf91c0016051e9bd72016d38a54248b1695424016d4cb46be9a09ef29837cd268cac57f0c7eebe1e5c330d218c580b304f1210764bc
+  data.tar.gz: 3698d2ab77b8c9904b43143795226e9f3abce36a55fc2923fc7ed65f4cf48d60790ec55e2f43d6bfb75c0f010aa23b32c08d73c00f6468420f4fc8131dce22dc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+  - ruby-head
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ostruct.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,69 @@
+# OpenStruct
+
+An OpenStruct is a data structure, similar to a Hash, that allows the definition of arbitrary attributes with their ccompanying values. This is accomplished by using Ruby's metaprogramming to define methods on the class itself.
+
+## Installation
+
+The `ostruct` library comes pre-packaged with Ruby. No installation is necessary.
+
+## Usage
+
+```
+  require "ostruct"
+
+  person = OpenStruct.new
+  person.name = "John Smith"
+  person.age  = 70
+
+  person.name      # => "John Smith"
+  person.age       # => 70
+  person.address   # => nil
+```
+
+An OpenStruct employs a Hash internally to store the attributes and values and can even be initialized with one:
+
+```
+  australia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
+    # => #<OpenStruct country="Australia", capital="Canberra">
+```
+
+Hash keys with spaces or characters that could normally not be used for method calls (e.g. <code>()[]*</code>) will not be immediately available on the OpenStruct object as a method for retrieval or assignment, but can still be reached through the Object#send method.
+
+```
+  measurements = OpenStruct.new("length (in inches)" => 24)
+  measurements.send("length (in inches)")   # => 24
+
+  message = OpenStruct.new(:queued? => true)
+  message.queued?                           # => true
+  message.send("queued?=", false)
+  message.queued?                           # => false
+```
+
+Removing the presence of an attribute requires the execution of the delete_field method as setting the property value to +nil+ will not remove the attribute.
+
+```
+  first_pet  = OpenStruct.new(:name => "Rowdy", :owner => "John Smith")
+  second_pet = OpenStruct.new(:name => "Rowdy")
+
+  first_pet.owner = nil
+  first_pet                 # => #<OpenStruct name="Rowdy", owner=nil>
+  first_pet == second_pet   # => false
+
+  first_pet.delete_field(:owner)
+  first_pet                 # => #<OpenStruct name="Rowdy">
+  first_pet == second_pet   # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/ostruct.
+
+## License
+
+The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test" << "test/lib"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :default => [:test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ostruct"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ostruct.rb

@@ -0,0 +1,369 @@
+# frozen_string_literal: true
+#
+# = ostruct.rb: OpenStruct implementation
+#
+# Author:: Yukihiro Matsumoto
+# Documentation:: Gavin Sinclair
+#
+# OpenStruct allows the creation of data objects with arbitrary attributes.
+# See OpenStruct for an 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.
+#
+# == Examples
+#
+#   require "ostruct"
+#
+#   person = OpenStruct.new
+#   person.name = "John Smith"
+#   person.age  = 70
+#
+#   person.name      # => "John Smith"
+#   person.age       # => 70
+#   person.address   # => nil
+#
+# An OpenStruct employs a Hash internally to store the attributes and values
+# and can even be initialized with one:
+#
+#   australia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
+#     # => #<OpenStruct country="Australia", capital="Canberra">
+#
+# Hash keys with spaces or characters that could normally not be used for
+# method calls (e.g. <code>()[]*</code>) will not be immediately available
+# on the OpenStruct object as a method for retrieval or assignment, but can
+# still be reached through the Object#send method.
+#
+#   measurements = OpenStruct.new("length (in inches)" => 24)
+#   measurements.send("length (in inches)")   # => 24
+#
+#   message = OpenStruct.new(:queued? => true)
+#   message.queued?                           # => true
+#   message.send("queued?=", false)
+#   message.queued?                           # => false
+#
+# Removing the presence of an attribute requires the execution of the
+# delete_field method as setting the property value to +nil+ will not
+# remove the attribute.
+#
+#   first_pet  = OpenStruct.new(:name => "Rowdy", :owner => "John Smith")
+#   second_pet = OpenStruct.new(:name => "Rowdy")
+#
+#   first_pet.owner = nil
+#   first_pet                 # => #<OpenStruct name="Rowdy", owner=nil>
+#   first_pet == second_pet   # => false
+#
+#   first_pet.delete_field(:owner)
+#   first_pet                 # => #<OpenStruct name="Rowdy">
+#   first_pet == second_pet   # => true
+#
+#
+# == Implementation
+#
+# An OpenStruct utilizes Ruby's method lookup structure to find and define the
+# necessary methods for properties. This is accomplished through the methods
+# method_missing and define_singleton_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
+
+  #
+  # 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
+  # (can be a Hash, an OpenStruct or a Struct).
+  # For example:
+  #
+  #   require "ostruct"
+  #   hash = { "country" => "Australia", :capital => "Canberra" }
+  #   data = OpenStruct.new(hash)
+  #
+  #   data   # => #<OpenStruct country="Australia", capital="Canberra">
+  #
+  def initialize(hash=nil)
+    @table = {}
+    if hash
+      hash.each_pair do |k, v|
+        k = k.to_sym
+        @table[k] = v
+      end
+    end
+  end
+
+  # Duplicates an OpenStruct object's Hash table.
+  def initialize_copy(orig) # :nodoc:
+    super
+    @table = @table.dup
+  end
+
+  #
+  # Converts the OpenStruct to a hash with keys representing
+  # each attribute (as symbols) and their corresponding values.
+  #
+  #   require "ostruct"
+  #   data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
+  #   data.to_h   # => {:country => "Australia", :capital => "Canberra" }
+  #
+  def to_h
+    @table.dup
+  end
+
+  #
+  # :call-seq:
+  #   ostruct.each_pair {|name, value| block }  -> ostruct
+  #   ostruct.each_pair                         -> Enumerator
+  #
+  # Yields all attributes (as symbols) along with the corresponding values
+  # or returns an enumerator if no block is given.
+  #
+  #   require "ostruct"
+  #   data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
+  #   data.each_pair.to_a   # => [[:country, "Australia"], [:capital, "Canberra"]]
+  #
+  def each_pair
+    return to_enum(__method__) { @table.size } unless block_given?
+    @table.each_pair{|p| yield p}
+    self
+  end
+
+  #
+  # Provides marshalling support for use by the Marshal library.
+  #
+  def marshal_dump
+    @table
+  end
+
+  #
+  # Provides marshalling support for use by the Marshal library.
+  #
+  def marshal_load(x)
+    @table = x
+  end
+
+  #
+  # 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? # :nodoc:
+    begin
+      @modifiable = true
+    rescue
+      exception_class = defined?(FrozenError) ? FrozenError : RuntimeError
+      raise exception_class, "can't modify frozen #{self.class}", caller(3)
+    end
+    @table
+  end
+  private :modifiable?
+
+  # ::Kernel.warn("do not use OpenStruct#modifiable", uplevel: 1)
+  alias modifiable modifiable? # :nodoc:
+  protected :modifiable
+
+  #
+  # Used internally to defined properties on the
+  # OpenStruct. It does this by using the metaprogramming function
+  # define_singleton_method for both the getter method and the setter method.
+  #
+  def new_ostruct_member!(name) # :nodoc:
+    name = name.to_sym
+    unless singleton_class.method_defined?(name)
+      define_singleton_method(name) { @table[name] }
+      define_singleton_method("#{name}=") {|x| modifiable?[name] = x}
+    end
+    name
+  end
+  private :new_ostruct_member!
+
+  # ::Kernel.warn("do not use OpenStruct#new_ostruct_member", uplevel: 1)
+  alias new_ostruct_member new_ostruct_member! # :nodoc:
+  protected :new_ostruct_member
+
+  def freeze
+    @table.each_key {|key| new_ostruct_member!(key)}
+    super
+  end
+
+  def respond_to_missing?(mid, include_private = false) # :nodoc:
+    mname = mid.to_s.chomp("=").to_sym
+    @table&.key?(mname) || super
+  end
+
+  def method_missing(mid, *args) # :nodoc:
+    len = args.length
+    if mname = mid[/.*(?==\z)/m]
+      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 # and /\A[a-z_]\w*\z/ =~ mid #
+      if @table.key?(mid)
+        new_ostruct_member!(mid) unless frozen?
+        @table[mid]
+      end
+    else
+      begin
+        super
+      rescue NoMethodError => err
+        err.backtrace.shift
+        raise
+      end
+    end
+  end
+
+  #
+  # :call-seq:
+  #   ostruct[name]  -> object
+  #
+  # Returns the value of an attribute.
+  #
+  #   require "ostruct"
+  #   person = OpenStruct.new("name" => "John Smith", "age" => 70)
+  #   person[:age]   # => 70, same as person.age
+  #
+  def [](name)
+    @table[name.to_sym]
+  end
+
+  #
+  # :call-seq:
+  #   ostruct[name] = obj  -> obj
+  #
+  # Sets the value of an attribute.
+  #
+  #   require "ostruct"
+  #   person = OpenStruct.new("name" => "John Smith", "age" => 70)
+  #   person[:age] = 42   # equivalent to person.age = 42
+  #   person.age          # => 42
+  #
+  def []=(name, value)
+    modifiable?[new_ostruct_member!(name)] = value
+  end
+
+  #
+  # :call-seq:
+  #   ostruct.dig(name, ...)  -> object
+  #
+  # Extracts the nested value specified by the sequence of +name+
+  # objects by calling +dig+ at each step, returning +nil+ if any
+  # intermediate step is +nil+.
+  #
+  #   require "ostruct"
+  #   address = OpenStruct.new("city" => "Anytown NC", "zip" => 12345)
+  #   person  = OpenStruct.new("name" => "John Smith", "address" => address)
+  #
+  #   person.dig(:address, "zip")            # => 12345
+  #   person.dig(:business_address, "zip")   # => nil
+  #
+  #   data = OpenStruct.new(:array => [1, [2, 3]])
+  #
+  #   data.dig(:array, 1, 0)   # => 2
+  #   data.dig(:array, 0, 0)   # TypeError: Integer does not have #dig method
+  #
+  def dig(name, *names)
+    begin
+      name = name.to_sym
+    rescue NoMethodError
+      raise TypeError, "#{name} is not a symbol nor a string"
+    end
+    @table.dig(name, *names)
+  end
+
+  #
+  # Removes the named field from the object. Returns the value that the field
+  # contained if it was defined.
+  #
+  #   require "ostruct"
+  #
+  #   person = OpenStruct.new(name: "John", age: 70, pension: 300)
+  #
+  #   person.delete_field("age")   # => 70
+  #   person                       # => #<OpenStruct name="John", pension=300>
+  #
+  # Setting the value to +nil+ will not remove the attribute:
+  #
+  #   person.pension = nil
+  #   person                 # => #<OpenStruct name="John", pension=nil>
+  #
+  def delete_field(name)
+    sym = name.to_sym
+    begin
+      singleton_class.remove_method(sym, "#{sym}=")
+    rescue NameError
+    end
+    @table.delete(sym) do
+      raise NameError.new("no field `#{sym}' in #{self}", sym)
+    end
+  end
+
+  InspectKey = :__inspect_key__ # :nodoc:
+
+  #
+  # Returns a string containing a detailed summary of the keys and values.
+  #
+  def inspect
+    ids = (Thread.current[InspectKey] ||= [])
+    if ids.include?(object_id)
+      detail = ' ...'
+    else
+      ids << object_id
+      begin
+        detail = @table.map do |key, value|
+          " #{key}=#{value.inspect}"
+        end.join(',')
+      ensure
+        ids.pop
+      end
+    end
+    ['#<', self.class, detail, '>'].join
+  end
+  alias :to_s :inspect
+
+  attr_reader :table # :nodoc:
+  protected :table
+  alias table! table
+
+  #
+  # Compares this object and +other+ for equality.  An OpenStruct is equal to
+  # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
+  # equal.
+  #
+  #   require "ostruct"
+  #   first_pet  = OpenStruct.new("name" => "Rowdy")
+  #   second_pet = OpenStruct.new(:name  => "Rowdy")
+  #   third_pet  = OpenStruct.new("name" => "Rowdy", :age => nil)
+  #
+  #   first_pet == second_pet   # => true
+  #   first_pet == third_pet    # => false
+  #
+  def ==(other)
+    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
+
+  # Computes a hash code for this OpenStruct.
+  # Two OpenStruct objects with the same content will have the same hash code
+  # (and will compare using #eql?).
+  #
+  # See also Object#hash.
+  def hash
+    @table.hash
+  end
+end

data/ostruct.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "ostruct"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Marc-Andre Lafortune"]
+  spec.email         = ["ruby-core@marc-andre.ca"]
+
+  spec.summary       = %q{Class to build custom data structures, similar to a Hash.}
+  spec.description   = %q{Class to build custom data structures, similar to a Hash.}
+  spec.homepage      = "https://github.com/ruby/ostruct"
+  spec.license       = "BSD-2-Clause"
+
+  spec.files         = [".gitignore", ".travis.yml", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/ostruct.rb", "ostruct.gemspec"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: ostruct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc-Andre Lafortune
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Class to build custom data structures, similar to a Hash.
+email:
+- ruby-core@marc-andre.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ostruct.rb
+- ostruct.gemspec
+homepage: https://github.com/ruby/ostruct
+licenses:
+- BSD-2-Clause
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Class to build custom data structures, similar to a Hash.
+test_files: []