enumerable_deep_search 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', version: 2, cli: '--color --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anthony Cook
+
+MIT License
+
+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,46 @@
+# EnumerableDeepSearch
+
+Recursively searches enumerable objects and their nested objects for a given object or string.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumerable_deep_search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerable_deep_search
+
+## Usage
+
+In practice it's an exploration tool, I recommend using it with pry and extending objects as needed.
+You can also include it on a class and use it the same way on instances.
+
+example:
+
+```ruby
+object.extend EnumerableDeepSearch
+object.search 'something'
+```
+
+It will return a facimile of the path to the matching object, for hash-like objects it will return a Hash containg the match as well as the opposite pair (either the key or the value), for array-like objects it will return a two element Array where the first element is the index of the match and second element the match itself.
+
+example:
+
+```ruby
+object.search 'something'
+#=> {:foo => [1, 'something']}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/enumerable_deep_search.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumerable_deep_search/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "enumerable_deep_search"
+  gem.version       = EnumerableDeepSearch::VERSION
+  gem.authors       = ["Anthony Cook"]
+  gem.email         = ["anthonymichaelcook@gmail.com"]
+  gem.description   = %q{Recursively searches enumerable objects and their nested objects for a given object or string.}
+  gem.summary       = %q{Recursively searches through enumerable objects.}
+  gem.homepage      = "https://github.com/acook/enumerable_deep_search"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  %w{
+    rspec guard-rspec pry pry-nav pry-doc pry-theme pry-coolline pry-highlight pry-buffers
+  }.each do |g|
+    gem.add_development_dependency g
+  end
+end

data/lib/enumerable_deep_search.rb

@@ -0,0 +1,100 @@
+require_relative 'enumerable_deep_search/version'
+
+module EnumerableDeepSearch
+  def search item
+    research self, item
+  end
+
+  def out *args
+    puts "-- #{args.join(' ')}" if $VERBOSE || $DEBUG
+  end
+
+  def research object, item
+    if simple_research object, item then
+      out '# simple objects match'
+      object
+    elsif object.respond_to? :keys then
+      out 'keys'
+      hash_research object, item
+    elsif object.respond_to? :each then
+      out 'each'
+      array_research object, item
+    elsif object.respond_to? :to_hash then
+      out 'convert to hash'
+      research object.to_hash, item
+    elsif object.respond_to? :to_a then
+      out 'convert to array'
+      research object.to_a, item
+    else
+      out 'other:', object.class
+      other_research object, item
+    end
+  end
+
+  def hash_research object, item
+    out 'hash'
+
+    match = nil
+    object.find do |key, value|
+      match = research key, item
+      if match then
+        out '# match found (hash key):', key
+        match = {match => value}
+      else
+        out 'no match (hash key):', key
+        match = research value, item
+        match = {key => match} if match
+      end
+    end
+
+    if match then
+      out '# match:', match
+    else
+      out 'no match'
+    end
+    match
+  end
+
+  def array_research object, item
+    out 'array'
+    match = nil
+    object.each_with_index do |element, index|
+      match = research(element, item)
+      if match then
+        match = [index, match]
+      end
+    end
+
+    if match then
+      out '# match found:', match
+    else
+      out 'no match'
+    end
+    match
+  end
+
+  def simple_research object, item
+    if object == item then
+      out '# objects match'
+      object
+    elsif object.to_s == item.to_s then
+      out '# object strings match'
+      object
+    end
+  end
+
+  def other_research object, item
+    if simple_research object, item then
+      out '# simple match found'
+      object
+    elsif item.is_a?(Regexp) && object.to_s =~ item then
+      out '# regex match found'
+      object
+    elsif object.to_s =~ /#{item.to_s}/ then
+      out '# substring match found'
+      object
+    else
+      out 'no match:', object.class
+    end
+  end
+end

data/lib/enumerable_deep_search/version.rb

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

data/spec/enumerable_deep_search_spec.rb

@@ -0,0 +1,92 @@
+require_relative 'spec_helper'
+require 'enumerable_deep_search'
+
+describe EnumerableDeepSearch do
+  let(:eds){Object.new.extend EnumerableDeepSearch}
+
+  it 'should exist' do
+    subject.should be
+  end
+
+  it 'should define methods on objects it extends' do
+    class DummyClass; end
+    dummy = DummyClass.new
+    dummy.extend EnumerableDeepSearch
+    dummy.should respond_to(:search)
+  end
+
+  describe '#search' do
+    it 'should proxy to research' do
+      eds.should_receive(:research)
+      eds.search :foo
+    end
+  end
+
+  describe '#research' do
+    context 'simple object matching' do
+      it 'should match identical objects' do
+        object = Object.new
+        result = eds.research object, object
+        result.should == object
+      end
+
+      it 'should match keys in a hash' do
+        hash = {'match' => 'bar'}
+        result = eds.research hash, 'match'
+        result.should == hash
+      end
+
+      it 'should match values in a hash' do
+        hash = {foo: 'match'}
+        result = eds.research hash, 'match'
+        result.should == hash
+      end
+
+      it 'should match values in an array' do
+        array = ['match']
+        result = eds.research array, 'match'
+        result.should == [0, 'match']
+      end
+    end
+
+    context 'nested structures' do
+      it 'should match values in nested hashes' do
+        hash = {foo: {bar: 'match'}}
+        result = eds.research hash, 'match'
+        result.should == hash
+      end
+
+      it 'should match keys in nested hashes' do
+        hash = {foo: {'match' => 1}}
+        result = eds.research hash, 'match'
+        result.should == hash
+      end
+
+      it 'should match elements in nested array' do
+        array = [:foo, [:bar, 'match']]
+        result = eds.research array, 'match'
+        result.should == [1, [1, 'match']]
+      end
+
+      it 'should match objects in mixed hashes and arrays' do
+        struture = [:foo, {bar: [1,2,3,{baz: 'match'}]}]
+        result = eds.research struture, 'match'
+        result.should == [1, {:bar=>[3, {:baz=>"match"}]}]
+      end
+    end
+
+    context 'matching enumerable objects' do
+      it 'should match full arrays' do
+        array = [1]
+        result = eds.research array, array
+        result.should == array
+      end
+
+      it 'should match full hashes' do
+        hash = {a: 1}
+        result = eds.research hash, hash
+        result.should == hash
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$: << File.dirname(__FILE__)
+$: << File.join($:.last, '..', 'lib')
+
+require 'bundler'
+Bundler.require :test
+require 'pry'
+
+def run *args
+  output = Struct.new :pid, :stdout, :stderr
+
+  status = Open4.popen4(*args) do |pid, stdin, stdout, stderr|
+    output = output.new pid, stdout.read, stderr.read
+  end
+
+  [status, output]
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: enumerable_deep_search
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Anthony Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-theme
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-highlight
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-buffers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Recursively searches enumerable objects and their nested objects for
+  a given object or string.
+email:
+- anthonymichaelcook@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enumerable_deep_search.gemspec
+- lib/enumerable_deep_search.rb
+- lib/enumerable_deep_search/version.rb
+- spec/enumerable_deep_search_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/acook/enumerable_deep_search
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Recursively searches through enumerable objects.
+test_files:
+- spec/enumerable_deep_search_spec.rb
+- spec/spec_helper.rb
+has_rdoc: