mini_mindmap 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03611e87e07f7d586a6f0338a57d671e476d67e7dbc727d9977bdb0f5876ed48
-  data.tar.gz: cb861ebcadcf43ea70e463063425b7ef4fb14e247880edc8a1e98490bd4cb985
+  metadata.gz: '0941fbef61833009099b52dc0561ef6c2672bffd0e5e12ae16a54db7a1aa479d'
+  data.tar.gz: ee55990fa4bced3ce05ff9e69099d806bfc4cb3bf0af5695f5f72501ffa26353
 SHA512:
-  metadata.gz: 1bf82626bfe580a51e38d55a1b3cbd61d5f160d5b55e1d8e81f885ad331b37b831d2f688f5e9d061389b80ab6361a3da747b30fdf569f111de133d64f0be728e
-  data.tar.gz: 9d980a34bc29f60afcee9b87f671b2d3bafc9938dfa3a728b71a605d88f520f95a1e458f41317e05a0db043816116a258a5decb4cdc4806d599bce62b6d9b399
+  metadata.gz: 95894edeafb90a53e04bae3429e5b2e0fbcc7bc487d98b8a9d23524396210c9a594055bf5c316f1b6f731d7d8149f3d2b533c506a1facf69ba3216d69665c6d5
+  data.tar.gz: 0cf17b703155452c3252be70afbe622b4440736ed92f5c9f28e74d4f74928ea8856e02ee7a2ed948cbee8e437400182ccd61a2e746371c4ac725276706e483e6

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 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.
+
+## 0.2.0
+
+* Export mindmap.
+
 ## 0.1.0
 
  * Initial gem release of 0.1 codebase.

data/README.md

@@ -1,8 +1,10 @@
 # MiniMindmap
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mini_mindmap`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Prepare
 
-TODO: Delete this and the text above, and describe your gem
+You need install graphviz first.
+
+[graphviz download](http://www.graphviz.org/download/)
 
 ## Installation
 
@@ -22,23 +24,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+DSL Example
 
-## Development
+```ruby
+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
+}
+
+# online
+
+dsl = %Q{
+  * MiniMindmap
+  ** name
+  ** DSL
+  ** output
+  *** dir
+  *** format
+  ** 汉字测试
+}
+
+demo = MiniMindmap::Mindmap.new(name,dsl,output=output,config=config)
+
+demo.export # export files to dir
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+output img
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+![demo.png](https://wx2.sbimg.cn/2020/07/16/CiWr6.png)
 
-## Contributing
+## Q&A
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mark24code/mini_mindmap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mark24code/mini_mindmap/blob/master/CODE_OF_CONDUCT.md).
+### Chinese charset code problem
 
+1. To check fonts. Run `fc-list` or go to `/etc/fonts` to check if you have correct fonts.
 
-## License
+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
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+> 
+```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)
 
-## Code of Conduct
+```
+## License
 
-Everyone interacting in the MiniMindmap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mark24code/mini_mindmap/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/examples/demo.rb

@@ -1,29 +1,36 @@
-react_mind = RubyMindmap::Mindmap.new do |m|
-  m.name = 'React'
-  m.output = {
-    format: 'png',
-    dir: './out'
+require_relative "helper.rb"
+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
+}
+
+# online
 
+dsl = %Q{
+  * MiniMindmap
+  ** name
+  ** DSL
+  ** output
+  *** dir
+  *** format
+  ** 汉字测试
+}
 
-  m.dsl = <<-Mindmap
-    * React
-    ** 生命周期
-    *** ComponentDidMount
-    **** ComponentWillMount
-    ***** AAAComponentWillMount
-    ** BBBB
-    *** CCCCC
-    **** DDDD
-    ***** FFFF
-    ******* KK
-    ** OPLL
-    * GO
-    ** Woker
-    *** KKKKKLLL
-    * CASIO
-    * KO
-  Mindmap
-end
+demo = MiniMindmap::Mindmap.new(name,dsl,output=output,config=config)
 
-react_mind.export
+demo.export # export files to dir

data/examples/helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)

data/lib/mini_mindmap.rb

@@ -1,75 +1,146 @@
 require "mini_mindmap/version"
+require "mini_mindmap/utils/deep_merge"
+require "fileutils"
 
 module MiniMindmap
   class Error < StandardError; end
 
   class Mindmap
-    def initialize(name, dsl)
+    @@compiles_meta = {
+      basic: {
+        id: "basic",
+        description: "basic expression",
+        syntax: /^(\*+)\s+([^\s]*[^\[\]]*)\s*(\[.*\])*\s*$/,
+        processor: "basic_processor",
+      }
+    }
+    def self.compiles_meta
+      @@compiles_meta
+    end
+
+    def initialize(name, dsl,output={},config={})
+
       @name = name
       @dsl = dsl
+      @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?
-
-      # self.compile
     end
 
-    attr_accessor(:name, :dsl, :output, :nodes)
+    attr_accessor(:name, :dsl, :config, :output, :nodes, :declares)
 
-    def node(code)
+    def compile(code)
     	# TODO  增加拓展语法支持 label等自定义
-    	# 同步Test也要更新
-      node_express = /^(\*+)\s+([^\s]+.*)$/
-      node_express =~ code.strip
-
-      level_prefix = $1
-      content = $2
-      level = level_prefix.length
-      node = [level, content]
+      case code.strip
+      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
+      else
+        # pass
+      end
     end
 
-    def dsl_to_nodes
+    def basic_processor
+      declares = [];
       nodes = []
       stack = []
       dsl = @dsl.split("\n")
       dsl.each_with_index do |code, current_index|
-        current = self.node(code)
-        unless stack.empty?
-          top = stack.pop
-          if (current[0] > top[0])
-            (nodes << "#{top[1]} -> #{current[1]}")
-            stack.push(top)
-          else
-            while (current[0] <= top[0]) and (not stack.empty?)
-              top = stack.pop
+
+        if not code.strip.empty?
+          current_id = current_index
+          current = self.compile(code)
+          current.unshift(current_id)
+          # [id, type_id, level, content, config]
+
+    
+          current_declare = "node#{current_id}[label=\"#{current[3]}\"]";
+          declares.push(current_declare)
+
+          unless stack.empty?
+            top = stack.pop
+            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[2] <= top[2]) and (not stack.empty?)
+                top = stack.pop
+              end
+              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
+              
             end
-            (nodes << "#{top[1]} -> #{current[1]}") if (current[0] > top[0])
           end
+          stack.push(current)
         end
-        stack.push(current)
       end
+      @declares = declares
       @nodes = nodes
     end
 
+    def processor
+      self.send @@compiles_meta[:basic][:processor]  
+    end
+
     def package_nodes
-      "digraph #{@name} {\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
-      File.open("#{@name}.dot", "w") { |f| f.write(package_nodes) }
+      output_dir = File.absolute_path(@output[:dir])
+      FileUtils::mkdir_p output_dir
+      output_file = File.join(output_dir, "#{@name}.dot")
+
+      File.open("#{output_file}", "w") { |f| f.write(package_nodes) }
     end
 
-    def compile
-      self.dsl_to_nodes
+    def run_tasks
+      self.processor
       self.package_nodes
       self.nodes_to_doc
     end
 
     def export_cmd
-      "dot #{@name}.dot -T #{@output[:format]} -o #{@name}.#{@output[:format]}"
+      output_dir = @output[:dir]
+      output_file = File.join(output_dir, "#{@name}.#{@output[:format]}")
+
+      output_dotfile = File.join(output_dir, "#{@name}.dot")
+      "dot #{output_dotfile} -T #{@output[:format]} -o #{output_file}"
     end
 
     def export
+      self.run_tasks
       export = self.export_cmd
+
       puts("[command]: #{export}")
       `#{export}`
     end

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.1.0"
+  VERSION = "0.4.1"
 end

data/mini_mindmap.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A kind of DSL to generate mindmap.}
   spec.description   = %q{[Experimenting!] A kind of DSL to generate mindmap. Depend on Graphviz.}
-  spec.homepage      = "https://github.com/Mark24Code/mini_mindmap"
+  spec.homepage      = "https://mark24code.github.io/mini_mindmap/"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_mindmap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 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:
@@ -26,17 +26,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
 - examples/demo.rb
+- 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://github.com/Mark24Code/mini_mindmap
+homepage: https://mark24code.github.io/mini_mindmap/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Mark24Code/mini_mindmap
+  homepage_uri: https://mark24code.github.io/mini_mindmap/
   source_code_uri: https://github.com/Mark24Code/mini_mindmap
   changelog_uri: https://github.com/Mark24Code/mini_mindmap/blob/master/CHANGELOG.md
 post_install_message: