geb 0.1.11

data/lib/geb/commands/build.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+#
+# Build command definition, based on Dry::CLI framework
+# Builds the site, this is the core of what Geb does
+#
+# @title Geb - Build Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+module Geb
+  module CLI
+    module Commands
+
+      # Define build command
+      class Build < Dry::CLI::Command
+
+        # Command description, usage and examples
+        desc "Build the full site, includes pages and assets"
+        example [" ", "--skip_assets", "--skip_pages"]
+
+        # Define command options
+        option :skip_assets,  type: :boolean, default: false, desc: "Skip building assets (images, css, js)"
+        option :skip_pages,   type: :boolean, default: false, desc: "Skip building pages"
+
+        # Call method for the build command
+        def call(**options)
+
+          # initialise a new site and load the site from the current directory
+          site = Geb::Site.new
+          site.load(Dir.pwd)
+
+          # build the pages unless the skip_pages option is set
+          # it is important to build assets first as there may be pages in the assets directory
+          Geb.log "Skipping building pages as told." if options[:skip_pages]
+          site.build_pages unless options[:skip_pages]
+
+          # build the assets (images, css, js) unless the skip_assets option is set
+          Geb.log "Skipping building assets as told." if options[:skip_assets]
+          site.build_assets unless options[:skip_assets]
+
+          # put a smartarse message to the console if both options are set
+          Geb.log "You told me to skip everything, so I did." if options[:skip_assets] && options[:skip_pages]
+
+        rescue Geb::Error => e
+
+          # print error message
+          puts
+          warn e.message
+
+        end # def call
+
+      end # class Build < Dry::CLI::Command
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/commands/init.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+#
+# Init command definition, based on Dry::CLI framework
+# Initializes the site, creates a basic folder structure and git repository
+#
+# @title Geb - Init Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+# include the required libraries
+require 'fileutils'
+
+module Geb
+  module CLI
+    module Commands
+
+      # define init command
+      class Init < Dry::CLI::Command
+
+        # command description, usage and examples
+        desc "Initialise geb site, creates folder locations, git repository and initial file structures"
+        example ["new_site ", "new_site [options]", "new_site --skip_template --skip_git"]
+
+        # define project name command argument
+        argument :site_path,        type: :string,  required: true, desc: "Path to the site folder / site name"
+
+        # define command options
+        option :template,       type: :string,  required: false,  desc: "Template site, either a path to a folder or one of the following: #{Geb::Defaults::AVAILABLE_TEMPLATES.join(", ")}. Default: #{Geb::Defaults::AVAILABLE_TEMPLATES.first}"
+        option :skip_template,  type: :boolean, default: false,   desc: "Skip generating a site from template, ignores the template option."
+        option :skip_git,       type: :boolean, default: false,   desc: "Skip initialising git repository"
+        option :force,          type: :boolean, default: false,   desc: "Force overwrite of existing files and git repository. Use with caution."
+
+        # call method for the init command
+        def call(site_path:, **options)
+
+          # initialize a new site object, this does all sorts of validations and checks, raises errors if something is wrong
+          new_site = Geb::Site.new
+
+          # validate the site
+          new_site.validate(site_path, options[:template], options[:skip_template], options[:force])
+
+          # validate proposed git repository in the site path if we are not skipping git, will raise error if git situation is unacceptable
+          Geb.log "Skipping git repository validation as told." if options[:skip_git]
+          Geb::Git.validate_git_repo(site_path) unless options[:skip_git]
+
+          # create the site folder and populate it with the template if we are not skipping the whole process
+          new_site.create
+
+          # create the git repository if we are not skipping git
+          Geb.log "Skipping git repository creation as told." if options[:skip_git]
+          Geb::Git.create_git_repo(site_path) unless options[:skip_git]
+
+        rescue Geb::Error => e
+
+          # print error message
+          puts
+          warn e.message
+
+        end # def call
+
+        # ::: Methods ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
+      end # class Init < Dry::CLI::Command
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/commands/release.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Release command definition, based on Dry::CLI framework
+# Builds the site into the release directory with optional template archive
+#
+# @title Geb - Release Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @todo Consider some option or check to see if the release would override previous release --with_template
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+module Geb
+  module CLI
+    module Commands
+
+      # Define release command
+      class Release < Dry::CLI::Command
+
+        # Command description, usage and examples
+        desc "Builds the release version of the site (pages and assets)"
+        example [" ", "--with_template"]
+
+        # Define command options
+        option :with_template,  type: :boolean, default: false, desc: "Build the release site with a template archive so you can share it."
+
+        # Call method for the release command
+        def call(**options)
+
+          # initialise a new site and load the site from the current directory
+          site = Geb::Site.new
+          site.load(Dir.pwd)
+
+          # create a new release for the site
+          site.release()
+
+          # bundle the site with a template archive if the with_template option is set
+          site.bundle_template() if options[:with_template]
+
+        rescue Geb::Error => e
+
+          # print error message
+          puts
+          warn e.message
+
+        end # def call
+
+      end # class Release < Dry::CLI::Command
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/commands/remote.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# Remote command definition, based on Dry::CLI framework
+# Just a proxy for the ssh command
+#
+# @title Geb - Remote Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+module Geb
+  module CLI
+    module Commands
+
+      # Define remote command
+      class Remote < Dry::CLI::Command
+
+        # Command description, usage and examples
+        desc "Launch remote ssh session using the config file settings"
+        example [" "]
+
+        # Define command options
+
+        # Call method for the remote command
+        def call(*)
+
+          # initialise a new site and load the site from the current directory
+          site = Geb::Site.new
+          site.load(Dir.pwd)
+
+          # launch the remote session
+          site.launch_remote()
+
+        rescue Geb::Error => e
+
+          # print error message
+          puts
+          warn e.message
+
+        end # def call
+
+      end # class Remote < Dry::CLI::Command
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/commands/server.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+#
+# Build command definition, based on Dry::CLI framework
+# Run a webrick http server to view the site output, it optionally monitors
+# for file changes and rebuilds the site when a file changes.
+#
+# @title Geb - Remote Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+module Geb
+  module CLI
+    module Commands
+
+      # Define server command
+      class Server < Dry::CLI::Command
+
+        # Command description, usage and examples
+        desc "Start a local server to view the site output (runs build first), uses webrick"
+        example [" ", "--port 8080", "--skip_auto_build", "--skip_build"]
+
+        # Define command options
+        option :port,             type: :int,     default: 0,     desc: "Port to run the server on, otherwise it will use config file setting"
+        option :skip_build,       type: :boolean, default: false, desc: "Skip building the site before starting the server"
+        option :skip_auto_build,  type: :boolean, default: false, desc: "Don't automatically rebuild the site when a file changes"
+
+        # Call method for the server command
+        # @param options [Hash] the options hash for the command
+        def call(**options)
+
+          # initialise a site and load it from the current directory
+          site = Geb::Site.new
+          site.load(Dir.pwd)
+
+          # build the site if the skip_build option is not set
+          site.build() unless options[:skip_build]
+
+          # start a new queue for the shutdown signal (instead of using trap to shutdown the server and file watcher directly)
+          @shutdown_queue = Queue.new
+          trap('INT') { @shutdown_queue << :shutdown }
+
+          # get the server port from the options, site configuration or auto generated (0), in that order
+          server_port = options[:port] || site.site_config.local_port || 0
+
+          # initialize the server
+          server = Geb::Server.new(site, server_port, !options[:skip_auto_build])
+
+          # start the server
+          server.start()
+
+          # wait for the shutdown signal
+          @shutdown_queue.pop
+
+          # stop the server
+          server.stop()
+
+        rescue Geb::Error => e
+
+          # print error message
+          puts
+          warn e.message
+
+        end # def call
+
+        # Force shutdown of the server
+        def force_shutdown
+          @shutdown_queue << :shutdown if @shutdown_queue
+        end # force_shutdown
+
+      end # class Server < Dry::CLI::Command
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/commands/upload.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# Upload command definition, based on Dry::CLI framework
+# Upload the site to a remote server
+#
+# @title Geb - Upload Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+module Geb
+  module CLI
+    module Commands
+
+      # Define upload command
+      class Upload < Dry::CLI::Command
+
+        # Command description, usage and examples
+        desc "Upload the site to the remote server"
+        example [" "]
+
+        # Define command options
+
+        # Call method for the remote command
+        def call(*)
+
+          # initialise a new site and load the site from the current directory
+          site = Geb::Site.new
+          site.load(Dir.pwd)
+
+          # check if the site has been released before uploading
+          site.upload_release_to_remote()
+
+        rescue Geb::Error => e
+
+          # print error message
+          puts
+          warn e.message
+
+        end # def call
+
+      end # class Upload < Dry::CLI::Upload
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/commands/version.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+#
+# Version command definition, based on Dry::CLI framework
+# Prints the current version of the Geb
+#
+# @title Geb - Version Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+module Geb
+  module CLI
+    module Commands
+
+      # Define version command
+      class Version < Dry::CLI::Command
+
+        # Command description, usage and examples
+        desc "Print version"
+        example [" "]
+
+        # Call method for the version command
+        def call(*)
+
+          # Print the version
+          puts "Geb version #{Geb::VERSION}"
+
+        end # def call
+
+      end # class Version < Dry::CLI::Command
+
+    end # module Commands
+  end # module CLI
+end # module Geb

