hikiutils 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bda58449bae0510c3a9093331d8d6c6ea48ce376
-  data.tar.gz: 9b161e95894f2a018b609a761644af5f5c4a0207
+  metadata.gz: 4aab4b33d787a459fc7d72229c1924493a8e85b0
+  data.tar.gz: 360a2ff7e9a484d37993e1faf22b8f200bd54765
 SHA512:
-  metadata.gz: 95e0fa61f8b53a2f6460bce9b641b3013b67d277216ad534c155278d8dea7d3d2ac6affd6bdaf3c2a1514a99930de6ae5342ec2171ba82451463ef4f4d52b2cd
-  data.tar.gz: edead024fbf1958267db4e1eb5c3676b34d0e1c1d139c254434251e111961eb652b8cd616136149be93484c921f4fc38658c6fb88221be87d6996babc49841f5
+  metadata.gz: 2fdc4a29f28c4ab486ca74531ffb18c1c0d2ce9642f8f907989bfa93ed37f23e8c268abe9b1e7919798cacf120c2bf9f611f89ce88be155da0d9f2485de9dd7f
+  data.tar.gz: 7d5b656f83f8f4665ea769192fc3549c82d2ec6e495e510009489f743b40a83c6829ff3549bc7076e80fa4be9986b07900d530a59b1ee29f21c05584a35a8b91

data/.yardopts

@@ -1,2 +1,2 @@
 -
