case_parser 1.0.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eb3ac4e3e0ab334bd4467876c3b3bcb7863b4ebac5c32628664b2ef21adcb89
+  data.tar.gz: 274280302860ccfe7f44f36da4c503ed5d2479091b017ea643d57f1fed27ff48
+SHA512:
+  metadata.gz: 4effea98ea2b44eae22d93898e5b9c5e268c813b70deb595fb65a493069602a59cf9260f8c6b346e298c8a6b9c221e651d7a9ac42b7fb1b7b36fefdeacd143a8
+  data.tar.gz: 3ed735cb4369bab8ef903c3808f0c93baf5b8f7bfcc1d2c6fdc6a777df21193229cc89d4698f10a71c3472c30a733d9c8c8c4062006baf4fad91a9659dd5e0b0

data/case_parser.gemspec

@@ -0,0 +1,52 @@
+# =========================================================================== #
+# Gemspec for Project CaseParser.
+# =========================================================================== #
+require 'case_parser'
+
+Gem::Specification.new { |s|
+
+  s.name      = 'case_parser'
+  s.version   = CaseParser::VERSION
+  s.date      = Time.now.strftime('%Y-%m-%d')
+  
+  s.summary = <<-EOF
+
+    It will try to parse a case/when menu from a given
+    .rb file and then give back an Array of all entries
+    found after the first occurance of when.
+
+    If you have specific suggestions to make this gem more
+    useful for others, please drop me an email at:
+
+      shevegen@gmail.com
+
+    Thank you.
+
+  EOF
+  
+  s.description = <<-EOF
+
+    This library is called case_parser.
+
+    It will try to parse a case/when menu from a given
+    .rb file and then give back an Array of all entries
+    found after the first occurance of when.
+
+  EOF
+
+  s.extra_rdoc_files = %w()
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = 'shevegen@gmail.com'
+  s.files    = Dir.glob('**/*')
+  s.license  = 'GPL-2.0'
+  s.homepage = 'http://rubygems.org/gems/case_parser'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+
+}

data/lib/case_parser.rb

@@ -0,0 +1 @@
+require 'case_parser/class_methods.rb'

data/lib/case_parser/case_parser.rb

@@ -0,0 +1,291 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === CaseParser
+#
+# This class will scan a file and extract all case entries.
+#
+# For now though, we will work only on the first case menu.
+# =========================================================================== #
+# require 'case_parser.rb'
+# =========================================================================== #
+require 'case_parser/version/version.rb'
+
+class CaseParser # CaseParser.new
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  begin
+    require 'convert_global_env'
+  rescue LoadError; end
+
+  begin
+    require 'colours'
+    include Colours
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === USE_THIS_ENCODING
+  # ========================================================================= #
+  USE_THIS_ENCODING = 'UTF-8' # 'ISO-8859-1'
+
+  # ========================================================================= #
+  # Test it via compile.rb.
+  # ========================================================================= #
+  DEFAULT_FILE =
+    "#{ENV['RBT']}/compile.rb"
+  # DEFAULT_FILE = '/Depot/jjj/testcase.rb'
+
+  # ========================================================================== #
+  # === SHALL_WE_DEBUG
+  # ========================================================================== #
+  SHALL_WE_DEBUG = false
+
+  # ========================================================================== #
+  # === initialize
+  # ========================================================================== #
+  def initialize(
+      i           = DEFAULT_FILE,
+      run_already = true
+    )
+    reset
+    case run_already
+    when :continue,
+         :do_not_exit
+      @may_we_exit_on_missing_file = false
+      run_already = true
+    end
+    run(i) if run_already
+  end
+
+  # ========================================================================== #
+  # === set_file
+  #
+  # Simply set the @file variable here.
+  # ========================================================================== #
+  def set_file(i)
+    i = DEFAULT_FILE if i.nil?
+    case i
+    # ======================================================================== #
+    # === :beautiful_menu
+    # ======================================================================== #
+    when :beautiful_menu
+      i = ConvertGlobalEnv[
+        '$RUBY_SRC/beautiful_url/lib/beautiful_url/toplevel_methods/menu.rb'
+      ] # Hardcoded.
+      unless File.exist? i
+        opn; e 'Warning - no file exists at `'+sfile(i)+'`.'
+      end
+    when :dia_menu
+      i = ConvertGlobalEnv['$RUBY_SRC/diamond_shell/lib/diamond_shell/menu/menu.rb']
+      unless File.exist? i
+        opn; e 'Warning - no file exists at `'+sfile(i)+'`.'
+      end
+    end
+    i = i.to_s unless i.is_a? String
+    i = ConvertGlobalEnv.convert(i) if i.include? '$'
+    @file = i
+  end
+
+  # ========================================================================== #
+  # === reset  
+  # ========================================================================== #
+  def reset
+    # ======================================================================== #
+    # === @dataset
+    # ======================================================================== #
+    @dataset = nil
+    # ======================================================================== #
+    # === @seen_case
+    #
+    # Whether we saw "case" yet or did not.
+    # ======================================================================== #
+    @seen_case = false
+    # ======================================================================== #
+    # === @array_keeping_all_when_entries
+    # ======================================================================== #
+    @array_keeping_all_when_entries = []
+    # ======================================================================== #
+    # === @shall_we_debug
+    #
+    # If true then we will debug.
+    # ======================================================================== #
+    @shall_we_debug = SHALL_WE_DEBUG
+    # ======================================================================== #
+    # === @may_we_exit_on_missing_file
+    # ======================================================================== #
+    @may_we_exit_on_missing_file = true
+  end
+
+  # ========================================================================== #
+  # === feedback
+  # ========================================================================== #
+  def feedback
+    opn; pp results
+  end
+
+  # ========================================================================== #
+  # === sanitize_array
+  #
+  # This will try to sanitize the array.
+  # ========================================================================== #
+  def sanitize_array
+    @array_keeping_all_when_entries.flatten!
+    begin # Musct rescue this in case the encoding is bad.
+      @array_keeping_all_when_entries.map! {|entry|
+        entry.delete("'").strip
+      }
+    rescue; end
+    # ======================================================================== #
+    # Now, we remove all Regexes from this menu, because Regexes
+    # are not really useful to keep for tab completion in most
+    # scripts.
+    # ======================================================================== #
+    @array_keeping_all_when_entries.reject! {|entry|
+      entry.start_with? '/' or
+      entry.start_with? ':' # Symbols also get rejected.
+    }
+  end
+
+  # ========================================================================== #
+  # === remove_potential_comments
+  #
+  # This gets rid of potential '#' comments.
+  # ========================================================================== #
+  def remove_potential_comments(i)
+    i = i[0, i.index('#')].strip if i.include? '#' # If there is a #, return all up to that.
+    return i
+  end
+
+  # ========================================================================== #
+  # === red
+  # ========================================================================== #
+  def red
+    Colours::RED
+  end
+
+  # ========================================================================== #
+  # === read_file
+  # ========================================================================== #
+  def read_file
+    if File.exist? @file
+      @dataset = File.readlines(@file, encoding: USE_THIS_ENCODING)
+    else
+      if @may_we_exit_on_missing_file
+        opn; e red+'Can not continue. File `'+sfile(@file)+
+               red+'` does not exist.'+rev
+        exit
+      end
+    end
+    if @shall_we_debug
+      opn; pp dataset?
+    end
+  end
+
+  # ========================================================================== #
+  # === report_n_entries
+  # ========================================================================== #
+  def report_n_entries
+    opn; e "We found #{simp(dataset?.size.to_s)} entries."
+  end
+
+  # ========================================================================== #
+  # === results
+  # ========================================================================== #
+  def results
+    _ = @array_keeping_all_when_entries
+    _.sort! if _
+    _
+  end
+
+  # ========================================================================== #
+  # === extract_first_when
+  #
+  # Use this method here if you wish to extract the first word.
+  # ========================================================================== #
+  def extract_first_when(
+      mode = :extract_only_first_entry
+    )
+    dataset?.each { |d|
+      if d.include? 'when' # Work on when-entries only. This is not perfect, as we miss other entries.
+        begin
+          _ = d.chomp.strip.gsub(/when /,'') # Eliminate 'when ' here.
+        rescue ArgumentError
+          opn; e 'ArgumentError - invalid byte sequence in US-ASCII'
+        end
+        if _
+          _ = _.split(',') if _.include? ',' # Split on ',' if they exist.
+          _ = _.delete("'") if _.include? "'" # Eliminate "'" characters.
+          append_to_main_array(_)
+        end
+      end
+    }
+  end
+
+  # ========================================================================== #
+  # === extract_case_menu
+  #
+  # This method will extract the case menu.
+  # ========================================================================== #
+  def extract_case_menu
+    _ = []
+    dataset?.each {|line|
+      begin
+        @seen_case = true if line.include? 'case'
+        _ << remove_potential_comments(line) if @seen_case
+        @seen_case = false if line =~ /end$/
+      rescue ArgumentError # This is here to rescue against "invalid byte sequence in US-ASCII"
+      end
+    } if dataset?
+    _.reject!(&:empty?)
+    @dataset = _
+  end
+
+  # ========================================================================== #
+  # === append_to_main_array
+  # ========================================================================== #
+  def append_to_main_array(i)
+    @array_keeping_all_when_entries << i
+  end
+
+  # ========================================================================== #
+  # === dataset?
+  # ========================================================================== #
+  def dataset?
+    @dataset
+  end
+
+  # ========================================================================== #
+  # === found_entries?
+  #
+  # We return all entries found in a sorted manner here.
+  # ========================================================================== #
+  def found_entries?
+    @array_keeping_all_when_entries.sort
+  end
+
+  # ========================================================================== #
+  # === run
+  #
+  # General run method. We will also set_file() in this method.
+  # ========================================================================== #
+  def run(which_file)
+    set_file(which_file)
+    read_file
+    extract_case_menu
+    extract_first_when
+    sanitize_array
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = CaseParser.new(ARGV.first)
+  _.feedback
+  _.report_n_entries
+end # cparse
+    # cparse $RUBY_SRC/beautiful_url/lib/beautiful_url/menu/beautiful_menu.rb
+    # 

data/lib/case_parser/class_methods.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'case_parser/case_parser.rb'
+
+class CaseParser
+
+  # ========================================================================== #
+  # === CaseParser.parse
+  #
+  # This method will return a (sorted) array.
+  #
+  # To use this, do something like:
+  #
+  #   CaseParser.parse(__FILE__)
+  # 
+  # ========================================================================== #
+  def self.parse(i, optional_run_already = :do_not_exit)
+    return CaseParser.new(i, optional_run_already).results
+  end; self.instance_eval { alias []           parse } # === CaseParser[]
+       self.instance_eval { alias return_array parse } # === CaseParser.return_array
+
+end

data/lib/case_parser/version/version.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class CaseParser
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.0.17'
+
+end

data/test/testing_case_parser.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+require 'pp'
+require 'colours/autoinclude'
+require 'case_parser'
+e 'We will now test class CaseParser'
+menu = '$RUBY_SRC/beautiful_url/lib/beautiful_url/menu/beautiful_menu.rb'
+case_parser = CaseParser.new(menu)
+pp case_parser
+cliner
+e 'The found entries were:'
+pp case_parser.found_entries?
+cliner
+pp CaseParser.return_array(menu)
+cliner
+array = CaseParser.return_array(:beautiful_menu)
+e 'The array has '+sfancy(array.size.to_s)+' elements.'
+array = CaseParser.return_array(:dia_menu)
+e 'The array has '+sfancy(array.size.to_s)+' elements.'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: case_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.17
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-19 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: opn
+  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 case_parser.
+
+      It will try to parse a case/when menu from a given
+      .rb file and then give back an Array of all entries
+      found after the first occurance of when.
+
+email: shevegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- case_parser.gemspec
+- lib/case_parser.rb
+- lib/case_parser/case_parser.rb
+- lib/case_parser/class_methods.rb
+- lib/case_parser/version/version.rb
+- test/testing_case_parser.rb
+homepage: http://rubygems.org/gems/case_parser
+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.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.1
+requirements: []
+rubygems_version: 3.2.1
+signing_key: 
+specification_version: 4
+summary: 'It will try to parse a case/when menu from a given .rb file and then give
+  back an Array of all entries found after the first occurance of when.  If you have
+  specific suggestions to make this gem more useful for others, please drop me an
+  email at:  shevegen@gmail.com  Thank you.'
+test_files: []