requidef 0.2.0 → 0.2.2

data/ChangeLog.md

@@ -1,14 +1,32 @@
-# version 0.1.0
+# ChangeLog 
+ChangeLogs for Milestones.
+
+## Version 0.1.0 (Aug. 21, 2011)
 The consequence of 10H rapid developement.   
 It had many bugs so we could not use the command after 'gem install'ing. 
 
-# version 0.2.0
-(Below describes the future which is not happened still.)  
-
+## Version 0.2.0 (Aug. 22, 2011)
 We found that the .rd file is not as easy to edit as we had expected.  
 So we decided to edit file in XMind, a free MindMap tool, export it to HTML to translate to .rd file.  
 Other features,  
+
 * The commandline I/F is changed.
 * Fixed the flashed bugs in 0.1.0.
 * Provides some converter functionality.
 * It is now ready to get started by just gem installing.
+
+## Version 0.3.0 (Forecast)
+* Add more format to translate (TGF, GML, ..).
+* Parser Enhancement (Hopefully all but few would be eliminated).  
+Comment Out,  
+Line Breaking,  
+Empty Line,  
+[[tagname]] -> [[tagname:tagname]] for DRY.  
+* Not all the (>>dest) does not have the real destination. Even in that case, works fine.  
+Imagine if all the link must have definitly the real desitination. What could be happened?  
+* Code Clean  
+Testing will be automated so that the future development will be saved.
+* Design Issue  
+rationalize! method in rdtree is quite wierd. fix it or not.
+
+

data/bin/Makefile

@@ -1,12 +1,17 @@
-sample : dot_sample csv_sample
+sample : rd_sample mm_sample csv_sample rd_composition_sample
 
-dot_sample :
-	cat sample.mm | requidef --from=mm --to=rd | requidef --from=rd --to=dot > sample.dot
-	dot -Tjpg sample.dot -o sample.jpg
+rd_sample :
+	cat sample.rd | requidef --parse-lenient --from=rd --to=dot | dot -Tjpg -o rd.jpg 
+
+rd_composition_sample :
+	cat sample.rd sample2.rd | requidef --parse-lenient --from=rd --to=dot | dot -Tjpg -o rd_composition.jpg 
+
+mm_sample :
+	cat sample.mm | requidef --from=mm --to=rd | requidef --from=rd --to=dot | dot -Tjpg -o mm.jpg
 
 csv_sample :
-	cat sample.html | requidef --from=html --to=rd | requidef --from=rd --to=csv > sample.csv
+	cat sample.html | requidef --from=html --to=rd | requidef --from=rd --to=csv > html.csv
 
 clean_sample :
-	rm sample.dot sample.csv sample.jpg
+	rm rd.jpg mm.jpg html.csv rd_composition.jpg
 	

data/bin/requidef

@@ -21,16 +21,25 @@ opt.on("--from=FromType") do |v|
   from = v
 end
 
+opt.on("--parse-lenient", "parse all text nodes as link nodes.") do |v|
+  # NOTE: Design Issue
+  # This uses global env table. If Ruby process has its own table, use it instead.
+  ENV["REQUIDEF_PARSE_LENIENT"] = "true"
+end
+
 opt.parse!(ARGV)
 
 def usage_msg
-"""  
-Usage:
+"""Usage:
 requidef supports translations from one file format to another one.
 You usually first create standard input and pipe it to requidef command and continue piping.
 
 Clear Example,
 cat input.mm | requidef --from=mm --to=rd | requidef --from=rd --to=dot > output.dot
+
+For more details, see help.
+
+Enjoy!
 """
 end
 

data/bin/requidef.rb

@@ -21,16 +21,25 @@ opt.on("--from=FromType") do |v|
   from = v
 end
 
+opt.on("--parse-lenient", "parse all text nodes as link nodes.") do |v|
+  # NOTE: Design Issue
+  # This uses global env table. If Ruby process has its own table, use it instead.
+  ENV["REQUIDEF_PARSE_LENIENT"] = "true"
+end
+
 opt.parse!(ARGV)
 
 def usage_msg
-"""  
-Usage:
+"""Usage:
 requidef supports translations from one file format to another one.
 You usually first create standard input and pipe it to requidef command and continue piping.
 
 Clear Example,
 cat input.mm | requidef --from=mm --to=rd | requidef --from=rd --to=dot > output.dot
+
+For more details, see help.
+
+Enjoy!
 """
 end
 

data/bin/sample.rd

@@ -1,6 +1,11 @@
-- a
+- aaa bbb
 -- b
---- c
--- d
---- [[t:e]]
+
+// comment
+--- ccc, ddd
+// this 's' should be a link if lenient mode.
+-- s
+--- [[t:eee fff]]
+--- [[s]]
 - >>t
