ndc_tree 0.0.0

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'rubytree', '>=0.8.1'
+gem 'ruby-graphviz'
+
+group :development do
+  gem 'jeweler'
+  gem 'rake'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Mao Tsunekawa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,73 @@
+= ndc_tree
+
+link://output.gif
+
+ndc_treeはNDC(日本十進分類法)のコードを木構造データとして集計して視覚化するツールです。
+
+ndc_tree is a ruby gem aggregating and visualizing a list of NDC(Nippon Decimal Classification).
+
+== Requirements
+
+- GraphViz
+- rubytree
+- ruby-graphviz
+
+== How to use
+
+NdcTreeを作成するには、NdcTree << メソッドでNDCコードのリストを入力します。
+
+If you want to generate NDC Tree, apply NdcTree << and input a list of NDC.
+
+  require 'ndc_tree'
+
+  tree = NdcTree << %w{
+    913.6
+    411
+    007
+    913.6
+    914
+    914.6
+    913.6
+    913.6
+    913.6
+    913.6
+  }
+
+テキスト形式でNDCツリーを表示することができます。
+
+With print_tree method, you can show text-based NDC Tree.
+ 
+  tree.print_tree
+
+NDCツリーはGraphVizを使って画像形式で出力することができます。
+
+ndc_tree can generate a image of NDC Tree with GraphViz.
+
+  tree.print_image(:gif=>"output.gif")
+
+もし画像のレイアウトを変更したい場合は、print_imageを実行する際にブロックを与えてください。
+
+If you want to change design of tree image, use block. 
+
+  tree.print_image(:gif=>"output.gif") do |g|
+    g.node[:style] = "filled"
+    g.node[:shape] = "note"
+    g.node[:color] = "black"
+    g.node[:fontcolor] = "white"
+  end
+
+上のコード中の g は、GraphVizクラスのインスタンスです。
+
+In a above code, g is a instance of GraphViz object.
+
+== ライセンス ( Licence )
+
+MITライセンスです。
+
+This is MIT Licence.
+
+== Copyright
+
+Copyright (c) 2012 Mao Tsunekawa. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = File.read('VERSION')
+  gem.name = "ndc_tree"
+  gem.homepage = "http://github.com/tsunekawa/ndc_tree"
+  gem.license = "MIT"
+  gem.summary = %Q{NdcTree is a library outputs a list of NDC(Nippon Decimal Classification) as a tree-structured data}
+  gem.description = %Q{NdcTree is a library outputs a list of NDC(Nippon Decimal Classification) as a tree-structured data.}
+  gem.email = "tsunekaw@slis.tsukuba.ac.jp"
+  gem.authors = ["Mao Tsunekawa"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ndc_tree #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/example/graph.rb

@@ -0,0 +1,26 @@
+# -*- coding:utf-8 -*-
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), %w{ .. lib })
+
+require 'ndc_tree'
+
+tree = NdcTree << %w{
+  913.6
+  411
+  007
+  913.6
+  914
+  914.6
+  913.6
+  913.6
+  913.6
+  913.6
+}
+
+filepath = File.join(File.dirname(__FILE__), %w{ .. data })
+tree.print_image(:gif=>File.join(filepath,%w{output.gif})) do |g|
+  g.node[:style] = "filled"
+  g.node[:shape] = "note"
+  g.node[:color] = "black"
+  g.node[:fontcolor] = "white"
+end
+

data/lib/ndc_tree.rb

@@ -0,0 +1,18 @@
+# -*- coding:utf-8 -*-
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'tree'
+require 'graphviz'
+
+module NdcTree
+  extend self
+  VERSION = File.read(File.join(File.dirname(__FILE__),%w{ .. VERSION}))
+
+  # 
+  def <<(ndcs)
+    Node.new << ndcs
+  end
+
+  autoload :Node, "ndc_tree/node.rb"
+end

data/lib/ndc_tree/node.rb

@@ -0,0 +1,178 @@
+# -*- coding:utf-8 -*-
+
+class NdcTree::Node < Tree::TreeNode
+  class InputNdcError < Exception;end
+
+  attr_accessor :weight
+
+  ##
+  # converts this tree to array of nodes
+
+  alias_method :nodes, :to_a
+
+  ##
+  # Returns:: a instance object of NdcTree::Node
+  def initialize(name="root",content={})
+    @weight=1
+    super(name, content)
+  end
+
+  ##
+  #
+  # Returns:: a node has name same as a given key
+  
+  def [](key)
+    nodes.find {|node| node.name==key }
+  end
+
+  ##
+  # this method searches nodes have name matching a given expression
+  #
+  # Returns :: a list of NdcTree::Node objects.
+ 
+  def search(exp)
+    nodes.find_all {|node| node.name =~ exp }
+  end
+
+  ##
+  # this method sorts nodes at each layers by ndc codes ( it's bang method )
+  # Returns :: a instance object of NdcTree::Node
+  
+  def sort!
+    unless self.is_leaf? then
+      @children.sort!.map{|node| node.sort!}
+    end
+    self
+  end
+
+  ##
+  # sorts nodes at each layers by ndc codes ( it is not bang method )
+  #
+  # Returns :: a instance object of NdcTree::Node
+ 
+  def sort
+    node = self.dup
+    node.sort!
+  end
+
+  ##
+  # This method inserts a node has name same as given value as a child node.
+  # If given value is instance of Array, this method repeats inserting each element of value.
+  #
+  # Returns :: self instance
+
+  def <<(value)
+    case value.class.name.to_sym
+      when :String
+	add_ndc(value)
+      when :Array
+	value.flatten.each{|v| add_ndc(v) }
+      when :Node
+	super
+      else
+	raise TypeError,"#{value} is not valid"
+    end 
+    self
+  end
+
+  ##
+  # This method loads dump of a tree formatted marshal object.
+  #
+  # Return :: self instance
+  
+  def marshal_load(dumped_tree_array)
+    nodes = { }
+    dumped_tree_array.each do |node_hash|
+      name        = node_hash[:name]
+      parent_name = node_hash[:parent]
+      content     = Marshal.load(node_hash[:content])
+
+      if parent_name then
+	nodes[name] = current_node = self.class.new(name, content)
+	nodes[parent_name].add current_node
+      else
+	# This is the root node, hence initialize self.
+	initialize(name, content)
+
+	nodes[name] = self    # Add self to the list of nodes
+      end
+    end
+  end
+
+  # This method output a image file with GraphViz.
+  #
+  # Returns :: true
+  # Raise :: when given file path is wrong
+  def print_image(opts={:gif=>"ndc_tree.gif"},&block)
+    sort!
+
+    g = GraphViz::new("G")
+    set_default_style
+    to_graphviz(g,opts)
+
+    yield g if block_given?
+
+    g.output(opts)
+    true
+  end
+
+  protected
+
+  def add_ndc (str) #nodoc#
+    unless /^[0-9]{3}(\.[0-9]+){0,1}$/ =~ str
+      raise InputNdcError, "入力された文字列(#{str})はNDCコードではありません" 
+    end
+
+    labels=Array.new
+    name = ""
+    node = self
+    str.split(//).each do |n|
+      name+=n
+      asta= "*"*([3-name.size,0].max) 
+      next if n=="."
+      label = name+asta
+      if node[label].nil? then
+	unless node.is_leaf? then
+	  index = -1 
+	else
+	  index = node.children.inject(-1) {|count,n|
+	    (n.name > label) ? count : count+1
+	  }
+	end
+	node.add(self.class.new(label),index)
+      else
+	node[label].weight+=1
+      end
+      node = node[label]
+    end
+
+    self
+  end
+
+  def set_default_style
+    g = GraphViz::new("G")
+    g.node[:style] = "filled"
+    g.node[:shape] = "note"
+    g.node[:color] = "black"
+    g.node[:fontcolor] = "white"
+  end
+
+  def to_graphviz(g,opts={})
+    case weight
+    when 0..1;color="black";
+    when 2..4;color="blue";
+    else;color="red";
+    end
+
+    gnode = g.add_nodes(name+"(#{weight})")
+    gnode[:color] = color
+
+    unless is_leaf? then
+      children.each do |node|
+	g.add_edges(gnode, node.to_graphviz(g,opts))
+      end
+    end
+    gnode
+  end
+
+end

data/lib/ndc_tree/version.rb

@@ -0,0 +1,2 @@
+#-*- coding:utf-8 -*-
+NdcTree::VERSION = "0.1.0"

data/ndc_tree.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ndc_tree"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mao Tsunekawa"]
+  s.date = "2012-02-12"
+  s.description = "NdcTree is a library outputs a list of NDC(Nippon Decimal Classification) as a tree-structured data."
+  s.email = "tsunekaw@slis.tsukuba.ac.jp"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "example/graph.rb",
+    "lib/ndc_tree.rb",
+    "lib/ndc_tree/node.rb",
+    "lib/ndc_tree/version.rb",
+    "ndc_tree.gemspec",
+    "spec/insert_spec.rb",
+    "spec/ndc_tree_spec.rb",
+    "spec/search_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/tsunekawa/ndc_tree"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "NdcTree is a library outputs a list of NDC(Nippon Decimal Classification) as a tree-structured data"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rubytree>, [">= 0.8.1"])
+      s.add_runtime_dependency(%q<ruby-graphviz>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rubytree>, [">= 0.8.1"])
+      s.add_dependency(%q<ruby-graphviz>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rubytree>, [">= 0.8.1"])
+    s.add_dependency(%q<ruby-graphviz>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/insert_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "NdcTree <<" do
+
+  subject { @tree = NdcTree << [ "913.6" ] }
+
+  it { should be_instance_of NdcTree::Node }
+
+  its(:name) { should == "root" }
+  its(:nodes) {
+    should be_instance_of Array
+    should have(5).items
+  }
+  its(:weight) { should >= 1 }
+  its(:children) {
+    should have(1).items 
+
+    corrects = [ "9**", "91*", "913", "913.6" ]
+    corrects.inject(subject.first) do |node, correct|
+      node.name.should  == correct
+      if node.is_leaf? then
+	next node
+      else
+        node.children.should have(1).items 
+        next node.children.first
+      end
+    end
+  }
+  its(:content) {
+    should be_instance_of Hash
+    should have(0).items
+  }
+
+end

data/spec/ndc_tree_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "NdcTree::Node" do
+
+  before do
+    @tree = NdcTree::Node.new
+  end
+
+  it "should initialize" do
+    @tree.should be_instance_of NdcTree::Node
+  end
+
+  it "should has name" do
+    @tree.name.should be_instance_of String
+  end
+
+  it "should not has accessor of name" do
+    (defined? @tree.name="newname").should be_nil
+  end
+
+  it "should has weight" do
+    @tree.weight.should > 0
+  end
+
+  it "should has content" do
+    @tree.content.should be_instance_of Hash
+  end
+
+  it "should has accessor of weight" do
+    @tree.weight = 1
+    @tree.weight.should == 1
+    @tree.weight+=1
+    @tree.weight.should == 2
+  end
+  
+end

data/spec/search_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "NdcTree::Node searching" do
+  subject { NdcTree << %w{ 913.6 913.6 914 400 007 515 } }
+
+  it {
+    result = subject["913.6"]
+    result.should be_instance_of NdcTree::Node
+    result.name.should == "913.6"
+    result.weight.should == 2
+  }
+
+  it {
+    result = subject["611"]
+    result.should be_nil
+  }
+
+  it {
+    result = subject.search(/^9/)
+    result.should be_instance_of Array
+    result.should have(5).items
+  }
+
+  it {
+    result = subject.search(/^1/)
+    result.should be_instance_of Array
+    result.should have(0).items
+  }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'ndc_tree'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ndc_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mao Tsunekawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: &80559200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *80559200
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: &80557600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80557600
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &80556190 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *80556190
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &80555280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *80555280
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &80569350 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *80569350
+description: NdcTree is a library outputs a list of NDC(Nippon Decimal Classification)
+  as a tree-structured data.
+email: tsunekaw@slis.tsukuba.ac.jp
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- example/graph.rb
+- lib/ndc_tree.rb
+- lib/ndc_tree/node.rb
+- lib/ndc_tree/version.rb
+- ndc_tree.gemspec
+- spec/insert_spec.rb
+- spec/ndc_tree_spec.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tsunekawa/ndc_tree
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 48156979
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: NdcTree is a library outputs a list of NDC(Nippon Decimal Classification)
+  as a tree-structured data
+test_files: []