requidef 0.1.0 → 0.1.1

data/README.md

@@ -1,11 +1,33 @@
 # requidef
+Requiem for the Requirement Definitions.
 
 ## 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.
+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.
 
 ## Installation
+Only for Ruby >= 1.9
+
+gem install requidef
+
+or 
+
+git clone $(this repo) and add path to the bin dir.
+
+## 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 
 
 ## 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
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -15,7 +37,5 @@
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 ## Copyright
-
-Copyright (c) 2011 Akira Hayakawa. See LICENSE.txt for
+Copyright (c) 2011 Akira Hayakawa (@akiradeveloper). See LICENSE.txt for
 further details.
-

data/lib/matrix.rb

@@ -0,0 +1,74 @@
+class Matrix
+  def initialize()
+    @mat = []
+    @n = 0
+  end
+
+  def n_size
+    @n
+  end
+
+  def m_size
+    @mat.size
+  end
+
+  def set(at, value)
+    expand(at)
+    i = at[0]
+    j = at[1]
+    @mat[i][j] = value
+  end
+  
+  def get(at)
+    i = at[0]
+    j = at[1]
+    @mat[i][j]
+  end
+
+  def to_s
+    p @mat
+#    print "["
+#    print @mat.join(",\n")
+#    print "]\n"
+  end
+
+private 
+
+  def expand(by)
+    _m_size = by[0] + 1
+    _n_size = by[1] + 1
+
+    if _m_size > m_size
+      expand_m(_m_size)
+    end
+
+    if _n_size > n_size
+      expand_n(_n_size)
+    end
+
+  end
+
+  def expand_m(to)
+    (to-m_size).times do
+      @mat << Array.new(n_size)
+    end
+  end
+
+  def expand_n(to)
+    @mat.each do |x|
+      n = x.size
+      (to-n).times do
+        x << nil
+      end
+    end
+    @n = to
+  end
+end
+
+if __FILE__ == $0
+  m = Matrix.new
+  m.set([0,2], "akira")
+  puts m
+  m.set([2,0], "developer")
+  puts m
+end

data/lib/matrix2csv.rb

@@ -0,0 +1,31 @@
+require_relative "matrix"
+
+def matrix2csv(matrix, &writer)
+  s = ""
+  for i in 0...matrix.m_size   
+    ms = []
+    for j in 0...matrix.n_size
+      ms[j] = writer.call matrix.get([i,j])
+    end
+    s += ms.join ","
+    s += "\n" unless i == matrix.m_size - 1
+  end
+  s
+end
+
+if __FILE__ == $0
+  m = Matrix.new
+  m.set([0,1], "a")
+  m.set([1,0], "b")
+
+  t = matrix2csv(m) do |x|
+    s = nil
+    if x == nil
+      s = "" 
+    else
+      s = x*2
+    end
+    s
+  end
+  print t 
+end 

data/lib/node.rb

@@ -0,0 +1,74 @@
+class Node
+  def initialize(depth)
+    @depth = depth
+    @tmp = {}
+  end
+  attr_reader :tmp ,:depth
+  attr_accessor :id
+end
+
+class Link < Node
+  def initialize(depth, dest)
+    super(depth)
+    @dest = dest
+  end
+  attr_reader :dest
+
+  def to_s
+    "(Link depth:#{@depth}, dest:#{@dest}, tmp:#{@tmp})"
+  end   
+
+  def to_desc
+    ""
+  end
+
+  def to_csv
+    ""
+  end
+end
+
+class Tag < Node
+  def initialize(depth, tag, text)
+    super(depth)
+    @tag = tag
+    @text = text
+  end
+  attr_reader :tag
+
+  def to_s
+    "(Tag depth:#{@depth}, tag:#{@tag}, text:#{@text}, tmp:#{@tmp})"
+  end  
+
+  def to_csv
+    @text
+  end
+
+  def to_desc
+    @text
+  end
+end
+
+class Text < Node
+  def initialize(depth, text)
+    super(depth)
+    @text = text
+  end
+
+  def to_s
+    "(Text depth:#{@depth}, text:#{@text}, tmp:#{@tmp})"
+  end   
+
+  def to_csv
+    @text
+  end
+
+  def to_desc
+    @text
+  end
+end
+
+if __FILE__ == $0
+  n = Text.new(10, "akira")
+  n.tmp[:x] = 100
+  p n
+end

data/lib/nodes2tree.rb

