sinatra-contrib 2.2.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afa15c985b40f0c6679ed5a072565e05bd65c1d61abc77fb54617f3b3c4dff98
-  data.tar.gz: d301da7cb0cbcefc3de53d2665fbd3aebf1244ae5ddc29c665cacd4b80f9ebc5
+  metadata.gz: b1606208f2d126996b156d899ccd999bbac16eede55a2b3fc4d5070260993cc5
+  data.tar.gz: be0646504c34bdc361f4242a236c8979f91b2958fe0f9cce401253bfc944036d
 SHA512:
-  metadata.gz: 36f4da234684c872e28d35f623f0587aa135fb34c372fd8be12f2037958bdaa9fccb9cd6b9c9e6514e12d3d613e388da0f4996d719a9c1a29d42db8fb9bd15c9
-  data.tar.gz: f50a7809a699a3b77d5c0d368f189fd860f5cc73451f1a67097b0af55030eec508be7c3f8b96fb6284751eab0c9d3f5c93e7e0fe130998107207413f0a63b9af
+  metadata.gz: 6a5cd60ad8293f3eaf839dca15ba27e25e20f7b0ac48b66c1fb0133709f1aec00492ade424fff55acd4fa3677fc390863d18be769172db953684b07a7c11f8d7
+  data.tar.gz: b7b269f3f99c2062da6e658f9c7ccbb2c3c48b333c23270f827425f6879801d68db51a6b844bbe34b0daf65d17945b91204f80e125c73bd8daba4248de3165d5

data/README.md

@@ -22,8 +22,8 @@ Currently included:
 
 * [`sinatra/config_file`][sinatra-config-file]: Allows loading configuration from yaml files.
 
-* [`sinatra/content_for`][sinatra-content-for]: Adds Rails-style `content_for` helpers to Haml, Erb, Erubi,
-  Erubis and Slim.
+* [`sinatra/content_for`][sinatra-content-for]: Adds Rails-style `content_for` helpers to Haml, Erb, Erubi
+  and Slim.
 
 * [`sinatra/cookies`][sinatra-cookies]: A `cookies` helper for reading and writing cookies.
 
@@ -58,7 +58,9 @@ existing APIs.
 
 Currently included:
 
