hash_dial 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a2e69ddcb5f84bef6fa164953fa3a127396568cd91ee1debbad926902e29df3
+  data.tar.gz: efa91b61097992c4b3a57545d9cb64af8cd4a9fa924277e2c5f1af60f967e1bb
+SHA512:
+  metadata.gz: b776b72153e96ff264e3c859cb1a12b37a06d8baa3538735e34dcffb8331780597ed119cc032c11ccdb70379f45f888ec497b09c417aeab794cc5917c29660ae
+  data.tar.gz: 4c38e006c1140bb59afc72e2fadb347e40887c49e5b7274d59e2b9cef1c33e54fde80ff475944ed9bb541ddc296ccad9a0ff61a6d86b413993e1ef03dded41a9

data/.gitignore

@@ -0,0 +1,17 @@
+.git
+.env
+*.lnk
+*.db
+*.ini
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.17.2

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 hash_dial.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    hash_dial (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  hash_dial!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,79 @@
+# HashDial
+
+**Avoid all errors when accessing a deeply nested Hash key.** HashDial goes one step beyond Hash::dig() by returning nil (or your default) if the keys requested are invalid for any reason.
+
+In particular, if you try to access a key on a value that isn't a hash, dig() will cause an error where HashDial will not.
+
+```ruby
+hash = {a: {b: {c: true}, d: 5}}
+hash.dig( :a, :d, :c) #=> TypeError: Integer does not have #dig method
+hash.call(:a, :d, :c) #=> nil
+hash.call(:a, :b, :c) #=> true
+```
+
+**Bonus: you don't even need to fiddle with existing code.** If you have already written something to access a deep hash key, just surround this with `dial` and `call` (rather than changing it to the form above as function parameters).
+
+```ruby
+ hash[:a][:d][:c] #=> TypeError: no implicit conversion of Symbol into Integer
+#hash →   [:a][:d][:c]
+#     ↓                ↓
+ hash.dial[:a][:d][:c].call #=> nil
+```
+
+## Explanation
+
+We use the concept of placing a phone-call: you can 'dial' any set of keys regardless of whether they exist (like entering a phone number), then finally place the 'call'. If the key is invalid for any reason you get nil/default (like a wrong number); otherwise you get the value (you're connected).
+
+This works by intermediating your request with a HashDialler object. Trying to access keys on this object simply builds up a list of keys to use when you later place the 'call'.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_dial'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_dial
+
+## Usage
+
+```ruby
+require 'hash_dial'
+```
+
+### Use it like dig()
+
+If you want to follow this pattern, it works in the same way. You can't change the default return value when using this pattern.
+
+```ruby
+hash.call(:a, :b, :c) #=> Returns the value at hash[:a][:b][:c] or nil
+```
+
+### Use it like a Hash -- allows default return value
+
+```ruby
+hash.dial[:a][:b][:c].call #=> Returns the value at hash[:a][:b][:c] or nil
+hash.dial[:a][:b][:c].call('Ooops') #=> Returns the value at hash[:a][:b][:c] or 'Ooops'
+```
+
+If you don't do this all in one line, you can access the HashDialler object should you want to manipulate it:
+
+```ruby
+dialler = hash.dial # Returns a HashDialler object referencing hash
+dialler[:a] # Adds :a to the list of keys to dial (returns self)
+dialler.dial!(:b, :c) # Longhand way of adding more keys (returns self)
+dialler.undial! # Removes the last-added key (returns self)
+dialler[:c][:d] # Adds two more keys (returns self)
+dialler += :e # Adds yet one more (returns self)
+dialler -= :a # Removes all such keys from the list (returns self)
+# So far we have dialled [:b][:c][:d][:e]
+dialler.call #=> Returns the value at hash[:b][:c][:d][:e] or nil
+dialler.hangup #=> Returns the original hash by reference
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hash_dial"
+
+# 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/hash_dial.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hash_dial/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_dial"
+  spec.version       = HashDial::VERSION
+  spec.authors       = ["Convincible"]
+  spec.email         = ["development@convincible.media"]
+
+  spec.summary       = "Access (deeply nested) hash keys. Get the value, or nil on any error. (Even safer than Hash::dig)."
+  spec.description   = "Avoid all errors when accessing a (deeply nested) Hash key. HashDial goes one step beyond Hash::dig() by returning nil (or your default) if the keys requested are invalid for any reason at all. Bonus: you don't even need to fiddle with existing code. If you have already written something to access a deep hash key, just surround this with '.dial' and '.call'."
+  spec.homepage      = "https://github.com/ConvincibleMedia/hash_dial"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hash_dial.rb

@@ -0,0 +1,20 @@
+require "hash_dial/version"
+require "hash_dial/hash_dialler"
+
+module HashDial
+
+    def to_dial(*lookup)
+        return HashDialler.new(self, *lookup)
+    end
+
+    alias_method :dial, :to_dial
+
+    def call(*lookup)
+        return HashDialler.new(self, *lookup).call
+    end
+
+end
+
+class Hash
+    include HashDial
+end

data/lib/hash_dial/hash_dialler.rb

@@ -0,0 +1,61 @@
+module HashDial
+
+	class HashDialler
+
+		@hash
+		@lookup
+		@default = nil
+
+		def initialize(hash, *lookup)
+			if hash.is_a?(Hash)
+				@hash = hash
+			else
+				@hash = {}
+			end
+			@lookup = []
+			if lookup.length > 0
+				dial!(*lookup)
+			end
+		end
+
+		def dial!(*keys)
+			#unless key.is_a(Symbol) || key.is_a(String)
+			@lookup += keys
+			return self
+		end
+
+		def call(default = nil)
+			begin
+				value = @hash.dig(*@lookup)
+			rescue
+				value = default
+			end
+			return value
+		end
+
+		def hangup
+			return @hash
+		end
+
+		def undial!(*keys)
+			if keys.length > 0
+				@lookup -= keys
+			elsif @lookup.length > 0
+				@lookup.pop
+			end
+			return self
+		end
+
+		def [](key)
+			return dial!(key)
+		end
+		def +(key)
+			return dial!(key)
+		end
+		def -(key)
+			return undial!(key)
+		end
+
+	end
+
+end

data/lib/hash_dial/version.rb

@@ -0,0 +1,3 @@
+module HashDial
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hash_dial
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Convincible
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Avoid all errors when accessing a (deeply nested) Hash key. HashDial
+  goes one step beyond Hash::dig() by returning nil (or your default) if the keys
+  requested are invalid for any reason at all. Bonus: you don''t even need to fiddle
+  with existing code. If you have already written something to access a deep hash
+  key, just surround this with ''.dial'' and ''.call''.'
+email:
+- development@convincible.media
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hash_dial.gemspec
+- lib/hash_dial.rb
+- lib/hash_dial/hash_dialler.rb
+- lib/hash_dial/version.rb
+homepage: https://github.com/ConvincibleMedia/hash_dial
+licenses: []
+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: []
+rubygems_version: 3.0.0
+signing_key: 
+specification_version: 4
+summary: Access (deeply nested) hash keys. Get the value, or nil on any error. (Even
+  safer than Hash::dig).
+test_files: []