tree_support 0.1.0

data/examples/0210_take_drop.rb

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

data/examples/0220_it_will_not_be_strange_to_tojson.rb

@@ -0,0 +1,27 @@
+# It will not be strange to tojson
+#
+require "bundler/setup"
+
+require "rails"
+require "active_record"
+require "tree_support"
+require "byebug"
+
+Class.new(Rails::Application){config.eager_load = false}.initialize! # In order to read Railtie
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :nodes do |t|
+    t.belongs_to :parent
+    t.string :name
+  end
+end
+
+class Node < ActiveRecord::Base
+  ar_tree_model
+end
+
+Node.create!(name: "*root*")
+Node.first.to_json              # => "{\"id\":1,\"parent_id\":null,\"name\":\"*root*\"}"

data/examples/0230_list_to_tree.rb

@@ -0,0 +1,68 @@
+require "bundler/setup"
+require "tree_support"
+
+records = [
+  {key: :a0, parent: nil},
+  {key: :a1, parent: :a0},
+  {key: :a2, parent: :a1},
+
+  {key: :b0, parent: nil},
+  {key: :b1, parent: :b0},
+  {key: :b2, parent: :b1},
+]
+
+# ---------- Convert with function of library
+if true
+  puts TreeSupport.records_to_tree(records).collect(&:to_s_tree)
+  puts TreeSupport.records_to_tree(records, root_key: :root).to_s_tree
+end
+
+# ---------- How to write by yourself
+if true
+  source_hash = records.inject({}) { |a, e| a.merge(e[:key] => e) }
+  node_hash = records.inject({}) { |a, e| a.merge(e[:key] => TreeSupport::Node.new(e[:key])) }
+  node_hash.each_value { |node|
+    if parent = source_hash[node.key][:parent]
+      parent_node = node_hash[parent]
+      node.parent = parent_node
+      parent_node.children << node
+    end
+  }
+  roots = node_hash.each_value.find_all { |e| e.parent == nil }
+  puts roots.collect(&:to_s_tree)
+
+  # When you want to make one route
+  root = TreeSupport::Node.new(:root)
+  roots.each do |e|
+    e.parent = root
+    root.children << e
+  end
+  puts root.to_s_tree
+end
+
+# >> a0
+# >> └─a1
+# >>     └─a2
+# >> b0
+# >> └─b1
+# >>     └─b2
+# >> root
+# >> ├─a0
+# >> │   └─a1
+# >> │       └─a2
+# >> └─b0
+# >>     └─b1
+# >>         └─b2
+# >> a0
+# >> └─a1
+# >>     └─a2
+# >> b0
+# >> └─b1
+# >>     └─b2
+# >> root
+# >> ├─a0
+# >> │   └─a1
+# >> │       └─a2
+# >> └─b0
+# >>     └─b1
+# >>         └─b2

data/examples/0240_memory_record.rb

@@ -0,0 +1,34 @@
+# Example of combining with MemoryRecord
+require "bundler/setup"
+require "tree_support"
+require "memory_record"
+
+class Foo
+  include MemoryRecord
+  memory_record [
+    {key: :a, name: "A", parent: nil},
+    {key: :b, name: "B", parent: :a},
+    {key: :c, name: "C", parent: :b},
+  ]
+
+  # Any structure can be used as long as it can respond to parent and children
+  concerning :TreeMethods do
+    included do
+      include TreeSupport::Treeable
+      include TreeSupport::Stringify
+    end
+
+    def parent
+      self.class[super]
+    end
+
+    def children
+      self.class.find_all {|e| e.parent == self }
+    end
+  end
+end
+
+puts Foo.find_all(&:root?).collect(&:to_s_tree)
+# >> A
+# >> └─B
+# >>     └─C

data/examples/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gem "tree_support", :path => ".."
+gem "memory_record"
+
+gem "rails"
+gem "activerecord"
+gem "sqlite3"
+gem "gviz"
+gem "acts_as_tree"
+gem "acts_as_list"
+gem "byebug"

data/examples/Gemfile.lock

