cliner 1.0.33

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e0b4d55ee5124b9949be326d7f0ee90a43452403704e94038a76164bef0dad5
+  data.tar.gz: 2e72d6ced8308d32cce443734ac1a50e9582d59807339b554f32dd2c4d4ca6e2
+SHA512:
+  metadata.gz: a7b4515c3e489b999845d795c71c1102a7ad91f680b11a1874e410f878db75d5ed5bc64616d35c302ab3b1c35b98d8d481731b2e26d42ef96489bd019d737dc2
+  data.tar.gz: 8045f631e8561fa5b9d5154e11939bd4af5cf4b47672dc13cfc7f2a29f0401d0ef4329ebddbafadd2d496919335a04a4422466cba7f159e46d4f879eb2ef0605

data/README.md

@@ -0,0 +1,18 @@
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](https://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/cliner.svg)](https://badge.fury.io/rb/cliner)
+
+## The cliner project
+
+This project is really small - it will just display a horizontal line.
+
+The primary use case is to display this line for commandline applications.
+
+This line can be colourized. You can also show the current time format,
+e. g. in hh:mm:ss format.
+
+Examples:
+
+    Cliner.cliner :show_time
+    string = Cliner.cliner :show_time, :default, :default, :return_as_string
+

data/bin/cliner

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'cliner/module.rb'
+
+Cliner[]

data/cliner.gemspec

@@ -0,0 +1,46 @@
+# =========================================================================== #
+# Gemspec for Project Cliner.
+# =========================================================================== #
+require 'cliner/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name      = 'cliner'
+  s.version   = Cliner::VERSION
+  s.date      = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This small gem just provides one method called
+cliner.
+
+cliner means "colourized liner", and it basically
+only makes a coloured line. Yes, that's it. :D
+
+May not seem useful for anyone else at all, but
+I found that I often need to use it. Use cases
+include passing in a Hash such as via:
+
+  cliner token: 'X'
+
+For more documentation please see the homepage
+of this gem.
+
+EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+  s.homepage = 'https://rubygems.org/gems/cliner'
+  s.licenses = 'MIT'
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

data/doc/README.gen

@@ -0,0 +1,16 @@
+ADD_RUBY_BADGE
+
+## The cliner project
+
+This project is really small - it will just display a horizontal line.
+
+The primary use case is to display this line for commandline applications.
+
+This line can be colourized. You can also show the current time format,
+e. g. in hh:mm:ss format.
+
+Examples:
+
+    Cliner.cliner :show_time
+    string = Cliner.cliner :show_time, :default, :default, :return_as_string
+

data/lib/cliner/autoinclude.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'cliner/module.rb' # Pull in the main Cliner-module here.
+
+include Cliner

data/lib/cliner/cliner.rb

@@ -0,0 +1,228 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cliner
+
+  require 'cliner/colours.rb'
+  require 'cliner/token.rb'
+  require 'cliner/time.rb'
+
+  # ========================================================================= #
+  # === Cliner.cliner
+  #
+  # This method will output a line.
+  #
+  # The third argument is optional - we can use a specific colour with it.
+  #
+  # Usage examples:
+  #
+  #   Cliner.cliner '','',BLUE
+  #   Cliner.cliner token: 'X'
+  #   Cliner.cliner :show_time
+  #   Cliner.cliner :show_time, :default, :default, :return_as_string
+  #   Cliner.cliner colour: :green
+  #   Cliner.cliner use_colour: :dodgerblue
+  #   Cliner.cliner use_colour: :konsole_dodgerblue
+  #   Cliner.cliner(:show_time) { use_n_tokens: 30 }
+  #
+  # ========================================================================= #
+  def self.cliner(
+      which_token_to_use          = Cliner.token?,
+      how_often_to_use_that_token = :default,
+      # ===================================================================== #
+      # The following is a bit hard to understand, so let's break it down.
+      # We need to first query whether the constant Cliner is defined.
+      # If it is, we can tap into a module method, but if it is not,
+      # we have to default to nil.
+      # ===================================================================== #
+      use_colour                  = (
+        (Object.const_defined? :Cliner) ? Cliner.use_colours? : nil
+      ),
+      output_the_result           = true # <- Whether to output the result.
+    )
+    show_time = false # Default.
+    case use_colour
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      use_colour = (Object.const_defined? :Cliner) ? Cliner.use_colours? : nil
+    end
+    case output_the_result
+    when :return_as_string
+      output_the_result = false
+    end
+    case which_token_to_use
+    # ======================================================================= #
+    # === :show_time
+    # ======================================================================= #
+    when :show_time
+      which_token_to_use = Cliner.token?
+      show_time = true
+    # ======================================================================= #
+    # === :return_time
+    # ======================================================================= #
+    when :return_time
+      which_token_to_use = Cliner.token?
+      show_time = true
+      output_the_result = false
+    when :default
+      which_token_to_use = Cliner.token?
+    end
+    default_token = Cliner.token?
+    append = ''.dup
+    case how_often_to_use_that_token
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      how_often_to_use_that_token = 80
+    end
+    if how_often_to_use_that_token.to_s.empty?
+      how_often_to_use_that_token = 80
+    end
+    # ======================================================================= #
+    # === Hash input for which_token_to_use
+    #
+    # Check if we use a hash for the variable which_token_to_use next.
+    # ======================================================================= #
+    if which_token_to_use.is_a? Hash
+      # ===================================================================== #
+      # === :colour
+      # ===================================================================== #
+      if which_token_to_use.has_key? :colour
+        use_colour = which_token_to_use.delete :colour
+      elsif which_token_to_use.has_key? :colours
+        use_colour = which_token_to_use.delete :colours
+      elsif which_token_to_use.has_key? :use_colour
+        use_colour = which_token_to_use.delete :use_colour
+      end
+      # ===================================================================== #
+      # === :length
+      # ===================================================================== #
+      if which_token_to_use.has_key?    :length
+        how_often_to_use_that_token = which_token_to_use.delete(:length)
+        which_token_to_use = default_token
+      elsif which_token_to_use.has_key? :token
+        which_token_to_use = which_token_to_use[:token]
+      # ===================================================================== #
+      # === :use_this_token
+      # ===================================================================== #
+      elsif which_token_to_use.has_key? :use_this_token
+        which_token_to_use = which_token_to_use[:use_this_token]
+      else
+        which_token_to_use = Cliner.token? # Default value. Reassign it here.
+      end
+    end
+    # ======================================================================= #
+    # === Handle colours given as the first argument
+    # ======================================================================= #
+    if which_token_to_use.is_a? Symbol
+      use_colour = which_token_to_use
+      which_token_to_use = Cliner.token?
+    end
+    if which_token_to_use.to_s.empty?
+      which_token_to_use = Cliner.token?
+    end
+    how_often_to_use_that_token = how_often_to_use_that_token.to_i
+    result = ''.dup
+    case use_colour # case tag
+    when :do_not_use_colours
+      use_colour = false
+    end
+    # ======================================================================= #
+    # === Handle colours next
+    # ======================================================================= #
+    if use_colour and !use_colour.is_a?(TrueClass) # Must not be the boolean "true".
+      # ===================================================================== #
+      # === Handle symbols
+      # ===================================================================== #
+      if use_colour.is_a? Symbol # If it is a symbol, convert it.
+        if use_colour.to_s.start_with? 'konsole_' # For instance, :konsole_slateblue
+          # ================================================================= #
+          # === Handle konsole colours next
+          # ================================================================= #
+          _ = use_colour.to_s.sub(/^konsole_/,'')
+          use_colour = ::Colours.send(_.to_sym) if Object.const_defined? :Colours
+        else
+          use_colour = Colours.send(use_colour.to_sym) { :omit_end }
+        end
+      # ===================================================================== #
+      # === Is it a valid colour?
+      # ===================================================================== #
+      elsif Colours.is_a_valid_colour?(use_colour)
+        use_colour = Colours.beautiful(use_colour)
+      end
+      result = result.dup if result.frozen? # Unfreeze the String.
+      result << use_colour.to_s # Append the colour.
+      append << Colours.rev
+    end
+    if result.frozen?
+      result = result.dup
+    end
+    # ======================================================================= #
+    # Handle show_time next:
+    # ======================================================================= #
+    if show_time
+      _ = return_hhmmss
+      how_often_to_use_that_token -= (_.size + 3)
+    end
+    result << which_token_to_use * how_often_to_use_that_token # The latter must be an Integer at all times.
+    if show_time
+      # ===================================================================== #
+      # We have to pad the resulting string a little bit:
+      # ===================================================================== #
+      result[3,0] = " #{_} " 
+    end
+    result << append
+    if output_the_result
+      if respond_to? :e
+        e result
+      else
+        puts result
+      end
+    else # Else return it.
+      return result
+    end
+    if block_given?
+      yield
+      cliner(
+        which_token_to_use,
+        how_often_to_use_that_token,
+        use_colour
+      )
+    end
+  end
+
+end
+
+# =========================================================================== #
+# === cliner
+#
+# Usage examples:
+#
+#   cliner '','',BLUE
+#   cliner :token => 'X'
+#   cliner :colour => :green
+#   cliner use_colour: :dodgerblue
+#   cliner use_colour: :seagreen
+#   cliner use_colour: :konsole_dodgerblue
+#
+# =========================================================================== #
+def cliner(
+    which_token_to_use          = Cliner.token?,
+    how_often_to_use_that_token = 80,
+    use_colour                  = (
+      (Object.const_defined? :Cliner) ? Cliner.use_colours? : nil
+    ),
+    output_the_result           = true
+  )
+  Cliner.cliner(
+    which_token_to_use,
+    how_often_to_use_that_token,
+    use_colour,
+    output_the_result
+  )
+
+end

data/lib/cliner/colours.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cliner
+
+  # ========================================================================= #
+  # === @use_this_colour
+  #
+  # By default we will not use any colours.
+  # ========================================================================= #
+  @use_this_colour = nil
+
+  # ========================================================================= #
+  # === Cliner.set_colour
+  #
+  # Use this method to designate a special colour to use.
+  # ========================================================================= #
+  def self.set_colour(
+      i = 'lightblue'
+    )
+    @use_this_colour = i
+  end; self.instance_eval { alias colour= set_colour } # === Cliner.colour=
+
+  # ========================================================================= #
+  # === Cliner.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_this_colour
+  end
+
+end

data/lib/cliner/module.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# You can also assign a default colour to use, via the
+# Cliner.set_colour() method call.
+# =========================================================================== #
+# require 'cliner/module.rb'
+# =========================================================================== #
+module Cliner
+
+  require 'cliner/cliner.rb'
+  require 'cliner/colours.rb'
+  require 'cliner/token.rb'
+
+  # ========================================================================= #
+  # === Cliner.reset
+  # ========================================================================= #
+  def self.reset
+    Cliner.set_colour nil
+  end
+
+  # ========================================================================= #
+  # === Cliner[]
+  #
+  # This module-method accepts one argument, which is how many '=' we will
+  # use. By default we will show 80 '=' tokens.
+  # ========================================================================= #
+  def self.[](n_times = 80)
+    cliner(
+      ASSIGNMENT_TOKEN,
+      n_times,
+      nil,
+      false # false for "return the result".
+    )
+  end
+
+end

data/lib/cliner/time.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cliner/time.rb'
+# Cliner.return_hhmmss
+# =========================================================================== #
+module Cliner
+
+  # ========================================================================= #
+  # === Cliner.return_hhmmss
+  #
+  # This method will return hh:mm:ss, such as in "10:58:32".
+  # ========================================================================= #
+  def self.return_hhmmss
+    Time.now.strftime('%H:%M:%S')
+  end
+
+end

data/lib/cliner/token.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cliner/token.rb'
+# =========================================================================== #
+module Cliner
+
+  # ========================================================================= #
+  # === ASSIGNMENT_TOKEN
+  # ========================================================================= #
+  ASSIGNMENT_TOKEN = '='
+
+  # ========================================================================= #
+  # === Cliner.token?
+  # ========================================================================= #
+  def self.token?
+    ASSIGNMENT_TOKEN
+  end
+
+end

data/lib/cliner/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cliner
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.0.33'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '08.08.2022'
+
+end

data/lib/cliner.rb

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

data/test/testing_cliner.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'cliner/autoinclude'
+require 'colours/colours_e_autoinclude.rb'
+
+e 'Now testing the project called '+sfancy('cliner')+'.'
+cliner
+e "(1) Next we will set the colour lightblue via Cliner.colour = 'lightblue'"
+Cliner.colour = 'lightblue'
+cliner
+e '(2) The above line should be in blue. We will next restore to the'
+e 'default again via Cliner.reset'
+Cliner.reset
+cliner
+e '(3) Now testing different size-length of cliner(), or more '\
+  'accurately, cliner length: 88:'
+cliner length: 88
+
+# =========================================================================== #
+# === Testing some colours
+# =========================================================================== #
+e '(4) Now via colours (lightblue, red, cyan):'
+cliner :lightblue
+cliner :red
+cliner :cyan
+# =========================================================================== #
+# === Testing Konsole-related colours
+# =========================================================================== #
+e '(5) Now via Konsole-colours (Colours.orange then Colours.slateblue):'
+cliner colours: :konsole_orange
+cliner colours: :konsole_slateblue
+e
+
+# =========================================================================== #
+# === Testing - as token
+# =========================================================================== #
+e "(6) Now we test using the token: '-'"
+cliner token: '-'
+e
+
+e "That's it! We have finished testing this tiny project."

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: cliner
+version: !ruby/object:Gem::Version
+  version: 1.0.33
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-08 00:00:00.000000000 Z
+dependencies: []
+description: |2+
+
+  This small gem just provides one method called
+  cliner.
+
+  cliner means "colourized liner", and it basically
+  only makes a coloured line. Yes, that's it. :D
+
+  May not seem useful for anyone else at all, but
+  I found that I often need to use it. Use cases
+  include passing in a Hash such as via:
+
+    cliner token: 'X'
+
+  For more documentation please see the homepage
+  of this gem.
+
+email: shevy@inbox.lt
+executables:
+- cliner
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/cliner
+- cliner.gemspec
+- doc/README.gen
+- lib/cliner.rb
+- lib/cliner/autoinclude.rb
+- lib/cliner/cliner.rb
+- lib/cliner/colours.rb
+- lib/cliner/module.rb
+- lib/cliner/time.rb
+- lib/cliner/token.rb
+- lib/cliner/version/version.rb
+- test/testing_cliner.rb
+homepage: https://rubygems.org/gems/cliner
+licenses:
+- MIT
+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.3.18
+requirements: []
+rubygems_version: 3.3.18
+signing_key:
+specification_version: 4
+summary: 'This small gem just provides one method called cliner.  cliner means "colourized
+  liner", and it basically only makes a coloured line. Yes, that''s it. :D  May not
+  seem useful for anyone else at all, but I found that I often need to use it. Use
+  cases include passing in a Hash such as via:  cliner token: ''X''  For more documentation
+  please see the homepage of this gem.'
+test_files: []
+...