my_help 0.6.2 → 0.7.0

data/lib/my_help.rb

@@ -1,205 +1,6 @@
-# -*- coding: utf-8 -*-
-require "optparse"
-require "yaml"
+require 'my_help/version.rb'
+require 'my_help/my_help_controll'
 require 'my_help/org2yml'
-require 'my_help/yml2org'
-require "fileutils"
-require "my_help/version"
-require "systemu"
-require "colorize"
-
-module MyHelp
-  class Command
-
-    def self.run(argv=[])
-      new(argv).execute
-    end
-
-    def initialize(argv=[])
-      @argv = argv
-      @template_dir = File.expand_path("../../lib/templates", __FILE__)
-      @exe_path = File.expand_path("../../exe", __FILE__)
-      @local_help_dir = File.join(ENV['HOME'],'.my_help')
-      set_help_dir_if_not_exists
-    end
-
-    def set_help_dir_if_not_exists
-      return if File::exists?(@local_help_dir)
-      FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
-      Dir.entries(@template_dir).each{|file|
-        next if file=='template_help.org'
-        file_path=File.join(@local_help_dir,file)
-        next if File::exists?(file_path)
-        FileUtils.cp((File.join(@template_dir,file)),@local_help_dir,:verbose=>true)
-      }
-    end
-
-    def execute
-      @argv << '--help' if @argv.size==0
-      command_parser = OptionParser.new do |opt|
-        opt.on('-v', '--version','show program Version.') { |v|
-          opt.version = MyHelp::VERSION
-          puts opt.ver
-        }
-        opt.on('-l', '--list', 'list specific helps'){list_helps}
-        opt.on('-e NAME', '--edit NAME', 'edit NAME help(eg test_help)'){|file| edit_help(file)}
-        opt.on('-i NAME', '--init NAME', 'initialize NAME help(eq test_help)'){|file| init_help(file)}
-        opt.on('-m', '--make', 'make executables for all helps'){make_help}
-        opt.on('-c', '--clean', 'clean up exe dir.'){clean_exe_dir}
-        opt.on('-y', '--yml2org [FILE]', 'convert FILE from yaml to org format'){|file| yml2org(file)}
-        opt.on('--install_local','install local after edit helps'){install_local}
-        opt.on('--delete NAME','delete NAME help'){|file| delete_help(file)}
-      end
-      begin
-        command_parser.parse!(@argv)
-      rescue=> eval
-        p eval
-      end
-      exit
-    end
-
-    def yml2org(file)
-      p target = File.join(@local_help_dir,file+'.yml')
-      cont = YmlToOrg.new(target).contents
-      dump = file+'.org'
-      File.open(dump, 'w'){|file| file.print cont }
-      delete_help(file)
-    end
-
-    def delete_help(file)
-      del_files=[]
-      del_files << File.join(@local_help_dir,file+'.org')
-      exe_dir=File.join(File.expand_path('../..',@template_dir),'exe')
-      exe_0_dir= @exe_path
-      del_files << File.join(exe_dir,file)
-      del_files << File.join(exe_0_dir,file)
-      del_files << File.join(exe_dir,short_name(file))
-      del_files << File.join(exe_0_dir,short_name(file))
-      del_files.each do |file|
-        print "Are you sure to delete "+file.blue+"?[Ynq] ".red
-        case gets.chomp
-        when 'Y'
-          begin
-            FileUtils.rm(file,:verbose=>true)
-          rescue => error
-            puts error.to_s.red
-          end
-        when 'n' ; next
-        when 'q' ; exit
-        end
-      end
-    end
-
-    def install_local
-      status, stdout = systemu 'gem env gemdir'
-      system_inst_dir = stdout.chomp
-      local_help_entries.each do |file|
-        title = file.split('.')[0]
-        [title, short_name(title)].each do |name|
-          source = File.join(@exe_path, name)
-          target = File.join(system_inst_dir, 'bin', name)
-          FileUtils.cp(source, target,  verbose: true)
-        end
-      end
-    end
-
-    def short_name(file)
-      file_name=file.split('_')
-      return file_name[0][0]+"_"+file_name[1][0]
-    end
-
-    def make_help
-      local_help_entries.each{|file|
-        title = file.split('.')[0]
-        exe_cont=<<"EOS"
-#!/usr/bin/env ruby
-require 'specific_help'
-help_file = File.join(ENV['HOME'],'.my_help','#{file}')
-SpecificHelp::Command.run(help_file, ARGV)
-EOS
-        [title, short_name(title)].each do |name|
-          p target=File.join(@exe_path, name)
-          File.open(target,'w'){|file| file.print exe_cont}
-          FileUtils.chmod('a+x', target, :verbose => true)
-        end
-      }
-      install_local
-    end
-
-    def clean_exe_dir
-      local_help_entries.each{|file|
-        next if ['emacs_help.org', 'my_help.org',
-                 'my_todo.org', 'org_help.org'].include?(file)
-        file = File.basename(file,'.org')
-        [file, short_name(file)].each{|name|
-          p target=File.join(@exe_path, name)
-        begin
-          FileUtils::Verbose.rm(target)
-        rescue=> eval
-          puts eval.to_s.red
-        end
-        }
-      }
-    end
-
-    def init_help(file)
-      p target_help=File.join(@local_help_dir,file+'.org')
-      if File::exists?(target_help)
-        puts "File exists. --delete it first to initialize it."
-        exit
-      end
-      p template = File.join(@template_dir,'template_help.org')
-      FileUtils::Verbose.cp(template,target_help)
-    end
-
-    def edit_help(file)
-      target_help = File.join(@local_help_dir,file)
-      ['.yml','.org'].each do |ext|
-        p target_help += ext if local_help_entries.member?(file+ext)
-      end
-      system "emacs #{target_help}"
-    end
-
-    def local_help_entries
-      entries= []
-      Dir.entries(@local_help_dir).each{|file|
-        next unless file.include?('_')
-        next if file[0]=='#' or file[-1]=='~' or file[0]=='.'
-        next if file.match(/(.+)_e\.org/) # OK?
-        entries << file
-      }
-      return entries
-    end
-
-    def auto_load(file_path)
-      case File.extname(file_path)
-      when '.yml'
-        cont = YAML.load(File.read(file_path))
-      when '.org'
-        cont = OrgToYaml.new(file_path).help_cont
-      else
-        puts "Not handling file types of #{file}"
-      end
-      cont
-    end
-
-    def list_helps
-      print "Specific help file:\n"
-      local_help_entries.each do |file|
-        file_path=File.join(@local_help_dir,file)
-        title = file.split('.')[0]
-        begin
-          help = auto_load(file_path)
-        rescue=> eval
-          p eval.to_s.red
-          print "\n YAML load error in #{file}.".red
-          print "  Revise it by "+"my_help --edit #{title}\n".red
-          exit
-        end
-        desc = help[:head][:cont].split("\n")[0]
-        print "  #{title}\t: #{desc}\n".blue
-      end
-    end
-
-  end
-end
+require 'colorize'
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file

data/lib/my_help/my_help_controll.rb

@@ -0,0 +1,139 @@
+module MyHelp
+  class Control
+    def initialize()
+      @template_dir = File.expand_path("../../templates", __FILE__)
+      @exe_dir = File.expand_path("../../exe", __FILE__)
+      @local_help_dir = File.join(ENV['HOME'],'.my_help')
+      set_help_dir_if_not_exists
+    end
+
+    def set_help_dir_if_not_exists
+      return if File::exists?(@local_help_dir)
+      FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
+      Dir.entries(@template_dir).each{|file|
+        next if file=='template_help.org'
+        file_path=File.join(@local_help_dir,file)
+        next if File::exists?(file_path)
+        FileUtils.cp((File.join(@template_dir,file)),@local_help_dir,:verbose=>true)
+      }
+    end
+
+    def show_item(file, item)
+      file_path=File.join(@local_help_dir,file+'.org')
+      help = auto_load(file_path)
+      select = select_item(help, item)
+      print help[:head][:cont]
+      puts '-'*5+"\n"+select.to_s.red
+      print help[select][:cont]
+    end
+
+    def select_item(help, item)
+      o_key = ''
+      help.each_pair do |key, cont|
+        p key
+        next if key==:license or key==:head
+        if cont[:opts][:short] == item or cont[:opts][:long] == item
+          o_key = key
+          break
+        end
+      end
+      o_key
+    end
+
+    def list_help(file)
+      file_path=File.join(@local_help_dir,file+'.org')
+      help = auto_load(file_path)
+      help.each_pair do |key, conts|
+        print conts[:cont] if key==:head
+        disp_opts( conts[:opts] )
+      end
+    end
+
+    def disp_opts( conts )
+      col = 0
+      conts.each_pair do |key, item|
+        col_length = case col
+                     when 0; print item.rjust(5)+", "
+                     when 1; print item.ljust(15)+": "
+                     else; print item
+                     end
+        col += 1
+      end
+      print("\n")
+    end
+
+    def list_all
+      print "List all helps\n"
+      local_help_entries.each do |file|
+        file_path=File.join(@local_help_dir,file)
+        title = file.split('.')[0]
+        help = auto_load(file_path)
+        next if help.nil?
+        desc = help[:head][:cont].split("\n")[0]
+        print "  #{title}\t: #{desc}\n".blue
+      end
+    end
+
+    def edit_help(file)
+      target_help = File.join(@local_help_dir,file)
+      ['.yml','.org'].each do |ext|
+        p target_help += ext if local_help_entries.member?(file+ext)
+      end
+      system "emacs #{target_help}"
+    end
+
+    def init_help(file)
+      if file.nil?
+        puts "specify NAME".red
+        exit
+      end
+      p target_help=File.join(@local_help_dir,file+'.org')
+      if File::exists?(target_help)
+        puts "File exists. --delete it first to initialize it."
+        exit
+      end
+      p template = File.join(@template_dir,'template_help.org')
+      FileUtils::Verbose.cp(template,target_help)
+    end
+
+    def delete_help(file)
+      file = File.join(@local_help_dir,file+'.org')
+      print "Are you sure to delete "+file.blue+"?[Ynq] ".red
+      case STDIN.gets.chomp
+      when 'Y'
+        begin
+          FileUtils.rm(file,:verbose=>true)
+        rescue => error
+          puts error.to_s.red
+        end
+      when 'n', 'q' ; exit
+      end
+    end
+
+    private
+    def local_help_entries
+      entries= []
+      Dir.entries(@local_help_dir).each{|file|
+        next unless file.include?('_')
+        next if file[0]=='#' or file[-1]=='~' or file[0]=='.'
+        next if file.match(/(.+)_e\.org/) # OK?
+        next if file.match(/(.+)\.html/)
+        entries << file
+      }
+      return entries
+    end
+
+    def auto_load(file_path)
+      case File.extname(file_path)
+      when '.yml'
+        cont = YAML.load(File.read(file_path))
+      when '.org'
+        cont = OrgToYaml.new(file_path).help_cont
+      else
+        puts "Not handling file types of #{file_path}"
+        cont = nil
+      end
+      cont
+    end
+  end
+end

data/lib/my_help/org2yml.rb

@@ -9,6 +9,7 @@ class OrgToYaml
     @help_cont = {} #{ head: [File.basename(file, '.org')] }
     @head_sym = nil
     @conts = ''
+    @short_stored = []
     org_to_yaml(File.readlines(file))
   end
 
@@ -16,7 +17,12 @@ class OrgToYaml
     head, desc = line.split(':')
     desc ||= head.to_s
     short = "-#{head[0]}"
-    { short: short, long: "--#{head}", desc: desc }
+    if @short_stored.include?(short) or head=='license' or head=='head'
+      short = ''
+    else
+      @short_stored << short
+    end
+    { short: short, long: "#{head}", desc: desc }
   end
 
   def next_cont(head)
@@ -41,7 +47,7 @@ class OrgToYaml
   end
 end
 
-if __FILE__ == $1
+if $PROGRAM_NAME == __FILE__ 
   helps = OrgToYaml.new(ARGV[0])
   pp helps.help_cont
 end

data/lib/my_help/version.rb

@@ -1,3 +1,3 @@
 module MyHelp
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/templates/org_help.org

@@ -13,8 +13,6 @@
 - - でitem追加
 - * でitem追加
 - #+STARTUP: indent nolineimages nofold
-- #+BEGIN_QUOTE -- #+END_QUOTE
-- #+BEGIN_SRC bash -- #+END_SRC
 - #+TITLE: 格子欠陥について最近の研究から
 - #+AUTHOR: 関西学院大学・理工学部・情報科学科　西谷滋人 2017
 * key_bind
