requidef 0.1.2 → 0.1.4

data/ChangeLog.md

@@ -0,0 +1,13 @@
+# version 0.1.0
+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.)
+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 reported bugs in 0.1.0.
+* Provides some converter functionality.
+* It is now ready to get started by just gem installing.

data/README.md

@@ -1,27 +1,19 @@
 # requidef
-Requiem for the Requirement Definitions.
+Requiem for the boring Requirement Definitions.
+Save time and get back to coding.
 
 ## Motivation
 Do you know the most and the last thing that hinder our technology grow rapidly in this century?
 The most harmful software, you know that is the MS Office.
-We, workers, are forced to write lenghty documents with MS Word, MS Excel ... you know what.
+We, workers, are forced to write ten of thousand of lenghty documents with MS Word, MS Excel ... you know what.
 I disrespect every single of the softwares MS provides.
 Today, we declared to be free from these greedy evils.
 
-This software, requidef, will guide you to the haven where any documentation works are happy.
+This software, requidef [r`ekwidef], will guide you to the haven where any documentation works are happy.
 
 ## Installation
 Only for Ruby >= 1.9
-
-gem install requidef
-
-## Recent Releases
-- 0.1.0
--- The consequence of 10 hours rapid developement.
-- Next : 0.2.0
--- Bug fix. Already found 3 
--- impl : tree -> rd
--- impl : http -> tree 
+just 'gem install requidef'.
 
 ## Contributing to requidef
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/bin/Makefile

@@ -1,11 +1,11 @@
 sample : dot_sample csv_sample
 
 dot_sample :
-	ruby requidef -t dot -f sample.rd > sample.dot
+	requidef --type=dot --file=sample.rd > sample.dot
 	dot -Tjpg sample.dot -o sample.jpg
 
 csv_sample :
-	ruby requidef -t csv -f sample.rd > sample.csv
+	requidef -t csv -f sample.rd > sample.csv
 
 clean_sample :
 	rm sample.dot sample.csv sample.jpg

data/bin/requidef

@@ -15,12 +15,12 @@ end
 opt = OptionParser.new
 
 type = nil
-opt.on("-t VAL") do |v| 
+opt.on("-t", "--type=VAL") do |v| 
   type = v
 end
 
 input = nil
-opt.on("-f VAL") do |v|
+opt.on("-f", "--file=VAL") do |v|
   input = v
 end
 opt.parse!(ARGV)

data/bin/requidef.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "requidef"
+require "optparse"
+
+def print_dot(input)
+  print dot(input)
+end
+
+def print_csv(input)
+  print csv(input)
+end
+
+# Main 
+opt = OptionParser.new
+
+type = nil
+opt.on("-t", "--type=VAL") do |v| 
+  type = v
+end
+
+input = nil
+opt.on("-f", "--file=VAL") do |v|
+  input = v
+end
+opt.parse!(ARGV)
+
+case type 
+when "dot"
+  print_dot(input)
+when "csv"
+  print_csv(input)
+else
+  raise "no match on type"
+end

data/lib/{matrix2csv.rb → generic/matrix2csv.rb}

@@ -1,13 +1,17 @@
 require_relative "matrix"
 
-def matrix2csv(matrix, &writer)
+def matrix2csv(matrix, range = [0...matrix.m_size, 0...matrix.n_size], &writer)
   s = ""
-  for i in 0...matrix.m_size   
+  for i in range[0]
     ms = []
-    for j in 0...matrix.n_size
+    ms_range = range[1]
+    for j in ms_range
       ms[j] = writer.call matrix.get([i,j])
     end
-    s += ms.join ","
+    # NOTE: The separator of csv file is decisively |
+    # I/F to change the charactor is the future work.
+    separator = "|"
+    s += ms[ms_range].join separator
     s += "\n" unless i == matrix.m_size - 1
   end
   s

data/lib/{tree.rb → generic/tree.rb}

@@ -5,6 +5,12 @@ class Tree
     @parents = []
   end
 
+  def list_depth_traverse(under)
+    list = []
+    do_list_depth_traverse(under, list)
+    return list
+  end
+
   def values
     @values
   end
@@ -58,6 +64,16 @@ class Tree
 
 private
   
+  def do_list_depth_traverse(under, list)
+    list << under
+    if leaf?(under)
+      return
+    end
+    children(under).each do |id|
+      do_list_depth_traverse(id, list)
+    end
+  end
+
   def register_edge(from, to)
     if @edges[from] == nil
       @edges[from] = Array.new
@@ -89,5 +105,5 @@ if __FILE__ == $0
     puts "children:#{t.children(i)}"
   end
 
-  
+  p t.list_depth_traverse(t.root_id)
 end

data/lib/html2rd.rb

@@ -0,0 +1,43 @@
+# NOTE:
+# HTML from XMind 3.2.1 lets only h1, h2 and h3.
+# So, this code only succeeds if the height of the tree is no more greater than 3.
+# No practical. Must reconsider.
+
+require "hpricot"
+
+def html2rd(html)
+  body = read_body(html)
+  regex = /<h(\d).*?>(.*?)<\/h\d>/m
+  body.scan(regex).map do |e|
+    hx2rd(e)
+  end.join("\n")
+end
+
+def hx2rd(header)
+  depth = header[0].to_i
+  s = read_anchor(header[1].strip)
+  "#{repeat(depth, "-")} #{s}"
+end
+
+def read_anchor(anchor)
+  anchor.scan(/<a.*?>(.*?)<\/a>/m)[0][0]
+end
+
+def repeat(n, s)
+  Array.new(n, s).join
+end
+
+def read_body(html)
+  doc = Hpricot(open("sample.html"))
+  x = ""
+  (doc/"body").each do |e|
+    x += e.to_html
+  end
+  x
+end
+
+if __FILE__ == $0
+  p html2rd("sample.html")
+  # p read_body("sample.html")
+  # p read_anchor("<a name=\"hoge\">text</a>")
+end

data/lib/mm2rdtree.rb

@@ -0,0 +1,81 @@
+require "rexml/document"
+require_relative "generic/tree"
+require_relative "rdnode"
+
+def mm2tree(mm)
+  build_tree(mm)
+end
+
+# Doc -> Tree (of Text node class)
+def build_tree(mm)
+  t = Tree.new
+  doc_root_id = 1
+  t.add_node(0, DummyRoot)
+  t.add_edge(0, doc_root_id)
+  do_build_tree(root_node_of(mm), doc_root_id, 1, t) 
+  t
+end
+
+def do_build_tree(doc, id, depth, t)
+  t.add_node( id, to_node(doc, depth) )
+  n = doc.elements.size
+  for i in 1...n+1
+    child_id = id+i
+    child_depth = depth + 1
+    child_doc = doc.elements[i]
+    child_value = to_node( child_doc, child_depth )
+    t.add_node( child_id, child_value )
+    t.add_edge( id, child_id )
+
+    do_build_tree( child_doc, child_id, child_depth, t )
+  end
+end
+
+def to_node(doc, depth)
+  text = doc.attributes["TEXT"]
+  Text.new(depth, text)
+end
+
+def root_node_of(mm)
+  f = File.open(mm, "r")
+  
+  txt = f.read
+  doc = REXML::Document.new( txt )
+
+  f.close
+  doc.root.elements[1]
+end
+
+if __FILE__ == $0
+  # p root_node_of("sample.mm")
+  p mm2tree("sample.mm")
+
+  puts "# Test ------------------------"
+  include REXML
+  f = File.open("sample.mm", "r")
+  txt = f.read
+
+  p txt
+  doc = Document.new txt
+  p doc
+  p doc.size
+  p "xx"
+  p doc.root.size
+  p doc.root.elements.size
+  p doc.root.elements[1]
+  p doc.root.elements[2]
+  p doc.root.elements[3]
+
+  n = doc.root.elements[1]
+  p n.attributes["TEXT"]
+
+  f.close
+
+  # Try:
+  # doc.size # what means?
+  # doc.root #=> Element
+  # doc.root.
+  # n.attributes[name]
+  
+  puts "# -----------------------------"
+end

data/lib/{rd2nodes.rb → rd2rdnodes.rb}

@@ -1,4 +1,4 @@
-require_relative "node"
+require_relative "rdnode"
 
 # rd -> [node]
 def rd2nodes(file)

data/lib/rd2rdtree.rb

@@ -0,0 +1,6 @@
+require_relative "rd2rdnodes"
+require_relative "rdnodes2rdtree"
+
+def rd2rdtree(rd)
+  nodes2tree( rd2nodes(rd) ) 
+end

data/lib/{node.rb → rdnode.rb}

@@ -25,6 +25,10 @@ class Link < Node
   def to_csv
     ""
   end
+
+  def to_rd
+    "#{dashes(@depth)} >>#{@dest}"
+  end
 end
 
 class Tag < Node
@@ -46,8 +50,13 @@ class Tag < Node
   def to_desc
     @text
   end
+
+  def to_rd
+    "#{dashes(@depth)} [[#{@tag}:#{@text}]]"
+  end
 end
 
+
 class Text < Node
   def initialize(depth, text)
     super(depth)
@@ -65,8 +74,18 @@ class Text < Node
   def to_desc
     @text
   end
+
+  def to_rd
+    "#{dashes(@depth)} #{@text}"
+  end
 end
 
+def dashes(n)
+  Array.new(n, "-").join ""
+end
+
+DummyRoot = Text.new(0, "DummyRoot")
+
 if __FILE__ == $0
   n = Text.new(10, "akira")
   n.tmp[:x] = 100

data/lib/{nodes2tree.rb → rdnodes2rdtree.rb}

@@ -1,5 +1,5 @@
-require_relative "tree"
-require_relative "node"
+require_relative "generic/tree"
+require_relative "rdnode"
 
 def nodes2tree(nodes)
   nodess = depth2link(nodes)
@@ -17,7 +17,7 @@ def nodes2tree(nodes)
 end
 
 def depth2link(nodes)
-  nodess = [Text.new(0, "Root")] + nodes        
+  nodess = [DummyRoot] + nodes        
   nodess.each_with_index do |n, i|
     n.id = i
   end

data/lib/rdtree.rb

@@ -0,0 +1,31 @@
+require_relative "generic/matrix2csv"
+require_relative "generic/tree2matrix"
+require_relative "rdtree2dot"
+
+class Tree
+
+  def to_csv 
+    m = tree2matrix(self)
+
+    range = [
+      0...m.m_size,
+      1...m.n_size]
+    c = matrix2csv(m, range) do |n|
+      s = nil
+      if n == nil
+        s = ""
+      else
+        s = n.to_csv
+      end
+      s
+    end
+    c
+  end
+end
+
+require_relative "rd2rdtree"
+if __FILE__ == $0
+  t = rd2rdtree("sample.rd")
+  puts t.to_csv
+  puts t.to_dot
+end

data/lib/{nodetree.rb → rdtree2dot.rb}

@@ -1,26 +1,7 @@
-require_relative "matrix2csv"
-require_relative "tree2matrix"
-require_relative "node"
+require_relative "generic/tree"
 
 class Tree
 
-  def to_csv 
-    m = tree2matrix(self)
-
-    # TODO: Link node write the tag it links to.
-    # Maybe, let Node has ID so we can reach the parent.
-    c = matrix2csv(m) do |n|
-      s = nil
-      if n == nil
-        s = ""
-      else
-        s = n.to_csv
-      end
-      s
-    end
-    c
-  end
-
   def to_dot
     elems = []
     for i in 0...size
@@ -43,13 +24,18 @@ class Tree
         elems << dot_edge_desc(i, child) unless link_node?(child)
       end
     end
+    
+    # NOTE: The ratio of the output figure is 1 at default.
+    # I/F to change the ratio is the future work.
 """
 digraph graphname {
+  graph [ratio = 1]
   #{elems.join("\n  ")}
 }
 """
   end
 
+private
   def dot_node_desc(id)
     "v#{id} [label=\"#{value(id).to_desc}\"];" 
   end
@@ -91,12 +77,3 @@ digraph graphname {
     id2id
   end
 end
-
-require_relative "rd2nodes"
-require_relative "nodes2tree"
-if __FILE__ == $0
-  t = nodes2tree( rd2nodes("sample.rd") ) 
-  p t
-  p t.to_csv
-  print t.to_dot
-end

data/lib/rdtree2rd.rb

@@ -0,0 +1,18 @@
+require_relative "generic/tree"
+
+class Tree
+  def to_rd
+    nodes = list_depth_traverse(root_id)
+    # NOTE: Eliminate the DummyRoot from rd file.
+    nodes.delete(root_id) 
+    nodes.map do |node|
+      value(node).to_rd
+    end.join("\n")
+  end
+end
+
+require_relative "rd2rdtree"
+if __FILE__ == $0
+  t = rd2rdtree( "sample.rd" )
+  print t.to_rd
+end

data/lib/requidef.rb

@@ -1,6 +1,6 @@
-require_relative "nodetree"
-require_relative "rd2nodes"
-require_relative "nodes2tree"
+require_relative "rdtree"
+require_relative "rd2rdnodes"
+require_relative "rdnodes2rdtree"
 
 def rd2tree(file)
   nodes2tree( rd2nodes(file) )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requidef
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-21 00:00:00.000000000Z
+date: 2011-08-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &25426960 !ruby/object:Gem::Requirement
+  requirement: &26055980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *25426960
+  version_requirements: *26055980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &25426440 !ruby/object:Gem::Requirement
+  requirement: &26055500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *25426440
+  version_requirements: *26055500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &25425880 !ruby/object:Gem::Requirement
+  requirement: &26055020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *25425880
+  version_requirements: *26055020
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &25425320 !ruby/object:Gem::Requirement
+  requirement: &26054540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,33 +54,42 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25425320
+  version_requirements: *26054540
 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
 executables:
 - Makefile
 - requidef
+- requidef.rb
 - sample.rd
 extensions: []
 extra_rdoc_files:
+- ChangeLog.md
 - LICENSE.txt
 - README.md
 files:
-- lib/matrix.rb
-- lib/matrix2csv.rb
-- lib/node.rb
-- lib/nodes2tree.rb
-- lib/nodetree.rb
-- lib/rd2nodes.rb
+- lib/generic/matrix.rb
+- lib/generic/matrix2csv.rb
+- lib/generic/row_of_nodes.rb
+- lib/generic/tree.rb
+- lib/generic/tree2matrix.rb
+- lib/html2rd.rb
+- lib/mm2rdtree.rb
+- lib/rd2rdnodes.rb
+- lib/rd2rdtree.rb
+- lib/rdnode.rb
+- lib/rdnodes2rdtree.rb
+- lib/rdtree.rb
+- lib/rdtree2dot.rb
+- lib/rdtree2rd.rb
 - lib/requidef.rb
-- lib/row_of_nodes.rb
-- lib/tree.rb
-- lib/tree2matrix.rb
+- ChangeLog.md
 - LICENSE.txt
 - README.md
 - bin/Makefile
 - bin/requidef
+- bin/requidef.rb
 - bin/sample.rd
 homepage: http://github.com/akiradeveloper/requidef
 licenses:
@@ -97,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3420236441750194994
+      hash: -1372144996746053066
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: