gloo 1.4.2 → 2.0.0

data/lib/gloo/objs/web/uri.rb

@@ -0,0 +1,148 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A URI (URL).
+#
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+module Gloo
+  module Objs
+    class Uri < Gloo::Core::Obj
+
+      KEYWORD = 'uri'.freeze
+      KEYWORD_SHORT = 'url'.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
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        basic = %w[open]
+        gets = %w[get_scheme get_host get_path]
+        more = %w[get_query get_fragment get_cert_expires]
+        return super + basic + gets + more
+      end
+
+      #
+      # Get the expiration date for the certificate.
+      #
+      def msg_get_cert_expires
+        return unless value
+        o = value
+        uri = URI( value )
+        response = Net::HTTP.start( uri.host, uri.port, :use_ssl => true )
+        cert = response.peer_cert
+        o = cert.not_after
+
+        @engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI fragment that comes after the '#'
+      # in the URL.  Might be used to scroll down in the page.
+      #
+      def msg_get_fragment
+        return unless value
+
+        o = URI( value ).fragment
+        @engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI query parameters.
+      # Example:  id=121
+      #
+      def msg_get_query
+        return unless value
+
+        o = URI( value ).query
+        @engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI path.
+      # Example:  /posts
+      #
+      def msg_get_path
+        return unless value
+
+        o = URI( value ).path
+        @engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI host.
+      # Example:  google.com
+      #
+      def msg_get_host
+        return unless value
+
+        o = URI( value ).host
+        @engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI Scheme.
+      # Example:  http
+      #
+      def msg_get_scheme
+        return unless value
+
+        o = URI( value ).scheme
+        @engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Open the URI in the default browser.
+      #
+      def msg_open
+        return unless value
+
+        cmd = Gloo::Core::GlooSystem.open_for_platform
+        cmd_with_param = "#{cmd} \"#{value}\""
+        `#{cmd_with_param}`
+      end
+
+    end
+  end
+end

data/lib/gloo/persist/disc_mech.rb

@@ -0,0 +1,87 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2022 Eric Crane.  All rights reserved.
+#
+# Disc based mechanism for files.
+# Provides interaction between the persistance classes and the OS 
+# file and folder system.
+# This class might be overiden elsewhere to provide other mechanism.
+# For example, in gloo-web, there will be a db based mechanism.
+#
+
+module Gloo
+  module Persist
+    class DiscMech
+
+      #
+      # Set up a disc based file mechanism.
+      #
+      def initialize( engine )
+        @engine = engine
+      end
+
+      #
+      # Get the default file extention.
+      #
+      def file_ext
+        return '.gloo'
+      end
+
+      #
+      # Get all the gloo files in the folder (partial path).
+      #
+      def get_all_files_in( folder )
+        pns = []
+        dir = File.join( @engine.settings.project_path, folder )
+        Dir.glob( "#{dir}*.gloo" ).each do |f|
+          pns << f
+        end
+        return pns
+      end
+
+      # 
+      # Check if a file exists.
+      # 
+      def exist?( file )
+        File.exist?( file )
+      end
+
+      # 
+      # Check to see if the file is valid.
+      # 
+      def valid?( file )
+        return false unless file
+        return false unless File.exist?( file )
+        return false unless File.file?( file )
+        return false unless file.end_with?( self.file_ext )
+
+        return true
+      end
+
+      # 
+      # Expand a single file path.
+      # 
+      def expand( name )
+        ext_path = File.expand_path( name )
+        return [ ext_path ] if self.valid?( ext_path )
+
+        full_name = "#{name}#{file_ext}"
+        return [ File.join( @engine.settings.project_path, full_name ) ]
+      end
+
+      # 
+      # Read in the contents of a single file.
+      # 
+      def read( file )
+        return File.read( file )
+      end
+
+      # 
+      # Write data to the file.
+      # 
+      def write( pn, data )
+        File.write( pn, data )
+      end
+
+    end
+  end
+end

data/lib/gloo/persist/file_loader.rb

@@ -0,0 +1,193 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Helper class used to load a file and create objects in the heap.
+#
+
+module Gloo
+  module Persist
+    class FileLoader
+
+      BEGIN_BLOCK = 'BEGIN'.freeze
+      END_BLOCK = 'END'.freeze
+      SPACE_CNT = 2
+
+      attr_reader :obj
+
+      #
+      # Set up a file storage for an object.
+      #
+      def initialize( engine, pn )
+        @engine = engine
+        @mech = @engine.platform.getFileMech( @engine )
+        @pn = pn
+        @tabs = 0
+        @obj = nil
+        @in_multiline = false
+        @exiting_multiline = false
+        @in_block = false
+        @block_value = ''
+        @debug = false
+      end
+
+      #
+      # Load the objects from the file.
+      #
+      def load
+        unless @mech.exist?( @pn )
+          @engine.log.error "File '#{@pn}' does not exist."
+          return
+        end
+
+        @engine.log.debug "Loading file '#{@pn}'"
+        @tabs = 0
+        @parent_stack = []
+        @parent = @engine.heap.root
+        @parent_stack.push @parent
+        f = @mech.read( @pn )
+        f.each_line do |line|
+          next if skip_line? line
+
+          handle_one_line line
+        end
+      end
+
+      #
+      # Process one one of the file we're loading.
+      #
+      def handle_one_line( line )
+        if line.strip.end_with? BEGIN_BLOCK
+          @in_block = true
+          @save_line = line
+        elsif @in_block
+          if line.strip == END_BLOCK
+            @in_block = false
+            determine_indent @save_line
+            process_line @save_line
+          else
+            @block_value << line
+          end
+        else
+          determine_indent line
+          process_line line
+        end
+      end
+
+      #
+      # Is this line a comment or a blank line?
+      # If so we'll skip it.
+      #
+      def skip_line?( line )
+        line = line.strip
+        return true if line.empty?
+        return true if line[ 0 ] == '#'
+
+        return false
+      end
+
+      #
+      # Determine the relative indent level for the line.
+      #
+      def determine_indent( line )
+        tabs = tab_count( line )
+        @indent = 0 # same level as prior line
+        if tabs > @tabs # indent
+          # TODO:  What if indent is more than one more level?
+          @tabs = tabs
+          @indent = 1
+        elsif tabs < @tabs # outdent
+          diff = @tabs - tabs
+          @tabs -= diff
+          @indent -= diff
+        end
+        puts "tabs: #{@tabs}, indent: #{@indent}, line: #{line}" if @debug
+      end
+
+      #
+      # Process one line and add objects.
+      #
+      def process_line( line )
+        # reset multiline unless we're actually indented
+        if @in_multiline && @multi_indent > @indent
+          puts "Done multiline mi: #{@multi_indent}, i: #{@indent}" if @debug
+          @in_multiline = false
+          @exiting_multiline = true
+        end
+
+        if @in_multiline
+          @last.add_line line
+        else
+          setup_process_obj_line
+          process_obj_line line
+        end
+      end
+
+      #
+      # Setup and get ready to process an object line.
+      #
+      def setup_process_obj_line
+        if @exiting_multiline
+          @exiting_multiline = false
+          @indent += 1
+        end
+
+        if @indent.positive?
+          @parent = @last
+          @parent_stack.push @parent
+        elsif @indent.negative?
+          @indent.abs.times do
+            @parent_stack.pop
+            @parent = @parent_stack.last
+          end
+        end
+      end
+
+      #
+      # Process one line and add objects.
+      #
+      def process_obj_line( line )
+        name, type, value = split_line( line )
+        unless @block_value == ''
+          value = @block_value
+          @block_value = ''
+        end
+        params = { name: name, type: type, value: value, parent: @parent }
+        @last = @engine.factory.create( params )
+
+        if value.empty? && @last&.multiline_value?
+          @multi_indent = 0
+          @in_multiline = true
+          puts "*** Start multiline. multi_indent: #{@multi_indent}" if @debug
+        end
+
+        @obj = @last if @obj.nil?
+      end
+
+      #
+      # Get the number of leading tabs.
+      #
+      def tab_count( line )
+        i = 0
+
+        if line[ i ] == ' '
+          i += 1 while line[ i ] == ' '
+          tab_equiv = ( i / SPACE_CNT ).to_i
+          puts "Found #{i} spaces => #{tab_equiv}" if @debug
+          return tab_equiv
+        end
+
+        i += 1 while line[ i ] == "\t"
+        return i
+      end
+
+      #
+      # Split the line into 3 parts.
+      #
+      def split_line( line )
+        o = LineSplitter.new( line, @tabs )
+        return o.split
+      end
+
+    end
+  end
+end

data/lib/gloo/persist/file_saver.rb

@@ -0,0 +1,51 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Helper class used to save an object to a file..
+#
+
+module Gloo
+  module Persist
+    class FileSaver
+
+      #
+      # Set up a file storage for an object.
+      #
+      def initialize( engine, pn, obj )
+        @engine = engine
+        @mech = @engine.platform.getFileMech( @engine )
+        @pn = pn
+        @obj = obj
+      end
+
+      #
+      # Save the object to the file.
+      #
+      def save
+        data = get_obj( @obj )
+        @mech.write( @pn, data )
+      end
+
+      #
+      # Get string of tabs for indentation.
+      #
+      def tabs( indent = 0 )
+        return "\t" * indent
+      end
+
+      #
+      # Convert an object to textual representation.
+      # This is a recursive function.
+      #
+      def get_obj( obj, indent = 0 )
+        t = tabs( indent )
+        str = "#{t}#{obj.name} [#{obj.type_display}] : #{obj.value_display}\n"
+        obj.children.each do |child|
+          str << get_obj( child, indent + 1 )
+        end
+        return str
+      end
+
+    end
+  end
+end

data/lib/gloo/persist/file_storage.rb

@@ -0,0 +1,46 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Helper class takes an object and writes it to a file.
+#
+
+module Gloo
+  module Persist
+    class FileStorage
+
+      attr_reader :obj, :pn
+
+      #
+      # Set up a file storage for an object.
+      #
+      def initialize( engine, pn, obj = nil )
+        @engine = engine
+        @obj = obj
+        @pn = pn
+      end
+
+      #
+      # Save the object to the file.
+      #
+      def save
+        fs = FileSaver.new( @engine, @pn, @obj )
+        fs.save
+      end
+
+      #
+      # Load the object from the file.
+      #
+      def load
+        fl = FileLoader.new( @engine, @pn )
+        fl.load
+        @obj = fl.obj
+        if @obj
+          @engine.log.debug "Loaded object: #{@obj.name}"
+        else
+          @engine.log.error "Error loading file at #{@pn}"
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo/persist/line_splitter.rb

@@ -0,0 +1,81 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Helper class used as part of file loading.
+# It is responsible for splitting a line into components.
+#
+
+module Gloo
+  module Persist
+    class LineSplitter
+
+      BEGIN_BLOCK = 'BEGIN'.freeze
+      END_BLOCK = 'END'.freeze
+
+      attr_reader :obj
+
+      #
+      # Set up a line splitter
+      #
+      def initialize( line, tabs )
+        @line = line
+        @tabs = tabs
+      end
+
+      #
+      # Split the line into 3 parts.
+      #
+      def split
+        detect_name
+        detect_type
+        detect_value
+
+        return @name, @type, @value
+      end
+
+      #
+      # Detect the object name.
+      #
+      def detect_name
+        @line = @line.strip
+        @idx = @line.index( ' ' )
+        @name = @line[ 0..@idx - 1 ]
+      end
+
+      #
+      # Detect the object type.
+      #
+      def detect_type
+        @line = @line[ @idx + 1..-1 ]
+        @idx = @line.index( ' ' )
+
+        if @line[ 0 ] == ':'
+          @type = 'untyped'
+          return
+        end
+
+        @type = @line[ 0..( @idx ? @idx - 1 : -1 ) ]
+        @type = @type[ 1..-1 ] if @type[ 0 ] == '['
+        @type = @type[ 0..-2 ] if @type[ -1 ] == ']'
+      end
+
+      #
+      # Detect the object value.
+      # Use nil if there is no value specified.
+      #
+      def detect_value
+        if @idx
+          @value = @line[ @idx + 1..-1 ]
+          if @value[ 0..1 ] == ': '
+            @value = @value[ 2..-1 ]
+          elsif @value[ 0 ] == ':'
+            @value = @value[ 1..-1 ]
+          end
+        else
+          @value = nil
+        end
+      end
+
+    end
+  end
+end