charsi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1f4d275d1e0160a13c59583ba73d13718c6010935543c5dd9281b97071b4a4b
+  data.tar.gz: 4f85f65b66740a9f6bfe9c1f3204ed8f50a3fe8509facd150698c3c1dd65beb6
+SHA512:
+  metadata.gz: ca51e1d73a4d3aed16d2ea3c72ab1638c38c035b68c3bc93ead2e1b85fe84b36dca66d2ed05d0dc4c6c111349fa79a05478d3debaf2fba0a73efd58d0715f4fb
+  data.tar.gz: f278453dca7038b2b10a3ea3c4750243c9138864b28ca3833b3aab55e263ddab7092da003f1939fca3d7c078c1fc5db311da3bbf42821c51e7797b27c016eea5

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in charsi.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'terser', '~> 1.2'
+gem 'tilt', '~> 2.6'
+gem 'tailwindcss-ruby', '~> 4.1'
+gem 'filewatcher', '~> 2.0'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    charsi (0.1.0)
+      filewatcher (~> 2.1)
+      logger (~> 1.6)
+      tailwindcss-ruby (~> 4.1)
+      terser (~> 1.2)
+      tilt (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    execjs (2.10.0)
+    filewatcher (2.1.0)
+      module_methods (~> 0.1.0)
+    logger (1.7.0)
+    module_methods (0.1.0)
+    rake (13.3.0)
+    tailwindcss-ruby (4.1.11-x86_64-linux-gnu)
+    terser (1.2.6)
+      execjs (>= 0.3.0, < 3)
+    tilt (2.6.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  charsi!
+  filewatcher (~> 2.0)
+  rake (~> 13.0)
+  tailwindcss-ruby (~> 4.1)
+  terser (~> 1.2)
+  tilt (~> 2.6)
+
+BUNDLED WITH
+   2.6.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ryan Beasse
+
+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,29 @@
+# Charsi
+
+A static site generator for Ruby.
+
+## Usage
+
+### Build the site
+
+Run the static site generator:
+
+```bash
+bundle exec charsi build
+```
+
+### Watch for changes
+
+Run the static site generator with file watching:
+
+```bash
+bundle exec charsi build --watch
+```
+
+### Create a new project
+
+Generate a new Charsi project:
+
+```bash
+bundle exec charsi new <project_name>
+```

data/bin/charsi

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'charsi'
+
+command = ARGV[0]
+watch_flag = ARGV.include?('--watch')
+
+if command == 'build'
+  charsi = Charsi::Builder.new
+  
+  charsi.build
+  charsi.watch if watch_flag
+elsif command == 'new'
+  project_name = ARGV[1]
+  
+  raise ArgumentError, 'Project name is required' if project_name.nil?
+
+  Charsi::Generator.generate(project_name)
+else
+  puts 'Usage: charsi build [--watch]'
+end

data/charsi.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |spec|
+  spec.name    = 'charsi'
+  spec.version = '0.1.0'
+
+  spec.authors = ['Ryan Beasse']
+  spec.email   = ['me@ryanbeasse.com']
+
+  spec.summary  = 'Simple static site generator.'
+  spec.homepage = 'https://github.com/rbeasse/charsi'
+  spec.license  = 'MIT'
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+
+  spec.executables << 'charsi'
+
+  spec.add_dependency 'terser', '~> 1.2'
+  spec.add_dependency 'tilt', '~> 2.6'
+  spec.add_dependency 'tailwindcss-ruby', '~> 4.1'
+  spec.add_dependency 'filewatcher', '~> 2.1'
+  spec.add_dependency 'logger', '~> 1.6'
+end

data/lib/charsi/app.rb

@@ -0,0 +1,23 @@
+module Charsi
+  # Standard app class.
+  #
+  # This class is used to build the app. It includes all utility methods to be acccessed through the
+  # templating.
+  class App
+    attr_reader :cache_slug
+
+    def initialize
+      @cache_slug = Time.now.to_i
+    end
+
+    protected
+
+    def stylesheet_tag(asset)
+      "<link rel='stylesheet' href='assets/css/#{asset}?#{@cache_slug}'>"
+    end
+
+    def javascript_tag(asset)
+      "<script src='assets/javascript/#{asset}?#{@cache_slug}'></script>"
+    end
+  end
+end

data/lib/charsi/asset.rb

@@ -0,0 +1,41 @@
+module Charsi
+  # Itterates each assets, processes them, and copies them to the output directory.
+  #
+  # JavaScript and CSS files are minified.
+  class Asset
+    def initialize(config)
+      @config = config
+    end
+
+    def build
+      assets_path = @config.path(:assets_dir, '**', '*.*')
+      
+      Dir.glob(assets_path).each do |asset|
+        extension        = File.extname(asset)
+        destination_dir  = @config.path(:output_dir, 'assets')
+        destination_path = asset.sub(@config.path(:assets_dir), destination_dir)
+
+        next process_javascript(asset, destination_path)  if extension == '.js'
+        next process_tailwind(asset, destination_path) if asset.include?('tailwind.css')
+
+        Charsi::FileManagement.copy(asset, destination_path)
+      end
+    end
+
+    private
+
+    def process_tailwind(asset, destination_path)
+      commands  = [Tailwindcss::Ruby.executable]
+      commands += ['-i', asset, '-o', destination_path, '--minify']
+      commands += ['--config', 'tailwind.config.js']
+
+      system(*commands)
+    end
+
+    def process_javascript(asset, destination_path)
+      processed_asset = Terser.compile(File.read(asset))
+
+      Charsi::FileManagement.write(destination_path, processed_asset)
+    end
+  end
+end

data/lib/charsi/builder.rb

@@ -0,0 +1,41 @@
+module Charsi
+  # Builds the application and handles file watching for changes.
+  class Builder
+    def initialize
+      @app    = defined?(::App) ? ::App.new : Charsi::App.new
+      @config = Configuration.new
+    end
+
+    def build
+      start_time = Time.now
+
+      Charsi::FileManagement.reset_output_dir(@config.path(:output_dir))
+      Charsi::Asset.new(@config).build
+      Charsi::Template.new(@app, @config).build
+
+      puts "[charsi] Build completed in #{Time.now - start_time} seconds."
+    end
+
+    def watch
+      Filewatcher.new(watch_paths).watch do |changes|
+        changes.each do |filename, event|
+          puts "[charsi][#{event}] #{filename}"
+        end
+        
+        build
+      end
+    rescue Interrupt
+      puts "\n[charsi] Done watching."
+    end
+
+    private
+
+    def watch_paths
+      [
+        @config.path(:assets_dir), 
+        @config.path(:views_dir), 
+        @config.path(:layout_dir)
+      ]
+    end
+  end
+end

data/lib/charsi/configuration.rb

@@ -0,0 +1,24 @@
+module Charsi
+  # Handles configuration for the Charsi application.
+  class Configuration
+    CONFIG_FILE = 'config.yml'.freeze
+
+    def initialize
+      @config ||= app_config
+    end
+
+    def path(config_key, *keys)
+      config_path = @config.dig('paths', config_key.to_s)
+
+      File.join(Dir.pwd, config_path, *keys)
+    end
+
+    private
+
+    def app_config
+      app_config_path = File.join(Dir.pwd, CONFIG_FILE)
+
+      YAML.load_file(app_config_path)
+    end
+  end
+end

data/lib/charsi/file.rb

@@ -0,0 +1,23 @@
+module Charsi
+  # Tools for working with file operations.
+  class FileManagement
+    def self.write(path, content)
+      destination_folder = File.dirname(path)
+
+      FileUtils.mkdir_p(destination_folder)
+      File.write(path, content)
+    end
+
+    def self.copy(path, destination)
+      destination_folder = File.dirname(destination)
+
+      FileUtils.mkdir_p(destination_folder)
+      FileUtils.cp(path, destination)
+    end
+
+    def self.reset_output_dir(output_dir)
+      FileUtils.rm_rf(output_dir) if Dir.exist?(output_dir)
+      FileUtils.mkdir_p(output_dir)
+    end
+  end
+end

data/lib/charsi/generator.rb

@@ -0,0 +1,35 @@
+module Charsi
+  # The Generator class is responsible for creating new Charsi projects from our template.
+  class Generator
+    def self.generate(project, template: 'site')
+      templates_dir  = File.join(__dir__, '../../templates', template)
+      templates_glob = File.join(templates_dir, '**', '*.template')
+
+      Dir.glob(templates_glob).each do |template|
+        output_path = template.delete_prefix(templates_dir)
+        output_path = output_path.delete_suffix('.template')
+        output_path = File.join(Dir.pwd, project, output_path)
+        
+        processed_template = parse_erb(template, project)
+
+        puts "[charsi] #{output_path}"
+
+        Charsi::FileManagement.write(output_path, processed_template)
+      end
+
+      puts "\n[charsi] Created new static site: #{project}"
+    end
+    
+    private
+    
+    def self.titleize(string)
+      string.split(/_|-/).map(&:capitalize).join(' ')
+    end
+
+    def self.parse_erb(template_path, project)
+      template = Tilt::ERBTemplate.new(template_path)
+      
+      template.render(nil, project_title: titleize(project))
+    end
+  end
+end

data/lib/charsi/template.rb

@@ -0,0 +1,35 @@
+module Charsi
+  # Itterates over all views and builds them into the output directory.
+  #
+  # Each view is created with a layout. The default layout is `default.erb`.
+  class Template
+    def initialize(app, config)
+      @app    = app
+      @config = config
+    end
+
+    def build
+      views_path = @config.path(:views_dir, '*.erb')
+      
+      Dir.glob(views_path).each do |view|
+        output_file = File.basename(view, '.erb') + '.html'
+        output_path = @config.path(:output_dir, output_file)
+
+        processed_view = parse_erb_with_layout(view)
+
+        Charsi::FileManagement.write(output_path, processed_view)
+      end
+    end
+
+    private
+
+    def parse_erb_with_layout(view_path, layout: 'default.erb')
+      layout_path = @config.path(:layout_dir, layout)
+
+      layout = Tilt::ERBTemplate.new(layout_path)
+      view   = Tilt::ERBTemplate.new(view_path)
+
+      layout.render(@app) { view.render(@app) }
+    end
+  end
+end

data/lib/charsi.rb

@@ -0,0 +1,17 @@
+require 'erb'
+require 'fileutils'
+require 'tilt'
+require 'terser'
+require 'tailwindcss/ruby'
+require 'yaml'
+require 'filewatcher'
+
+module Charsi
+  require 'charsi/configuration'
+  require 'charsi/file'
+  require 'charsi/template'
+  require 'charsi/asset'
+  require 'charsi/app'
+  require 'charsi/builder'
+  require 'charsi/generator'
+end

data/templates/site/Gemfile.template

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'charsi'

data/templates/site/assets/css/tailwind.css.template

@@ -0,0 +1,58 @@
+@import "tailwindcss";
+
+@theme {
+  --color-catppuccin-rosewater: #f5e0dc;
+  --color-catppuccin-flamingo: #f2cdcd;
+  --color-catppuccin-pink: #f5c2e7;
+  --color-catppuccin-mauve: #cba6f7;
+  --color-catppuccin-red: #f38ba8;
+  --color-catppuccin-maroon: #eba0ac;
+  --color-catppuccin-peach: #fab387;
+  --color-catppuccin-yellow: #f9e2af;
+  --color-catppuccin-green: #a6e3a1;
+  --color-catppuccin-teal: #94e2d5;
+  --color-catppuccin-sky: #89dceb;
+  --color-catppuccin-sapphire: #74c7ec;
+  --color-catppuccin-blue: #89b4fa;
+  --color-catppuccin-lavender: #b4befe;
+  --color-catppuccin-text: #cdd6f4;
+  --color-catppuccin-subtext1: #bac2de;
+  --color-catppuccin-subtext0: #a6adc8;
+  --color-catppuccin-overlay2: #9399b2;
+  --color-catppuccin-overlay1: #7f849c;
+  --color-catppuccin-overlay0: #6c7086;
+  --color-catppuccin-surface2: #585b70;
+  --color-catppuccin-surface1: #45475a;
+  --color-catppuccin-surface0: #313244;
+  --color-catppuccin-base: #1e1e2e;
+  --color-catppuccin-mantle: #181825;
+  --color-catppuccin-crust: #11111b;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  @apply font-bold text-catppuccin-sky;
+}
+
+h1 {
+  @apply text-3xl border-b border-catppuccin-sky;
+}
+
+h2 {
+  @apply text-2xl;
+}
+
+h3 {
+  @apply text-xl;
+}
+
+h4 {
+  @apply text-3xl;
+}
+
+h5 {
+  @apply text-2xl;
+}
+
+h6 {
+  @apply text-xl;
+}

data/templates/site/assets/javascript/app.js.template

@@ -0,0 +1 @@
+console.log('Hello world!');

data/templates/site/config.yml.template

@@ -0,0 +1,5 @@
+paths:
+  output_dir: '_build'
+  layout_dir: 'layouts'
+  assets_dir: 'assets'
+  views_dir:  'views'

data/templates/site/layouts/default.erb.template

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%=project_title%></title>
+    <%%= stylesheet_tag('tailwind.css') %>
+  </head>
+
+  <body class="bg-catppuccin-base">
+    <main class="container mx-auto px-6 py-8 font-sans text-catppuccin-text">
+      <%%= yield %>
+    </main>
+    
+    <%%= javascript_tag('app.js') %>
+  </body>
+</html>

data/templates/site/tailwind.config.js.template

@@ -0,0 +1,7 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: [
+    "./views/**/*.erb",
+    "./layouts/**/*.erb"
+  ],
+}

data/templates/site/views/index.erb.template

@@ -0,0 +1,2 @@
+<h1><%=project_title%></h1>
+<p class="text-lg mb-4">Simple static site generator written in Ruby.</p>

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: charsi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Beasse
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+email:
+- me@ryanbeasse.com
+executables:
+- charsi
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/charsi
+- charsi.gemspec
+- lib/charsi.rb
+- lib/charsi/app.rb
+- lib/charsi/asset.rb
+- lib/charsi/builder.rb
+- lib/charsi/configuration.rb
+- lib/charsi/file.rb
+- lib/charsi/generator.rb
+- lib/charsi/template.rb
+- templates/site/Gemfile.template
+- templates/site/assets/css/tailwind.css.template
+- templates/site/assets/javascript/app.js.template
+- templates/site/config.yml.template
+- templates/site/layouts/default.erb.template
+- templates/site/tailwind.config.js.template
+- templates/site/views/index.erb.template
+homepage: https://github.com/rbeasse/charsi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rbeasse/charsi
+  source_code_uri: https://github.com/rbeasse/charsi
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Simple static site generator.
+test_files: []