my_help 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a77e9a66372bd04c96bb0e29de646913594a2fe
-  data.tar.gz: 4e27864662ad2ecbe5d672824b37595f6780408d
+  metadata.gz: 13b91f6abff32e7684a29cc6ed379336cec60491
+  data.tar.gz: 4a4615b5241da57e266de134b904b68cf030cb11
 SHA512:
-  metadata.gz: 1bc062f32280693491ef365b7ec53ef9bbe4c01889f33e122aac2cc9172a75c38db84b8f07a2743de44f8ce3cc1b5b13fa261ddec7cf94a8f7129581b310b260
-  data.tar.gz: 6402844db1fc46a448a549a9ffbbd3c04ac082464b6ef8f7d394de299a3e699484b154c671c9c4c045eefb9be73753c491146c871e0ba8fbd5c12bf1100c021c
+  metadata.gz: eed8e764d4d4a8cca12016807e1792886c297e347fd1c722e6466eaf4ec1043dad5b408090eaefd9d1b4f9bbd6fb6381ad3be98852584fa7a7fd09cc68f68aa3
+  data.tar.gz: 7518cd00a767a2d0c63ec0b514a0d39d9fb6eda53a2ee77c40e7db508d4de0ef2f281dcba2f7b200648bd42337f81cf81ed57a3247a132112f6b44c6f4126fc1

data/Gemfile.lock

@@ -10,9 +10,9 @@ GEM
   specs:
     colorize (0.8.1)
     diff-lcs (1.3)
-    ffi (1.11.1)
+    ffi (1.11.2)
     gli (2.17.1)
-    rake (13.0.0)
+    rake (13.0.1)
     rdoc (6.2.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)

data/README.org

@@ -135,3 +135,10 @@ COMMANDS
 : my_help delete new_help
 
 すると消されます．
+* test
+testは[[/Users/bob/github/ruby_docs/testing_frameworks/test_unit/README.org]]
+にあるのに従って書いている．
+
+「Rubyベストプラクティス」にあるmustを使ったextension
+を組み込んで，DSLにしている．
+[[https://github.com/practicingruby/rbp/blob/master/testing/test_unit_extensions.rb]]

data/exe/my_help

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

data/lib/my_help/my_help_controll.rb

@@ -1,16 +1,47 @@
-# -*- coding: utf-8 -*-
+# coding: utf-8
+require 'fileutils'
+require 'yaml'
+
 module MyHelp
-  class Control
+  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')
-     # @mini_account = File
+      @editor = 'code' #'emacs' #'vim'
+      # @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(Dir.pwd, file_name)
+      @conf_file = File.join(@local_help_dir, file_name)
+      conf = {editor: editor}
+      File.open(@conf_file, 'w'){|f| YAML.dump(conf, f)}
+    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
+        p e
+        set_editor('code')
+      end
     end
 
     def set_help_dir_if_not_exists
-      return if File::exists?(@local_help_dir)
+      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'
@@ -20,66 +51,60 @@ module MyHelp
       }
     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|
-        next if key==:license or key==:head
-        if cont[:opts][:short] == item or cont[:opts][:long] == item
-          o_key = key
-          break
+    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
-      o_key
+      output
     end
 
+    WrongFileName = Class.new(RuntimeError)
     def list_help(file)
+      output = ''
       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] )
+      begin
+        help = auto_load(file_path)
+      rescue => e
+        raise WrongFileName, "No help named '#{file}' in the directory '#{local_help_dir}'."
       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
+      help.each_pair do |key, conts|
+        output << conts[:cont] if key==:head
+        output << disp_opts( conts[:opts] )
       end
-      print("\n")
+      output
     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.rjust(10).blue
-        print ": #{desc}\n".blue
+    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 "emacs #{target_help}"
+        system "#{@editor} #{target_help}"
       else
         puts "file #{target_help} does not exits in #{@local_help_dir}."
         puts "init #{file} first."
@@ -114,39 +139,44 @@ module MyHelp
       end
     end
 
-    def upload_help(file)
-      p target_help = File.join(@local_help_dir,file+'.org')
-      puts "miniのuser_nameを入力してください．"
-      p user_name = STDIN.gets.chomp
-      puts "保存するディレクトリ名を入力してください．"
-      p directory_name = STDIN.gets.chomp
-      if local_help_entries.member?(file+'.org')
-        #        if target_help.empty?(file+'.org')
-#          system "scp #{@local_help_dir} tomoko_y@mini:~/our_help/member/tomoko"
-#        else
-        system "scp #{target_help} #{user_name}@mini:~/our_help/member/#{directory_name}"
-      puts "後は，miniでgitにpushしてください．"
-#      end
-      else
-        puts "file #{target_help} does not exits in #{@local_help_dir}."
-        puts "init #{file} first."
+    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
 
-=begin
-    def search_help(file)
-      p find_char = STDIN.gets.chomp
-      system "ls #{@local_help_dir} | grep #{find_char}"
+    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
-=end
 
-    private
     def local_help_entries
       entries= []
       Dir.entries(@local_help_dir).each{|file|
-#        next unless file.include?('_')
+        #        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(/(.+)_e\.org/) # OK?
         #        next if file.match(/(.+)\.html/)
         if file.match(/(.+)\.org$/) # OK?
           entries << file
@@ -157,8 +187,8 @@ module MyHelp
 
     def auto_load(file_path)
       case File.extname(file_path)
-#      when '.yml'
-#        cont = YAML.load(File.read(file_path))
+      #      when '.yml'
+      #        cont = YAML.load(File.read(file_path))
       when '.org'
         cont = OrgToYaml.new(file_path).help_cont
       else

data/lib/my_help/version.rb

@@ -1,3 +1,3 @@
 module MyHelp
-  VERSION = "0.8.0"
+  VERSION = "0.8.2"
 end

data/my_help.gemspec

@@ -18,8 +18,8 @@ spec = Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.add_development_dependency('rake')
   s.add_development_dependency('rdoc')
-  s.add_development_dependency('thor')
   s.add_development_dependency('rspec')
-  s.add_runtime_dependency('gli','2.17.1')
+  s.add_runtime_dependency('thor')
+#  s.add_runtime_dependency('gli','2.17.1')
   s.add_runtime_dependency "colorize"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Shigeot R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,33 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gli
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.17.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.17.1
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +91,6 @@ files:
 - ".dockerignore"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - ".yardoc/checksums"
 - ".yardoc/complete"
@@ -120,7 +105,6 @@ files:
 - README.rdoc
 - README_en.org
 - Rakefile
-- Rakefile_gli
 - doc/MyHelp.html
 - doc/MyHelp/Control.html
 - doc/OrgToYaml.html
@@ -150,8 +134,6 @@ files:
 - lib/templates/org.org
 - lib/templates/todo.org
 - my_help.gemspec
-- my_help.rdoc
-- tmp.rb
 homepage: https://github.com/daddygongon/my_help
 licenses:
 - MIT

data/.ruby-version

@@ -1 +0,0 @@
-2.4.3

data/Rakefile_gli

@@ -1,44 +0,0 @@
-require 'rake/clean'
-require 'rubygems'
-require 'rubygems/package_task'
-require 'rdoc/task'
-require 'cucumber'
-require 'cucumber/rake/task'
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
-  rd.title = 'Your application title'
-end
-
-spec = eval(File.read('my_help.gemspec'))
-
-Gem::PackageTask.new(spec) do |pkg|
-end
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-desc 'Run features'
-Cucumber::Rake::Task.new(:features) do |t|
-  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
-  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
-  t.cucumber_opts =  opts
-  t.fork = false
-end
-
-desc 'Run features tagged as work-in-progress (@wip)'
-Cucumber::Rake::Task.new('features:wip') do |t|
-  tag_opts = ' --tags ~@pending'
-  tag_opts = ' --tags @wip'
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
-  t.fork = false
-end
-
-task :cucumber => :features
-task 'cucumber:wip' => 'features:wip'
-task :wip => 'features:wip'
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
-end
-
-task :default => [:test,:features]

data/my_help.rdoc

@@ -1,5 +0,0 @@
-= my_help
-
-Generate this with
-    my_help rdoc
-After you have described your command line interface

data/tmp.rb

@@ -1,5 +0,0 @@
-def test(opts={})
-  p opts[:test2]
-end
-
-test(test: 'hoge', test2: 'hage')