logaling-command 0.1.2 → 0.1.3

data/CHANGES

@@ -1,3 +1,21 @@
+= 0.1.3 / 2012-02-29
+
+* Mozilla Japan プロジェクトの対訳用語集をインポートできるようにしました。(kdmsnr さん)
+
+* FreeBSD jpman プロジェクトの対訳用語集をインポートできるようにしました。
+
+* lookup 時にCSV、JSON形式で出力できるように --output オプションを用意しました。
+
+* lookup 時に翻訳言語が違う用語集や対訳からも検索出来るように --dictionary オプションを用意しました。
+
+* lookup、show、list を pager なしでも実行できるように、--no-pager オプションを用意しました。
+
+* lookup の検索結果に色付けをさせない --no-color オプションを用意しました。
+
+* .logaling を任意の場所に指定できるように --logaling-config オプションを用意しました。
+
+* --logaling-home を指定できなくなっていた不具合を修正しました。
+
 = 0.1.2 / 2012-01-30
 
 * 英和 / 和英 辞書のインポートができるようになりました。他プロジェクトの用語集をインポートする `loga import` と同じ手順でインポートすることができます。

data/README.md

@@ -5,22 +5,22 @@ You can add/update/delete terms to your glossary, and search glossaries at once.
 
 ### To install:
 
-  % gem install logaling-command
+    % gem install logaling-command
 
 ### Usage:
 
 Create new glossary:
 
-  % loga new my_glossary en ja
+    % loga new my_glossary en ja
 
 Add term to glossary:
 
-  % loga add developer 開発者
+    % loga add developer 開発者
 
 Lookup glossary:
 
-  % loga lookup develop<br/>
-    developer           ソフトウェア開発者 (my_glossary)
+    % loga lookup develop
+    developer           開発者 (my_glossary)
 
 ### License
 

data/bin/loga

@@ -21,5 +21,4 @@ LOGALING_HOME = File.expand_path("~/.logaling.d")
 
 require "logaling"
 
-Logaling::Command.start
-
+Logaling::Command::Application.start

data/lib/logaling/command/application.rb

