RubyGems - rack-unscripted - Versions diffs - 0.1.0 - Mend

rack-unscripted 0.1.0

Files changed (11) hide show

data/.gitignore ADDED

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/Gemfile ADDED

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

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright 2011 Casey Dreier.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED

@@ -0,0 +1,76 @@
+= Rack::Unscripted
+This is a small piece of Rack middleware that will append a message to your HTML warning a user that they need to enable JavaScript in order to properly view your site.
+The Rack middleware will append a <tt><div></tt> right after the opening body tag, but hide it via a CSS directive that is written by JavaScript in the <tt><head></tt> section. This prevents any flashing that can happen by merely hiding the element via JS directly.  We don't use the <tt><noscript></tt> tag since it has spotty support and doesn't work when a user is using a browser plugin to whitelist JS on certain sites.
+The div that is created can be referenced in CSS the the id, <tt>rack-unscripted-no-javascript-warning</tt>, so you can style this warning (when it does get displayed) to your heart's content.
+== Example
+Original HTML:
+  <html>
+    <head>
+      <title>The Bucket of Truth</title>
+    </head>
+    <body>
+      ...stuff!...
+    </body>
+  </html>
+HTML with Rack::Unscripted enabled:
+  <html>
+    <head>
+      <title>The Bucket of Truth</title>
+      <script type="text/javascript">
+        document.write('<style>.rack-unscripted-no-javascript-warning { display:none }</style>');
+      </script>
+    </head>
+    <body>
+      <div id='rack-unscripted-no-javascript-warning'>
+        Warning, this site requires JavaScript to function properly. Please enable it.
+      </div>
+      ...stuff!...
+    </body>
+  </html>
+== Installation
+Make sure to install this gem:
+  gem install rack-unscripted
+or, add the following to your Gemfile:
+  gem 'rack-unscripted'
+Then you need to configure your middleware stack to use this library.
+== Usage
+  use Rack::Unscripted
+or
+  use Rack::Unscripted, "Custom warning message to users without JavaScript enabled."
+== Example Configuration
+=== Rails 3.x
+In config/initializers/rack_unscripted.rb
+  MyApplicationName::Application.config.middleware use "Rack::Unscripted"
+=== Rails 2.3.x
+In config/environment.rb
+  config.middleware.use "Rack::Unscripted"
+=== Sinatra
+  require 'rack/unscripted'
+  use Rack::Unscripted

data/Rakefile ADDED

	@@ -0,0 +1,2 @@
1	+ require 'bundler'
2	+ Bundler::GemHelper.install_tasks

data/lib/rack-unscripted.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'rack/unscripted'

data/lib/rack/unscripted.rb ADDED

@@ -0,0 +1,78 @@
+module Rack
+  class Unscripted
+    def initialize(app, warning_message = nil)
+      self.warning_message = warning_message if warning_message
+      @app = app
+    end
+    def call(env)
+      @status, @headers, @response = @app.call(env)
+      if valid_content_type?(@headers['Content-Type']) && valid_status?(@status)
+        @response.each do |response_line|
+          insert_js(response_line)   if response_line =~ head_regex
+          insert_html(response_line) if response_line =~ body_regex
+        end
+      end
+      [@status, @headers, @response]
+    end
+  private
+    attr_writer :warning_message
+    def insert_js(response_line)
+      add_to_content_length(inline_code.length)
+      response_line.sub!(head_regex, inline_code + '\1')
+    end
+    # Inserts HTML of javascript warning after the opening body tag.
+    def insert_html(response_line)
+      add_to_content_length(no_javascript_warning.length)
+      response_line.sub!(body_regex, '\1'+ no_javascript_warning)
+    end
+    def no_javascript_warning
+      "<div id='rack-unscripted-no-javascript-warning'>#{warning_message}</div>"
+    end
+    def inline_code
+      <<-END
+<script type="text/javascript">document.write('<style>#rack-unscripted-no-javascript-warning{display:none;}</style>');</script>
+      END
+    end
+    # Regular Expression to find the opening body tag.
+    def body_regex
+      /(<\s*body[^>]*>)/i
+    end
+    # Regular expression to find the closing </head> tag in a document.
+    def head_regex
+      /(<\s*\/head[^>]*>)/i
+    end
+    # Appends the given number to the current content length in the headers.
+    def add_to_content_length(number)
+      if @headers['Content-Length']
+        @headers['Content-Length'] = (@headers['Content-Length'].to_i + number.to_i).to_s
+      end
+    end
+    # Returns +true+ if the content type is text/html. No need to add this message
+    # to any other types of content.
+    def valid_content_type?(content_type)
+      content_type.respond_to?(:include?) && content_type.include?("text/html")
+    end
+    # Returns +true+ if the HTTP response code is such that we should append this warning message.
+    def valid_status?(response_code)
+      [200, 404].include? response_code.to_i
+    end
+    # Attribute reader for the warning message.  Sets a default value.
+    def warning_message
+      @warning_message ||= 'Warning, this site requires javascript to function properly. Please enable it.'
+    end
+  end
+end

data/lib/version.rb ADDED

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

data/rack-unscripted.gemspec ADDED

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+# $:.push File.expand_path("lib", __FILE__)
+require File.expand_path('../lib/version.rb', __FILE__)
+Gem::Specification.new do |s|
+  s.name        = "rack-unscripted"
+  s.version     = Rack::Unscripted::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Casey Dreier"]
+  s.email       = ["casey.dreier@gmail.com"]
+  s.homepage    = "https://github.com/daphonz/rack-unscripted"
+  s.summary     = %q{Rack middleware to add a textual warning to your site for users who have Javascript disabled.}
+  s.description = %q{Many sites these days absolutely require a user to have Javascript enabled in order to function properly. You may have one yourself. Users that either have JS disabled or only allow trusted sites to execute JS should be given a textual warning that their user experience may be hampered.
+This Rack middleware will append a div with a customizable message to the HTTP response body, right after the opening <body> tag. This warning message is then hidden via a CSS command that is written by Javascript.
+}
+  s.rubyforge_project = "rack-unscripted"
+  s.extra_rdoc_files  = ['README.rdoc']
+  s.license           = 'MIT'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency('rack-test')
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 1.0"])
+    else
+      s.add_dependency(%q<rack>, [">= 1.0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 1.0"])
+  end
+end

data/test/unscripted_test.rb ADDED

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rack/test'
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rack/unscripted')
+class Rack::UnscriptedTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  def app
+    @other_app ||= other_app
+    @custom_warning_message ||= nil
+    Rack::Unscripted.new(@other_app, @custom_warning_message)
+  end
+  def test_inline_js_added
+    get '/'
+    assert last_response.body.include?(app.send(:inline_code) + '</head>')
+  end
+  def test_default_warning_message_added_to_response_body
+    get '/'
+    assert last_response.body.include?("<body class=\"such-and-such\">" + app.send(:no_javascript_warning))
+  end
+  def test_custom_message_added_to_response_body
+    @custom_warning_message = "¡Se necissita activar JavaScript!"
+    get '/'
+    assert last_response.body.include?(@custom_warning_message)
+  end
+  def test_content_length_is_increased
+    get '/'
+    expected = app.send(:inline_code).length + app.send(:no_javascript_warning).length + test_page_html.length
+    assert_equal expected, last_response.headers['Content-Length'].to_i
+  end
+  def test_takes_no_action_on_non_html_content_type
+    json = "{\"success\":\"success\"}"
+    @other_app = other_app(200, {'Content-Type' =>  'application/json', 'Content-Length' => json.length.to_s}, Rack::Response.new(json))
+    get '/'
+    assert_equal json.length, last_response.headers['Content-Length'].to_i
+    assert_equal json, last_response.body
+  end
+  def test_takes_no_action_on_non_200_or_404_status_responses
+    # Obviously, this isn't all possible responses, but you get the idea.
+    [204, 302, 406, 500].each do |status|
+      @other_app = other_app(status)
+      get '/'
+      assert_equal test_page_html.length, last_response.headers['Content-Length'].to_i
+      assert_equal test_page_html, last_response.body
+    end
+  end
+  private
+  def other_app(status = 200, headers = nil, response = nil)
+    headers  = {'Content-Type' =>  'text/html', 'Content-Length' => test_page_html.length.to_s} unless headers
+    response =  Rack::Response.new(test_page_html) unless response
+    Proc.new do |env|
+      [status, headers, response]
+    end
+  end
+  def test_page_html
+    '<html><head></head><body class="such-and-such"><p>The Bucket of Truth</p></body></html>'
+  end
+end

metadata ADDED

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rack-unscripted
+version: !ruby/object:Gem::Version
+  hash: 27
+  prerelease:
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors:
+- Casey Dreier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-05-07 00:00:00 -04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 15
+        segments:
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+description: |
+  Many sites these days absolutely require a user to have Javascript enabled in order to function properly. You may have one yourself. Users that either have JS disabled or only allow trusted sites to execute JS should be given a textual warning that their user experience may be hampered.
+  This Rack middleware will append a div with a customizable message to the HTTP response body, right after the opening <body> tag. This warning message is then hidden via a CSS command that is written by Javascript.
+email:
+- casey.dreier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/rack-unscripted.rb
+- lib/rack/unscripted.rb
+- lib/version.rb
+- rack-unscripted.gemspec
+- test/unscripted_test.rb
+has_rdoc: true
+homepage: https://github.com/daphonz/rack-unscripted
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project: rack-unscripted
+rubygems_version: 1.6.2
+signing_key:
+specification_version: 3
+summary: Rack middleware to add a textual warning to your site for users who have Javascript disabled.
+test_files: []