jeanine 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3df31123e22ecf9f1dd465af168aa34b3199e75
-  data.tar.gz: 9fb4883db99cbf0a30b4895064bcb10f00896c6c
+  metadata.gz: 88de5348121b7c5c778d523251999fdc88b6fa2b
+  data.tar.gz: 1032b93658f81998494037f7dc9eb1a16a1bef0f
 SHA512:
-  metadata.gz: e871411c10b283ab9ad26c5b568870e651dc25110cb1e5ea842e607dfe1d3d28dfac640bb574cfe19ee0bb01575668e1906fdbd2c9d5304e0c85a75977d3bfd4
-  data.tar.gz: 214f87e732bbfa864f5b64574c27b4a284c260c7447dc867af01a94da52edac49308d427da84c19846b8c540a2309ab3d81117b99b6f4330df04b194b3b5c65a
+  metadata.gz: 85b1a10571b6e8cf08bd8b2d1497eb4e47651dcce1f4c31546bed10368b53e3e8fb2d5f215006ab450af316e5763adb8e0640ff1fa2ddad84300947cafaab766
+  data.tar.gz: 357e9d198d278167a330b9ad00ff0b5adcdda551690b157adb17b4bea3e99fa4e79cca2f4b6a46bf1ff22faa12dbded50961034132d3b2387bbb7130e38043d4

data/README.md

@@ -0,0 +1,228 @@
+# Jeanine
+
+A Ruby micro-web-framework that gives you enough training wheels to be productive, while being as nearly as fast as Rack itself.
+
+Its design (and some parts of the code) is influenced by/inherited from (thanks!) Ruby on Rails, Rack::App, Hobbit, and Cuba. Without them this is nothing.
+ 
+## Name 
+
+Named after my mom. Because she was the best.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jeanine'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jeanine
+
+## Basic usage
+
+Drop this into `config.ru`:
+
+```ruby
+require 'bundler/setup'
+require 'jeanine'
+
+class App < Jeanine::App
+  root do
+    "Hello world"
+  end
+end
+
+run App 
+```
+
+`$ rackup`
+
+## Advanced usage 
+
+```ruby
+class App < Jeanine::App 
+  path "/posts" do 
+    get do 
+      if request.json?
+        render json: []
+      else
+        "Posts index"
+      end
+    end 
+    get "new" do 
+      "Posts new"
+    end
+    post do 
+      "Posts post"
+    end 
+    path ":id" do 
+      get do 
+        "Posts #{params[:id]}"
+      end
+      match via: [:put, :patch] do 
+        "Posts #{request.via} #{params[:id]}"
+      end
+      delete do
+        "Posts delete #{params[:id]}" 
+      end 
+      path "/comments" do
+        get do 
+          "Posts #{params[:id]} comments"
+        end 
+      end
+    end 
+  end 
+end 
+```
+
+## Plugins 
+
+### Callbacks 
+
+Supports `before` and `after` callbacks (same DSL): 
+
+```
+class App < Jeanine::App
+  plugin :Callbacks 
+  before do 
+    puts "All"
+  end
+  before /posts/ do
+    puts "Before posts"
+  end 
+  before /posts\/\d*/, /comments\/\d*/  do 
+    puts "Before posts/:id, comments/:id"
+    response.headers['X-Thing-Id'] = params[:id]
+  end 
+end 
+```
+
+### Rendering
+
+Basic support for rendering. Be explicit.
+
+```ruby 
+class App < Jeanine::App
+  plugin :Rendering 
+  # loads views/root.html.erb and views/layouts/application.html.erb
+  root do 
+    @title = "My cool app"
+    render template: "root.html.erb", layout: "application.html.erb"
+  end
+end 
+```
+
+### Sessions
+
+Uses Rack's session management.
+
+```ruby 
+class App < Jeanine::App
+  plugin :Session
+  root do 
+    session[:uid] = SecureRandom.hex
+  end
+end 
+```
+
+### Error handling
+
+```ruby 
+class App < Jeanine::App
+  plugin :Resucable 
+  rescue_from NoMethodError, RuntimeError do |exception|
+    response.status = 500
+    "Oh no!"
+  end
+  rescue_from StandardError, with: :handle_error!
+  root do 
+    @title = "My cool app"
+    raise NoMethodError 
+    render template: "root.html.erb", layout: "application.html.erb"
+  end
+
+  private 
+  
+  def handle_error!(exception)
+    response.status = 500
+    render template: "error.html.erb" 
+  end
+end 
+```
+
+## Development
+
+### Ideologies
+
+* No meaningless metaprogramming = fast 
+
+## Benchmarks 
+
+### Requests/second
+
+Benched on a Intel Core i7-8700B / 64GB RAM.
+
+```
+Framework            Requests/sec  % from best
+----------------------------------------------
+rack                     17299.31      100.00%
+jeanine                  16022.71       92.62%
+rack-response            15462.50       89.38%
+syro                     15416.13       89.11%
+watts                    15307.52       88.49%
+roda                     14550.56       84.11%
+hanami-router            14342.92       82.91%
+cuba                     14246.23       82.35%
+hobbit                   14132.20       81.69%
+rambutan                 12526.40       72.41%
+rack-app                 11696.66       67.61%
+flame                     7931.61       45.85%
+rails-metal               7761.75       44.87%
+sinatra                   4616.81       26.69%
+grape                     2401.66       13.88%
+hobby                     1805.93       10.44%
+rails-api                 1593.77        9.21%
+```
+
+### Memory
+
+```
+Framework       Allocs/Req Memsize/Req
+--------------------------------------
+rack                    40        3408
+roda                    43        4016
+syro                    44        4288
+cuba                    44        4056
+watts                   46        3648
+hobbit                  48        4416
+jeanine                 52        4576
+hobby                   52        5416
+rack-response           55        5128
+rails-metal             59        5848
+hanami-router           63        5184
+rambutan                79        6944
+rack-app                80        8424
+flame                  115        9648
+sinatra                179       13440
+grape                  250       26704
+rails-api              383       34949
+```
+
+## Todo 
+
+* Callback constraints 
+* File downloads 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshmn/jeanine.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jeanine/generator/new/Gemfile.tt

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+ruby "$RUBY_VERSION$"
+
+gem "jeanine"
+
+group :production do
+  gem "puma"
+end

data/lib/jeanine/generator/new/README.md.tt

@@ -0,0 +1,8 @@
+# README
+
+Welcome to your Jeanine app.
+
+## Start
+
+`$ bundle`
+`$ rackup`

data/lib/jeanine/generator/new/app.rb.tt

@@ -0,0 +1,10 @@
+require_relative 'boot'
+
+require 'jeanine'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Jeanine.groups)
+
+class App < ::Jeanine::App
+end

data/lib/jeanine/generator/new/config/boot.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/lib/jeanine/generator/new/config/environment.rb.tt

@@ -0,0 +1 @@
+require_relative '../app'

data/lib/jeanine/generator/new/config/puma.rb.tt

@@ -0,0 +1,35 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RACK_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RACK_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RACK_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!

data/lib/jeanine/generator/new/config.ru.tt

@@ -0,0 +1,3 @@
+require_relative './app'
+
+run App

data/lib/jeanine/version.rb

@@ -1,3 +1,3 @@
 module Jeanine
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeanine
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Josh Brody
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - exe/jeanine
 - lib/jeanine.rb
 - lib/jeanine/app.rb
@@ -126,6 +127,13 @@ files:
 - lib/jeanine/core_ext/nil_class.rb
 - lib/jeanine/core_ext/string.rb
 - lib/jeanine/environment.rb
+- lib/jeanine/generator/new/Gemfile.tt
+- lib/jeanine/generator/new/README.md.tt
+- lib/jeanine/generator/new/app.rb.tt
+- lib/jeanine/generator/new/config.ru.tt
+- lib/jeanine/generator/new/config/boot.rb.tt
+- lib/jeanine/generator/new/config/environment.rb.tt
+- lib/jeanine/generator/new/config/puma.rb.tt
 - lib/jeanine/headers.rb
 - lib/jeanine/mimes.rb
 - lib/jeanine/path_proxy.rb