@@ -0,0 +1,41 @@
+require_relative "tree"
+require_relative "node"
+
+def nodes2tree(nodes)
+  nodess = depth2link(nodes)
+  t = Tree.new
+  nodess.each do |n|
+    t.add_node(n.id, n)
+  end
+  for i in 1...nodess.size
+    n = nodess[i]
+    from = n.tmp[:parent_id]
+    to = n.id
+    t.add_edge(from, to)
+  end
+  t
+end
+
+def depth2link(nodes)
+  nodess = [Text.new(0, "Root")] + nodes        
+  nodess.each_with_index do |n, i|
+    n.id = i
+  end
+  current = [nodess[0]]
+  for i in 1...nodess.size
+    n = nodess[i]
+    x = n.depth - 1
+    n.tmp[:parent_id] = current[x].id
+    current[n.depth] = n
+  end
+  
+  nodess
+end
+
+if __FILE__ == $0
+  puts depth2link([Text.new(1, "akira"), Text.new(2, "developer")])
+  t = nodes2tree([Text.new(1, "akira"), Text.new(2, "developer")])
+
+  puts "------------"
+  puts t.size
+end

data/lib/nodetree.rb

@@ -0,0 +1,102 @@
+require_relative "matrix2csv"
+require_relative "tree2matrix"
+require_relative "node"
+
+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
+      unless link_node?(i)
+        elems << dot_node_desc(i)
+      end
+    end
+    linkmap = mk_linkmap
+    for i in 0...size
+      if link_node?(i)
+	to = linkmap[i]
+	from = parent(i)
+        elems << dot_edge_desc(from, to)
+	next
+      end
+      if leaf?(i)
+        next
+      end
+      children(i).each do |child|
+        elems << dot_edge_desc(i, child) unless link_node?(child)
+      end
+    end
+"""
+digraph graphname {
+  #{elems.join("\n  ")}
+}
+"""
+  end
+
+  def dot_node_desc(id)
+    "v#{id} [label=\"#{value(id).to_desc}\"];" 
+  end
+
+  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
+
+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/rd2nodes.rb

@@ -0,0 +1,60 @@
+require_relative "node"
+
+# rd -> [node]
+def rd2nodes(file)
+  f = File.open(file, "r")
+  lines = f.read.split("\n")
+  nodes = lines2nodes(lines)
+  f.close
+  nodes
+end
+
+def lines2nodes(lines)
+  xs = []
+  lines.each do |line|
+    xs << line2node(line)
+  end
+  xs 
+end
+
+# Example,
+# --- aaa => Text(3, "aaa")
+# -- >>bbb => Link(2, "bbb")
+# - [[ccc:ddd]] => Tag(1, "ccc", "ddd")
+def line2node(line)
+  splits = line.split(" ")
+  dashes = splits[0]
+  depth = dashes.split("").size
+  rest = splits[1...splits.size][0]
+  if rest.start_with?(">>")
+    ss = parse_link(rest)
+    return Link.new(depth, ss)
+  elsif rest.start_with?("[[")
+    ss = parse_tag(rest)
+    return Tag.new(depth, ss[0], ss[1]) 
+  else
+    ss = parse_text(rest)
+    return Text.new(depth, ss)
+  end
+end
+
+def parse_text(s)
+  s
+end
+
+# NOTE: under-engineering
+def parse_link(s)
+  s.delete ">>" 
+end
+
+# NOTE: under-engineering
+def parse_tag(s)
+  ss = s.delete("[[").delete("]]")
+  ss.split(":")
+end
+
+if __FILE__ == $0
+    puts "nodes from .rd"
+  nodes = rd2nodes("sample.rd")  
+  puts nodes
+end

data/lib/requidef.rb

@@ -0,0 +1,17 @@
+require_relative "nodetree"
+require_relative "rd2nodes"
+require_relative "nodes2tree"
+
+def rd2tree(file)
+  nodes2tree( rd2nodes(file) )
+end
+
+# File -> String
+def dot(file)
+  rd2tree(file).to_dot
+end
+
+# File -> String
+def csv(file)
+  rd2tree(file).to_csv
+end

data/lib/row_of_nodes.rb

@@ -0,0 +1,67 @@
+require_relative "tree"
+
+def row_of_nodes(tree)
+  RowOfNodes.new(tree).row_of_nodes
+end
+
+class RowOfNodes
+
+  def initialize(tree)
+    @tree = tree
+    @array = Array.new(tree.values.size, [0,0])
+  end 
+
+  def row_of_nodes
+    n = @tree.root_id
+    set_row_of_nodes(n)
+    @array.map { |xx| xx[0] }
+  end
+
+private
+
+  def set_row_of_nodes(id)
+    if @tree.leaf? id
+      @array[id][1] = 1
+      return 
+    end
+  
+    children_id = @tree.children(id)
+       
+    for i in 0...children_id.size
+      child_id = children_id[i]
+      a = @array[id][0] + @array[id][1]
+      # @array[child_id][0] = @array[id][0] + @array[id][1]
+      @array[child_id] = [a, @array[child_id][1]]
+      set_row_of_nodes(child_id)
+      # @array[id][1] += @array[child_id][1]
+      b = @array[id][1] + @array[child_id][1]
+      @array[id] = [@array[id][0], b]
+    end
+  end
+end
+
+if __FILE__ == $0
+  # test ------------------
+  a = [[1,1], [2,2]]
+  a[0][0] = a[0][0] + a[0][1]
+  p a #=> no problem.
+
+  # NOTE: 
+  # The problem occured above related to
+  # Array on recursion.
+  # -----------------------
+
+  t = Tree.new
+  t.add_node(0, nil)
+  t.add_node(1, nil)
+  t.add_node(2, nil)
+  t.add_node(3, nil)
+  t.add_node(4, nil)
+
+  t.add_edge(0, 2)
+  t.add_edge(0, 1)
+  t.add_edge(1, 3)
+  t.add_edge(1, 4)
+
+  p row_of_nodes(t)
+end

