stir_fry 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a00e29a6a5328edd5213cd08821bd05627ac300c11bed5cc473a54059e63fc
-  data.tar.gz: d529099f09b0056ed4be196a62b0cfea2bcf99c2b0bb4c747116bcf92a8b16ba
+  metadata.gz: ed1a83ba5a7f03e897667e5bcbd985e9f41ba88a891713b4f7b030f7a117f80a
+  data.tar.gz: 71883f4158b897b0f15b16d465f4ceee3a0c94bd8e9ba47924ce467218a575f4
 SHA512:
-  metadata.gz: 59c837dd40c9dc13e80a8d467fd8ce1618cef3c8e4fc5e1dcffe25cc5faefcdb45bd22ffaaf5da531a9e9f6969e481ad8c1a7fcd0cf501c64194c3b516a5cbad
-  data.tar.gz: 97a6c2f514e52a7304f1900e802d4132ebeaac41ad623c1bcd00202fc1f476b286d6f2a2c825cf6077323d509c283e654f01546debd140885c611adf0044d05f
+  metadata.gz: 5e39ad7677be38e3c105687812c5789394313fb2d24a493632e65de33742d419cb8a4997fb0939bafabb7dfe06f3f782a98a49bb02af45e986a3e3a40870a7ff
+  data.tar.gz: 5d5cb8dd4de5bc0d326d2ca7b19b3811f03f1bb92a87254601f749436033a9d86c5f5f2ae5dcec175c9533d78578e6124940bfb2a94a7e1245e7141e18ec1568

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 ## [Unreleased]
 
-## [0.1.0] - 2026-08-10
+## [0.1.2] - 2026-09-07
+
+- Added a `stirfry` cli command to gemspec files so it is usable
+
+## [0.1.1] - 2026-09-07
+
+- Added a `stirfry` cli command for easy development running.
+
+## [0.1.0] - 2026-09-06
 
 Initial release of the whole framework including:
 

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 gem "irb"
 gem "pstore"
 gem "puma"
+gem "rackup"
 gem "rake", "~> 13.0"
 gem "rdoc"
 gem "rerun"
@@ -14,3 +15,4 @@ gem "rspec", "~> 3.13"
 gem "rubocop", "~> 1.21"
 gem "rubocop-rake", ">= 0.7.1"
 gem "rubocop-rspec", "~> 3.10", require: false
+gem "terminal-notifier"

data/README.md

@@ -1,5 +1,11 @@
-# StirFry
+# StirFry 🥡
 A small, simple web framework that lets you enjoy ruby with a JSX type flavour. 
+Have a little fun! Mix it up! 
+
+- [Documentation](https://timanema.com/stir_fry/)
+- [RubyGems](https://rubygems.org/gems/stir_fry)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [License](https://opensource.org/licenses/MIT)
 
 ## Installation
 
@@ -36,7 +42,8 @@ __END__
 
 ### app.rb
 
-```
+```ruby
+require "stir_fry"
 require "layout"
 require "home"
 
@@ -48,8 +55,6 @@ class App < StirFry::App
     response.text("Hello #{req.args["name"]}") 
   end
 end
-
-StirFry.run!(App)
 ```
 
 See the `/examples` directory for more in-depth examples.
@@ -77,8 +82,8 @@ __END__
 After checking out the repo, 
 
 - run `bundle install` to install dependencies. 
-- run `./example/todos_app/app.rb` to run the example todo app.
-- run `./example/chat_app/app.rb` to run the example chat app.
+- run `bundle exec stirfry ./example/todos` to run the example todo app.
+- run `bundle exec stirfry ./example/chat` to run the example chat app.
 - run `rake` to run the specs, rubocop and rdoc. 
 
 ## Further Reading

data/bin/stirfry

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path(File.join(__dir__, "..", "lib"))
+
+require "bundler/setup"
+require "stir_fry"
+require "stir_fry/cli/options"
+require "rerun"
+require "rackup"
+require "yaml"
+
+options = StirFry::CLI::Options.parse!
+
+return unless options.key?(:config) # indicates early return from parse
+
+config_path = options.fetch(:config)
+yaml_options = File.exist?(config_path) ? YAML.load_file(config_path) : {}
+options = yaml_options.merge(options)
+
+rackup_options = []
+rackup_options << "--host #{options.dig(:rackup, :host)}"
+rackup_options << "--port #{options.dig(:rackup, :port)}"
+rackup_options << "--quiet" if options.key?(:quiet)
+rackup_options << "--warn" if options.key?(:warn)
+command = "rackup #{rackup_options.join(" ")} #{options[:rackup_file]}"
+
+Rerun::Runner.keep_running(command, options[:rerun])

data/lib/stir_fry/app.rb

@@ -17,8 +17,6 @@ module StirFry
   #   end
   #   get "/todo", Todos::List
   # end
-  #
-  # StirFry.run!(App)
   # ```
   class App
     DEFAULT_ERROR_HANDLERS = { # :nodoc: disable in production
@@ -35,7 +33,7 @@ module StirFry
 
     class << self
       def routes = @routes ||= {} # :nodoc:
-      def all_routes = @all_routes ||= [] # :nodoc:
+      def route_table = @route_table ||= [] # :nodoc:
       def error_handlers = @error_handlers ||= DEFAULT_ERROR_HANDLERS.dup # :nodoc:
       def call(env) = root_app.call(env) # :nodoc:
 
@@ -167,7 +165,7 @@ module StirFry
       # `route("GET", "/")`
       def route(verb, pattern, klass, &block)
         path_pattern = Mustermann.new(route_prefix + pattern)
-        all_routes << path_pattern.to_s unless path_pattern.to_s.start_with?("/stir_fry")
+        route_table << [verb, path_pattern.to_s] unless path_pattern.to_s.start_with?("/stir_fry")
         (routes[verb] ||= []) << [path_pattern, route_handler(klass || block)]
       end
 
@@ -259,8 +257,8 @@ module StirFry
       handle_error(e)
     end
 
-    def all_routes # :nodoc:
-      self.class.all_routes
+    def route_table # :nodoc:
+      self.class.route_table
     end
 
     private

data/lib/stir_fry/cli/options.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "json"
+require "optparse"
+require "pathname"
+
+module StirFry
+  module CLI # :nodoc:
+    # A class that handled CLI options for the cli which contains flags for both
+    # rerun and rackup.
+    class Options # :nodoc:
+      # rubocop:disable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
+      def self.parse!(args: ARGV)
+        options = { rerun: {}, rackup: {} }
+
+        option_parser = OptionParser.new("", 24, "  ") do |o|
+          o.banner = "Usage: stirfry [options] [application_directory]"
+
+          o.separator ""
+          o.separator "Uses the rerun gem and rackup to run your development app and reload it when needed."
+          o.separator "Version: #{StirFry::VERSION}"
+
+          o.separator ""
+          o.separator "Options:"
+          o.on("-d dir", "--dir dir",
+               "directory to watch. Specify multiple paths with ',' or separate '-d dir' " \
+               "option pairs. (default ./ )") do |dir|
+            (options[:rerun][:dir] ||= []).concat(dir.split(","))
+          end
+          o.on("-p pattern", "--pattern pattern", "file glob to watch, (default \"**/*\")") do |pattern|
+            options[:rerun][:pattern] = pattern
+          end
+          o.on("-i pattern", "--ignore pattern", "file glob(s) to ignore.") do |pattern|
+            (options[:rerun][:ignore] ||= []) << pattern
+          end
+          o.on("-n name", "--name name",
+               "name of app used in logs and notifications (default \"#{rerun_defaults[:name]}\")") do |name|
+            options[:rerun][:name] = name
+          end
+          o.on("--notify", "send messages through a desktop notification application.") do
+            options[:rerun][:notify] = os_notifier
+          end
+          o.on("-o", "--host HOST", "listen on HOST (default: #{rackup_defaults[:host]})") do |host|
+            options[:rackup][:host] = host
+          end
+          o.on("-p", "--port PORT", "use PORT (default: #{rackup_defaults[:port]})") do |port|
+            options[:rackup][:port] = port
+          end
+          o.on("-v", "--verbose", "output more logs") { options[:rerun][:verbose] = options[:verbose] = true }
+          o.on("-w", "--warn", "turn warnings on for your script") { options[:rerun][:warn] = options[:warn] = true }
+          o.on("-q", "--quiet", "turn off logging") { options[:rerun][:quiet] = options[:quiet] = true }
+          o.on_tail("--config config_filepath", "load config from path (default: .stirfry)") do |value|
+            options[:config] = value
+          end
+          o.on_tail("-h", "--help", "--usage", "show this message") do
+            puts o
+            return {}
+          end
+          o.on_tail("--version", "show version") do
+            puts StirFry::VERSION
+            return {}
+          end
+        end
+
+        begin
+          option_parser.parse! args
+        rescue OptionParser::InvalidOption => e
+          warn e.message
+          abort option_parser.to_s
+        end
+
+        options[:rackup] = rackup_defaults.dup.merge(options[:rackup])
+        options[:rerun] = rerun_defaults.dup.merge(options[:rerun])
+        options[:config] ||= ".stirfry"
+        options[:app_directory] = args.last && !args.last.empty? ? args.last.strip : "."
+        options[:rackup_file] = File.expand_path("config.ru", options[:app_directory])
+        options
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
+
+      def self.validate_enum!(opt_name, enum)
+        raise OptionParser::InvalidOption, "unknown #{opt_name}: #{e}" unless enum.include?(e)
+      end
+
+      def self.mac? = RUBY_PLATFORM =~ /darwin/i
+      def self.windows? = RUBY_PLATFORM =~ /(mswin|mingw32)/i
+      def self.linux? = RUBY_PLATFORM =~ /linux/i
+
+      def self.rackup_defaults
+        @rackup_defaults ||= {
+          host: "localhost",
+          port: 9292
+        }
+      end
+
+      def self.rerun_defaults
+        {
+          dir: [+"."],
+          ignore: [],
+          name: Pathname.getwd.basename.to_s.tr("_-", " ").split.map(&:capitalize).join(" "),
+          notify: false,
+          pattern: "**/*",
+          clear: true,
+          wait: 2,
+          signal: "TERM,INT,KILL"
+        }
+      end
+
+      def self.os_notifier
+        return "osx" if mac?
+        return "notify-send" if linux?
+
+        warn "no notifier supported for windows" if windows?
+        nil
+      end
+    end
+  end
+end

data/lib/stir_fry/pages/not_found_page.rb

@@ -23,9 +23,12 @@ __END__
     <section class="error-page">
       <p class="error-page__code">404</p>
       <p class="error-page__message">Request path did not match any registered routes.</p>
-      <ul class="error-page__backtrace">
-        {application.all_routes.map { |route| <li>{route}</li> }.join }
-      </ul>
     </section>
+    <nav class="route-list">
+      <p class="route-list__caption">Registered routes</p>
+      <ul class="route-list__items">
+        {application.route_table.map { |verb, path| <li class="route-list__item"><span class="route-list__verb" data-verb={verb}>{verb}</span><code class="route-list__path">{path}</code></li> }.join }
+      </ul>
+    </nav>
   </section>
 </StirFry.Pages.Layout>

data/lib/stir_fry/pages/routes_page.rb

@@ -12,10 +12,11 @@ __END__
 <StirFry.Pages.Layout>
   <section>
     <header><h1>Routes</h1></header>
-    <section>
-      <ul class="error-page__backtrace">
-        {application.all_routes.map { |route| <li>{route}</li> }.join }
+    <nav class="route-list">
+      <p class="route-list__caption">{ "#{application.route_table.length} registered routes" }</p>
+      <ul class="route-list__items">
+        {application.route_table.map { |verb, path| <li class="route-list__item"><span class="route-list__verb" data-verb={verb}>{verb}</span><code class="route-list__path">{path}</code></li> }.join }
       </ul>
-    </section>
+    </nav>
   </section>
 </StirFry.Pages.Layout>

data/lib/stir_fry/static/stir_fry.css

@@ -62,3 +62,68 @@ ul.error-page__backtrace {
 	text-align: left;
 	list-style-type: none;
 }
+
+.route-list {
+	margin-top: 2rem;
+}
+
+.route-list__caption {
+	margin: 0 0 0.75rem;
+	color: var(--muted);
+	font-size: 0.8rem;
+	font-weight: 600;
+	text-transform: uppercase;
+	letter-spacing: 0.06em;
+}
+
+.route-list__items {
+	margin: 0;
+	padding: 0;
+	list-style: none;
+	border: 1px solid #e6e6e6;
+	border-radius: 6px;
+	overflow: hidden;
+}
+
+.route-list__item {
+	display: flex;
+	align-items: center;
+	gap: 0.75rem;
+	padding: 0.55rem 0.9rem;
+	background: #fff;
+}
+
+.route-list__item:nth-child(even) {
+	background: #f7f7f7;
+}
+
+.route-list__item:hover {
+	background: #eef6f0;
+}
+
+.route-list__verb {
+	flex: none;
+	min-width: 3.75rem;
+	padding: 0.15rem 0.5rem;
+	border-radius: 3px;
+	background: var(--muted);
+	color: #fff;
+	font-family: Menlo, Consolas, "Liberation Mono", monospace;
+	font-size: 0.72rem;
+	font-weight: 700;
+	letter-spacing: 0.04em;
+	text-align: center;
+}
+
+.route-list__verb[data-verb="GET"] { background: var(--ruby-green); }
+.route-list__verb[data-verb="POST"] { background: #1f6feb; }
+.route-list__verb[data-verb="PUT"],
+.route-list__verb[data-verb="PATCH"] { background: #b8860b; }
+.route-list__verb[data-verb="DELETE"] { background: var(--ruby-red); }
+
+.route-list__path {
+	font-family: Menlo, Consolas, "Liberation Mono", monospace;
+	font-size: 0.9rem;
+	color: var(--ink);
+	word-break: break-all;
+}

data/lib/stir_fry/version.rb

@@ -2,5 +2,5 @@
 
 module StirFry
   # VERSION is the release library version
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/stir_fry.rb

@@ -40,58 +40,6 @@ module StirFry
   SIGNALS = %i[INT TERM].freeze # :nodoc:
 
   class << self
-    attr_reader :running_server # :nodoc:
-
-    ##
-    # Start the application server for an App.
-    #
-    # Example:
-    #
-    # ```ruby
-    # class App < StirFry::App
-    #   get "/" { |request:, response:| response.text("Hello world") }
-    # end
-    #
-    # StirFry.run!(App)
-    # ```
-    #
-    # Options:
-    #
-    # - port       [int]    port to listen on for the server.
-    #                       Defaults to 8080 in development and 80 in production.
-    # - host       [string] host to bind on.
-    #                       Default to `localhost` in development and `0.0.0.0` in production
-    # - logger     [Logger] logger to output requests and app messages to.
-    #                       Defaults to new semantic logger.
-    # - log_level  [Symbol] the log level or limit output of the log.
-    #                       options: (:trace, :debug, :info, :warn, :error, :fatal)
-    #                       default: :trace in development and :info in production.
-    # - log_format [Symbol] the output format of the semantic logger.
-    #                       options: (:default, :color, :json, :logfmt)
-    # - log_stdout          disable stdout logging.
-    #                       default: true
-    # - log_file            set a filepath to output logs to.
-    #                       default: nil, only outputs to stdout.
-    #
-    def run!(app_klass, **options)
-      return unless running_server.nil?
-
-      Rackup::Handler.default.run(app_klass, **extract_options(app_klass, **options)) do |server|
-        at_exit { quit! }
-        SIGNALS.each { |signal| chain_trap(signal) { quit! } }
-        @logger.info("Server started", **server_info(server))
-        server.threaded = true if server.respond_to? :threaded=
-        @running_server = server
-      end
-    ensure
-      quit!
-    end
-
-    ##
-    # Returns the running status of the server. If `run!` has not already been called
-    # then this will return false.
-    def running? = !running_server.nil?
-
     # Is the set environment setting evaluated from environment variables APP_ENV,
     # RACK_ENV or ENV. It defaults to :development.
     def app_env = @app_env ||= (ENV["APP_ENV"] || ENV["RACK_ENV"] || ENV["ENV"] || :development).to_sym
@@ -106,75 +54,17 @@ module StirFry
     def production? = app_end == :production
 
     # Logger is the app wide logger for any app messages.
-    def logger = @logger ||= default_logger(App)
-
-    ##
-    # Stops the running server if it is running. If it is not running then this is
-    # a no-op
-    def quit!
-      return if running_server.nil?
-
-      running_server.respond_to?(:stop!) ? running_server.stop! : running_server.stop
-    end
+    def logger = @logger ||= default_logger
 
     private
 
-    def extract_options(klass, **options)
-      @port = options.fetch(:Port, options.fetch(:port, default_port)) || default_port
-      @host = options.fetch(:Host, options.fetch(:host, default_host)) || default_host
-      @logger = options.delete(:logger) || default_logger(klass, options)
-      dev_null = Logger.new(File.open(File::NULL, "w"))
-      {
-        # Set the capitalized options in case the downcased options are set.
-        Port: @port,
-        Host: @host,
-        # Disable Rack logging
-        Logger: dev_null,
-        AccessLog: dev_null
-      }.merge(options)
-    end
-
-    def server_info(server)
-      {
-        port: @port,
-        host: @host,
-        app_env: @app_env,
-        threaded: server.respond_to?(:threaded=),
-        server: Rackup::Handler.default.name
-      }
-    end
-
-    def default_logger(klass, options = {})
-      log_format = options.fetch(:log_format, :color) || :color
-      log_stdout = options.fetch(:log_silence, false)
-      log_file = options.fetch(:log_file, nil)
-
+    def default_logger
       SemanticLogger.add_signal_handler
-      SemanticLogger.application = klass.name.to_s
-      SemanticLogger.environment = @app_env
-      SemanticLogger.default_level = options.fetch(:log_level, default_log_level) || default_log_level
-      SemanticLogger.add_appender(io: $stdout, formatter: log_format) unless log_stdout
-      SemanticLogger.add_appender(filename: log_file, formatter: log_format) unless log_file.nil?
-      SemanticLogger[klass.name.to_s]
-    end
-
-    def default_port
-      development? ? "8080" : "80"
-    end
-
-    def default_host
-      development? ? "localhost" : "0.0.0.0"
-    end
-
-    def default_log_level
-      development? ? :trace : :info
-    end
-
-    def chain_trap(sig, &)
-      prev = Signal.trap(sig) do
-        yield
-        prev.call if prev.respond_to?(:call)
-      end
+      SemanticLogger.application = "StirFry"
+      SemanticLogger.environment = app_env
+      SemanticLogger.default_level = :trace
+      SemanticLogger.add_appender(io: $stdout, formatter: :color)
+      SemanticLogger["StirFry"]
     end
   end
 end

data/stir_fry.gemspec

@@ -13,10 +13,13 @@ Gem::Specification.new do |spec|
     It leverages a JSX like templating language, simple routing definitions
     similar to sinatra and usage of ruby that will make it feel easy and understandable.
   DESC
+  spec.post_install_message = " 🐦‍⬛ Let's Get Cookin! 🥡 "
   spec.homepage = "https://github.com/tanema/stir_fry"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1"
   spec.require_paths = ["lib"]
+  spec.bindir        = "bin"
+  spec.executables   = ["stirfry"]
   spec.metadata = {
     "source_code_uri" => "https://github.com/tanema/stir_fry",
     "changelog_uri" => "https://github.com/tanema/stir_fry/blob/main/CHANGELOG.md",
@@ -26,6 +29,7 @@ Gem::Specification.new do |spec|
     "rubygems_mfa_required" => "true"
   }
   spec.files = Dir["lib/**/*"] + [
+    "bin/stirfry",
     "README.md",
     "CHANGELOG.md",
     "CODE_OF_CONDUCT.md",
@@ -39,7 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack", ">= 3.0.0", "< 4"
   spec.add_dependency "rack-protection", ">= 3.1"
   spec.add_dependency "rack-session", ">= 2.0.0", "< 3"
-  spec.add_dependency "rackup", ">= 2.1"
   spec.add_dependency "rbxrb", ">= 0.1"
   spec.add_dependency "semantic_logger", ">= 5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stir_fry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Tim Anema
@@ -77,20 +77,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: rackup
-  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: rbxrb
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +111,8 @@ description: |
   similar to sinatra and usage of ruby that will make it feel easy and understandable.
 email:
 - timanema@gmail.com
-executables: []
+executables:
+- stirfry
 extensions: []
 extra_rdoc_files: []
 files:
@@ -135,8 +122,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/stirfry
 - lib/stir_fry.rb
 - lib/stir_fry/app.rb
+- lib/stir_fry/cli/options.rb
 - lib/stir_fry/component.rb
 - lib/stir_fry/middleware.rb
 - lib/stir_fry/middleware/logger.rb
@@ -160,6 +149,7 @@ metadata:
   bug_tracker_uri: https://github.com/tanema/stir_fry/issues
   documentation_uri: https://github.com/tanema/stir_fry
   rubygems_mfa_required: 'true'
+post_install_message: " \U0001F426‍⬛ Let's Get Cookin! \U0001F961 "
 rdoc_options: []
 require_paths:
 - lib