find_line_in_file 1.0.18

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bd4460bc1c1920abb9e440f39c623c889aeef5ec3552a22660c6e07d1f575ce
+  data.tar.gz: 7a68f891f687c905a06cb5b74aa790f8fa6cba533834d75478df78a8759c5c51
+SHA512:
+  metadata.gz: bec228d68af758d1f494e60049d67717f497b55bbfb2e264976ccdc4f341849067e4ccf808af7c2bab48863f46d3e0e120519a56df9772cf8deca9bfece6f028
+  data.tar.gz: f8398fc4b662b96ffac95b22203f7b422c2bb4b29c22a0f02324346b71c2b808fc247c6690e7d3706489760c5fd3f9b4272c837c0f867a1da021897bc2ac969d

data/find_line_in_file.gemspec

@@ -0,0 +1,57 @@
+# =========================================================================== #
+# Gemspec for Project FindLineInFile.
+# =========================================================================== #
+require 'find_line_in_file/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name        = 'find_line_in_file'
+  s.version     = FindLineInFile::VERSION
+  s.date        = Time.now.strftime('%Y-%m-%d')
+
+  s.summary = <<-EOF
+
+    This small class simply gives you the first line
+    found if you need to search a file for the occurance
+    of a given line.
+
+    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 small class simply gives you the first line
+    found if you need to search a file for the occurance
+    of a given line.
+
+    This library is called find_line_in_file.
+
+    To use it, do something like:
+
+      FindLineInFile[]
+
+  EOF
+  
+  s.extra_rdoc_files = %w()
+  
+  s.authors     = ['Robert A. Heiler']
+  s.email       = 'shevegen@gmail.com'
+  s.files       = Dir['**/*']
+  s.license     = 'GPL-2.0'
+  s.homepage    = 'http://rubygems.org/gems/find_line_in_file'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  s.add_dependency 'colours'
+  s.add_dependency 'cliner'
+  s.add_dependency 'opn'
+
+}

data/lib/find_line_in_file.rb

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

data/lib/find_line_in_file/class_methods.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'find_line_in_file/class_methods.rb'
+# FindLineInFile.find[search_term: 'foo', where: '/this/file.rb']
+# =========================================================================== #
+class FindLineInFile
+
+  # ========================================================================= #
+  # === FindLineInFile.find
+  #
+  # The first argument to this method should be the search string in
+  # question, that is, the line you want to find exactly.
+  #
+  # The second argument should ideally be a Hash but it can also be a
+  # String, hence the check below in the method body. It will tell
+  # us the file location.
+  #
+  # If the line has been found then this method will return an Integer
+  # number, aka the fileline - starting at line number 1. (There is,
+  # logically, no line number called 0, hence why the code here behaves
+  # in that way.)
+  #
+  # Usage examples:
+  #
+  #   FindLineInFile.find(search_term, :in => 'test.txt')
+  #   FindLineInFile[search_term: 'foo', where: '/this/file.rb']
+  #
+  # ========================================================================= #
+  def self.find(
+      search_term, where = ''
+    )
+    if search_term.is_a? Hash
+      # ===================================================================== #
+      # === :where
+      # ===================================================================== #
+      if search_term.has_key? :where
+        if where.is_a?(String) and where.empty?
+          where = search_term.delete(:where)
+        end
+      end
+      # ===================================================================== #
+      # === :what
+      # ===================================================================== #
+      if search_term.has_key? :what
+        if search_term.has_key? :in
+          where = search_term.delete :in
+        elsif search_term.has_key? :where
+          where = search_term.delete :where
+        end
+        search_term = search_term.delete :what
+      end
+      # ===================================================================== #
+      # === :search_term
+      #
+      # This should come last.
+      # ===================================================================== #
+      if search_term.has_key? :search_term
+        search_term = search_term.delete(:search_term)
+      end
+    end
+    if where.is_a? Hash
+      if where.has_key? :in
+        where = where.delete :in
+      elsif where.has_key? :where
+        where = where.delete :where
+      end
+    elsif where.is_a? String # Handle given Strings next.
+      where = where.to_s.dup
+    end
+    # ======================================================================= #
+    # `where` may still be a Hash at this point, so
+    # we convert it into a string.
+    # ======================================================================= #
+    if where.is_a? Hash and where.empty?
+      where = ''
+    end
+    _ = FindLineInFile.new(search_term, where)
+    return _.result # We will return a Fixnum here, or nil otherwise.
+  end; self.instance_eval { alias [] find } # === FindLineInFile[]
+
+end

data/lib/find_line_in_file/constants.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'find_line_in_file/constants.rb'
+# =========================================================================== #
+class FindLineInFile
+
+  # ========================================================================= #
+  # === DEFAULT_FILE
+  # ========================================================================= #
+  DEFAULT_FILE =
+    '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/'\
+    'find_line_in_file/test/testing_find_line_in_file.rb'
+
+  # ========================================================================= #
+  # === THIS_LINE
+  # ========================================================================= #
+  THIS_LINE = ''
+
+  # ========================================================================= #
+  # === NAME
+  # ========================================================================= #
+  NAME = 'FindLineInFile: '
+
+  # ========================================================================= #
+  # === ENCODING_ISO
+  # ========================================================================= #
+  ENCODING_ISO = 'ISO-8859-1'
+
+  # ========================================================================= #
+  # === ENCODING_UTF
+  # ========================================================================= #
+  ENCODING_UTF = 'UTF-8'
+
+  # ========================================================================= #
+  # === USE_THIS_ENCODING
+  #
+  # The class will default to UTF-8, unless specified otherwise. Thus,
+  # this is the default encoding to be used.
+  # ========================================================================= #
+  USE_THIS_ENCODING = ENCODING_UTF
+
+  # ========================================================================= #
+  # === MAIN_ENCODING
+  # ========================================================================= #
+  MAIN_ENCODING = USE_THIS_ENCODING
+
+end

data/lib/find_line_in_file/find_line_in_file.rb

@@ -0,0 +1,254 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === FindLineInFile
+#
+# The purpose of the class in this file is to find a specific line
+# in a given file.
+#
+# If this file exists, then we will return a single integer
+# which will denote the file number that contains our
+# substring in question (starting at line number 1).
+#
+# Specific usage examples:
+#
+#   require 'find_line_in_file'
+#   FindLineInFile.new
+#   FindLineInFile.new('include Colours')
+#   FindLineInFile.new('include Colours', 'att.rb')
+#   FindLineInFile['run_everything', '/Users/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/tools/to_png.rb']
+#
+# Here is a slightly more complex usage example of FindLineInFile:
+#
+#   FindLineInFile[ what: 'run_everything', where: '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/tools/to_png.rb']
+#
+# =========================================================================== #
+# require 'find_line_in_file'; FindLineInFile.new
+# =========================================================================== #
+require 'colours'
+require 'cliner'
+require 'opn'
+require 'find_line_in_file/class_methods.rb'
+require 'find_line_in_file/constants.rb'
+require 'find_line_in_file/version/version.rb'
+
+class FindLineInFile # === FindLineInFile
+
+  include Colours::E
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      search_for_this_line = nil,
+      search_in_this_file  = nil,
+      run_already          = true
+    )
+    reset
+    # ======================================================================= #
+    # The second one has to come first, because the first argument may
+    # sometimes be a Hash. If it is a Hash then it may overrule the @file
+    # variable, so that is why the order is reverse.
+    # ======================================================================= #
+    set_search_in_this_file(
+      search_in_this_file  # This file is grepped.
+    )
+    set_search_for_this_line(
+      search_for_this_line # This line is sought.
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @data
+    # ======================================================================= #
+    @data   = nil
+    # ======================================================================= #
+    # === @result
+    # ======================================================================= #
+    @result = nil
+    # ======================================================================= #
+    # === @can_we_continue
+    # ======================================================================= #
+    @can_we_continue = true
+    # ======================================================================= #
+    # === @use_this_encoding
+    # ======================================================================= #
+    @use_this_encoding = USE_THIS_ENCODING
+  end
+
+  # ========================================================================= #
+  # === search_for_which_file?
+  # ========================================================================= #
+  def search_for_which_file?
+    @search_for_this_file
+  end; alias file? search_for_which_file? # === file? 
+
+  # ========================================================================= #
+  # === clear_dataset
+  # ========================================================================= #
+  def clear_dataset # No more need for @data to contain anything.
+    @data = nil; remove_instance_variable(:@data)
+  end
+
+  # ========================================================================= #
+  # === can_we_continue?
+  # ========================================================================= #
+  def can_we_continue?
+    @can_we_continue
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i)
+    ::Colours.sfile(i)
+  end
+
+  # ========================================================================= #
+  # === ewarn
+  # ========================================================================= #
+  def ewarn(i)
+    ::Colours.ewarn(i)
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i)
+    ::Colours.simp(i)
+  end
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(i)
+    ::Colours.swarn(i)
+  end
+
+  # ========================================================================= #
+  # === report_result
+  #
+  # We only report if we have found something.
+  # ========================================================================= #
+  def report_result
+    if can_we_continue?
+      opn; e "We will try to find something in "\
+             "#{sfile(search_for_which_file?)} now."
+      opn; e 'The variable @result (of class '+@result.class.to_s+') '+
+             'is: '+simp(@result.to_s)
+    end
+  end; alias report report_result # === report
+
+  # ========================================================================= #
+  # === read_in_dataset
+  #
+  # This here makes use of File.readlines(), so the Encoding must be
+  # checked.
+  # ========================================================================= #
+  def read_in_dataset
+    @data = File.readlines(
+      search_for_which_file?,
+      encoding: @use_this_encoding # We must specify our default encoding to use.
+    )
+  end
+
+  # ========================================================================= #
+  # === number?
+  # ========================================================================= #
+  def number?
+    @result
+  end; alias line_number? number? # === line_number?
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @result
+  end; alias result result? # === result
+
+  # ========================================================================= #
+  # === set_search_in_this_file
+  # ========================================================================= #
+  def set_search_in_this_file(i = nil)
+    i = DEFAULT_FILE if i.nil?
+    i = i.first if i.is_a? Array
+    @search_for_this_file = i
+  end; alias set_this_file set_search_in_this_file # === set_this_file
+       alias use_this_file set_search_in_this_file # === use_this_file
+
+  # ========================================================================= #
+  # === set_search_for_this_line
+  # ========================================================================= #
+  def set_search_for_this_line(i = nil)
+    i = THIS_LINE if i.nil?
+    if i.is_a? Hash
+      if i.has_key? :this_file
+        set_this_file(i.delete(:this_file))
+      end
+      if i.has_key? :this_line
+        i = i.delete(:this_line)
+      end
+    end
+    i = i.to_s
+    @search_for_this_line = i
+  end; alias search_for set_search_for_this_line # === search_for
+
+  # ========================================================================= #
+  # === check_whether_the_file_exists
+  #
+  # We find out whether our target file exists or whether it does not.
+  # ========================================================================= #
+  def check_whether_the_file_exists
+    search_for_this_file = search_for_which_file?
+    unless File.exist? search_for_this_file
+      opn; ewarn 'The file `'+sfile(search_for_this_file)+
+           swarn('` does not exist.')
+      @can_we_continue = false
+    end
+  end
+
+  # ========================================================================= #
+  # === find_input_in_dataset
+  # ========================================================================= #
+  def find_input_in_dataset
+    # ======================================================================= #
+    # Must add +1 because files start at 1, whereas Arrays start at entry 0.
+    # ======================================================================= #
+    @result = @data.find_index {|entry|
+      entry.include? @search_for_this_line.to_s
+    }
+    if @result
+      @result += 1
+    else
+      opn; e "We may have not found anything for: `#{@search_for_this_line}`"
+      pp @search_for_this_line
+      opn; e 'Its encoding was: '+
+             simp(@search_for_this_line.to_s.encoding.to_s)
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_whether_the_file_exists
+    if can_we_continue?
+      read_in_dataset
+      find_input_in_dataset
+      clear_dataset
+      return @result
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = FindLineInFile.new(ARGV.first, ARGV[1])
+  _.report_result
+end # find_line_in_file

data/lib/find_line_in_file/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class FindLineInFile
+
+  # ========================================================================= #
+  # === FindLineInFile::VERSION
+  # ========================================================================= #
+  VERSION = '1.0.18'
+
+  # ========================================================================= #
+  # === FindLineInFile::LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '28.02.2020'
+
+end

data/test/testing_find_line_in_file.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/autoinclude'
+require 'find_line_in_file'
+
+INCLUDE_COLOUR_E = 'include Colours'
+
+file = '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/diamond_shell/lib/diamond_shell/standalone_classes/aliases.rb'
+line = INCLUDE_COLOUR_E
+
+p FindLineInFile[
+  what:  INCLUDE_COLOUR_E,
+  where: file
+]
+FindLineInFile.new
+FindLineInFile.new(INCLUDE_COLOUR_E)
+FindLineInFile.new(INCLUDE_COLOUR_E, file).report
+FindLineInFile.new(INCLUDE_COLOUR_E, file).report
+FindLineInFile['run_everything',
+  '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/tools/to_png.rb']
+
+find_line_in_file = FindLineInFile.new(
+  this_file: file,
+  this_line: line
+)
+pp find_line_in_file

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: find_line_in_file
+version: !ruby/object:Gem::Version
+  version: 1.0.18
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-28 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: cliner
+  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 small class simply gives you the first line
+      found if you need to search a file for the occurance
+      of a given line.
+
+      This library is called find_line_in_file.
+
+      To use it, do something like:
+
+        FindLineInFile[]
+
+email: shevegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- find_line_in_file.gemspec
+- lib/find_line_in_file.rb
+- lib/find_line_in_file/class_methods.rb
+- lib/find_line_in_file/constants.rb
+- lib/find_line_in_file/find_line_in_file.rb
+- lib/find_line_in_file/version/version.rb
+- test/testing_find_line_in_file.rb
+homepage: http://rubygems.org/gems/find_line_in_file
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: 'This small class simply gives you the first line found if you need to search
+  a file for the occurance of a given line.  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: []