-* [`sinatra/reloader`][sinatra-reloader]: Automatically reloads Ruby files on code changes.
+* [`sinatra/reloader`][sinatra-reloader]: Automatically reloads Ruby files on code changes. **DEPRECATED**: Please consider
+consider using an alternative like [rerun](https://github.com/alexch/rerun) or
+[rack-unreloader](https://github.com/jeremyevans/rack-unreloader) instead.
 
 ### Other Tools
 

data/Rakefile

@@ -1,12 +1,14 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'open-uri'
 require 'yaml'
 require 'sinatra/contrib/version'
 
-desc "run specs"
-task(:spec) { ruby '-S rspec spec -cw' }
-task(:test => :spec)
-task(:default => :spec)
+desc 'run specs'
+task(:spec) { ruby '-S rspec' }
+task(test: :spec)
+task(default: :spec)
 
 namespace :doc do
   task :readmes do
@@ -14,36 +16,37 @@ namespace :doc do
       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"
-      Dir.mkdir "doc" unless File.directory? "doc"
+      file = "doc/#{file[4..-4].tr('/_', '-')}.rdoc"
+      Dir.mkdir 'doc' unless File.directory? 'doc'
       puts "writing #{file}"
-      File.open(file, "w") { |f| f << doc }
+      File.open(file, 'w') { |f| f << doc }
     end
   end
 
   task :index do
-    doc = File.read("README.md")
-    file = "doc/sinatra-contrib-readme.md"
-    Dir.mkdir "doc" unless File.directory? "doc"
+    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 }
+    File.open(file, 'w') { |f| f << doc }
   end
 
-  task :all => [:readmes, :index]
+  task all: %i[readmes index]
 end
 
-desc "generate documentation"
-task :doc => 'doc:all'
+desc 'generate documentation'
+task doc: 'doc:all'
 
-desc "generate gemspec"
+desc 'generate gemspec'
 task 'sinatra-contrib.gemspec' do
   content = File.read 'sinatra-contrib.gemspec'
 
   fields = {
-    :authors => `git shortlog -sn`.scan(/[^\d\s].*/),
-    :email   => `git shortlog -sne`.scan(/[^<]+@[^>]+/),
-    :files   => `git ls-files`.split("\n").reject { |f| f =~ /^(\.|Gemfile)/ }
+    authors: `git shortlog -sn`.scan(/[^\d\s].*/),
+    email: `git shortlog -sne`.scan(/[^<]+@[^>]+/),
+    files: `git ls-files`.split("\n").grep_v(/^(\.|Gemfile)/)
   }
 
   fields.each do |field, values|
@@ -56,9 +59,9 @@ task 'sinatra-contrib.gemspec' do
   File.open('sinatra-contrib.gemspec', 'w') { |f| f << content }
 end
 
-task :gemspec => 'sinatra-contrib.gemspec'
+task gemspec: 'sinatra-contrib.gemspec'
 
-task :release => :gemspec do
+task release: :gemspec do
   sh <<-SH
     rm -Rf sinatra-contrib*.gem &&
     gem build sinatra-contrib.gemspec &&
@@ -70,4 +73,3 @@ task :release => :gemspec do
     git push --tags && (git push origin --tags || true)
   SH
 end
-

data/ideas.md

@@ -11,7 +11,7 @@
 
 * `sinatra-smart-cache`: update cache header only if arguments are more
   restrictive than curent value, set caching headers that way for most helper
-  methods (i.e. `sass` or `send_file`)
+  methods (i.e. `send_file`)
 
 * Some verbose logging extension: Log what filters, routes, error handlers,
   templates, and so on is used.
@@ -26,4 +26,4 @@
 
 * Rewrite of `sinatra-compass`?
 
-* Helpers for HTML escaping and such.
+* Helpers for HTML escaping and such.

data/lib/sinatra/capture.rb

@@ -86,17 +86,19 @@ module Sinatra
 
     def capture(*args, &block)
       return block[*args] if ruby?
+
       if haml? && Tilt[:haml] == Tilt::HamlTemplate
         buffer = Haml::Buffer.new(nil, Haml::Options.new.for_buffer)
         with_haml_buffer(buffer) { capture_haml(*args, &block) }
       else
-        @_out_buf, _buf_was = '', @_out_buf
+        buf_was = @_out_buf
+        @_out_buf = ''
         begin
           raw = block[*args]
           captured = block.binding.eval('@_out_buf')
           captured.empty? ? raw : captured
         ensure
-          @_out_buf = _buf_was
+          @_out_buf = buf_was
         end
       end
     end

data/lib/sinatra/config_file.rb

@@ -3,7 +3,6 @@ require 'yaml'
 require 'erb'
 
 module Sinatra
-
   # = Sinatra::ConfigFile
   #
   # <tt>Sinatra::ConfigFile</tt> is an extension that allows you to load the
@@ -107,7 +106,6 @@ module Sinatra
   #       bar: 'baz' # override the default value
   #
   module ConfigFile
-
     # When the extension is registered sets the +environments+ setting to the
     # traditional environments: development, test and production.
     def self.registered(base)
@@ -122,13 +120,10 @@ module Sinatra
         paths.each do |pattern|
           Dir.glob(pattern) do |file|
             raise UnsupportedConfigType unless ['.yml', '.yaml', '.erb'].include?(File.extname(file))
+
             logger.info "loading config file '#{file}'" if logging? && respond_to?(:logger)
-            document = ERB.new(IO.read(file)).result
-            yaml = begin
-              YAML.load(document, aliases: true)
-            rescue ArgumentError
-              YAML.load(document)
-            end
+            document = ERB.new(File.read(file)).result
+            yaml = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(document) : YAML.load(document)
             config = config_for_env(yaml)
             config.each_pair { |key, value| set(key, value) }
           end
@@ -136,7 +131,7 @@ module Sinatra
       end
     end
 
-    class UnsupportedConfigType < Exception
+    class UnsupportedConfigType < StandardError
       def message
         'Invalid config file type, use .yml, .yaml or .erb'
       end

data/lib/sinatra/content_for.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 require 'sinatra/capture'
 
 module Sinatra
-
   # = Sinatra::ContentFor
   #
   # <tt>Sinatra::ContentFor</tt> is a set of helpers that allows you to capture
   # blocks inside views to be rendered later during the request. The most
   # common use is to populate different parts of your layout from your view.
   #
-  # The currently supported engines are: Erb, Erubi, Erubis, Haml and Slim.
+  # The currently supported engines are: Erb, Erubi, Haml and Slim.
   #
   # == Usage
   #
@@ -174,11 +175,11 @@ module Sinatra
     # for <tt>:head</tt>.
     def yield_content(key, *args, &block)
       if block_given? && !content_for?(key)
-        (haml? && Tilt[:haml] == Tilt::HamlTemplate) ? capture_haml(*args, &block) : yield(*args)
+        haml? && Tilt[:haml] == Tilt::HamlTemplate ? capture_haml(*args, &block) : yield(*args)
       else
         content = content_blocks[key.to_sym].map { |b| capture(*args, &b) }
         content.join.tap do |c|
-          if block_given? && (erb? || erubi? || erubis?)
+          if block_given? && (erb? || erubi?)
             @_out_buf << c
           end
         end

data/lib/sinatra/contrib/all.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'sinatra/contrib'
 Sinatra.register Sinatra::Contrib::All

data/lib/sinatra/contrib/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 require 'sinatra/contrib/version'
 
@@ -5,7 +7,7 @@ module Sinatra
   module Contrib
     module Loader
       def extensions
-        @extensions ||= {:helpers => [], :register => []}
+        @extensions ||= { helpers: [], register: [] }
       end
 
       def register(name, path)

data/lib/sinatra/contrib/version.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Sinatra
   module Contrib
-    VERSION = '2.2.3'
+    VERSION = '3.0.0'
   end
 end
-

data/lib/sinatra/contrib.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/contrib/setup'
 
 module Sinatra
@@ -25,7 +27,6 @@ module Sinatra
     ##
     # Other extensions you don't want to be loaded unless needed.
     module Custom
-      # register :Compass, 'sinatra/compass'
       register :Reloader, 'sinatra/reloader'
     end
 

data/lib/sinatra/cookies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
 module Sinatra
@@ -65,15 +67,15 @@ module Sinatra
         @deleted         = []
 
         @options = {
-          :path => @request.script_name.to_s.empty? ? '/' : @request.script_name,
-          :domain => @request.host == 'localhost' ? nil : @request.host,
-          :secure   => @request.secure?,
-          :httponly => true
+          path: @request.script_name.to_s.empty? ? '/' : @request.script_name,
+          domain: @request.host == 'localhost' ? nil : @request.host,
+          secure: @request.secure?,
+          httponly: true
         }
 
-        if app.settings.respond_to? :cookie_options
-          @options.merge! app.settings.cookie_options
-        end
+        return unless app.settings.respond_to? :cookie_options
+
+        @options.merge! app.settings.cookie_options
       end
 
       def ==(other)
@@ -88,9 +90,11 @@ module Sinatra
         set(key, value: value)
       end
 
-      def assoc(key)
-        to_hash.assoc(key.to_s)
-      end if Hash.method_defined? :assoc
+      if Hash.method_defined? :assoc
+        def assoc(key)
+          to_hash.assoc(key.to_s)
+        end
+      end
 
       def clear
         each_key { |k| delete(k) }
@@ -114,17 +118,20 @@ module Sinatra
 
       def delete_if
         return enum_for(__method__) unless block_given?
+
         each { |k, v| delete(k) if yield(k, v) }
         self
       end
 
       def each(&block)
         return enum_for(__method__) unless block_given?
+
         to_hash.each(&block)
       end
 
       def each_key(&block)
         return enum_for(__method__) unless block_given?
+
         to_hash.each_key(&block)
       end
 
@@ -132,6 +139,7 @@ module Sinatra
 
       def each_value(&block)
         return enum_for(__method__) unless block_given?
+
         to_hash.each_value(&block)
       end
 
@@ -145,16 +153,18 @@ module Sinatra
         end
       end
 
-      def flatten
-        to_hash.flatten
-      end if Hash.method_defined? :flatten
+      if Hash.method_defined? :flatten
+        def flatten
+          to_hash.flatten
+        end
+      end
 
       def has_key?(key)
-        response_cookies.has_key? key.to_s or request_cookies.has_key? key.to_s
+        response_cookies.key? key.to_s or request_cookies.key? key.to_s
       end
 
       def has_value?(value)
-        response_cookies.has_value? value or request_cookies.has_value? value
+        response_cookies.value? value or request_cookies.value? value
       end
 
       def hash
@@ -164,22 +174,20 @@ module Sinatra
       alias include? has_key?
       alias member?  has_key?
 
-      def index(value)
-        warn "Hash#index is deprecated; use Hash#key"
-        key(value)
-      end
-
       def inspect
         "<##{self.class}: #{to_hash.inspect[1..-2]}>"
       end
 
-      def invert
-        to_hash.invert
-      end if Hash.method_defined? :invert
+      if Hash.method_defined? :invert
+        def invert
+          to_hash.invert
+        end
+      end
 
       def keep_if
         return enum_for(__method__) unless block_given?
-        delete_if { |*a| not yield(*a) }
+
+        delete_if { |*a| !yield(*a) }
       end
 
       def key(value)
@@ -202,11 +210,11 @@ module Sinatra
 
       def merge!(other)
         other.each_pair do |key, value|
-          if block_given? and include? key
-            self[key] = yield(key.to_s, self[key], value)
-          else
-            self[key] = value
-          end
+          self[key] = if block_given? && include?(key)
+                        yield(key.to_s, self[key], value)
+                      else
+                        value
+                      end
         end
       end
 
@@ -222,18 +230,20 @@ module Sinatra
 
       def reject(&block)
         return enum_for(__method__) unless block_given?
+
         to_hash.reject(&block)
       end
 
       alias reject! delete_if
 
       def replace(other)
-        select! { |k, v| other.include?(k) or other.include?(k.to_s)  }
+        select! { |k, _v| other.include?(k) or other.include?(k.to_s) }
         merge! other
       end
 
       def select(&block)
         return enum_for(__method__) unless block_given?
+
         to_hash.select(&block)
       end
 
@@ -251,9 +261,11 @@ module Sinatra
 
       alias size length
 
-      def sort(&block)
-        to_hash.sort(&block)
-      end if Hash.method_defined? :sort
+      if Hash.method_defined? :sort
+        def sort(&block)
+          to_hash.sort(&block)
+        end
+      end
 
       alias store []=
 
@@ -305,6 +317,7 @@ module Sinatra
         string.each_line do |line|
           key, value = line.split(';', 2).first.to_s.split('=', 2)
           next if key.nil?
+
           key = Rack::Utils.unescape(key)
           if line =~ /expires=Thu, 01[-\s]Jan[-\s]1970/
             @deleted << key
@@ -319,7 +332,7 @@ module Sinatra
       end
 
       def request_cookies
-        @request.cookies.reject { |key, value| deleted.include? key }
+        @request.cookies.reject { |key, _value| deleted.include? key }
       end
     end
 

data/lib/sinatra/custom_logger.rb

@@ -1,5 +1,6 @@
-module Sinatra
+# frozen_string_literal: true
 
+module Sinatra
   # = Sinatra::CustomLogger
   #
   # CustomLogger extension allows you to define your own logger instance

data/lib/sinatra/engine_tracking.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
 module Sinatra
@@ -12,21 +14,12 @@ module Sinatra
     end
 
     # Returns true if the current engine is `:erubi`, or `Tilt[:erb]` is set
-    # to Tilt::ErubisTemplate.
+    # to Tilt::ErubiTemplate.
     #
     # @return [Boolean] Returns true if current engine is `:erubi`.
     def erubi?
       @current_engine == :erubi or
-      erb? && Tilt[:erb] == Tilt::ErubiTemplate
-    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
+        (erb? && Tilt[:erb] == Tilt::ErubiTemplate)
     end
 
     # @return [Boolean] Returns true if current engine is `:haml`.
@@ -34,21 +27,6 @@ module Sinatra
       @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
@@ -64,31 +42,16 @@ module Sinatra
       @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
@@ -99,11 +62,6 @@ module Sinatra
       @current_engine == :slim
     end
 
-    # @return [Boolean] Returns true if current engine is `:creole`.
-    def creole?
-      @current_engine == :creole
-    end
-
     # @return [Boolean] Returns true if current engine is `:ruby`.
     def ruby?
       @current_engine == :ruby
@@ -116,7 +74,8 @@ module Sinatra
 
     # @param engine [Symbol, String] Name of Engine to shift to.
     def with_engine(engine)
-      @current_engine, engine_was = engine.to_sym, @current_engine
+      engine_was = @current_engine
+      @current_engine = engine.to_sym
       yield
     ensure
       @current_engine = engine_was

data/lib/sinatra/extension.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
 module Sinatra
-
   # = Sinatra::Extension
   #
   # <tt>Sinatra::Extension</tt> is a mixin that provides some syntactic sugar
@@ -81,13 +82,14 @@ module Sinatra
 
     def method_missing(method, *args, &block)
       return super unless Sinatra::Base.respond_to? method
+
       record(method, *args, &block)
       DontCall.new(method)
     end
 
     class DontCall < BasicObject
       def initialize(method) @method = method end
-      def method_missing(*) fail "not supposed to use result of #@method!" end
+      def method_missing(*) raise "not supposed to use result of #{@method}!" end
       def inspect; "#<#{self.class}: #{@method}>" end
     end
   end

data/lib/sinatra/json.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 require 'multi_json'
 module Sinatra
-
   # = Sinatra::JSON
   #
   # <tt>Sinatra::JSON</tt> adds a helper method, called +json+, for (obviously)
@@ -95,7 +96,7 @@ module Sinatra
 
     def json(object, options = {})
       content_type resolve_content_type(options)
-      resolve_encoder_action  object, resolve_encoder(options)
+      resolve_encoder_action object, resolve_encoder(options)
     end
 
     private
@@ -109,16 +110,14 @@ module Sinatra
     end
 
     def resolve_encoder_action(object, encoder)
-      [:encode, :generate].each do |method|
+      %i[encode generate].each do |method|
         return encoder.send(method, object) if encoder.respond_to? method
       end
-      if encoder.is_a? Symbol
-        object.__send__(encoder)
-      else 
-        fail "#{encoder} does not respond to #generate nor #encode"
-      end #if
-    end #resolve_encoder_action  
-  end #JSON
+      raise "#{encoder} does not respond to #generate nor #encode" unless encoder.is_a? Symbol
+
+      object.__send__(encoder)
+    end
+  end
 
   Base.set :json_encoder do
     ::MultiJson