my_help 0.8.5 → 1.1a

data/lib/my_help/cli.rb

@@ -0,0 +1,106 @@
+module MyHelp
+  class CLI < Thor
+    include GetConfig
+    class_option :help_dir, :type => :string
+    #    option :help_dir, :type => :string
+    #    option :layer, :type => :numeric
+
+    # THOR to SILENCE DEPRECATION
+    # https://qiita.com/tbpgr/items/5edb1454634157ff816d
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+
+    desc "version", "show version"
+
+    def version
+      puts VERSION
+    end
+
+    desc "git [pull|push]", "git operations"
+    subcommand "git", Git
+
+    desc "init", "initialize my_help environment"
+
+    def init(*args)
+      config = get_config # for using methods in Config
+      #config.ask_default
+      init = Init.new(config)
+      raise "Local help dir exist." if init.help_dir_exist?
+      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."
+    end
+
+    desc "set [:key] [VAL]", "set editor or ext"
+
+    def set(*args)
+      config = get_config # for using methods in Config
+      key = args[0] || ""
+      config.configure(key.to_sym => args[1])
+      config.save_config
+      conf_file_path = config[:conf_file]
+      puts "conf_file_path: %s" % conf_file_path
+      puts File.read(conf_file_path)
+    end
+
+    desc "list [HELP] [ITEM]", "list helps"
+    #    option :help_dir, :type => :string
+    option :layer, :type => :numeric
+    # use method_options [[https://github.com/rails/thor/wiki/Method-Options]]
+    def list(*args)
+      config = get_config
+      help_dir = options["help_dir"] || config[:local_help_dir]
+      layer = options["layer"] || 1
+      puts List.new(help_dir,
+                    config[:ext],
+                    layer).list(*args.join(" "))
+    end
+
+    desc "edit [HELP]", "edit help"
+
+    def edit(*args)
+      c = get_config
+      help_name = args[0]
+      Modify.new(c).edit(help_name)
+    end
+
+    desc "new  [HELP]", "mk new HELP"
+
+    def new(*args)
+      c = get_config
+      help_name = args[0]
+      help_file = File.join(c[:local_help_dir], help_name + c[:ext])
+      Modify.new(c).new(help_file)
+      #     puts res.stdout
+    end
+
+    desc "delete [HELP]", "delete HELP"
+
+    def delete(*args)
+      c = get_config
+      help_name = args[0]
+      help_file = File.join(c[:local_help_dir], help_name + c[:ext])
+      puts "Are you sure to delete #{help_file}? [YN]"
+      responce = $stdin.gets.chomp
+      if responce.upcase[0] == "Y"
+        Modify.new(c).delete(help_file)
+      else
+        puts "Leave #{help_file} exists."
+      end
+    end
+
+    desc "hello", "hello"
+
+    def hello
+      name = $stdin.gets.chomp
+      puts("Hello #{name}.")
+    end
+  end
+end

data/lib/my_help/config.rb

@@ -0,0 +1,70 @@
+module MyHelp
+
+  # make @config from default and load yaml
+  # as shown
+  # https://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem
+  class Config
+    attr_reader :valid_config_keys
+    # Configuration defaults
+    def initialize(conf_path = nil)
+      conf_path ||= ENV["HOME"]
+      local_help_dir = File.join(conf_path, ".my_help")
+      @config = {
+        template_dir: File.expand_path("../templates", __dir__),
+        local_help_dir: local_help_dir,
+        conf_file: File.join(local_help_dir, ".my_help_conf.yml"),
+        editor: ENV["EDITOR"] || "emacs",
+        ext: ".org",
+        verbose: false,
+      }
+      @valid_config_keys = @config.keys
+      configure_with(@config[:conf_file])
+      #      YAML.dump(@config, File.open(@config[:conf_file], 'w'))
+      # no good for multiple testers.
+    end
+
+    # Configure through hash
+    def configure(opts = nil)
+      return if opts == nil
+      opts.each do |k, v|
+        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
+        else
+          raise KeyError.new("Error: keyword '#{k}' is invalid",
+                             receiver: @config,
+                             key: k)
+        end
+      end
+      @config
+    end
+
+    # Configure through yaml file
+    def configure_with(path)
+      begin
+        config = YAML.safe_load(IO.read(path),
+                                permitted_classes: [Symbol])
+      rescue Errno::ENOENT => e
+        message = "WARNING: #{e.message}.\nUsing default conf."
+        $stderr.puts message if @config[:verbose]
+      rescue Psych::SyntaxError => e
+        message = "WARNING: #{e.message}.\nUsing default conf."
+        $stderr.puts message if @config[:verbose]
+      end
+      configure(config)
+    end
+
+    # save config in  @config[:conf_file]
+    def save_config()
+      File.write(@config[:conf_file], YAML.dump(config))
+    end
+
+    attr_reader :config
+
+    def [](sym)
+      @config[sym]
+    end
+  end
+end

