geb 0.1.11

data/lib/geb/page.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+#
+# Represents a site object, handles creation of new sites and site templates
+# Templates can be one of the following:
+#  - name of the site template that comes bundled with geb
+#  - a local directory that is a valid site template
+#  - a URL to a geb site template packaged as a zip file
+#
+# @title Geb - Page
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @todo Make insert pattern configurable
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+# include the required libraries
+require 'fileutils'
+
+module Geb
+  class Page
+
+    # insert pattern constant
+    INSERT_PATTERN    = /<%= insert: (.*?) %>/
+
+    class PageFileNotFound < Geb::Error
+      MESSAGE = "Page file not found".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class PageFileNotFound < Geb::Error
+
+    class PageFileReadFailure < Geb::Error
+      MESSAGE = "Failed to read the page file.".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class PageFileReadFailure < Geb::Error
+
+    class PageMissingTemplateDefition < Geb::Error
+      MESSAGE = "Page is missing template defitions but has insert sections defined".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class PageMissingTemplateDefition < Geb::Error
+
+    class FailedToOutputPage < Geb::Error
+      MESSAGE = "Failed to create output page".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class FailedToOutputPage < Geb::Error
+
+    # @!attribute [r] site
+    # @return [Geb::Site] the site object
+    attr_reader :site
+
+    # @!attribute [r] path
+    # @return [String] the page path
+    attr_reader :path
+
+    # @!attribute [r] content
+    # @return [String] the page content
+    attr_reader :content
+
+    # @!attribute [r] parsed_content
+    # @return [String] the parsed page content
+    attr_reader :parsed_content
+
+    # page constructor, initializes the page object and attributes
+    # @param site [Geb::Site] the site object
+    # @param path [String] the page path
+    # @raise [PageFileNotFound] if the page file does not exist
+    # @raise [PageFileReadFailure] if the page file could not be read
+    # @return [Geb::Page] the page object
+    def initialize(site, path)
+
+      # set the site and path
+      @site = site
+      @path = path
+
+      # check if the page file exists
+      raise PageFileNotFound.new(@path) unless page_file_exists?
+
+      Geb.log ""
+      Geb.log " - loading page: #{page_name}"
+
+      # read the page file, raise an error if the file could not be read
+      begin
+        @content = File.read(@path)
+      rescue => e
+        raise PageFileReadFailure.new(e.message)
+      end # begin
+
+      # parse the page content
+      parse()
+
+    end # def initialize
+
+    # parse the page content for templates and partials
+    def parse
+
+      # initalise the new page content
+      @parsed_content = @content.dup
+
+      # parse the content for templates and partials
+      @parsed_content = parse_for_templates(@parsed_content)
+      @parsed_content = parse_for_partials(@parsed_content)
+
+    end # def parse
+
+    # parse the content for templates. This method will keep looking for templates until all templates are found as
+    # templates can be based on templates.
+    # @param content [String] the content to parse for templates. Default is the parsed page content.
+    # @return [String] the parsed content, with no templates to parse.
+    # @raise [PageMissingTemplateDefition] if a template sections are found but the template declaration is not.
+    def parse_for_templates(content = @parsed_content)
+
+      # initialise a flag to keep looking for templates
+      keep_looking_for_template = true
+
+      # keep looking for template until we find them all
+      while keep_looking_for_template
+
+        # attempt to extract the template path and sections
+        template_path     = Geb::Template.extract_template_path(content)
+        template_sections = Geb::Template.extract_sections_for_template(content)
+
+        # raise an error if template sections are defined but the template is not
+        raise PageMissingTemplateDefition.new(page_name) if template_sections.any? && template_path.nil?
+
+        # check if we found a template
+        if template_path.nil?
+
+          # we did not find a template, so we are done
+          keep_looking_for_template = false
+
+        else
+
+          # create a new template object
+          template = Geb::Template.load(File.join(@site.site_path, template_path))
+
+          # parse the template content and replace the insert sections
+          content = template.parse(template_sections)
+
+        end # unless template_path.nil?
+
+      end # while keep_looking_for_template
+
+      # return the parsed content with templates handled
+      return content
+
+    end # def parse_for_templates
+
+    # parse the content for partials. This method will keep looking for partials until all partials are found as
+    # partials can be embeded in other partials.
+    # @param content [String] the content to parse for partials. Default is the parsed page content.
+    # @return [String] the parsed content, with no partials to parse.
+    def parse_for_partials(content = @parsed_content)
+
+      # initialise a flag to keep looking for partials
+      keep_looking_for_partials = true
+
+      # keep looking for partials until we find them all (partials can be embeded in other partials)
+      while keep_looking_for_partials
+
+        # attempt to extract the partial paths
+        found_partials, content = Geb::Partial.process_partials(@site.site_path, content)
+
+        # check if we found any partials, if not we are done
+        keep_looking_for_partials = (found_partials != 0)
+
+      end # while keep_looking_for_partials
+
+      # return the parsed content with partials handled
+      return content
+
+    end # def parse_for_partials
+
+    # build the page, save it to the output folder
+    # @param output_path [String] the output path
+    # @raise [FailedToOutputPage] if the page could not be saved to the output folder
+    def build(output_path)
+
+      # build the page
+      Geb.log " - building page: #{page_name}"
+
+      # strip whitespace (spaces and newlines) at the beginning and at the end of the file
+      @parsed_content = @parsed_content.strip
+
+      # build the output filename
+      output_filename = @path.gsub(@site.site_path, output_path)
+
+      # attempt to create the output directory and file
+      begin
+
+        # make sure the output directory for the file exists
+        FileUtils.mkdir_p(File.dirname(output_filename))
+
+        # write the content to the output file
+        File.write(output_filename, @parsed_content)
+
+      rescue => e
+        raise FailedToOutputPage.new(e.message)
+      end # begin rescue
+
+    end # def build
+
+    private
+
+    # get the page name by removing the site folder from the path
+    # @return [String]
+    def page_name
+      return @path.gsub(@site.site_path, '')
+    end # def page_name
+
+    # check if the page file exists, returns true if the file exists, false otherwise
+    # @return [Boolean]
+    def page_file_exists?
+      return File.exist?(@path)
+    end # def page_file_exists?
+
+  end # class Page
+end # module Geb

