gloo 0.4.0 → 0.5.0

data/lib/gloo/objs/data/markdown.rb

@@ -0,0 +1,109 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Markdown data.
+#
+require 'tty-markdown'
+require 'tty-pager'
+
+module Gloo
+  module Objs
+    class Markdown < Gloo::Core::Obj
+
+      KEYWORD = 'markdown'.freeze
+      KEYWORD_SHORT = 'md'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # Set the value with any necessary type conversions.
+      #
+      def set_value( new_value )
+        self.value = new_value.to_s
+      end
+
+      #
+      # Does this object support multi-line values?
+      # Initially only true for scripts.
+      #
+      def multiline_value?
+        return false
+      end
+
+      #
+      # Get the number of lines of text.
+      #
+      def line_count
+        return value.split( "\n" ).count
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[show page]
+      end
+
+      #
+      # Show the markdown data in the terminal.
+      #
+      def msg_show
+        puts TTY::Markdown.parse self.value
+      end
+
+      #
+      # Show the markdown data in the terminal, paginated.
+      #
+      def msg_page
+        return unless self.value
+
+        md = TTY::Markdown.parse self.value
+        # pager = TTY::Pager::SystemPager.new command: 'less -R'
+        pager = TTY::Pager.new
+        pager.page( md )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          MARKDOWN OBJECT TYPE
+            NAME: markdown
+            SHORTCUT: md
+
+          DESCRIPTION
+            Markdown data in a text string.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            show - Show the markdown data in the terminal.
+            page - Show the markdown data in the terminal, paginated.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/data/table.rb

@@ -0,0 +1,168 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A data table.
+# The table container headers and data.
+#
+require 'tty-table'
+require 'pastel'
+
+module Gloo
+  module Objs
+    class Table < Gloo::Core::Obj
+
+      KEYWORD = 'table'.freeze
+      KEYWORD_SHORT = 'tbl'.freeze
+      HEADERS = 'headers'.freeze
+      DATA = 'data'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # Get the list of headers.
+      # Returns nil if there is none.
+      #
+      def headers
+        o = find_child HEADERS
+        return [] unless o
+
+        return o.children.map( &:value )
+      end
+
+      #
+      # Get the list of column names.
+      # Returns nil if there is none.
+      #
+      def columns
+        o = find_child HEADERS
+        return [] unless o
+
+        return o.children.map( &:name )
+      end
+
+      #
+      # Get the list of data elements.
+      #
+      def data
+        o = find_child DATA
+        return [] unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( o )
+        cols = self.columns
+        return o.children.map do |e|
+          cols.map { |h| e.find_child( h ).value }
+        end
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      def add_children_on_create?
+        return true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_can HEADERS, self
+        fac.create_can DATA, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'show' ]
+      end
+
+      #
+      # Show the table in the CLI.
+      #
+      def msg_show
+        title = self.value
+        Gloo::Objs::Table.show headers, data, title
+      end
+
+      # ---------------------------------------------------------------------
+      #    Static table helper
+      # ---------------------------------------------------------------------
+
+      #
+      # Show the given table data.
+      #
+      def self.show( headers, data, title = nil )
+        pastel = ::Pastel.new
+        table = TTY::Table.new headers, data
+        pad = [ 0, 1, 0, 1 ]
+        rendered = table.render( :ascii, indent: 2, padding: pad ) do |r|
+          r.border.style = :blue
+          r.filter = proc do |val, row_index, _col_index|
+            # col_index % 2 == 1 ? pastel.red.on_green(val) : val
+            if row_index.zero?
+              pastel.blue( val )
+            else
+              row_index.odd? ? pastel.white( val ) : pastel.yellow( val )
+            end
+          end
+        end
+        puts "\n#{title.white}"
+        puts "#{rendered}\n\n"
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          TABLE OBJECT TYPE
+            NAME: table
+            SHORTCUT: tbl
+
+          DESCRIPTION
+            A data table.
+
+          CHILDREN
+            headers - container
+              A list of headers.
+              The name of the header object needs to be the same as the
+              name of the object in the data container.
+              The value of the header is what will be displayed.
+            data - container
+              The table's data.
+              The data container will have one or more containers, each
+              of which represents one row of data.
+
+          MESSAGES
+            show - Show the contents of the table in the CLI.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/dt/date.rb

@@ -0,0 +1,72 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A Date object (does not include a time).
+#
+
+module Gloo
+  module Objs
+    class Date < Gloo::Core::Obj
+
+      KEYWORD = 'date'.freeze
+      KEYWORD_SHORT = 'date'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[now]
+      end
+
+      # Get the current working branch.
+      def msg_now
+        t = DateTime.now.strftime( '%Y.%m.%d' )
+        self.value = t
+        $engine.heap.it.set_to t
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          DATE OBJECT TYPE
+            NAME: date
+            SHORTCUT: date
+
+          DESCRIPTION
+            A reference to a date, but without time.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            now - Set to the current system date.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/dt/datetime.rb

@@ -0,0 +1,84 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A Date and Time object.
+#
+
+module Gloo
+  module Objs
+    class Datetime < Gloo::Core::Obj
+
+      KEYWORD = 'datetime'.freeze
+      KEYWORD_SHORT = 'dt'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # Set the value with any necessary type conversions.
+      #
+      def set_value( new_value )
+        unless new_value.is_a? DateTime
+          self.value = $engine.convert( new_value, 'DateTime', nil )
+          return
+        end
+
+        self.value = new_value
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[now]
+      end
+
+      # Get the current working branch.
+      def msg_now
+        t = DateTime.now.strftime( '%Y.%m.%d %I:%M:%S %P' )
+        self.value = t
+        $engine.heap.it.set_to t
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          DATETIME OBJECT TYPE
+            NAME: datetime
+            SHORTCUT: dt
+
+          DESCRIPTION
+            A reference to a date and time.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            now - Set to the current system date and time.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/dt/time.rb

@@ -0,0 +1,72 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A Time object (does not include a date).
+#
+
+module Gloo
+  module Objs
+    class Time < Gloo::Core::Obj
+
+      KEYWORD = 'time'.freeze
+      KEYWORD_SHORT = 'time'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[now]
+      end
+
+      # Get the current working branch.
+      def msg_now
+        t = DateTime.now.strftime( '%I:%M:%S %P' )
+        self.value = t
+        $engine.heap.it.set_to t
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          TIME OBJECT TYPE
+            NAME: time
+            SHORTCUT: time
+
+          DESCRIPTION
+            A reference to a time, but without a date.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            now - Set to the current system time.
+        TEXT
+      end
+
+    end
+  end
+end