From 29be7885de56f37a546476ed578ea387d23dc463 Mon Sep 17 00:00:00 2001
From: Bill Niblock <azulien@gmail.com>
Date: Sun, 7 May 2017 16:56:31 -0400
Subject: [PATCH] planter.rb: Start work on editor

This should probably be on it's own branch, but too many of the changes I made
were already committed.

- Logic for a Plot, basically a data class
- Logic for Spade, the main functionality of the class
- Logic to load and parse the tree
- Functionality for loading the first branch with debugging mode

TO-DO
- Abstract branch display properly into Dialogue
- Abstract tree loading and parsing probably back into Gardner
- Change Gardner to a different name. Like... Druid or something...
- Actually build the editor
---
 lib/sapling/planter.rb | 113 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 113 insertions(+)

diff --git a/lib/sapling/planter.rb b/lib/sapling/planter.rb
index c8238ff..7783d66 100644
--- a/lib/sapling/planter.rb
+++ b/lib/sapling/planter.rb
@@ -1,4 +1,117 @@
+require_relative './dialogue'
+require_relative './gardner'
+require_relative './utility'
+
 # Planter is the module for creating or editing a tree.
 module Planter
 
+  class Plot
+    # The tree, trunk, and branches
+    attr_accessor :tree, :trunk, :branches
+
+  end
+
+  # Utilities for editing specific parts of a tree.
+  class Spade
+
+    # The file we parse into a tree
+    attr_writer :file
+
+    # Establish a new Plot, which is basically an object for storing information
+    # for us. From here, we start gardening.
+    def plant
+      @plot = Plot.new
+      @plot.tree = @file
+      @plot.trunk = @file.shift.values[0]
+      @plot.branches = Gardner.prune_branches(@file)
+
+      dig(1)
+    end
+
+    # Function for displaying a single branch in debug mode. We also always
+    # display the trunk, since otherwise it's displayed a single time then gone
+    # forever (until next time).
+    #
+    # @param branch [Integer] The number of the branch to be displayed.
+    def dig(branch_no)
+      branch = @plot.branches[branch_no]
+
+      # Print the trunk
+      40.times { print "-" }
+      puts "\n[ Trunk ]\n#{@plot.trunk}"
+      40.times { print "-" }
+      puts "\n"
+      10.times { print "*" }
+
+      # Print the branch and options
+      puts "\n[ Branch: #{branch_no} ]"
+      puts "\n#{branch["desc"]}\n\n"
+      unless branch["options"].empty?
+        branch["options"].each_pair do |k,v|
+          puts "\t#{k}: #{v.keys[0]}"
+          puts "\t\t [ Goes to branch #{v.values[0]} ]"
+        end
+      end
+    end
+
+    # Edit the trunk of the tree
+    def edit_trunk
+
+    end
+
+    # Edit a branch on the tree
+    #
+    # @param branch [Integer] The number of the branch to be edited.
+    def edit_branch(branch)
+
+    end
+
+    # Edit a leaf on a branch, grasshopper
+    #
+    # @param branch [Integer] The number of the branch to be edited.
+    # @param leaf [Hash] The leaf hash to be edited.
+    def edit_leaf(branch, leaf)
+
+    end
+
+  end
+
 end
+
+=begin
+
+Process:
+- User selects to create/edit a tree
+  - If the user presented a file, use it as the tree file
+  - If the user failed to provide a file, create a new tree file in the current directory
+
+- Check if the file is empty.
+  - If so, assume a new tree
+  - If not, verify formatting
+
+- If new tree, prompt for trunk
+- If existing tree, display trunk and first branch
+
+- At this point, editing is the same
+  - Prompt provides options:
+    - B # - Go to Branch #
+    - T - Edit Trunk
+    - D - Edit Current Branch description
+    - X - Delete Current Branch
+    - L A - Add a new Leaf
+    - L # D - Edit Leaf # description
+    - L # B - Edit Leaf # branch destination
+    - L # X - Remove Leaf #
+    - S - Save Changes (write to the file)
+    - Q - Quit without saving
+
+Details:
+
+- Regardless of the file existing, the user will be editing a Hash, not the actual YAML file
+  - Use Gardner to build the tree (either existing or skeleton)
+  - Use Dialog to interact with the tree
+  - Overwrite prompt with Planter prompt
+  - On changes, re-build the tree, and restart dialogue from most recent branch
+- After each edit option, display the current branch with the new changes.
+
+=end