data/lib/geb/config.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+#
+# Geb configuration.  It merges the geb.yml configuration file with the defaults.
+#
+# @title Geb - Command Registry
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+# include the required libraries
+require 'yaml'
+
+module Geb
+  class Config
+
+    class ConfigFileNotFound < Geb::Error
+      MESSAGE = "Could not find geb config file.".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class ConfigFileNotFound < Geb::Error
+
+    # check if the site directory specified has the required geb.config.yml file
+    def self.site_directory_has_config?(site_path)
+      File.exist?(File.join(site_path, Geb::Defaults::SITE_CONFIG_FILENAME))
+    end # def self.site_directory_has_config?
+
+    # initialize the site configuration\
+    # @param site [Geb::Site] the site object
+    # @raise ConfigFileNotFound if the site directory has no geb.config.yml file
+    def initialize(site)
+
+      # set the site path
+      @site = site
+
+      # make sure the site directory has the required geb.config.yml file
+      raise ConfigFileNotFound.new("Site path [#{@site.site_path}] has no geb configuration.") unless Geb::Config.site_directory_has_config?(@site.site_path)
+
+      # load the site configuration, if no configuration is found in the file, set it to an empty hash
+      @config = YAML.load_file(File.join(@site.site_path, Geb::Defaults::SITE_CONFIG_FILENAME))
+      @config ||= {}
+
+    end # def initialize
+
+    # get the configured site name, if not set, use the site directory name
+    # @return [String] the site name
+    def site_name
+      return @config['site_name'] || File.basename(@site.site_path)
+    end # def site_name
+
+    # get the configured remote uri
+    # @return [String] the remote uri
+    def remote_uri
+      return @config['remote_uri'] || nil
+    end # def remote_uri
+
+    # get the configured remote path
+    # @return [String] the remote path
+    def remote_path
+      return @config['remote_path'] || nil
+    end # def remote_path
+
+    # get the configured local port
+    # @return [Integer] the local port
+    def local_port
+      return @config['local_port'] || nil
+    end # def local_port
+
+    # get the configured output directory
+    # @return [String] the output directory
+    # @note the assets directory is relative to the site root
+    def output_dir
+      return @config['output_dir'] || Geb::Defaults::OUTPUT_DIR
+    end # def output_dir
+
+    # get the configured assets directory
+    # @return [String] the assets directory
+    # @note the assets directory is relative to the site root
+    def assets_dir
+      return @config['assets_dir'] || Geb::Defaults::ASSETS_DIR
+    end # def assets_dir
+
+    # get the configured page extensions
+    # @return [Array] the page extensions
+    def page_extensions
+      return @config['page_extensions'] || Geb::Defaults::PAGE_EXTENSIONS
+    end # def page_extensions
+
+    # get the configured template and partial identifier
+    # @return [Regexp] the template and partial identifier
+    def template_and_partial_identifier
+      return @config['template_and_partial_identifier'] || Geb::Defaults::TEMPLATE_AND_PARTIAL_IDENTIFIER
+    end # def template_and_partial_identifier
+
+    # get the configured template paths
+    # @return [Array] the template paths
+    # @note the template paths are relative to the site root
+    def template_paths
+      return @config['template_paths'] || []
+    end # def template_paths
+
+  end # class Config
+end # module Geb

data/lib/geb/defaults.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+#
+# A simple list of defaults for the Geb gem
+#
+# @title Geb - Defaults
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+# include the required libraries
+require 'fileutils'
+
+module Geb
+  module Defaults
+
+    # default values for site templates
+    TEMPLATE_ARCHIVE_FILENAME = 'geb-template.tar.gz'             # default the template archive filename
+    AVAILABLE_TEMPLATES       =                                   # list of bundled templates (first one is the default template)
+      ['bootstrap_jquery', 'basic']
+    SITE_CONFIG_FILENAME      = 'geb.config.yml'                  # site config file name
+    HTTP_TEMPLATE_CONTENT_TYPES =                               # acceptable remote template content types
+      ['application/x-gzip', 'application/gzip', 'application/octet-stream']
+    BUNDLED_TEMPLATES_DIR     =                                   # bundled template directory
+      File.join(__dir__, 'samples')
+    DEFAULT_TEMPLATE_DIR      =                                   # default template directory
+      File.join(BUNDLED_TEMPLATES_DIR, AVAILABLE_TEMPLATES.first)
+    DEFAULT_TEMPLATE          =                                   # default template
+      AVAILABLE_TEMPLATES.first
+
+    # default values for site configuration (all paths are relative to the site root)
+    OUTPUT_DIR                = 'output'                          # output directory  (relative to site root)
+    LOCAL_OUTPUT_DIR          = 'local'                           # local output directory (relative to output directory)
+    RELEASE_OUTPUT_DIR        = 'release'                         # release output directory (relative to output directory)
+    ASSETS_DIR                = 'assets'                          # location for assets (images, js and css)
+
+    # default values for site pages
+    PAGE_EXTENSIONS           =                                   # list of file extention to treat as pages
+      ['.md', '.markdown', '.html', '.htm', '.txt', '.js', '.css']
+    TEMPLATE_AND_PARTIAL_IDENTIFIER  = /^_/                       # filename pattern for templates or partials
+
+  end # module Defaults
+end # module Geb

data/lib/geb/git.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+#
+# Simple set of git utilities used by the cli commands
+#
+# @title Geb - Git
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+# include the required libraries
+require 'tmpdir'
+require 'open3'
+require 'shellwords'
+
+module Geb
+  module Git
+
+    class FailedValidationError < Geb::Error
+      MESSAGE = "Could not evaluate if the specified SITE_PATH is within a git repository, please choose a different location or use the --skip_git option.".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class FailedValidationError < Geb::Error
+
+    class InsideGitRepoError < Geb::Error
+      MESSAGE = "You are already inside a git repository, please choose a different location or use the --skip_git option.".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class InsideGitRepoError < Geb::Error
+
+    class GitError < Geb::Error
+      MESSAGE = "An error occurred while executing a git command.".freeze
+      def initialize(e = ""); super(e, MESSAGE); end
+    end # class GitError < Geb
+
+    # ::: Class Methods ::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
+    # validate if the proposed directory is a git repository, raise an error if it is
+    # or if the directory is inside a git repository
+    # @param site_directory [String] the proposed site directory
+    # @raise [FailedValidationError] if the directory could not be evaluated
+    # @raise [InsideGitRepoError] if the directory is inside a git repository
+    # @raise [GitError] if an error occurred while executing the git command
+    # @return [void]
+    def self.validate_git_repo(site_directory)
+
+      Geb.log_start "Validating proposed site path as a git repository ... "
+
+      # initialize the closest directory to the site directory that actually exists
+      closest_existing_directory = site_directory
+
+
+      # find the closest existing directory
+      until Dir.exist?(closest_existing_directory)
+        closest_existing_directory = File.dirname(closest_existing_directory)
+      end # until
+
+      # raise an error if we reached the root directory
+      raise FailedValidationError if closest_existing_directory == '/'
+
+      # perform the git check in the closest existing directory
+      _, stderr, status = Open3.capture3("cd #{Shellwords.shellescape(closest_existing_directory)} && git rev-parse --is-inside-work-tree")
+
+      # check if the error message is that the directory is not in a git repository
+      raise InsideGitRepoError if status.success?
+
+      # the above git command will fail if the directory is not in a git repository (we want that)
+      # raise error for all other errors
+      raise FailedValidationError.new(stderr.chomp) unless stderr.include?("not a git repository")
+
+      Geb.log "done."
+
+    end # def self.validate_git_repo(site_directory)
+
+    # Create a new git repository in the specified folder. It also creates a .gitignore file
+    # @param site_directory [String] the proposed site directory
+    # @raise [GitError] if an error occurred while executing the git command
+    # @return [void]
+    def self.create_git_repo(site_directory)
+
+      Geb.log_start "Initialising git repository ... "
+
+      # initialize the git repository
+      _, stderr, status = Open3.capture3("git -C #{Shellwords.shellescape(site_directory)} init")
+
+      # raise an error if the git command failed
+      raise GitError.new(stderr.chomp) unless status.success?
+
+      # attempt to create a .gitignore file
+      begin
+
+        # create a .gitignore file
+        File.open(File.join(site_directory, '.gitignore'), 'w') do |f|
+
+          # ignore everything withint the output folder
+          f.puts "/output"
+          f.puts "/.DS_Store"
+
+        end # File.open
+
+      rescue StandardError => e
+
+        # raise an error if the gitignore file could not be created
+        raise GitError.new("Could not create .gitignore file: #{e.message}")
+
+      end # begin ... rescue
+
+      Geb.log "done."
+
+    end # def self.create_git_repo
+
+  end # module Git
+end # module Geb