ListBrowser 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Aldric Giacomoni
+
+ 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.rdoc

@@ -0,0 +1,26 @@
+~~~~ ListBrowser README ~~~~
+
+I was working on a parser for a very specific tree structure, and was frustrated
+that there wasn't a simple way to parse it in irb. "What??", I thought. "I have
+to use my brain?! God forbid!".
+So I set to using my brain a little more to create this tool. It's not much,
+but maybe it'll make someone's life a little easier.
+
+It can be used in irb, and really should be used there - when you call it on
+a tree structure, you'll get a menu with a list of choices on how you want to
+go through whatever structure you gave it.
+
+In my particular, special case, I would do something like this:
+
+require 'sgf_parser' # For my tree structure
+require 'list_browser' # For this.
+
+tree = SgfParser::Tree.new :filename => "kogo.sgf"
+
+ListBrowser.new tree.root, 'parent', 'children', 'properties'
+
+# And follow the menu!
+
+ In my particular case, I would not need to enter those strings, as they
+ just happen to be the names I chose for my tree structure, but they should
+ serve as a good enough example!

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/list_browser.rb

@@ -0,0 +1,86 @@
+# A class to browse tree structures.
+# When creating the object, you have one required attribute and three optional
+# attributes:
+# node (the node where you wish to start browsing, usually the root of the tree)
+#
+# parent (the name of the method used to get to the parent)
+#
+# children (the name of the method used to get to the children)
+#
+# properties (the name of the method used to get to properties)
+class ListBrowser
+
+  attr_accessor :node, :parent, :children, :properties
+
+  def initialize node, parent='parent', children='children', properties='properties'
+    @node = node
+    @parent = parent.to_sym
+    @children = children.to_sym
+    @properties = properties.to_sym
+    puts @node.send(@properties)
+    generate_menu
+  end
+
+  # Call this method to go to the current node's parent
+  def parent
+    unless @node.send(@parent).nil?
+      @node = @node.send(@parent)
+    end
+  end
+
+  # Call this method, with a number between 0 and the size of the array of
+  # children -1 (if there are three children, between 0 and 2), to go to
+  # the current node's child.
+  def child number
+    unless @node.send(@children).nil?
+      @node = ( ( @node.send(@children) ).at(number) )
+    end
+  end
+
+  private
+
+  def generate_menu
+    input = nil
+    until ['q', 'Q'].include? input
+      input = nil
+      @menu = "Press Q to quit.\n"
+      count = '1'
+      @node.send(@children).each do 
+        @menu << "#{count}. Go to child ##{count}.\n"
+        count.succ!
+      end
+      @menu << "#{count}. Go to parent.\n"
+      @menu << "#{count.succ}. Print current node's properties again.\n"
+
+      choices = ['q', 'Q'] + ('1'..count.succ).to_a
+      while !choices.include?(input)
+        puts @menu
+        input = gets.chomp
+      end
+      case input
+        when 'q', 'Q'
+          leave
+        when count
+          parent
+        when count.succ
+          puts @node.send(@properties)
+        else
+          child input.to_i - 1
+      end
+    end
+  end
+
+  def print_properties
+    properties = @node.send(@properties)
+    keylength = properties.max {|a, b| a.size }
+    #valuelength = properties.max {|a, b| b.size}
+    properties.each do |k, v|
+      puts "#{k.ljust(keylength)} => #{v}"
+    end
+  end
+
+  def leave
+    # AND DON'T COME BACK!
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ListBrowser'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: ListBrowser
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aldric Giacomoni
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 -05:00
+default_executable: list_browser.rb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: ListBrowser allows you to navigate non-obvious structures like linked lists.
+email: aldric@trevoke.net
+executables: 
+- list_browser.rb
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- VERSION
+- bin/list_browser.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/Trevoke/ListBrowser
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A tool to browse tree structures.
+test_files: 
+- spec/spec_helper.rb