slimview 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dedf9869b30963a26ede0f0321d8306ca389bb7689726ad6e56b5dac0956cb6
-  data.tar.gz: 2d38bf535f127f9aac501c4f5be967314cec3643445ee2b5d0b353170a718c4b
+  metadata.gz: 0aa3ca8b36a79be2250688b865b106e9dd39661f23f356b58a16fb66ee1992f6
+  data.tar.gz: a149f31b69c9d97d8cf651499197ece2f59aaf6fe03e16a5039d8c658d89282f
 SHA512:
-  metadata.gz: 4182b5be878c07f1150418342d3fd9c589a580ed3660a45b995d7d17a95095df918a0381ea37e6f6d15e66ee4cc34bce495835f6dc0a832fd249968e9ea90cd7
-  data.tar.gz: 32d63537999fedce6a8edfe9dd1072776386e89a3407152d0080acc6b415b464bc1e1b8398dc1388013764223b3bd303a39607973f533cb7d66ac1dbb77292a7
+  metadata.gz: 23067f0a79d9f69fb2846ef9139bbfe45d08db67483baeaddfe6bc197788f3bd5e9b670644485c07c7bcb06e2022ff14d9869353a2e864991dda2e58661f7fdb
+  data.tar.gz: 5d3a0cecc4178cb0c060c7fd919a7152243f9893a59b3f40ccde205eb3365581c6f079ade74aecc1fe8588dd184b882826f99f4945e9c0d4abaec11727018b1f

data/README.md

@@ -1,6 +1,10 @@
 # Slimview
 