data/lib/my_help/git_cli.rb

@@ -0,0 +1,40 @@
+module MyHelp
+  module GetConfig
+    def get_config #(args)
+      parent_help_dir = options["help_dir"] || ""
+      parent_help_dir = ENV["HOME"] unless File.exist?(parent_help_dir)
+      return Config.new(parent_help_dir)
+    end
+  end
+
+  class Git < Thor
+    include MyHelp::GetConfig
+
+    desc "pull", "pull my helps"
+
+    def pull
+      puts "called my_help git pull"
+      config = get_config
+      help_dir = config[:local_help_dir]
+      puts "on the target git directory : %s" % help_dir
+      Dir.chdir(help_dir) do
+        system "git pull origin main"
+      end
+    end
+
+    desc "push", "push my helps"
+
+    def push
+      puts "called my_help git push"
+      config = get_config
+      help_dir = config[:local_help_dir]
+      puts "on the target git directory : %s" % help_dir
+      Dir.chdir(help_dir) do
+        system "git add -A"
+        system "git commit -m 'auto commit from my_help'"
+        system "git pull origin main"
+        system "git push origin main"
+      end
+    end
+  end
+end

data/lib/my_help/init.rb

@@ -0,0 +1,28 @@
+module MyHelp
+  class Init
+    def initialize(config)
+      @config = config
+    end
+
+    def help_dir_exist?
+      File.exist?(@config[:local_help_dir])
+    end
+
+    def check_conf_exist
+      File.exist?(@config[:conf_file])
+    end
+
+    def mk_help_dir
+      FileUtils.mkdir(@config[:local_help_dir])
+    end
+
+    def cp_templates
+      target_dir = @config[:local_help_dir]
+      src_dir = @config[:template_dir]
+      ext = @config[:ext]
+      Dir.glob(File.join(src_dir, "*#{ext}")).each do |file|
+        FileUtils.cp(file, target_dir, verbose: false)
+      end
+    end
+  end
+end

data/lib/my_help/list.rb

@@ -0,0 +1,76 @@
+require_relative "./org2yml"
+#require "colorize"
+require "colorized_string"
+
+module MyHelp
+  # Your code goes here...
+  class List
+    def initialize(path = "", ext = ".org", layer = 1)
+      @path = path
+      @ext = ext
+      p @layer = layer
+    end
+
+    def list(help_options = "", level = 0)
+      name, item = help_options.split(" ")
+      if item == nil && name == nil
+        list_helps()
+      else
+        path = File.exists?(name + @ext) ? name + @ext :
+          File.join(@path, name + @ext)
+        list_help_with(path, name, item)
+      end
+    end
+
+    def read_help(file)
+      info = {}
+      info[:items] = Org2Hash.new(File.read(file)).contents
+      info[:name] = File.basename(file).split(".")[0]
+      return info
+    end
+
+    def list_helps()
+      files = File.join(@path, "*#{@ext}")
+      Dir.glob(files).inject("") do |out, file|
+        #        p [out, file]
+        help_info = read_help(file)
+        out << "%10s: %s\n" % [help_info[:name],
+                               help_info[:items]["head"].split("\n")[0]]
+      end
+    end
+
+    # defaultで@path/name.@extのヘルプを読み込んで，itemを表示
+    #
+    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)
+
+      if item == nil
+        @help_info[:items].each_pair do |item, val|
+          item, desc = item.split(":")
+          desc ||= ""
+          output << "- %20s : %s\n" % [item, desc]
+        end
+      else
+        output << find_near(item)
+      end
+      return output
+    end
+
+    def find_near(input_item)
+      candidates = []
+      @help_info[:items].each_pair do |item, val|
+        candidates << item if item.include?(input_item)
+      end
+      if candidates.size == 0
+        "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]
+        end
+        contents.join("\n")
+      end
+    end
+  end
+end

data/lib/my_help/md2hash.rb

@@ -0,0 +1,54 @@
+module MyHelp
+  class Md2Hash
+    attr_accessor :md_text, :contents, :results, :opts
+
+    def initialize(md_text = "", **opts)
+      @opts = opts
+      @md_text = md_text.split("\n")
+      @contents = fsm
+      #fsm()
+    end
+
+    TRANS = {
+      #current
+      #            new         action
+      #-----------------------------------
+      init: {
+        #"*" => [:init, :ignore],
+        :default => [:init, :ignore],
+        "#" => [:reading, :item],
+      },
+      reading: {
+        "#" => [:reading, :item],
+        :default => [:reading, :data],
+      },
+    }
+
+    def fsm
+      contents = {}
+      state = :init
+      @results = []
+      item = ""
+      @md_text.each do |line|
+        state, action = TRANS[state][line[0]] || TRANS[state][:default]
+
+        if line[0..1] == "#+" # line[1] != " "
+          state = :init
+          action = :ignore
+        end
+
+        results << [line, state, action]
+
+        case action
+        when :ignore
+        when :item
+          item = line.match(/^# (.+)/)[1]
+          contents[item] = []
+        when :data
+          contents[item] << line
+        end
+      end
+      return contents
+    end
+  end
+end

data/lib/my_help/modify.rb

@@ -0,0 +1,33 @@
+module MyHelp
+  class Modify
+    def initialize(conf)
+      @conf = conf
+    end
+
+    def new(help_file)
+      target = help_file
+      source = File.join(@conf[:template_dir], "example.org")
+      FileUtils.cp(source, target, verbose: @conf[:verbose])
+    end
+
+    def delete(help_file)
+      if File.exist?(help_file)
+        FileUtils.rm(help_file, verbose: @conf[:verbose])
+      else
+        puts "file #{help_file} does not exist."
+      end
+    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}"
+        system(comm)
+      else
+        puts "file #{help_file} does not exist,"
+        puts "make #{help_name} first by 'new' command."
+      end
+    end
+  end
+end

data/lib/my_help/org2hash.rb

@@ -0,0 +1,45 @@
+module MyHelp
+  # get org and trans it to hash by FSM
+  class Org2Hash
+    attr_accessor :contents, :text
+    # current_state => [  new_state,    action ]
+    TRANSITIONS = {
+      :header_read => {
+        "* " => [:contents_read, :start_new_item],
+        :default => [:header_read, :ignore],
+      },
+      :contents_read => {
+        "* " => [:contents_read, :start_new_item],
+        :default => [:contents_read, :add_contents],
+      },
+    }
+
+    def initialize(org_text)
+      @text = org_text
+      @contents = Hash.new
+      simple_fsm()
+    end
+
+    def simple_fsm()
+      state = :header_read
+      item = ""
+      @text.split("\n").each do |line|
+        next if line.size < 1
+        state, action = TRANSITIONS[state][line[0..1]] ||
+                        TRANSITIONS[state][:default]
+        case action
+        when :ignore
+        when :start_new_item
+          item = read_item(line)
+          @contents[item] = ""
+        when :add_contents
+          @contents[item] += line + "\n"
+        end
+      end
+    end
+
+    def read_item(line)
+      line.match(/\* (.+)/)[1]
+    end
+  end
+end

data/lib/my_help/org2yml.rb

@@ -1,24 +1,24 @@
 # -*- coding: utf-8 -*-
-require 'yaml'
-require 'pp'
+require "yaml"
+require "pp"
 
-class OrgToYaml
+class Org2Yaml
   attr_accessor :help_cont
 
   def initialize(file)
     @help_cont = {} #{ head: [File.basename(file, '.org')] }
     @head_sym = nil
-    @conts = ''
+    @conts = ""
     @short_stored = []
     org_to_yaml(File.readlines(file))
   end
 
   def make_options(line)
-    head, desc = line.split(':')
+    head, desc = line.split(":")
     desc ||= head.to_s
     short = "-#{head[0]}"
-    if @short_stored.include?(short) or head=='license' or head=='head'
-      short = ''
+    if @short_stored.include?(short) or head == "license" or head == "head"
+      short = ""
     else
       @short_stored << short
     end
@@ -27,27 +27,28 @@ class OrgToYaml
 
   def next_cont(head)
     @help_cont[@head_sym][:cont] = @conts if @head_sym
-    return if head == 'EOF'
-    @conts = ''
+    return if head == "EOF"
+    @conts = ""
     @head_sym = head.to_sym
     @help_cont[@head_sym] = {
-      opts: make_options(head), title: head, cont: ''
+      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]
+      m = line.force_encoding(Encoding::UTF_8).match(/^(\*+) (.+)/u)
+      if m
+        next_cont m[2]
       else
         @conts << line
       end
     end