@@ -0,0 +1,383 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  Miho SUZUKI
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'thor'
+require 'rainbow'
+require "logaling/repository"
+require "logaling/glossary"
+require "logaling/config"
+
+module Logaling::Command
+  LOGALING_CONFIG = '.logaling'
+
+  class Application < Thor
+
+    def initialize(*args)
+      super
+      @logaling_home = options["logaling-home"] ? options["logaling-home"] : LOGALING_HOME
+      @repository = Logaling::Repository.new(@logaling_home)
+      @config = Logaling::Config.load(@repository.config_path)
+
+      @dotfile_path = options["logaling-config"] ? options["logaling-config"] : find_dotfile
+      @project_config_path = File.join(@dotfile_path, 'config')
+      @config.load(@project_config_path)
+    rescue Logaling::CommandFailed # can't find .logaling
+      @project_config_path = nil
+    ensure
+      @config.merge!(options)
+    end
+
+    map '-a' => :add,
+        '-d' => :delete,
+        '-u' => :update,
+        '-l' => :lookup,
+        '-i' => :import,
+        '-n' => :new,
+        '-r' => :register,
+        '-U' => :unregister,
+        '-L' => :list,
+        '-s' => :show,
+        '-v' => :version
+
+    class_option "glossary",        type: :string, aliases: "-g"
+    class_option "source-language", type: :string, aliases: "-S"
+    class_option "target-language", type: :string, aliases: "-T"
+    class_option "logaling-home",   type: :string, aliases: "-h"
+    class_option "logaling-config", type: :string, aliases: "-c"
+
+    desc 'new [PROJECT NAME] [SOURCE LANGUAGE] [TARGET LANGUAGE(optional)]', 'Create .logaling'
+    method_option "no-register", type: :boolean, default: false
+    def new(project_name, source_language, target_language=nil)
+      unless File.exist?(logaling_config_path)
+        FileUtils.mkdir_p(File.join(logaling_config_path, "glossary"))
+
+        config = Logaling::Config.new("glossary" => project_name, "source-language" => source_language)
+        config.merge!("target-language" => target_language) if target_language
+        config.save(File.join(logaling_config_path, "config"))
+
+        unless options["no-register"]
+          @dotfile_path = options["logaling-config"] ? options["logaling-config"] : find_dotfile
+          @project_config_path = File.join(@dotfile_path, 'config')
+          @config.load(@project_config_path)
+          register
+        end
+        say "Successfully created #{logaling_config_path}"
+      else
+        say "#{logaling_config_path} already exists."
+      end
+    end
+
+    desc 'import', 'Import external glossary'
+    method_option "list", type: :boolean, default: false
+    def import(external_glossary=nil)
+      require "logaling/external_glossary"
+      Logaling::ExternalGlossary.load
+      if options["list"]
+        Logaling::ExternalGlossary.list.each {|glossary| say "#{glossary.name.bright} : #{glossary.description}" }
+      else
+        @repository.import(Logaling::ExternalGlossary.get(external_glossary))
+        @repository.index
+      end
+    rescue Logaling::ExternalGlossaryNotFound
+      say "'#{external_glossary}' can't find in import list."
+      say "Try 'loga import --list' and confirm import list."
+    end
+
+    desc 'register', 'Register .logaling'
+    def register
+      @config.check_required_option("glossary" => "input glossary name '-g <glossary name>'")
+      raise Logaling::CommandFailed, "Try 'loga new' first." unless File.exist?(@dotfile_path)
+
+      @repository.register(@dotfile_path, @config.glossary)
+      @repository.index
+      say "#{@config.glossary} is now registered to logaling."
+    rescue Logaling::CommandFailed => e
+      say e.message
+    rescue Logaling::GlossaryAlreadyRegistered => e
+      say "#{@config.glossary} is already registered."
+    end
+
+    desc 'unregister', 'Unregister .logaling'
+    def unregister
+      @config.check_required_option("glossary" => "input glossary name '-g <glossary name>'")
+
+      @repository.unregister(@config.glossary)
+      @repository.index
+      say "#{@config.glossary} is now unregistered."
+    rescue Logaling::CommandFailed => e
+      say e.message
+    rescue Logaling::GlossaryNotFound => e
+      say "#{@config.glossary} is not yet registered."
+    end
+
+    desc 'config [KEY] [VALUE] [--global(optional)]', 'Set config.'
+    method_option "global", type: :boolean, default: false
+    def config(key, value)
+      config_path = options["global"] ? File.join(@logaling_home, "config") : @project_config_path
+      config = Logaling::Config.load(config_path)
+      config.add(key, value)
+      config.save(config_path)
+      say "Successfully set config."
+    rescue Logaling::CommandFailed => e
+      say e.message
+    end
+
+    desc 'add [SOURCE TERM] [TARGET TERM] [NOTE(optional)]', 'Add term to glossary.'
+    def add(source_term, target_term, note='')
+      required_options = {
+        "glossary" => "input glossary name '-g <glossary name>'",
+        "source-language" => "input source-language code '-S <source-language code>'",
+        "target-language" => "input target-language code '-T <target-language code>'"
+      }
+      @config.check_required_option(required_options)
+      @repository.index
+
+      if @repository.bilingual_pair_exists?(source_term, target_term, @config.glossary)
+        raise Logaling::TermError, "term '#{source_term}: #{target_term}' already exists in '#{@config.glossary}'"
+      end
+
+      glossary.add(source_term, target_term, note)
+    rescue Logaling::CommandFailed, Logaling::TermError => e
+      say e.message
+    end
+
+    desc 'delete [SOURCE TERM] [TARGET TERM(optional)] [--force(optional)]', 'Delete term.'
+    method_option "force", type: :boolean, default: false
+    def delete(source_term, target_term=nil)
+      required_options = {
+        "glossary" => "input glossary name '-g <glossary name>'",
+        "source-language" => "input source-language code '-S <source-language code>'",
+        "target-language" => "input target-language code '-T <target-language code>'"
+      }
+      @config.check_required_option(required_options)
+
+      if target_term
+        glossary.delete(source_term, target_term)
+      else
+        glossary.delete_all(source_term, options["force"])
+      end
+    rescue Logaling::CommandFailed, Logaling::TermError => e
+      say e.message
+    rescue Logaling::GlossaryNotFound => e
+      say "Try 'loga new or register' first."
+    end
+
+    desc 'update [SOURCE TERM] [TARGET TERM] [NEW TARGET TERM] [NOTE(optional)]', 'Update term.'
+    def update(source_term, target_term, new_target_term, note='')
+      required_options = {
+        "glossary" => "input glossary name '-g <glossary name>'",
+        "source-language" => "input source-language code '-S <source-language code>'",
+        "target-language" => "input target-language code '-T <target-language code>'"
+      }
+      @config.check_required_option(required_options)
+      @repository.index
+
+      if @repository.bilingual_pair_exists_and_has_same_note?(source_term, new_target_term, note, @config.glossary)
+        raise Logaling::TermError, "term '#{source_term}: #{new_target_term}' already exists in '#{@config.glossary}'"
+      end
+
+      glossary.update(source_term, target_term, new_target_term, note)
+    rescue Logaling::CommandFailed, Logaling::TermError => e
+      say e.message
+    rescue Logaling::GlossaryNotFound => e
+      say "Try 'loga new or register' first."
+    end
+
+    desc 'lookup [TERM]', 'Lookup terms.'
+    method_option "output", type: :string, default: "terminal"
+    method_option "no-pager", type: :boolean, default: false
+    method_option "no-color", type: :boolean, default: false
+    method_option "dictionary", type: :boolean, default: false, aliases: "--dict"
+    def lookup(source_term)
+      @repository.index
+      terms = @repository.lookup(source_term, glossary, options["dictionary"])
+      unless terms.empty?
+        max_str_size = terms.map{|term| term[:source_term].size}.sort.last
+        run_pager
+        terms.each_with_index do |term, i|
+          source_string = extract_keyword_and_coloring(term[:snipped_source_term], term[:source_term])
+          target_string = extract_keyword_and_coloring(term[:snipped_target_term], term[:target_term])
+          note = term[:note].to_s unless term[:note].empty?
+          glossary_name = ""
+          if @repository.glossary_counts > 1
+            glossary_name = term[:glossary_name]
+            if term[:glossary_name] == @config.glossary
+              glossary_name = glossary_name.foreground(:white).background(:green)
+            end
+          end
+          printer(source_string, target_string, note,
+                  glossary_name, max_str_size, i, terms.length)
+        end
+      else
+        "source-term <#{source_term}> not found"
+      end
+    rescue Logaling::CommandFailed, Logaling::TermError => e
+      say e.message
+    end
+
+    desc 'version', 'Show version.'
+    def version
+      say "logaling-command version #{Logaling::Command::VERSION}"
+    end
+
+    desc 'show', 'Show terms in glossary.'
+    method_option "no-pager", type: :boolean, default: false
+    def show
+      required_options = {
+        "glossary" => "input glossary name '-g <glossary name>'",
+        "source-language" => "input source-language code '-S <source-language code>'",
+        "target-language" => "input target-language code '-T <target-language code>'"
+      }
+      @config.check_required_option(required_options)
+      @repository.index
+      terms = @repository.show_glossary(glossary)
+      unless terms.empty?
+        run_pager
+        max_str_size = terms.map{|term| term[:source_term].size}.sort.last
+        terms.each do |term|
+          target_string = "#{term[:target_term]}"
+          target_string <<  "\t# #{term[:note]}" unless term[:note].empty?
+          printf("  %-#{max_str_size+10}s %s\n", term[:source_term], target_string)
+        end
+      else
+        "glossary <#{@config.glossary}> not found"
+      end
+
+    rescue Logaling::CommandFailed, Logaling::GlossaryDBNotFound => e
+      say e.message
+    end
+
+    desc 'list', 'Show glossary list.'
+    method_option "no-pager", type: :boolean, default: false
+    def list
+      @repository.index
+      glossaries = @repository.list
+      unless glossaries.empty?
+        run_pager
+        glossaries.each do |glossary|
+          printf("  %s\n", glossary)
+        end
+      else
+        "There is no registered glossary."
+      end
+
+    rescue Logaling::CommandFailed, Logaling::GlossaryDBNotFound => e
+      say e.message
+    end
+
+    private
+    def glossary
+      @glossary ||= Logaling::Glossary.new(@config.glossary, @config.source_language, @config.target_language, @logaling_home)
+    end
+
+    def error(msg)
+      STDERR.puts(msg)
+      exit 1
+    end
+
+    def find_dotfile
+      dir = Dir.pwd
+      searched_path = []
+      while(dir) do
+        path = File.join(dir, '.logaling')
+        if File.exist?(path)
+          return path
+        else
+          if dir != "/"
+            searched_path << dir
+            dir = File.dirname(dir)
+          else
+            raise(Logaling::CommandFailed, "Can't found .logaling in #{searched_path}")
+          end
+        end
+      end
+    end
+
+    def logaling_config_path
+      if options["logaling-config"]
+        options["logaling-config"]
+      else
+        File.join(Dir.pwd, LOGALING_CONFIG)
+      end
+    end
+
+    # http://nex-3.com/posts/73-git-style-automatic-paging-in-ruby
+    def run_pager
+      return if options["no-pager"]
+      return if ::RUBY_PLATFORM =~ /win32/
+      return unless STDOUT.tty?
+
+      read, write = IO.pipe
+
+      unless Kernel.fork # Child process
+        STDOUT.reopen(write)
+        STDERR.reopen(write) if STDERR.tty?
+        read.close
+        write.close
+        return
+      end
+
+      # Parent process, become pager
+      STDIN.reopen(read)
+      read.close
+      write.close
+
+      ENV['LESS'] = 'FSRX' # Don't page if the input is short enough
+
+      # wait until we have input before we start the pager
+      Kernel.select [STDIN]
+      pager = ENV['PAGER'] || 'less'
+      exec pager rescue exec "/bin/sh", "-c", pager
+    end
+
+    def extract_keyword_and_coloring(snipped_term, term)
+      return term if snipped_term.empty? || options["no-color"]
+      display_string = snipped_term.map do |word|
+        word.is_a?(Hash) ? word[:keyword].bright : word
+      end
+      display_string = display_string.join
+      display_string
+    end
+
+    def printer(source_string, target_string, note=nil,
+                glossary_name, max_str_size, i, last)
+      case options["output"]
+      when "terminal"
+        unless note
+          format = target_string + "\t" + glossary_name
+        else
+          format = target_string + "\t# " + note + "\t" + glossary_name
+        end
+        printf("  %-#{max_str_size+10}s %s\n", source_string, format)
+      when "csv"
+        items = [source_string, target_string, note,
+                 @config.source_language, @config.target_language]
+        print(CSV.generate {|csv| csv << items})
+      when "json"
+        puts("[") if i == 0
+        puts(",") if i > 0
+        record = {
+          :source => source_string, :target => target_string, :note => note,
+          :source_language => @config.source_language,
+          :target_language => @config.target_language
+        }
+        print JSON.pretty_generate(record)
+        puts("\n]") if i == last-1
+      end
+    end
+  end
+end

data/lib/logaling/command/version.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  Miho SUZUKI
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Logaling
+  module Command
+    VERSION = "0.1.3"
+  end
+end