sinatra-contrib 2.0.0 → 2.0.1.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf38ba43d86a4cf35be7c13891786306305a62ac
-  data.tar.gz: da10c8b52a05af663e40fa952b572c6101ff6280
+  metadata.gz: 1a615aeb430fc3798adc052a32db556b4cc14995
+  data.tar.gz: dee1f8d52eb7fcdfb96b9af0f19077419da5a6a6
 SHA512:
-  metadata.gz: afe2dee3e6795405b38d0a8423ae6429c64777d4b116c22155f011589df3d07ab579feab9574a5bbed4fac3d954b7460f0ed8e47e38bc755afcd877fec5cdf03
-  data.tar.gz: acbade89cb2796ccac556ee08ed0f838235902df156854882d730d238a045b9d5c996522e96899f774654022a4119c96951d237060f72a6d0b8d7543a8e18271
+  metadata.gz: d8958af5cf23ef811fe72c7e59f19d667e6e0ac81f39f5efb76158b90f7ee92af7aa3f684e796e8e0f31532c5629fb7fc8278c7569ef806427b8f2d84eb01309
+  data.tar.gz: a42fcd0f2141282102e8ae872b47915781112b2c93c51e2505ad4777e6a64eb66ffc2a4d494bde422d49c603904c8e26168d30d1b14f7f20e962f27a3d229760

data/README.md

@@ -18,38 +18,38 @@ installed with this gem.
 
 Currently included:
 
-* `sinatra/capture`: Let's you capture the content of blocks in templates.
+* [`sinatra/capture`][sinatra-capture]: Let's you capture the content of blocks in templates.
 
-* `sinatra/config_file`: Allows loading configuration from yaml files.
+* [`sinatra/config_file`][sinatra-config-file]: Allows loading configuration from yaml files.
 
-* `sinatra/content_for`: Adds Rails-style `content_for` helpers to Haml, Erb,
+* [`sinatra/content_for`][sinatra-content-for]: Adds Rails-style `content_for` helpers to Haml, Erb,
   Erubis and Slim.
 
-* `sinatra/cookies`: A `cookies` helper for reading and writing cookies.
+* [`sinatra/cookies`][sinatra-cookies]: A `cookies` helper for reading and writing cookies.
 
-* `sinatra/engine_tracking`: Adds methods like `haml?` that allow helper
+* [`sinatra/engine_tracking`][sinatra-engine-tracking]: Adds methods like `haml?` that allow helper
   methods to check whether they are called from within a template.
 
-* `sinatra/json`: Adds a `#json` helper method to return JSON documents.
+* [`sinatra/json`][sinatra-json]: Adds a `#json` helper method to return JSON documents.
 
-* `sinatra/link_header`: Helpers for generating `link` HTML tags and
+* [`sinatra/link_header`][sinatra-link-header]: Helpers for generating `link` HTML tags and
   corresponding `Link` HTTP headers. Adds `link`, `stylesheet` and `prefetch`
   helper methods.
 
-* `sinatra/multi_route`: Adds ability to define one route block for multiple
+* [`sinatra/multi_route`][sinatra-multi-route]: Adds ability to define one route block for multiple
   routes and multiple or custom HTTP verbs.
 
-* `sinatra/namespace`: Adds namespace support to Sinatra.
+* [`sinatra/namespace`][sinatra-namespace]: Adds namespace support to Sinatra.
 
-* `sinatra/respond_with`: Choose action and/or template automatically
+* [`sinatra/respond_with`][sinatra-respond-with]: Choose action and/or template automatically
   depending on the incoming request. Adds helpers `respond_to` and
   `respond_with`.
 
-* `sinatra/custom_logger`: This extension allows you to define your own
+* [`sinatra/custom_logger`][sinatra-custom-logger]: This extension allows you to define your own
   logger instance using +logger+ setting. That logger then will
   be available as #logger helper method in your routes and views.
 
-* `sinatra/required_params`: Ensure if required query parameters exist
+* [`sinatra/required_params`][sinatra-required-params]: Ensure if required query parameters exist
 
 ### Custom Extensions
 
@@ -58,13 +58,13 @@ existing APIs.
 
 Currently included:
 
-* `sinatra/reloader`: Automatically reloads Ruby files on code changes.
+* [`sinatra/reloader`][sinatra-reloader]: Automatically reloads Ruby files on code changes.
 
 ### Other Tools
 
-* `sinatra/extension`: Mixin for writing your own Sinatra extensions.
+* [`sinatra/extension`][sinatra-extension]: Mixin for writing your own Sinatra extensions.
 
-* `sinatra/test_helpers`: Helper methods to ease testing your Sinatra
+* [`sinatra/test_helpers`][sinatra-test-helpers]: Helper methods to ease testing your Sinatra
   application. Partly extracted from Sinatra. Testing framework agnostic
 
 ## Installation
@@ -153,3 +153,23 @@ end
 
 For more info check the [official docs](http://www.sinatrarb.com/contrib/) and
 [api docs](http://www.rubydoc.info/gems/sinatra-contrib).
+
+[sinatra-reloader]: /contrib/reloader
+[sinatra-namespace]: /contrib/namespace
+[sinatra-content-for]: /contrib/content_for
+[sinatra-cookies]: /contrib/cookies
+[sinatra-streaming]: /contrib/streaming
+[sinatra-webdav]: /contrib/webdav
+[sinatra-runner]: /contrib/runner
+[sinatra-extension]: /contrib/extension
+[sinatra-test-helpers]: /contrib/test_helpers
+[sinatra-required-params]: /contrib/required_params
+[sinatra-custom-logger]: /contrib/custom_logger
+[sinatra-multi-route]: /contrib/multi_route
+[sinatra-json]: /contrib/json
+[sinatra-respond-with]: /contrib/respond_with
+[sinatra-config-file]: /contrib/config_file
+[sinatra-link-header]: /contrib/link_header
+[sinatra-capture]: /contrib/capture
+[sinatra-engine-tracking]: /contrib/engine_tracking
+

data/Rakefile

@@ -11,7 +11,8 @@ task(:default => :spec)
 namespace :doc do
   task :readmes do
     Dir.glob 'lib/sinatra/*.rb' do |file|
-      excluded_files = %w[lib/sinatra/contrib.rb lib/sinatra/capture.rb lib/sinatra/decompile.rb lib/sinatra/engine_tracking.rb]
+      puts "Trying file... #{file}"
+      excluded_files = %w[lib/sinatra/contrib.rb lib/sinatra/decompile.rb]
       next if excluded_files.include?(file)
       doc  = File.read(file)[/^module Sinatra(\n)+(  #[^\n]*\n)*/m].scan(/^ *#(?!#) ?(.*)\n/).join("\n")
       file = "doc/#{file[4..-4].tr("/_", "-")}.rdoc"
@@ -21,7 +22,15 @@ namespace :doc do
     end
   end
 
-  task :all => [:readmes]
+  task :index do
+    doc = File.read("README.md")
+    file = "doc/sinatra-contrib-readme.md"
+    Dir.mkdir "doc" unless File.directory? "doc"
+    puts "writing #{file}"
+    File.open(file, "w") { |f| f << doc }
+  end
+
+  task :all => [:readmes, :index]
 end
 
 desc "generate documentation"

data/lib/sinatra/contrib/version.rb

@@ -1,6 +1,6 @@
 module Sinatra
   module Contrib
-    VERSION = '2.0.0'
+    VERSION = '2.0.1.rc1'
   end
 end
 

data/lib/sinatra/engine_tracking.rb

@@ -1,74 +1,96 @@
 require 'sinatra/base'
 
 module Sinatra
+  # Adds methods like `haml?` that allow helper methods to check whether they
+  # are called from within a template.
   module EngineTracking
     attr_reader :current_engine
 
+    # @return [Boolean] Returns true if current engine is `:erb`.
     def erb?
       @current_engine == :erb
     end
 
+    # Returns true if the current engine is `:erubis`, or `Tilt[:erb]` is set
+    # to Tilt::ErubisTemplate.
+    #
+    # @return [Boolean] Returns true if current engine is `:erubis`.
     def erubis?
       @current_engine == :erubis or
       erb? && Tilt[:erb] == Tilt::ErubisTemplate
     end
 
+    # @return [Boolean] Returns true if current engine is `:haml`.
     def haml?
       @current_engine == :haml
     end
 
+    # @return [Boolean] Returns true if current engine is `:sass`.
     def sass?
       @current_engine == :sass
     end
 
+    # @return [Boolean] Returns true if current engine is `:scss`.
     def scss?
       @current_engine == :scss
     end
 
+    # @return [Boolean] Returns true if current engine is `:less`.
     def less?
       @current_engine == :less
     end
 
+    # @return [Boolean] Returns true if current engine is `:builder`.
     def builder?
       @current_engine == :builder
     end
 
+    # @return [Boolean] Returns true if current engine is `:liquid`.
     def liquid?
       @current_engine == :liquid
     end
 
+    # @return [Boolean] Returns true if current engine is `:markdown`.
     def markdown?
       @current_engine == :markdown
     end
 
+    # @return [Boolean] Returns true if current engine is `:textile.
     def textile?
       @current_engine == :textile
     end
 
+    # @return [Boolean] Returns true if current engine is `:rdoc`.
     def rdoc?
       @current_engine == :rdoc
     end
 
+    # @return [Boolean] Returns true if current engine is `:radius.
     def radius?
       @current_engine == :radius
     end
 
+    # @return [Boolean] Returns true if current engine is `:markaby`.
     def markaby?
       @current_engine == :markaby
     end
 
+    # @return [Boolean] Returns true if current engine is `:coffee`.
     def coffee?
       @current_engine == :coffee
     end
 
+    # @return [Boolean] Returns true if current engine is `:nokogiri`.
     def nokogiri?
       @current_engine == :nokogiri
     end
 
+    # @return [Boolean] Returns true if current engine is `:slim`.
     def slim?
       @current_engine == :slim
     end
 
+    # @return [Boolean] Returns true if current engine is `:creole`.
     def creole?
       @current_engine == :creole
     end
@@ -78,6 +100,7 @@ module Sinatra
       super
     end
 
+    # @param engine [Symbol, String] Name of Engine to shift to.
     def with_engine(engine)
       @current_engine, engine_was = engine.to_sym, @current_engine
       yield

data/lib/sinatra/namespace.rb

@@ -318,9 +318,7 @@ module Sinatra
           pattern = nil
         end
         base_pattern, base_conditions = @pattern, @conditions
-        pattern         ||= default_pattern
-        base_pattern    ||= base.pattern    if base.respond_to? :pattern
-        base_conditions ||= base.conditions if base.respond_to? :conditions
+        pattern ||= default_pattern
         [ prefixed_path(base_pattern, pattern),
           (base_conditions || {}).merge(conditions) ]
       end

data/lib/sinatra/runner.rb

@@ -2,51 +2,51 @@ require 'open-uri'
 require 'net/http'
 require 'timeout'
 
-# NOTE: This feature is experimental, and missing tests!
-#
-# Helps you spinning up and shutting down your own sinatra app. This is especially helpful for running
-# real network tests against a sinatra backend.
-#
-# The backend server could look like the following (in test/server.rb).
-#
-#   require "sinatra"
-#
-#   get "/" do
-#     "Cheers from test server"
-#   end
-#
-#   get "/ping" do
-#     "1"
-#   end
-#
-# Note that you need to implement a ping action for internal use.
-#
-# Next, you need to write your runner.
-#
-#   require 'sinatra/runner'
-#
-#   class Runner < Sinatra::Runner
-#     def app_file
-#       File.expand_path("../server.rb", __FILE__)
-#     end
-#   end
-#
-# Override Runner#app_file, #command, #port, #protocol and #ping_path for customization.
-#
-# **Don't forget to override #app_file specific to your application!**
-#
-# Whereever you need this test backend, here's how you manage it. The following example assumes you
-# have a test in your app that needs to be run against your test backend.
-#
-#   runner = ServerRunner.new
-#   runner.run
-#
-#   # ..tests against localhost:4567 here..
-#
-#   runner.kill
-#
-# For an example, check https://github.com/apotonick/roar/blob/master/test/integration/runner.rb
 module Sinatra
+  # NOTE: This feature is experimental, and missing tests!
+  #
+  # Helps you spinning up and shutting down your own sinatra app. This is especially helpful for running
+  # real network tests against a sinatra backend.
+  #
+  # The backend server could look like the following (in test/server.rb).
+  #
+  #   require "sinatra"
+  #
+  #   get "/" do
+  #     "Cheers from test server"
+  #   end
+  #
+  #   get "/ping" do
+  #     "1"
+  #   end
+  #
+  # Note that you need to implement a ping action for internal use.
+  #
+  # Next, you need to write your runner.
+  #
+  #   require 'sinatra/runner'
+  #
+  #   class Runner < Sinatra::Runner
+  #     def app_file
+  #       File.expand_path("../server.rb", __FILE__)
+  #     end
+  #   end
+  #
+  # Override Runner#app_file, #command, #port, #protocol and #ping_path for customization.
+  #
+  # **Don't forget to override #app_file specific to your application!**
+  #
+  # Wherever you need this test backend, here's how you manage it. The following example assumes you
+  # have a test in your app that needs to be run against your test backend.
+  #
+  #   runner = ServerRunner.new
+  #   runner.run
+  #
+  #   # ..tests against localhost:4567 here..
+  #
+  #   runner.kill
+  #
+  # For an example, check https://github.com/apotonick/roar/blob/master/test/integration/runner.rb
   class Runner
     def app_file
       File.expand_path("../server.rb", __FILE__)

data/lib/sinatra/test_helpers.rb

@@ -10,7 +10,10 @@ require 'forwardable'
 module Sinatra
   Base.set :environment, :test
 
+  # Helper methods to ease testing your Sinatra application. Partly extracted
+  # from Sinatra. Testing framework agnostic.
   module TestHelpers
+    # Test variant of session, which exposes a `global_env`.
     class Session < Rack::Test::Session
       def global_env
         @global_env ||= {}
@@ -27,11 +30,107 @@ module Sinatra
     extend Forwardable
     attr_accessor :settings
 
+    # @!group Instance Methods delegated to last_response
+
+    # @!method body
+    #
+    # Body of last_response
+    #
+    # @see http://www.rubydoc.info/github/rack/rack/master/Rack/Response#body-instance_method
+    # @return [String] body of the last response
+
+    # @!method headers
+    #
+    # Headers of last_response
+    #
+    # @return [Hash] hash of the last response
+
+    # @!method status
+    #
+    # HTTP status of last_response
+    #
+    # @return [Integer] HTTP status of the last response
+
+    # @!method errors
+    #
+    # Errors of last_response
+    #
+    # @return [Array] errors of the last response
     def_delegators :last_response, :body, :headers, :status, :errors
+    # @!endgroup
+
+    # @!group Class Methods delegated to app
+
+    # @!method configure(*envs) {|_self| ... }
+    # @!scope class
+    # @yieldparam _self [Sinatra::Base] the object that the method was called on
+    #
+    # Set configuration options for Sinatra and/or the app. Allows scoping of
+    # settings for certain environments.
+
+    # @!method set(option, value = (not_set = true), ignore_setter = false, &block)
+    # @!scope class
+    # Sets an option to the given value. If the value is a proc, the proc will
+    # be called every time the option is accessed.
+    # @raise [ArgumentError]
+
+    # @!method enable(*opts)
+    # @!scope class
+    #
+    # Same as calling `set :option, true` for each of the given options.
+
+    # @!method disable(*opts)
+    # @!scope class
+    #
+    # Same as calling `set :option, false` for each of the given options.
+
+    # @!method use(middleware, *args, &block)
+    # @!scope class
+    # Use the specified Rack middleware
+
+    # @!method helpers(*extensions, &block)
+    # @!scope class
+    #
+    # Makes the methods defined in the block and in the Modules given in
+    # `extensions` available to the handlers and templates.
+
+    # @!method register(*extensions, &block)
+    # @!scope class
+    # Register an extension. Alternatively take a block from which an
+    # extension will be created and registered on the fly.
+
     def_delegators :app, :configure, :set, :enable, :disable, :use, :helpers, :register
+    # @!endgroup
+
+    # @!group Instance Methods delegated to current_session
+
+    # @!method env_for(uri = "", opts = {})
+    #
+    # Return the Rack environment used for a request to `uri`.
+    #
+    # @return [Hash]
     def_delegators :current_session, :env_for
+    # @!endgroup
+
+    # @!group Instance Methods delegated to rack_mock_session
+    # @!method cookie_jar
+    #
+    # Returns a {http://www.rubydoc.info/github/rack-test/rack-test/Rack/Test/CookieJar Rack::Test::CookieJar}.
+    #
+    # @return [Rack::Test::CookieJar]
     def_delegators :rack_mock_session, :cookie_jar
 
+    # @!endgroup
+
+    # Instantiate and configure a mock Sinatra app.
+    #
+    # Takes a `base` app class, or defaults to Sinatra::Base, and instantiates
+    # an app instance. Any given code in `block` is `class_eval`'d on this new
+    # instance before the instance is returned.
+    #
+    # @param base [Sinatra::Base] App base class
+    #
+    # @return [Sinatra] Configured mocked app
     def mock_app(base = Sinatra::Base, &block)
       inner = nil
       @app  = Sinatra.new(base) do
@@ -42,18 +141,35 @@ module Sinatra
       app
     end
 
+    # Replaces the configured app.
+    #
+    # @param base [Sinatra::Base] a configured app
     def app=(base)
       @app = base
     end
 
     alias set_app app=
 
+    # Returns a Rack::Lint-wrapped Sinatra app.
+    #
+    # If no app has been configured, a new subclass of Sinatra::Base will be
+    # used and stored.
+    #
+    # (Rack::Lint validates your application and the requests and
+    # responses according to the Rack spec.)
+    #
+    # @return [Sinatra::Base]
     def app
       @app ||= Class.new Sinatra::Base
       Rack::Lint.new @app
     end
 
     unless method_defined? :options
+      # Processes an OPTIONS request in the context of the current session.
+      #
+      # @param uri [String]
+      # @param params [Hash]
+      # @param env [Hash]
       def options(uri, params = {}, env = {}, &block)
         env = env_for(uri, env.merge(:method => "OPTIONS", :params => params))
         current_session.send(:process_request, uri, env, &block)
@@ -61,12 +177,18 @@ module Sinatra
     end
 
     unless method_defined? :patch
+      # Processes a PATCH request in the context of the current session.
+      #
+      # @param uri [String]
+      # @param params [Hash]
+      # @param env [Hash]
       def patch(uri, params = {}, env = {}, &block)
         env = env_for(uri, env.merge(:method => "PATCH", :params => params))
         current_session.send(:process_request, uri, env, &block)
       end
     end
 
+    # @return [Boolean]
     def last_request?
       last_request
       true
@@ -74,12 +196,15 @@ module Sinatra
       false
     end
 
+    # @raise [Rack::Test:Error] If sessions are not enabled for app
+    # @return [Hash] Session of last request, or the empty Hash
     def session
       return {} unless last_request?
       raise Rack::Test::Error, "session not enabled for app" unless last_env["rack.session"] or app.session?
       last_request.session
     end
 
+    # @return The env of the last request
     def last_env
       last_request.env
     end

data/sinatra-contrib.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "sinatra-contrib"
   s.version     = version
   s.description = "Collection of useful Sinatra extensions"
-  s.homepage    = "http://github.com/sinatra/sinatra/tree/master/sinatra-contrib"
+  s.homepage    = "http://www.sinatrarb.com/contrib/"
   s.license     = "MIT"
   s.summary     = s.description
   s.authors     = ["https://github.com/sinatra/sinatra/graphs/contributors"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-contrib
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1.rc1
 platform: ruby
 authors:
 - https://github.com/sinatra/sinatra/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-07 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1.rc1
 - !ruby/object:Gem::Dependency
   name: mustermann
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1.rc1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -400,7 +400,7 @@ files:
 - lib/sinatra/test_helpers.rb
 - lib/sinatra/webdav.rb
 - sinatra-contrib.gemspec
-homepage: http://github.com/sinatra/sinatra/tree/master/sinatra-contrib
+homepage: http://www.sinatrarb.com/contrib/
 licenses:
 - MIT
 metadata: {}
@@ -415,12 +415,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Collection of useful Sinatra extensions