klookup 0.2

data/lib/klookup/lookup.rb

@@ -0,0 +1,29 @@
+=begin
+
+  lib/klookup/lookup.rb
+
+  Copyright © Tom Adams 2006
+
+  This programme is free software.
+  You can distribute/modify this program under
+  the terms of the Ruby License.
+
+=end
+
+# A module containing abstract classes representing Radical and Kanji.
+module KLookup::Lookup
+
+  # Returns the default handler for database lookups.
+  def self.default_handler
+    KLookup::Database::FlatFile
+  end
+
+  # Set the handler used by both Kanji and Radical.
+  def self.handler=(h)
+    KLookup::Lookup::Kanji.handler=h
+    KLookup::Lookup::Radical.handler=h
+  end
+
+  require 'klookup/lookup_radical'
+  require 'klookup/lookup_kanji'
+end

data/lib/klookup/lookup_kanji.rb

@@ -0,0 +1,107 @@
+=begin
+
+  lib/klookup/lookup_kanji.rb
+
+  Copyright © Tom Adams 2006
+
+  This programme is free software.
+  You can distribute/modify this program under
+  the terms of the Ruby License.
+
+=end
+
+# An abstract representation of 漢字 (kanji).
+class KLookup::Lookup::Kanji
+  # A class variable because we have class methods which need this.
+  @@data = KLookup::Lookup.default_handler
+
+  def initialize(kanji)
+    unless @@data.instance.is_kanji?(kanji)
+      raise ArgumentError
+    end
+    @kanji=kanji.to_s
+    @reading=nil
+    @meaning=nil
+  end
+
+  # Get handler used by this class.
+  def self.handler
+    @@data
+  end
+
+  # Set handler used by this class (see also Lookup.handler=).
+  def self.handler=(h)
+    @@data = h
+  end
+
+  # Returns an array of Kanji that are made up of these +radicals+ which have
+  # +strokes+ strokes.
+  def self.lookup(strokes=nil, *radicals)
+    unless strokes.nil?
+      raise ArgumentError unless strokes.respond_to?(:to_i)
+      strokes=strokes.to_i
+    end
+
+    raise ArgumentError unless radicals.respond_to?(:to_a)
+    radicals = radicals.to_a.flatten
+    raise ArgumentError unless radicals.size > 0
+    radicals.collect! { |r|
+      raise ArgumentError unless r.respond_to?(:to_s)
+      r.to_s
+    }
+    return @@data.instance.get_kanji(strokes, radicals).collect {|k|
+      KLookup::Lookup::Kanji.new(k)
+    }
+  end
+
+  # Returns true if kanji exists in database.
+  def self.exist?(kanji)
+    begin
+      new(kanji)
+      return true
+    rescue ArgumentError
+      return false
+    end
+  end
+
+  def == (kanji)
+    unless kanji.is_a? KLookup::Lookup::Kanji
+      kanji = KLookup::Lookup::Kanji.new(kanji.to_s)
+    end
+    return true if kanji.to_s == to_s
+    false
+  end
+
+  # Returns an array of radicals that make up a kanji.
+  def radicals
+    return @@data.instance.get_radicals(to_s).collect {|r|
+      KLookup::Lookup::Radical.new(r)
+    }
+  end
+
+  # Returns a textual representation of a radical.
+  def to_s
+    @kanji
+  end
+
+  #Returns a Struct of arrays of Japanese readings.
+  #
+  # KLookup::Lookup::Kanji.new('富').reading
+  # KLookup::Database::FlatFile::KanjiDic.instance.get_reading('富')
+  # #=> #<struct #<Class:0xb7d3b5dc> reading=["フ", "フウ", "と.む", "とみ"],
+  #                                  name_reading=["と", "とん", "ふっ"]>
+  def reading
+    if @reading.nil?
+      @reading = @@data.instance.get_reading(to_s)
+    end
+    @reading
+  end
+
+  # Returns an array of English meanings.
+  def meaning
+    if @meaning.nil?
+      @meaning = @@data.instance.get_meaning(to_s)
+    end
+    @meaning
+  end
+end

data/lib/klookup/lookup_radical.rb

@@ -0,0 +1,74 @@
+=begin
+
+  lib/klookup/lookup_radical.rb
+
+  Copyright © Tom Adams 2006
+
+  This programme is free software.
+  You can distribute/modify this program under
+  the terms of the Ruby License.
+
+=end
+
+# An abstract representation of radicals.
+class KLookup::Lookup::Radical
+  # A class variable because we have class methods which need this.
+  @@data = KLookup::Lookup.default_handler
+
+  def initialize(radical)
+    unless @@data.instance.is_radical?(radical)
+      raise ArgumentError
+    end
+    @radical = radical.to_s
+  end
+
+  # Get handler used by this class.
+  def self.handler
+    @@data
+  end
+
+  # Set handler used by this class (see also Lookup.handler=).
+  def self.handler=(h)
+    @@data = h
+  end
+
+  # Return an array of how many strokes radicals can be made up of.
+  def self.strokes
+    @@data.instance.stroke_count_list
+  end
+
+  # Returns an array of radicals with +strokes+ strokes. Without an argument,
+  # all radicals are returned.
+  def self.list(strokes=nil)
+    if strokes.nil?
+      @@data.instance.radicals_by_strokes.values.flatten
+    else
+      raise ArgumentError unless strokes.respond_to?(:to_i)
+
+      @@data.instance.radicals_by_strokes[strokes.to_i]
+    end
+  end
+
+  # Returns true if +radical+ exists in the database.
+  def self.exist?(radical)
+    begin
+      new(radical)
+      return true
+    rescue ArgumentError
+      return false
+    end
+  end
+
+  def == (radical)
+    unless radical.is_a? KLookup::Lookup::Radical
+      radical = KLookup::Lookup::Radical.new(radical.to_s)
+    end
+    return true if radical.to_s == to_s
+    false
+  end
+
+  # Returns a textual representation of a radical.
+  def to_s
+    @radical
+  end
+end

data/test/suite.rb

@@ -0,0 +1,148 @@
+=begin
+
+  test/suite.rb
+
+  Copyright © Tom Adams 2006
+
+  This programme is free software.
+  You can distribute/modify this program under
+  the terms of the Ruby License.
+
+=end
+
+begin
+  require 'runicode_test'
+rescue LoadError
+end
+
+require 'klookup'
+require 'test/unit'
+
+# KLookup::Lookup tests
+class KLookup_Test < Test::Unit::TestCase
+
+  # Check classes
+  def test_radical_type
+    assert KLookup::Lookup::Radical.strokes.kind_of?(Array), 'KLookup::Lookup::Radical.strokes is an Array'
+    assert KLookup::Lookup::Radical.new('田').kind_of?(KLookup::Lookup::Radical), 'KLookup::Lookup::Radical initilaisation works'
+  end
+
+  # Check to_s behaviour
+  def test_radical_to_s
+    assert KLookup::Lookup::Radical.new('田').to_s=='田', 'A field is a field.'
+  end
+
+  def test_radical_list
+    assert KLookup::Lookup::Radical.list(1).any? {|k| k.to_s=='一'}, 'The first radical is fine.'
+    assert KLookup::Lookup::Radical.list(17).any? {|k| k.to_s=='龠'}, 'A flute is a flute.'
+  end
+
+  # Initialisation should work
+  def test_kanji_to_s
+    assert KLookup::Lookup::Kanji.new('猫').to_s=='猫', 'Cat.'
+    assert KLookup::Lookup::Kanji.new('栗').to_s=='栗', 'Chestnut.'
+  end
+
+  # Lookups should work
+  def test_kanji_lookup
+    # Cat
+    assert KLookup::Lookup::Kanji.lookup(nil, KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')).include?(KLookup::Lookup::Kanji.new('猫')), 'Without stroke count. Grass, left-dog, field => cat'
+    assert KLookup::Lookup::Kanji.lookup(11, KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')).include?(KLookup::Lookup::Kanji.new('猫')), 'With stroke count. Grass, left-dog, field => cat'
+    assert KLookup::Lookup::Kanji.lookup(nil, [KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')]).include?(KLookup::Lookup::Kanji.new('猫')), 'Without stroke count. Arrayed grass, left-dog, field => cat'
+    assert KLookup::Lookup::Kanji.lookup(11, [KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')]).include?(KLookup::Lookup::Kanji.new('猫')), 'With stroke count. Arrayed grass, left-dog, field => cat'
+
+    # Chestnut
+    assert KLookup::Lookup::Kanji.lookup(nil, KLookup::Lookup::Radical.new('西'), KLookup::Lookup::Radical.new('木')).include?(KLookup::Lookup::Kanji.new('栗')), 'Without stroke count. West, tree => chestnut.'
+    assert KLookup::Lookup::Kanji.lookup(10, KLookup::Lookup::Radical.new('西'), KLookup::Lookup::Radical.new('木')).include?(KLookup::Lookup::Kanji.new('栗')), 'With stroke count. West, tree => chestnut.'
+
+    # Test that radicals are using to_s
+    assert KLookup::Lookup::Kanji.lookup(10, '西'.to_sym, KLookup::Lookup::Radical.new('木'.to_sym)).include?(KLookup::Lookup::Kanji.new('栗'.to_sym)), 'With stroke count (and symbols). West, tree => chestnut.'
+  end
+
+  # Checks stroke count works
+  def test_kanji_lookup_stroke
+    # Unmatching stroke counts should result in empty lists
+    assert KLookup::Lookup::Kanji.lookup(10, [KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')])==[], '10 strokes for grass, left-dog, and field is impossible.'
+    assert KLookup::Lookup::Kanji.lookup(12, [KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')])==[], '12 strokes for grass, left-dog, and field results in no characters.'
+  end
+
+  def test_kanji_radicals
+    cat=KLookup::Lookup::Kanji.new('猫').radicals
+    catr=[KLookup::Lookup::Radical.new('艹'), KLookup::Lookup::Radical.new('犭'), KLookup::Lookup::Radical.new('田')]
+    unless cat.all? {|r| catr.include? r } and cat.size==catr.size
+      assert false, 'KLookup::Lookup::Kanji#radicals works fine.'
+    end
+  end
+
+  def test_kanji_meaning
+    pull = KLookup::Lookup::Kanji.new('引')
+    assert pull.meaning==['pull','tug','jerk','admit','install','quote',
+                          'refer to']
+    origin = KLookup::Lookup::Kanji.new('元')
+    assert origin.meaning==['beginning','former time','origin'], origin.to_s
+    i = KLookup::Lookup::Kanji.new('以')
+    assert i.meaning==['by means of','because','in view of','compared with'],
+    i.to_s
+  end
+
+  def test_kanji_reading
+    pull = KLookup::Lookup::Kanji.new('引')
+    assert pull.reading[:reading]==['イン','ひ.く','ひ.き','ひ.き-','-び.き','ひ.ける'], pull.to_s + ' reading'
+    assert pull.reading[:name_reading]==['いな','ひき','ひけ','びき'], pull.to_s + ' name_reading'
+  end
+
+  def test_multiple_kanji
+    begin
+      stupid = KLookup::Lookup::Kanji.new('馬鹿')
+      assert false, 'Failed to raise exception.'
+    rescue Exception
+      assert $!.is_a?(ArgumentError), 'Raised correct exception.'
+    end
+  end
+
+  def test_un_kanji
+    begin
+      not_a_kanji = KLookup::Lookup::Kanji.new('k')
+      assert false, 'Raised exception.'
+    rescue ArgumentError
+      # Win
+    end
+  end
+
+  def test_un_radical
+    begin
+      not_a_radical = KLookup::Lookup::Radical.new('r')
+      assert false, 'Raised exception.'
+    rescue ArgumentError
+      # Win
+    end
+  end
+
+  def test_exist
+    assert KLookup::Lookup::Kanji.exist?('猫')
+    assert (not KLookup::Lookup::Kanji.exist?('k'))
+
+    assert KLookup::Lookup::Radical.exist?('田')
+    assert (not KLookup::Lookup::Radical.exist?('た'))
+  end
+end
+
+
+require 'test/unit/ui/console/testrunner'
+results=[]
+db=KLookup::Database
+db.constants.each {|h|
+  handler = "#{db.to_s}::#{h}"
+  next unless eval(handler).superclass == db
+  puts
+  puts "== KLookup::Lookup.handler = #{handler}"
+  KLookup::Lookup.handler = eval(handler)
+  results << [handler, Test::Unit::UI::Console::TestRunner.run(KLookup_Test)]
+  puts
+}
+
+results.each {|p|
+  h,r=p
+  puts "#{r.passed? ? 'PASS' : 'FAIL'} : #{h}"
+  puts ("       %s" % r.to_s) unless r.passed?
+}

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: klookup
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+date: 2007-01-28 00:00:00 +00:00
+summary: A set of kanji lookup tools and a library.
+require_paths: 
+- lib
+email: tom@holizz.com
+homepage: http://klookup.rubyforge.org/
+rubyforge_project: klookup
+description: A character dictionary for Japanese kanji.
+autorequire: 
+default_executable: cklookup
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Tom Adams
+files: 
+- data/klookup/newradkfile
+- data/klookup/kanjidic
+- lib/klookup
+- lib/klookup.rb
+- lib/klookup/lookup_kanji.rb
+- lib/klookup/database.rb
+- lib/klookup/lookup.rb
+- lib/klookup/database_flatfile_kanjidic.rb
+- lib/klookup/database_unihan.rb
+- lib/klookup/lookup_radical.rb
+- lib/klookup/database_flatfile.rb
+- lib/klookup/database_flatfile_radk.rb
+test_files: 
+- test/suite.rb
+rdoc_options: 
+- - --main
+  - KLookup
+  - --charset
+  - UTF-8
+extra_rdoc_files: []
+
+executables: 
+- cklookup
+- gklookup
+- klookup.cgi
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: unihan
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 5.0.0.1.1
+    version: