galakei 0.3.8 → 0.4.0

data/Gemfile

@@ -10,4 +10,6 @@ group :development, :test do
   gem 'sqlite3'
   gem 'rspec-rails'
   gem 'haml'
+  gem 'css_parser'
+  gem 'fakeweb'
 end

data/README.md

@@ -2,7 +2,27 @@
 
 [Japanese feature phones](http://www.mobalean.com/en/keitai_web_technology_guide) (a.k.a., keitai, galakei) have a number of restrictions over normal web browsers.  This library adds support for them.
 
-### Goals
+## Goals
 
  * Provide support for 3G handsets from the major 3 carriers in Japan (docomo, au, SoftBank)
  * Avoid modifying Rails internals as much as possible
+
+## Examples
+
+### Inlining Styles
+
+Old docomo handsets [don't support external stylesheets](http://www.keitai-dev.net/CSS). Additionally, only very limited CSS is supported. galakei/docomo_css automatically inlines CSS and manipulates markup to overcome these limitations.
+
+    # css file
+    h1 { color: red; background-color: blue}
+
+    # source html
+    <h1>Foo</h1>
+
+    # outputted html
+    <div style="background-color: blue;"><h1><span style="color:red;">Foo</span></h1>/div>
+
+## Thanks
+
+ * To [jpmobile](https://github.com/jpmobile/jpmobile) for offering the most mature Rails plugin for Rails
+ * To [docomo_css](https://github.com/milk1000cc/docomo_css) for providing the inspiration for galakei/docomo_css

data/galakei.gemspec

@@ -17,8 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'actionpack', '>= 3.0.3'
   s.add_dependency 'rack', '>= 1.2.1'
-  s.add_dependency 'docomo_css', '~> 0.4.4'
- 
+  s.add_dependency 'css_parser'
  
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 end

data/lib/galakei/docomo_css/inline_stylesheet.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+require 'css_parser'
+
+class Galakei::DocomoCss::InlineStylesheet
+  def self.filter(controller)
+    return unless controller.request.imode_browser_1_0?
+    doc = Nokogiri::HTML(controller.response.body)
+    stylesheets = doc.xpath('//link[@rel="stylesheet"]')
+    return if stylesheets.empty?
+    stylesheets.each do |e|
+      e.unlink
+      parser = CssParser::Parser.new
+      uri = URI.parse(e['href'])
+      uri.scheme = controller.request.scheme unless uri.scheme
+      uri.host = controller.request.host unless uri.host
+      uri.port = controller.request.port unless uri.port
+      parser.load_uri!(uri)
+      stylesheet = Galakei::DocomoCss::Stylesheet.new(parser)
+      stylesheet.apply(doc)
+    end
+    controller.response.body = doc.to_xhtml(:encoding => doc.encoding)
+  end
+end

data/lib/galakei/docomo_css/railtie.rb

@@ -0,0 +1,11 @@
+module Galakei
+  module DocomoCss
+    class Railtie < Rails::Railtie
+      initializer "galakei.docomo_css" do |app|
+        ActiveSupport.on_load :action_controller do
+          after_filter Galakei::DocomoCss::InlineStylesheet
+        end
+      end
+    end
+  end
+end

data/lib/galakei/docomo_css/stylesheet.rb

@@ -0,0 +1,70 @@
+require "css_parser"
+
+class Galakei::DocomoCss::Stylesheet
+  def initialize(parsed_stylesheet)
+    @parsed_stylesheet = parsed_stylesheet
+  end
+
+  def apply(doc)
+    pseudo_styles = []
+    @parsed_stylesheet.each_rule_set do |ruleset|
+      ruleset.each_selector do |selector, declarations_string, specificity|
+        if selector =~ /a:(link|focus|visited)/
+          pseudo_styles << "#{selector} { #{declarations_string} }"
+        else
+          embed_style(doc, ruleset, selector)
+        end
+      end
+    end
+    unless pseudo_styles.empty?
+      doc.at("/html/head").add_child(<<-EOD)
+<style type="text/css">
+<![CDATA[
+#{pseudo_styles.join("\n")}
+]]>
+</style>
+EOD
+    end
+    doc
+  end
+
+  private
+
+  def merge_style(e, s)
+    if e["style"] 
+      e['style'] += ";" unless e['style'] =~ /;\Z/
+        e['style'] += s
+    else
+      e["style"] = s
+    end
+  end
+
+  def wrap_all_children(e, s)
+    new_parent = e.document.parse(s).first
+    e.children.each {|f| new_parent.add_child(f)}
+    e.add_child(new_parent)
+  end
+
+  def embed_style(doc, ruleset, selector)
+    doc.css(selector).each do |e| 
+      ruleset.each_declaration do |property, value, is_important|
+        s = "#{property}: #{value};"
+        if selector =~ /^(h\d|p)[^\s]*$/
+          if %w[color font-size].include?(property)
+            wrap_all_children(e, '<span>')
+            merge_style(e.children.first, s)
+          elsif %w[background-color].include?(property)
+            div = Nokogiri.make("<div>")
+            merge_style(div, s)
+            e.replace(div)
+            div.add_child(e)
+          else
+            merge_style(e, s)
+          end
+        else
+          merge_style(e, s)
+        end
+      end
+    end
+  end
+end

data/lib/galakei/docomo_css.rb

@@ -0,0 +1,4 @@
+module Galakei::DocomoCss
+  autoload :Stylesheet, "galakei/docomo_css/stylesheet"
+  autoload :InlineStylesheet, "galakei/docomo_css/inline_stylesheet"
+end

data/lib/galakei/emoji_table.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/string/output_safety'
 module Galakei
   class EmojiTable
     MAPPING = { 
@@ -22,10 +23,24 @@ module Galakei
       :sparkle => %w[2747 E6FA E46C E32E],
       :copyright_sign => %w[00A9 E731 E558 E24E],
       :registered_sign => %w[00AE E736 E559 E24F],
-      :trade_mark_sign => %w[2122 E732 E54E E537]
+      :trade_mark_sign => %w[2122 E732 E54E E537],
+      :hash_key => [ %w[0023 20E3] ] + %w[E6E0 EB84 E210],
+      :keycap_1 => [ %w[0031 20E3] ] + %w[E6E2 E522 E21C],
+      :keycap_2 => [ %w[0032 20E3] ] + %w[E6E3 E523 E21D],
+      :keycap_3 => [ %w[0033 20E3] ] + %w[E6E4 E524 E21E],
+      :keycap_4 => [ %w[0034 20E3] ] + %w[E6E5 E525 E21F],
+      :keycap_5 => [ %w[0035 20E3] ] + %w[E6E6 E526 E220],
+      :keycap_6 => [ %w[0036 20E3] ] + %w[E6E7 E527 E221],
+      :keycap_7 => [ %w[0037 20E3] ] + %w[E6E8 E528 E222],
+      :keycap_8 => [ %w[0040 20E3] ] + %w[E6E9 E529 E223],
+      :keycap_9 => [ %w[0041 20E3] ] + %w[E6EA E52A E224],
+      :keycap_0 => [ %w[0030 20E3] ] + %w[E6EB E52C E225],
     }
     MAPPING.each do |k,v|
-      MAPPING[k] = v.map {|s| "&#x#{s};".html_safe}
+      MAPPING[k] = v.map do |a| 
+        a = [ a ] if a.is_a?(String)
+        a.map {|s| "&#x#{s};"}.join.html_safe
+      end
       define_method k do
         MAPPING[k][@carrier]
       end

data/lib/galakei/railtie.rb

@@ -1,12 +1,9 @@
-require 'docomo_css'
-
 module Galakei
   class Railtie < Rails::Railtie
     config.galakei = ActiveSupport::OrderedOptions.new
-    initializer "galakei.extend.action_controller", :after => "docomo_css.extend.action_controller" do |app|
+    initializer "galakei.extend.action_controller" do |app|
       ActiveSupport.on_load :action_controller do
         include Galakei::HelperMethods
-        docomo_filter
         filters = %w[Views ContentType]
         filters << :Haml if defined?(Haml)
         filters.each {|f| Galakei::Filter.const_get(f).inject(self) }
@@ -19,3 +16,4 @@ module Galakei
 end
 
 require 'galakei/session_id_parameter/railtie'
+require 'galakei/docomo_css/railtie'

data/lib/galakei/session_id_parameter/railtie.rb

@@ -1,5 +1,3 @@
-require 'docomo_css'
-
 module Galakei
   module SessionIdParameter
     class Railtie < Rails::Railtie

data/lib/galakei/version.rb

@@ -1,3 +1,3 @@
 module Galakei
-  VERSION = "0.3.8"
+  VERSION = "0.4.0"
 end

data/lib/galakei.rb

@@ -1,9 +1,9 @@
 if defined?(Rails)
   require 'galakei/railtie'
   require 'galakei/use_rack_request_to_extract_sid'
-  require 'docomo_css/railtie'
 end
 require 'galakei/request'
+require 'galakei/docomo_css'
 
 module Galakei
   autoload :Email, "galakei/email"

data/spec/acceptance/app/app/views/haml/index.html.haml

@@ -0,0 +1 @@
+%br/

data/spec/acceptance/app/app/views/layouts/application.html.haml

@@ -1,4 +1,8 @@
+!!! XML
+!!! Mobile
 %html
   %head
+    %meta{"http-equiv" => "Content-Type", :content => "application/xhtml+xml;charset=UTF-8"}
+    = yield :head if content_for?(:head)
   %body
     = yield

data/spec/acceptance/docomo_css_spec.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/acceptance_helper')
+require 'fakeweb'
+
+class DocomoCssController < ApplicationController
+  def simple
+    html = <<-EOD
+      <% content_for(:head, stylesheet_link_tag("docomo_css/simple.css")) %>
+      <span>color</span>
+    EOD
+    render :inline => html, :layout => true
+  end
+
+  def external
+    html = <<-EOD
+      <% content_for(:head, stylesheet_link_tag("http://www.galakei.com/external.css")) %>
+      <span>color</span>
+    EOD
+    render :inline => html, :layout => true
+  end
+
+  def japanese
+    html = <<-EOD
+      <% content_for(:head, stylesheet_link_tag("docomo_css/simple.css")) %>
+      ほげ
+    EOD
+    render :inline => html, :layout => true
+  end
+end
+
+feature 'inlining of css' do
+  scenario 'requesting simple page for docomo', :driver => :docomo do
+    FakeWeb.register_uri(:get, 'http://www.example.com/stylesheets/docomo_css/simple.css', :body => "span { color: red }")
+    visit '/docomo_css/simple'
+    find("span")["style"].should == "color: red;"
+    page.should_not have_xpath("//link")
+  end
+  scenario 'requesting external page for docomo', :driver => :docomo do
+    FakeWeb.register_uri(:get, 'http://www.galakei.com/external.css', :body => "span { color: red }")
+    visit '/docomo_css/external'
+    find("span")["style"].should == "color: red;"
+    page.should_not have_xpath("//link")
+  end
+  %w[au softbank docomo_2_0].each do |carrier|
+    scenario "requesting simple page for #{carrier}", :driver => carrier.to_sym do
+      visit '/docomo_css/simple'
+      find("span")["style"].should be_nil
+    end
+  end
+
+  scenario 'response contains non-ascii', :driver => :docomo do
+    visit '/docomo_css/japanese'
+    page.body.should include("ほげ")
+  end
+end

data/spec/acceptance/haml_spec.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/acceptance_helper')
+
+class HamlController < ApplicationController
+end
+
+feature 'haml' do
+  %w[softbank au docomo].each do |s|
+    scenario "for #{s}", :driver => s.to_sym do
+      visit '/haml'
+      page.body.should include('<br />')
+      page.should have_css('br')
+    end
+  end
+end

data/spec/acceptance/handset_detection_spec.rb

@@ -19,7 +19,6 @@ class HandsetDetectionController < ApplicationController
   end
 end
 
-
 feature 'handset detection' do
   scenario 'for docomo', :driver => :docomo do
     visit '/handset_detection'

data/spec/acceptance/support/handsets.rb

@@ -13,6 +13,10 @@ Capybara.register_driver :docomo do |app|
   Capybara::Driver::RackTestWithUserAgent.new(app, "DoCoMo/2.0 P903i(c100;TB;W24H12)")
 end
 
+Capybara.register_driver :docomo_2_0 do |app|
+  Capybara::Driver::RackTestWithUserAgent.new(app, "DoCoMo/2.0 SH06A3(c500;TB;W24H14)")
+end
+
 Capybara.register_driver :au do |app|
   Capybara::Driver::RackTestWithUserAgent.new(app, "KDDI-CA32 UP.Browser/6.2.0.7.3.129 (GUI) MMP/2.0")
 end

data/spec/acceptance/views_spec.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/acceptance_helper')
+
+class ViewsController < ApplicationController
+  def index
+  end
+end
+
+feature 'View path appending' do
+  scenario 'for docomo', :driver => :docomo do
+    visit '/views'
+  end
+end

data/spec/galakei/docomo_css/stylesheet_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+require "nokogiri"
+
+describe Galakei::DocomoCss::Stylesheet do
+  context "simple stylesheet" do
+    before do
+      parser = CssParser::Parser.new
+      parser.add_block!(<<-EOD)
+        span {
+          color: red;
+        }
+      EOD
+      @stylesheet = described_class.new(parser)
+    end
+    it "should apply style to matching element" do
+      doc = Nokogiri::HTML.fragment("<span>foo</span>")
+      @stylesheet.apply(doc)
+      doc.to_s.should == %q{<span style="color: red;">foo</span>}
+    end
+    it "should not apply style to non-matching element" do
+      doc = Nokogiri::HTML.fragment("<p>foo</p>")
+      @stylesheet.apply(doc)
+      doc.to_s.should == %q{<p>foo</p>}
+    end
+  end
+  
+  context "stylesheet with multiple styles" do
+    before do
+      parser = CssParser::Parser.new
+      parser.add_block!(<<-EOD)
+        div {
+          background-color: red;
+        }
+        
+        .alC {
+          text-align: center
+        }
+      EOD
+      @stylesheet = described_class.new(parser)
+    end
+
+    it "should apply style to element that matches one style" do
+      doc = Nokogiri::HTML.fragment("<div class='alC'>foo</span>")
+      @stylesheet.apply(doc)
+      doc.to_s.should == %q{<div class="alC" style="background-color: red;text-align: center;">foo</div>}
+    end
+  end
+  context "stylesheet with pseudo style" do
+    before do
+      parser = CssParser::Parser.new
+      parser.add_block!(<<-EOD)
+        a:link      { color: red; }
+        a:focus     { color: green; }
+        a:visited   { color: blue; }
+      EOD
+      @stylesheet = described_class.new(parser)
+    end
+
+    it "should add to head" do
+      doc = Nokogiri::HTML(<<-EOD)
+        <html>
+          <head></head>
+          <body><a href="/">foo</a></body>
+        </html>
+      EOD
+      @stylesheet.apply(doc)
+      doc.at("//a").to_s.should == %q{<a href="/">foo</a>}
+      expected = <<-EOD
+<style type="text/css">
+<![CDATA[
+a:link { color: red; }
+a:focus { color: green; }
+a:visited { color: blue; }
+]]>
+</style>
+EOD
+      doc.at("/html/head/style").to_s.strip.should == expected.strip
+    end
+  end
+
+  ((1..6).map {|i| "h#{i}"} + %w[p]).each do |tag|
+    context "style applied to #{tag}" do
+      before do
+        parser = CssParser::Parser.new
+        parser.add_block!(<<-EOD)
+          #{tag}.color { color: red; }
+          #{tag}.fontsize { font-size: x-small; }
+          #{tag}.backgroundcolor { background-color: blue; }
+        EOD
+        @stylesheet = described_class.new(parser)
+      end
+
+      it "should wrap children in span for color" do
+        doc = Nokogiri::HTML("<#{tag} class='color'>foo</#{tag}>")
+        @stylesheet.apply(doc)
+        doc.at("//#{tag}").to_s.should == %Q{<#{tag} class="color"><span style="color: red;">foo</span></#{tag}>}
+      end
+
+      it "should wrap children in span for font-size" do
+        doc = Nokogiri::HTML("<#{tag} class='fontsize'>foo</#{tag}>")
+        @stylesheet.apply(doc)
+        doc.at("//#{tag}").to_s.should == %Q{<#{tag} class="fontsize"><span style="font-size: x-small;">foo</span></#{tag}>}
+      end
+
+      it "should wrap multiple children in single span" do
+        doc = Nokogiri::HTML("<#{tag} class='fontsize'>foo<br />bar</#{tag}>")
+        @stylesheet.apply(doc)
+        doc.at("//#{tag}").to_s.should == %Q{<#{tag} class="fontsize"><span style="font-size: x-small;">foo<br>bar</span></#{tag}>}
+      end
+
+      it "should wrap element in div for background-color" do
+        doc = Nokogiri::HTML("<#{tag} class='backgroundcolor'>foo</#{tag}>")
+        @stylesheet.apply(doc)
+        doc.at("//div").to_s.should == %Q{<div style="background-color: blue;"><#{tag} class="backgroundcolor">foo</#{tag}></div>}
+      end
+    end
+  end
+
+  context "style applied to child of h1" do
+    before do
+      parser = CssParser::Parser.new
+      parser.add_block!(<<-EOD)
+        h1 span { color: red; }
+      EOD
+      @stylesheet = described_class.new(parser)
+    end
+
+    it "should not apply style to single h1" do
+      doc = Nokogiri::HTML("<h1>foo</h1>")
+      @stylesheet.apply(doc)
+      doc.at("//h1").to_s.should == %q{<h1>foo</h1>}
+    end
+
+    it "should apply style to neseted element" do
+      doc = Nokogiri::HTML("<h1><span>foo</span></h1>")
+      @stylesheet.apply(doc)
+      doc.at("//h1").to_s.should == %q{<h1><span style="color: red;">foo</span></h1>}
+    end
+  end
+end

data/spec/galakei/emoji_table_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Galakei::EmojiTable do
+  before do
+    @unicode, @docomo, @softbank, @au = %w[unicode docomo softbank au].map {|s| Galakei::EmojiTable.send(s)}
+  end
+
+  it "should handle single-character unicode" do
+    @unicode.black_sun_with_rays.should == "☀"
+    @docomo.black_sun_with_rays.should == ""
+    @softbank.black_sun_with_rays.should == ""
+    @au.black_sun_with_rays.should == ""
+  end
+
+  it "should handle multi-character unicode" do
+    @unicode.hash_key.should == "#⃣"
+    @docomo.hash_key.should == ""
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 8
-  version: 0.3.8
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Paul McMahon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 +09:00
+date: 2011-04-05 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,18 +49,16 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: docomo_css
+  name: css_parser
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 4
-        - 4
-        version: 0.4.4
+        version: "0"
   type: :runtime
   version_requirements: *id003
 description: Japanese feature phones (a.k.a., keitai, galakei) have a number of restrictions over normal web browsers.  This library adds support for them
@@ -79,6 +77,10 @@ files:
 - Rakefile
 - galakei.gemspec
 - lib/galakei.rb
+- lib/galakei/docomo_css.rb
+- lib/galakei/docomo_css/inline_stylesheet.rb
+- lib/galakei/docomo_css/railtie.rb
+- lib/galakei/docomo_css/stylesheet.rb
 - lib/galakei/email.rb
 - lib/galakei/emoji_table.rb
 - lib/galakei/filter/base.rb
@@ -97,13 +99,19 @@ files:
 - lib/galakei/version.rb
 - spec/acceptance/acceptance_helper.rb
 - spec/acceptance/app/.gitignore
+- spec/acceptance/app/app/views/haml/index.html.haml
 - spec/acceptance/app/app/views/layouts/application.html.haml
 - spec/acceptance/app/fake.rb
+- spec/acceptance/docomo_css_spec.rb
 - spec/acceptance/emoji_table_spec.rb
+- spec/acceptance/haml_spec.rb
 - spec/acceptance/handset_detection_spec.rb
 - spec/acceptance/input_mode_spec.rb
 - spec/acceptance/session_spec.rb
 - spec/acceptance/support/handsets.rb
+- spec/acceptance/views_spec.rb
+- spec/galakei/docomo_css/stylesheet_spec.rb
+- spec/galakei/emoji_table_spec.rb
 - spec/galakei/filter/content_type_spec.rb
 - spec/galakei/request_spec.rb
 - spec/spec_helper.rb