-docs/README.ja.md
+**/*.md

data/README.md

@@ -1,26 +1,29 @@
 # hikiutils
-Utilities for helping hiki editing.
+CMSソフトhikiのtextを直接編集するのを助けるutilitiesデス．
 
 # Features
-Direct file handling utility for hiki text, cache and rsync of local ang global hiki sites.
-
+hikiでlocalとglobalのサイトを管理している場合の，text, cache, rsyncなどでfilesを直接編集，操作するためのutilityデス．
 
 # Operation
 
-"hiki" is the command name.
+"hiki" をコマンド名としています．
 
 ```tcsh
-bob% hiki
-hiki says 'Hello world'.
 Usage: hiki [options]
     -v, --version                    show program Version.
     -s, --show                       show sources
     -a, --add                        add sources info
-    -t, --target [VAL]               set target number
+    -t, --target VAL                 set target id
     -e, --edit FILE                  open file
     -l, --list [FILE]                list files
-    -u, --update [FILE]              update file
+    -u, --update FILE                update file
     -r, --rsync                      rsync files
+        --database FILE              read database file
+        --display FILE               display converted hikifile
+    -c, --checkdb                    check database file
+        --remove FILE                remove file
+        --move FILES                 move file1,file2
+        --euc FILE                   translate file to euc
 ```
 
 ## Installation

data/Rakefile

@@ -1,42 +1,42 @@
 require "bundler/gem_tasks"
 require 'yard'
 require "rake/testtask"
+require 'fileutils'
 p base_path = File.expand_path('..', __FILE__)
 p basename = File.basename(base_path)
 
-#task :default => :test
 task :default do
   system 'rake -T'
 end
 
-
 desc "make documents by yard"
-task :yard do
-  hiki2md_all(basename)
+task :yard => [:hiki2md] do
   YARD::Rake::YardocTask.new
 end
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-#task :default => :spec
-
-def hiki2md_all(basename)
-  files = Dir.entries('docs')
+desc "transfer hikis/*.hiki to wiki"
+task :hiki2md do
+  files = Dir.entries('hikis')
   files.each{|file|
     name=file.split('.')
-    if name[1]=='hiki' then
-      p command="hiki2md docs/#{name[0]}.hiki > #{basename}.wiki/#{name[0]}.md"
+    case name[1]
+    when 'hiki'
+      p command="hiki2md hikis/#{name[0]}.hiki > #{basename}.wiki/#{name[0]}.md"
       system command
+    when 'gif','png','pdf'
+      p command="cp hikis/#{file} #{basename}.wiki/#{file}"
+#      system command
+      FileUtils.cp("hikis/#{file}","#{basename}.wiki/#{file}",:verbose=>true)
+      FileUtils.cp("hikis/#{file}","doc/#{file}",:verbose=>true)
     end
   }
-  system "cp #{basename}.wiki/README_ja.md README.md"
-  system "cp #{basename}.wiki/README_ja.md #{basename}.wiki/Home.md"
-  system "cp docs/*.gif #{basename}.wiki"
-  system "cp docs/*.gif doc"
-  system "cp docs/*.png #{basename}.wiki"
-  system "cp docs/*.png doc"
+  readme_en="#{basename}.wiki/README_en.md"
+  readme_ja="#{basename}.wiki/README_ja.md"
+  if File.exists?(readme_en)
+    FileUtils.cp(readme_en,"./README.md",:verbose=>true)  
+  elsif File.exists?(readme_ja)
+    FileUtils.cp(readme_ja,"./README.md",:verbose=>true)
+    FileUtils.cp(readme_ja,"#{basename}.wiki/Home.md",:verbose=>true)
+  end
 end
+

data/Rakefile.orig

@@ -0,0 +1,42 @@
+require "bundler/gem_tasks"
+require 'yard'
+require "rake/testtask"
+p base_path = File.expand_path('..', __FILE__)
+p basename = File.basename(base_path)
+
+#task :default => :test
+task :default do
+  system 'rake -T'
+end
+
+
+desc "make documents by yard"
+task :yard do
+  hiki2md_all(basename)
+  YARD::Rake::YardocTask.new
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+#task :default => :spec
+
+def hiki2md_all(basename)
+  files = Dir.entries('docs')
+  files.each{|file|
+    name=file.split('.')
+    if name[1]=='hiki' then
+      p command="hiki2md docs/#{name[0]}.hiki > #{basename}.wiki/#{name[0]}.md"
+      system command
+    end
+  }
+  system "cp #{basename}.wiki/README_ja.md README.md"
+  system "cp #{basename}.wiki/README_ja.md #{basename}.wiki/Home.md"
+  system "cp docs/*.gif #{basename}.wiki"
+  system "cp docs/*.gif doc"
+  system "cp docs/*.png #{basename}.wiki"
+  system "cp docs/*.png doc"
+end

data/{docs → hikis}/README_ja.hiki

@@ -1,26 +1,29 @@
 !hikiutils
-Utilities for helping hiki editing.
+CMSソフトhikiのtextを直接編集するのを助けるutilitiesデス．
 
 !Features
-Direct file handling utility for hiki text, cache and rsync of local ang global hiki sites.
-
+hikiでlocalとglobalのサイトを管理している場合の，text, cache, rsyncなどでfilesを直接編集，操作するためのutilityデス．
 
 !Operation
 
-"hiki" is the command name.
+"hiki" をコマンド名としています．
 
 <<< tcsh
-bob% hiki
-hiki says 'Hello world'.
 Usage: hiki [options]
     -v, --version                    show program Version.
     -s, --show                       show sources
     -a, --add                        add sources info
-    -t, --target [VAL]               set target number
+    -t, --target VAL                 set target id
     -e, --edit FILE                  open file
     -l, --list [FILE]                list files
-    -u, --update [FILE]              update file
+    -u, --update FILE                update file
     -r, --rsync                      rsync files
+        --database FILE              read database file
+        --display FILE               display converted hikifile
+    -c, --checkdb                    check database file
+        --remove FILE                remove file
+        --move FILES                 move file1,file2
+        --euc FILE                   translate file to euc
 >>>
 
 !! Installation

data/{docs → hikis}/README_ja.hiki.html

@@ -1,26 +1,35 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!DOCTYPE html
+    PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+    "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="ja">
 <html>
 <head>
-<title>docs/README_ja.hiki</title>
+  <meta http-equiv="Content-Language" content="ja">
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  <title>README_ja.hiki</title>
 </head>
 <body>
-<h1>hikiutils</h1>
-<p>Utilities for helping hiki editing.</p>
+  <h1>hikiutils</h1>
+<p>CMSソフトhikiのtextを直接編集するのを助けるutilitiesデス．</p>
 <h1>Features</h1>
-<p>Direct file handling utility for hiki text, cache and rsync of local ang global hiki sites.</p>
+<p>hikiでlocalとglobalのサイトを管理している場合の，text, cache, rsyncなどでfilesを直接編集，操作するためのutilityデス．</p>
 <h1>Operation</h1>
-<p>"hiki" is the command name.</p>
-<pre class="prettyprint">bob% hiki
-hiki says 'Hello world'.
-Usage: hiki [options]
+<p>"hiki" をコマンド名としています．</p>
+<pre>Usage: hiki [options]
     -v, --version                    show program Version.
     -s, --show                       show sources
     -a, --add                        add sources info
-    -t, --target [VAL]               set target number
+    -t, --target VAL                 set target id
     -e, --edit FILE                  open file
     -l, --list [FILE]                list files
-    -u, --update [FILE]              update file
-    -r, --rsync                      rsync files</pre>
+    -u, --update FILE                update file
+    -r, --rsync                      rsync files
+        --database FILE              read database file
+        --display FILE               display converted hikifile
+    -c, --checkdb                    check database file
+        --remove FILE                remove file
+        --move FILES                 move file1,file2
+        --euc FILE                   translate file to euc</pre>
 <h2>Installation</h2>
 <p>Installed by</p>
 <pre>$ gem install hikimode</pre>

data/hikis/yamane.hiki

@@ -0,0 +1,36 @@
+!目的
+
+hikiutilsを直感的なオプションに替える
+
+!背景
+
+hikiutilsはhikiの編集を効率的に行うためのutilitiesを提供している．
+しかし，そこで使われているoptionsは，あまり直感的でない．
+そこで，optionsをshellで使われているコマンドを元に，より直感的なものに変更する．
+
+!具体例
+
+ hiki --update FILE
+は変更したファイルをhikiに反映させるコマンドです．この操作を
+ hiki touch FILE
+とすると，FILEを最新の状態に変更するという意味で通じると思います．
+
+!使用法
+
+"hiki" をコマンド名としています．
+
+Usage: hiki [options]
+    -v, --version                    show program Version.
+    -s, --show                       show sources
+    -a, --add                        add sources info
+    -t, --target VAL                 set target id
+    -e, --edit FILE                  open file
+    -l, --list [FILE]                list files
+    -u, --update FILE                update file
+    -r, --rsync                      rsync files
+        --database FILE              read database file
+        --display FILE               display converted hikifile
+    -c, --checkdb                    check database file
+        --remove FILE                remove file
+        --move FILES                 move file1,file2
+        --euc FILE                   translate file to euc

data/hikiutils.gemspec

@@ -34,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "hiki2md"
+  spec.add_development_dependency "mathjax-yard"
+  spec.add_development_dependency "hiki2yard"
   spec.add_runtime_dependency "systemu"
   spec.add_runtime_dependency "hikidoc", "~> 0.1.0"
 end

data/hikiutils.wiki/Home.md

@@ -1,26 +1,29 @@
 # hikiutils
-Utilities for helping hiki editing.
+CMSソフトhikiのtextを直接編集するのを助けるutilitiesデス．
 
 # Features
-Direct file handling utility for hiki text, cache and rsync of local ang global hiki sites.
-
+hikiでlocalとglobalのサイトを管理している場合の，text, cache, rsyncなどでfilesを直接編集，操作するためのutilityデス．
 
 # Operation
 
-"hiki" is the command name.
+"hiki" をコマンド名としています．
 
 ```tcsh
-bob% hiki
-hiki says 'Hello world'.
 Usage: hiki [options]
     -v, --version                    show program Version.
     -s, --show                       show sources
     -a, --add                        add sources info
-    -t, --target [VAL]               set target number
+    -t, --target VAL                 set target id
     -e, --edit FILE                  open file
     -l, --list [FILE]                list files
-    -u, --update [FILE]              update file
+    -u, --update FILE                update file
     -r, --rsync                      rsync files
+        --database FILE              read database file
+        --display FILE               display converted hikifile
+    -c, --checkdb                    check database file
+        --remove FILE                remove file
+        --move FILES                 move file1,file2
+        --euc FILE                   translate file to euc
 ```
 
 ## Installation

data/hikiutils.wiki/README_ja.md

@@ -1,26 +1,29 @@
 # hikiutils
-Utilities for helping hiki editing.
+CMSソフトhikiのtextを直接編集するのを助けるutilitiesデス．
 
 # Features
-Direct file handling utility for hiki text, cache and rsync of local ang global hiki sites.
-
+hikiでlocalとglobalのサイトを管理している場合の，text, cache, rsyncなどでfilesを直接編集，操作するためのutilityデス．
 
 # Operation
 
-"hiki" is the command name.
+"hiki" をコマンド名としています．
 
 ```tcsh
-bob% hiki
-hiki says 'Hello world'.
 Usage: hiki [options]
     -v, --version                    show program Version.
     -s, --show                       show sources
     -a, --add                        add sources info
-    -t, --target [VAL]               set target number
+    -t, --target VAL                 set target id
     -e, --edit FILE                  open file
     -l, --list [FILE]                list files
-    -u, --update [FILE]              update file
+    -u, --update FILE                update file
     -r, --rsync                      rsync files
+        --database FILE              read database file
+        --display FILE               display converted hikifile
+    -c, --checkdb                    check database file
+        --remove FILE                remove file
+        --move FILES                 move file1,file2
+        --euc FILE                   translate file to euc
 ```
 
 ## Installation

data/hikiutils.wiki/yamane.md

@@ -0,0 +1,42 @@
+# 目的
+
+hikiutilsを直感的なオプションに替える
+
+# 背景
+
+hikiutilsはhikiの編集を効率的に行うためのutilitiesを提供している．
+しかし，そこで使われているoptionsは，あまり直感的でない．
+そこで，optionsをshellで使われているコマンドを元に，より直感的なものに変更する．
+
+# 具体例
+
+```
+hiki --update FILE
+```
+は変更したファイルをhikiに反映させるコマンドです．この操作を
+```
+hiki touch FILE
+```
+とすると，FILEを最新の状態に変更するという意味で通じると思います．
+
+# 使用法
+
+"hiki" をコマンド名としています．
+
+Usage: hiki [options]
+```
+-v, --version                    show program Version.
+-s, --show                       show sources
+-a, --add                        add sources info
+-t, --target VAL                 set target id
+-e, --edit FILE                  open file
+-l, --list [FILE]                list files
+-u, --update FILE                update file
+-r, --rsync                      rsync files
+--database FILE              read database file
+--display FILE               display converted hikifile
+-c, --checkdb                    check database file
+--remove FILE                remove file
+--move FILES                 move file1,file2
+--euc FILE                   translate file to euc
+```

data/lib/hikiutils.rb

@@ -36,7 +36,7 @@ HTML_TEMPLATE = <<EOS
 EOS
 
     def self.run(argv=[])
-      print "hiki says 'Hello world'.\n"
+      print "hikiutils: provide utilities for helping hiki editing.\n"
       new(argv).execute
     end
 
@@ -81,10 +81,11 @@ EOS
     def display(file)
       body = HikiDoc.to_html(File.read(file))
       source = HTML_TEMPLATE
-      title = ''
+      title = File.basename(file)
       erb = ERB.new(source)
       t = File.open(file+".html",'w')
       t.puts(erb.result(binding))
+      t.close
       system "open #{t.path}"
     end
 
@@ -248,6 +249,7 @@ EOS
     def show_sources()
       printf("target_no:%i\n",@src[:target])
       printf("editor_command:%s\n",@src[:editor_command])
+      check_display_size()
       header = display_format('id','name','local directory','global uri')
 
       puts header
@@ -264,10 +266,23 @@ EOS
 
     end
 
+    def check_display_size
+      @i_size,@n_size,@l_size,@g_size=3,5,30,15 #i,g_size are fixed
+      n_l,l_l=0,0
+      @src[:srcs].each_with_index{|src,i|
+        n_l =(n_l= src[:nick_name].length)>@n_size? n_l:@n_size
+        l_l =(l_l= src[:local_dir].length)>@l_size? l_l:@l_size
+      }
+      @n_size,@l_size=n_l,l_l
+    end
+
     def display_format(id, name, local, global)
-      name_length  = 5-full_width_count(name)
-      local_length = 45-full_width_count(local)
-      [id.to_s.rjust(3), name.ljust(name_length),local.ljust(local_length), global.center(10)].join(' | ')
+      name_length  = @n_size-full_width_count(name)
+      local_length = @l_size-full_width_count(local)
+      global_string= global.size < @g_size ? global : global[0..@g_size]
+      [id.to_s.rjust(@i_size), name.ljust(name_length),
+               local.ljust(local_length),
+                          global_string.ljust(@g_size)].join(' | ')
     end
 
     def full_width_count(string)

data/lib/hikiutils/version.rb

@@ -1,3 +1,3 @@
 module HikiUtils
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hikiutils
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Shigeto R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mathjax-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hiki2yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: systemu
   requirement: !ruby/object:Gem::Requirement
@@ -139,17 +167,20 @@ files:
 - LectureNotes
 - README.md
 - Rakefile
+- Rakefile.orig
 - bin/console
 - bin/setup
-- docs/README.hiki
-- docs/README.hiki.html
-- docs/README_ja.hiki
-- docs/README_ja.hiki.html
 - exe/hiki
+- hikis/README.hiki
+- hikis/README.hiki.html
+- hikis/README_ja.hiki
+- hikis/README_ja.hiki.html
+- hikis/yamane.hiki
 - hikiutils.gemspec
 - hikiutils.wiki/Home.md
 - hikiutils.wiki/README.md
 - hikiutils.wiki/README_ja.md
+- hikiutils.wiki/yamane.md
 - lib/hikiutils.rb
 - lib/hikiutils/infodb.rb
 - lib/hikiutils/tmarshal.rb
@@ -180,4 +211,3 @@ signing_key:
 specification_version: 4
 summary: helper of hiki editing.
 test_files: []
-has_rdoc: