treerepl 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Jeffrey Palm
+
+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

@@ -0,0 +1,11 @@
+Provides a way to create command line itnerfaces for web services with
+inherent tree-like structure.  There are two examples:
+
+ - githubrepl
+ - rdiorepl
+
+They both require some other libraries.  The basic idea is this:
+ 
+ 1. Define the tree model for your service
+ 2. Define the mapping from tree to service
+ 3. See the example and go from there

data/lib/treerepl.rb

@@ -0,0 +1,30 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# stdlib
+require 'logger'
+
+# internal requires
+require 'treerepl/tree'
+require 'treerepl/cmds'
+require 'treerepl/repl'
+
+module TreeRepl
+  VERSION = '0.0.1'
+
+
+  class << self
+    attr_accessor :debug
+    attr_accessor :logger
+    def log(str)
+      logger.debug { str }
+    end
+  end
+  self.debug = false
+
+  @logger ||= ::Logger.new(STDERR)
+
+  def self.version
+    VERSION
+  end
+
+end

data/lib/treerepl/cmds.rb

@@ -0,0 +1,156 @@
+module TreeRepl
+
+  class Cmd
+    attr_reader :repl,:name
+    def initialize(repl,name)
+      @repl = repl
+      @name = name
+    end
+    def help
+      raise 'Implement help()'
+    end
+    def exec(args)
+      raise 'Implement exec(string[])'
+    end
+  end
+
+  class Ls < Cmd
+    def initialize(repl)
+      super(repl,'ls')
+    end
+    def exec(args)
+      def ls_print(n,prefix=nil)
+        def pr(s,prefix)
+          if prefix
+            puts File.join prefix,s
+          else
+            puts s
+          end
+        end
+        puts if prefix
+        ['.','..'].each do |s|
+          pr s,prefix
+        end
+        n.children.each do |node|
+          pr node.name,prefix
+        end
+      end
+      args = ['.'] if args.empty?
+      args.uniq!
+      args.each do |path|
+        n = repl.eval_path repl.cur,path
+        if n
+          prefix = args.length > 1 ? path : nil
+          ls_print n,prefix
+        end
+      end
+    end
+    def help
+      'List directory'
+    end
+  end
+
+  class Cd < Cmd
+    def initialize(repl)
+      super(repl,'cd')
+    end
+    def exec(args)
+      args = ['/'] if args.empty?
+      path = args.join ' '
+      n = repl.eval_path repl.cur,path
+      repl.cur = n if n
+    end
+    def help
+      'Change directory'
+    end
+  end
+
+  class Pwd < Cmd
+    def initialize(repl)
+      super(repl,'pwd')
+    end
+    def exec(args)
+      puts cwd
+    end
+    def help
+      'Print the current working directory'
+    end
+  end
+  
+  class Help < Cmd
+    def initialize(repl)
+      super(repl,'help')
+    end
+    def help
+      'Print this message'
+    end
+    def exec(args)
+      puts 'Commands:'
+      repl.commands.sort {|a,b| a.name <=> b.name}.each do |cmd|
+        printf " %-10s %s\n",cmd.name,cmd.help
+      end
+    end
+  end
+
+  class Quit < Cmd
+    def initialize(repl)
+      super(repl,'quit')
+    end
+    def help
+      'Quit'
+    end
+    def exec(args)
+      exit 0
+    end
+  end
+
+  class Use < Cmd
+    def initialize(repl)
+      super(repl,'use')
+    end
+    def help
+      'Start exploring a certain user'
+    end
+    def exec(args)
+      if args.empty?
+        STDERR.puts 'Missing required argument'
+        return
+      end
+      username = args[0]
+      user = nil
+      begin
+        user = repl.finder.call username
+      rescue Exception => e
+        STDERR.puts "Could not create user for name: #{username}"
+        STDERR.puts e
+      end
+      if user
+        repl.use repl.root_class.new user
+      end
+    end
+  end
+
+  class Cat < Cmd
+    def initialize(repl)
+      super(repl,'cat')
+    end
+    def help
+      'Shows the contents of whatever it is you selected'
+    end
+    def exec(args)
+      if args.empty?
+        STDERR.put 'Required argument'
+        return
+      end
+      args.each do |arg|
+        n = repl.eval_path repl.cur,arg
+        if n.kind_of? NamedNode
+          p n.obj
+        else
+          STDERR.puts "Uh, not with this node #{n}"
+        end
+      end
+    end
+  end
+
+end

data/lib/treerepl/repl.rb

