jeanine 0.5.0 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: dab8651a092f6e68e49ce6774d3c1c3156e1cf51aed9e266a4afbc438c62c041
-  data.tar.gz: defb2a775a5ae99a7e19deca237f778a7795525339c35f6d1da2cdb917d64179
+SHA1:
+  metadata.gz: ae2f211b64bde8d5c7b65837dec687314bafedff
+  data.tar.gz: 119368f1a2e7ca316aba774c89cf14caa7b8b0dc
 SHA512:
-  metadata.gz: dfd4e2901c604b06a262da1d05a660ade74e4810ba25d4917ae1f873bf9f306213ca28b20b2a3c028f4ca5f95706e90d51566edff3bbe10c8559dec735d36377
-  data.tar.gz: 92e87f254903c370d1708fdd09dff0921e77ff3d5fa804fb424cfae86febc7aab1419bbde3665b9813c0801d89d567eb4e8e1a36cd2aba4e90531bfb9620d354
+  metadata.gz: 59fa12a8e324f5f8d5d23ab87c7e778f8ea746b87744d3a865f29b4725e4f1d3470a75f3db2947d425f063d6edcd583ea0316ac19823f92784b9378e8162f333
+  data.tar.gz: 6f142f86f7b67441e35bdbffacad9cc083007333b36165f3925f27aae4132a1d72418ac73ad850c51cc366730f2e8ca1f60c8dfd737564b83f3ea09fe8cb2870

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/exe/jeanine

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'jeanine/cli'
+
+Jeanine::CLI.new(ARGV).execute

data/lib/jeanine/app.rb

@@ -1,3 +1,4 @@
+require 'jeanine/cli'
 require 'jeanine/mimes'
 require 'jeanine/request'
 require 'jeanine/response'

data/lib/jeanine/cli.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+
+module Jeanine
+  class CLI
+    def initialize(args)
+      @args = args
+    end
+
+    def execute
+      if @args[0] == 'new'
+        command_new!
+      else
+        $stdout.puts "I don't know how to `#{@args[0]}`. Maybe you meant `new`?"
+      end
+    end
+
+    def command_new!
+      FileUtils.mkdir("#{@args[1]}") unless Dir.exists?("#{@args[1]}")
+      FileUtils.mkdir("#{@args[1]}/config") unless Dir.exists?("#{@args[1]}/config")
+      relative_dir = "lib/jeanine/generator/new"
+      Dir.glob("lib/jeanine/generator/new/**/*.*").each do |file|
+        new_dir = file.gsub(relative_dir, "#{@args[1]}")[0...-3]
+        FileUtils.copy_file(file, new_dir)
+      end
+      relative_dir = "lib/jeanine/generator/new/config"
+      Dir.glob("lib/jeanine/generator/new/config/**/*.*").each do |file|
+        new_dir = file.gsub(relative_dir, "#{@args[1]}/config")[0...-3]
+        FileUtils.copy_file(file, new_dir)
+      end
+    end
+  end
+end

data/lib/jeanine/core_ext/hash.rb

@@ -5,4 +5,19 @@ class Hash
   def reverse_merge!(other_hash)
     replace(reverse_merge(other_hash))
   end
+  def deep_transform_keys(&block)
+    result = {}
+    each do |key, value|
+      result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
+    end
+    result
+  end
+
+  def deep_transform_keys!(&block)
+    keys.each do |key|
+      value = delete(key)
+      self[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys!(&block) : value
+    end
+    self
+  end
 end

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.ru.tt

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

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/request.rb

@@ -16,6 +16,10 @@ module Jeanine
       super
     end
 
+    def params
+      super.deep_transform_keys!(&:to_sym)
+    end
+
     def post?
       request_method == 'POST'
     end

data/lib/jeanine/{rescuing.rb → rescuable.rb}

@@ -1,5 +1,5 @@
 module Jeanine
-  module Rescuing
+  module Rescuable
     def self.included(base)
       base.extend ClassMethods
       base.prepend InstanceMethods

data/lib/jeanine/version.rb

@@ -1,3 +1,3 @@
 module Jeanine
-  VERSION = "0.5.0"
+  VERSION = "0.7.3"
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: jeanine
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.3
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
@@ -108,28 +108,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A framework.
+description: A lightning-fast, batteries-included Ruby web micro-framework.
 email:
 - git@josh.mn
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- exe/jeanine
 - lib/jeanine.rb
 - lib/jeanine/app.rb
 - lib/jeanine/callbacks.rb
+- lib/jeanine/cli.rb
 - lib/jeanine/core_ext.rb
 - lib/jeanine/core_ext/array.rb
 - lib/jeanine/core_ext/hash.rb
 - 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
 - lib/jeanine/rendering.rb
 - lib/jeanine/request.rb
-- lib/jeanine/rescuing.rb
+- lib/jeanine/rescuable.rb
 - lib/jeanine/response.rb
 - lib/jeanine/router.rb
 - lib/jeanine/routing.rb
@@ -161,8 +171,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
-summary: A framework.
+summary: A lightning-fast, batteries-included Ruby web micro-framework.
 test_files: []