data/lib/tree.rb

@@ -0,0 +1,93 @@
+class Tree
+  def initialize
+    @values = []
+    @edges = []
+    @parents = []
+  end
+
+  def values
+    @values
+  end
+
+  def size
+    @values.size
+  end
+
+  def parent(id)
+    @parents[id]
+  end
+
+  def depth(id)
+    d = 0
+    i = id
+    until( i==root_id )
+      i = parent(i)
+      d += 1
+    end
+    d
+  end
+
+  def root_id
+    0
+  end
+  
+  def value(id)
+    @values[id]
+  end
+
+  def children(id)
+    @edges[id]
+  end
+  
+  def add_node(id, value)
+    @values[id] = value 
+  end
+
+  def add_edge(from, to)
+    register_edge(from, to)
+    register_parent(to, from)
+  end
+
+  def leaf?(id)
+    @edges[id] == nil
+  end
+
+  def branch?(id)
+    ! leaf?(id)
+  end
+
+private
+  
+  def register_edge(from, to)
+    if @edges[from] == nil
+      @edges[from] = Array.new
+    end
+    @edges[from] << to
+  end
+  
+  def register_parent(from, to)
+    @parents[from] = to  
+  end
+end
+
+if __FILE__ == $0
+  t = Tree.new
+  t.add_node(0, "a")
+  t.add_node(1, "b")
+  t.add_node(2, "c")
+  
+  t.add_edge(0, 1)
+  t.add_edge(1, 2)
+  [0,1,2].each do |i|
+    puts "id:#{i}"
+    puts "value:#{t.value(i)}"
+    puts "leaf?:#{t.leaf?(i)}"
+    puts "branch?:#{t.branch?(i)}"
+    puts "depth:#{t.depth(i)}"
+  end
+  [0,1].each do |i|
+    puts "children:#{t.children(i)}"
+  end
+
+  
+end

data/lib/tree2matrix.rb

@@ -0,0 +1,27 @@
+require_relative "matrix"
+require_relative "row_of_nodes"
+
+def tree2matrix(tree)
+  rows = row_of_nodes(tree)
+  m = Matrix.new
+  for i in 0...tree.size
+    m.set( [rows[i], tree.depth(i)], tree.value(i) )
+  end
+  m 
+end
+
+if __FILE__ == $0
+  t = Tree.new
+  t.add_node(0, 0)
+  t.add_node(1, 1)
+  t.add_node(2, 2)
+  t.add_node(3, 3) 
+  t.add_node(4, 4)
+
+  t.add_edge(0, 2)
+  t.add_edge(0, 1)
+  t.add_edge(1, 3)
+  t.add_edge(1, 4)
+
+  print tree2matrix(t)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requidef
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-20 00:00:00.000000000Z
+date: 2011-08-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11027760 !ruby/object:Gem::Requirement
+  requirement: &14359940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *11027760
+  version_requirements: *14359940
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &11027220 !ruby/object:Gem::Requirement
+  requirement: &14359460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *11027220
+  version_requirements: *14359460
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11026700 !ruby/object:Gem::Requirement
+  requirement: &14358980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *11026700
+  version_requirements: *14358980
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &11026160 !ruby/object:Gem::Requirement
+  requirement: &14358500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,12 +54,11 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11026160
+  version_requirements: *14358500
 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:
-- .requidef.swp
 - Makefile
 - requidef
 - sample.rd
@@ -68,9 +67,18 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- lib/matrix.rb
+- lib/matrix2csv.rb
+- lib/node.rb
+- lib/nodes2tree.rb
+- lib/nodetree.rb
+- lib/rd2nodes.rb
+- lib/requidef.rb
+- lib/row_of_nodes.rb
+- lib/tree.rb
+- lib/tree2matrix.rb
 - LICENSE.txt
 - README.md
-- bin/.requidef.swp
 - bin/Makefile
 - bin/requidef
 - bin/sample.rd
@@ -89,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2938751983039171718
+      hash: -4304971184590871815
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: