alister 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0d1ba1fe8f39f425a504f7e02454b0182b7ba51673c63482fc51ab9c28e6260
+  data.tar.gz: 4bb178fcfd4f5fc2c12347392e578db460f50924a158ed87518a451a9b43c677
+SHA512:
+  metadata.gz: 2d3cf3db9d806285fdef30115824650ca7dfe74e5b6ec19482c6a0b0bbcacfd1c15cd44000a4924f5dd42bc1cf720328dcf1b76626f59f693b0346887a9ccbc0
+  data.tar.gz: cbfc01a0d65870d5648ec1377b4f05c36ceed89e26d41fdf352c5c11a3d35adda63a84633c79cadf51472a680e087959dd9d074aad55ab3368e174dc14d87d8d

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Released]
+
+## [1.0.0] - 2025-08-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Alister
+
+A super minimal ruby solution to static site generation. This gem allows you to create a static site whilst writing almost purely ruby!
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add alister
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install alister
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/lain62/alister. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lain62/alister/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Alister project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lain62/alister/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/alister/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Alister
+  VERSION = '1.0.0'
+end

data/lib/alister.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "alister/version"
+require_relative 'html/html'
+require_relative 'site'
+require_relative 'assets'
+require_relative 'self'
+
+# An SSG (Static Site Generator) helper that allows you to easily create a site
+# @example A simple site
+#   root_page = Alister.html do
+#     doctype
+#     html lang: "en" do
+#       head do
+#         meta charset: "utf-8"
+#         meta name: "viewport", content: "width=device-width, initial-scale=1"
+#       end
+#       body do
+#         div id: "app" do
+#           p "hello world"
+#         end
+#       end
+#   end
+#   s = Alister::Site.new
+#   s.route "/", root_page
+#   s.build "./build"
+module Alister
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/assets.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'webp-ffi'
+
+module Alister
+  # @example Simple asset building
+  #   a = Alister::Assets.new
+  #   a.source "./assets/"
+  #   a.file "**/*"
+  #   a.build_to "./build/assets/"
+  # @example Convert all png to webp
+  #   a = Alister::Assets.new
+  #   a.source "./assets/"
+  #   a.file "*.png"
+  #   a.enable_webp_conversion
+  #   a.build "./build/assets/gallery/"
+  # @example Multiple sources and specific files
+  #   a = Alister::Assets.new
+  #   a.source "./"
+  #   a.files "robots.txt", "main.css"
+  #   a.build_and_reset "./build/assets/gallery/"
+  #   a.source "./assets/"
+  #   a.file "*.png"
+  #   a.enable_webp_conversion
+  #   a.build_and_reset "./build/assets/gallery/"
+  # An asset builder that helps with putting website asset files into the correct place
+  class Assets
+    # All supported image filetype that can be converted to .webp
+    WEBP_EXTS = %w[.png .jpg .jpeg .tiff].freeze
+    def initialize
+      @source_path = nil
+      @build_path = nil
+      @webp_conversion = false
+      @excludes = nil
+      @files = nil
+      @source_files = nil
+    end
+
+    # Enables turning all suitable images into webp when building
+    # @return [void]
+    def enable_webp_conversion
+      @webp_conversion = true
+    end
+
+    # Exclude certain folders from being built
+    # @return [void]
+    def excludes(*args)
+      if args.size == 1
+        @excludes = args.first
+        nil
+      else
+        @excludes = args
+      end
+    end
+
+    alias exclude excludes
+
+    # Defines the files that will be included in the build
+    # @return [void]
+    def files(*args)
+      if args.size == 1
+        @files = args.first
+        nil
+      else
+        @files = args
+      end
+    end
+
+    alias file files
+
+    # Builds the assets
+    # @return [void]
+    def build_to(build_path)
+      raise '[ERROR] Files are empty' if @files.nil?
+      raise '[ERROR] Source is empty' if @source_path.nil?
+
+      @build_path = build_path
+
+      glob_source_files
+      remove_excludes unless @excludes.nil?
+      ensure_folders_are_built_first
+      build_da_thing
+    end
+
+    alias build build_to
+
+    # Defines the source of the files
+    # @return [void]
+    def source_from(source_path)
+      @source_path = source_path
+    end
+
+    alias source source_from
+
+    # Resets the builder for another building
+    # @return [void]
+    def reset
+      @source_path = nil
+      @build_path = nil
+      @webp_conversion = false
+      @excludes = nil
+      @files = nil
+      @source_files = nil
+    end
+
+    # Shorthand for building and resetting at the same time
+    # @return [void]
+    def build_to_and_reset(build_path)
+      build_to(build_path)
+      reset
+    end
+
+    alias build_and_reset build_to_and_reset
+
+    private
+
+    def build_da_thing
+      files = @source_files.select { |f| File.file? f }
+      if @webp_conversion
+        files.each do |file|
+          if WEBP_EXTS.include? File.extname(file)
+            convert_webp(file)
+          else
+            copy(file)
+          end
+        end
+      else
+        files.each do |file|
+          copy(file)
+        end
+      end
+    end
+
+    def convert_webp(file)
+      output = convert_output_to_webp(file)
+      WebP.encode(file, output)
+      puts "[Log] Converting #{file} to #{output}"
+    end
+
+    def convert_output_to_webp(file)
+      name = File.basename(file, File.extname(file))
+      new_file_path = change_starting_folders(file, @source_path, @build_path)
+      dir = File.dirname(new_file_path)
+      "#{File.join(dir, name)}.webp"
+    end
+
+    def copy(file)
+      name = File.basename(file)
+      path = change_starting_folders(file, @source_path, @build_path)
+      path = File.dirname path
+      FileUtils.cp(file, path)
+      puts "[Log] Copying #{file} to #{File.join(@build_path, name)}"
+    end
+
+    def glob_source_files
+      if @files.is_a? Array
+        @source_files = []
+        @files.each do |file|
+          files = Dir.glob(File.join(@source_path, file))
+          @source_files.concat(files).uniq!
+        end
+      else
+        @source_files = Dir.glob(File.join(@source_path, @files))
+      end
+    end
+
+    def remove_excludes
+      excludes = @excludes.map { |x| File.join(@source_path, x) }
+      @source_files.reject! { |x| x.start_with?(*excludes) }
+    end
+
+    def ensure_build_folder_is_empty
+      return unless File.directory? @build_path
+
+      FileUtils.rm_rf(@build_path, secure: true)
+      puts "[Log] #{@build_path} directory found, deleting"
+    end
+
+    def ensure_folders_are_built_first
+      folders = @source_files.select { |x| File.directory? x }
+
+      folders.each do |folder|
+        File.join(@build_path, File.join(*(folder.split('/') - @source_path.split('/'))))
+        path = change_starting_folders(folder, @source_path, @build_path)
+        FileUtils.mkdir_p(path)
+        puts "[Log] Creating folder #{path}"
+      end
+    end
+
+    def change_starting_folders(path, what_to_remove, what_to_insert)
+      File.join(what_to_insert, File.join(*(path.split('/') - what_to_remove.split('/'))))
+    end
+  end
+end

data/lib/html/builder.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Alister
+  module HTML
+    # All the html tags
+    # @note p is reserved by ruby, use para instead
+    TAGS = %i[html body div span applet object iframe
+              h1 h2 h3 h4 h5 h6 para blockquote pre
+              a abbr acronym address big cite code del
+              dfn em img ins kbd q s samp small
+              strike strong sub sup tt var b u i
+              center meta dl dt dd ol ul li fieldset
+              form label legend table caption tbody tfoot
+              thead tr th td article aside canvas details
+              embed figure figcaption footer header hgroup
+              menu nav output ruby section summary time
+              mark audio video script head title link].freeze
+
+    # An HTML Builder class
+    # @example Creating a simple html
+    #   builder = Alister::Builder.new
+    #   builder.start do
+    #     doctype
+    #     html lang: "en" do
+    #       head do
+    #         meta charset: "utf-8"
+    #         meta name: "viewport", content: "width=device-width, initial-scale=1"
+    #       end
+    #       body do
+    #         div id: "app"
+    #       end
+    #     end
+    #   end
+    class Builder
+      # All the elements that has been collected
+      # @return [Array<Element>]
+      attr_reader :elements
+
+      def initialize
+        @elements = []
+      end
+
+      # @note only use if you're using {Builder} directly
+      # @yield Starts an html block
+      def start(&block)
+        block.call
+      end
+
+      TAGS.each do |tag|
+        define_method(tag) do |value = nil, **args, &block|
+          @elements << Element.new(id: Element::TAG_START, value: tag.to_s)
+          args&.each_key do |key|
+            @elements << Element.new(id: Element::ATTR, value: { key: key, value: args[key] })
+          end
+
+          if !block.nil?
+            @elements << Element.new(id: Element::VALUE_BLOCK)
+            block.call
+            @elements << Element.new(id: Element::TAG_END, value: tag.to_s)
+          elsif !value.nil?
+            @elements << Element.new(id: Element::VALUE_LIT, value: value)
+            @elements << Element.new(id: Element::TAG_END, value: tag.to_s)
+          else
+            @elements << Element.new(id: Element::VALUE_NIL, value: nil)
+          end
+        end
+      end
+
+      # Creates a <!DOCTYPE html> element and puts it to {#elements}.
+      # @return [void]
+      def doctype
+        @elements << Element.new(id: Element::DOCTYPE, value: nil)
+      end
+
+      # Adds a partial element and puts it to {#elements}
+      # @param element [Builder, Element, String, Array<Builder, Element, String>] Basically anything that can convert to string tbh
+      # @return [void]
+      def partial(element)
+        @elements << element.elements if element.is_a? Builder
+        @elements << element if element.is_a?(Element) || element.is_a?(String)
+
+        return unless element.is_a? Array
+
+        element.each do |el|
+          partial(el)
+        end
+      end
+
+      # Combines all elements, and turn it into a single string
+      # @return [String]
+      def to_s
+        @elements.flatten!
+        @elements.map(&:to_s).join
+      end
+    end
+  end
+end

data/lib/html/element.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Alister
+  module HTML
+    # Create a part of an element like puzzle pieces
+    # @note this isn't meant to be used directly, you need multiple of these to create a full <p>foo</p>
+    class Element
+      # Creates "<tag" on {#to_s}
+      TAG_START = :tag_start
+      # Creates "</tag>\n" on {#to_s}
+      TAG_END = :tag_end
+      # Creates ">\n" on {#to_s}
+      VALUE_BLOCK = :value_block
+      # Creates ">value" on {#to_s}
+      VALUE_LIT = :value_lit
+      # Creates  "/>\n" on {#to_s}
+      VALUE_NIL = :value_nil
+      # Creates "<!DOCTYPE html>\\n" on {#to_s}
+      DOCTYPE = :doctype
+      # Creates " key=\"value\"" on {#to_s}
+      ATTR = :attributes
+
+      # @note Look up {Element} Constants for the value of id
+      # @return [Symbol]
+      attr_accessor :id
+
+      # @return [String, void]
+      attr_accessor :value
+
+      # @param id [Symbol] Look up {Element} Constants for the value of id
+      # @param value [String, void]
+      def initialize(id:, value: nil)
+        @id = id
+        @value = value
+        @value = 'p' if [TAG_START, TAG_END].include?(id) && value == 'para'
+      end
+
+      # Creates a string from part of an element
+      # Depends on {#id} on what it will return
+      # Look for {Element} Constants for returns
+      # @return [String]
+      def to_s
+        case @id
+        when TAG_START
+          tag_start
+        when TAG_END
+          tag_end
+        when VALUE_BLOCK
+          value_block
+        when VALUE_LIT
+          value_lit
+        when VALUE_NIL
+          value_nil
+        when ATTR
+          attribute
+        end
+      end
+
+      private
+
+      def doctype
+        "<!DOCTYPE html>\n"
+      end
+
+      def value_nil
+        "/>\n"
+      end
+
+      def tag_start
+        "<#{@value}"
+      end
+
+      def tag_end
+        "</#{@value}>\n"
+      end
+
+      def value_block
+        ">\n"
+      end
+
+      def value_lit
+        ">#{@value}"
+      end
+
+      def attribute
+        key = @value[:key].to_s.gsub('_', '-')
+        " #{key}=\"#{@value[:value]}\""
+      end
+    end
+  end
+end

data/lib/html/generate_yard_tags.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# THIS IS JUST TO GENERATE YARD TAGS, IGNORE
+
+require_relative 'builder'
+
+str = +"# frozen_string_literal: true\n\n"
+str << "module Alister\n"
+str << "  module HTML\n"
+str << "    class Builder\n\n"
+Alister::HTML::TAGS.each do |tag|
+  str << "      # @!method #{tag}(value = nil, **args, &block)\n"
+  tag = :p if tag == :para
+  str << "      #   Creates a <#{tag}> element and puts it to {#elements}\n"
+  str << "      #   @param value [String] The value of the element\n"
+  str << "      #   @param args [Hash] The attributes of the element\n"
+  str << "      #   @return [void]\n"
+  str << "      #   @yield Create child elements of <#{tag}>\n"
+  str << "\n"
+end
+str << "    end\n"
+str << "  end\n"
+str << "end\n"
+
+File.delete('./yard_tags.rb') if File.exist? './yard_tags.rb'
+file = File.new('./yard_tags.rb', 'w+')
+file.write(str)
+file.close
+puts '[LOG] Created yard_tags.rb'

data/lib/html/html.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'builder'
+require_relative 'element'
+
+module Alister
+  # Module for creating HTML strings using ruby methods
+  module HTML; end
+end