my_help 0.4.5 → 0.5.0

data/docs/yagi/thor_task.ipynb

@@ -0,0 +1,98 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# RSpecで振る舞いを調べる方法\n",
+    "\n",
+    "RSpec 振る舞い テスト，など\n",
+    "\n",
+    "色々ググりましたが有力な情報は出てきませんでした．"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# ルボコップでコードを改善\n",
+    "\n",
+    "## auto correct\n",
+    "rubocop my_help.rb\n",
+    "\n",
+    "1 file inspected, 175 offenses detected\n",
+    "\n",
+    "175個のoffensesが検出された．\n",
+    "\n",
+    "rubocop -aで一気に19まで減少．\n",
+    "\n",
+    "## 細かい修正\n",
+    "\n",
+    "・コメントアウトされているoptparse版のコマンドが怒られていたので削除\n",
+    "19から14まで減少．\n",
+    "\n",
+    "・なんの説明もなしにいきなりclassの記述がされていると怒られたのでclassの説明を記述\n",
+    "13に減少．\n",
+    "\n",
+    "・status,stderrの前にアンダーバーを付けろとの警告\n",
+    "アンダーバーをつけることで9に減少．\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Thorでサブコマンドを自動登録する方法\n",
+    "\n",
+    "optparseならoptを何度も呼び出せるが，\n",
+    "Thorのメソッドは何度も呼び出せない．\n",
+    "\n",
+    "## サブサブコマンド\n",
+    "サブサブコマンドを使うことで可能になるかもしれない．\n",
+    "\n",
+    "さらに言うと，ymlからサブコマンドとして呼び出す用のクラスを書ければいけるかもしれない．\n",
+    "\n",
+    "\n",
+    "## 問題点\n",
+    "・サブサブコマンドまで必要になる\n",
+    "\n",
+    "・コードが複雑になる\n",
+    "\n",
+    "・ファイルが増える"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 2.3.3",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.3.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/exe/my_help

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 require "my_help"
-
 MyHelp::Command.run(ARGV)
+
+#require "my_help_thor"
+#MyHelp::Command.start(ARGV)

data/lib/my_help/org2yml.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+require 'yaml'
+require 'pp'
+
+class OrgToYaml
+  attr_accessor :help_cont
+
+  def initialize(file)
+    @help_cont = {} #{ head: [File.basename(file, '.org')] }
+    @head_sym = nil
+    @conts = ''
+    org_to_yaml(File.readlines(file))
+  end
+
+  def make_options(line)
+    head, desc = line.split(':')
+    desc ||= head
+    { short: "-#{head[0]}", long: "--#{head}", desc: desc.to_s }
+  end
+
+  def next_cont(head)
+    @help_cont[@head_sym][:cont] = @conts if @head_sym
+    return if head == 'EOF'
+    @conts = ''
+    @head_sym = head.to_sym
+    @help_cont[@head_sym] = {
+      opts: make_options(head), title: head, cont: ''
+    }
+  end
+
+  def org_to_yaml(lines)
+    lines.each do |line|
+      if m = line.match(/^\* (.+)/)
+        next_cont m[1]
+      else
+        @conts << line
+      end
+    end
+    next_cont 'EOF'
+  end
+end
+
+if __FILE__ == $1
+  helps = OrgToYaml.new(ARGV[0])
+  pp helps.help_cont
+end

data/lib/my_help/version.rb

@@ -1,3 +1,3 @@
 module MyHelp
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

data/lib/my_help/yml2org.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+require "optparse"
+require "yaml"
+
+class YmlToOrg
+  attr_accessor :contents
+
+  def initialize(file)
+    @contents = ''
+    yml_to_org(YAML.load(File.read(file)))
+  end
+
+  def head_and_licence(key, cont)
+    cont.each { |line| @contents << "- #{line}\n" }
+  end
+
+  def plain_element(key, cont)
+    cont[:cont].each { |line| @contents << "- #{line}\n" }
+  end
+
+  def yml_to_org(help_cont)
+    @contents << "#+STARTUP: indent nolineimages\n" # nofold
+    help_cont.each_pair do |key, cont|
+      @contents << "* #{key.to_s}\n"
+      if key == :head or key == :license
+        head_and_licence(key, cont)
+      else
+        plain_element(key, cont)
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  print YmlToOrg.new(ARGV[0]).contents
+end

data/lib/my_help.rb

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 require "optparse"
 require "yaml"
+require 'my_help/org2yml'
+require 'my_help/yml2org'
 require "fileutils"
 require "my_help/version"
 require "systemu"
@@ -15,7 +17,7 @@ module MyHelp
 
     def initialize(argv=[])
       @argv = argv
-      @default_help_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+      @template_dir = File.expand_path("../../lib/templates", __FILE__)
       @local_help_dir = File.join(ENV['HOME'],'.my_help')
       set_help_dir_if_not_exists
     end
@@ -23,11 +25,11 @@ module MyHelp
     def set_help_dir_if_not_exists
       return if File::exists?(@local_help_dir)
       FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
-      Dir.entries(@default_help_dir).each{|file|
-        next if file=='template_help.yml'
+      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(@default_help_dir,file)),@local_help_dir,:verbose=>true)
+        FileUtils.cp((File.join(@template_dir,file)),@local_help_dir,:verbose=>true)
       }
     end
 
@@ -38,11 +40,18 @@ module MyHelp
           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(eg test_help)'){|file| init_help(file)}
+        if ENV['LANG'] == "C" then
+          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)}
+        else
+          opt.on('-l', '--list', '個別(specific)ヘルプのList表示.'){list_helps}
+          opt.on('-e NAME', '--edit NAME', 'NAME(例：test_help)をEdit編集.'){|file| edit_help(file)}
+          opt.on('-i NAME', '--init NAME', 'NAME(例：test_help)のtemplateを作成.'){|file| init_help(file)}
+        end
         opt.on('-m', '--make', 'make executables for all helps'){make_help}
-        opt.on('-c', '--clean', 'clean up exe dir.'){clean_exe}
+        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
@@ -54,16 +63,24 @@ module MyHelp
       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+'.yml')
-      exe_dir=File.join(File.expand_path('../..',@default_help_dir),'exe')
+      del_files << File.join(@local_help_dir,file+'.org')
+      exe_dir=File.join(File.expand_path('../..',@template_dir),'exe')
       exe_0_dir='/usr/local/bin'
       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{|file|
+      del_files.each do |file|
         print "Are you sure to delete "+file.blue+"?[Ynq] ".red
         case gets.chomp
         when 'Y'
@@ -75,13 +92,13 @@ module MyHelp
         when 'n' ; next
         when 'q' ; exit
         end
-      }
+      end
     end
 
     USER_INST_DIR="USER INSTALLATION DIRECTORY:"
     INST_DIR="INSTALLATION DIRECTORY:"
     def install_local
-      Dir.chdir(File.expand_path('../..',@default_help_dir))
+      Dir.chdir(File.expand_path('../..',@template_dir))
       p pwd_dir = Dir.pwd
       # check that the working dir should not the gem installed dir,
       # which destroys itself.
@@ -107,11 +124,18 @@ module MyHelp
 
     def make_help
       local_help_entries.each{|file|
-        exe_cont="#!/usr/bin/env ruby\nrequire 'specific_help'\n"
-        exe_cont << "help_file = File.join(ENV['HOME'],'.my_help','#{file}')\n"
-        exe_cont << "SpecificHelp::Command.run(help_file, ARGV)\n"
-        file = File.basename(file,'.yml')
-        [file, short_name(file)].each{|name|
+        title = file.split('.')[0]
+        exe_cont=<<"EOS"
+#!/usr/bin/env ruby
+require 'specific_help'
+if ENV['LANG'] == "C" then
+  help_file = File.join(ENV['HOME'],'.my_help','#{title}_e.org')
+else
+  help_file = File.join(ENV['HOME'],'.my_help','#{file}')
+end
+SpecificHelp::Command.run(help_file, ARGV)
+EOS
+        [title, short_name(title)].each{|name|
           p target=File.join('exe',name)
           File.open(target,'w'){|file| file.print exe_cont}
           FileUtils.chmod('a+x', target, :verbose => true)
@@ -120,30 +144,37 @@ module MyHelp
       install_local
     end
 
-    def clean_exe
+    def clean_exe_dir
       local_help_entries.each{|file|
         next if ['emacs_help','e_h','my_help','my_todo'].include?(file)
-        file = File.basename(file,'.yml')
+        file = File.basename(file,'.org')
         [file, short_name(file)].each{|name|
           p target=File.join('exe',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+'.yml')
+      p target_help=File.join(@local_help_dir,file+'.org')
       if File::exists?(target_help)
         puts "File exists. rm it first to initialize it."
         exit
       end
-      p template = File.join(@default_help_dir,'template_help.yml')
+      p template = File.join(@template_dir,'template_help.org')
       FileUtils::Verbose.cp(template,target_help)
     end
 
     def edit_help(file)
-      p target_help=File.join(@local_help_dir,file)
-      system "emacs #{target_help}.yml"
+      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
@@ -151,26 +182,41 @@ module MyHelp
       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{|file|
+      local_help_entries.each do |file|
         file_path=File.join(@local_help_dir,file)
-        file = File.basename(file,'.yml')
+        title = file.split('.')[0]
         begin
-          help = YAML.load(File.read(file_path))
+          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 #{file}\n".red
+          print "  Revise it by "+"my_help --edit #{title}\n".red
           exit
         end
-        print "  #{file}\t:#{help[:head][0]}\n".blue
-      }
+        desc = help[:head][:cont].split("\n")[0]
+        print "  #{title}\t: #{desc}\n".blue
+      end
     end
+
   end
 end

data/lib/my_help_thor.rb

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+require "optparse"
+require "yaml"
+require "fileutils"
+require "my_help/version"
+require "systemu"
+require "thor"
+
+module MyHelp
+  class Command < Thor
+=begin
+    def self.run(argv=[])
+      new(argv).execute
+    end
+=end
+
+  def initialize(*args)
+    super
+#    @argv = args
+    @default_help_dir = File.expand_path("../../lib/templates", __FILE__)
+    @local_help_dir = File.join(ENV['HOME'],'.my_help')
+    set_help_dir_if_not_exists
+  end
+
+  desc 'version, -v', 'show program version'
+  #    map "--version" => "version"
+  map "--version" => "version"
+  def version
+    puts MyHelp::VERSION
+  end
+
+  desc 'delete NAME, --delete NAME','delete NAME help'
+  map "--delete" => "delete"
+    def delete_help(file)
+      del_files=[]
+      del_files << File.join(@local_help_dir,file)
+      exe_dir=File.join(File.expand_path('../..',@default_help_dir),'exe')
+      del_files << File.join(exe_dir,file)
+      p del_files << File.join(exe_dir,short_name(file))
+      print "Are you sure to delete these files?[yes]"
+      if gets.chomp=='yes' then
+        del_files.each{|file| FileUtils.rm(file,:verbose=>true)}
+      end
+    end
+
+    USER_INST_DIR="USER INSTALLATION DIRECTORY:"
+    INST_DIR="INSTALLATION DIRECTORY:"
+    desc 'install_local, --install_local','install local after edit helps'
+    map "--install_local" => "install_local"
+    def install_local
+
+      Dir.chdir(File.expand_path('../..',@default_help_dir))
+      p pwd_dir = Dir.pwd
+      # check that the working dir should not the gem installed dir,
+      # which destroys itself.
+      status, stdout, stderr = systemu "gem env|grep '#{USER_INST_DIR}'"
+      if stdout==""
+        status, stdout, stderr = systemu "gem env|grep '#{INST_DIR}'"
+      end
+      p system_inst_dir = stdout.split(': ')[1].chomp
+      if pwd_dir == system_inst_dir
+        puts "Download my_help from github, and using bundle for edit helps\n"
+        puts "Read README in detail.\n"
+        exit
+      end
+      system "git add -A"
+      system "git commit -m 'update exe dirs'"
+      system "Rake install:local"
+    end
+
+    desc 'clean, --clean', 'clean up exe dir.'
+    map "--clean" => "clean"
+    def clean
+      local_help_entries.each{|file|
+        next if file.include?('emacs_help') or file.include?('e_h')
+        next if file.include?('git_help') or file.include?('t_h')
+        [file, short_name(file)].each{|name|
+          p target=File.join('exe',name)
+          FileUtils::Verbose.rm(target)
+        }
+      }
+    end
+
+    desc 'init NAME, --init NAME', 'initialize NAME help(eg test_help).'
+    map "--init" => "init"
+    def init(file)
+      p target_help=File.join(@local_help_dir,file+'.yml')
+      if File::exists?(target_help)
+        puts "File exists. rm it first to initialize it."
+        exit
+      end
+      p template = File.join(@default_help_dir,'template_help.yml')
+      FileUtils::Verbose.cp(template,target_help)
+      command_template = <<EOS
+EOS
+    end
+
+    desc 'edit NAME, --edit NAME', 'edit NAME help(eg test_help)'
+    map "--edit" => "edit"
+    def edit(file)
+      p target_help=File.join(@local_help_dir,file+'.yml')
+      system "emacs #{target_help}"
+    end
+
+
+
+    desc 'list, --list', 'list specific helps'
+    map "--list" => "list"
+    def list
+      print "Specific help file:\n"
+      local_help_entries.each{|file|
+        file_path=File.join(@local_help_dir,file)
+        help = YAML.load(File.read(file_path))
+        print "  #{file}\t:#{help[:head][0]}\n"
+      }
+    end
+
+    desc 'make, --make', 'make executables for all helps.'
+    map "--make" => "make"
+    def make
+      local_help_entries.each{|file|
+        file_name=file
+        help_name=file
+        help_name=File.basename(help_name,".yml")
+        exe_cont="#!/usr/bin/env ruby\nrequire 'specific_help_opt'\nrequire 'specific_help_thor'\n"
+        exe_cont << "ENV['HELP_NAME']='#{help_name}'\n"
+        exe_cont << "help_file = File.join(ENV['HOME'],'.my_help','#{file_name}')\n"
+        exe_cont << "SpecificHelp::Command.start(ARGV)\n"
+        exe_cont << "SpecificHelpOpt::Command.run(help_file, ARGV)\n"
+        [help_name, short_name(help_name)].each{|name|
+          p target=File.join('exe',name)
+          File.open(target,'w'){|file| file.print exe_cont}
+          FileUtils.chmod('a+x', target, :verbose => true)
+        }
+      }
+      install_local
+    end
+
+    no_commands do
+      def set_help_dir_if_not_exists
+        return if File::exists?(@local_help_dir)
+        FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
+        Dir.entries(@default_help_dir).each{|file|
+          next if file=='template_help'
+          file_path=File.join(@local_help_dir,file)
+          next if File::exists?(file_path)
+          FileUtils.cp((File.join(@default_help_dir,file)),@local_help_dir,:verbose=>true)
+        }
+      end
+
+      #    desc 'test2', 'test3'
+      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]=='.'
+          entries << file
+        }
+        return entries
+      end
+
+      #   desc 'test4', 'test5'
+      def short_name(file)
+        file_name=file.split('_')
+        return file_name[0][0]+"_"+file_name[1][0]
+      end
+    end
+
+  end
+end

data/lib/my_todo/my_todo.rb

@@ -1,7 +1,10 @@
+=begin
 module Mytodo
-  class Todo
+  class Edit
     def open
+
     end
   end
 end
-    
+
+=end