staticz 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e625da7c786a60e0b0f05046b81e750c35b850b18e5c337324324f10b9c3617e
-  data.tar.gz: ead9239fae7ac1d1e9d70ea0f9b2e26d61142db784414ff96dc654e897e3c399
+  metadata.gz: 7819fab696a446369d90aa66d4fd561dd4ad8b1d862f36a0f51ebe7035e2ffa1
+  data.tar.gz: a458e37b67fe7a8df4e23127f9f5dac7d121008a2112ae6b52c2e07a056a3277
 SHA512:
-  metadata.gz: 46792118d6680d1229ddd4e9a7b320cf5e8f33ced725530eb5713c9d0f13a532568e8efc08d728e5cfad7a175fa614fbd7fd513959c184c37102b9c6345849c3
-  data.tar.gz: 521439fd1a9f283427533332ef40bc35a34e01b211fb6c0cf323f921fd018dd8af3dd5af52641b078356942d4232298df55bbd49944b660b25d2cde8069eb635
+  metadata.gz: 972f53a183e511618034c267e5d4677697938d3975fef5264368d37f758b6166555e5c2c0f6d37de0df4e8adab3035753a8db5b80989ab2eee8876a4b0e3e19b
+  data.tar.gz: 017a30f95a0e30be6ad3f8cb8495df0bfb3ac580958503b3a08f261dd8548622d3dc91ee5e5a35d8dbefefc608fe763a6b5f76feec8cb9f267b023d1fda29665

data/lib/builder.rb

@@ -9,6 +9,16 @@ module Staticz
     end
 
     def build
+      if !manifest_exists?
+        puts "Manifest missing"
+        exit 1
+      end
+
+      if !src_folder_exists?
+        puts "src folder missing"
+        exit 1
+      end
+
       Staticz::Modules::LibLoader.load_files
 
       Dir.mkdir('build') unless File.exist?('build')
@@ -17,5 +27,15 @@ module Staticz
 
       Staticz::Manifest.instance.valid?
     end
+
+    private
+
+    def manifest_exists?
+      File.exist? "manifest.rb"
+    end
+
+    def src_folder_exists?
+      Dir.exist? "src"
+    end
   end
 end

data/lib/commands/new_command.rb

@@ -1,5 +1,6 @@
 require "tty-option"
-require_relative "../templates/default"
+require_relative "../templates/clean"
+require_relative "../templates/simple"
 require_relative "../templates/layout"
 
 module Staticz
@@ -18,19 +19,24 @@ module Staticz
       desc "The name to give the app. Decides how the folder is named"
     end
 
-    flag :help do
-      short "-h"
-      long "--help"
-      desc "Print this page"
-    end
-
     option :template do
       short "-t"
       long "--template name"
       desc "The template to use"
 
-      default "default"
-      permit %w[default layout]
+      default "clean"
+      permit %w[clean simple layout]
+    end
+
+    flag :with_gitignore do
+      long "--with-gitignore"
+      desc "Add basic .gitignore file"
+    end
+
+    flag :help do
+      short "-h"
+      long "--help"
+      desc "Print this page"
     end
 
     def run
@@ -46,6 +52,13 @@ module Staticz
 
       Object
         .const_get("Staticz::Templates::#{params[:template].capitalize}")
+        .tap do |template|
+          if params[:with_gitignore]
+            template.file ".gitignore", <<~GITIGNORE
+              build/
+            GITIGNORE
+          end
+        end
         .build(params[:name])
     end
   end

data/lib/manifest/compilable/{sassc.rb → scss.rb}

@@ -4,16 +4,27 @@ require_relative "../compilable"
 
 module Staticz
   module Compilable
-    class SassC
+    class Scss
       include Compilable
 
       attr_reader :name
 
-      compile "sass", "css", "Sass"
-
-      def initialize(name)
+      def initialize(name, type:)
         @name = name
         @warnings = []
+        @type = type
+      end
+
+      def source_file_ending
+        @type
+      end
+
+      def build_file_ending
+        "css"
+      end
+
+      def file_type_name
+        @type.capitalize
       end
 
       def build(listener_class: nil)

data/lib/manifest/css_bundle.rb

@@ -17,11 +17,11 @@ module Staticz
     end
 
     def sass(name, &block)
-      elements.push(Staticz::Compilable::SassC.new(generate_location_path(name)))
+      elements.push(Staticz::Compilable::Scss.new(generate_location_path(name), type: :sass))
     end
 
     def scss(name, &block)
-      elements.push(Staticz::Compilable::ScssC.new(generate_location_path(name)))
+      elements.push(Staticz::Compilable::Scss.new(generate_location_path(name), type: :scss))
     end
 
     def generate_location_path(name)

data/lib/manifest/manifest.rb

@@ -4,8 +4,7 @@ require_relative "compilable/haml"
 require_relative "compilable/cs"
 require_relative "compilable/js"
 require_relative "compilable/react"
-require_relative "compilable/sassc"
-require_relative "compilable/scssc"
+require_relative "compilable/scss"
 require_relative "compilable/simple_file"
 require_relative "js_bundle"
 require_relative "css_bundle"
@@ -33,11 +32,11 @@ module Staticz
     end
 
     def sass(name)
-      elements.push(Staticz::Compilable::SassC.new(name))
+      elements.push(Staticz::Compilable::Scss.new(name, type: :sass))
     end
 
     def scss(name)
-      elements.push(Staticz::Compilable::ScssC.new(name))
+      elements.push(Staticz::Compilable::Scss.new(name, type: :scss))
     end
 
     def js(name)
@@ -113,5 +112,11 @@ module Staticz
         e.print(0)
       end
     end
+
+    def index_missing?
+      elements.find do |e|
+        e.build_path == "build/index.html"
+      end.nil?
+    end
   end
 end

data/lib/manifest/sub.rb

@@ -18,11 +18,11 @@ module Staticz
     end
 
     def sass(name, &block)
-      elements.push(Staticz::Compilable::SassC.new("#{@name}/#{name}"))
+      elements.push(Staticz::Compilable::Scss.new("#{@name}/#{name}", type: :sass))
     end
 
     def scss(name, &block)
-      elements.push(Staticz::Compilable::ScssC.new("#{@name}/#{name}"))
+      elements.push(Staticz::Compilable::Scss.new("#{@name}/#{name}", type: :scss))
     end
 
     def js(name, &block)

data/lib/modules/reload.rb

@@ -10,11 +10,11 @@ module Staticz
       def self.build_reload_js
         <<~JS
           var hash = null;