data/lib/geb/partial.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+#
+# Represents a page partial. A page partial is a file that contains
+# content that is to be inserted in the page at the pace where the partial was
+# declared. The class keeps a cache of already loaded partials.
+#
+# @title Geb - Partial
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @todo Make partial pattern configurable
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+# include the required libraries
+require 'fileutils'
+
+module Geb
+  class Partial
+
+    # partial pattern constant
+    PARTIAL_PATTERN = /<%= partial: (?<path>.*?) %>/
+
+    class PartialFileNotFound < Geb::Error
+      MESSAGE = "Partial file not found".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class PartialFileNotFound < Geb::Error
+
+    class PartialFileReadFailure < Geb::Error
+      MESSAGE = "PFailed to read the partial file.".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class PartialFileReadFailure < Geb::Error
+
+    # define a class level cache for loaded partial objects
+    @@loaded_partials = {}
+
+    # class method to expire the partial cache
+    def self.expire_cache
+      @@loaded_partials = {}
+    end # def self.expire_cache
+
+    # class method to initialise a partial if it is not already loaded, otherwise, return the cached partial
+    # @param partial_path [String] the path to the partial file
+    # @return [Geb::Partial] the partial object
+    def self.load(partial_path)
+
+      # initialise a return partial object
+      return_partial = nil
+
+      # check if the partial is already loaded
+      if @@loaded_partials.key?(partial_path)
+
+        # return the cached partial
+        Geb.log " - using cached partial: #{partial_path}"
+        return_partial = @@loaded_partials[partial_path]
+
+      else
+
+        # create a new partial object
+        return_partial = Partial.new(partial_path)
+
+        # add the partial to the cache
+        @@loaded_partials[partial_path] = return_partial
+
+      end # if else
+
+      # return the partial object
+      return return_partial
+
+    end # def self.load
+
+    # class method to process partials in a page
+    # @param site_path [String] the path to the site
+    # @param page_content [String] the content of the page
+    # @return [Array] an array containing the number of partials found and the page content
+    # @raise [PartialFileNotFound] if the partial file does not exist
+    # @raise [PartialFileReadFailure] if the partial file could not be read
+    def self.process_partials(site_path, page_content)
+
+      # initialise a counter to count the number of partials found on the page
+      partial_count = 0
+
+      # initialize return page content
+      return_page_content = page_content.dup
+
+      # scan the page content for partials
+      return_page_content.gsub!(PARTIAL_PATTERN) do |match|
+
+        # match the partial relative and full paths
+        partial_file_path =  match.match(PARTIAL_PATTERN)[:path].strip
+        partial_file_full_path = File.join(site_path, partial_file_path)
+
+        # load the partial object
+        partial = Partial.load(partial_file_full_path)
+
+        # increment the partial count
+        partial_count += 1
+
+        # return the partial content
+        partial.content
+
+      end # page_content.scan(PARTIAL_PATTERN) do |match|
+
+      # return the array of partial paths
+      return partial_count, return_page_content
+
+    end # def self.extract_partial_paths
+
+    # @!attribute [r] path
+    # @return [String] the path to the partial file
+    attr_reader :path
+
+    # @!attribute [r] content
+    # @return [String] the content of the partial file
+    attr_reader :content
+
+    # initialise a new partial object
+    # @param partial_path [String] the path to the partial file
+    # @raise [PartialFileNotFound] if the partial file does not exist
+    # @raise [PartialFileReadFailure] if the partial file could not be read
+    # @return [Geb::Partial] the partial object
+    def initialize(partial_path)
+
+      # set the partial path
+      @path = partial_path
+      @content = nil
+
+      # check if the partial file exists
+      raise PartialFileNotFound.new(partial_path) unless partial_file_exists?()
+
+      Geb.log " - loading partial: #{@path}"
+
+      # read the template file, raise an error if the file could not be read
+      begin
+        @content = File.read(partial_path)
+      rescue => e
+        raise PartialFileReadFailure.new(e.message)
+      end # begin
+
+    end # def initialize
+
+    # check if the partial file exists
+    # @return [Boolean] true if the partial file exists, otherwise false
+    def partial_file_exists?
+      return File.exist?(@path)
+    end # def template_file_exists?
+
+  end # class Partial
+end # module Geb

data/lib/geb/samples/basic/assets/css/site.css

@@ -0,0 +1,7 @@
+BODY {
+  background-color: #1A2D3D;
+  font-family: Arial, sans-serif;
+  margin: 0;
+  padding: 0;
+  color: #fff;
+}

data/lib/geb/samples/basic/assets/js/site.js

@@ -0,0 +1,5 @@
+
+// use jquery to log a message to the console once the page loads
+$(document).ready(function() {
+    console.log('site.js loaded');
+}

data/lib/geb/samples/basic/geb.config.yml

@@ -0,0 +1,70 @@
+
+# Geb Configuration File
+# =======================
+#
+# This is a sample configuration file for the geb command line tool.
+# You pretty much don't have to specify anything in this file, unless you want to 
+# customize the site. The default values are good enough for most sites.
+#
+# EVEN IF YOU DON"T SPECIFY ANYTHING IN THIS FILE, THIS CONFIG FILE MUST EXIST
+# AT THE ROOT OF THE SITE DIRECTORY.  OTHERWISE, THE GEB COMMANDS WILL NOT WORK.
+# IT CAN BE EMPTY, BUT IT MUST EXIST. GEB DEMANDS IT.
+#
+# However, remote_uri and remote_path are required if you want to use 
+# the geb remote and upload commands. If you plan to upload the site on your own then
+# you don't need to specify these values.
+#
+
+# Name of the site. 
+# If not specified, the default is the name of the directory where the site is located.
+# Just for display purposes.
+#site_name: "My Site"
+
+# The remote_uri is the SSH URI of the remote server that you are deploying to.
+# Geb remote and upload commands will use this URI to connect to the server.
+# If you don't specify a remote_uri, geb remote and upload commands will not work.
+# Typical format is username@server
+#remote_uri: "user@server.com"
+
+# The remote_path is the path on the remote server where the site is located.
+# If you don't specify a remote_path, upload commands will not work.
+#remote_path: "/path/to/site"
+
+# Set the local web server port that the site will run on.
+# Geb server command will use this port to start the local web server
+# If you don't specify a port, geb server command auto selects a port
+#local_port: 4000
+
+# Specifies the output directory, this directory will be used to store the output of
+# the build and release commands. 
+# the output directory is relative to the site directory.
+# The default value is "output"
+#output_dir: "output"
+
+# Specifies the assets directory, this directory will be used to store the assets.
+# The assets directory is relative to the site directory.
+# The default value is "assets"
+#assets_dir: "assets"
+
+# Specifies the page extensions that are used in the site. This can be any text file extension.
+# Default value is ['.md', '.markdown', '.html', '.htm', '.txt', '.js', '.css']
+#page_extensions: ["html", "htm", "md", "markdown"]
+
+# Template and partial identifier is a regular expression that is used to identify the template
+# and partial files in the site. The default value is /^_/, any filename that starts with an underscore.
+# These files are processed, but not included in the output directory, local or release.
+# This setting does not impact template paths below, which are used to share the site as a template,
+# which will include the template and partial files, if the template_paths includes them.
+#template_and_partial_identifier: /^_/
+
+# if you want to share the site as a template site, specify which files and directories 
+# are part of the template.
+# When you create a new site, these files and directories will be copied to the new site
+# If you don't specify template_paths, the site will not be shared as a template site and
+# the geb release --with_template option will not work.
+# Likewise, for other sites to use this site as a template, you must specify the template_paths.
+# The site template files will be archived into geb-template.tar.gz file and put within
+# the release directory.
+# e.g. template_paths: ["assets", "shared", "*.html", "site.webmanifest"]
+#template_paths: []
+  

data/lib/geb/samples/basic/index.html

@@ -0,0 +1,11 @@
+<% template: shared/templates/_site.html %>
+
+<% start: title %>
+This is a website title
+<% end: title %>
+
+<% start: content %>
+
+<p>Welcome to the site</p>
+
+<% end: content %>

data/lib/geb/samples/basic/page.html

@@ -0,0 +1,11 @@
+<% template: shared/templates/_site.html %>
+
+<% start: title %>
+This is another page
+<% end: title %>
+
+<% start: content %>
+
+<p>Welcome to the other page</p>
+
+<% end: content %>

data/lib/geb/samples/basic/shared/partials/_analytics.html

@@ -0,0 +1,9 @@
+
+<!-- Global Site Tag (gtag-js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=GA_TRACKING_ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag() {databayer-push (arguments) ; }
+  gtag( 'js', new Date());
+  gtag( 'config', 'GA_TRACKING_ID' );
+</script>

data/lib/geb/samples/basic/shared/partials/_footer.html

@@ -0,0 +1,3 @@
+
+<!-- Bootstrap Bundle -->
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>

data/lib/geb/samples/basic/shared/partials/_global_assets.html

@@ -0,0 +1,19 @@
+<!-- Bootstrap icons-->
+<link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css" rel="stylesheet" >
+
+<!-- Bootstrap CSS -->
+<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+
+<!-- Custom CSS styles -->
+<link href="_{site_url}_/assets/css/site.css" rel="stylesheet" />
+
+<!--
+The Bootstrap JavaScript bundle is not here, but is included in the footer of the page.
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+-->
+
+<!-- jQuery -->
+<script src="https://code.jquery.com/jquery-3.7.1.slim.min.js" integrity="sha256-kmHvs0B+OpCW5GVHUNjv9rOmY0IvSIRcf7zGUDTDQM8=" crossorigin="anonymous"></script>
+
+<!-- Custom Javascript -->
+<script src="_{site_url}_/assets/js/site.js"></script>

data/lib/geb/samples/basic/shared/partials/_meta_tags.html

@@ -0,0 +1,34 @@
+
+<!-- Meta tags -->
+<meta charset="utf-8" />
+<meta name="generator"    content="Geb 1.0.0" />
+<meta name="viewport"     content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+<meta name=”robots”       content="index, follow" />
+<meta name="description"  content="_{title}_" />
+<meta name="keywords"     content="geb,geb static site,static site" />
+<meta name="author"       content="Geb, the Egyptian god of earth" />
+
+<!-- Favicon and site icon -->
+<link rel="apple-touch-icon"  type="image/png"  sizes="180x180" href="_{site_url}_/assets/images/apple-touch-icon.png" />
+<link rel="icon"              type="image/png"  sizes="32x32"   href="_{site_url}_/assets/images/favicon-32x32.png" />
+<link rel="icon"              type="image/png"  sizes="16x16"   href="_{site_url}_/assets/images/favicon-16x16.png" />
+<link rel="icon"              type="image/x-icon"               href="_{site_url}_/assets/images/favicon.ico" />
+<link rel="shortcut icon"     type="image/x-icon"               href="_{site_url}_/assets/images/favicon.ico" />
+
+<!-- Site manifest -->
+<link rel="canonical"                   href="_{site_url}_/_{relative_path}_" />
+<link rel="manifest"  type="image/png"  href="/site.webmanifest" />
+
+<!-- Open Graph -->
+<meta property="og:type"          content="website" />
+<meta property="og:title"         content="_{title}_" />
+<meta property="og:description"   content="_{title}_." />
+<meta property="og:image"         content="_{site_url}_/assets/images/og-thumb.png" />
+
+<!-- Twitter Cards -->
+<meta name="twitter:card"         content="summary_large_image" />
+<meta name="twitter:site"         content="@twitter" />
+<meta name="twitter:title"        content="_{title}_" />
+<meta name="twitter:description"  content="_{title}_" />
+<meta name="twitter:image"        content="_{site_url}_/assets/images/twitter-thumb.png" />
+

data/lib/geb/samples/basic/shared/templates/_site.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <head>
+
+    <title><%= insert: title %></title>
+
+    <%= partial: shared/partials/_analytics.html %>
+    <%= partial: shared/partials/_meta_tags.html %>
+    <%= partial: shared/partials/_global_assets.html %>
+    
+  </head>
+  <body>
+    
+    <%= partial: shared/partials/_header.html %>
+    <%= insert: content %>
+    <%= partial: shared/partials/_footer.html %>
+
+  </body>
+</html>

data/lib/geb/samples/basic/site.webmanifest

@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/assets/images/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/assets/images/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

data/lib/geb/samples/bootstrap_jquery/assets/css/site.css

@@ -0,0 +1,7 @@
+BODY {
+  background-color: #1A2D3D;
+  font-family: Arial, sans-serif;
+  margin: 0;
+  padding: 0;
+  color: #fff;
+}

data/lib/geb/samples/bootstrap_jquery/assets/js/site.js

@@ -0,0 +1,5 @@
+
+// use jquery to log a message to the console once the page loads
+$(document).ready(function() {
+    console.log('site.js loaded');
+}