slimview 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 492f4ca1ae763a6bdeca63357861cbf17816717e5fb7e488845cea73c9162ae7
+  data.tar.gz: c4ff4d48bd84127875aeb75e95f91b366e7ae5c45ee83b18f86ff11f72ae56b2
+SHA512:
+  metadata.gz: a642281c5d19fea3be9e5bdce0abb49c2ce503ca361313f3bf8491e05bf9752a8ee343b2ffd455424df3392d23a0583f266fd91ded177313f5cf6f3deb4d05d7
+  data.tar.gz: 826f6a2e7edf508e2b29252c94d56509e9d6336448cbc9e66a4cae1b92adefe33fa14e347a44c25b936790391c0bdc1eb951214020c8b167a37f335901cb5753

data/README.md

@@ -0,0 +1,84 @@
+# 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/).
+
+## Features
+
+- Instantly preview `.slim` templates in your browser
+- Minimal setup - just point to a folder and go
+- Automatically reloads templates in development
+- Configurable port and root directory via flags or environment variables
+
+
+## Installation
+
+```bash
+gem install slimview
+```
+
+Or add it to your `Gemfile`:
+
+```ruby
+gem 'slimview'
+```
+
+
+## Command-Line Usage
+
+```bash
+$ 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
+
+Environment Variables:
+  SLIMVIEW_PORT   Set the port (default: 3000)
+  SLIMVIEW_ROOT   Set the root templates directory (default: ./templates)
+```
+
+Example:
+
+```bash
+# Serve Slim templates from ./templates at http://localhost:3000
+slimview
+
+# Serve from another folder on port 8080
+slimview --root app/views --port 8080
+```
+
+## Ruby API Usage
+
+You can also use Slimview programmatically from Ruby:
+
+```ruby
+require 'slimview'
+
+# Start the server with default port 3000 and default 'templates' root
+Slimview.new.start
+
+# Customize port and templates root
+server = Slimview.new port: 4000, root: 'views/slim'
+server.start
+
+# Pass locals (available as variables inside your Slim templates)
+server = Slimview.new items: ['one', 'two'], title: 'Hello'
+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.
+- 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

data/bin/slimview

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+args = ARGV.dup
+
+if args.include?('--help') || args.include?('-h')
+  puts <<~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
+
+    Environment Variables:
+      SLIMVIEW_ROOT   Set the root templates directory
+      SLIMVIEW_PORT   Set the port
+
+  HELP
+  exit
+end
+
+require 'slimview'
+
+if args.include?('--version') || args.include?('-v')
+  puts Slimview::VERSION
+  exit
+end
+
+port = nil
+root = nil
+
+if i = args.index '--port'
+  port = args[i + 1]
+end
+
+if i = args.index '--root'
+  root = args[i + 1]
+end
+
+port = port.to_i if port
+
+server = Slimview.new port: port, root: root
+server.start

data/lib/slimview/version.rb

@@ -0,0 +1,3 @@
+class Slimview
+  VERSION = '0.2.0'
+end

data/lib/slimview.rb

@@ -0,0 +1,42 @@
+require 'sinatra/base'
+require 'slim'
+
+class Slimview
+  def initialize(port: nil, root: nil, **locals)
+    @port = port || ENV['SLIMVIEW_PORT']&.to_i || 3000
+    @root = root || ENV['SLIMVIEW_ROOT'] || 'templates'
+    @locals = locals
+  end
+
+  def start = app.run!
+
+private
+
+  def app = @app ||= app!
+
+  def app!
+    root = @root
+    port = @port
+    locals = @locals
+
+    Class.new Sinatra::Base do
+      Slim::Engine.set_options pretty: true
+
+      set :bind, '0.0.0.0'
+      set :port, port
+      set :views, root
+      set :public_folder, File.join(settings.root, 'assets')
+      set :environment, :development
+      set :reload_templates, true
+
+      get '/*' do
+        page = params[:splat].first
+        page = 'index' if page.empty?
+        slim_path = File.join settings.views, "#{page}.slim"
+        halt 404, "Template not found: #{page}" unless File.exist? slim_path
+
+        slim page.to_sym, locals: locals
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: slimview
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Command-line tool and library for quickly previewing Slim templates in
+  a local web server
+email: db@dannyben.com
+executables:
+- slimview
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/slimview
+- lib/slimview.rb
+- lib/slimview/version.rb
+homepage: https://github.com/DannyBen/slimview
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dannyben/slimview/issues
+  changelog_uri: https://github.com/dannyben/slimview/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/dannyben/slimview
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Instant Slim Template Server
+test_files: []