@@ -0,0 +1,137 @@
+PATH
+  remote: ..
+  specs:
+    tree_support (0.0.1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0)
+      actionpack (= 5.0.0)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0)
+      actionpack (= 5.0.0)
+      actionview (= 5.0.0)
+      activejob (= 5.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0)
+      actionview (= 5.0.0)
+      activesupport (= 5.0.0)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0)
+      activesupport (= 5.0.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0)
+      activesupport (= 5.0.0)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activerecord (5.0.0)
+      activemodel (= 5.0.0)
+      activesupport (= 5.0.0)
+      arel (~> 7.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    acts_as_list (0.7.6)
+      activerecord (>= 3.0)
+    acts_as_tree (2.4.0)
+      activerecord (>= 3.0.0)
+    arel (7.1.0)
+    builder (3.2.2)
+    byebug (9.0.5)
+    concurrent-ruby (1.0.2)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    gviz (0.3.5)
+      thor
+    i18n (0.7.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    memory_record (0.0.6)
+      activemodel
+      activesupport
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0)
+      actioncable (= 5.0.0)
+      actionmailer (= 5.0.0)
+      actionpack (= 5.0.0)
+      actionview (= 5.0.0)
+      activejob (= 5.0.0)
+      activemodel (= 5.0.0)
+      activerecord (= 5.0.0)
+      activesupport (= 5.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0)
+      actionpack (= 5.0.0)
+      activesupport (= 5.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.2.2)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  acts_as_list
+  acts_as_tree
+  byebug
+  gviz
+  memory_record
+  rails
+  sqlite3
+  tree_support!
+
+BUNDLED WITH
+   1.16.0.pre.3

data/examples/demo.rb

@@ -0,0 +1,126 @@
+# output ../images/*
+require "bundler/setup"
+require "tree_support"
+
+root = TreeSupport.example
+
+p root.each_node.collect.with_index {|n, i| [n.name, i]}
+puts root.to_s_tree
+puts TreeSupport.tree(root)
+puts TreeSupport.tree(root, drop: 1)
+puts TreeSupport.tree(root, take: 3)
+puts TreeSupport.tree(root, take: 3, drop: 1)
+puts TreeSupport.tree(root) {|node, _locals| node.object_id}
+# TreeSupport.graph_open(root)
+
+TreeSupport.graphviz(root) {|node|
+  if node.name.include?("Attack")
+    {fillcolor: "lightblue", style: "filled"}
+  elsif node.name.include?("Recover")
+    {fillcolor: "lightpink", style: "filled"}
+  end
+}.output("../images/tree_color.png")
+
+TreeSupport.graphviz(root) {|node|
+  {label: node.name.chars.first}
+}.output("../images/tree_label.png")
+
+TreeSupport.graphviz(root).output("../images/tree.png")
+TreeSupport.graphviz(root, take: 3).output("../images/take.png")
+TreeSupport.graphviz(root, drop: 1).output("../images/drop.png")
+TreeSupport.graphviz(root, take: 3, drop: 1).output("../images/take_drop.png")
+# >> [["*root*", 0], ["Battle", 1], ["Attack", 2], ["Shake the sword", 3], ["Attack magic", 4], ["Summoned Beast X", 5], ["Summoned Beast Y", 6], ["Repel sword in length", 7], ["Defense", 8], ["Withdraw", 9], ["To stop", 10], ["Place a trap", 11], ["Shoot a bow and arrow", 12], ["To escape", 13], ["Break", 14], ["Stop", 15], ["Recover", 16], ["Recovery magic", 17], ["Drink recovery medicine", 18]]
+# >> *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
+# >> 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
+# >> │   └─Defense
+# >> ├─Withdraw
+# >> │   ├─To stop
+# >> │   └─To escape
+# >> └─Break
+# >>     ├─Stop
+# >>     └─Recover
+# >> Battle
+# >> ├─Attack
+# >> └─Defense
+# >> Withdraw
+# >> ├─To stop
+# >> └─To escape
+# >> Break
+# >> ├─Stop
+# >> └─Recover
+# >> 70279213508120
+# >> ├─70279213507760
+# >> │   ├─70279213507500
+# >> │   │   ├─70279213507240
+# >> │   │   ├─70279213507000
+# >> │   │   │   ├─70279213506800
+# >> │   │   │   └─70279213506660
+# >> │   │   └─70279213507200
+# >> │   └─70279213509960
+# >> ├─70279213498160
+# >> │   ├─70279213497920
+# >> │   │   ├─70279213497740
+# >> │   │   └─70279213497600
+# >> │   └─70279213497380
+# >> └─70279213497180
+# >>     ├─70279213496960
+# >>     └─70279213496720
+# >>         ├─70279213496480
+# >>         └─70279213496320

data/lib/tree_support/ar_tree_model.rb

@@ -0,0 +1,74 @@
+# acts_as_tree replacement
+#
+#   class Node < ActiveRecord::Base
+#     ar_tree_model                                                 # default
+#     ar_tree_model scope: -> { order(:name) }                      # Designate the scope yourself
+#     ar_tree_model scope: -> { order(:id).where(active: true) } # You can also specify where
+#   end
+#
+require "active_support/concern"
+
+module TreeSupport
+  module ArTreeModel
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    class_methods do
+      def ar_tree_model(options = {})
+        return if ar_tree_model_defined?
+
+        class_attribute :ar_tree_model_configuration
+        self.ar_tree_model_configuration = {
+          scope: -> { order(:id) },
+        }.merge(options)
+
+        if block_given?
+          yield ar_tree_model_configuration
+        end
+
+        include SingletonMethods
+      end
+
+      def ar_tree_model_defined?
+        ancestors.include?(SingletonMethods)
+      end
+    end
+
+    concern :SingletonMethods do
+      include Treeable
+      include Stringify
+
+      included do
+        scope :tree_default_scope, ar_tree_model_configuration[:scope]
+
+        belongs_to :parent, -> { tree_default_scope }, class_name: name, foreign_key: :parent_id, required: false
+        has_many :children, -> { tree_default_scope }, class_name: name, foreign_key: :parent_id, dependent: :destroy, inverse_of: :parent
+        scope :roots, -> { tree_default_scope.where(parent_id: nil) }
+      end
+
+      class_methods do
+        def ar_tree_model?
+          ar_tree_model_defined? # && columns_hash.has_key?(:id)
+        end
+
+        def root
+          roots.first
+        end
+
+        # In combination with acts_as_list accident in destroy_all, we have to erase from the leaves in order
+        def safe_destroy_all
+          roots.collect(&:destroy)
+        end
+
+        def destroy_all(*args)
+          if respond_to?(:acts_as_list)
+            ActiveSupport::Deprecation.warn("When you use acts_as_list destroy_all do not get id failed to accidentally delete_all Please use safe_destroy_all to erase from the end")
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tree_support/graphviz_builder.rb

@@ -0,0 +1,78 @@
+require "gviz"
+
+# for GvizEx#output
+require "pathname"
+require "delegate"
+require "fileutils"
+
+require "active_support/core_ext/module/delegation"
+
+module TreeSupport
+  def self.graphviz(*args, &block)
+    GraphvizBuilder.build(*args, &block)
+  end
+
+  def self.graph_open(*args, &block)
+    graphviz(*args, &block).output("_output.png")
+    `open _output.png`
+  end
+
+  class GraphvizBuilder
+    # For Gviz#save only for some reason
+    class GvizEx < SimpleDelegator
+      def output(filename)
+        filename = Pathname(filename).expand_path
+        FileUtils.makedirs(filename.dirname)
+        save("#{filename.dirname}/#{filename.basename(".*")}", filename.extname.delete("."))
+      end
+
+      # alias to_dot to_s can not
+      def to_dot
+        to_s
+      end
+    end
+
+    def self.build(object, *args, &block)
+      new(*args, &block).build(object)
+    end
+
+    def initialize(**options, &block)
+      @options = {
+        take: 256,
+        drop: 0,
+      }.merge(options)
+      @block = block
+    end
+
+    def build(object)
+      GvizEx.new(Gviz.new).tap do |gv|
+        gv.global(rankdir: "LR", concentrate: "true")
+        visit(gv, object)
+      end
+    end
+
+    private
+
+    def visit(gv, object, depth = 0)
+      if depth < @options[:take]
+        if @options[:drop] <= depth
+          attrs = {}
+          if @block
+            attrs = @block.call(object) || {}
+          end
+          attrs[:label] ||= TreeSupport.node_name(object)
+          gv.node(node_code(object), attrs)
+          if depth.next < @options[:take]
+            gv.route node_code(object) => object.children.collect {|node| node_code(node) }
+          end
+        end
+        object.children.each {|e| visit(gv, e, depth.next) }
+      end
+    end
+
+    def node_code(object)
+      # I do not want to be a symbol because it is not subject to GC, but because I get angry with Gviz it is a symbolic symbol
+      :"n#{object.object_id}"
+    end
+  end
+end