my_help 0.8.5 → 1.1a

data/README.rdoc

@@ -1,6 +0,0 @@
-= my_help
-
-Describe your project here
-
-:include:my_help.rdoc
-

data/bin/my_help_thor

@@ -1,66 +0,0 @@
-#!/usr/bin/env ruby
-require 'thor'
-require 'my_help'
-require 'colorize'
-class MyCLI < Thor
-  desc('setup', 'set up the test database')
-  def setup(*args)
-    $control = MyHelp::Control.new()
-  end
-
-  desc "list", "list all helps, specific HELP, or item"
-  def list(*args)
-    invoke :setup
-    file = args[0]
-    item = args[1]
-    if file.nil?
-      puts $control.list_all # list []
-    elsif item.nil?
-      begin
-        puts $control.list_help(file) # list [file]
-      rescue => e
-        puts e.to_s.red
-      end
-    else
-      begin
-        puts $control.show_item(file, item) # list [file] [item]
-      rescue => e
-        puts e.to_s.red
-      end
-    end
-  end
-
-  desc "edit {help_name}", "edit HELP_NAME"
-  def edit(help_name)
-    invoke :setup
-    $control.edit_help(help_name)
-  end
-
-  desc "new {help_name}", "make new HELP_NAME"
-  def new(help_name)
-    invoke :setup
-    $control.init_help(help_name)
-  end
-
-  desc "delete {help_name}", "delete HELP_NAME"
-  def delete(help_name)
-    invoke :setup
-    $control.delete_help(help_name)
-  end
-
-  desc "tomo_upload {help_name}", "tomo_upload HELP_NAME"
-  def tomo_upload(help_name)
-    invoke :setup
-    $control.upload_help(help_name)
-  end
-
-  desc "search {find_char}", "search FIND_CHAR"
-  def search(find_char)
-    invoke :setup
-    $control.search_help(find_char)
-  end
-end
-
-MyCLI.start(ARGV)
-
-

data/exe/my_help_gli

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-require 'gli'
-require 'my_help'
-
-include GLI::App
-
-program_desc 'make own help and list.'
-
-version MyHelp::VERSION
-
-subcommand_option_handling :normal
-arguments :strict
-
-desc 'list all helps, specific HELP, or item'
-arg_name 'HELP_NAME, ITEM'
-command :list do |c|
-  c.action do |global_options,options,args|
-    file, item = args
-    if file.nil?
-      $control.list_all
-    elsif item.nil?
-      $control.list_help(file)
-    else
-      $control.show_item(file, item)
-    end
-  end
-end
-
-desc 'edit HELP_NAME help'
-arg_name 'HELP_NAME'
-command :edit do |c|
-  c.action do |global_options,options,args|
-    $control.edit_help(args[0])
-  end
-end
-
-desc 'make new HELP_NAME help'
-arg_name 'HELP_NAME'
-command :new do |c|
-  c.action do |global_options,options,args|
-    $control.init_help(args[0])
-  end
-end
-
-desc 'delete HELP_NAME help'
-arg_name 'HELP_NAME'
-command :delete do |c|
-  c.action do |global_options,options,args|
-    $control.delete_help(args[0])
-  end
-end
-
-desc 'tomo_upload HELP_NAME help'
-arg_name 'HELP_NAME'
-command :tomo_upload do |c|
-  c.action do |global_options,options,args|
-    $control.upload_help(args[0])
-  end
-end
-
-desc 'search FIND_CHAR'
-arg_name = 'FIND_CHAR'
-command :search do |c|
-  c.action do |global_options,options,args|
-    $control.search_help(args[0])
-  end
-end
-
-
-pre do |global,command,options,args|
-  $control = MyHelp::Control.new()
-  true
-end
-
-post do |global,command,options,args|
-end
-
-on_error do |exception|
-  true
-end
-
-exit run(ARGV)

data/lib/my_help/my_help_controll.rb

