sinatra-default_charset 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+=== 0.2.0 / 2010-05-24
+
+* 2 major enhancements
+
+  * Tests
+  * Can remove the charset by passing :charset => nil
+  * Defaults discovered from $kcode or Encoding.default_external
+
 === 0.1.0 / 2010-05-24
 
 * 1 major enhancement

data/Manifest.txt

@@ -4,4 +4,4 @@ Manifest.txt
 README.rdoc
 Rakefile
 lib/sinatra/default_charset.rb
-test/test_sinatra_default_charset.rb
+test/test_sinatra/test_default_charset.rb

data/README.rdoc

@@ -9,21 +9,47 @@
 
 == DESCRIPTION:
 
-Sets a default charset in the MIME headers. Defaults to utf-8.
+Sets a default charset in the MIME headers. Defaults to
+Encoding.default_external on ruby 1.9, and to $kcode on ruby 1.8, or falls
+back to utf-8 when neither are available.
+
+Provides a setting called +default_charset+ that allows overriding the
+auto-discovered default.
+
+To remove the transmitted charset for a single request, simply pass +:charset
+=> nil+ as your parameter to the +content_type+ helper.
 
 == FEATURES/PROBLEMS:
 
-* TODO  add some actual tests
+* Applies a default charset field to the Content-Type header of all responses
+* Allows for removal of the default-applied field
+* Allows for per-request overrides of the value
 
 == SYNOPSIS:
 
   require 'sinatra/default_charset'
   register Sinatra::DefaultCharset
   set :default_charset, 'utf-8'
+  
+  get '/' do
+    "I'm utf-8"
+  end
+  
+  get '/shift_jis' do 
+    content_type :html, :charset => 'shift_jis'
+    "I'm shift_jis"
+  end
+  
+  get '/none' do
+    content_type :html, :charset => nil
+    "I have no charset in my headers"
+  end
 
 == REQUIREMENTS:
 
-* sinatra
+* sinatra for runtime.
+
+* rack-test and minitest for testing.
 
 == INSTALL:
 

data/Rakefile

@@ -8,6 +8,7 @@ Hoe.spec 'sinatra-default_charset' do
   extra_dev_deps << %w(hoe-doofus >=1.0.0)
   extra_dev_deps << %w(hoe-git >=1.3.0)
   extra_dev_deps << %w(hoe-gemcutter >=1.0.0)
+  extra_dev_deps << %w(rack-test >=0.5.3)
   extra_deps << %w(sinatra >=1.0)
   self.extra_rdoc_files = FileList["**/*.rdoc"]
   self.history_file     = "CHANGELOG.rdoc"

data/lib/sinatra/default_charset.rb

@@ -2,15 +2,41 @@ require 'sinatra/base'
 
 module Sinatra
   module DefaultCharset
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 
+    DEFAULT_FALLBACK = 'utf-8'
+
+    charset = if defined?(Encoding) && Encoding.respond_to?(:default_external)
+      Encoding.default_external.to_s.downcase
+    else
+      case $kcode
+      when /n/i
+        DEFAULT_FALLBACK
+      when /e/i
+        'euc-jp'
+      when /s/i
+        'shift_jis'
+      when /u/i
+        'utf-8'
+      else
+        DEFAULT_FALLBACK
+      end
+    end
+
+    DEFAULT_CHARSET = charset
+
+    # Defaults to 
     def content_type(type, params = {})
-      params[:charset] ||= settings.default_charset
+      if params.include?(:charset)
+        params.delete(:charset) if params[:charset].nil?
+      else
+        params[:charset] = settings.default_charset
+      end
       super
     end
 
     def self.registered(app)
-      app.set :default_charset, 'utf-8'
+      app.set :default_charset, DEFAULT_CHARSET
       app.helpers self
       # re-default it so that we've always got a charset set
       app.before { content_type :html }

data/test/test_sinatra/test_default_charset.rb

@@ -0,0 +1,77 @@
+require "sinatra/default_charset"
+require 'minitest/unit'
+require 'rack/test'
+
+class TestSinatra; end
+class TestSinatra::TestDefaultCharset < MiniTest::Unit::TestCase
+  class TestApp < Sinatra::Base
+    register Sinatra::DefaultCharset
+
+    get '/' do
+      "hello world\n"
+    end
+    
+    get '/thing.xml' do
+      content_type :xml
+      'thing'
+    end
+    
+    get '/custom.xml' do
+      content_type :xml, :charset => 'iso-8859-1'
+      'custom'
+    end
+    
+    get '/none' do
+      content_type :html, :charset => nil
+      'none'
+    end
+  end
+
+  include Rack::Test::Methods
+
+  attr_reader :app
+
+  def test_defaults
+    # This test assumes you haven't set $kcode or Encoding.default_external to
+    # non-default values.
+    @app = TestApp.new
+    get '/'
+    assert last_response.ok?
+    assert_match 'charset=utf-8', last_response['Content-Type']
+    assert_equal "hello world\n", last_response.body
+  end
+  
+  def test_custom_content_type
+    @app = TestApp.new
+    get '/thing.xml'
+    assert_match 'charset=utf-8', last_response['Content-Type']
+    assert_match 'application/xml', last_response['Content-Type']
+    assert_equal 'thing', last_response.body
+  end
+  
+  def test_custom_content_type_and_charset
+    @app = TestApp.new
+    get '/custom.xml'
+    assert_match 'charset=iso-8859-1', last_response['Content-Type']
+    assert_match 'application/xml', last_response['Content-Type']
+    assert_equal 'custom', last_response.body
+  end
+  
+  def test_no_charset
+    @app = TestApp.new
+    get '/none'
+    refute_match 'charset=', last_response['Content-Type']
+    assert_match 'text/html', last_response['Content-Type']
+    assert_equal 'none', last_response.body
+  end
+  
+  class Windows < TestApp
+    set :default_charset, 'windows-1252'
+  end
+  
+  def test_set_default_charset
+    @app = Windows.new
+    get '/'
+    assert_match 'charset=windows-1252', last_response['Content-Type']
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - James Tucker
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-24 00:00:00 -03:00
+date: 2010-05-25 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,9 +87,23 @@ dependencies:
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rack-test
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -99,8 +113,8 @@ dependencies:
         - 0
         version: 2.6.0
   type: :development
-  version_requirements: *id006
-description: Sets a default charset in the MIME headers. Defaults to utf-8.
+  version_requirements: *id007
+description: helper.
 email: 
 - raggi@rubyforge.org
 executables: []
@@ -118,7 +132,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/sinatra/default_charset.rb
-- test/test_sinatra_default_charset.rb
+- test/test_sinatra/test_default_charset.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/sinatra-default_charset
 licenses: []
@@ -149,6 +163,6 @@ rubyforge_project: libraggi
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Sets a default charset in the MIME headers
+summary: helper.
 test_files: 
-- test/test_sinatra_default_charset.rb
+- test/test_sinatra/test_default_charset.rb

data/test/test_sinatra_default_charset.rb

@@ -1,15 +0,0 @@
-require "sinatra/default_charset"
-
-class TestSinatraDefaultCharset < MiniTest::Unit::TestCase
-  class TestApp < Sinatra::Base
-    register Sinatra::DefaultCharset
-
-    get '/' do
-      "hello world\n"
-    end
-  end
-  
-  def test_sanity
-    flunk "write tests or I will kneecap you"
-  end
-end