pirj-sinatra-contrib 1.3.0

data/lib/sinatra/streaming.rb

@@ -0,0 +1,267 @@
+require 'sinatra/base'
+require 'eventmachine'
+require 'backports'
+
+module Sinatra
+
+  # = Sinatra::Streaming
+  #
+  # Sinatra 1.3 introduced the +stream+ helper. This addon improves the
+  # streaming API by making the stream object immitate an IO object, turing
+  # it into a real Deferrable and making the body play nicer with middleware
+  # unaware of streaming.
+  #
+  # == IO-like behavior
+  #
+  # This is useful when passing the stream object to a library expecting an
+  # IO or StringIO object.
+  #
+  #   get '/' do
+  #     stream do |out|
+  #       out.puts "Hello World!", "How are you?"
+  #       out.write "Written #{out.pos} bytes so far!\n"
+  #       out.putc(65) unless out.closed?
+  #       out.flush
+  #     end
+  #   end
+  #
+  # == Proper Deferrable
+  #
+  # Handy when using EventMachine.
+  #
+  #   list = []
+  #
+  #   get '/' do
+  #     stream(false) do |out|
+  #       list << out
+  #       out.callback { list.delete out }
+  #       out.errback do
+  #         logger.warn "lost connection"
+  #         list.delete out
+  #       end
+  #     end
+  #   end
+  #
+  # == Better Middleware Handling
+  #
+  # Blocks passed to #map! or #map will actually be applied while streaming
+  # (as you might suspect, #map! applies modifications to the current body,
+  # #map creates a new one):
+  #
+  #   class StupidMiddleware
+  #     def initialize(app) @app = app end
+  #
+  #     def call(env)
+  #       status, headers, body = @app.call(env)
+  #       body.map! { |e| e.upcase }
+  #       [status, headers, body]
+  #     end
+  #   end
+  #
+  #   use StupidMiddleware
+  #
+  #   get '/' do
+  #     stream do |out|
+  #       out.puts "still"
+  #       sleep 1
+  #       out.puts "streaming"
+  #     end
+  #   end
+  #
+  # Even works if #each is used to generate an Enumerator:
+  #
+  #   def call(env)
+  #     status, headers, body = @app.call(env)
+  #     body = body.each.map { |s| s.upcase }
+  #     [status, headers, body]
+  #   end
+  #
+  # Note that both examples violate the Rack specification.
+  #
+  # == Setup
+  #
+  # In a classic application:
+  #
+  #   require "sinatra"
+  #   require "sinatra/streaming"
+  #
+  # In a modular application:
+  #
+  #   require "sinatra/base"
+  #   require "sinatra/streaming"
+  #   
+  #   class MyApp < Sinatra::Base
+  #     helpers Streaming
+  #   end
+  module Streaming
+    def stream(*)
+      stream = super
+      stream.extend Stream
+      stream.app = self
+      env['async.close'].callback { stream.close } if env.key? 'async.close'
+      stream
+    end
+
+    module Stream
+      include EventMachine::Deferrable
+
+      attr_accessor :app, :lineno, :pos, :transformer, :closed
+      alias tell pos
+      alias closed? closed
+
+      def self.extended(obj)
+        obj.closed, obj.lineno, obj.pos = false, 0, 0
+        obj.callback { obj.closed = true }
+        obj.errback  { obj.closed = true }
+      end
+
+      def <<(data)
+        raise IOError, 'not opened for writing' if closed?
+        data = data.to_s
+        data = @transformer[data] if @transformer
+        @pos += data.bytesize
+        super(data)
+      end
+
+      def each
+        # that way body.each.map { ... } works
+        return self unless block_given?
+        super
+      end
+
+      def map(&block)
+        # dup would not copy the mixin
+        clone.map!(&block)
+      end
+
+      def map!(&block)
+        if @transformer
+          inner, outer = @transformer, block
+          block = proc { |value| outer[inner[value]] }
+        end
+        @transformer = block
+        self
+      end
+
+      def write(data)
+        self << data
+        data.to_s.bytesize
+      end
+
+      alias syswrite      write
+      alias write_nonblock write
+
+      def print(*args)
+        args.each { |arg| self << arg }
+        nil
+      end
+
+      def printf(format, *args)
+        print(format.to_s % args)
+      end
+
+      def putc(c)
+        print c.chr
+      end
+
+      def puts(*args)
+        args.each { |arg| self << "#{arg}\n" }
+        nil
+      end
+
+      def close
+        @scheduler.schedule { succeed }
+        nil
+      end
+
+      def close_read
+        raise IOError, "closing non-duplex IO for reading"
+      end
+
+      def closed_read?
+        true
+      end
+
+      def closed_write?
+        closed?
+      end
+
+      def external_encoding
+        Encoding.find settings.default_encoding
+      rescue NameError
+        settings.default_encoding
+      end
+
+      def closed?
+        @closed
+      end
+
+      def settings
+        app.settings
+      end
+
+      def rewind
+        @pos = @lineno = 0
+      end
+
+      def not_open_for_reading(*)
+        raise IOError, "not opened for reading"
+      end
+
+      alias bytes         not_open_for_reading
+      alias eof?          not_open_for_reading
+      alias eof           not_open_for_reading
+      alias getbyte       not_open_for_reading
+      alias getc          not_open_for_reading
+      alias gets          not_open_for_reading
+      alias read          not_open_for_reading
+      alias read_nonblock not_open_for_reading
+      alias readbyte      not_open_for_reading
+      alias readchar      not_open_for_reading
+      alias readline      not_open_for_reading
+      alias readlines     not_open_for_reading
+      alias readpartial   not_open_for_reading
+      alias sysread       not_open_for_reading
+      alias ungetbyte     not_open_for_reading
+      alias ungetc        not_open_for_reading
+      private :not_open_for_reading
+
+      def enum_not_open_for_reading(*)
+        not_open_for_reading if block_given?
+        enum_for(:not_open_for_reading)
+      end
+
+      alias chars     enum_not_open_for_reading
+      alias each_line enum_not_open_for_reading
+      alias each_byte enum_not_open_for_reading
+      alias each_char enum_not_open_for_reading
+      alias lines     enum_not_open_for_reading
+      undef enum_not_open_for_reading
+
+      def dummy(*) end
+      alias flush             dummy
+      alias fsync             dummy
+      alias internal_encoding dummy
+      alias pid               dummy
+      undef dummy
+
+      def seek(*)
+        0
+      end
+
+      alias sysseek seek
+
+      def sync
+        true
+      end
+
+      def tty?
+        false
+      end
+
+      alias isatty tty?
+    end
+  end
+
+  helpers Streaming
+end

data/lib/sinatra/test_helpers.rb

@@ -0,0 +1,87 @@
+require 'sinatra/base'
+require 'rack/test'
+require 'rack'
+require 'forwardable'
+
+module Sinatra
+  Base.set :environment, :test
+
+  module TestHelpers
+    class Session < Rack::Test::Session
+      def global_env
+        @global_env ||= {}
+      end
+
+      private
+
+      def default_env
+        super.merge global_env
+      end
+    end
+
+    include Rack::Test::Methods
+    extend Forwardable
+    attr_accessor :settings
+
+    def_delegators :last_response, :body, :headers, :status, :errors
+    def_delegators :app, :configure, :set, :enable, :disable, :use, :helpers, :register
+    def_delegators :current_session, :env_for
+    def_delegators :rack_mock_session, :cookie_jar
+
+    def mock_app(base = Sinatra::Base, &block)
+      inner = nil
+      @app  = Sinatra.new(base) do
+        inner = self
+        class_eval(&block)
+      end
+      @settings = inner
+      app
+    end
+
+    def app=(base)
+      @app = base
+    end
+
+    alias set_app app=
+
+    def app
+      @app ||= Class.new Sinatra::Base
+      Rack::Lint.new @app
+    end
+
+    unless method_defined? :options
+      def options(uri, params = {}, env = {}, &block)
+        env = env_for(uri, env.merge(:method => "OPTIONS", :params => params))
+        current_session.send(:process_request, uri, env, &block)
+      end
+    end
+
+    unless method_defined? :patch
+      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
+
+    def last_request?
+      last_request
+      true
+    rescue Rack::Test::Error
+      false
+    end
+
+    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
+
+    def last_env
+      last_request.env
+    end
+
+    def build_rack_test_session(name) # :nodoc:
+      Session.new rack_mock_session(name)
+    end
+  end
+end

data/sinatra-contrib.gemspec

@@ -0,0 +1,121 @@
+# Run `rake sinatra-contrib.gemspec` to update the gemspec.
+Gem::Specification.new do |s|
+  s.name        = "pirj-sinatra-contrib"
+  s.version     = "1.3.0"
+  s.description = "Collection of useful Sinatra extensions"
+  s.homepage    = "http://github.com/sinatra/sinatra-contrib"
+  s.summary     = s.description
+
+  # generated from git shortlog -sn
+  s.authors = [
+    "Konstantin Haase",
+    "Gabriel Andretta",
+    "Nicolas Sanguinetti",
+    "Eliot Shepard",
+    "Andrew Crump",
+    "Matt Lyon",
+    "undr"
+  ]
+
+  # generated from git shortlog -sne
+  s.email = [
+    "konstantin.mailinglists@googlemail.com",
+    "ohhgabriel@gmail.com",
+    "contacto@nicolassanguinetti.info",
+    "eshepard@slower.net",
+    "andrew.crump@ieee.org",
+    "matt@flowerpowered.com",
+    "undr@yandex.ru"
+  ]
+
+  # generated from git ls-files
+  s.files = [
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "ideas.md",
+    "lib/sinatra/capture.rb",
+    "lib/sinatra/config_file.rb",
+    "lib/sinatra/content_for.rb",
+    "lib/sinatra/contrib.rb",
+    "lib/sinatra/contrib/all.rb",
+    "lib/sinatra/contrib/setup.rb",
+    "lib/sinatra/contrib/version.rb",
+    "lib/sinatra/decompile.rb",
+    "lib/sinatra/engine_tracking.rb",
+    "lib/sinatra/extension.rb",
+    "lib/sinatra/json.rb",
+    "lib/sinatra/link_header.rb",
+    "lib/sinatra/namespace.rb",
+    "lib/sinatra/reloader.rb",
+    "lib/sinatra/respond_with.rb",
+    "lib/sinatra/streaming.rb",
+    "lib/sinatra/test_helpers.rb",
+    "sinatra-contrib.gemspec",
+    "spec/capture_spec.rb",
+    "spec/config_file/key_value.yml",
+    "spec/config_file/missing_env.yml",
+    "spec/config_file/with_envs.yml",
+    "spec/config_file/with_nested_envs.yml",
+    "spec/config_file_spec.rb",
+    "spec/content_for/different_key.erb",
+    "spec/content_for/different_key.erubis",
+    "spec/content_for/different_key.haml",
+    "spec/content_for/different_key.slim",
+    "spec/content_for/layout.erb",
+    "spec/content_for/layout.erubis",
+    "spec/content_for/layout.haml",
+    "spec/content_for/layout.slim",
+    "spec/content_for/multiple_blocks.erb",
+    "spec/content_for/multiple_blocks.erubis",
+    "spec/content_for/multiple_blocks.haml",
+    "spec/content_for/multiple_blocks.slim",
+    "spec/content_for/multiple_yields.erb",
+    "spec/content_for/multiple_yields.erubis",
+    "spec/content_for/multiple_yields.haml",
+    "spec/content_for/multiple_yields.slim",
+    "spec/content_for/passes_values.erb",
+    "spec/content_for/passes_values.erubis",
+    "spec/content_for/passes_values.haml",
+    "spec/content_for/passes_values.slim",
+    "spec/content_for/same_key.erb",
+    "spec/content_for/same_key.erubis",
+    "spec/content_for/same_key.haml",
+    "spec/content_for/same_key.slim",
+    "spec/content_for/takes_values.erb",
+    "spec/content_for/takes_values.erubis",
+    "spec/content_for/takes_values.haml",
+    "spec/content_for/takes_values.slim",
+    "spec/content_for_spec.rb",
+    "spec/decompile_spec.rb",
+    "spec/extension_spec.rb",
+    "spec/json_spec.rb",
+    "spec/link_header_spec.rb",
+    "spec/namespace/foo.erb",
+    "spec/namespace/nested/foo.erb",
+    "spec/namespace_spec.rb",
+    "spec/okjson.rb",
+    "spec/reloader/app.rb.erb",
+    "spec/reloader_spec.rb",
+    "spec/respond_with/bar.erb",
+    "spec/respond_with/bar.json.erb",
+    "spec/respond_with/foo.html.erb",
+    "spec/respond_with/not_html.sass",
+    "spec/respond_with_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/streaming_spec.rb"
+  ]
+
+  s.add_dependency "sinatra",   "~> 1.3.0"
+  s.add_dependency "backports", ">= 2.0"
+  s.add_dependency "tilt",      "~> 1.3"
+  s.add_dependency "rack-test"
+  s.add_dependency "rack-protection"
+  s.add_dependency "eventmachine"
+
+  s.add_development_dependency "rspec", "~> 2.3"
+  s.add_development_dependency "haml"
+  s.add_development_dependency "erubis"
+  s.add_development_dependency "slim"
+  s.add_development_dependency "rake"
+end