charsi 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68bef40ef4cf1b6c65db0027a9df2ea6d788821d599aea4ee1682543fd11b38e
-  data.tar.gz: 9f3f4f5acda8d2bc23fab91591857cdc032099d12c32567f8519f91a4ac4e66f
+  metadata.gz: e4894331787c5775e21343e7942bffc421d433638749553e57922234f56fba97
+  data.tar.gz: 1b3346e7494836267395d5d66ae8ad5bed4cbeaf2124d03e81257152a580b035
 SHA512:
-  metadata.gz: f29a0ff3a07e0043db88b04a9de7d51dc8301b639249fad95a9a3855f9e18498d1a9a6790b5bd2d736daca1c7182ab34b3e9d8904ca5ad6af093b3509775a3b0
-  data.tar.gz: 545bf0905a06d7174e3373aaeb72ce82cf51399debc26f3c54068e6b5f3c746c865483801d52342b090e831a9615ff08a5cba704a46d72c9dbb5734f408782a4
+  metadata.gz: 5caa649097f056fda5ac9ed8ed9e282320e638d9db2723cc76619e51d7d575d7c8dcdcea6373abf8fc6fe7148b33097e276856e0f5a719d46e36c446f252522f
+  data.tar.gz: 41283471f53d8495fdd907f325ea08cebb0f0ac28bf6ade7d861a838655b1a2a6e0f67f446c69b7fb981856c65660b2266a3ffde54f9ad9e0c502cde0afdcdc7

data/Gemfile

@@ -5,8 +5,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in charsi.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
-gem 'terser', '~> 1.2'
+gem 'rake',     '~> 13.0'
+gem 'minitest', '~> 5.0', group: :development
 gem 'tilt', '~> 2.6'
 gem 'tailwindcss-ruby', '~> 4.1'
-gem 'filewatcher', '~> 2.0'
+gem 'filewatcher', '~> 3.0'

data/Gemfile.lock

@@ -1,37 +1,69 @@
 PATH
   remote: .
   specs:
-    charsi (0.1.0)
-      filewatcher (~> 2.1)
+    charsi (0.1.5)
+      filewatcher (~> 3.0)
       logger (~> 1.6)
       tailwindcss-ruby (~> 4.1)
-      terser (~> 1.2)
       tilt (~> 2.6)
+      webrick (~> 1.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    execjs (2.10.0)
-    filewatcher (2.1.0)
-      module_methods (~> 0.1.0)
+    filewatcher (3.0.1)
+      logger (~> 1.7)
+      module_methods (~> 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)
+    minitest (5.27.0)
+    module_methods (1.0.0)
+    rake (13.3.1)
+    tailwindcss-ruby (4.2.1)
+    tailwindcss-ruby (4.2.1-aarch64-linux-gnu)
+    tailwindcss-ruby (4.2.1-aarch64-linux-musl)
+    tailwindcss-ruby (4.2.1-arm64-darwin)
+    tailwindcss-ruby (4.2.1-x64-mingw-ucrt)
+    tailwindcss-ruby (4.2.1-x86_64-darwin)
+    tailwindcss-ruby (4.2.1-x86_64-linux-gnu)
+    tailwindcss-ruby (4.2.1-x86_64-linux-musl)
+    tilt (2.7.0)
+    webrick (1.9.2)
 
 PLATFORMS
-  x86_64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm64-darwin
+  ruby
+  x64-mingw-ucrt
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
   charsi!
-  filewatcher (~> 2.0)
+  filewatcher (~> 3.0)
+  minitest (~> 5.0)
   rake (~> 13.0)
   tailwindcss-ruby (~> 4.1)
-  terser (~> 1.2)
   tilt (~> 2.6)
 
+CHECKSUMS
+  charsi (0.1.5)
+  filewatcher (3.0.1) sha256=b0f51e568cf112f72392053ae5ff5afa267592489091ee9f93c20fc275597f5a
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
+  module_methods (1.0.0) sha256=92f28a9254b8c1a7f4e68aa52242ecabdac3343ce41909aac3fcc3bf2ac8ec5e
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  tailwindcss-ruby (4.2.1) sha256=95886a1e24b42d76792c787d34e47098b53cb3b5a6363845bca4486f52b2e66a
+  tailwindcss-ruby (4.2.1-aarch64-linux-gnu) sha256=de457ddfc999c6bbbe1a59fbc11eb2168d619f6e0cb72d8d3334d372b331e36f
+  tailwindcss-ruby (4.2.1-aarch64-linux-musl) sha256=e6ed27704263201f8366316354aa45f9016cc9378ce8fac46fbbe65fafd4da5e
+  tailwindcss-ruby (4.2.1-arm64-darwin) sha256=bcf222fb8542cf5433925623e5e7b257897fbb8291a2350daae870a32f2eeb91
+  tailwindcss-ruby (4.2.1-x64-mingw-ucrt) sha256=607b948a63262391e35081d6f06b9f9757bb151461195423736249cae7b32c2c
+  tailwindcss-ruby (4.2.1-x86_64-darwin) sha256=b737b84f80941628d03c703b31abb204151b9d0a494d58ed06fd8220a5162f1b
+  tailwindcss-ruby (4.2.1-x86_64-linux-gnu) sha256=201d0e5e5d4aba52cae4ee4bd1acd497d2790c83e7f15da964aab8ec93876831
+  tailwindcss-ruby (4.2.1-x86_64-linux-musl) sha256=79fa48ad51e533545f9fdbb04227e1342a65a42c2bd1314118b95473d5612007
+  tilt (2.7.0) sha256=0d5b9ba69f6a36490c64b0eee9f6e9aad517e20dcc848800a06eb116f08c6ab3
+  webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131
+
 BUNDLED WITH
-   2.6.9
+  4.0.6

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs    << 'lib'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/charsi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name    = 'charsi'
-  spec.version = '0.1.3'
+  spec.version = '0.1.5'
 
   spec.authors = ['Ryan Beasse']
   spec.email   = ['me@ryanbeasse.com']
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/rbeasse/charsi'
   spec.license  = 'MIT'
 
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.metadata['homepage_uri']    = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -18,16 +18,17 @@ Gem::Specification.new do |spec|
   # 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])
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[test/ .git .github .devcontainer])
     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 'filewatcher', '~> 3.0'
   spec.add_dependency 'logger', '~> 1.6'
   spec.add_dependency 'webrick', '~> 1.9'
+
+  spec.add_development_dependency 'minitest', '~> 5.0'
 end

data/lib/charsi/app.rb

@@ -15,12 +15,12 @@ module Charsi
 
     protected
 
-    def stylesheet_tag(asset)
-      "<link rel='stylesheet' href='assets/css/#{asset}?#{@cache_slug}'>"
+    def stylesheet_tag(asset, **attributes)
+      "<link rel='stylesheet' href='assets/css/#{asset}?#{@cache_slug}'#{html_attributes(attributes)}>"
     end
 
-    def javascript_tag(asset)
-      "<script src='assets/javascript/#{asset}?#{@cache_slug}'></script>"
+    def javascript_tag(asset, **attributes)
+      "<script src='#{javascript_src(asset)}'#{html_attributes(attributes)}></script>"
     end
 
     def render_partial(partial_name, **locals)
@@ -32,6 +32,18 @@ module Charsi
 
     private
 
+    def javascript_src(asset)
+      if asset.is_a?(Symbol)
+        "assets/vendor/#{asset}.js?#{@cache_slug}"
+      else
+        "assets/javascript/#{asset}?#{@cache_slug}"
+      end
+    end
+
+    def html_attributes(attributes)
+      attributes.map { |attribute, value| " #{attribute}='#{value}'" }.join
+    end
+
     def load_helpers
       helpers_path = @config.path(:helpers_dir)
 

data/lib/charsi/asset.rb

@@ -1,21 +1,21 @@
 module Charsi
   # Itterates each assets, processes them, and copies them to the output directory.
-  #
-  # JavaScript and CSS files are minified.
   class Asset
+    UNPKG_BASE = 'https://unpkg.com/'.freeze
+
     def initialize(config)
       @config = config
     end
 
     def build
+      build_vendor
+
       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)
@@ -24,6 +24,20 @@ module Charsi
 
     private
 
+    def build_vendor
+      @config.vendor.each do |key, package_path|
+        cache_path  = @config.path(:cache_dir, 'vendor', "#{key}.js")
+        output_path = @config.path(:output_dir, 'assets', 'vendor', "#{key}.js")
+
+        Charsi::FileManagement.cached(cache_path) do |path|
+          puts "[charsi] Downloading vendor: #{key}"
+          Charsi::FileManagement.download("#{UNPKG_BASE}#{package_path}", path)
+        end
+
+        Charsi::FileManagement.copy(cache_path, output_path)
+      end
+    end
+
     def process_tailwind(asset, destination_path)
       commands  = [Tailwindcss::Ruby.executable]
       commands += ['-i', asset, '-o', destination_path, '--minify']
@@ -31,11 +45,5 @@ module Charsi
 
       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/configuration.rb

@@ -13,13 +13,17 @@ module Charsi
       File.join(Dir.pwd, config_path, *keys)
     end
 
+    def vendor
+      @config.fetch('vendor', {})
+    end
+
 
     private
 
     def app_config
       app_config_path = File.join(Dir.pwd, CONFIG_FILE)
 
-      YAML.load_file(app_config_path)
+      YAML.safe_load_file(app_config_path)
     end
   end
 end

data/lib/charsi/file.rb

@@ -19,5 +19,15 @@ module Charsi
       FileUtils.rm_rf(output_dir) if Dir.exist?(output_dir)
       FileUtils.mkdir_p(output_dir)
     end
+
+    def self.download(url, destination)
+      write(destination, URI.open(url, &:read)) # rubocop:disable Security/Open
+    rescue OpenURI::HTTPError => error
+      raise "[charsi] Failed to download #{url} — #{error.message}"
+    end
+
+    def self.cached(path)
+      File.exist?(path) ? path : yield(path)
+    end
   end
 end

data/lib/charsi/generator.rb

@@ -5,7 +5,7 @@ module Charsi
       templates_dir  = File.join(__dir__, '../../templates', template)
       templates_glob = File.join(templates_dir, '**', '*.template')
 
-      Dir.glob(templates_glob).each do |template|
+      Dir.glob(templates_glob, File::FNM_DOTMATCH).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)

data/lib/charsi.rb

@@ -1,7 +1,7 @@
 require 'erb'
 require 'fileutils'
+require 'open-uri'
 require 'tilt'
-require 'terser'
 require 'tailwindcss/ruby'
 require 'yaml'
 require 'filewatcher'

data/templates/site/.devcontainer/devcontainer.json.template

@@ -0,0 +1,12 @@
+{
+  "name": "<%= project_title %>",
+  "image": "mcr.microsoft.com/devcontainers/ruby:4",
+  "postCreateCommand": "bundle install",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "shopify.ruby-lsp"
+      ]
+    }
+  }
+}

data/templates/site/CLAUDE.md.template

@@ -0,0 +1,102 @@
+# <%= project_title %>
+
+This is a [Charsi](https://github.com/rbeasse/charsi) static site. Charsi is a simple Ruby static site generator that compiles ERB views, processes Tailwind CSS, and copies assets to a build directory.
+
+## Commands
+
+```bash
+bundle exec charsi build           # build the site to _build/
+bundle exec charsi build --watch   # build and watch for changes
+bundle exec charsi serve           # build and serve at http://localhost:8000
+bundle exec charsi serve --watch   # serve with live rebuilding on changes
+```
+
+## Project structure
+
+```
+layouts/        ERB layouts — default.erb wraps all views via yield
+views/          ERB views — each .erb file becomes an .html page
+  _partial.erb  Partials are prefixed with _ and not compiled to pages
+assets/
+  css/          CSS files — tailwind.css is processed by the Tailwind binary
+  javascript/   JS files — copied as-is to _build/assets/javascript/
+helpers/        Ruby files auto-loaded and mixed into the template context
+config.yml      Project configuration
+tailwind.config.js  Tailwind configuration — content paths are pre-configured
+_build/         Build output — do not edit, regenerated on every build
+.charsi/        Charsi cache (vendor downloads) — do not edit or commit
+```
+
+## Views and layouts
+
+Views are ERB files in `views/`. Each becomes a page at the same name:
+- `views/index.erb` → `_build/index.html`
+- `views/about.erb` → `_build/about.html`
+
+The default layout in `layouts/default.erb` wraps every view. Use `yield` where the view content should appear.
+
+Partials live in `views/` prefixed with `_` and are rendered via `render_partial`:
+
+```erb
+<%%= render_partial('header') %>
+<%%= render_partial('card', title: 'Hello', body: 'World') %>
+```
+
+Locals passed to `render_partial` are available as variables in the partial.
+
+## Coding style
+
+- Write clear, readable code — use full descriptive names, avoid shorthand or single-letter variables
+- No inline JavaScript or CSS — JS belongs in `assets/javascript/`, styles in `assets/css/`
+- Use Tailwind classes for styling whenever possible — only write custom CSS when Tailwind cannot achieve it or when explicitly asked
+- Keep views focused on structure — logic belongs in helpers or partials
+
+## Template helpers
+
+These methods are available in all views and layouts:
+
+```erb
+<%%= stylesheet_tag('tailwind.css') %>
+<%%= stylesheet_tag('tailwind.css', media: 'print') %>
+
+<%%= javascript_tag('app.js') %>
+<%%= javascript_tag('app.js', type: 'module', defer: true) %>
+<%%= javascript_tag(:stimulus) %>   <%# references a vendor library by key %>
+```
+
+## Tailwind CSS
+
+The `assets/css/tailwind.css` file is the Tailwind entry point. It is processed by the Tailwind binary and minified. Use Tailwind classes directly in ERB files — `tailwind.config.js` is already configured to scan `views/` and `layouts/`.
+
+## Vendor JS
+
+Third-party JS libraries can be declared in `config.yml` under `vendor:`. Charsi downloads them from [unpkg.com](https://unpkg.com) and caches them in `.charsi/vendor/`. They are copied to `_build/assets/vendor/` on every build.
+
+```yaml
+vendor:
+  stimulus: "@hotwired/stimulus/dist/stimulus.js"
+  alpine:   "alpinejs/dist/cdn.js"
+```
+
+Reference them in templates with a symbol:
+
+```erb
+<%%= javascript_tag(:stimulus, type: 'module') %>
+```
+
+## Custom helpers
+
+Any `.rb` file in `helpers/` is automatically required and its methods become available in all views and layouts. Define helper methods as module-level methods:
+
+```ruby
+# helpers/format_helper.rb
+def format_date(date)
+  date.strftime('%B %d, %Y')
+end
+```
+
+Then use them directly in ERB:
+
+```erb
+<%%= format_date(Time.now) %>
+```

data/templates/site/config.yml.template

@@ -1,5 +1,6 @@
 paths:
   output_dir: '_build'
+  cache_dir:  '.charsi'
   layout_dir: 'layouts'
   assets_dir: 'assets'
   views_dir:  'views'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charsi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Ryan Beasse
@@ -9,20 +9,6 @@ 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
@@ -57,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 email:
 - me@ryanbeasse.com
 executables:
@@ -104,6 +104,7 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
 - bin/charsi
 - charsi.gemspec
 - lib/charsi.rb
@@ -115,6 +116,8 @@ files:
 - lib/charsi/generator.rb
 - lib/charsi/server.rb
 - lib/charsi/template.rb
+- templates/site/.devcontainer/devcontainer.json.template
+- templates/site/CLAUDE.md.template
 - templates/site/Gemfile.template
 - templates/site/assets/css/tailwind.css.template
 - templates/site/assets/javascript/app.js.template
@@ -135,14 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Simple static site generator.
 test_files: []