character_to_description 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 238a4c54005ac74f56a4dffd5472eb9ed4d45a52
-  data.tar.gz: cf791830067b9401519cb5ca6586db4c735332be
+  metadata.gz: 3cf4f7ba86b76c320266992119fdbf09581a36be
+  data.tar.gz: 013f90790868b4085b5fc907bb5199f6abd7066d
 SHA512:
-  metadata.gz: 358238e8cf9cce971ad476a47d6089a26e74f8cd16eb94b0232461ee02d2dafa4ae904ba9671d863ec48f45058039913218b0768d838fa434a27beb80f16752c
-  data.tar.gz: 43c46e9d040a9307c5fc0e1d68c1fe04186ecb67d59bb08c18db49de99dc2ae9df94fdb98e97e4d59fbc67689646960b2f85da4af8cc2068785b59c9e975eae6
+  metadata.gz: 12a46853fb846a440f924c3de71707a1cebc1eab82419665ea41079ffee48d54a744da4da093de1460cc39b5b3bfd90dead615385d4c6353baa23ae46fc33cf9
+  data.tar.gz: 9ec7f01b7cbfe59e2d36b52121af66438cd4a59e24e9289e43a8f42c1295a807b76d6348786ac89b8ad9eefb47291d3c07a86549d44070b1f08589f37b0e1fde

data/README.md

@@ -1,11 +1,9 @@
 # CharacterToDescription
 
-The gem for converting a character into its description.
-
-This gem converts a character into its description by using the dictionary for NVDA, the screen reader for Windows.
+This gem converts a Japanese character into its description by using the dictionary for NVDA, the screen reader for Windows.
 There are many characters that are pronounced as the same in Japanese so that this gem currently targets to Japanese characters.
 
-## Quick start
+## Usage
 
 Install the gem by the following command:
 
@@ -19,12 +17,17 @@ Now you can convert a character into its description.
 require 'character_to_description'
 
 class String
-  def to_description
-    CharacterToDescription::Dictionary.description self
-  end
+  include CharacterToDescription
 end
 
-puts 'あ'.to_description
+puts 'あ'.to_description #=> ひらがなの「あ」
+```
+
+If you want to overwrite the built-in dictionary, you can modify `CharacterToDescription.user_dictionary`.
+
+```ruby
+CharacterToDescription.user_dictionary['あ'] = 'Hiragana letter'
+p 'あ'.to_description #=> "Hiragana letter"
 ```
 
 ## Development

data/lib/character_to_description.rb

@@ -1,37 +1,47 @@
 require "character_to_description/version"
 
 module CharacterToDescription
-  class Dictionary
-    @description_table = {}
+  DESCRIPTION_FOR_UNKNOWN = '説明がありません'
+  DICTIONARY_PATH = File.expand_path '../../descriptions.dic', __FILE__
 
-    File.open File.expand_path('../../descriptions.dic', __FILE__), 'r' do |file|
-      file.each_line do |line|
-        next if line.match /^#|^\r\n$/
-        fields = line.split "\t"
-        character = fields[0]
-        description = fields[1].chomp.gsub /[()]/, ''
-        @description_table[character] = description
-      end
+  @dictionary = {}
+  @user_dictionary = {}
+
+  File.open(DICTIONARY_PATH, 'r') do |file|
+    file.each_line do |line|
+      next if line.match /^#|^\r\n$/
+      fields = line.split "\t"
+      character = fields[0]
+      description = fields[1].chomp.gsub /[()]/, ''
+      @dictionary[character] = description
     end
-    class << self
-      def description(character)
-        return nil if character.empty?
-        character = character[0] if character.size > 1
-        case character
-        when /[a-z]/
-          "Lower case #{character}"
-        when /[A-Z]/
-          "Upper case: #{character}"
-        when /\p{Hiragana}/
-          "ひらがなの「#{character}」"
-        when /\p{Katakana}/
-          "カタカナの「#{character}」"
-        when /[一-龠]/
-          @description_table[character]
-        else
-          "不明な文字"
-        end
-      end
+  end
+
+  class << self
+    attr_reader :dictionary
+    attr_accessor :user_dictionary
+  end
+
+  def to_description
+    character = self[0]
+    description = CharacterToDescription.user_dictionary[character]
+
+    return description unless description.nil?
+
+    case character
+    when /[a-z]/
+      "Lower case #{character}"
+    when /[A-Z]/
+      "Upper case: #{character}"
+    when /\p{Hiragana}/
+      "ひらがなの「#{character}」"
+    when /\p{Katakana}/
+      "カタカナの「#{character}」"
+    when /[一-龠]/
+      CharacterToDescription.dictionary[character]
+    else
+      CharacterToDescription::DESCRIPTION_FOR_UNKNOWN
     end
   end
+  alias_method :to_d, :to_description
 end

data/lib/character_to_description/version.rb

@@ -1,3 +1,3 @@
 module CharacterToDescription
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: character_to_description
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Yoshiyuki Koyanagi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler