termline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8a666432b2c154e47a5a7eab4bf5000b82f757505ae7dc8d3e666f6d5e3348e
+  data.tar.gz: 474673368a2be027c630918b5e063c65d0439adf222ec541b1ecfd546c9475c1
+SHA512:
+  metadata.gz: 5498fedb4fc8b12a28da46e142a188ff0251667704e3df0b02143932ebc14f95afb91df155715a5e93208fc59fd149cf301450428e6a84c2783e69845fe77bc8
+  data.tar.gz: 8365ae2a44b6857315d9d3006d4362747094a71c8375bb32745d1a70523354bd1173d06e8fcce30779c6264c4f4503a8be356cb46749f7d3de71752bc26211bd

data/lib/termline/banner.rb

@@ -0,0 +1,50 @@
+
+module Termline 
+    module Banner 
+        def self.title title 
+            width = WIDTH - title.length - 4
+            self.line(WIDTH/8)
+            puts title.rjust(width / 2)
+            self.line(WIDTH/8)
+        end 
+
+        def self.infob *messages
+            puts(separator_pretty(:blue))
+            messages.each { |message| puts(pretty("INFO: #{ message }", :white, :blue)) }
+            puts(separator_pretty(:blue))
+        end
+    
+        def self.successb *messages
+            puts(separator_pretty(:green))
+            messages.each { |message| puts(pretty("SUCCESS: #{ message }", :black, :green)) }
+            puts(separator_pretty(:green))
+        end
+    
+        def self.warningb *messages
+            puts(separator_pretty(:yellow))
+            messages.each { |message| puts(pretty("WARNING: #{ message }", :black, :yellow)) }
+            puts(separator_pretty(:yellow))
+        end
+    
+        def self.dangerb *messages
+            puts(separator_pretty(:red))
+            messages.each { |message| puts(pretty("ERROR: #{ message }", :yellow, :red)) }
+            puts(pretty("PATH: #{ caller[0] }", :yellow, :red))
+            puts(separator_pretty(:red))
+        end
+    
+        def self.fatal *messages
+            puts(separator_pretty(:red))
+            messages.each { |message| puts("\e[5m#{pretty(message, :white, :red)}\e[0m") }
+            puts(pretty("PATH: #{ caller[0] }", :white, :red))
+            puts(separator_pretty(:red))
+        end
+
+        
+        def self.deprecation message
+            puts(separator_pretty(:red))
+            puts(pretty("DEPRECATED METHOD: #{ caller[0] }, #{ message }", :white, :red))
+            puts(separator_pretty(:red))
+        end
+    end
+end 

data/lib/termline/config.rb

@@ -0,0 +1,64 @@
+
+
+module Termline 
+    module Config 
+
+        ICONS = {
+            checkmark: "✓",
+            bullet: "•",
+            star: "★"
+        }.freeze
+    
+        # standard color palette for texts
+        COLORS = { 
+            skyblue: '96',
+            default: '38', 
+            yellow: '1;33',
+            white: '1;37', 
+            green: '32',  
+            black: '30', 
+            blue: '36', 
+            red: '31'
+        }.freeze
+    
+        # standard color palette for backgrounds
+        BG_COLORS = { 
+            default: '0', 
+            yellow: '103', 
+            white: '107', 
+            green: '42', 
+            black: '40', 
+            blue: '44',
+            red: '41'
+        }.freeze
+    
+    
+        # calculate the console width
+        # tputcols is not available on windows
+        #WIDTH = `tput cols`.to_i rescue WIDTH = 1;
+        WIDTH = begin
+            term = ENV['TERM']
+            term ? `tput cols`.to_i : 1
+        rescue
+            1
+        end
+
+        def self.colorize(text, colour = :default, bg_colour = :default)
+            colour_code = COLORS[colour]
+            bg_colour_code = BG_COLORS[bg_colour]
+            return "\e[#{bg_colour_code};#{colour_code}m#{text}\e[0m".squeeze(';')
+        end
+        
+    
+        def self.pretty(message, colour = :default, bg_colour = :default)
+            width = 1
+    
+            unless bg_colour == :default
+                width = WIDTH - message.length - 4
+                width = 1 if width.negative?
+            end
+    
+            return colorize("\ \ #{ message } #{"\ " * width}", colour, bg_colour)
+        end
+    end 
+end

data/lib/termline/list.rb

@@ -0,0 +1,17 @@
+
+module Termline 
+    module List 
+
+        def self.bullet *items
+            items.each { |item| puts(" #{Config::ICONS[:bullet]} #{ item }" )}
+        end
+    
+        def self.check *items
+            items.each { |item| puts(" #{Config::ICONS[:checkmark]} #{ item }" )}
+        end
+    
+        def self.star *items
+            items.each { |item| puts(" #{Config::ICONS[:star]} #{ item }" )}
+        end
+    end
+end 

data/lib/termline/msg.rb

@@ -0,0 +1,32 @@
+
+module Termline
+    module Msg 
+        def self.msg messages
+            puts(message)
+        end
+
+        def self.builder message, tag: 'MSG', color: :default
+            puts(Config.pretty("#{tag} #{ message }", color))
+        end
+    
+        def self.info message
+            builder(message, tag:'INFO:', color: :blue)
+        end
+
+        def self.success message
+            builder(message, tag:'SUCCESS:', color: :green)
+        end
+
+        def self.warning messages
+            messages.each { |message| puts(Config.pretty("WARNING: #{ message }", :yellow)) }
+        end
+
+        def self.danger messages
+            messages.each { |message| puts(Config.pretty("ERROR: #{ message }", :red)) }
+        end
+
+        def self.alert messages
+            messages.each { |message| puts("\e[5m#{message}\e[0m") }
+        end
+    end
+end

data/lib/termline/space.rb

@@ -0,0 +1,17 @@
+
+module Termline 
+    module Space 
+
+        def self.br count=1
+            puts("\n" * count);
+        end 
+    
+        def self.line count=8
+            puts('-·-     ' * count)
+        end
+
+        def self.color color
+            Config.pretty("", :black, color)
+        end
+    end
+end

data/lib/termline/table.rb

@@ -0,0 +1,61 @@
+
+module Termline 
+    module Table 
+        def self.simple data, header:true
+
+            return if Gem.win_platform?
+            return unless data.size > 0
+
+            if data.class.name == "ActiveRecord::Relation"
+                data = data.to_a.map(&:serializable_hash) 
+            end
+
+            # get the available characters in terminal width
+            #terminal_width = `tput cols`.to_i
+            terminal_width = Config::WIDTH
+
+            # get the number of columns to print base on the data hash
+
+            pp "--------------------------"
+            pp "--------------------------"
+            header = false if data.first.class == Array
+            pp "--------------------------"
+            pp "--------------------------"
+
+            cols = data.first.length + 1
+
+            # get the available space for every column
+            col_width = (terminal_width / cols) - 1
+
+            # validate that we have minimum space to render the table
+            return if col_width <= 0
+
+            # separator for every column and row
+            separator = ('| ' << ('- ' * (col_width / 2)))
+
+            # add extra blank spaces to adjust the col_width only if col_width not a even number
+            separator += (' ') if (col_width - separator.size).odd?
+        
+            # print data as table :)
+            data.each_with_index do |row, index|
+
+                # only for table header
+                if index == 0 && header
+
+                    # print table titles
+                    puts '| ' << row.keys.map { |key| key.to_s.upcase.ljust(col_width) }.join('| ')
+
+                    # print header separators, only for visible columns
+                    puts separator * (cols - 1)
+
+                end 
+
+                # join hash values as a line and justify every value to print value
+                # in its own column
+                puts '| ' << row.values.map { |value| value.to_s.ljust(col_width) }.join('| ')
+                #puts '| ' << row.map { |value| value.to_s.ljust(col_width) }.join('| ')
+
+            end
+        end
+    end
+end

data/lib/termline/version.rb

@@ -0,0 +1,35 @@
+=begin
+
+Copyright (c) 2022, Lesli Technologies, S. A.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Lesli Ruby Messages - Message utilities for the Ruby console
+
+Powered by https://www.lesli.tech
+Building a better future, one line of code at a time.
+
+@contact  <hello@lesli.tech>
+@website  <https://www.lesli.tech>
+@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
+@author   The Lesli Development Team
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// · 
+=end
+
+module Termline
+    VERSION = "0.1.0"
+    BUILD = "1774159419"
+end

data/lib/termline.rb

@@ -0,0 +1,112 @@
+=begin
+
+Copyright (c) 2022, Lesli Technologies, S. A.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Lesli Ruby Messages - Message utilities for the Ruby console
+
+Powered by https://www.lesli.tech
+Building a better future, one line of code at a time.
+
+@contact  <hello@lesli.tech>
+@website  <https://www.lesli.tech>
+@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
+@author   The Lesli Development Team
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// · 
+=end
+
+require "termline/config"
+require "termline/table"
+require "termline/space"
+require "termline/list"
+require "termline/msg"
+require "termline/banner"
+
+
+# ·
+module Termline
+
+    def self.m *messages
+        messages.each { |message| Termline::Msg.msg(message) }
+    end
+
+    def self.msg (*messages)
+        messages.each { |message| Termline::Msg.builder(message) }
+    end
+
+    def self.info *messages
+        messages.each { |message| Termline::Msg.info(message) }
+    end
+
+    def self.success *messages
+        messages.each { |message| Termline::Msg.success(message) }
+    end
+
+    def self.warning *messages
+        Termline::Msg.warning(messages)
+    end
+
+    def self.danger *messages
+        Termline::Msg.danger(messages)
+    end
+
+    def self.alert *messages
+        Termline::Msg.alert(messages)
+    end
+
+    def self.warn *messages
+        warning(messages)
+    end
+
+    def self.error *messages
+        Termline::Msg.danger(messages)
+    end
+
+
+    def self.list *items
+        Termline::List.bullet(items)
+    end
+
+    def self.list_check *items
+        Termline::List.check(items)
+    end
+
+    def self.list_star *items
+        Termline::List.star(items)
+    end
+
+
+    def self.table data, header:true
+        Termline::Table.simple(data, header:header)
+    end
+
+    def self.br count=1
+        Termline::Space.br(count)
+    end 
+
+    def self.line count=8
+        Termline::Space.line(count)
+    end
+
+    def self.color color
+        Termline::Space.color(count)
+    end
+
+
+    def self.deprecation message
+    end
+end

data/readme.md

@@ -0,0 +1,145 @@
+<p align="center">
+	<a href="https://www.lesli.dev" target="_blank">
+		<img alt="Lesli Ruby Message logo" width="200px" src="./docs/l2-logo.svg" />
+	</a>
+</p>
+<h3 align="center">Message utilities for the Ruby console</h3>
+
+Version 0.5.2
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add l2
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install l2
+
+Rails apps
+
+    $ gem "L2", "~> 0.4.0"
+
+## Usage
+
+
+**Simple message:**
+
+```ruby
+L2.m("hola")
+L2.m("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Simple message with dividing line:**
+
+```ruby
+L2.msg("hola")
+L2.msg("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Informative message:**
+
+```ruby
+L2.info("hola")
+L2.info("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Sucessful message:**
+
+```ruby
+L2.success("hola")
+L2.success("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Simple message:**
+
+```ruby
+L2.warning("hola")
+L2.warning("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Error message:**
+
+```ruby
+L2.danger("hola")
+L2.danger("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Error with flashing message:**
+
+```ruby
+L2.fatal("hola")
+L2.fatal("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Flashing message:**
+
+```ruby
+L2.alert("hola")
+L2.alert("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Useful to give instructions in deprecated methods or code:**
+
+```ruby
+L2.deprecation("hola")
+```
+
+
+**Print a simple list:**
+
+```ruby
+L2.list("hola", "hello", "hallo", 1, [2], {"a":"b"})
+```
+
+
+**Show data as table:**
+
+```ruby
+L2.table([
+    { español: "hola", english: "hello", deutsch: "hallo" },
+    { español: "hola", english: "hello", deutsch: "hallo" },
+    { español: "hola", english: "hello", deutsch: "hallo" }
+])
+```
+
+
+**Display a cow message:**
+
+```ruby
+L2.cow("Hello little cow!")
+```
+
+
+### Development
+------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Contributing
+------
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LesliTech/l2.
+
+
+### License  
+------
+
+Software developed in [Guatemala](http://visitguatemala.com/) distributed under the *General Public License v 3.0* you can read the full license [here](http://www.gnu.org/licenses/gpl-3.0.html)
+
+<p align="center">
+	<a href="https://www.lesli.tech" target="_blank">
+		<img alt="LesliTech logo" width="150" src="https://cdn.lesli.tech/leslitech/brand/leslitech-logo.svg" />
+	</a>
+</p>

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: termline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- The Lesli Development Team
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: "Termline is a lightweight Ruby gem for printing terminal messages with
+  \ncolors, icons, and semantic log levels.\n"
+email:
+- hello@lesli.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/termline.rb
+- lib/termline/banner.rb
+- lib/termline/config.rb
+- lib/termline/list.rb
+- lib/termline/msg.rb
+- lib/termline/space.rb
+- lib/termline/table.rb
+- lib/termline/version.rb
+- readme.md
+homepage: https://www.lesli.dev/
+licenses:
+- GPL-3.0-or-later
+metadata:
+  homepage_uri: https://www.lesli.dev/
+  changelog_uri: https://github.com/LesliTech/Termline/releases
+  source_code_uri: https://github.com/LesliTech/Termline
+  bug_tracker_uri: https://github.com/LesliTech/Termline/issues
+  documentation_uri: https://www.lesli.dev/gems/termline/
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Human-friendly terminal logs for the Lesli Platform.
+test_files: []