RubyGems - my_help - Versions diffs - 1.2.9 → 1.2.12 - Mend

my_help 1.2.9 → 1.2.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

data/doc/method_list.html CHANGED Viewed

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html>
+<html >
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
@@ -38,7 +38,10 @@
         </div>
-        <div id="search">Search: <input type="text" /></div>
+        <div id="search">
+          <label for="search-class">Search:</label>
+          <input id="search-class" type="text" />
+        </div>
       </div>
       <ul id="full_list" class="method">
@@ -53,6 +56,14 @@
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="MyHelp/CLI.html#add_defaults-instance_method" title="MyHelp::CLI#add_defaults (method)">#add_defaults</a></span>
+      <small>MyHelp::CLI</small>
+    </div>
+  </li>
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="MyHelp/Init.html#check_conf_exist-instance_method" title="MyHelp::Init#check_conf_exist (method)">#check_conf_exist</a></span>
       <small>MyHelp::Init</small>
@@ -60,6 +71,14 @@
   </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="MyHelp/Config.html#check_template_dir-instance_method" title="MyHelp::Config#check_template_dir (method)">#check_template_dir</a></span>
+      <small>MyHelp::Config</small>
+    </div>
+  </li>
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="MyHelp/Config.html#config-instance_method" title="MyHelp::Config#config (method)">#config</a></span>
@@ -86,16 +105,16 @@
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Org2Hash.html#contents-instance_method" title="MyHelp::Org2Hash#contents (method)">#contents</a></span>
-      <small>MyHelp::Org2Hash</small>
+      <span class='object_link'><a href="MyHelp/Md2Hash.html#contents-instance_method" title="MyHelp::Md2Hash#contents (method)">#contents</a></span>
+      <small>MyHelp::Md2Hash</small>
     </div>
   </li>
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Md2Hash.html#contents-instance_method" title="MyHelp::Md2Hash#contents (method)">#contents</a></span>
-      <small>MyHelp::Md2Hash</small>
+      <span class='object_link'><a href="MyHelp/Org2Hash.html#contents-instance_method" title="MyHelp::Org2Hash#contents (method)">#contents</a></span>
+      <small>MyHelp::Org2Hash</small>
     </div>
   </li>
@@ -110,16 +129,16 @@
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Modify.html#delete-instance_method" title="MyHelp::Modify#delete (method)">#delete</a></span>
-      <small>MyHelp::Modify</small>
+      <span class='object_link'><a href="MyHelp/CLI.html#delete-instance_method" title="MyHelp::CLI#delete (method)">#delete</a></span>
+      <small>MyHelp::CLI</small>
     </div>
   </li>
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/CLI.html#delete-instance_method" title="MyHelp::CLI#delete (method)">#delete</a></span>
-      <small>MyHelp::CLI</small>
+      <span class='object_link'><a href="MyHelp/Modify.html#delete-instance_method" title="MyHelp::Modify#delete (method)">#delete</a></span>
+      <small>MyHelp::Modify</small>
     </div>
   </li>
@@ -206,56 +225,56 @@
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Org2Yaml.html#initialize-instance_method" title="Org2Yaml#initialize (method)">#initialize</a></span>
-      <small>Org2Yaml</small>
+      <span class='object_link'><a href="MyHelp/Config.html#initialize-instance_method" title="MyHelp::Config#initialize (method)">#initialize</a></span>
+      <small>MyHelp::Config</small>
     </div>
   </li>
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Org2Hash.html#initialize-instance_method" title="MyHelp::Org2Hash#initialize (method)">#initialize</a></span>
-      <small>MyHelp::Org2Hash</small>
+      <span class='object_link'><a href="MyHelp/List.html#initialize-instance_method" title="MyHelp::List#initialize (method)">#initialize</a></span>
+      <small>MyHelp::List</small>
     </div>
   </li>
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Init.html#initialize-instance_method" title="MyHelp::Init#initialize (method)">#initialize</a></span>
-      <small>MyHelp::Init</small>
+      <span class='object_link'><a href="Org2Yaml.html#initialize-instance_method" title="Org2Yaml#initialize (method)">#initialize</a></span>
+      <small>Org2Yaml</small>
     </div>
   </li>
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/List.html#initialize-instance_method" title="MyHelp::List#initialize (method)">#initialize</a></span>
-      <small>MyHelp::List</small>
+      <span class='object_link'><a href="MyHelp/Init.html#initialize-instance_method" title="MyHelp::Init#initialize (method)">#initialize</a></span>
+      <small>MyHelp::Init</small>
     </div>
   </li>
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Config.html#initialize-instance_method" title="MyHelp::Config#initialize (method)">#initialize</a></span>
-      <small>MyHelp::Config</small>
+      <span class='object_link'><a href="MyHelp/Org2Hash.html#initialize-instance_method" title="MyHelp::Org2Hash#initialize (method)">#initialize</a></span>
+      <small>MyHelp::Org2Hash</small>
     </div>
   </li>
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Modify.html#initialize-instance_method" title="MyHelp::Modify#initialize (method)">#initialize</a></span>
-      <small>MyHelp::Modify</small>
+      <span class='object_link'><a href="MyHelp/Md2Hash.html#initialize-instance_method" title="MyHelp::Md2Hash#initialize (method)">#initialize</a></span>
+      <small>MyHelp::Md2Hash</small>
     </div>
   </li>
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Md2Hash.html#initialize-instance_method" title="MyHelp::Md2Hash#initialize (method)">#initialize</a></span>
-      <small>MyHelp::Md2Hash</small>
+      <span class='object_link'><a href="MyHelp/Modify.html#initialize-instance_method" title="MyHelp::Modify#initialize (method)">#initialize</a></span>
+      <small>MyHelp::Modify</small>
     </div>
   </li>
@@ -318,16 +337,16 @@
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/CLI.html#new-instance_method" title="MyHelp::CLI#new (method)">#new</a></span>
-      <small>MyHelp::CLI</small>
+      <span class='object_link'><a href="MyHelp/Modify.html#new-instance_method" title="MyHelp::Modify#new (method)">#new</a></span>
+      <small>MyHelp::Modify</small>
     </div>
   </li>
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="MyHelp/Modify.html#new-instance_method" title="MyHelp::Modify#new (method)">#new</a></span>
-      <small>MyHelp::Modify</small>
+      <span class='object_link'><a href="MyHelp/CLI.html#new-instance_method" title="MyHelp::CLI#new (method)">#new</a></span>
+      <small>MyHelp::CLI</small>
     </div>
   </li>
@@ -356,6 +375,22 @@
   </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="MyHelp/List.html#pad_multi_bytes-instance_method" title="MyHelp::List#pad_multi_bytes (method)">#pad_multi_bytes</a></span>
+      <small>MyHelp::List</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="MyHelp/CLI.html#place-instance_method" title="MyHelp::CLI#place (method)">#place</a></span>
+      <small>MyHelp::CLI</small>
+    </div>
+  </li>
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="MyHelp/Git.html#pull-instance_method" title="MyHelp::Git#pull (method)">#pull</a></span>

data/doc/top-level-namespace.html CHANGED Viewed

@@ -102,9 +102,9 @@
 </div>
       <div id="footer">
-  Generated on Thu Sep 26 14:20:52 2024 by
+  Generated on Tue Oct 15 12:36:20 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.0.2).
+  0.9.37 (ruby-3.0.2).
 </div>
     </div>

data/lib/my_help/cli.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require 'colorize'
 module MyHelp
   class CLI < Thor
     include GetConfig
@@ -21,6 +22,19 @@ module MyHelp
       puts "my_help #{VERSION}"
     end
+    map "-s" => :search
+    desc "search [WORD]", "search word on my_helps dir"
+    def search(*args)
+      c = get_config
+      word = args[0]
+      targets = File.join(c[:local_help_dir],"*"+c[:ext])
+      puts "my_help search word on my_helps dir"
+      comm = "grep  #{word} #{targets}"
+      puts "#{comm}\n\n"
+      system comm
+    end
     desc "git [pull|push]", "git operations"
     subcommand "git", Git
@@ -40,7 +54,7 @@ module MyHelp
         end
       end
     end
     map "-i" => :init
     desc "init", "initialize my_help environment"
@@ -49,14 +63,20 @@ module MyHelp
       #config.ask_default
       init = Init.new(config)
-      raise "Local help dir exist." if init.help_dir_exist?
+      begin
+        init.help_dir_exist?
+      rescue RuntimeError => e
+        puts "RuntimeError: #{e.message}"
+        exit
+      end
       puts "Choose default markup '.org' [Y or .md]? "
       response = $stdin.gets.chomp
       config.configure(:ext => response) unless response.upcase[0] == "Y"
       init.mk_help_dir
       config.save_config
       init.cp_templates
-      puts "If you want change editor use my_help set editor code."
+      puts "For changing editor to code: 'my_help set editor code'.".green
+      puts "For activating batcat:       'my_help set bat true'.".green
     end
     desc "set [:key] [VAL]", "set editor or ext"
@@ -64,7 +84,13 @@ module MyHelp
     def set(*args)
       config = get_config # for using methods in Config
       key = args[0] || ""
-      config.configure(key.to_sym => args[1])
+      begin
+        config.configure(key.to_sym => args[1])
+      rescue => e
+        puts e
+        exit
+      end
       config.save_config
       conf_file_path = config[:conf_file]
       puts "conf_file_path: %s" % conf_file_path
@@ -80,16 +106,29 @@ module MyHelp
       config = get_config
       help_dir = options["help_dir"] || config[:local_help_dir]
       layer = options["layer"] || 1
-      puts List.new(help_dir,
+      text = List.new(help_dir,
                     config[:ext],
                     layer).list(*args.join(" "))
+      if config[:bat]
+        require "tempfile"
+        t = Tempfile.open(['hoge', 'bar'])
+        File.write(t.path, text)
+        if ENV["WSL_DISTRO_NAME"]=="Ubuntu"
+#          p ['config[:bat]',config[:bat]]
+          system("cat #{t.path} |batcat --theme Coldark-Cold -l zsh -p") #| bat -l org -p")
+        else
+          system("cat #{t.path} |bat -l zsh -p") #| bat -l org -p")
+        end
+      else
+        puts text
+      end
     end
     map "-e" => :edit
     desc "edit [HELP]", "edit help"
     def edit(*args)
       c = get_config
-      help_name = args[0]
+      help_name = *args[0] #.join(" ")
       Modify.new(c).edit(help_name)
     end

data/lib/my_help/config.rb CHANGED Viewed

@@ -16,6 +16,7 @@ module MyHelp
         editor: ENV["EDITOR"] || "emacs",
         ext: ".org",
         verbose: false,
+        bat: false,
       }
       @valid_config_keys = @config.keys
       configure_with(@config[:conf_file])
@@ -41,10 +42,13 @@ module MyHelp
         if @valid_config_keys.include? k.to_sym
           @config[k.to_sym] = v
         elsif k == "".to_sym
-          print "Valid key words are follows:"
-          p @valid_config_keys
+          print "Valid key words are follows: "
+          puts [@valid_config_keys.map{|v| v.to_s}].join(", ")
         else
-          raise KeyError.new("Error: keyword '#{k}' is invalid",
+          raise KeyError.new("KeywordError: keyword '#{k}' is invalid.\n
+Valid key words are follows;
+          #{[@valid_config_keys.map{|v| v.to_s}].join(", ")}
+",
                              receiver: @config,
                              key: k)
         end
@@ -69,6 +73,7 @@ module MyHelp
     # save config in  @config[:conf_file]
     def save_config()
+      puts " save config in  #{@config[:conf_file]}"
       File.write(@config[:conf_file], YAML.dump(config))
     end

data/lib/my_help/init.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require 'colorize'
 module MyHelp
   class Init
     def initialize(config)
@@ -5,7 +6,11 @@ module MyHelp
     end
     def help_dir_exist?
-      File.exist?(@config[:local_help_dir])
+      if File.exist?(@config[:local_help_dir])
+        raise "Local help dir exist.\n".red+
+              "local help dir: #{@config[:local_help_dir]};
+if you are sure, delete local help dir first.".green
+      end
     end
     def check_conf_exist
@@ -13,6 +18,7 @@ module MyHelp
     end
     def mk_help_dir
+      puts "making local help dir: #{@config[:local_help_dir]}"
       FileUtils.mkdir(@config[:local_help_dir])
     end
@@ -20,6 +26,7 @@ module MyHelp
       target_dir = @config[:local_help_dir]
       src_dir = @config[:template_dir]
       ext = @config[:ext]
+      puts "cp help templates *#{ext}"
       Dir.glob(File.join(src_dir, "*#{ext}")).each do |file|
         FileUtils.cp(file, target_dir, verbose: false)
       end

data/lib/my_help/list.rb CHANGED Viewed

@@ -4,6 +4,7 @@ require "colorized_string"
 module MyHelp
   # Your code goes here...
   class List
     def initialize(path = "", ext = ".org", layer = 1)
       @path = path
@@ -16,6 +17,7 @@ module MyHelp
       if item == nil && name == nil
         list_helps()
       else
+        name = File.basename(name, @ext)
         path = File.exist?(name + @ext) ? name + @ext :
           File.join(@path, name + @ext)
         list_help_with(path, name, item)
@@ -24,7 +26,15 @@ module MyHelp
     def read_help(file)
       info = {}
-      info[:items] = Org2Hash.new(File.read(file)).contents
+      info[:items] = case @ext
+                     when '.org'
+                       Org2Hash.new(File.read(file)).contents
+                     when '.md'
+                       Md2Hash.new(File.read(file)).contents
+                     else
+                       RaiseError(:NoExtension)
+                     end
       info[:name] = File.basename(file).split(".")[0]
       return info
     end
@@ -35,7 +45,7 @@ module MyHelp
 #                p [out, file]
         help_info = read_help(file)
         head = help_info[:items]["head"] ?
-                 help_info[:items]["head"].split("\n")[0] : ''
+                 help_info[:items]["head"][0] : ''
 #        out << "%10s: %s\n" % [help_info[:name], head]
         out << "%s: %s\n" %
                [pad_multi_bytes(help_info[:name],20), head]
@@ -43,24 +53,20 @@ module MyHelp
     end
     def pad_multi_bytes(str, length, padstr=" ")
-      str_bytes = str.each_char.map do |c|
-        c.bytesize == 1 ? 1 : 2
-      end.reduce(0, &:+)
-#      p [str, length, str_bytes]
-      if str_bytes<length
-        pad = padstr * (length - str_bytes)
+      str_bytes = str.each_char.map { |c| c.bytesize == 1 ? 1 : 2 }.sum
+      pad_length = length - str_bytes
+      if pad_length > 0
+        pad = padstr * pad_length
         return pad + str
       else
         return str
       end
     end
     def list_help_with(path, name, item)
       @help_info = read_help(path)
-      output = ColorizedString[
-        "my_help called with name : #{name},item : #{item}\n"
-      ].colorize(:cyan)
+      output = "my_help called with name : #{name},item : #{item}\n"
       if item == nil
         @help_info[:items].each_pair do |item, val|
@@ -84,8 +90,8 @@ module MyHelp
         "Can't find similar item name with : #{input_item}"
       else
         contents = candidates.collect do |near_item|
-          ColorizedString["item : #{near_item} \n"].colorize(:cyan) +
-          @help_info[:items][near_item]
+          #          ColorizedString["item : #{near_item} \n"].colorize(:cyan) +
+         "item : #{near_item} \n" + @help_info[:items][near_item].join("\n")
         end
         contents.join("\n")
       end

data/lib/my_help/modify.rb CHANGED Viewed

@@ -2,6 +2,7 @@ module MyHelp
   class Modify
     def initialize(conf)
       @conf = conf
+      @ext = @conf[:ext]
     end
     def new(help_file)
@@ -19,13 +20,14 @@ module MyHelp
     end
     def edit(help_name)
-      p help_file = File.join(@conf[:local_help_dir],
-                              help_name + @conf[:ext])
-      if File.exist?(help_file)
-        p comm = "#{@conf[:editor]} #{help_file}"
+      name = File.basename(help_name[0], @ext)
+      path = File.exist?(name + @ext) ? name + @ext :
+          File.join(@conf[:local_help_dir], name + @ext)
+      if File.exist?(path)
+        p comm = "#{@conf[:editor]} #{path}"
         system(comm)
       else
-        puts "file #{help_file} does not exist,"
+        puts "file #{path} does not exist,"
         puts "make #{help_name} first by 'new' command."
       end
     end

data/lib/my_help/org2hash.rb CHANGED Viewed

@@ -22,7 +22,7 @@ module MyHelp
     def simple_fsm()
       state = :header_read
-      item = ""
+      item = []
       @text.split("\n").each do |line|
         next if line.size < 1
         state, action = TRANSITIONS[state][line[0..1]] ||
@@ -31,9 +31,9 @@ module MyHelp
         when :ignore
         when :start_new_item
           item = read_item(line)
-          @contents[item] = ""
+          @contents[item] = []
         when :add_contents
-          @contents[item] += line + "\n"
+          @contents[item] << line
         end
       end
     end

data/lib/my_help/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module MyHelp
-  VERSION = "1.2.9"
+  VERSION = "1.2.12"
 end

data/lib/templates/kick_off.md ADDED Viewed

@@ -0,0 +1,51 @@
+# head: kickoff for wsl novice
+# license: cc by Shigeto R. Nishitani, 2025
+# initial_operation
+最初(initial)の操作
+1.  cd comp_a_25s
+2.  git stash # 変更をgitに無かったことに
+3.  git pull origin main # 最新のfilesをgitでpull(引っ張ってくる)
+4.  cp bin/kick_off ~/bin # 最新版のkick_offを~/binにcopy
+5.  cd ~/my_comp_a/python
+6.  cp ~/comp_a_25s/python/hogehoge . # hogehogeファイルを'.'にcp
+# wsl shell commands
+- cat : catenate # 中身を出力する
+  - cat results | pbcopy(clip.exe)
+- bat : batcat
+  - kick_off -f | bat -l zsh
+- python3 d1_print_calendar.py > results.txt
+- history
+  - history -r | tail -20 | clip.exe
+- tree, open, code .,
+# directory(path) comms
+- pwd : print working directory
+- ls [DIR] : list # defaultは'.'
+- cd [DIR] : change directory # defaultは'~'
+  - '~' tilde, ホームdirectoryを指す
+# file comms
+- mv : move
+- cp : copy
+- mkdir : make directory
+- rm : remove
+  - rm -rf DIR # DIRごとremove
+# editor key binds
+-                       c-p(previous)
+- c-a(ahead), c-b(back), c-f(forward), c-e(end)
+-                       c-n(next)
+- c-d(delete), c-k(kill-line), del
+- c-y(yank, paste)
+# capture comms
+- Mac
+  - whole : Shift + Command + 3
+  - select: Shift + Command + 4
+  - window: Shift + Command + 4 , space
+  -  Desktopに保存
+- Windows :
+  - Win + Shift + S, それからIcon操作
+  - 「ピクチャ」->「スクリーンショット」に保存

data/lib/templates/kick_off.org ADDED Viewed

@@ -0,0 +1,57 @@
+#+OPTIONS: ^:{}
+#+STARTUP: indent nolineimages overview num
+* head: help_title example
+* license:      cc by Shigeto R. Nishitani, 2016-24
+* initial_operation
+最初(initial)の操作
+    1. cd comp_a_25s
+    2. git stash                         # 変更をgitに無かったことに
+    3. git pull origin main              # 最新のfilesをgitでpull(引っ張ってくる)
+    4. cp bin/kick_off ~/bin             # 最新版のkick_offを~/binにcopy
+    5. cd ~/my_comp_a/python
+    6. cp ~/comp_a_25s/python/hogehoge . # hogehogeファイルを'.'にcp
+* wsl shell commands
+     - cat : catenate # 中身を出力する
+      - cat results | pbcopy(clip.exe)
+              # '|' pipe : 出力結果を次のclaに渡す
+              # 'clip.exe'->'pbcopy' for mac users
+    - bat : batcat
+      - kick_off -f | bat -l zsh
+              # | bat -l zsh
+    - python3 d1_print_calendar.py > results.txt
+              # '>' redirect : 出力をfileに保存
+    - history
+      - history -r | tail -20 | clip.exe
+    - tree, open, code .,
+* directory(path) related commands
+    - pwd : print working directory
+              # 今いる絶対path(dir)
+    - ls [DIR] : list # defaultは'.'
+              # '.' current dir, 今いるdirectory
+    - cd [DIR] : change directory # defaultは'~'
+              # '~' tilde, ホームdirectoryを指す
+              # '..' 一つ上の相対path
+* file related commands
+    - mv  : move
+    - cp  : copy
+    - mkdir : make directory
+    - rm  : remove
+      - rm -rf DIR # DIRごとremove
+      # recursive 繰り返し（再帰的に）, force 強制的に
+* editor key binds
+    -                 c-p(previous)
+    - c-a(ahead), c-b(back), c-f(forward), c-e(end)
+    -                 c-n(next)
+    - c-d(delete), c-k(kill-line), del
+    - c-y(yank, paste)
+* capture commands
+    Screen capture
+    Mac
+      whole : Shift + Command + 3
+      select: Shift + Command + 4
+      window: Shift + Command + 4 , space
+      Desktopに保存
+    Windows  :
+      Win + Shift + S, それからIcon操作
+      ピクチャ」->「スクリーンショット」に保存

data/my_help.gemspec CHANGED Viewed

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   # Uncomment to register a new dependency of your gem
-  spec.add_development_dependency "rspec"
+#  spec.add_development_dependency "rspec"
   spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "command_line"
   spec.add_runtime_dependency "colorize"
 #  spec.add_development_dependency "aruba"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "rubocop"
+#  spec.add_development_dependency "yard"
+#  spec.add_development_dependency "rubocop"
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 end