@@ -1,220 +0,0 @@
-# coding: utf-8
-require 'fileutils'
-require 'yaml'
-
-module MyHelp
-  class Control  
-    attr_accessor :local_help_dir, :editor
-    def initialize()
-      # for configuration setups
-      # see https://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem
-
-      @template_dir = File.expand_path("../../templates", __FILE__)
-      @exe_dir = File.expand_path("../../exe", __FILE__)
-      @local_help_dir = File.join(ENV['HOME'],'.my_help')
-      @editor = 'code' #'emacs' #'vim' #default editor
-      # @mini_account = File
-      set_help_dir_if_not_exists
-      load_conf
-    end
-
-    def set_editor(editor)
-      @editor = editor
-      file_name = '.my_help_conf.yml'
-      @conf_file = File.join(@local_help_dir, file_name)
-      conf = {editor: editor}
-      File.open(@conf_file, 'w'){|f| YAML.dump(conf, f)}
-      puts "set editor '#{@editor}'"
-    end
-
-    def load_conf
-      file_name = '.my_help_conf.yml'
-      # @conf_file = File.join(Dir.pwd, file_name)
-      @conf_file = File.join(@local_help_dir, file_name)
-      begin
-        conf = YAML.load_file(@conf_file)
-        @editor = conf[:editor]
-      rescue => e
-        puts e.to_s.red
-        puts 'make .my_help_conf.yml'.green
-        set_editor(@editor)
-      end
-    end
-
-    def set_help_dir_if_not_exists
-      return if File::exist?(@local_help_dir)
-      FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
-      Dir.entries(@template_dir).each{|file|
-        next if file=='help_template.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 list_all
-      output = "\nList 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?
-        begin
-          desc = help[:head][:cont].split("\n")[0]
-        rescue => e
-          puts e
-          puts "No head in #{file_path}".red
-          next
-        end
-        output << title.rjust(10)
-        output << ": #{desc}\n"
-      end
-      output
-    end
-
-    WrongFileName = Class.new(RuntimeError)
-    def list_help(file)
-      output = ''
-      file_path=File.join(@local_help_dir,file+'.org')
-      begin
-        help = auto_load(file_path)
-      rescue => e
-        raise WrongFileName, "No help named '#{file}' in the directory '#{local_help_dir}'."
-      end
-      help.each_pair do |key, conts|
-        output << conts[:cont] if key==:head
-        output << disp_opts( conts[:opts] )
-      end
-      output
-    end
-
-    WrongItemName = Class.new(RuntimeError)
-    def show_item(file, item)
-      output = ''
-      file_path=File.join(@local_help_dir,file+'.org')
-      help = auto_load(file_path)
-      select = select_item(help, item)
-      output << help[:head][:cont]
-      unless select then
-        raise WrongItemName, "No item entry: #{item}"
-      end
-      output << '-'*5+"\n"+select.to_s.green+"\n"
-      output << help[select][:cont]
-    end
-
-    def edit_help(file)
-      p target_help = File.join(@local_help_dir,file+'.org')
-      if local_help_entries.member?(file+'.org')
-        system "#{@editor} #{target_help}"
-      else
-        puts "file #{target_help} does not exits in #{@local_help_dir}."
-        puts "init #{file} first."
-      end
-    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,'help_template.org')
-      FileUtils::Verbose.cp(template,target_help)
-    end
-
-=begin
-    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
-=end
-
-    def delete_help(file)
-      file = File.join(@local_help_dir,file+'.org')
-      print "Are you sure to delete "+file.blue+"?[Yn] ".red
-      case STDIN.gets.chomp
-      when 'Y'
-        begin
-          FileUtils.rm(file,:verbose=>true)
-          return 0
-        rescue => error
-          puts error.to_s.red
-          return 1
-        end
-      when 'n', 'q' ; return 0
-      end
-    end
-
-    def search_help(word)
-      p find_char = word
-      system "ls #{@local_help_dir} | grep #{find_char}"
-    end
-
-    private
-    def select_item(help, item)
-      o_key = nil
-      help.each_pair do |key, cont|
-        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 disp_opts( conts )
-      output = ''
-      col = 0
-      conts.each_pair do |key, item|
-        col_length = case col
-                     when 0; output << item.rjust(5)+", "
-                     when 1; output << item.ljust(15)+": "
-                     else; output << item
-                     end
-        col += 1
-      end
-      output << "\n"
-    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?
-        #        next if file.match(/(.+)\.html/)
-        if file.match(/(.+)\.org$/) # OK?
-          entries << file
-        end
-      }
-      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/templates/help_template.org

@@ -1,8 +0,0 @@
-#+STARTUP: indent nolineimages
-* head
-- ヘルプのサンプル雛形
--   headに常に表示される内容を記述
-* license
--      cc by Shigeto R. Nishitani, 2016
-* item_example
-- itemの例