object_graph_traverser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1c832a8577d709ac324e78bacbd57656708845a
+  data.tar.gz: 17440f93f631733cc13103c3930e130c302f314b
+SHA512:
+  metadata.gz: 931b04d08b333ca185a0070aeae0728dbdffe9280ff8c8d1ff4af8572185e402542cd828995bd0ab0d555f9a8fa11a4d4748bba0bc88141f45f28d41f29dc2c1
+  data.tar.gz: c788739d6a3762d8765a1fa024faa64778d58c161ae9d0e9f0c6bfb72cc89826c88b87dd99e4c21709d67917ad0da6bd30466a148c6290ca0e0ad5f507e94c8d

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 3.2.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,86 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    builder (3.2.2)
+    coderay (1.1.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.0)
+    highline (1.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.2.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  pry
+  rdoc (~> 3.12)
+  rspec (~> 3.2.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Optoro
+
+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,57 @@
+object_graph_traverser
+======================
+
+This gem will allow you traverse an object graph, executing arbitrary code at each node.
+
+Example:
+
+```ruby
+class Team
+  attr_accessor :name, :players
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+class Player < Team; end
+
+foo  = Team.new('Foo')
+bob  = Player.new('Bob')
+jane = Player.new('Jane')
+
+foo.players = [bob, jane]
+
+ogt = ObjectGraphTraverser.new('Team' => ['players'])
+
+names = []
+
+ogt.traverse_graph(foo) do |obj, parent, nodes|
+  names << obj.name
+end
+
+names # ["Foo", "Bob", "Jane"]
+```
+
+Contributing to object_graph_traverser
+--------------------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+
+* Fork the project.
+
+* Start a feature/bugfix branch.
+
+* Commit and push until you are happy with your contribution.
+
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+Copyright
+---------
+
+Copyright © 2015 Optoro. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "object_graph_traverser"
+  gem.homepage = "http://github.com/optoro/object_graph_traverser"
+  gem.license = "MIT"
+  gem.summary = %Q{A small class for traversing object graphs.}
+  gem.description = %Q{A small class for traversing object graphs.}
+  gem.authors = ["Jeffrey Gillis", "Ben Smith"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "object_graph_traverser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/object_graph_traverser.rb

@@ -0,0 +1,36 @@
+class ObjectGraphTraverser
+
+  # Params:
+  # +object_graph+:: a hash of class name => association pairs, e.g.
+  #   { 'Foo' => ['bars'], 'Bar' => ['baz'] }
+  def initialize(object_graph)
+    @graph = object_graph
+  end
+
+  # Given a starting object, traverses the graph calling the given block on each node.
+  #
+  # Params:
+  # +object+:: root object from which to start traversing
+  # +parent+:: optional parent object
+  # +block+:: a block that will be called on each node, receiving the node, its parent and the graph of objects under the current node.
+  def traverse_graph(object,parent=nil,&block)
+    nodes = fetch_object_graph(object.class).map do |node|
+      Array(object.send(node.to_sym)).each do |node_object|
+        traverse_graph(node_object,object,&block)
+      end
+      node
+    end
+    block.call(object,parent,nodes)
+  end
+
+  private
+
+  def fetch_object_graph(klass)
+    nodes = @graph.fetch(klass.name) {[]}
+    if nodes.empty? && klass.superclass
+      nodes = fetch_object_graph(klass.superclass)
+    end
+    nodes
+  end
+
+end

data/object_graph_traverser.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: object_graph_traverser 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "object_graph_traverser"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Jeffrey Gillis", "Ben Smith"]
+  s.date = "2015-02-24"
+  s.description = "A small class for traversing object graphs."
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/object_graph_traverser.rb",
+    "object_graph_traverser.gemspec",
+    "spec/object_graph_traverser_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/bar.rb",
+    "spec/support/baz.rb",
+    "spec/support/foo.rb"
+  ]
+  s.homepage = "http://github.com/optoro/object_graph_traverser"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5"
+  s.summary = "A small class for traversing object graphs."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 3.2.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 3.2.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 3.2.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/spec/object_graph_traverser_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe ObjectGraphTraverser do
+  let(:graph) do
+    {
+      "Foo" => [
+        "bars"
+      ],
+      "Bar" => [
+        "baz"
+      ]
+    }
+  end
+
+  let(:foo) do
+    Foo.new
+  end
+
+  let(:traverser) do
+    ObjectGraphTraverser.new(graph)
+  end
+
+  describe "visited objects" do
+    subject do
+      visited = []
+      traverser.traverse_graph(foo) do |obj, parent, nodes|
+        visited << obj
+      end
+      visited
+    end
+
+    it "visited some nodes" do
+      expect(subject.length > 3)
+    end
+
+    it "visits the foo" do
+      expect(subject.include?(foo)).to eq(true)
+    end
+
+    it "visits the foo's bars" do
+      foo.bars.each do |bar|
+        expect(subject.include?(bar)).to eq(true)
+      end
+    end
+
+    it "visits the foo's bars' bazs" do
+      foo.bars.each do |bar|
+        expect(subject.include?(bar.baz)).to eq(true)
+      end
+    end
+  end
+
+  describe "parents of visited objects" do
+    subject do
+      parents = []
+      traverser.traverse_graph(foo) do |obj, parent, nodes|
+        parents << parent
+      end
+      parents
+    end
+
+    it "contain the root node" do
+      expect(subject).to include(foo)
+    end
+
+    it "contains the middle nodes" do
+      foo.bars.each do |bar|
+        expect(subject).to include(bar)
+      end
+    end
+
+    it "doesn't contain the leaves" do
+      foo.bars.each do |bar|
+        expect(subject).not_to include(bar.baz)
+      end
+    end
+  end
+
+  describe "nodes (child associations)" do
+    subject do
+      all_nodes = []
+      traverser.traverse_graph(foo) do |obj, parent, nodes|
+        all_nodes << nodes
+      end
+      all_nodes.flatten
+    end
+
+    it "contains Strings" do
+      expect(subject.first).to be_a(String)
+    end
+
+    it "has the name of the association of an object to its child" do
+      %w[bars baz].each do |name|
+        expect(subject).to include(name)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'object_graph_traverser'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/support/bar.rb

@@ -0,0 +1,7 @@
+class Bar
+  attr_reader :baz
+
+  def initialize
+    @baz = Baz.new
+  end
+end

data/spec/support/baz.rb

@@ -0,0 +1,2 @@
+class Baz
+end

data/spec/support/foo.rb

@@ -0,0 +1,7 @@
+class Foo
+  attr_reader :bars
+
+  def initialize
+    @bars = [Bar.new, Bar.new]
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: object_graph_traverser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeffrey Gillis
+- Ben Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: pry
+  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: A small class for traversing object graphs.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/object_graph_traverser.rb
+- object_graph_traverser.gemspec
+- spec/object_graph_traverser_spec.rb
+- spec/spec_helper.rb
+- spec/support/bar.rb
+- spec/support/baz.rb
+- spec/support/foo.rb
+homepage: http://github.com/optoro/object_graph_traverser
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A small class for traversing object graphs.
+test_files: []