black_hole_struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73a1e2099462587da0f479f244188535c3a237bd
+  data.tar.gz: e664723785a1fee9b05b29593a1ee481743d2298
+SHA512:
+  metadata.gz: 54e70fa218aacd903f040a52112eaad60eb22e1561c6ffd502e6dc5ed53100967bc20e955d9fd93e3b53d3839751fe8fce3b0f2b8c0bda785ce5327a663d6eb7
+  data.tar.gz: 017822bce9972ef9cb83d7b6ed052eea09678ce9cd69bb33e7a5e6551be5262613d78384758d72d29a682b4decb5e1602655c304262890b9e35651070e8e246b

data/README.md

@@ -0,0 +1,37 @@
+# BlackHoleStruct
+
+**BlackHoleStruct** is a data structure similar to an `OpenStruct`, that allows
+infinite chaining of attributes or [autovivification](https://en.wikipedia.org/wiki/Autovivification).  
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem "black-hole-struct"
+```
+
+Or install the gem manually:
+
+```sh
+$ gem install black-hole-struct
+```
+
+## Basic Usage
+
+```ruby
+require "black_hole_struct"
+
+config = BlackHoleStruct.new
+config.dashboard.theme = "white"
+config.dashboard.time.from = "now-1h"
+config.dashboard.time.to = "now"
+
+puts config.dashboard.theme      # "white"
+puts config.dashboard.time       # #<BlackHoleStruct :from="now-1h" :to="now">
+puts config.dashboard.time.from  # "now-1h"
+```
+
+### Advanced usage
+
+Check the [documentation](http://www.rubydoc.info/github/mickey/black-hole-struct/master/BlackHoleStruct).

data/lib/black_hole_struct.rb

@@ -0,0 +1,103 @@
+# *BlackHoleStruct* is a data structure similar to an OpenStruct, that allows
+# infinite chaining of attributes or [autovivification](https://en.wikipedia.org/wiki/Autovivification).
+class BlackHoleStruct
+  # Current version
+  VERSION = "0.1.0"
+
+  # BlackHoleStruct can be optionally initialized with a Hash
+  # @param [Hash] hash Initialize with a hash
+  # @return [BlackHoleStruct]
+  def initialize(hash = {})
+    raise ArgumentError, "Argument should be a Hash" unless hash.is_a?(Hash)
+
+    @table = {}
+    hash.each do |key, value|
+      value = self.class.new(value) if value.is_a?(Hash)
+      @table[key.to_sym] = value
+    end
+  end
+
+  # Retrieves the value object corresponding to the key symbol.
+  # @param [Symbol] key
+  # @return the value object or a BlackHoleStruct if nothing was found
+  def [](key)
+    method_missing(key)
+  end
+
+  # Associates the value given by value with the key given by key.
+  # @param [Symbol] key
+  # @param value
+  # @return the value
+  def []=(key, value)
+    method_missing("#{key}=", value)
+  end
+
+  # Two BlackHoleStruct are equal if they each contain the same number of keys
+  # and if each key-value pair is equal to the corresponding elements in
+  # the other BlackHoleStruct.
+  # @param [BlackHoleStruct]
+  # @return [Boolean]
+  def ==(other)
+    other.is_a?(self.class) && self.to_h == other.to_h
+  end
+  alias :eql? :==
+
+  # Deletes the key-value pair and returns the value from hsh whose key is equal to key.
+  # If the key is not found, returns an instance of BlackHoleStruct.
+  # @param [Symbol] key
+  def delete_field(key)
+    @table[key.to_sym] = self.class.new
+  end
+
+  # Calls block once for each key in hsh, passing the key-value pair as parameters.
+  # if no block is given, an Enumerator is returned instead.
+  # @yield [key, value]
+  def each_pair
+    @table.each_pair
+  end
+
+  # Adds the contents of other_hash to hsh.
+  # If no block is specified, entries with duplicate keys are overwritten with the values from other_hash,
+  # otherwise the value of each duplicate key is determined by calling the block with the key,
+  # its value in hsh and its value in other_hash.
+  # @param [Hash] other_hash
+  # @return the final hash
+  def merge!(other_hash)
+    # no deep merge
+    @table = self.to_h.merge!(other_hash)
+  end
+  alias :update :merge!
+
+  # Converts self to the hash
+  # @return [Hash]
+  def to_h
+    hash = {}
+    @table.each do |key, value|
+      hash[key] = value.is_a?(self.class) ? value.to_h : value
+    end
+    hash
+  end
+
+  # Return the contents of this instance as a string.
+  # @return [String]
+  def inspect
+    "#<#{self.class}"
+      .concat(@table.map { |k, v| " :#{k}=#{v.inspect}" }.join(" "))
+      .concat(">")
+  end
+  alias :to_s :inspect
+
+  private
+
+  def method_missing(name, *args)
+    if @table[name.to_sym]
+      @table[name.to_sym]
+    else
+      if name[-1] == "="
+        @table[name[0..-2].to_sym] = args.first
+      else
+        @table[name.to_sym] = self.class.new
+      end
+    end
+  end
+end

data/test/black_hole_struct_test.rb

@@ -0,0 +1,106 @@
+require File.expand_path('../../lib/black_hole_struct', __FILE__)
+require 'minitest/autorun'
+
+class BlackHoleStructTest < Minitest::Test
+  def setup
+    @subject = BlackHoleStruct.new
+  end
+
+  def test_instanciate_without_arguments
+    assert_instance_of BlackHoleStruct, @subject
+  end
+
+  def test_accessor
+    @subject.theme = "white"
+    assert_equal @subject.theme, "white"
+    assert_equal @subject[:theme], "white"
+
+    @subject[:theme] = "black"
+    assert_equal @subject.theme, "black"
+    assert_equal @subject[:theme], "black"
+  end
+
+  def test_missing_values
+    assert_instance_of BlackHoleStruct, @subject.missing
+  end
+
+  def test_nested_accessor
+    @subject.dashboard.theme = "white"
+    assert_equal @subject.dashboard.theme, "white"
+    assert_equal @subject[:dashboard][:theme], "white"
+
+    @subject[:dashboards][:theme] = "black"
+    assert_equal @subject.dashboards.theme, "black"
+    assert_equal @subject[:dashboards][:theme], "black"
+  end
+
+  def test_equality
+    @subject.dashboard.theme = "white"
+    other = BlackHoleStruct.new
+    other.dashboard.theme = "white"
+    assert_equal @subject, other
+    assert_equal @subject.eql?(other), true
+  end
+
+  def test_instanciate_with_arguments
+    assert_raises ArgumentError do
+      BlackHoleStruct.new(Array.new)
+    end
+
+    subject = BlackHoleStruct.new(theme: "white")
+    assert_equal subject.theme, "white"
+
+    subject = BlackHoleStruct.new(dashboard: {theme: "white"})
+    assert_equal subject.dashboard.theme, "white"
+  end
+
+  def test_delete_field
+    @subject.theme = "white"
+    @subject.delete_field(:theme)
+    assert_equal @subject.theme, BlackHoleStruct.new
+
+    @subject.dashboard.theme = "white"
+    @subject.delete_field(:dashboard)
+    assert_equal @subject.dashboard, BlackHoleStruct.new
+    assert_equal @subject.dashboard.theme, BlackHoleStruct.new
+
+    assert_equal @subject.delete_field(:missing), BlackHoleStruct.new
+  end
+
+  def test_each_pair
+    assert_kind_of Enumerator, @subject.each_pair
+
+    @subject.theme = "white"
+    assert_equal @subject.each_pair.to_a, [[:theme, "white"]]
+
+    @subject.each_pair do |key, value|
+      assert_equal key, :theme
+      assert_equal value, "white"
+    end
+  end
+
+  def test_to_h
+    @subject.dashboard.theme = "white"
+    @subject.host = "127.0.0.1"
+
+    assert_equal @subject.to_h, {
+      dashboard: {theme: "white"},
+      host: "127.0.0.1"
+    }
+  end
+
+  def test_merge
+    @subject.theme = "white"
+    @subject.merge!(size: 5)
+
+    assert_equal @subject.to_h, {
+      theme: "white", size: 5
+    }
+  end
+
+  def test_inspect
+    assert_equal @subject.inspect, '#<BlackHoleStruct>'
+    @subject.theme = "white"
+    assert_equal @subject.inspect, '#<BlackHoleStruct :theme="white">'
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: black_hole_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bensoussan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: yard
+  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: BlackHoleStruct is a data structure similar to an OpenStruct allowing
+  autovivification.
+email:
+- mbensoussan.is@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/black_hole_struct.rb
+- test/black_hole_struct_test.rb
+homepage: https://github.com/mickey/black_hole_struct
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: BlackHoleStruct is a data structure
+test_files:
+- test/black_hole_struct_test.rb