RubyGems - docomo_css - Versions diffs - 0.0.1 → 0.0.2 - Mend

docomo_css 0.0.1 → 0.0.2

Files changed (14) hide show

data/README.rdoc CHANGED Viewed

@@ -13,20 +13,9 @@ Instead, every element must use its own style attribute, for example
 docomo_css works around this by inlining all CSS automatically for you.
-Furthermore, DoCoMo phones have a number of limitations about how you can style
-elements.  For instance, the following will not be rendered properly.
-  <h1 style="color:red">Foo</h1>
-However, this can be worked around by doing the following
-  <h1><span style="color:red">Foo</span></h1>
-This library will automatically do this transformation for you if you apply css styles to unsupported elements like h1.
 == Install
-  sudo gem install milk1000cc-docomo_css --source=http://gems.github.com
+  sudo gem install docomo_css
 == Usage
@@ -42,7 +31,6 @@ This library will automatically do this transformation for you if you apply css
     <%= stylesheet_link_tag 'foo', :media => 'handheld, tty' %>
   </head>
   <body>
-    <h1>Header</h1>
     <div class="title">bar</div>
   </body>
   </html>
@@ -51,10 +39,6 @@ This library will automatically do this transformation for you if you apply css
   .title {
     color: red;
   }
-  h1 {
-    color:blue:
-  }
   # result
   <html>
@@ -62,7 +46,6 @@ This library will automatically do this transformation for you if you apply css
     <%= stylesheet_link_tag 'foo', :media => 'handheld, tty' %>
   </head>
   <body>
-    <h1><span style="color:blue">Header</span></h1>
     <div class="title" style="color:red">bar</div>
   </body>
   </html>
@@ -80,4 +63,4 @@ Copyright (c) 2008 milk1000cc, released under the MIT license
 milk1000cc <mailto:info@milk1000.cc>
-Gem, refactorings, and additions by Paul McMahon <mailto:paul@mobalean.com>
+Gem and refactorings by Paul McMahon <mailto:paul@mobalean.com>

data/Rakefile CHANGED Viewed

@@ -31,7 +31,7 @@ begin
     s.homepage = "http://www.milk1000.cc/"
     s.authors = ["milk1000cc", "Paul McMahon"]
     s.add_dependency 'hpricot'
-    s.add_dependency 'milk1000cc-tiny_css'
+    s.add_dependency 'tiny_css'
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.1
1	+ 0.0.2

data/docomo_css.gemspec CHANGED Viewed

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name = %q{docomo_css}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["milk1000cc", "Paul McMahon"]
-  s.date = %q{2009-06-11}
+  s.date = %q{2010-09-15}
   s.description = %q{Inlines CSS so that you can use external CSS with docomo handsets.}
   s.email = %q{info@milk1000.cc}
   s.extra_rdoc_files = [
@@ -20,17 +23,17 @@ Gem::Specification.new do |s|
      "VERSION",
      "docomo_css.gemspec",
      "init.rb",
-     "install.rb",
      "lib/docomo_css.rb",
      "rails/init.rb",
+     "test/actual.css",
+     "test/actual.html",
      "test/docomo_css_test.rb",
-     "uninstall.rb"
+     "test/expected.html"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://www.milk1000.cc/}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{CSS inliner}
   s.test_files = [
     "test/docomo_css_test.rb"
@@ -38,9 +41,9 @@ Gem::Specification.new do |s|
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<hpricot>, [">= 0"])
       s.add_runtime_dependency(%q<tiny_css>, [">= 0"])
     else
@@ -52,3 +55,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<tiny_css>, [">= 0"])
   end
 end

data/init.rb CHANGED Viewed

@@ -1,2 +1 @@
-require 'docomo_css/rails'
-ActionController::Base.send :include, DocomoCss::Rails
+require File.join File.dirname(__FILE__), 'rails', 'init'

data/lib/docomo_css.rb CHANGED Viewed

@@ -1,130 +1,116 @@
-require 'hpricot'
+require 'nokogiri'
 require 'tiny_css'
 module DocomoCss
-  def self.handlers
-    unless defined?(@handlers)
-      element_handler = UnsupportedElementHandler.new(
-        (1..6).map {|i| "h#{i}"} + %w{p},
-        %w{font-size color})
-      @handlers = Hash.new {|h,k| h[k] = DefaultHandler.new(k, element_handler)}
-      ["a:link", "a:focus", "a:visited"].each do |k|
-        @handlers[k] = PseudoSelectorHandler.new(k)
-      end
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  module ClassMethods
+    def docomo_filter
+      after_filter DocomoCssFilter.new
     end
-    @handlers
   end
-  def self.inline_css(content, css_dir)
-    content.gsub!(/&#(\d+);/, 'HTMLCSSINLINERESCAPE\1::::::::')
+  class DocomoCssFilter
+    def after(controller)
+      return unless controller.response.content_type =~ /application\/xhtml\+xml/
+      return unless controller.request.user_agent =~ /docomo/i
+      return if docomo_2_0_browser?(controller)
+      body = escape_numeric_character_reference controller.response.body
+      body = embed_css remove_xml_declare(body)
+      controller.response.body = unescape_numeric_character_reference body
+    end
-    doc = Hpricot(content)
+    def embed_css(body)
+      doc = Nokogiri::HTML(body)
-    linknodes = doc/'//link[@rel="stylesheet"]'
-    linknodes.each do |linknode|
-      href = linknode['href']
-      next unless href && allowed_media_type?(linknode['media'])
-      if linknode['docomo_css'] == "ignore"
-        linknode.remove_attribute('docomo_css')
-        next
+      stylesheet_link_node(doc).each do |linknode|
+        href = linknode['href'] or next
+        next unless FileTest.exist? css_path(href)
+        css = TinyCss.new.read(css_path(href))
+        embed_pseudo_style(doc, extract_pseudo_style(css))
+        embed_style(doc, css)
       end
+      xml_declare(doc) + doc.to_xhtml(:indent => 0)
+    end
+    def xml_declare(doc)
+      <<-XML
+<?xml version="1.0" encoding="#{doc.encoding}"?>
+      XML
+    end
-      cssfile = File.join(css_dir, href)
-      cssfile.gsub!(/\?.+/, '')
-      css = TinyCss.new.read(cssfile)
+    def remove_xml_declare(body)
+      body.gsub(%r'<\?xml[^\?]*?\?>', '')
+    end
-      style_style = TinyCss.new
+    def embed_style(doc, css)
       css.style.each do |selector, style|
-        handlers[selector].replace(doc, style_style, style)
-      end
-      unless style_style.style.keys.empty?
-        style = %(<style type="text/css">#{ style_style.write_string }</style>)
-        (doc/('head')).append style
+        stringified_style = stringify_style(style)
+        doc.css(selector).each do |element|
+          element['style'] = merge_style element['style'], stringified_style
+        end
       end
     end
-    doc.search('//link[@docomo_css="remove_after_inline"]').remove
-    content = doc.to_html
-    content.gsub!(/HTMLCSSINLINERESCAPE(\d+)::::::::/, '&#\1;')
-    content
-  end
+    def stringify_style(style)
+      style.map { |k, v| "#{ k }:#{ v }" }.join ';'
+    end
-  def self.allowed_media_type?(s)
-    s.nil? || s =~ /handheld|all|tty/
-  end
+    def merge_style(style, other_style)
+      return other_style if style == nil
+      style += ";" unless style =~ /;\Z/
+      style + other_style
+    end
-  class Handler
-    def initialize(selector)
-      @selector = selector
+    def escape_numeric_character_reference(text)
+      text.gsub /&#(\d+);/, 'HTMLCSSINLINERESCAPE\1::::::::'
     end
-  end
-  class PseudoSelectorHandler < Handler
-    def replace(doc, style_style, style)
-      style_style.style[@selector] = style
+    def unescape_numeric_character_reference(text)
+      text.gsub /HTMLCSSINLINERESCAPE(\d+)::::::::/, '&#\1;'
     end
-  end
-  class DefaultHandler < Handler
-    def initialize(selector, element_handler)
-      super(selector)
-      @element_handler = element_handler
+    def stylesheet_link_node(document)
+      document.xpath '//link[@rel="stylesheet"]'
     end
-    def replace(doc, style_style, style)
-      (doc/(@selector)).each do |element|
-        @element_handler.add_style(element, style)
-      end
+    def css_path(href)
+      File.join(Rails.root, 'public', href.gsub(/\?\d+/, ''))
     end
-  end
-  class UnsupportedElementHandler
-    def initialize(unsupported_elements, unsupported_styles)
-      @unsupported_elements = unsupported_elements
-      @unsupported_styles = unsupported_styles
+    def extract_pseudo_style(css)
+      pseudo_style = TinyCss.new
+      pseudo_selectors(css).each do |v|
+        pseudo_style.style[v] = css.style[v]
+        css.style.delete(v)
+      end
+      pseudo_style
     end
-    def add_style(element, style)
-      if @unsupported_elements.include?(element.name)
-        unsupported = TinyCss::OrderedHash.new
-        supported = TinyCss::OrderedHash.new
-        style.each do |k,v|
-          s = @unsupported_styles.include?(k) ? unsupported : supported
-          s[k] = v
-        end
+    def embed_pseudo_style(doc, pseudo_style)
+      return if pseudo_style.style.keys.empty?
-        #TODO: unit test
-        _add_style(element, supported) unless supported.keys.empty?
-        unless unsupported.keys.empty?
-          # BUG: assumes source contains no span wrapped in selector
-          wrapped_children = element.search("span")
-          if wrapped_children.empty?
-            element.search("/").wrap("<span></span>")
-            wrapped_children = element.search("span")
-          end
-          wrapped_children.each do |c|
-            add_style(c, unsupported)
-          end
-        end
-      else
-        _add_style(element, style)
-      end
+      raise unless doc.at('/html/head')
+      doc.at('/html/head').add_child <<-STYLE
+<style type="text/css">
+#{pseudo_style.write_string}
+</style>
+      STYLE
+      doc
     end
-    def _add_style(element, style)
-      style_attr = element[:style]
-      style_attr = (!style_attr) ? stringify_style(style) :
-        [style_attr, stringify_style(style)].join(';')
-      element[:style] = style_attr
+    def pseudo_selectors(css)
+      css.style.keys.grep(/a:(link|focus|visited)/)
     end
     private
-    def stringify_style(style)
-      style.map { |k, v| "#{ k }:#{ v }" }.join ';'
+    def docomo_2_0_browser?(controller)
+      controller.request.user_agent =~ /DoCoMo\/2\.0 [^(]*\(c(\d+);/ && $1.to_i >= 500
     end
   end
 end

data/rails/init.rb CHANGED Viewed

@@ -1,2 +1,2 @@
-require 'docomo_css/rails'
-ActionController::Base.send :include, DocomoCss::Rails
+require 'docomo_css'
+ActionController::Base.send :include, DocomoCss

data/test/actual.css ADDED Viewed

@@ -0,0 +1,4 @@
+a:link      { color: red; }
+a:focus     { color: green; }
+a:visited   { color: blue; }
+div.content { background-color: #999 }

data/test/actual.html ADDED Viewed

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="Shift_JIS"?>
+<!DOCTYPE html PUBLIC "-//i-mode group (ja)//DTD XHTML i-XHTML(Locale/Ver.=ja/2.3) 1.0//EN" "i-xhtml_4ja_10.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=Shift_JIS" />
+<link rel="stylesheet" href="/actual.css" />
+</head>
+<body>
+<div class="content">
+<a href="/">TOP</a>
+</div>
+</body>
+</html>

data/test/docomo_css_test.rb CHANGED Viewed

@@ -1,46 +1,194 @@
 require 'test/unit'
 require 'rubygems'
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..',  'lib')
-require 'docomo_css'
+require 'mocha'
+require File.join File.dirname(__FILE__), '..', 'lib', 'docomo_css'
+Rails = Mocha::Mockery.instance.unnamed_mock
+Rails.stubs(:root => File.dirname(__FILE__))
 class DocomoCssTest < Test::Unit::TestCase
-  def self.data_path
-    File.join(File.dirname(__FILE__), "data")
-  end
-  Dir.glob(File.join(data_path, "html", "*")) do |f|
-    s = File.basename(f,".html")
-    define_method("test_#{s}") do
-      e = expected(s)
-      i = inline(s)
-      e_lines = e.split("\n")
-      i_lines = i.split("\n")
-      e_lines.each_with_index do |s,j|
-        assert_equal(s, i_lines[j])
-      end
-      assert_equal e, i, "#{s} did not match"
+  def setup
+    @filter = DocomoCss::DocomoCssFilter.new
+  end
+  def test_invalid_response_content_type
+    response = mock("invalid_response") do
+      expects(:content_type).returns('text/html').once
+      expects(:body).never
+    end
+    controller = stub("invalid_controller", :response => response)
+    @filter.after(controller)
+  end
+  def test_escape_numeric_character_reference
+    assert_equal "HTMLCSSINLINERESCAPE123456789::::::::", @filter.escape_numeric_character_reference("&#123456789;")
+  end
+  def test_unescape_numeric_character_reference
+    assert_equal "&#123456789;", @filter.unescape_numeric_character_reference("HTMLCSSINLINERESCAPE123456789::::::::")
+  end
+  def test_pseudo_selectors
+    css = TinyCss.new.read_string(<<-CSS)
+a:visited { color: FF00FF; }
+    CSS
+    assert_equal ["a:visited"], @filter.pseudo_selectors(css)
+    css = TinyCss.new.read_string(<<-CSS)
+.purple { color: FF00FF; }
+    CSS
+    assert_equal [], @filter.pseudo_selectors(css)
+  end
+  def test_stylesheet_link_node
+    doc = Nokogiri::HTML(<<-HTML)
+<link href="a.css"/>
+<link href="b.css" rel="stylesheet"/>
+    HTML
+    @filter.stylesheet_link_node(doc).each do |node|
+      assert_equal 'b.css', node['href']
+    end
+  end
+  def test_css_path
+    href = "/stylesheets/all.css?1274411517"
+    assert_equal "#{Rails.root}/public/stylesheets/all.css", @filter.css_path(href)
+  end
+  def test_extract_pseudo_style
+    css = TinyCss.new.read_string <<-CSS
+a:link    { color: red; }
+a:focus   { color: green; }
+a:visited { color: blue; }
+div.title { background-color: #999 }
+    CSS
+    pseudo_style = @filter.extract_pseudo_style css
+    assert_equal('red', pseudo_style.style['a:link']['color'])
+    assert_equal('green', pseudo_style.style['a:focus']['color'])
+    assert_equal('blue', pseudo_style.style['a:visited']['color'])
+    assert_equal('#999', css.style['div.title']['background-color'])
+  end
+  def test_embed_pseudo_style
+    css = TinyCss.new
+    assert_equal nil, @filter.embed_pseudo_style(nil, css)
+    css = TinyCss.new.read_string <<-CSS
+a:link    { color: red; }
+a:focus   { color: green; }
+a:visited { color: blue; }
+    CSS
+    doc = Nokogiri::HTML <<-HTML
+<html>
+<head></head>
+<body></body>
+</html>
+    HTML
+    doc = @filter.embed_pseudo_style doc, css
+    assert_match %r'<style .*?/style>'m, doc.to_xhtml
+    doc = Nokogiri::HTML <<-HTML
+<html>
+<body></body>
+</html>
+    HTML
+    assert_raise RuntimeError do
+      @filter.embed_pseudo_style doc, css
     end
   end
-  def inline(file_name)
-    DocomoCss.inline_css(html(file_name), data_path)
+  def test_embed_style
+    css = TinyCss.new.read_string <<-CSS
+.title { color: red; }
+    CSS
+    doc = Nokogiri::HTML <<-HTML
+<html>
+<body>
+<div class="title">bar</div>
+</body>
+</html>
+    HTML
+    @filter.embed_style doc, css
+    assert_match %r'style="color:red"', doc.to_xhtml
+    doc = Nokogiri::HTML <<-HTML
+<html>
+<body>
+<div class="title" style="background-color:black">bar</div>
+</body>
+</html>
+    HTML
+    @filter.embed_style doc, css
+    assert_match %r'style="background-color:black;color:red"', doc.to_xhtml
+    doc = Nokogiri::HTML <<-HTML
+<html>
+<body>
+<div class="title" style="background-color:silver;">bar</div>
+</body>
+</html>
+    HTML
+    @filter.embed_style doc, css
+    assert_match %r'style="background-color:silver;color:red"', doc.to_xhtml
+  end
+  def test_xml_declare
+    doc = stub("doc", :encoding => "Shift_JIS")
+    assert_equal <<-XML, @filter.xml_declare(doc)
+<?xml version="1.0" encoding="Shift_JIS"?>
+    XML
+    doc = stub("doc", :encoding => "UTF-8")
+    assert_equal <<-XML, @filter.xml_declare(doc)
+<?xml version="1.0" encoding="UTF-8"?>
+    XML
   end
-  def html(file_name)
-    read_html("html", file_name)
+  def test_remove_xml_declare
+    assert_equal '', @filter.remove_xml_declare('<?xml version="1.0"?>')
+    assert_equal '', @filter.remove_xml_declare('<?xml encoding="Shift_JIS"?>')
+    assert_equal '', @filter.remove_xml_declare('<?xml version="1.0" encoding="Shift_JIS" ?>')
+    assert_equal '', @filter.remove_xml_declare('<?xml?>')
   end
-  def expected(file_name)
-    read_html("expected_html", file_name)
+  def test_output_with_docomo_1_0_browser
+    request = stub('request', :user_agent => 'DoCoMo/2.0 D905i(c100;TB;W24H17)')
+    response = stub("response") do
+      expects(:content_type).returns('application/xhtml+xml')
+      expects(:body).returns(File.open(File.join(File.dirname(__FILE__), 'actual.html'), 'rb'){ |f| f.read })
+      expects(:body=).with(File.open(File.join(File.dirname(__FILE__), 'expected.html'), 'rb'){ |f| f.read })
+    end
+    controller = stub("controller", :response => response, :request => request)
+    @filter.stubs(:css_path).returns(File.join(File.dirname(__FILE__), 'actual.css'))
+    @filter.after(controller)
   end
-  def read_html(dir, file_name)
-    File.open(File.join(data_path, dir, "#{file_name}.html")) do |f|
-      f.read
+  def test_output_with_docomo_1_0_browser_and_utf8_charset
+    request = stub('request', :user_agent => 'DoCoMo/2.0 D905i(c100;TB;W24H17)')
+    response = stub("response") do
+      expects(:content_type).returns('application/xhtml+xml; charset=utf-8')
+      expects(:body).returns(File.open(File.join(File.dirname(__FILE__), 'actual.html'), 'rb'){ |f| f.read })
+      expects(:body=).with(File.open(File.join(File.dirname(__FILE__), 'expected.html'), 'rb'){ |f| f.read })
     end
+    controller = stub("controller", :response => response, :request => request)
+    @filter.stubs(:css_path).returns(File.join(File.dirname(__FILE__), 'actual.css'))
+    @filter.after(controller)
   end
-  def data_path
-    self.class.data_path
+  def test_output_with_docomo_2_0_browser
+    request = stub('request', :user_agent => 'DoCoMo/2.0 N03B(c500;TB;W24H16)')
+    response = stub("response") do
+      expects(:content_type).returns('application/xhtml+xml')
+      expects(:body).never
+    end
+    controller = stub("controller", :response => response, :request => request)
+    @filter.after(controller)
   end
 end

data/test/expected.html ADDED Viewed

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="Shift_JIS"?>
+<!DOCTYPE html PUBLIC "-//i-mode group (ja)//DTD XHTML i-XHTML(Locale/Ver.=ja/2.3) 1.0//EN" "i-xhtml_4ja_10.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=Shift_JIS" />
+<link rel="stylesheet" href="/actual.css" />
+<style type="text/css">
+<![CDATA[
+a:visited {
+	color: blue;
+}
+a:link {
+	color: red;
+}
+a:focus {
+	color: green;
+}
+]]>
+</style>
+</head>
+<body>
+<div class="content" style="background-color:#999">
+<a href="/">TOP</a>
+</div>
+</body>
+</html>

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: docomo_css
 version: !ruby/object:Gem::Version
-  hash: 29
+  hash: 27
   prerelease: false
   segments:
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors:
 - milk1000cc
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-06-11 00:00:00 +09:00
+date: 2010-09-15 00:00:00 +09:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -63,11 +63,12 @@ files:
 - VERSION
 - docomo_css.gemspec
 - init.rb
-- install.rb
 - lib/docomo_css.rb
 - rails/init.rb
+- test/actual.css
+- test/actual.html
 - test/docomo_css_test.rb
-- uninstall.rb
+- test/expected.html
 has_rdoc: true
 homepage: http://www.milk1000.cc/
 licenses: []
@@ -100,7 +101,7 @@ requirements: []
 rubyforge_project:
 rubygems_version: 1.3.7
 signing_key:
-specification_version: 2
+specification_version: 3
 summary: CSS inliner
 test_files:
 - test/docomo_css_test.rb

data/install.rb DELETED Viewed

	@@ -1 +0,0 @@
1	- # Install hook code here

data/uninstall.rb DELETED Viewed

	@@ -1 +0,0 @@
1	- # Uninstall hook code here