-    next_cont 'EOF'
+    next_cont "EOF"
   end
 end
 
-if $PROGRAM_NAME == __FILE__ 
+if $PROGRAM_NAME == __FILE__
   helps = OrgToYaml.new(ARGV[0])
   pp helps.help_cont
 end

data/lib/my_help/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MyHelp
-  VERSION = "0.8.5"
+  VERSION = "1.1a"
 end

data/lib/my_help.rb

@@ -1,7 +1,23 @@
-require 'my_help/version.rb'
-require 'my_help/my_help_controll'
-require 'my_help/tomo_help_controll'
-require 'my_help/org2yml'
-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
+# frozen_string_literal: true
+require "thor"
+require "fileutils"
+require "pp"
+require "yaml"
+require "command_line/global"
+
+require_relative "my_help/version"
+require_relative "my_help/list"
+require_relative "my_help/config"
+require_relative "my_help/modify"
+require_relative "my_help/init"
+require_relative "my_help/git_cli"
+require_relative "my_help/cli"
+require_relative "my_help/org2hash"
+require_relative "my_help/md2hash"
+
+module MyHelp
+  class Error < StandardError; end
+
+  # Your code goes here...
+
+end

data/lib/templates/emacs.org

@@ -1,33 +1,32 @@
-#+STARTUP: indent nolineimages
+#+STARTUP: indent nolineimages overview
 * head
 - Emacs key bind
-- 
-special key command
--   c-f, While pressing the control key, press 'f'
--   M-f, After pressing Esc key, press 'f'
--   c-g, Operation interruption 
--   c-x u, Undo operation(Undo)
+- special key command
+  -   c-f, While pressing the control key, press 'f'
+  -   M-f, After pressing Esc key, press 'f'
+  -   c-g, Operation interruption 
+  -   c-x u, Undo operation(Undo)
 * license
 -      cc by Natsuko Kawabata, 2017
 
-* move cursor
+* cursor_move
 - c-f, move Forward,		  Move to forward or right
 - c-b, move Backward,   	  Move to back or left
 - c-a, go Ahead of line, 	  Move to the beginning of the line
 - c-e, go End of line,   	  Move to the end of the line
 - c-n, move Next line,      Move to next line
 - c-p, move Previous line,  Move to previous line
-* move page
+* page_move
 - c-v, move Vertical,          Move to next page
 - M-v, move reversive Vertical,Move to previous page
 - c-l, centerise Line,         Move to center on current line
 - M-<, move Top of file,    	 Move to the top of the file
 - M->, move Bottom of file,    Move to the end of the file
-* file operation file
+* file_operation
 - c-x c-f, Find file, Find file
 - c-x c-s, Save file, Save file
 - c-x c-w, Write file NAME, Write a file with another name
-* edit operation
+* edit_operation
 - c-d, Delete char, Delete a letter
 - c-k, Kill line,   Delete a line，cut
 - c-y, Yank,        Paste
@@ -36,15 +35,15 @@ special key command
 - c-s, forward incremental Search WORD, 前へ WORD を検索
 - c-r, Reverse incremental search WORD, 後へ WORD を検索
 - M-x query-replace WORD1 <ret> WORD2：対話的置換(y or n で可否選択)
-* window operation
+* window_operation
 - c-x 2, 2 windows, Split into two windows 二つに分割
 - c-x 1, 1 windows, Integrate in a window
 - c-x 3, 3rd window sep, Split vertically
 - c-x o, Other windows, Move to the next window
-* buffer operation
+* buffer_operation
 - すでに open して Emacs にバッファーされた file
 - c-x b, show Buffer,   Buffer list
 - c-x c-b, next Buffer, Move to next buffer
-* quit operation
+* quit_operation
 - c-x c-c, Quit Emacs, Save file and quit
 - c-z, suspend Emacs,  Pause，restart with fg

data/lib/templates/example.md

@@ -0,0 +1,17 @@
+# head
+
+- help_title example
+
+# license
+
+-      cc by Shigeto R. Nishitani, 2016-22
+
+# a_item
+
+- item_short_description
+- content_a
+
+# b_item
+
+- b_item
+- content_b

data/lib/templates/example.org

@@ -0,0 +1,9 @@
+#+STARTUP: indent nolineimages overview
+* head
+- help_title example
+* license
+-      cc by Shigeto R. Nishitani, 2016-22
+* a_item : item_short_description
+- content_a
+* b_item
+- content_b