Home / Ruby / Web Frameworks

Lightweight, Flexible and Fast Ruby Web Framework

midori This project is still not production-ready. Questions, suggestions and pull requests are highly welcome. Description Midori is a Ruby Web Framework, providing high performance and proper abstraction.
Information
Category: Ruby / Web Frameworks
Watchers: 50
Star: 873
Fork: 57
Last update: Nov 20, 2023
Resource links
https://github.com/midori-rb/midori.rb

midori

This project is still not production-ready. Questions, suggestions and pull requests are highly welcome.

Backers on Open Collective Sponsors on Open Collective

Logo and Slogan

Description

Midori is a Ruby Web Framework, providing high performance and proper abstraction.

midori midori-contrib murasaki midori_http_parser
midori logo midori logo midori logo midori logo
Web Framework Official Extensions Modularized Event Engine HTTP Parser
Build Status Build Status Build Status Build Status
Test Coverage Test Coverage Test Coverage n/a
Maintainability Maintainability Maintainability Maintainability
doc doc doc n/a
Gem Version Gem Version Gem Version Gem Version
license license license license

Requirements

  • Ruby >= 2.3.7

Installation

gem install midori.rb

With Bundler

gem 'midori.rb'
bundle install

FAQ

Performance

Following benchmark results testing {msg: "Hello"} JSON response by visiting GET / with a single-core, 1GB memory, Amazon Web Service Linux instance.

framework version req/s
Rails (Thin, Ruby 2.5.1) 5.0.6 490.23
Rails (API Mode, Thin, Ruby 2.5.1) 5.0.6 785.61
Sinatra (Thin, Ruby 2.5.1) 2.0.0 1196.23
express.js (Node.js 9.3.0) 4.16.0 5435.98
midori (Ruby 2.5.1) 0.6.0 5517.66

Name

The name midori comes from midori machi, which was the place I stay on my first travel to Tokyo.

Semantic Versioning

Version consists of four numbers:

Milestone Major Minor Patch
Example 1. 2. 1. 5
Explanation Milestone version Incompatible API changes Add feature Fix bugs

Note: Before version v1.0, there's no minor version API compatible ensuring.

Contributing

See Contributing Guidelines before you leave any comment. This project exists thanks to all the people who contribute.

Contributors

Tutorial & Example

There is an unfinished tutorial available here.

There is also an example showing how to use midori with a todo-list web app available here.

Roadmap

Development roadmap has been moved here.

Detailed release notes for published versions can be seen here.

Midori 2 Goals

  1. Support HTTP/2
  2. Support RPC/ZeroMQ Based Server
  3. Add MVC abstraction example with scaffold
  4. Improve structure for fitting AutoFiber
  5. More examples on using midori

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

3 Open More issues
Closed

Performance goes very bad on macOS

The benchmark shown in Readme is under Linux instance. But found that performance goes 10 times slower on macOS. Need to be fixed.

bug 
opened Oct 24, 2016 by dsh0416 8
Closed

IOError when respond with large body

This will cause the server process abort.

I, [2018-02-28T08:09:48.730775 #1]  INFO -- : Midori 0.5.2 is now running on 0.0.0.0:3000
I, [2018-02-28T08:09:50.043817 #1]  INFO -- : 172.25.0.1 - - "GET /documents HTTP/1.0" 200 OK 0.034884
I, [2018-02-28T08:09:50.360293 #1]  INFO -- : 172.25.0.1 - - "GET /origin_websites HTTP/1.0" 200 OK 0.286312
I, [2018-02-28T08:09:50.437701 #1]  INFO -- : 172.25.0.1 - - "GET /output_columns HTTP/1.0" 200 OK 0.076205
I, [2018-02-28T08:09:51.133797 #1]  INFO -- : 172.25.0.1 - - "GET /compose_organizations HTTP/1.0" 200 OK 0.693688
/app/vendor/bundle/ruby/2.5.0/gems/murasaki-0.2.0/lib/murasaki/event_loop.rb:62:in `fileno': closed stream (IOError)
	from /app/vendor/bundle/ruby/2.5.0/gems/murasaki-0.2.0/lib/murasaki/event_loop.rb:62:in `deregister'
	from /app/vendor/bundle/ruby/2.5.0/gems/midori.rb-0.5.2/lib/midori/connection.rb:63:in `close_connection'
	from /app/vendor/bundle/ruby/2.5.0/gems/midori.rb-0.5.2/lib/midori/connection.rb:33:in `block in listen'
	from /app/vendor/bundle/ruby/2.5.0/gems/murasaki-0.2.0/lib/murasaki/event_loop.rb:75:in `block in run_once'
	from /app/vendor/bundle/ruby/2.5.0/gems/murasaki-0.2.0/lib/murasaki/event_loop.rb:74:in `select'
	from /app/vendor/bundle/ruby/2.5.0/gems/murasaki-0.2.0/lib/murasaki/event_loop.rb:74:in `run_once'
	from /app/vendor/bundle/ruby/2.5.0/gems/murasaki-0.2.0/lib/murasaki/event_loop.rb:101:in `start'
	from /app/vendor/bundle/ruby/2.5.0/gems/midori.rb-0.5.2/lib/midori/runner.rb:44:in `start'
	from /app/midori.rb:6:in `<main>'
bug 
opened Feb 28, 2018 by li-thy-um 7
Closed

feature-req/doc: SVG logo

Make a copy with text elements duplicated, one converted to path and the other hidden with display: none.

enhancement 
opened Nov 7, 2016 by Artoria2e5 7
Closed

Incomplete response body when deploying with nginx

error message

Failure/Error: puts JSON.pretty_generate(Oj.load(r.body))

     Oj::ParseError:
       quoted string not terminated at line 1, column 86807 [parse.c:337]

headers

{:server=>"nginx", :date=>"Wed, 31 Jan 2018 07:32:38 GMT", :content_type=>"application/json", :content_length=>"87904", :connection=>"close"}

nginx.conf

server {
        listen 6199;
        server_name default;
 
        proxy_next_upstream error timeout http_502 http_504;

        location / {
                proxy_pass http://localhost:3000/;
        }
}
bug 
opened Jan 31, 2018 by li-thy-um 5
Closed

WebSocket frame size is too small (125 bytes)

Steps to reproduce

Run this little script:

require 'midori.rb'

class AppRoute < Midori::API
  capture Errno::ENOENT do |e|
    @status = 404
    "Not found"
  end

  websocket '/' do |ws|
    ws.on :open do
      ws.send '125 bytes: ok'
      ws.send '1' * 125
      ws.send '126 bytes: fail'
      ws.send '1' * 126
      ws.send 'pipe is broken'
    end
  end

  get '/' do
    <<~HTML
      <!DOCTYPE html>
      <meta charset="UTF-8">
      <title>Midori Issue WebSocket</title>
      <p>Open the console to see errors.</p>
      <script>
        var ws = new WebSocket('ws://localhost:8080');
        ws.addEventListener('message', function (e) {
          console.log(e.data);
        });
      </script>
    HTML
  end
end

begin
  Midori::Runner.new(AppRoute).start
rescue Interrupt
  puts "See you next time."
rescue => e
  puts "#{e.class}: #{e}"
  retry
end

Error messages will be shown both in the browser console and the terminal.

Expected behavior

WebSocket frame size has a limit of 2^63 bytes (if we correctly implement it according to the RFC).

Actual behavior

ws.send '1' * 126 suddenly broke the socket, but the error shows until a new message is about to send (say, ws.send 'pipe is broken').

System configuration

Midori version: 0.7.0

Ruby version: 2.6.3

opened Jul 23, 2019 by hyrious 3
Closed

Can't logging to STDOUT properly

Using master branch Deploy on Aliyun swarm mode cluster with two containers on two different machines. When I stop the container, it will output all the missing logs.

Empty output when container is alive.

xxxx-node8:~# docker logs -f container

When I stop the container, it will puts all logs at once.

xxxx-node8:~# docker logs -f container
I, [2018-01-23T09:39:11.374340 #1]  INFO -- : Midori 0.5.0 is now running on 0.0.0.0:3000
I, [2018-01-23T09:39:47.184221 #1]  INFO -- : 10.255.0.34 - - "GET / HTTP/1.1" 200 OK 0.000187
I, [2018-01-23T09:39:49.306820 #1]  INFO -- : 10.255.0.34 - - "GET / HTTP/1.1" 200 OK 0.000080
I, [2018-01-23T09:39:56.277032 #1]  INFO -- : 10.255.0.47 - - "GET / HTTP/1.1" 200 OK 0.000073
I, [2018-01-23T09:39:59.395120 #1]  INFO -- : 10.255.0.47 - - "GET / HTTP/1.1" 200 OK 0.000076

My Dockerfile looks like this:

FROM ruby:2.4.1-alpine

WORKDIR /app

RUN echo "http://mirrors.aliyun.com/alpine/v3.4/main/" | tee /etc/apk/repositories

ADD ./Rakefile ./Rakefile
ADD ./config.ru ./config.ru
ADD Gemfile Gemfile.lock ./

RUN \
  apk update && apk add --no-cache git build-base && \
  bundle install --deployment --without development:test:doc && \
  apk del git build-base

ADD ./lib ./lib
ADD ./config ./config
ADD ./app ./app

NOTE: I double checked, logging is improper on both containers.

question 
opened Jan 23, 2018 by li-thy-um 3
Open

Fix spelling

opened Dec 26, 2020 by jbampton 0
Open

Add frozen literals support

opened Jul 9, 2018 by dsh0416 1
Open

API doc generator

Hello, Delton Ding!

I'm very interested! I have worked with Sinatra for an API server for tablets, phones and HTML and I'm back again.

Several things I see that I'd like to mention. First, I see that you're already in WebSockets in a big way. Good work; I think that's one of the biggest development pushes out tehre now that it is finally stabilizing (!!!). Have you given thought to incorporating Swagger/OpenAPI and its editor, since they already do Sinatra?

Secondly, I haven't needed it before but see the need now more than ever, is authentication of APIs. I never got close enough to production before but now see a pressing need for OAUTH2 and API-Key authentication. I like what Timi Ajiboye's Client Manager does in terms of functionality but don't want the whole Rails framework chewing up CPU cycles. Maybe a simple CL DSL loop?

enhancement 
opened Oct 20, 2016 by dwilde1 3

v0.9.0(Dec 25, 2020)

Support Ruby 3.0.0 official release πŸŽ‰

Merry Christmas and Happy Holidays

v0.8.0(Dec 23, 2020)

  • Use evt instead of nio4r as scheduler
  • Ruby 3.0 rc1 is required since this version

v0.7.1(Jul 30, 2019)

  • Update dependencies
  • Fix Websocket Frame Size bug (Thanks to @hyrious for reporting this bug)

v0.7.0(Jul 9, 2018)

  • Support reuse port option with Midori::Configure.socket_reuse_port Clusters could now be easily supported by starting multiple processes in Linux

  • Implement mask_str method for WebSockets in C String messages is now decoded 19% faster than v0.6.0

  • Bugs fixed in specs

Enjoy programming with midori and Ruby!

v0.6.0(Jun 29, 2018)

  • Introduce keep-alive feature
  • Introduce new configs keep_alive, keep_alive_timeout, keep_alive_requests for tuning performance
  • Using separated thread for ticking timers
  • Substantially increased performance (About 20% faster on Linux, 2500% faster on macOS)

Enjoy programming with midori and Ruby!

v0.5.4(Jun 28, 2018)

  • Fix a serious IOError bug from murasaki. Thanks to @li-thy-um for reporting this issue.

Midori would recover its regular update since this release. The development roadmap would continue as it was.

Contents

    ibeizhu Vue flexible modal popup component,Live Demo
    sumeetchhetri Framework for Enterprise Application Development, webrtc signalling server, peerjs webrtc, c++ framework, c++ web framework, c++ application framework, c++ rest framework, c++ soap framework, c++ web sites, c++ web applications, c++ driven web development - c++
    actix Actix web is a small, pragmatic, and extremely fast rust web framework.
    artichoke πŸ’Ž Artichoke is a Ruby made with Rust
    tangledpath Ruby library for interfacing with FANN (Fast Artificial Neural Network)
    fastruby :dash: Writing Fast Ruby :heart_eyes: -- Collect Common Ruby idioms.
    zkweb-framework A flexible web framework supports .Net Framework and .Net Core
    UnionOfRAD li₃ is the fast, flexible and most RAD development framework for PHP
    facebookresearch An End-To-End, Lightweight and Flexible Platform for Game Research
    HerikLyma ​The C++ Web Framework (CWF) is a MVC web framework, Open Source, under MIT License, using C++ with Qt to be used in the development of web applications.
    prism-rb Build frontend web apps with Ruby and WebAssembly
    voltrb A Ruby web framework where your Ruby runs on both server and client
    hanami Minimal, extremely fast, lightweight Ruby framework for HTTP APIs
    ryanmelt An easy to install gem version of the Ruby bindings to Qt
    fullstaq-ruby A server-optimized Ruby distribution: less memory, faster, easy to install and security-patch via APT/YUM
    chrisseaton Rhizome - a JIT for Ruby, implemented in pure Ruby
    michelson Make highcharts a la ruby , works in rails 5.X / 4.X / 3.X, and other ruby web frameworks
    marcelodolza Elegant, responsive, flexible and lightweight modal plugin with jQuery.
    marcelodolza Elegant, responsive, flexible and lightweight notification plugin with no dependencies.
    klein A fast & flexible router
    mockery Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its core goal is to offer a test double framework with a succinct API capable of clearly defining all possible object operations and interactions using a human readable Domain Specific Language (DSL).
    Share this repo

    Related Repos


    Web Frameworks
    81
    PostgreSQL Row Level Security, The Rails right way to do multitenancy
    Dandush03 PgRls PostgreSQL Row Level Security The Rails right way to do multitenancy Explore the docs Β» View Live Demo Β· Report Bug Β· Request Feature Β· API Repo
     
    Web Frameworks
    110
    Bundle and process CSS in Rails with Tailwind, PostCSS, and Sass via Node.js.
    rails Bundle and process CSS in Rails with Tailwind, PostCSS, and Sass via Node.js.
     
    Web Frameworks
    152
    Bundle and transpile JavaScript in Rails with esbuild, rollup.js, or Webpack.
    rails JavaScript Bundling for Rails Use esbuild, rollup.js, or Webpack to bundle your JavaScript, then deliver it via the asset pipeline in Rails. This gem
     
    Web Frameworks
    138
    Auditing tool for Rails console sessions
    basecamp Auditing tool for Rails console sessions
     
    Web Frameworks
    21
    Instant Rails is a Rails application template that comes with certain common tools, like D...
    jasonswett Instant Rails is a special kind of Rails application template. Instant Rails will generate your application inside of a Docker container so that you don't even need to have Ruby, Rails, PostgreSQL or anything else installed on your computer in order to generate a Rails app.
     
    Web Frameworks
    159
    A sustainable architecture for Ruby on Rails.
    Shopify Ruby on Rails is the framework of choice for web apps at Shopify. It is an opinionated stack for quick and easy development of apps that need standard persistence with relational databases, an HTTP server, and HTML views.
     
    Web Frameworks
    1.8k
    Seamlessly adds a Swagger to Rails-based API's
    rswag Rswag extends rspec-rails "request specs" with a Swagger-based DSL for describing and testing API operations. You describe your API operations with a succinct, intuitive syntax, and it automaticaly runs the tests.
     
    Web Frameworks
    40
    πŸ†” Friendly Prefixed IDs for your Ruby on Rails models
    excid3 πŸ†” Friendly Prefixed IDs for your Ruby on Rails models
     
    Web Frameworks
    25
    Rails N+1 queries auto-detection with zero false positives / false negatives
    charkost Prosopite is able to auto-detect Rails N+1 queries with zero false positives / false negatives.
     
    Web Frameworks
    91
    Hotwire is an alternative approach to building modern web applications without using much ...
    hotwired Hotwire is an alternative approach to building modern web applications without using much JavaScript by sending HTML instead of JSON over the wire.
     
    Web Frameworks
    45
    A boot time booster for Ruby on Rails that defers loading the whole bloody routes so the a...
    amatsuda A boot time booster for Ruby on Rails that defers loading the whole bloody routes so the app can spin up quickly 🀘
     
    Web Frameworks
    25
    A little bit of magic to make partials perfect for components.
    bullet-train-co Nice Partials provides a light layer of magic on top of traditional Rails view partials to try and make them an even better fit for extracting and reusing components in your views.
     
    Web Frameworks
    19
    Short, stateless URL slugs for UUID-based Rails models
    glacials FriendlyUUID is a Rails gem that shortens your UUID records' URLs.
     
    Web Frameworks
    23
    Lazy-load Rails partials via CableReady
    julianrubisch Lazy-load Rails partials via CableReady
     
    Web Frameworks
    682
    Motion allows you to build reactive, real-time frontend UI components in your Rails applic...
    unabridged Motion allows you to build reactive, real-time frontend UI components in your Rails application using pure Ruby.