requidef 0.1.4 → 0.2.0

data/ChangeLog.md

@@ -1,13 +1,14 @@
 # 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.
+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,
+(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.
+* Fixed the flashed bugs in 0.1.0.
 * Provides some converter functionality.
 * It is now ready to get started by just gem installing.

data/README.md

@@ -3,11 +3,11 @@ 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 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.
+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 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 [r`ekwidef], will guide you to the haven where any documentation works are happy.
 

data/bin/Makefile

@@ -1,11 +1,11 @@
 sample : dot_sample csv_sample
 
 dot_sample :
-	requidef --type=dot --file=sample.rd > sample.dot
+	cat sample.mm | requidef --from=mm --to=rd | requidef --from=rd --to=dot > sample.dot
 	dot -Tjpg sample.dot -o sample.jpg
 
 csv_sample :
-	requidef -t csv -f sample.rd > sample.csv
+	cat sample.html | requidef --from=html --to=rd | requidef --from=rd --to=csv > sample.csv
 
 clean_sample :
 	rm sample.dot sample.csv sample.jpg

data/bin/requidef

@@ -3,33 +3,58 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require "requidef"
 require "optparse"
 
-def print_dot(input)
-  print dot(input)
+# Main 
+opt = OptionParser.new
+
+usage = nil
+opt.on("--usage") do |v|
+  usage = v
 end
 
-def print_csv(input)
-  print csv(input)
+to = nil
+opt.on("--to=ToType") do |v| 
+  to = v
 end
 
-# Main 
-opt = OptionParser.new
+from = nil
+opt.on("--from=FromType") do |v|
+  from = v
+end
 
-type = nil
-opt.on("-t", "--type=VAL") do |v| 
-  type = v
+opt.parse!(ARGV)
+
+def usage_msg
+"""  
+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
+"""
 end
 
-input = nil
-opt.on("-f", "--file=VAL") do |v|
-  input = v
+if usage
+  print usage_msg
+  exit
+end
+
+inp = STDIN.read
+
+def check_nil(x)
+  if x == nil
+    raise "input #{x} is nil"
+  end
+  x
 end
-opt.parse!(ARGV)
 
-case type 
+case to 
 when "dot"
-  print_dot(input)
+  print to_dot(inp)
 when "csv"
-  print_csv(input)
+  print to_csv(inp)
+when "rd"
+  print to_rd(inp, check_nil(from))
 else
-  raise "no match on type"
+  raise "no match on output type"
 end

data/bin/requidef.rb

@@ -3,33 +3,58 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require "requidef"
 require "optparse"
 
-def print_dot(input)
-  print dot(input)
+# Main 
+opt = OptionParser.new
+
+usage = nil
+opt.on("--usage") do |v|
+  usage = v
 end
 
-def print_csv(input)
-  print csv(input)
+to = nil
+opt.on("--to=ToType") do |v| 
+  to = v
 end
 
-# Main 
-opt = OptionParser.new
+from = nil
+opt.on("--from=FromType") do |v|
+  from = v
+end
 
-type = nil
-opt.on("-t", "--type=VAL") do |v| 
-  type = v
+opt.parse!(ARGV)
+
+def usage_msg
+"""  
+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
+"""
 end
 
-input = nil
-opt.on("-f", "--file=VAL") do |v|
-  input = v
+if usage
+  print usage_msg
+  exit
+end
+
+inp = STDIN.read
+
+def check_nil(x)
+  if x == nil
+    raise "input #{x} is nil"
+  end
+  x
 end
-opt.parse!(ARGV)
 
-case type 
+case to 
 when "dot"
-  print_dot(input)
+  print to_dot(inp)
 when "csv"
-  print_csv(input)
+  print to_csv(inp)
+when "rd"
+  print to_rd(inp, check_nil(from))
 else
-  raise "no match on type"
+  raise "no match on output type"
 end

data/bin/sample.html

@@ -0,0 +1,32 @@
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+<meta content="text/css" http-equiv="Content-Style-Type">
+<title>My Topic</title>
+</head>
+<body>
+<h1 align="center" class="root">
+<a name="21uvm94sj9outhm1magv3p9v9g">My Topic</a>
+</h1>
+<h2 class="topic">
+<a name="0rviipcu433ss8bf8p8t923995">A</a>
+</h2>
+<h3 class="topic">
+<a name="4979s7rvktpr6obojjre7bilsi">B</a>
+</h3>
+<h3 class="topic">
+<a name="4cvebhlh8g6og1quvcc1ak6pao">C</a>
+</h3>
+<h2 class="topic">
+<a name="0bthuesn7hpimsvun34ssbc26b">D</a>
+</h2>
+<h3 class="topic">
+<a name="4t16foto09kqkejjoqa1kof7sq">E</a>
+</h3>
+<h3 class="topic">
+<a name="2e2ls9uqeer5tee7a57d4tsdf3">F</a>
+</h3>
+</body>
+</html>
+

data/bin/sample.mm

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<map version="0.8.1">
+<node CREATED="1313987433061" ID="21uvm94sj9outhm1magv3p9v9g" MODIFIED="1313987433061" TEXT="My Topic">
+  <node CREATED="1313987433061" ID="0rviipcu433ss8bf8p8t923995" MODIFIED="1313987433061" POSITION="right" TEXT="A">
+    <node CREATED="1313987433061" ID="4979s7rvktpr6obojjre7bilsi" MODIFIED="1313987433061" TEXT="B"/>
+    <node CREATED="1313987433061" ID="4cvebhlh8g6og1quvcc1ak6pao" MODIFIED="1313987433061" TEXT="C"/>
+  </node>
+</node>
+</map>

data/lib/html2rd.rb

@@ -28,7 +28,7 @@ def repeat(n, s)
 end
 
 def read_body(html)
-  doc = Hpricot(open("sample.html"))
+  doc = Hpricot( html )
   x = ""
   (doc/"body").each do |e|
     x += e.to_html
@@ -37,7 +37,7 @@ def read_body(html)
 end
 
 if __FILE__ == $0
-  p html2rd("sample.html")
-  # p read_body("sample.html")
-  # p read_anchor("<a name=\"hoge\">text</a>")
+  p html2rd( File.read("sample.html") )
+  p read_body( File.read("sample.html") )
+  p read_anchor("<a name=\"hoge\">text</a>")
 end

data/lib/mm2rdtree.rb

@@ -2,10 +2,14 @@ require "rexml/document"
 require_relative "generic/tree"
 require_relative "rdnode"
 
-def mm2tree(mm)
+def mm2rdtree(mm)
   build_tree(mm)
 end
 
+def mm2tree(mm)
+  mm2rdtree(mm)
+end
+
 # Doc -> Tree (of Text node class)
 def build_tree(mm)
   t = Tree.new
@@ -37,18 +41,13 @@ def to_node(doc, depth)
 end
 
 def root_node_of(mm)
-  f = File.open(mm, "r")
-  
-  txt = f.read
-  doc = REXML::Document.new( txt )
-
-  f.close
+  doc = REXML::Document.new( mm )
   doc.root.elements[1]
 end
 
 if __FILE__ == $0
   # p root_node_of("sample.mm")
-  p mm2tree("sample.mm")
+  p mm2tree( File.read("sample.mm") )
 
   puts "# Test ------------------------"
   include REXML

data/lib/rd2rdnodes.rb

@@ -1,12 +1,14 @@
 require_relative "rdnode"
 
-# rd -> [node]
-def rd2nodes(file)
-  f = File.open(file, "r")
-  lines = f.read.split("\n")
+def rd2rdnodes( rd)
+  lines = rd.split("\n")
   nodes = lines2nodes(lines)
-  f.close
-  nodes
+  nodes 
+end
+
+# rd -> [node]
+def rd2nodes(rd)
+  rd2rdnodes(rd)
 end
 
 def lines2nodes(lines)
@@ -57,6 +59,6 @@ end
 
 if __FILE__ == $0
   puts "nodes from .rd"
-  nodes = rd2nodes("sample.rd")  
+  nodes = rd2nodes( File.read("sample.rd") )  
   puts nodes
 end

data/lib/rd2rdtree.rb

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

data/lib/rdnodes2rdtree.rb

@@ -1,6 +1,10 @@
 require_relative "generic/tree"
 require_relative "rdnode"
 
+def rdnodes2rdtree(nodes)
+  nodes2tree(nodes)
+end
+
 def nodes2tree(nodes)
   nodess = depth2link(nodes)
   t = Tree.new

data/lib/rdtree.rb

@@ -25,7 +25,7 @@ end
 
 require_relative "rd2rdtree"
 if __FILE__ == $0
-  t = rd2rdtree("sample.rd")
+  t = rd2rdtree( File.read("sample.rd"))
   puts t.to_csv
   puts t.to_dot
 end

data/lib/rdtree2rd.rb

@@ -1,5 +1,9 @@
 require_relative "generic/tree"
 
+def rdtree2rd(tree)
+  tree.to_rd
+end
+
 class Tree
   def to_rd
     nodes = list_depth_traverse(root_id)
@@ -13,6 +17,6 @@ end
 
 require_relative "rd2rdtree"
 if __FILE__ == $0
-  t = rd2rdtree( "sample.rd" )
+  t = rd2rdtree( File.read("sample.rd"))
   print t.to_rd
 end

data/lib/requidef.rb

@@ -1,17 +1,31 @@
 require_relative "rdtree"
 require_relative "rd2rdnodes"
 require_relative "rdnodes2rdtree"
+require_relative "html2rd"
+require_relative "mm2rdtree"
+require_relative "rdtree2rd"
 
-def rd2tree(file)
-  nodes2tree( rd2nodes(file) )
+# File -> String
+def to_dot(txt)
+  rd2rdtree( txt ).to_dot
 end
 
 # File -> String
-def dot(file)
-  rd2tree(file).to_dot
+def to_csv(txt)
+  rd2rdtree( txt ).to_csv
 end
 
-# File -> String
-def csv(file)
-  rd2tree(file).to_csv
+def to_rd(txt, ext)
+  case ext
+  when "mm"
+    return mm2rd(txt)
+  when "html"
+    return html2rd(txt)
+  else
+    raise "the input stream assumed type can not translate into rd."
+  end
+end
+
+def mm2rd(txt)
+  rdtree2rd( mm2rdtree(txt))
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requidef
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &26055980 !ruby/object:Gem::Requirement
+  requirement: &28580760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *26055980
+  version_requirements: *28580760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &26055500 !ruby/object:Gem::Requirement
+  requirement: &28580280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *26055500
+  version_requirements: *28580280
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &26055020 !ruby/object:Gem::Requirement
+  requirement: &28579800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *26055020
+  version_requirements: *28579800
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &26054540 !ruby/object:Gem::Requirement
+  requirement: &28579300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *26054540
+  version_requirements: *28579300
 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
@@ -62,6 +62,8 @@ executables:
 - Makefile
 - requidef
 - requidef.rb
+- sample.html
+- sample.mm
 - sample.rd
 extensions: []
 extra_rdoc_files:
@@ -90,6 +92,8 @@ files:
 - bin/Makefile
 - bin/requidef
 - bin/requidef.rb
+- bin/sample.html
+- bin/sample.mm
 - bin/sample.rd
 homepage: http://github.com/akiradeveloper/requidef
 licenses:
@@ -106,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1372144996746053066
+      hash: -2863670838995052431
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: