mini_mindmap 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf3019409b24f81143cb4efc1c1cbfbf344063c866f900d90e08f24a246eef41
-  data.tar.gz: 326c75b84b04b27e01d5e42bc03f1fc8437f6b2befa09707b09219b8b624cfa5
+  metadata.gz: 2b143ee9e9001990d4274b842a7cd910259f997072d14e2cb62e7bb04d7c5486
+  data.tar.gz: 7f19f9a4bc3c4e74903ef01a78307be609bf1bf93db6b6026c7d9e1e00651ff1
 SHA512:
-  metadata.gz: a865dc6855c61c3b05bb3684696d7a364d4872d0f0466cafe26b7167edc148117347416c08eabe69f6623ed52017e5102e7d61dff5fcb1f225f74746c30f0b9e
-  data.tar.gz: e8f2b6fc5f239955850a1483a6061317c53589df578ed8d836b2b74e57cdc557374279f72fe3045f4f52c4296aa3aa1975fbd1179d8135c6cf5ad0d6a0dcba18
+  metadata.gz: e869b5f69da282dabe8add02ad4dc2f67b8a2d57fea6ea38e78295e5ff20421371d5d48e3764c86e4770253eea32df3d4f39c2ba9fed34cff6031c4f6a9c5902
+  data.tar.gz: 98d59b6b3a98a878aca95497cffbdc3b285591be03d727d34758fd7a101d4c57ca46c769058d134994e1096ec2233384665b0cf85c664f19ba71517d7b080180

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 0.6.0
+
+* Remove Markdown title support syntax
+
+## 0.5.0
+
+* Add annotion syntax
+* Add markdown title support syntax
+
+## 0.4.1
+
+* Fix name bug.
+
+## 0.4.0
+
+* Add Config Field with `node` ,`edge`. You can config fonts sharp etc.
+* Also support add attrs http://www.graphviz.org/doc/info/attrs.html
+ now we can write config like `** name [color=red]`
+
 ## 0.3.0
 
 * Change to node style to export dotfile.

data/README.md

@@ -22,6 +22,28 @@ Or install it yourself as:
 
     $ gem install mini_mindmap
 
+## Syntax
+
+PlantUML Mindmap Syntax
+
+```
+
+* Subject
+** Foo
+** Bar
+
+```
+
+Suppo Annotation with //
+
+```
+
+// one line annotation
+
+** Foo // you can add annotation here too
+
+```
+
 ## Usage
 
 DSL Example
@@ -31,6 +53,17 @@ require "mini_mindmap"
 
 name = 'mindmap' # filename
 
+# support add attrs http://www.graphviz.org/doc/info/attrs.html
+config = {
+  rankdir: "LR",# "TB", "LR", "BT", "RL", 分别对应于从上到下，从左到右，从下到上和从右到左绘制的有向图
+  node: {
+    fontname: "wqy-microhei",
+    fontcolor: "black"
+  },
+  edge: {
+    fontname: "wqy-microhei"
+  }
+}
 output = {
   format: 'png',
   dir: "#{Dir.home}/mindmap" # output dir
@@ -45,9 +78,10 @@ dsl = %Q{
   ** output
   *** dir
   *** format
+  ** 汉字测试
 }
 
-demo = MiniMindmap::Mindmap.new(name,dsl,output)
+demo = MiniMindmap::Mindmap.new(name,dsl,output=output,config=config)
 
 demo.export # export files to dir
 
@@ -56,6 +90,30 @@ output img
 
 ![demo.png](https://wx2.sbimg.cn/2020/07/16/CiWr6.png)
 
+## Q&A
+
+### Chinese charset code problem
+
+1. To check fonts. Run `fc-list` or go to `/etc/fonts` to check if you have correct fonts.
+
+2. You may need to install fonts, for example : Chinese font —— 文泉驿。 Run `sudo apt list fonts-wqy-zenhei`
+3. Make config with correct font name
+
+> 
+```ruby
+config = {
+  rankdir: "LR",# "TB", "LR", "BT", "RL" direction
+  node: {
+    fontname: "wqy-microhei"
+  },
+  edge: {
+    fontname: "wqy-microhei"
+  }
+}
+
+demo = MiniMindmap::Mindmap.new(name,dsl,output=output,config=config)
+
+```
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/examples/demo.rb

@@ -3,6 +3,17 @@ require "mini_mindmap"
 
 name = 'mindmap' # filename
 
+# support add attrs http://www.graphviz.org/doc/info/attrs.html
+config = {
+  rankdir: "LR",# "TB", "LR", "BT", "RL", 分别对应于从上到下，从左到右，从下到上和从右到左绘制的有向图
+  node: {
+    fontname: "wqy-microhei",
+    fontcolor: "black"
+  },
+  edge: {
+    fontname: "wqy-microhei"
+  }
+}
 output = {
   format: 'png',
   dir: "#{Dir.home}/mindmap" # output dir
@@ -11,14 +22,15 @@ output = {
 # online
 
 dsl = %Q{
-  * MiniMindmap
-  ** name
-  ** DSL
+  # MiniMindmap
+  ## name [color=red]
+  ** DSL // this is annotion
   ** output
   *** dir
   *** format
+  ** 汉字测试
 }
 
-demo = MiniMindmap::Mindmap.new(name,dsl,output)
+demo = MiniMindmap::Mindmap.new(name,dsl,output=output,config=config)
 
-demo.export # export files to dir
+demo.export # export files to dir

data/lib/mini_mindmap.rb

@@ -1,4 +1,5 @@
 require "mini_mindmap/version"
+require "mini_mindmap/utils/deep_merge"
 require "fileutils"
 
 module MiniMindmap
@@ -9,27 +10,38 @@ module MiniMindmap
       basic: {
         id: "basic",
         description: "basic expression",
-        syntax: /^(\*+)\s+([^\s]+.*)$/,
+        syntax: /^(\*+)\s+([^\s]*[^\[\]]*)\s*(\[.*\])*\s*(\/\/.*)*\s*$/,
         processor: "basic_processor",
+      },
+      annotation: {
+        id: "annotation",
+        description: "annotation expression",
+        syntax: /^\s*\/\/.*\s*/,
+        processor: "annotation_processor",
       }
     }
     def self.compiles_meta
       @@compiles_meta
     end
 
-    def initialize(name, dsl, output=nil)
+    def initialize(name, dsl,output={},config={})
 
       @name = name
       @dsl = dsl
-      @output = output || {
+      @config =  {
+        rankdir: 'LR', # "TB", "LR", "BT", "RL", 分别对应于从上到下，从左到右，从下到上和从右到左绘制的有向图
+        node: {},
+        edge: {}
+      }.deep_merge(config)
+      @output = {
         dir: Dir.home,
         format: "png"
-      }
+      }.deep_merge(output) 
 
       yield(self) if block_given?
     end
 
-    attr_accessor(:name, :dsl, :output, :nodes, :declares)
+    attr_accessor(:name, :dsl, :config, :output, :nodes, :declares)
 
     def compile(code)
     	# TODO  增加拓展语法支持 label等自定义
@@ -37,10 +49,19 @@ module MiniMindmap
       when @@compiles_meta[:basic][:syntax]
         level_prefix = $1
         content = $2
+        config = $3
         level = level_prefix.length
         node = [@@compiles_meta[:basic][:id],level, content]
+
+        if config
+          node.push(config)
+        end
+      
+        return node
+      when @@compiles_meta[:annotation][:syntax]
+        # pass annotation  
       else
-        # pass
+        # rest pass
       end
     end
 
@@ -54,23 +75,35 @@ module MiniMindmap
         if not code.strip.empty?
           current_id = current_index
           current = self.compile(code)
-          current << current_id
+          if not current
+            next
+          end
+          current.unshift(current_id)
+          # [id, type_id, level, content, config]
 
     
-          current_declare = "node#{current_id}[label=\"#{current[2]}\"]";
+          current_declare = "node#{current_id}[label=\"#{current[3]}\"]";
           declares.push(current_declare)
 
           unless stack.empty?
             top = stack.pop
-            if current[1] > top[1]
-              nodes << "node#{top[3]} -> node#{current[3]}"
+            if current[2] > top[2]
+              node_line = "node#{top[0]} -> node#{current[0]}"
+              if current.length >=5
+                node_line += " #{current[4]}"
+              end
+              nodes << node_line 
               stack.push(top)
             else
-              while (current[1] <= top[1]) and (not stack.empty?)
+              while (current[2] <= top[2]) and (not stack.empty?)
                 top = stack.pop
               end
-              if current[1] > top[1]
-                nodes << "node#{top[3]} -> node#{current[3]}"
+              if current[2] > top[2]
+                node_line = "node#{top[0]} -> node#{current[0]}"
+                if current.length >=5
+                  node_line += " #{current[4]}"
+                end
+                nodes << node_line 
                 stack.push top
               end
               
@@ -88,7 +121,9 @@ module MiniMindmap
     end
 
     def package_nodes
-      "digraph #{@name} {\n#{@declares.join("\n")}\n#{@nodes.join("\n")}\n}"
+      node_config = @config[:node].map {|k,v| "#{k}=\"#{v}\""}.join(",")
+      edge_config = @config[:edge].map {|k,v| "#{k}=\"#{v}\""}.join(",")
+      "digraph \"#{@name}\" {\nrankdir = #{@config[:rankdir]};\nnode [#{node_config}];\nedge [#{edge_config}];\n#{@declares.join("\n")}\n#{@nodes.join("\n")}\n}"
     end
 
     def nodes_to_doc

data/lib/mini_mindmap/utils/deep_merge.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Hash
+  # Returns a new hash with +self+ and +other_hash+ merged recursively.
+  #
+  #   h1 = { a: true, b: { c: [1, 2, 3] } }
+  #   h2 = { a: false, b: { x: [3, 4, 5] } }
+  #
+  #   h1.deep_merge(h2) # => { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+  #
+  # Like with Hash#merge in the standard library, a block can be provided
+  # to merge values:
+  #
+  #   h1 = { a: 100, b: 200, c: { c1: 100 } }
+  #   h2 = { b: 250, c: { c1: 200 } }
+  #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
+  #   # => { a: 100, b: 450, c: { c1: 300 } }
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+end

data/lib/mini_mindmap/version.rb

@@ -1,3 +1,3 @@
 module MiniMindmap
-  VERSION = "0.3.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_mindmap
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark24
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies: []
 description: "[Experimenting!] A kind of DSL to generate mindmap. Depend on Graphviz."
 email:
@@ -33,6 +33,7 @@ files:
 - examples/helper.rb
 - examples/mindmap.png
 - lib/mini_mindmap.rb
+- lib/mini_mindmap/utils/deep_merge.rb
 - lib/mini_mindmap/version.rb
 - mini_mindmap.gemspec
 homepage: https://mark24code.github.io/mini_mindmap/