@@ -22,32 +20,37 @@
 - shift-tabで全部に対するtoggle
 - shift-矢印でkeyを切り替え
 - M-shift-<left, right>アウトラインのレベルをツリーごと移動
-- beamer出力はc-c c-eでlbを選択
-* markdown
-- in emacs, M-x org-md-export-as-markdown
-- pandoc -f markdown -t org -o tmp.md sample.org
-- 行の折り返し，M-x toggle-truncate-lines
-* format
-- #+OPTIONS: ^:{}でsub, superを抑制．
+* convert
+- #+OPTIONS: ^:{}  でsub, superを抑制．
+- markdown
+  1. in emacs, M-x org-md-export-as-markdown
+  2. pandoc -f markdown -t org -o tmp.md sample.org
+  3. 行の折り返し，M-x toggle-truncate-lines
+- latex出力
+  1. c-c c-eでllを選択
+  2. 日本語と数式が混じる時には，$の前後に半角スペースを入れる
+  3. [[https://www-he.scphys.kyoto-u.ac.jp/member/shotakaha/dokuwiki/doku.php?id=toolbox:emacs:org:export:latex:start~]]
+  4. https://orgmode.org/worg/org-tutorials/org-latex-export.html
+- beamer出力
+  1. c-c c-eでlbを選択
 * list
 - 項目- 子項目1
 - 番号付き1. 2.
 - 名前付き   - 名前1 :: 内容1
 * link
 - [[file:./tmp/tmp.txt][Link to file]]
+- [[link][name]]
 - to edit, c-c c-l
 - to open, c-c c-o
-* latex
-- latex出力はc-c c-eでllを選択
-- 日本語と数式が混じる時には，$の前後に半角スペースを入れる
-- [[https://www-he.scphys.kyoto-u.ac.jp/member/shotakaha/dokuwiki/doku.php?id=toolbox:emacs:org:export:latex:start~]]
-- https://orgmode.org/worg/org-tutorials/org-latex-export.html
+- org-return-follows-linkが設定されていたらRETでも開く
 * todo
 - c-c c-tでno_head->TODO->DONEをloop
 - m-x agenda-modeでschedule操作可能コマンドを表示
-* verbose
+* verb_and_source
 - ': 'を頭に
 - #+BEGIN_EXAMPLE...#+END_EXAMPLE
+- #+BEGIN_QUOTE -- #+END_QUOTE
+- #+BEGIN_SRC bash -- #+END_SRC
 * date_and_time
 - c-c .でカレンダーと日付表示<2018-03-14 Wed>
 - +7とか-1を入力してreturnするとその日付が出力

data/my_help.gemspec

@@ -1,34 +1,24 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'my_help/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "my_help"
-  spec.version       = MyHelp::VERSION
-  spec.authors       = ["Shigeto R. Nishitani"]
-  spec.email         = ["shigeto_nishitani@me.com"]
-
-  spec.summary       = %q{display emacs key bindings in Japanese.}
-  spec.description   = %q{Emulating CUI(CLI) help, an user makes and displays his own helps.}
-  spec.homepage      = "https://github.com/daddygongon/my_help"
-  spec.license       = "MIT"
-  spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-#  if spec.respond_to?(:metadata)
-#    spec.metadata['allowed_push_host'] = 'http://rubygems.org'
-#  else
-#    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-#  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "systemu"
-  spec.add_dependency "colorize"
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','my_help','version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'my_help'
+  s.version = MyHelp::VERSION
+  s.author = 'Your Name Here'
+  s.email = 'your@email.address.com'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+  s.files = `git ls-files`.split("
+")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','my_help.rdoc']
+  s.rdoc_options << '--title' << 'my_help' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'my_help'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_runtime_dependency('gli','2.17.1')
+  s.add_runtime_dependency "colorize"
 end