-A lightweight command-line tool and Ruby library for quickly previewing [Slim](https://slim-template.github.io/) templates in a local web server powered by [Sinatra](https://sinatrarb.com/).
+![repocard](https://repocard.dannyben.com/svg/slimview.svg)
+
+A lightweight command-line tool and Ruby library for quickly previewing
+[Slim](https://slim-template.github.io/) templates in a local web server
+powered by [Sinatra](https://sinatrarb.com/).
 
 ## Features
 
@@ -8,6 +12,8 @@ A lightweight command-line tool and Ruby library for quickly previewing [Slim](h
 - Minimal setup - just point to a folder and go
 - Automatically reloads templates in development
 - Configurable port and root directory via flags or environment variables
+- Automatically wraps views with `layout.slim` when present
+- Render partial Slim templates via `== slim :other_template`
 
 
 ## Installation
@@ -22,6 +28,27 @@ Or add it to your `Gemfile`:
 gem 'slimview'
 ```
 
+### Docker
+
+Slimview is also available as a docker image:
+
+```shell
+docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/slimview
+```
+
+or as a docker compose service:
+
+```yaml
+services:
+  web:
+    build: .
+    image: dannyben/slimview
+    volumes: ["./:/docs"]
+    ports: ["3000:3000"]
+```
+
+[View image on Docker Hub](https://hub.docker.com/r/dannyben/slimview)
+
 
 ## Command-Line Usage
 
@@ -31,14 +58,17 @@ $ slimview --help
 Usage: slimview [options]
 
 Options:
-  --port PORT     Set the port to run the server on (default: 3000)
-  --root PATH     Set the root templates directory (default: ./templates)
-  --help, -h      Show this help message
-  --version, -v   Print version info
+  --port PORT       Set the port to run the server on (default: 3000)
+  --root PATH       Set the root templates directory (default: ./templates)
+  --assets PATH     Set the assets directory (default: <root>/assets)
+  --help, -h        Show this help message
+  --version, -v     Print version info
 
 Environment Variables:
-  SLIMVIEW_PORT   Set the port (default: 3000)
-  SLIMVIEW_ROOT   Set the root templates directory (default: ./templates)
+  SLIMVIEW_PORT     Set the port
+  SLIMVIEW_ROOT     Set the root templates directory
+  SLIMVIEW_ASSETS   Set the assets directory
+
 ```
 
 Example:
@@ -49,6 +79,12 @@ slimview
 
 # Serve from another folder on port 8080
 slimview --root app/views --port 8080
+
+# Serve with a custom assets directory
+slimview --root app/views --assets public/assets
+
+# Use environment variables instead of flags
+SLIMVIEW_ASSETS=public/assets SLIMVIEW_ROOT=app/views slimview
 ```
 
 ## Ruby API Usage
@@ -65,6 +101,10 @@ Slimview::Server.new.start
 server = Slimview::Server.new port: 4000, root: 'views/slim'
 server.start
 
+# Override the assets directory
+server = Slimview::Server.new root: 'views/slim', assets: 'public/assets'
+server.start
+
 # Pass locals (available as variables inside your Slim templates)
 server = Slimview::Server.new items: ['one', 'two'], title: 'Hello'
 server.start
@@ -73,12 +113,10 @@ server.start
 
 ## Notes
 
-- Templates are served from the directory specified by `--root` (or `SLIMVIEW_ROOT`).
-- Static files (images, CSS, JS) can be placed in an `assets/` subfolder.
+- Templates are served from the directory specified by `--root`
+  (or `SLIMVIEW_ROOT`).
+- Static files (images, CSS, JS) can be placed in an `assets/` directory and
+  overridden via `--assets` or `SLIMVIEW_ASSETS`.
 - Slim templates are automatically reloaded on each request in development mode.
-- The tool is intended for **local development and previewing**, not for production use.
-
-
-## License
-
-MIT License © 2025
+- The tool is intended for **local development and previewing**, not for
+  production use.

data/bin/slimview

@@ -6,14 +6,16 @@ if args.include?('--help') || args.include?('-h')
     Usage: slimview [options]
 
     Options:
-      --port PORT     Set the port to run the server on (default: 3000)
-      --root PATH     Set the root templates directory (default: ./templates)
-      --help, -h      Show this help message
-      --version, -v   Print version info
+      -p, --port PORT     Set the port to run the server on (default: 3000)
+      -r, --root PATH     Set the root templates directory (default: ./templates)
+      -a, --assets PATH   Set the assets directory (default: <root>/assets)
+      -h, --help          Show this help message
+      -v, --version       Print version info
 
     Environment Variables:
-      SLIMVIEW_ROOT   Set the root templates directory
-      SLIMVIEW_PORT   Set the port
+      SLIMVIEW_PORT     Set the port
+      SLIMVIEW_ROOT     Set the root templates directory
+      SLIMVIEW_ASSETS   Set the assets directory
 
   HELP
   exit
@@ -28,16 +30,22 @@ end
 
 port = nil
 root = nil
-
-if (i = args.index '--port')
-  port = args[i + 1]
+assets = nil
+
+def fetch_arg(args, *flags)
+  flags.each do |flag|
+    if (index = args.index(flag))
+      return args[index + 1]
+    end
+  end
+  nil
 end
 
-if (i = args.index '--root')
-  root = args[i + 1]
-end
+port = fetch_arg(args, '--port', '-p')
+root = fetch_arg(args, '--root', '-r')
+assets = fetch_arg(args, '--assets', '-a')
 
 port = port.to_i if port
 
-server = Slimview::Server.new port: port, root: root
+server = Slimview::Server.new port: port, root: root, assets: assets
 server.start

data/lib/slimview/app.rb

@@ -3,7 +3,7 @@ require 'slim'
 
 module Slimview
   class App < Sinatra::Base
-    def self.configure!(root:, port:, locals:)
+    def self.configure!(root:, port:, assets:, locals:)
       Slim::Engine.set_options pretty: true
 
       views_path = File.expand_path(root, Dir.pwd)
@@ -12,7 +12,7 @@ module Slimview
       set :port, port
       set :views, views_path
       set :root, File.expand_path('.')
-      set :public_folder, File.join(settings.root, 'assets')
+      set :public_folder, assets
       set :environment, :development
       set :reload_templates, true
       set :protection, except: :host_authorization

data/lib/slimview/server.rb

@@ -1,12 +1,13 @@
 module Slimview
   class Server
-    def initialize(port: nil, root: nil, **locals)
+    def initialize(port: nil, root: nil, assets: nil, **locals)
       @port = port || ENV['SLIMVIEW_PORT']&.to_i || 3000
       @root = root || ENV['SLIMVIEW_ROOT'] || 'templates'
+      @assets = assets || ENV['SLIMVIEW_ASSETS'] || "#{@root}/assets"
       @locals = locals
     end
 
     def start = app.run!
-    def app = App.configure!(root: @root, port: @port, locals: @locals)
+    def app = App.configure!(port: @port, root: @root, assets: @assets, locals: @locals)
   end
 end

data/lib/slimview/version.rb

@@ -1,3 +1,3 @@
 module Slimview
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimview
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: Command-line tool and library for quickly previewing Slim templates in
   a local web server
 email: db@dannyben.com
@@ -101,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Instant Slim Template Server
 test_files: []