RubyGems - rack-toolbar - Versions diffs - 0.1.0 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7290b0c5c77f8cdaea3f74a545caf3c9346752c
+  data.tar.gz: 1b421d6076390e190f3af39159958845638e96e2
+SHA512:
+  metadata.gz: f31c3485d5349def0489f9fa527751cbe2758cd9aa9a18fbfc9ea5e77a19b372b1c71c02d4101d8ead4a83cf19de1bb1dd8f259c394516836a7ba4853dce5efd
+  data.tar.gz: d8385ca9bb07b109ae0d8ec97caf3a80cec701b03179d396eade0bb8bd77967f2ad06ad644554aaa0efc05674f7be94db7f7e8f93a7ddce0840a9440fd6b95e5

data/.gitignore ADDED Viewed

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/.rspec ADDED Viewed

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml ADDED Viewed

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.2.1

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in rack-toolbar.gemspec
+gemspec

data/README.md ADDED Viewed

@@ -0,0 +1,85 @@
+# Rack::Toolbar
+Allows you to create simple Rack Middleware that will insert HTML (or whatever!) into responses at specific points.
+This gem was extracted from [Rack::Insight](https://github.com/pboling/rack-insight).
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'rack-toolbar'
+```
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install rack-toolbar
+## Usage
+If your app is delivering a response like:
+    <html>
+      <head></head>
+      <body>
+        <h1>Important</h1>
+      </body>
+    </html>
+### Simple Setup
+You want to inject something into the response!
+Configure your app to use Rack::Toolbar
+    use Rack::Toolbar, {snippet: "<div>More Important!</div>", insertion_point: "<body>", insertion_method: :after}
+The `div` specified will be injected `:after` the `<body` tag.
+    <html>
+      <head></head>
+      <body>
+        <div>More Important!</div>
+        <h1>Important</h1>
+      </body>
+    </html>
+### Easy Setup
+You want to build a Middleware that will deliver a custom response based on whatever.
+Create your middleware to inherit from Rack::Toolbar, and define a `render` method:
+    class CustomMiddleware < Rack::Toolbar
+      def render
+        "<script>javascript:void(0)</script>"
+      end
+    end
+Configure your app to use your CustomMiddleware.  You can still use the `:insertion_*` options, but `:snippet` will be ignored.
+    use CustomMiddleware, {insertion_point: "</head>", insertion_method: :before}
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Contributing
+1. Fork it ( https://github.com/[my-github-username]/destination_errors/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests!
+6. Create a new Pull Request
+## Contributors
+See the [Network View](https://github.com/pboling/rack-toolbar/network)

data/Rakefile ADDED Viewed

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+begin
+  require "rspec/core/rake_task"
+  desc 'Run specs'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.ruby_opts = '-w'
+  end
+  task :default => :spec
+rescue LoadError
+end

data/bin/console ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "rack/toolbar"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+require "irb"
+IRB.start

data/bin/setup ADDED Viewed

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+bundle install
+# Do any other automated setup that you need to do here

data/lib/rack/toolbar/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Rack
+  class Toolbar
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/toolbar.rb ADDED Viewed

@@ -0,0 +1,64 @@
+require "rack/toolbar/version"
+# Subclasses must define a render method which returns the snippet of HTML that will be inserted into the response body
+# according to the INSERTION_METHOD and INSERTION_POINT.  By default this is set before to the closing </body> tag.
+module Rack
+  class Toolbar
+    CONTENT_TYPE_REGEX = /text\/html|application\/xhtml\+xml/
+    INSERTION_METHOD = :before  # alternatively :after
+    INSERTION_POINT = "</body>" # alternatively "<body>" to have injection at the top of the body, or whatever else floats your boat.
+    SNIPPET = <<EOS
+  <h1>Welcome to rack-toolbar</h1>
+  <ul>
+    <li>Define render in Middleware subclass of Rack::Toolbar to return an HTML snippet.</li>
+    <li>or</li>
+    <li>Pass an HTML snippet as an argument and use Rack::Toolbar directly: Rack::Toolbar.new(snippet).</li>
+    <li>or</li>
+    <li>Redefine Rack::Toolbar::SNIPPET and ignore with the warnings.</li>
+  </ul>
+EOS
+    def initialize(app, options = {})
+      @app = app
+      @options = options || {}
+      @options[:snippet] ||= self.class::SNIPPET
+      @options[:insertion_point] ||= self.class::INSERTION_POINT
+      @options[:insertion_method] ||= self.class::INSERTION_METHOD
+    end
+    def call(env)
+      @status, @headers, @response = @app.call(env)
+      [@status, @headers, self]
+    end
+    def okay_to_modify?
+      return false unless @headers["Content-Type"] =~ self.class::CONTENT_TYPE_REGEX
+      true
+    end
+    def each(&block)
+      if okay_to_modify?
+        body = @response.inject("") do |memo, part|
+          memo << part
+          memo
+        end
+        index = body.rindex(@options[:insertion_point])
+        if index
+          if @options[:insertion_method] != :before
+            index += @options[:insertion_point].length
+          end
+          body.insert(index, render)
+          @headers["Content-Length"] = body.bytesize.to_s
+          @response = [body]
+        end
+      end
+      @response.each(&block)
+    end
+    def render
+      @options[:snippet]
+    end
+  end
+end

data/rack-toolbar.gemspec ADDED Viewed

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/toolbar/version'
+Gem::Specification.new do |spec|
+  spec.name          = "rack-toolbar"
+  spec.version       = Rack::Toolbar::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+  spec.summary       = %q{Provides an easy way to create Rack Middleware that injects things into the response body}
+  spec.description   = %q{Provides an easy way to create Rack Middleware that injects things into the response body. Extracted from rack-insight.}
+  spec.homepage      = "https://github.com/pboling/rack-toolbar"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata ADDED Viewed

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rack-toolbar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2015-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Provides an easy way to create Rack Middleware that injects things into
+  the response body. Extracted from rack-insight.
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/toolbar.rb
+- lib/rack/toolbar/version.rb
+- rack-toolbar.gemspec
+homepage: https://github.com/pboling/rack-toolbar
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.6
+signing_key:
+specification_version: 4
+summary: Provides an easy way to create Rack Middleware that injects things into the
+  response body
+test_files: []

rack-toolbar 0.1.0