blockify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8af64338fc8a469e61f4286ef0703d40d3368365
+  data.tar.gz: 667d48278b272ed5910fb3fe8afc777d13bcc2c9
+SHA512:
+  metadata.gz: f6b6f7afec83d58d134b771598b9cb69d9424842d9b1f5eaa7038dfd765757186127843300c287cfbb39dc6c1015337525281ae155473e40b4d0af9eac76ee13
+  data.tar.gz: e06d7a2a90c69ab54f032da75392a260abc49b34d61a139227a9e6a60404c2483d99f3c0506e42915d8f1bc40470f11ccc38c66b8f80112a6334bb20a2fe2514

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bryan@bdlsys.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blockify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bryan Colvin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# Blockify
+
+The `blockify` gem solves some of the problems associated with complex hierarchical nested arrays and hashes.
+It is possible to represent an HTML file as a series of Arrays and Hashes with very deep levels of Hashes within Arrays within Hashes.
+Traversing such a tree is tricky at best. The methods of the `blockify` gem are included in Array, and Hash using a naming convention
+that should not compete with anything. We don't need to concern ourselves with the complexity of the structure and can instead
+focus on the base elements wherever they may be.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blockify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blockify
+
+## Usage
+
+This first release includes a module that inserts itself with the Array and Hash classes.
+This same module could be used to service custom container classes as well so long as they look Array-like or Hash-like.
+As a practical point of view, examine the following code:
+
+```ruby
+require 'blockify'
+
+nested_thingee = [0,1,2,[3,4,5,[6,7,8,[9,10,11,12,[13,{:a=>[16,17],:b=>[18,19,20]}]]]],14,15]
+ary = nested_thingee.stringify_elements
+# ary == ["0","1","2",["3","4","5",["6","7","8",["9","10","11","12",["13",{:a=>["16","17"], :b=>["18","19","20"]}]]]],"14","15"]
+```
+We don't need to worry about what the structure is, we can traverse the entire system with a single call.
+Note that the returned structure is identical to the original.
+The `blockify` gem uses recursion to step through the entire structure. If we peek inside the `#stringify_elements` method we see this:
+
+```ruby
+  def stringify_elements
+    blockify_elements {|elm| elm.to_s}
+  end
+```
+The `#blockify_elements` method travels through the structure and calls our block whenever it encounters an element that is not an Array or a Hash.
+Whatever the block returns, the element in question will be modified with that result. In this case, each element is converted to a string.
+All the recursion magic is performed by the gem.
+
+Another tool is an element locator. This is best shown by example as follows:
+
+```ruby
+require 'blockify'
+
+nested_thingee = [0,1,2,[3,4,5,[6,7,8,[9,10,11,12,[13,{:a=>[16,17],:b=>[18,19,20]}]]]],14,15]
+path = nested_thingee.find_element_path { |t| t == 17 } # path == [3, 3, 3, 4, 1, :a, 1]
+elm = nested_thingee[3][3][3][4][1][:a][1]  # elm == 17
+
+# or easier ...
+elm = nested_thingee.path_get path          # elm == 17
+
+# and we can change it too!
+old = nested_thingee.path_put "Fred" path   # old == 17
+elm = nested_thingee.path_get path          # elm =="Fred"
+# nested_thingee == [0,1,2,[3,4,5,[6,7,8,[9,10,11,12,[13,{:a=>[16,"Fred"],:b=>[18,19,20]}]]]],14,15]
+```
+It is up to your imagination what you put in the block. When the block returns true, the recursion is done, and you get the path.
+Each method in the `blockify` gem is imported into both `Hash` and `Array`.
+The gem also includes three access methods that utilize the returned path. The above example shows two of them called `#path_put` and `#path_get`.
+Instead of searching for the first find, we have a means of finding every match as well; this is called: `#find_element_paths`.
+This methods returns an array of paths where each path is an array of indicies.
+We can access everything with `#paths_get` which will return an array of every found element.
+See the example below:
+
+```ruby
+require 'blockify'
+
+nested_thingee = [0,1,2,[13,4,15,[6,7,8,[9,10,11,12,[3,{:a=>[16,17],:b=>[18,19,20]}]]]],14,5]
+paths = nested_thingee.find_element_paths { |t| (5..15).include? t }
+paths.first  # [3,0]
+paths.last   # [5]
+paths[5]     # [3, 3, 3, 0]
+nested_thingee.path_get paths[5]  #  9
+nested_thingee.paths_get paths    #  [13, 15, 6, 7, 8, 9, 10, 11, 12, 14, 5]
+```
+
+One of the methods of of the `blockify` gem utilizes the `#find_element_path` is called `#includify?`.
+This is defined as follows:
+
+```ruby
+  def includify?(search_string)
+    path = find_element_path { |elm| elm.to_s.include? search_string }
+    !path.empty?
+  end
+```
+
+When you have a deeply nested array_hash system, the standard `#include?` method is no help.
+Instead of looking one-level deep for an exact match, `#includify?` examines each element
+until it finds what it is looking for. Internally, we are looking for a substring on one of the elements.
+See the example below:
+
+```ruby
+require 'blockify'
+
+nasty_array_hash = [{:quick=>{:a=>"tool", :b=>["xray","tent"]}, :quicker=>{:a=>:mess}, "green"=>"fox in socks", :empty=>[{}]},"fred"]
+
+nasty_array_hash.includify? "tool"   # true
+nasty_array_hash.includify? "mess"   # true
+nasty_array_hash.includify? "quick"  # false, :quick is a key, not an element
+nasty_array_hash.includify? "green"  # false, "green" is a key, not an element
+nasty_array_hash.includify? "fox"    # true, "fox" is a substring of "fox in socks"
+ep = nasty_array_hash.find_element_path { |elm| elm.to_s.include? "fox"}  # [0, "green"]
+str = nasty_array_hash.path_get ep                                        # str == "fox in socks"
+
+```
+
+The current methods for this first release are as follows:
+
+```ruby
+#  new_array_hash = ary_hash.blockify_elements { |elm| some_expression_using_elm_that_gets_saved_to_elm }
+#  ary_hash.blockify_elements! { your_block_here }  # ... self-modified ary_hash
+#  path_array = ary_hash.find_element_path { |elm| some_true_false_method_here_operating_on_elm }
+#  result = ary_hash.stringify_elements  # creates same structure with elements converted to strings
+#  ary_hash.stringify_elements!          # self-modified version of the above
+#  result = ary_hash.inspectify_elements # all elements replaced with a call to #inspect
+#  ary_hash.inspectify_elements!         # self-modified version of the above
+#  ary_hash.includify? substring         # true if substring is found in one of the elements
+#  ary_hash.find_element_paths { ... }   # returns array of found paths
+#  ary_hash.path_get path_array          # returns the element or structure found by the path array ... path_get([]) returns the entire structure
+#  ary_hash.paths_get array_paths        # paths looks like this: [[],[],[],[],...]  returns an array of each path_get
+#  ary_hash.path_put(data, path)         # replaces current path element with data, where path is an ordered list of keys
+```
+
+## Development
+
+I need to control this for the time being, so stay tuned! I will add more goodies in later releases.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "blockify"
+
+# 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

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/blockify.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blockify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blockify"
+  spec.version       = Blockify::VERSION
+  spec.authors       = ["Bryan Colvin"]
+  spec.email         = ["bryan@bdlsys.com"]
+
+  spec.summary       = %q{Hierarchical nested Hash and Array access tool}
+  spec.description   = %q{The `blockify` gem solves some of the problems associated with complex hierarchical nested arrays and hashes.
+It is possible to represent an HTML file as a series of Arrays and Hashes with very deep levels of Hashes within Arrays within Hashes.
+Traversing such a tree is tricky at best. The methods of the `blockify` gem are included in Array, and Hash using a naming convention
+that should not compete with anything. We don't need to concern ourselves with the complexity of the structure and can instead
+focus on the base elements wherever they may be.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'byebug', '~> 5.0', '>= 5.0.0'  
+end

data/lib/blockify.rb

@@ -0,0 +1,150 @@
+require "blockify/version"
+
+module Blockify
+  def blockify_elements(&block)  # blockify
+    if self.respond_to? :each_pair
+      hash = {}
+      self.each_pair do |key,val|
+        if val.respond_to? :each
+          hash[key] = val.blockify_elements &block
+        else
+          hash[key] = block.call(val)
+        end   
+      end
+      return hash
+    elsif self.respond_to? :each
+      ary = []
+      self.each do |val|
+        if val.respond_to? :each
+          ary.push val.blockify_elements &block
+        else
+          ary.push block.call(val)
+        end   
+      end
+      return ary
+    end
+    return self # should never get here
+  end
+  
+  def find_element_path(path=[],done=[false], &block)
+    if self.respond_to? :each_pair
+      self.each_pair do |key,val|
+        if val.respond_to? :each
+          path.push key
+          val.find_element_path(path, done, &block)
+          return path if done.first
+          path.pop
+        else
+          if block.call(val)
+            path.push key
+            done[0]=true
+            return path
+          end
+        end
+      end
+    elsif self.respond_to? :each
+      idx = 0
+      self.each do |val|
+        if val.respond_to? :each
+          path.push idx
+          val.find_element_path(path, done, &block)
+          return path if done.first
+          path.pop
+        else
+          if block.call(val)
+            path.push idx
+            done[0]=true
+            return path
+          end
+        end
+        idx += 1
+      end
+    end # if-else
+    return path
+  end
+
+  def find_element_paths(path=[],paths=[], &block)
+    if self.respond_to? :each_pair
+      self.each_pair do |key,val|
+        if val.respond_to? :each
+          path.push key
+          val.find_element_paths(path, paths, &block)
+          path.pop
+        else
+          if block.call(val)
+            path.push key
+            paths.push path.dup
+            path.pop
+          end
+        end
+      end
+    elsif self.respond_to? :each
+      idx = 0
+      self.each do |val|
+        if val.respond_to? :each
+          path.push idx
+          val.find_element_paths(path, paths, &block)
+          path.pop
+        else
+          if block.call(val)
+            path.push idx
+            paths.push path.dup
+            path.pop
+          end
+        end
+        idx += 1
+      end
+    end # if-else
+    return paths
+  end
+  
+  def path_get(path)
+    item = self
+    path.each do |idx|
+      item = item[idx]
+    end
+    return item
+  end
+  
+  def paths_get(paths)
+    rtn = []
+    paths.each do |path|
+      rtn.push path_get(path)
+    end
+    return rtn
+  end
+  
+  def path_put(val,path)
+    idx = path.pop
+    con = path_get(path)
+    rtn = con[idx]
+    con[idx]=val
+    path.push idx # put back
+    return rtn
+  end
+  
+  def includify?(search_string)
+    path = find_element_path { |elm| elm.to_s.include? search_string }
+    !path.empty?
+  end
+  
+  def blockify_elements!(&block)
+    replace blockify_elements &block
+  end
+  def stringify_elements
+    blockify_elements {|t| t.to_s}
+  end
+  def stringify_elements!
+    replace stringify_elements
+  end
+  def inspectify_elements
+    blockify_elements {|t| t.inspect}
+  end
+  def inspectify_elements!
+    replace inspectify_elements
+  end
+
+end # module
+
+Array.include Blockify
+Hash.include Blockify

data/lib/blockify/version.rb

@@ -0,0 +1,3 @@
+module Blockify
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: blockify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Colvin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: |-
+  The `blockify` gem solves some of the problems associated with complex hierarchical nested arrays and hashes.
+  It is possible to represent an HTML file as a series of Arrays and Hashes with very deep levels of Hashes within Arrays within Hashes.
+  Traversing such a tree is tricky at best. The methods of the `blockify` gem are included in Array, and Hash using a naming convention
+  that should not compete with anything. We don't need to concern ourselves with the complexity of the structure and can instead
+  focus on the base elements wherever they may be.
+email:
+- bryan@bdlsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blockify.gemspec
+- lib/blockify.rb
+- lib/blockify/version.rb
+homepage: 
+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: Hierarchical nested Hash and Array access tool
+test_files: []