RubyGems - docomo_css - Versions diffs - 0.0.1 - Mend

docomo_css 0.0.1

Files changed (13) hide show

data/.gitignore ADDED Viewed

@@ -0,0 +1,3 @@
+*.swp
+pkg/*
+rdoc/*

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2008 milk1000cc
+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 Viewed

@@ -0,0 +1,83 @@
+= DocomoCss
+docomo_css is a CSS in-liner.
+Most handsets for the Japanese cell-phone carrier DoCoMo cannot use external
+style sheets, such as
+  <link rel="stylesheet" /> style css, only can use in-line CSS.
+Instead, every element must use its own style attribute, for example
+  <div style="font-size:x-small">
+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
+== Usage
+  # app/controllers/articles_controller.rb
+  class ArticlesController < ApplicationController
+    docomo_filter  # please add this
+    ...
+  end
+  # app/views/articles/index.html.erb
+  <html>
+  <head>
+    <%= stylesheet_link_tag 'foo', :media => 'handheld, tty' %>
+  </head>
+  <body>
+    <h1>Header</h1>
+    <div class="title">bar</div>
+  </body>
+  </html>
+  # public/stylesheets/foo.css
+  .title {
+    color: red;
+  }
+  h1 {
+    color:blue:
+  }
+  # result
+  <html>
+  <head>
+    <%= 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>
+In addition to the basic usage, you may also provide the css inliner with additional directive by adding a docomo_css attribute to the style tag.
+Options for the value of this docomo_css are
+ * ignore - this stylesheet will not be inlined
+ * remove_after_inline - remove the link to this stylesheet after processing it
+== Author
+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>

data/Rakefile ADDED Viewed

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test the docomo_css plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+desc 'Generate documentation for the docomo_css plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DocomoCss'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "docomo_css"
+    s.summary = "CSS inliner"
+    s.description = "Inlines CSS so that you can use external CSS with docomo handsets."
+    s.email = "info@milk1000.cc"
+    s.homepage = "http://www.milk1000.cc/"
+    s.authors = ["milk1000cc", "Paul McMahon"]
+    s.add_dependency 'hpricot'
+    s.add_dependency 'milk1000cc-tiny_css'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.0.1

data/docomo_css.gemspec ADDED Viewed

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{docomo_css}
+  s.version = "0.0.1"
+  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.description = %q{Inlines CSS so that you can use external CSS with docomo handsets.}
+  s.email = %q{info@milk1000.cc}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "docomo_css.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/docomo_css.rb",
+     "rails/init.rb",
+     "test/docomo_css_test.rb",
+     "uninstall.rb"
+  ]
+  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.summary = %q{CSS inliner}
+  s.test_files = [
+    "test/docomo_css_test.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+      s.add_runtime_dependency(%q<tiny_css>, [">= 0"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      s.add_dependency(%q<tiny_css>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    s.add_dependency(%q<tiny_css>, [">= 0"])
+  end
+end

data/init.rb ADDED Viewed

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

data/install.rb ADDED Viewed

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

data/lib/docomo_css.rb ADDED Viewed

@@ -0,0 +1,130 @@
+require 'hpricot'
+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
+    end
+    @handlers
+  end
+  def self.inline_css(content, css_dir)
+    content.gsub!(/&#(\d+);/, 'HTMLCSSINLINERESCAPE\1::::::::')
+    doc = Hpricot(content)
+    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
+      end
+      cssfile = File.join(css_dir, href)
+      cssfile.gsub!(/\?.+/, '')
+      css = TinyCss.new.read(cssfile)
+      style_style = TinyCss.new
+      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
+      end
+    end
+    doc.search('//link[@docomo_css="remove_after_inline"]').remove
+    content = doc.to_html
+    content.gsub!(/HTMLCSSINLINERESCAPE(\d+)::::::::/, '&#\1;')
+    content
+  end
+  def self.allowed_media_type?(s)
+    s.nil? || s =~ /handheld|all|tty/
+  end
+  class Handler
+    def initialize(selector)
+      @selector = selector
+    end
+  end
+  class PseudoSelectorHandler < Handler
+    def replace(doc, style_style, style)
+      style_style.style[@selector] = style
+    end
+  end
+  class DefaultHandler < Handler
+    def initialize(selector, element_handler)
+      super(selector)
+      @element_handler = element_handler
+    end
+    def replace(doc, style_style, style)
+      (doc/(@selector)).each do |element|
+        @element_handler.add_style(element, style)
+      end
+    end
+  end
+  class UnsupportedElementHandler
+    def initialize(unsupported_elements, unsupported_styles)
+      @unsupported_elements = unsupported_elements
+      @unsupported_styles = unsupported_styles
+    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
+        #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
+    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
+    end
+    private
+    def stringify_style(style)
+      style.map { |k, v| "#{ k }:#{ v }" }.join ';'
+    end
+  end
+end

data/rails/init.rb ADDED Viewed

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

data/test/docomo_css_test.rb ADDED Viewed

@@ -0,0 +1,46 @@
+require 'test/unit'
+require 'rubygems'
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..',  'lib')
+require 'docomo_css'
+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"
+    end
+  end
+  def inline(file_name)
+    DocomoCss.inline_css(html(file_name), data_path)
+  end
+  def html(file_name)
+    read_html("html", file_name)
+  end
+  def expected(file_name)
+    read_html("expected_html", file_name)
+  end
+  def read_html(dir, file_name)
+    File.open(File.join(data_path, dir, "#{file_name}.html")) do |f|
+      f.read
+    end
+  end
+  def data_path
+    self.class.data_path
+  end
+end

data/uninstall.rb ADDED Viewed

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

metadata ADDED Viewed

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: docomo_css
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- milk1000cc
+- Paul McMahon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-06-11 00:00:00 +09:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: tiny_css
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Inlines CSS so that you can use external CSS with docomo handsets.
+email: info@milk1000.cc
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- docomo_css.gemspec
+- init.rb
+- install.rb
+- lib/docomo_css.rb
+- rails/init.rb
+- test/docomo_css_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://www.milk1000.cc/
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 2
+summary: CSS inliner
+test_files:
+- test/docomo_css_test.rb