zapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f666d4681200fdaf226cf78821e61fad6192f61f70bf8db9aa70a6c224a6a1e6
+  data.tar.gz: c6c72378e757c93190b5c2e73ec83c87806ba3d13f1bc80670336605be538d7c
+SHA512:
+  metadata.gz: ce692ed7205e2aa7157bf7180caf8d2c30ed973a394181f340dc456ef220ced24773bfe4cfa2e98a3cd5083e193cefb47b4daa043af9bb682878738e477e8576
+  data.tar.gz: 978c754d57a872141d03f8d522c94dab93ee94807cd2a09266cb1b223411b9e6bec0656e92a0750276847375c865755c4fea67547adbd6b1c6c5d16fc16264f5

data/.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  test_three_zero_zero:
+    docker:
+      - image: circleci/ruby:3.0.0
+    executor: ruby/default
+    steps:
+      - checkout
+      - ruby/bundle-install
+      - run:
+          name: RSpec
+          command: bundle exec rspec
+
+workflows:
+  test:
+    jobs:
+      - test_three_zero_zero

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/example/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  TargetRubyVersion: 3.0.0
+  EnabledByDefault: true
+  NewCops: enable
+  Exclude:
+    - examples/**/*
+
+Style/DocumentationMethod:
+  Enabled: false
+Style/MissingElse:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/Copyright:
+  Enabled: false
+Style/ConstantVisibility:
+  Enabled: false
+Style/MethodCallWithArgsParentheses:
+  IgnoreMacros: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: false
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+Style/Send:
+  Enabled: false
+Style/ClassMethodsDefinitions:
+  Enabled: false
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Bundler/GemComment:
+  Enabled: false
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+Layout/RedundantLineBreak:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+Metrics/MethodLength:
+  Max: 25
+Metrics/AbcSize:
+  Max: 30

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source("https://rubygems.org")
+
+# Specify your gem's dependencies in zap.gemspec
+gemspec
+
+group(:development) do
+  gem("guard", "~> 2.18.0")
+  gem("guard-rspec", "~> 4.7.3")
+  gem("guard-rubocop", "~> 1.5.0")
+  gem("simplecov", "~> 0.21.2")
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    zapp (0.1.0)
+      concurrent-ruby (~> 1.1.9)
+      puma (~> 5.5.2)
+      rack (~> 2.2.3)
+      rake (~> 13.0)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    nio4r (2.5.8)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    puma (5.5.2)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  guard (~> 2.18.0)
+  guard-rspec (~> 4.7.3)
+  guard-rubocop (~> 1.5.0)
+  simplecov (~> 0.21.2)
+  zapp!
+
+BUNDLED WITH
+   2.3.0.dev

data/Guardfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+%w[lib spec].select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") }
+
+guard(:rspec, cmd: "bundle exec rspec --format progress") do
+  require("guard/rspec/dsl")
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard(:rubocop) do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mathias H Steffensen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Zapp
+
+![CircleCI](https://circleci.com/gh/mathiashsteffensen/zapp/tree/master.svg?style=shield)
+
+Zapp is an experimental web server for Rack-based Ruby applications. It is based on the lightning fast [Puma](https://puma.io/) HTTP parser implemented in C,
+and the new parallelism implementation introduced with CRuby 3.0.0, [Ractors](https://github.com/ruby/ruby/blob/master/doc/ractor.md)
+
+This is an experimental project as Ractors are very very new and the Ractor API may change at any moment. While I would not recommend using this server in production for that reason,
+if you do decide to do so, pin your ruby version to one of the versions this project is tested against (Currently only version 3.0.0).
+
+Why is it named Zapp with 2 p's you may ask? Because Zap with 1 p was taken.
+
+Also it's meant to be pretty fast
+
+## Installation
+
+As a stand-alone ruby executable
+```bash
+gem install zapp
+```
+
+Or using Bundler, add the following to your gemfile
+```ruby
+gem("zapp")
+```
+
+And then run
+```bash
+bundle
+```
+
+## Usage
+
+The CLI tool is meant to be dead simple, and all configuration should be done through a configuration file.
+By default Zapp will look for a config file located at ./config/zapp.rb from where the command is run.
+To change this you can provide the optional -c flag when running the command.
+
+To use a config file at ./configuration/server.rb:
+```bash
+bundle exec zapp -c ./configuration/server.rb
+```
+
+An example config file using Zapp's DSL may look like the following
+```ruby
+# frozen_string_literal: true
+
+# A simple web server
+class App
+  def self.call(_env)
+    [200, {}, ["Hello from Zapp"]]
+  end
+end
+
+# Register the app
+app(App)
+
+# Launch 2 parallel Zapp workers
+parallelism(2)
+
+# Have Zapp be quiet
+# (by default Zapp workers time requests and log when they have been processed)
+log_requests(false)
+
+# Let's bind to 0.0.0.0 instead of localhost
+# since we may run the server from a Docker container
+host("0.0.0.0")
+
+# Use port 8080 (3000 is the default)
+port(8080)
+```
+
+Run the app
+```bash
+bundle exec zapp
+```
+
+## Implementation details
+
+* Parsing is done in a single thread
+  * Puma's HTTP Parser can not be shared between Ractors, and it cannot be copied to a Ractor so parsing can be done in parallel, I have a suspicion this is due to it being a C extension. 
+    If you have any suggestions for how to implement parallel parsing, please file a PR or an issue.
+* Request processing is done in parallel using the Ractor API
+
+## TODO
+
+* Add way more tests to all parts of the library
+* Resolve Rails/Ractor compatibility issues
+* Add thread pool per worker
+* Add some benchmarks against Puma, quite interesting to see how Ractors perform
+* PID file support
+* Support for rack_options

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require("bundler/gem_tasks")
+require("rspec/core/rake_task")
+
+RSpec::Core::RakeTask.new(:spec)
+
+task(default: :spec)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require("bundler/setup")
+require("zapp")
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require("irb")
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/zapp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require("bundler/setup")
+require("zapp")
+
+Zapp::CLI.new.run

data/examples/rails-app/.browserslistrc

@@ -0,0 +1 @@
+defaults

data/examples/rails-app/.gitattributes

@@ -0,0 +1,10 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark the yarn lockfile as having been generated.
+yarn.lock linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/examples/rails-app/.gitignore

@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity

data/examples/rails-app/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/examples/rails-app/Gemfile

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+source("https://rubygems.org")
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby("3.0.0")
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
+gem("rails", "~> 6.1.4", ">= 6.1.4.1")
+# Use sqlite3 as the database for Active Record
+gem("sqlite3", "~> 1.4")
+# Use Zapp as the app server
+gem("zapp", path: "../..")
+# Use SCSS for stylesheets
+gem("sass-rails", ">= 6")
+# Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker
+gem("webpacker", "~> 5.0")
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem("turbolinks", "~> 5")
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem("jbuilder", "~> 2.7")
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem("bootsnap", ">= 1.4.4", require: false)
+
+group(:development, :test) do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem("byebug", platforms: %i[mri mingw x64_mingw])
+end
+
+group(:development) do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem("web-console", ">= 4.1.0")
+  # Display performance information such as SQL time and flame graphs for each request in your browser.
+  # Can be configured to work on production as well see: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md
+  gem("listen", "~> 3.3")
+  gem("rack-mini-profiler", "~> 2.0")
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem("spring")
+end
+
+group(:test) do
+  # Adds support for Capybara system testing and selenium driver
+  gem("capybara", ">= 3.26")
+  gem("selenium-webdriver")
+  # Easy installation and use of web drivers to run system tests with browsers
+  gem("webdrivers")
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem("tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby])