stir_fry 0.1.0

data/lib/stir_fry/static/stir_fry.css

@@ -0,0 +1,64 @@
+:root {
+	--ruby-red: #cc342d;
+	--ruby-green: #2e8b57;
+	--ink: #2b2b2b;
+	--muted: #6b6b6b;
+}
+
+* {
+	box-sizing: border-box;
+}
+
+body {
+	margin: 0;
+	font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
+	color: var(--ink);
+	background: #fafafa;
+}
+
+section {
+	max-width: 640px;
+	margin: 0 auto;
+	padding: 2rem 1.5rem;
+}
+
+header h1 {
+	display: inline-block;
+	color: var(--ruby-red);
+	border-bottom: 3px solid var(--ruby-green);
+	padding-bottom: 0.5rem;
+}
+
+.error-page {
+	text-align: center;
+	padding: 4rem 1.5rem;
+}
+
+.error-page__code {
+	margin: 0;
+	color: var(--ruby-red);
+	font-size: 4rem;
+	font-weight: 700;
+}
+
+.error-page__path {
+	display: inline-block;
+	margin: 0 0 1rem;
+	padding: 0.35rem 0.75rem;
+	border: 1px solid var(--ruby-green);
+	border-radius: 4px;
+	background: #eef6f0;
+	color: var(--ink);
+	font-family: Menlo, Consolas, "Liberation Mono", monospace;
+	font-size: 0.9rem;
+}
+
+.error-page__message {
+	color: var(--muted);
+}
+
+ul.error-page__backtrace {
+	color: var(--muted);
+	text-align: left;
+	list-style-type: none;
+}

data/lib/stir_fry/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module StirFry
+  # VERSION is the release library version
+  VERSION = "0.1.0"
+end

data/lib/stir_fry.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require "semantic_logger"
+require "rbx"
+require "rackup"
+require "logger"
+
+##
+# StirFry as a module provides an entrypoint to starting your app. It is also the
+# namespace that contains the server library that will render the rbx templates.
+module StirFry
+  # Error is the main root error for most errors raised by the library. Most of these
+  # errors are raised to bail out of a request cycle early and return early.
+  class Error < StandardError; end
+  # Okay represents a http 200 response.
+  class OKAY < Error; end
+  # Found represents a http 302 response.
+  class Found < Error; end
+  # NotModified represents a http 304 response.
+  class NotModified < Error; end
+  # BadRequest represents a http 400 response.
+  class BadRequest < Error; end
+  # Unauthorized represents a http 401 response.
+  class Unauthorized < Error; end
+  # NotFound represents a http 404 response.
+  class NotFound < Error; end
+  # PreconditionFailed represents a http 412 response.
+  class PreconditionFailed < Error; end
+  # InternalError represents a http 500 response.
+  class InternalError < Error; end
+
+  autoload :App, "stir_fry/app"
+  autoload :Component, "stir_fry/component"
+  autoload :Pages, "stir_fry/pages"
+  autoload :Request, "stir_fry/request"
+  autoload :Response, "stir_fry/response"
+  autoload :Middleware, "stir_fry/middleware"
+  autoload :Version, "stir_fry/version"
+
+  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
+
+    # is the app running in development.
+    def development? = app_env == :development
+
+    # is the app running in test.
+    def test? = app_env == :test
+
+    # is the app running in production
+    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
+
+    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)
+
+      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
+    end
+  end
+end

data/stir_fry.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/stir_fry/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stir_fry"
+  spec.version = StirFry::VERSION
+  spec.authors = ["Tim Anema"]
+  spec.email = ["timanema@gmail.com"]
+  spec.summary = "Small simple ruby web framework that feels familiar."
+  spec.description = <<~DESC
+    Small simple ruby web framework that feels familiar.
+    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.homepage = "https://github.com/tanema/stir_fry"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+  spec.require_paths = ["lib"]
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/tanema/stir_fry",
+    "changelog_uri" => "https://github.com/tanema/stir_fry/blob/main/CHANGELOG.md",
+    "homepage_uri" => spec.homepage,
+    "bug_tracker_uri" => "https://github.com/tanema/stir_fry/issues",
+    "documentation_uri" => "https://github.com/tanema/stir_fry",
+    "rubygems_mfa_required" => "true"
+  }
+  spec.files = Dir["lib/**/*"] + [
+    "README.md",
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "Gemfile",
+    "LICENSE",
+    "Rakefile",
+    "stir_fry.gemspec"
+  ]
+
+  spec.add_dependency "mustermann", "~> 3.0"
+  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

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: stir_fry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Anema
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rack-protection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack-session
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: |
+  Small simple ruby web framework that feels familiar.
+  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.
+email:
+- timanema@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/stir_fry.rb
+- lib/stir_fry/app.rb
+- lib/stir_fry/component.rb
+- lib/stir_fry/middleware.rb
+- lib/stir_fry/middleware/logger.rb
+- lib/stir_fry/pages.rb
+- lib/stir_fry/pages/error_page.rb
+- lib/stir_fry/pages/layout.rb
+- lib/stir_fry/pages/not_found_page.rb
+- lib/stir_fry/pages/routes_page.rb
+- lib/stir_fry/request.rb
+- lib/stir_fry/response.rb
+- lib/stir_fry/static/stir_fry.css
+- lib/stir_fry/version.rb
+- stir_fry.gemspec
+homepage: https://github.com/tanema/stir_fry
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tanema/stir_fry
+  changelog_uri: https://github.com/tanema/stir_fry/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/tanema/stir_fry
+  bug_tracker_uri: https://github.com/tanema/stir_fry/issues
+  documentation_uri: https://github.com/tanema/stir_fry
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Small simple ruby web framework that feels familiar.
+test_files: []