@@ -0,0 +1,149 @@
+module TreeRepl
+
+  class Repl
+
+    attr_reader :root
+    attr_accessor :commands
+    attr_accessor :cur
+    attr_accessor :root_class
+
+    # String -> TreeNode
+    attr_accessor :finder
+    
+    def initialize(root_class)
+      @root_class = root_class
+      @finder = nil
+      @commands = [Ls,Cd,Pwd,Use,Help,Quit,Cat].map {|cls| cls.new self}
+    end
+
+    def add_command(command_class)
+      @commands << command_class.new(self)
+    end
+
+    # ----------------------------------------------------------------------
+    # Main
+    # ----------------------------------------------------------------------
+
+    # TreeNode -> Void
+    def main(root)
+      use root
+      strings2cmds = {}
+      commands.each do |cmd|
+        strings2cmds[cmd.name] = cmd
+      end
+      def loop(strings2cmds)
+        print cwd + '> '
+        orig_line = STDIN.readline.strip
+        line = orig_line.split(/ /)
+        return false if line.empty?
+        str = line.shift.downcase
+        return true if str == 'quit'
+        if not cur
+          if str != 'use' and str != 'help'
+            STDERR.puts 'You must set a user with \'use\' before anything else.'
+            return
+          end
+        end
+        args = line
+        cmd = strings2cmds[str]
+        if cmd
+          begin
+            cmd.exec args
+          rescue Exception => e
+            STDERR.puts 'Trouble executing: ' + orig_line
+            raise e
+          end
+        else
+          STDERR.puts 'Unknown command: ' + str
+        end
+        return false
+      end
+      while true
+        break if loop strings2cmds
+      end
+    end
+
+    # ----------------------------------------------------------------------
+    # 'Private'
+    # ----------------------------------------------------------------------
+
+    def use(user)
+      if user
+        @cur = user
+        @root = user
+      end
+    end
+
+    # TreeNode string -> TreeNode
+    def eval_path(node,path)
+      path = '.' if not path or path == ''
+      if path =~ /^\//
+        args = ['/'] + path.gsub(/^\/+/,'').split(/\//)
+      else
+        args = path.split /\//
+      end
+      trav = node
+      args.each do |arg|
+        case arg
+        when '.'
+          trav = trav
+        when '..'
+          trav = trav.parent
+        when '/'
+          trav = root
+        else
+          found = false
+          trav.children.each do |n|
+            if n.name == arg
+              trav = n
+              found = true
+              break
+            end
+          end
+          if not found
+            STDERR.puts 'Invalid path: ' + path
+            return nil
+          end
+        end
+      end
+      return trav
+    end
+
+    # void -> string
+    def cwd
+      path(root,cur).map {|n| n.name}.join('/')
+    end
+
+    # TreeNode string -> TreeNode
+    def node_relative_to(node,name)
+      if name == '.'
+        return node
+      elsif name == '..'
+        return node.parent
+      elsif name == '/'
+        return root
+      else
+        node.children.each do |n|
+          if name == n.name
+            return n
+          end
+        end
+      end
+      return nil
+    end
+
+    # TreeNode TreeNode -> TreeNode[]
+    def path(from,dest)
+      res = []
+      trav = dest
+      while trav
+        res.push trav
+        break if trav == from
+        trav = trav.parent
+      end
+      return res.reverse
+    end
+    
+  end
+
+end

data/lib/treerepl/tree.rb

@@ -0,0 +1,71 @@
+module TreeRepl
+
+  class TreeNode
+
+    attr_accessor :name, :parent, :leaf
+    
+    @kids = nil
+
+    def find_children
+      raise 'Implement find_children'
+    end
+
+    def children(force=false)
+      if force or not @kids
+        @kids = find_children || []
+        @kids.each do |node|
+          node.parent = self
+        end
+      end
+      @kids
+    end
+
+  end
+  
+  class CmdNode < TreeNode
+    attr_reader :cmd
+    
+    class << self
+      attr_accessor :classes2tree_nodes
+    end
+    self.classes2tree_nodes = {}
+    
+    def initialize(obj,cmd,name)
+      @obj = obj
+      @cmd = cmd
+      @name = name || cmd.to_s
+    end
+    def find_children
+      @obj.send(@cmd).map {|v| CmdNode.classes2tree_nodes[v.class].new v}
+    end
+  end
+
+class NamedNode < TreeNode
+  attr_reader :obj
+  attr_reader :name
+  def initialize(obj,name)
+    @obj = obj
+    @name = name
+  end
+  
+  # Creates the children from the provided symbols defined by
+  # implementing symbols()
+  def find_children
+    lst = symbols
+    if lst.is_a? Hash
+      lst.keys.sort.map {|n| CmdNode.new @obj,lst[n],n}
+    else
+      lst.sort {|a,b| a.to_s <=> b.to_s}.map {|n| CmdNode.new @obj,n,nil}
+    end
+  end
+
+  # -> [symbol] | {string => symbol}
+  #
+  # The symbols (with possible) mapped names to use for children
+  #
+  def symbols
+    raise 'Implement symbols()'
+  end
+end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: treerepl
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeffrey Palm
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-19 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: System for accessing web services for tree-like things via the repl
+email: jeff@jeffpalm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- README
+- LICENSE
+- lib/treerepl.rb
+- lib/treerepl/tree.rb
+- lib/treerepl/repl.rb
+- lib/treerepl/cmds.rb
+has_rdoc: true
+homepage: http://github.com/spudtrooper/treerepl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "%NAME"
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 2
+summary: Tree Repl
+test_files: []
+