-  
+
           function checkForChanges() {
             console.log("Check for file changes");
             var response = new XMLHttpRequest();
-            response.open("GET", "api/hash", true);
+            response.open("GET", "/api/hash", true);
             response.onload = function() {
               if (response.status === 200) {
                 if (!hash) {

data/lib/server.rb

@@ -32,8 +32,23 @@ module Staticz
             ]
           }
         end
+
         map "/" do
-          use Rack::Static, urls: {"/" => "build/index.html"}
+          if Staticz::Manifest.instance.index_missing?
+            use Rack::Static,
+              urls: {"/" => "get_started.html"},
+              root: File.join(File.dirname(__FILE__), "templates", "files")
+
+            use Rack::Static,
+              urls: {"/logo.png" => "logo.png"},
+              root: File.join(File.dirname(__FILE__), "templates", "files")
+
+            use Rack::Static,
+              urls: {"/bolt.png" => "bolt.png"},
+              root: File.join(File.dirname(__FILE__), "templates", "files")
+          else
+            use Rack::Static, urls: {"/" => "build/index.html"}
+          end
 
           Staticz::Server.all_haml(Staticz::Manifest.instance.elements).each do |e|
             use Rack::Static, urls: {"/#{e.name}" => e.build_path}

data/lib/staticz.rb

@@ -6,7 +6,7 @@ require_relative "commands/manifest_command"
 require_relative "commands/build_command"
 
 module Staticz
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 
   def self.init
     cmd, args = case ARGV[0]

data/lib/templates/clean.rb

@@ -0,0 +1,14 @@
+require_relative "template"
+
+module Staticz::Templates
+  class Clean
+    extend Staticz::Template
+
+    folders "src"
+
+    file "manifest.rb", <<~RUBY
+      Staticz::Manifest.define do
+      end
+    RUBY
+  end
+end

data/lib/templates/files/get_started.html

@@ -0,0 +1,201 @@
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+<meta charset='UTF-8'>
+<meta content='width=device-width, initial-scale=1' name='viewport'>
+<meta content='Get started with staticz' name='description'>
+<meta content='website, staticz' name='keywords'>
+<meta content='staticz.dev' property='og:site_name'>
+<meta content='Get started with staticz' property='og:title'>
+<meta content='Get started with staticz' property='og:description'>
+<meta content='website' property='og:type'>
+<meta content='https://staticz.dev/' property='og:url'>
+<meta content='Get started with staticz' property='og:title'>
+<link href='/bolt.png' rel='icon' type='image/x-icon'>
+<link href='https://fonts.googleapis.com' rel='preconnect'>
+<link crossorigin href='https://fonts.gstatic.com' rel='preconnect'>
+<link href='https://fonts.googleapis.com/css2?family=Jua&amp;family=Plus+Jakarta+Sans:ital,wght@0,200..800;1,200..800&amp;display=swap' rel='stylesheet'>
+<title>Get started with staticz</title>
+<script src="reload.js" defer></script>
+<style>
+  * {
+    box-sizing: border-box;
+  }
+
+  html, body {
+    padding: 0;
+    margin: 0;
+  }
+
+  body {
+    width: 100%;
+    min-height: 100vh;
+    overflow-x: hidden;
+    padding: 0.5rem;
+    padding-bottom: 2rem;
+    font-family: "Plus Jakarta Sans", sans-serif;
+  }
+
+  nav {
+    width: 100%;
+    padding: 0.125rem;
+    display: flex;
+    flex-direction: row;
+    justify-content: right;
+    align-items: center;
+    gap: 0.25rem;
+  }
+
+  .nav-link {
+    padding: 0.5rem 1rem;
+    color: rgb(51, 65, 85);
+    font-weight: bold;
+    text-decoration: none;
+    border-radius: 0.5rem;
+    transition: 150ms color, 150ms background-color;
+  }
+  .nav-link:hover {
+    color: rgb(91, 0, 255);
+    background-color: rgb(241, 245, 249);
+  }
+
+  header {
+    width: 100%;
+    max-width: 100%;
+    margin-top: 2rem;
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+  }
+
+  .header-logo {
+    width: 16rem;
+    max-width: 100%;
+  }
+
+  .header-name {
+    font-size: 2rem;
+    font-weight: bold;
+    font-family: "Jua";
+    background: -webkit-linear-gradient(180deg, rgb(255, 251, 69) 0%, rgb(240, 69, 229) 59%, rgb(91, 0, 255) 100%);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+  }
+
+  main {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+  }
+
+  code {
+    padding: 0.2rem 0.4rem;
+    background-color: rgb(226, 232, 240);
+    border-radius: 0.25rem;
+  }
+
+  .main-heading {
+    text-align: center;
+  }
+
+  .main-staticz {
+    font-weight: bold;
+    font-family: "Jua";
+    background: -webkit-linear-gradient(180deg, rgb(255, 251, 69) 0%, rgb(240, 69, 229) 59%, rgb(91, 0, 255) 100%);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+  }
+
+  .main-list {
+    display: grid;
+    grid-template-columns: 1fr auto;
+    gap: 1rem;
+  }
+
+  .main-list-number {
+    width: 4rem;
+    height: 4rem;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    font-size: 1.5rem;
+    font-family: "Jua";
+    background-color: rgb(241, 245, 249);
+    border-radius: 2rem;
+  }
+
+  .main-list-text {
+    max-width: 16rem;
+  }
+
+  .main-list-text-link {
+    color: rgb(91, 0, 255);
+    font-weight: bold;
+    text-decoration: none;
+    transition: 150ms color;
+  }
+  .main-list-text-link:hover {
+    color: rgb(240, 69, 229);
+  }
+</style>
+</head>
+<body>
+<nav>
+<a class='nav-link' href='https://staticz.philcomm.dev/' target='_blank'>Docs</a>
+<a class='nav-link' href='https://github.com/OfficialPhilcomm/staticz' target='_blank'>GitHub</a>
+<a class='nav-link' href='https://rubygems.org/gems/staticz' target='_blank'>RubyGems</a>
+</nav>
+<header>
+<img class='header-logo' src='/logo.png'>
+<div class='header-name'>staticz</div>
+</header>
+<main>
+<h1 class='main-heading'>
+Thank you for choosing
+<span class='main-staticz'>staticz</span>
+🎉
+</h1>
+<h2 class='main-heading'>First Steps</h2>
+<div class='main-list'>
+<div class='main-list-number'>1</div>
+<div class='main-list-text'>
+First, add an index file by adding
+<code>haml :index</code>
+to
+<code>manifest.rb</code>
+.
+Then create the file
+<code>src/index.haml</code>
+.
+This will be your index file and replaces this page.
+Careful, this page is only displayed if no index exists!
+</div>
+<div class='main-list-number'>2</div>
+<div class='main-list-text'>
+Add a stylesheet by adding
+<code>sass :style</code>
+to the manifest.
+Now create the file
+<code>src/style.sass</code>
+. As the last step, add
+<br>
+<code>= stylesheet style_path</code>
+<br>
+to your index's head tag.
+Et voilà! You have added a stylesheet.
+</div>
+<div class='main-list-number'>3</div>
+<div class='main-list-text'>
+There is many more things you can do now.
+To get a better overview, check out the
+<a class='main-list-text-link' href='https://staticz.philcomm.dev/' target='_blank'>
+docs!
+</a>
+There you'll find everything you need to kickstart your static website development with
+<span class='main-staticz'>staticz</span>
+!
+</div>
+</div>
+</main>
+</body>
+</html>

data/lib/templates/layout.rb

@@ -64,9 +64,5 @@ module Staticz::Templates
         padding: 0
         margin: 0
     SASS
-
-    file ".gitignore", <<~GITIGNORE
-      build/
-    GITIGNORE
   end
 end

data/lib/templates/{default.rb → simple.rb}

@@ -1,7 +1,7 @@
 require_relative "template"
 
 module Staticz::Templates
-  class Default
+  class Simple
     extend Staticz::Template
 
     folders "src", "src/css"
@@ -48,9 +48,5 @@ module Staticz::Templates
         padding: 0
         margin: 0
     SASS
-
-    file ".gitignore", <<~GITIGNORE
-      build/
-    GITIGNORE
   end
 end

data/lib/utils/helpers.rb

@@ -59,5 +59,5 @@ def react_component(name, css_class = nil)
 end
 
 def reload_js
-  "<script src=\"reload.js\" defer></script>" if Staticz::Settings.development?
+  "<script src=\"/reload.js\" defer></script>" if Staticz::Settings.development?
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staticz
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Philipp Schlesinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-15 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -185,8 +185,7 @@ files:
 - lib/manifest/compilable/haml.rb
 - lib/manifest/compilable/js.rb
 - lib/manifest/compilable/react.rb
-- lib/manifest/compilable/sassc.rb
-- lib/manifest/compilable/scssc.rb
+- lib/manifest/compilable/scss.rb
 - lib/manifest/compilable/simple_file.rb
 - lib/manifest/css_bundle.rb
 - lib/manifest/js_bundle.rb
@@ -197,8 +196,12 @@ files:
 - lib/server.rb
 - lib/settings.rb
 - lib/staticz.rb
-- lib/templates/default.rb
+- lib/templates/clean.rb
+- lib/templates/files/bolt.png
+- lib/templates/files/get_started.html
+- lib/templates/files/logo.png
 - lib/templates/layout.rb
+- lib/templates/simple.rb
 - lib/templates/template.rb
 - lib/utils/colors.rb
 - lib/utils/helpers.rb

data/lib/manifest/compilable/scssc.rb

@@ -1,83 +0,0 @@
-require "sass-embedded"
-require "pastel"
-require_relative "../compilable"
-
-module Staticz
-  module Compilable
-    class ScssC
-      include Compilable
-
-      attr_reader :name
-
-      compile "scss", "css", "Scss"
-
-      def initialize(name)
-        @name = name
-        @warnings = []
-      end
-
-      def build(listener_class: nil)
-        listener = listener_class&.new(self)
-
-        if valid?
-          File.write build_path, render
-
-          listener&.finish
-        else
-          listener&.error
-        end
-      end
-
-      def render
-        Sass.compile(source_path, style: :compressed, logger: Sass::Logger.silent).css
-      end
-
-      def errors
-        @_errors_cache ||= begin
-          errors = super
-
-          if exists?
-            begin
-              Sass.compile(source_path, style: :compressed, logger: Sass::Logger.silent).css
-            rescue => e
-              errors << e.message
-            end
-          end
-
-          errors
-        end
-      end
-
-      def debug(message, options)
-        warn(message, debug)
-      end
-
-      def warn(message, options)
-        pastel = Pastel.new
-
-        line = options.span.start.line + 1
-        start_index = options.span.start.column
-        end_index = options.span.end.column
-
-        @warnings << <<~WARNING
-          #{pastel.yellow.bold("Warning")}: #{message}
-
-          #{" " * line.to_s.size} #{pastel.blue("╷")}
-          #{pastel.blue(line)} #{pastel.blue("│")} #{pastel.red(options.span.context.strip)}
-          #{" " * line.to_s.size} #{pastel.blue("│")} #{" " * start_index}#{pastel.red("^" * (end_index - start_index))}
-          #{" " * line.to_s.size} #{pastel.blue("╵")}
-
-          #{options.stack}
-        WARNING
-      end
-
-      def warnings
-        if valid?
-          Sass.compile(source_path, style: :compressed, logger: self)
-        end
-
-        @warnings
-      end
-    end
-  end
-end