+- >>link can not find tag

data/bin/sample2.rd

@@ -0,0 +1,2 @@
+- >>b
+-- >>t

data/lib/generic/tree.rb

@@ -49,6 +49,13 @@ class Tree
     @values[id] = value 
   end
 
+  def update_value(id, value)
+    # In current version, 
+    # update_value is just a wrapper of add_node.
+    # but in future version, this may need modification.
+    add_node(id, value)
+  end
+
   def add_edge(from, to)
     register_edge(from, to)
     register_parent(to, from)

data/lib/rd2rdnodes.rb

@@ -1,7 +1,18 @@
 require_relative "rdnode"
 
+def rd2lines(rd)
+  all_lines = rd.split("\n")
+  all_lines
+  .delete_if do |line|
+    line.empty?
+  end
+  .delete_if do |line|
+    line.start_with? "//"
+  end 
+end
+
 def rd2rdnodes( rd)
-  lines = rd.split("\n")
+  lines = rd2lines(rd)
   nodes = lines2nodes(lines)
   nodes 
 end
@@ -19,6 +30,10 @@ def lines2nodes(lines)
   xs 
 end
 
+def parse_lenient?
+  ENV["REQUIDEF_PARSE_LENIENT"] == "true"
+end
+
 # Example,
 # --- aaa => Text(3, "aaa")
 # -- >>bbb => Link(2, "bbb")
@@ -35,22 +50,39 @@ def line2node(line)
     ss = parse_tag(rest)
     return Tag.new(depth, ss[0], ss[1]) 
   else
+    # NOTE: Design Issue
+    # If REQUIDEF_PARSE_LENIENT flag is on,
+    # This software understands every text nodes as link nodes whose dest is text.
+    if parse_lenient?
+      $stderr << "parse_lenient? true"
+      ss = parse_text(rest)
+      return Link.new(depth, ss)
+    end
     ss = parse_text(rest)
     return Text.new(depth, ss)
   end
 end
 
-# NOTE: under-engineering
+# NOTE: Under Engineering
 def parse_link(s)
   # Fix: Delete only the first >> 
   s.delete ">>" 
 end
 
-# NOTE: under-engineering
+# NOTE: Under Engineering
 def parse_tag(s)
   ss = s.delete("[[").delete("]]")
   # Fix: What happen if having two colons
-  ss.split(":")
+  # In current version, if haveing two colons will cause unexpected output or runtime error.
+  xs = ss.split(":")
+  case xs.size
+  when 1
+    return [xs[0], xs[0]]
+  when 2
+    return xs
+  end
+  # In current  version, if more than two colons will raise exception.
+  raise "Parse Erorr. The line #{s} contains more than two colons"
 end
 
 def parse_text(s)

data/lib/rdtree.rb

@@ -4,7 +4,38 @@ require_relative "rdtree2dot"
 
 class Tree
 
+  # NOTE: About Design. In current design, 
+  # a link node that can not find the tag node it points to
+  # is treated as text node.
+  def not_found_link2text!
+    list_link_nodes.each do |id|
+      if can_not_find_tag(id)
+        modify_link2text(id)
+      end
+    end
+  end
+
+  # NOTE: Crazy Design
+  # Akira Hayakawa, Aug 23, 2011
+  # This method must be called wherever it needs the rationalized state.
+  # For exmaple, a Link node that can not find the tag in the tree should be altered to Text node.
+  # But, this is innately a bad design.
+  # Because of my incapable of not coming up with a good idea to solve this issue elegantly.
+  # The version 2.0.2 scattered this method to to_csv and to_dot.
+  # But I do not know if this is sufficient.
+  # To solve this issue theoritically, embed this method into every single mutate methods of the instance mattered.
+  #
+  # If you embed this method, please leave comment "# CRAZY" there
+  # so that you can remove after I find a better solution.
+  #
+  # A solution is to simplify the design that lets every paths through RDTree structure.
+  # Then call rationalize only one time before it is needed, case of conversion for example.
+  def rationalize!
+    not_found_link2text!
+  end
+
   def to_csv 
