tree_support 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35b3da8eb68307c23ab1a39ffe096c55bb826f27
+  data.tar.gz: 64366be7a67841d0f0c0fbc893e46835bf417f12
+SHA512:
+  metadata.gz: 405374ce91c625deb5ad2f7eb3a1e3a0d9d518be315c960f32d92e858a0afe12224dcfbb0b4eb3951a40fde02f0973652d90b108c356881572c74a3be6ef2d58
+  data.tar.gz: cf0608091c08aaea0f5e099d4c1b439db05a2f8a2a4c3e3ed62efdb1f3444a22df0d798795213e2904417c960ed9cdda3e188fa1811ac5e7efd57b1fea774f07

data/.gitignore

@@ -0,0 +1,3 @@
+_*
+/Gemfile.lock
+*.dot

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.1
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.org

@@ -0,0 +1,471 @@
+* Tree structure visualization function library
+
+  [[https://travis-ci.org/akicho8/tree_support.png]]
+
+** How to use in one line
+
+   Just pass the object that has the parent, children method to TreeSupport.tree
+
+#+BEGIN_SRC ruby
+require "tree_support"
+puts TreeSupport.tree(TreeSupport.example)
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   │   ├─Shake the sword
+# >> │   │   ├─Attack magic
+# >> │   │   │   ├─Summoned Beast X
+# >> │   │   │   └─Summoned Beast Y
+# >> │   │   └─Repel sword in length
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   │   ├─Place a trap
+# >> │   │   └─Shoot a bow and arrow
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >>         ├─Recovery magic
+# >>         └─Drink recovery medicine
+#+END_SRC
+
+** Detailed usage
+
+*** Prepare a node class like this
+
+#+BEGIN_SRC ruby
+class Node
+  attr_accessor :name, :parent, :children
+
+  def initialize(name = nil, &block)
+    @name = name
+    @children = []
+    if block_given?
+      instance_eval(&block)
+    end
+  end
+
+  def add(*args, &block)
+    tap do
+      children << self.class.new(*args, &block).tap { |v| v.parent = self }
+    end
+  end
+end
+#+END_SRC
+
+*** Create a tree
+
+#+BEGIN_SRC ruby
+root = Node.new("*root*") do
+  add "Battle" do
+    add "Attack" do
+      add "Shake the sword"
+      add "Attack magic" do
+        add "Summoned Beast X"
+        add "Summoned Beast Y"
+      end
+      add "Repel sword in length"
+    end
+    add "Defense"
+  end
+  add "Withdraw" do
+    add "To stop" do
+      add "Place a trap"
+      add "Shoot a bow and arrow"
+    end
+    add "To escape"
+  end
+  add "Break" do
+    add "Stop"
+    add "Recover" do
+      add "Recovery magic"
+      add "Drink recovery medicine"
+    end
+  end
+end
+#+END_SRC
+
+*** Visualization
+
+#+BEGIN_SRC ruby
+puts TreeSupport.tree(root)
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   │   ├─Shake the sword
+# >> │   │   ├─Attack magic
+# >> │   │   │   ├─Summoned Beast X
+# >> │   │   │   └─Summoned Beast Y
+# >> │   │   └─Repel sword in length
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   │   ├─Place a trap
+# >> │   │   └─Shoot a bow and arrow
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >>         ├─Recovery magic
+# >>         └─Drink recovery medicine
+#+END_SRC
+
+*** Troublesome writing TreeSupport.tree
+
+   Include TreeSupport::Stringify
+
+#+BEGIN_SRC ruby
+Node.include(TreeSupport::Stringify)
+puts root.to_s_tree
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   │   ├─Shake the sword
+# >> │   │   ├─Attack magic
+# >> │   │   │   ├─Summoned Beast X
+# >> │   │   │   └─Summoned Beast Y
+# >> │   │   └─Repel sword in length
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   │   ├─Place a trap
+# >> │   │   └─Shoot a bow and arrow
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >>         ├─Recovery magic
+# >>         └─Drink recovery medicine
+#+END_SRC
+
+*** How do I change the label of a node?
+
+    We look for =to_s_tree_name=, =name=, =subject=, =title=, =to_s= defined by =TreeSupport.name_methods= in that order, so we define the method by considering the priority
+
+*** How do I change labels without defining methods?
+
+   Add a block to tree
+
+#+BEGIN_SRC ruby
+puts TreeSupport.tree(root) { |node| node.object_id }
+# >> 70308514816100
+# >> ├─70308514815920
+# >> │   ├─70308514815780
+# >> │   │   ├─70308514815680
+# >> │   │   ├─70308514815580
+# >> │   │   │   ├─70308514815480
+# >> │   │   │   └─70308514815420
+# >> │   │   └─70308514815360
+# >> │   └─70308514815300
+# >> ├─70308514815220
+# >> │   ├─70308514815080
+# >> │   │   ├─70308514814980
+# >> │   │   └─70308514814920
+# >> │   └─70308514814860
+# >> └─70308514814780
+# >>      ├─70308514814680
+# >>      └─70308514814580
+# >>           ├─70308514814480
+# >>           └─70308514814420
+#+END_SRC
+
+*** How to use methods that are common in tree structure?
+
+    The following methods become available in include of =TreeSupport::Treeable=
+
+- each
+- each_node
+- descendants
+- self_and_descendants
+- ancestors
+- root
+- siblings
+- self_and_siblings
+- root?
+- leaf?
+
+*** How to convert to Gviz object?
+
+#+BEGIN_SRC ruby
+gv = TreeSupport.graphviz(root)
+#+END_SRC
+
+*** How to image it?
+
+#+BEGIN_SRC ruby
+gv.output("tree.png")
+#+END_SRC
+
+   [[https://raw.github.com/akicho8/tree_support/master/images/tree.png]]
+
+*** How do I change the color of a particular node?
+
+    Return the graphviz attribute as a hash in TreeSupport.graphviz block
+
+#+BEGIN_SRC ruby
+gv = TreeSupport.graphviz(root) do |node|
+  if node.name.include?("Attack")
+    {fillcolor: "lightblue", style: "filled"}
+  elsif node.name.include?("Recover")
+    {fillcolor: "lightpink", style: "filled"}
+  end
+end
+gv.output("tree_color.png")
+#+END_SRC
+
+   [[https://raw.github.com/akicho8/tree_support/master/images/tree_color.png]]
+
+*** How do I change the label of a particular node?
+
+    As with the above method, it returns a hash containing the label value
+
+#+BEGIN_SRC ruby
+gv = TreeSupport.graphviz(root) do |node|
+  {label: node.name.chars.first}
+end
+gv.output("tree_label.png")
+#+END_SRC
+
+   [[https://raw.github.com/akicho8/tree_support/master/images/tree_label.png]]
+
+*** How can I check the dot format of Graphviz?
+
+#+BEGIN_SRC ruby
+puts gv.to_dot
+# >> digraph n70146110700700 {
+# >>   graph [charset = "UTF-8", rankdir = "LR"];
+# >>   n70146110700700 [label = "*root*"];
+# >>   n70146110700700 -> {n70146110698600; n70146110691220; n70146110689500;};
+# >>   n70146110698600 [label = "Battle"];
+# >>   n70146110698600 -> {n70146110698320; n70146110691720;};
+# >>   n70146110698320 [label = "Attack"];
+# >>   n70146110698320 -> {n70146110697900; n70146110697240; n70146110692060;};
+# >>   n70146110697900 [label = "Shake the sword"];
+# >>   n70146110697240 [label = "Attack magic"];
+# >>   n70146110697240 -> {n70146110695080; n70146110694480;};
+# >>   n70146110695080 [label = "Summoned Beast X"];
+# >>   n70146110694480 [label = "Summoned Beast Y"];
+# >>   n70146110692060 [label = "Repel sword in length"];
+# >>   n70146110691720 [label = "Defense"];
+# >>   n70146110691220 [label = "Withdraw"];
+# >>   n70146110691220 -> {n70146110690400; n70146110689620;};
+# >>   n70146110690400 [label = "To stop"];
+# >>   n70146110690400 -> {n70146110690220; n70146110689820;};
+# >>   n70146110690220 [label = "Place a trap"];
+# >>   n70146110689820 [label = "Shoot a bow and arrow"];
+# >>   n70146110689620 [label = "To escape"];
+# >>   n70146110689500 [label = "Break"];
+# >>   n70146110689500 -> {n70146110688500; n70146110687660;};
+# >>   n70146110688500 [label = "Stop"];
+# >>   n70146110687660 [label = "Recover"];
+# >>   n70146110687660 -> {n70146110686920; n70146110686220;};
+# >>   n70146110686920 [label = "Recovery magic"];
+# >>   n70146110686220 [label = "Drink recovery medicine"];
+# >> }
+#+END_SRC
+
+*** How can I check the image conversion immediately when debugging?
+
+#+BEGIN_SRC ruby
+TreeSupport.graph_open(root)
+#+END_SRC
+
+    Equivalent to the next shortcut
+
+#+BEGIN_SRC ruby
+TreeSupport.graphviz(root).output("_output.png")
+`open _output.png`
+#+END_SRC
+
+*** Troublesome making node classes yourself
+
+    You can use =TreeSupport::Node= as it is.
+
+#+BEGIN_SRC ruby
+TreeSupport::Node.new("*root*") do
+  add "Battle" do
+    add "Attack" do
+      add "Shake the sword"
+      add "Attack magic" do
+        add "Summoned Beast X"
+        add "Summoned Beast Y"
+      end
+    end
+  end
+end
+#+END_SRC
+
+*** Troublesome making trees
+
+#+BEGIN_SRC ruby
+TreeSupport.example
+#+END_SRC
+
+    There is a simple sample tree
+
+*** How to trace leaves?
+
+    If you include =TreeSupport::Treeable= you can use each_node
+
+#+BEGIN_SRC ruby
+root = TreeSupport.example
+root.each_node.with_index { |n, i| p [i, n.name] }
+# >> [0, "*root*"]
+# >> [1, "Battle"]
+# >> [2, "Attack"]
+# >> [3, "Shake the sword"]
+# >> [4, "Attack magic"]
+# >> [5, "Summoned Beast X"]
+# >> [6, "Summoned Beast Y"]
+# >> [7, "Repel sword in length"]
+# >> [8, "Defense"]
+# >> [9, "Withdraw"]
+# >> [10, "To stop"]
+# >> [11, "Place a trap"]
+# >> [12, "Shoot a bow and arrow"]
+# >> [13, "To escape"]
+# >> [14, "Break"]
+# >> [15, "Stop"]
+# >> [16, "Recover"]
+# >> [17, "Recovery magic"]
+# >> [18, "Drink recovery medicine"]
+#+END_SRC
+
+*** I do not want to display the root
+
+#+BEGIN_SRC ruby
+puts TreeSupport.tree(root, drop: 1)
+# >> Battle
+# >> ├─Attack
+# >> │   ├─Shake the sword
+# >> │   ├─Attack magic
+# >> │   │   ├─Summoned Beast X
+# >> │   │   └─Summoned Beast Y
+# >> │   └─Repel sword in length
+# >> └─Defense
+# >> Withdraw
+# >> ├─To stop
+# >> │   ├─Place a trap
+# >> │   └─Shoot a bow and arrow
+# >> └─To escape
+# >> Break
+# >> ├─Stop
+# >> └─Recover
+# >>     ├─Recovery magic
+# >>     └─Drink recovery medicine
+#+END_SRC
+
+*** Since the trees are too big, it is enough up to the depth 3
+
+#+BEGIN_SRC ruby
+puts TreeSupport.tree(root, take: 3)
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+#+END_SRC
+
+*** When you combine both
+
+#+BEGIN_SRC ruby
+puts TreeSupport.tree(root, take: 3, drop: 1)
+# >> Battle
+# >> ├─Attack
+# >> └─Defense
+# >> Withdraw
+# >> ├─To stop
+# >> └─To escape
+# >> Break
+# >> ├─Stop
+# >> └─Recover
+#+END_SRC
+
+*** Image version also has similar options
+
+#+BEGIN_SRC ruby
+gv = TreeSupport.graphviz(root, drop: 1)
+gv.output("drop.png")
+#+END_SRC
+
+    [[https://raw.github.com/akicho8/tree_support/master/images/drop.png]]
+
+#+BEGIN_SRC ruby
+gv = TreeSupport.graphviz(root, take: 3)
+gv.output("take.png")
+#+END_SRC
+
+    [[https://raw.github.com/akicho8/tree_support/master/images/take.png]]
+
+#+BEGIN_SRC ruby
+gv = TreeSupport.graphviz(root, take: 3, drop: 1)
+gv.output("take_drop.png")
+#+END_SRC
+
+    [[https://raw.github.com/akicho8/tree_support/master/images/take_drop.png]]
+
+*** How to use acts_as_tree equivalent?
+
+    Migration
+
+#+BEGIN_SRC ruby
+create_table :nodes do |t|
+  t.belongs_to :parent
+end
+#+END_SRC
+
+    Model
+
+#+BEGIN_SRC ruby
+class Node < ActiveRecord::Base
+  ar_tree_model
+end
+#+END_SRC
+
+    Difference from https://github.com/amerine/acts_as_tree
+
+    - simple
+    - Safely delete all safe_destroy_all (accident with destroy_all in combination with acts_as_list)
+    - Node.roots is defined by scope
+    - Arguments are different. =:order => :id= if you want to do it =scope: -> { order(:id) }=. By doing this you can also pass the where condition.
+
+*** How do I correspond to memory_record gem?
+
+    Just as with ordinary classes, we need parent and children methods
+
+#+BEGIN_SRC ruby
+class Foo
+  include MemoryRecord
+  static_record [
+    {key: :a, parent: nil},
+    {key: :b, parent: :a},
+    {key: :c, parent: :b},
+  ]
+
+  include TreeSupport::Treeable
+  include TreeSupport::Stringify
+
+  def parent
+    self.class[super]
+  end
+
+  def children
+    self.class.find_all { |e| e.parent == self }
+  end
+end
+
+puts Foo.find_all(&:root?).collect(&:to_s_tree)
+# >> A
+# >> └─B
+# >>     └─C
+#+END_SRC
+
+** With concern
+
+   - Since Gviz extends the standard class, concerns about future interference when combined with Rails (Active Support) etc.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+task :default => :spec

data/examples/0100_simple.rb

@@ -0,0 +1,22 @@
+require "bundler/setup"
+require "tree_support"
+puts TreeSupport.tree(TreeSupport.example)
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   │   ├─Shake the sword
+# >> │   │   ├─Attack magic
+# >> │   │   │   ├─Summoned Beast X
+# >> │   │   │   └─Summoned Beast Y
+# >> │   │   └─Repel sword in length
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   │   ├─Place a trap
+# >> │   │   └─Shoot a bow and arrow
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >>         ├─Recovery magic
+# >>         └─Drink recovery medicine

data/examples/0110_embeded_node_class.rb

@@ -0,0 +1,26 @@
+#
+# Built-in TreeSupport::Node can be used generically when you want to express a little tree structure
+#
+require "bundler/setup"
+require "tree_support"
+
+node = TreeSupport::Node.new("foo")
+node.name                       # => "foo"
+
+node = TreeSupport::Node.new(:foo)
+node.key                        # => :foo
+
+node = TreeSupport::Node.new(a: 1, b: 2)
+node[:a]                        # => 1
+node.to_h                       # => {:a=>1, :b=>2}
+
+tree = TreeSupport::Node.new(:root) do
+  add :a do
+    add :b do
+      add :c
+    end
+  end
+end
+
+tree.each_node.find { |e| e.key == :root }.key # => :root
+tree.each_node.find { |e| e.key == :b }.key    # => :b

data/examples/0120_graphiz_output_image.rb

@@ -0,0 +1,6 @@
+# Image conversion
+#
+require "bundler/setup"
+require "tree_support"
+root = TreeSupport.example
+TreeSupport.graphviz(root).output("_tree.png")

data/examples/0130_node_class_example.rb

@@ -0,0 +1,98 @@
+# Examples of homebrew nodes
+
+require "bundler/setup"
+require "tree_support"
+
+class Node
+  attr_accessor :name, :parent, :children
+
+  def initialize(name = nil, &block)
+    @name = name
+    @children = []
+    if block_given?
+      instance_eval(&block)
+    end
+  end
+
+  # 木を簡単につくるため
+  def add(*args, &block)
+    tap do
+      children << self.class.new(*args, &block).tap do |v|
+        v.parent = self
+      end
+    end
+  end
+end
+
+root = Node.new("*root*") do
+  add "Battle" do
+    add "Attack" do
+      add "Shake the sword"
+      add "Attack magic" do
+        add "Summoned Beast X"
+        add "Summoned Beast Y"
+      end
+      add "Repel sword in length"
+    end
+    add "Defense"
+  end
+  add "Withdraw" do
+    add "To stop" do
+      add "Place a trap"
+      add "Shoot a bow and arrow"
+    end
+    add "To escape"
+  end
+  add "Break" do
+    add "Stop"
+    add "Recover" do
+      add "Recovery magic"
+      add "Drink recovery medicine"
+    end
+  end
+end
+
+# TreeSupport.tree に渡すオブジェクトは は parent.children と name に応答できさえすればいい
+puts TreeSupport.tree(root)
+
+# オブジェクトに文字列化するメソッドを入れるには？
+Node.include(TreeSupport::Stringify)
+puts root.to_s_tree
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   │   ├─Shake the sword
+# >> │   │   ├─Attack magic
+# >> │   │   │   ├─Summoned Beast X
+# >> │   │   │   └─Summoned Beast Y
+# >> │   │   └─Repel sword in length
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   │   ├─Place a trap
+# >> │   │   └─Shoot a bow and arrow
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >>         ├─Recovery magic
+# >>         └─Drink recovery medicine
+# >> *root*
+# >> ├─Battle
+# >> │   ├─Attack
+# >> │   │   ├─Shake the sword
+# >> │   │   ├─Attack magic
+# >> │   │   │   ├─Summoned Beast X
+# >> │   │   │   └─Summoned Beast Y
+# >> │   │   └─Repel sword in length
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   │   ├─Place a trap
+# >> │   │   └─Shoot a bow and arrow
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >>         ├─Recovery magic
+# >>         └─Drink recovery medicine