generate_shell_completion 0.0.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a490a6fc92c57597553c6812c276c418b45788cf26db362db051030805a2cd09
+  data.tar.gz: b84865cd571afdb95ec7330c66ecdbe83eca28170fd3db157eed741bfbb4690d
+SHA512:
+  metadata.gz: 13c074403c84c66f909283cce30da19f428f8e2686d14d0ebc2fbafcd1b815d2de4666264b85a76703325727582c8c535daea5add71ae06349704cac3d4a4479
+  data.tar.gz: 6da482a5b1ef233071e64a48e0898d2da81813ab08809d13b9eda8132b0ad3e768082c3d56194e635546e3b6c2562d6ca416ee0d2fa818fc1f8406e7cf875120

data/USAGE.md

@@ -0,0 +1,11 @@
+= Usage of this Library
+
+== Requiring it
+
+  require 'generate_shell_completion'
+
+== Using it in a project
+
+  _ = Generate_shell_completion.new("science_news")
+  _.run
+

data/generate_shell_completion.gemspec

@@ -0,0 +1,41 @@
+# =========================================================================== #
+# Gemspec for Project generate_shell_completion.
+# =========================================================================== #
+require 'generate_shell_completion/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'generate_shell_completion'
+  s.version = GenerateShellCompletion::GenerateShellCompletion::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+  
+  s.summary = <<-EOF
+  EOF
+  
+  s.description = <<-EOF
+
+    This library is called generate_shell_completion.
+
+  EOF
+  
+  s.extra_rdoc_files = %w()
+  
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+  s.files    << 'USAGE.md'
+  s.license  = 'GPL-2.0'
+  s.homepage = 'https://rubygems.org/gems/generate_shell_completion'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'save_file'
+
+}

data/lib/generate_shell_completion/generate_shell_completion.rb

@@ -0,0 +1,267 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === GenerateShellCompletion::GenerateShellCompletion
+#
+# This class will generate a completion file for bash.
+#
+# I wanted to have a new class rather than bundle it inside of the
+# project RBT.
+#
+# Usage example:
+#
+#   GenerateShellCompletion::GenerateShellCompletion.new(ARGV)
+#
+# =========================================================================== #
+# require 'generate_shell_completion'
+# =========================================================================== #
+require 'generate_shell_completion/version/version.rb'
+
+module GenerateShellCompletion
+
+class GenerateShellCompletion # === GenerateShellCompletion::GenerateShellCompletion
+
+  begin
+    require 'colours'
+    include Colours
+  rescue LoadError; end
+
+  require 'opn'
+  require 'save_file/module'
+
+  N = "\n"
+
+  # ========================================================================= #
+  # === STORE_HERE
+  # ========================================================================= #
+  STORE_HERE = 'completion.sh' # Default.
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # _ = GenerateShellCompletion.new(, :dont_run_yet)
+  # ========================================================================= #
+  def initialize(
+      i           = STORE_HERE,
+      run_already = true
+    )
+    reset
+    set_store_where(i)
+    if run_already.to_s.include? 'dont'
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    @append_files_from_the_current_directory = false # Default.
+    @prepend_this = nil
+    set_name_of_the_shell_function 'completion_for_ry' # Default name.
+    set_dataset
+    set_aliases
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  #
+  # Here comes in your array.
+  # ========================================================================= #
+  def set_dataset(i = %w( abc def ghi ))
+    i = i.flatten if i.is_a? Array
+    @data = i
+  end
+
+  # ========================================================================= #
+  # === set_name_of_the_shell_function
+  #
+  # Set the name of the shell function here.
+  # ========================================================================= #
+  def set_name_of_the_shell_function(i)
+    @name_of_the_shell_function = i
+  end
+
+  # ========================================================================= #
+  # === set_store_where
+  # ========================================================================= #
+  def set_store_where(i = '/Depot/Temp/completion.sh')
+    i = i.first if i.is_a? Array
+    i = STORE_HERE if i.nil?
+    i = i.to_s.dup if i
+    @store_where = i
+  end; alias set_name    set_store_where # === set_name
+       alias store_here  set_store_where # === store_here
+       alias store_here= set_store_where # === store_here?
+
+  # ========================================================================= #
+  # === store_where
+  # ========================================================================= #
+  def store_where?
+    @store_where
+  end; alias store_here? store_where? # === store_here?
+
+  # ========================================================================= #
+  # === remove_old_file
+  # ========================================================================= #
+  def remove_old_file
+    File.delete(@store_where) if File.exist? @store_where
+  end
+
+  # ========================================================================= #
+  # === return_full_time
+  #
+  # Will return something like:
+  #   ", at 20:51:53 o'clock."
+  # ========================================================================= #
+  def return_full_time
+    Time.now.strftime('%d.%m.%Y')+', at '+Time.now.strftime('%H:%M:%S')+" o'clock."
+  end
+
+  # ========================================================================= #
+  # === liner
+  # ========================================================================= #
+  def liner(i = :add_newline)
+    _ = '# '+('=' * 76)+' #'
+    _ << N if i == :add_newline
+    return _
+  end
+
+  # ========================================================================= #
+  # === name_of_the_shell_function?
+  # ========================================================================= #
+  def name_of_the_shell_function?
+    @name_of_the_shell_function
+  end
+
+  # ========================================================================= #
+  # === append_files_from_the_current_directory
+  #
+  # When this instance variable is set to true, we will always append
+  # the files found in the current working directory to the available
+  # tab-completable options.
+  # ========================================================================= #
+  def append_files_from_the_current_directory
+    @append_files_from_the_current_directory = true
+  end; alias use_files_in_directory_as_well append_files_from_the_current_directory
+
+  # ========================================================================= #
+  # === append_files_from_the_current_directory?
+  # ========================================================================= #
+  def append_files_from_the_current_directory?
+    @append_files_from_the_current_directory
+  end
+
+  # ========================================================================= #
+  # === add_names_for_how_to_invoke_the_completions
+  #
+  # Here come the names for the complete functionality. This
+  # will be invoked in run().
+  # ========================================================================= #
+  def add_names_for_how_to_invoke_the_completions
+    _ = ' # Next, available auto-completion for the commands '+
+        '"ry", "wis" and "url".'+N
+    @aliases.each {|entry|
+      _ << 'complete -F '+name_of_the_shell_function?+' '+entry+N
+    } if @aliases
+    return _
+  end
+
+  # ========================================================================= #
+  # === set_aliases
+  # ========================================================================= #
+  def set_aliases(i = nil)
+    if i.is_a? String
+      i = i.split(',') if i.include? ','
+    end
+    i = [i] unless i.is_a? Array
+    i = i.flatten if i.is_a? Array
+    @aliases = i # Must be an Array or nil.
+  end; alias set_alias set_aliases # === set_alias
+
+  # ========================================================================= #
+  # === inform_the_user_what_we_will_do
+  # ========================================================================= #
+  def inform_the_user_what_we_will_do
+    opn; e 'Now generating the shell script'
+    e
+    e '  `'+sfile(store_where?)+'`'
+    e
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @data
+  end
+
+  # ========================================================================= #
+  # === prepend_this_string
+  #
+  # This method can be used to prepend something on top of the file.
+  # Specifically, this is used for generation tab-completion for the
+  # zsh shell.
+  # ========================================================================= #
+  def prepend_this_string(i)
+    @prepend_this = i
+  end
+
+  # ========================================================================= #
+  # === save_dataset
+  #
+  # Use this method to save the file.
+  # ========================================================================= #
+  def save_dataset(i)
+    SaveFile.save_what_into(i, store_where?)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    inform_the_user_what_we_will_do
+    array = dataset?
+    _ = ''.dup
+    _ << @prepend_this if @prepend_this
+    _ << liner+'# Automatically generated file, generated at '+return_full_time+N+
+         liner+'# A bash shell script.'+N+liner
+    _ << ''+name_of_the_shell_function?+'()
+{
+  local cur prev all_programs
+
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  all_programs="
+    '+array.join(N+'   ')+'
+  "
+'
+    # ======================================================================= #
+    # Whether to append files from the current directory or not:
+    # ======================================================================= #
+    if append_files_from_the_current_directory?
+      _ << '  append_this=`ls`
+  all_programs+=$append_this
+'
+    end
+    _ << '
+  if [[ ${cur} == * ]] ; then
+    COMPREPLY=( $(compgen -W "${all_programs}" -- ${cur}) )
+    return 0
+  fi
+}'
+    _ << add_names_for_how_to_invoke_the_completions
+    save_dataset(_)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = GenerateShellCompletion::GenerateShellCompletion.new(ARGV, :dont_run_yet)
+  _.set_name_of_the_shell_function 'beautiful_menu'
+  _.set_aliases 'rf'
+  _.run
+end # generate_shell_completion

data/lib/generate_shell_completion/version/version.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module GenerateShellCompletion
+
+class GenerateShellCompletion
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.0.16'
+
+end; end

data/lib/generate_shell_completion.rb

@@ -0,0 +1 @@
+require 'generate_shell_completion/generate_shell_completion.rb'

data/test/testing_generate_shell_completion.rb

@@ -0,0 +1,19 @@
+require 'generate_shell_completion'
+
+_ = GenerateShellCompletion::GenerateShellCompletion.new(nil,
+      :dont_run_yet)
+array = %w(
+  --help
+  --norc
+  --extract
+  --version
+  --nocolours
+  --nohistory
+  --run-method
+)
+array = array + array.map {|entry| entry.delete('-') }
+_.set_name_of_the_shell_function('diamond_shell_completion')
+_.set_dataset(array)
+_.set_alias('dia')
+_.store_here = '/Depot/Temp/completion_for_diamond_shell.sh'
+_.run

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: generate_shell_completion
+version: !ruby/object:Gem::Version
+  version: 0.0.16
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: save_file
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2+
+
+      This library is called generate_shell_completion.
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- USAGE.md
+- generate_shell_completion.gemspec
+- lib/generate_shell_completion.rb
+- lib/generate_shell_completion/generate_shell_completion.rb
+- lib/generate_shell_completion/version/version.rb
+- test/testing_generate_shell_completion.rb
+homepage: https://rubygems.org/gems/generate_shell_completion
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.24
+requirements: []
+rubygems_version: 3.2.24
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []
+...