+    rationalize! # CRAZY
     m = tree2matrix(self)
 
     range = [
@@ -21,11 +52,99 @@ class Tree
     end
     c
   end
+
+private
+
+  def modify_link2text(id)
+    linknode = value(id)
+    textnode = link2text(linknode)
+    update_value(id, textnode)
+  end
+
+  # NOTE: Maybe Under-Engineering.
+  # id of node, tmp field are not copied but
+  # this time, I decided not because I considered unnessessary.
+  def link2text(linknode)
+    depth = linknode.depth
+    text = linknode.dest
+    Text.new(depth, text)
+  end
+
+  # NOTE: Performance Issue
+  # The following methods call mk_xxx method
+  # everytime they need the information.
+  # Current version adopts lazy evaluation technique
+  # to always keep the state of RDTree new.
+  # 
+  # Now, my consideration is this is OK.
+  # Because the mk_xxx functions have complexity of O(N)
+  # where N is the number of nodes in the tree.
+  # Therefore, for small input, the performance will not
+  # go too bad.
+  #
+  # If, performance is found bad,
+  # first consider lazy instantiation technique.
+  def list_link_nodes
+    mk_id2tag.keys
+  end
+
+  def can_not_find_tag(id)
+    tag = mk_id2tag[id]
+    ! mk_tag2id.include? tag
+  end
+
+  def link_node?(id)
+    n = value(id)
+    n.class == Link
+  end
+
+  def mk_linkmap
+    # NOTE: is this use of warn method correct?
+    warn "Warning: mk_linkmap should not be used. mk_id2id instead."
+    mk_id2id
+  end  
+
+  def mk_id2id
+    id2tag = mk_id2tag
+    tag2id = mk_tag2id
+    id2id = {}
+    id2tag.keys.each do |id|
+      tag = id2tag[id]
+      if tag2id.include?( tag)
+        id2id[id] = tag2id[tag]
+      end
+    end
+    id2id
+  end
+
+  def mk_tag2id
+    tag2id = {}
+    for i in 0...size
+      n = value(i)
+      if n.class == Tag
+        tag2id[n.tag] = i
+      end
+    end
+    tag2id
+  end
+
+  def mk_id2tag
+    id2tag = {}
+    for i in 0...size
+      n = value(i)
+      if n.class == Link  
+        id2tag[i] = n.dest
+      end
+    end
+    id2tag
+  end
 end
 
 require_relative "rd2rdtree"
 if __FILE__ == $0
   t = rd2rdtree( File.read("sample.rd"))
-  puts t.to_csv
+  t.not_found_link2text!
+#  p t
+#  puts t.to_csv
   puts t.to_dot
 end

data/lib/rdtree2dot.rb

@@ -3,13 +3,14 @@ require_relative "generic/tree"
 class Tree
 
   def to_dot
+    rationalize! # CRAZY
     elems = []
     for i in 0...size
       unless link_node?(i)
         elems << dot_node_desc(i)
       end
     end
-    linkmap = mk_linkmap
+    linkmap = mk_id2id
     for i in 0...size
       if link_node?(i)
 	to = linkmap[i]
@@ -43,37 +44,4 @@ private
   def dot_edge_desc(from, to)
     "v#{from} -> v#{to};"
   end
-
-  def link_node?(id)
-    n = value(id)
-    n.class == Link
-  end
-
-  def mk_tag2id
-    tag2id = {}
-    for i in 0...size
-      n = value(i)
-      if n.class == Tag
-        tag2id[n.tag] = i
-      end
-    end
-    tag2id
-  end
-
-  def mk_linkmap
-    id2tag = {}
-    for i in 0...size
-      n = value(i)
-      if n.class == Link  
-        id2tag[i] = n.dest
-      end
-    end
-    id2id = {}
-    tag2id = mk_tag2id
-    id2tag.keys.each do |key|
-      tag = id2tag[key]
-      id2id[key] = tag2id[tag]
-    end
-    id2id
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requidef
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-22 00:00:00.000000000Z
+date: 2011-08-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &28580760 !ruby/object:Gem::Requirement
+  requirement: &28184820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *28580760
+  version_requirements: *28184820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &28580280 !ruby/object:Gem::Requirement
+  requirement: &28184340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *28580280
+  version_requirements: *28184340
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &28579800 !ruby/object:Gem::Requirement
+  requirement: &28183860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *28579800
+  version_requirements: *28183860
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &28579300 !ruby/object:Gem::Requirement
+  requirement: &28183380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28579300
+  version_requirements: *28183380
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &28182900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *28182900
 description: Which do you use for your requirement definition job? MS Excel? MS Word?
   Uninstall them. Because you will get a better solution.
 email: ruby.wktk@gmail.com
@@ -65,6 +76,7 @@ executables:
 - sample.html
 - sample.mm
 - sample.rd
+- sample2.rd
 extensions: []
 extra_rdoc_files:
 - ChangeLog.md
@@ -95,6 +107,7 @@ files:
 - bin/sample.html
 - bin/sample.mm
 - bin/sample.rd
+- bin/sample2.rd
 homepage: http://github.com/akiradeveloper/requidef
 licenses:
 - MIT
@@ -110,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2863670838995052431
+      hash: 226265604659266124
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: