eyeliner 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp

data/lib/eyeliner.rb

@@ -1,44 +1,117 @@
 require 'nokogiri'
 require 'css_parser'
 
-module Eyeliner
+class Eyeliner
 
-  class Inliner
+  def initialize(attributes = {})
+    @css = attributes[:css] || ""
+    @stylesheet_base = attributes[:stylesheet_base]
+  end
+
+  attr_accessor :stylesheet_base
+
+  StyleRule = Struct.new(:declarations, :specificity) do
+
+    def <=>(other)
+      specificity <=> other.specificity
+    end
+
+    def to_s
+      declarations
+    end
+
+  end
+
+  def add_css(css)
+    @css << css
+  end
+
+  def css
+    @css.dup
+  end
+
+  def apply_to(input)
+    Application.new(self, input).apply
+  end
 
-    attr_accessor :css
+  # encapsulates the application of CSS to some HTML input
+  class Application
 
-    def initialize
-      @css = ""
+    def initialize(eyeliner, input)
+      @eyeliner = eyeliner
+      @input = input
+      @css = @eyeliner.css
     end
 
-    StyleRule = Struct.new(:declarations, :specificity) do
+    def apply
+      parse_input
+      extract_stylesheets
+      parse_css
+      map_styles_to_elements
+      apply_styles_to_elements
+      @doc.to_html
+    end
+
+    private
 
-      def <=>(other)
-        specificity <=> other.specificity
+    def parse_input
+      @doc = case @input
+      when Nokogiri::XML::Node
+        @input
+      else
+        Nokogiri::HTML.parse(@input)
       end
+    end
 
-      def to_s
-        declarations
+    def extract_stylesheets
+      @doc.css("style, link[rel=stylesheet][type='text/css']").each do |element|
+        case element.name
+        when "style"
+          @css << element.content
+        when "link"
+          @css << read_stylesheet(element["href"])
+        end
+        element.remove
       end
+    end
 
+    def read_stylesheet(name)
+      full_path = File.join(@eyeliner.stylesheet_base, name)
+      File.read(full_path)
     end
 
-    def inline(input)
-      fragment = Nokogiri::HTML.fragment(input)
-      css_parser = CssParser::Parser.new
-      css_parser.add_block!(css)
-      styles_by_element = Hash.new do |h,k|
+    def parse_css
+      @css_parser = CssParser::Parser.new
+      @css_parser.add_block!(@css)
+      @styles_by_element = Hash.new do |h,k|
         h[k] = []
       end
-      css_parser.each_selector do |selector, declarations, specificity|
-        fragment.css(selector).each do |element|
-          styles_by_element[element] << StyleRule.new(declarations, specificity)
+    end
+
+    def map_styles_to_elements
+      @css_parser.each_selector do |selector, declarations, specificity|
+        @doc.css(selector, PsuedoClassHandler.new).each do |element|
+          @styles_by_element[element] << StyleRule.new(declarations, specificity)
         end
       end
-      styles_by_element.each do |element, rules|
-        element["style"] = rules.sort.join(" ")
+    end
+
+    def apply_styles_to_elements
+      @styles_by_element.each do |element, rules|
+        parts = rules.sort
+        parts.push(element["style"]) if element["style"]
+        element["style"] = parts.join(" ")
+      end
+    end
+
+  end
+
+  class PsuedoClassHandler
+
+    %w(visited active hover focus).each do |psuedo_class|
+      define_method(psuedo_class) do |node_set|
+        []
       end
-      fragment.to_html
     end
 
   end

data/lib/eyeliner/version.rb

@@ -1,3 +1,3 @@
-module Eyeliner
-  VERSION = "0.0.1"
+class Eyeliner
+  VERSION = "0.0.2"
 end

data/spec/eyeliner_spec.rb

@@ -1,15 +1,25 @@
 require 'spec_helper'
 
-describe Eyeliner::Inliner do
+describe Eyeliner do
 
-  let(:eyeliner) { Eyeliner::Inliner.new }
+  let(:eyeliner) { Eyeliner.new }
+
+  def parse_fragment(html)
+    Nokogiri::HTML.fragment(html)
+  end
 
   def should_not_modify(input)
-    eyeliner.inline(input).should == input
+    eyeliner.apply_to(parse_fragment(input)).should == input
   end
 
   def should_modify(input, options)
-    eyeliner.inline(input).should == options[:to]
+    eyeliner.apply_to(parse_fragment(input)).should == options[:to]
+  end
+
+  it "can be initialized with attributes" do
+    eyeliner = Eyeliner.new(:stylesheet_base => "STYLESHEETS", :css => "SOME CSS")
+    eyeliner.stylesheet_base.should == "STYLESHEETS"
+    eyeliner.css.should == "SOME CSS"
   end
 
   context "with no CSS" do
@@ -39,7 +49,7 @@ describe Eyeliner::Inliner do
   context "with some explicit CSS" do
 
     before do
-      eyeliner.css << %{
+      eyeliner.add_css %{
         .box { border: 1px solid green; }
         .small { font-size: 8px; }
       }
@@ -66,14 +76,15 @@ describe Eyeliner::Inliner do
                :to => %(<p class="small box" style="border: 1px solid green; font-size: 8px;">xyz</p>)
       end
 
+
     end
 
   end
 
-  context "where CSS rules conflict" do
+  context "where multiple CSS rules apply" do
 
     before do
-      eyeliner.css << %{
+      eyeliner.add_css %{
         p { color: red; }
         p.small { text-decoration: underline; }
         .small { font-size: 8px; }
@@ -87,6 +98,111 @@ describe Eyeliner::Inliner do
                :to => %(<p class="small" style="color: red; font-size: 8px; text-decoration: underline;">xyz</p>)
       end
 
+      it "retains contents of existing style attribute" do
+        should_modify %(<p style="border: 1px solid blue;">xyz</p>),
+               :to => %(<p style="color: red; border: 1px solid blue;">xyz</p>)
+      end
+
+    end
+
+  end
+
+  %w(visited active hover focus).each do |pseudo_class|
+    context "when CSS rule contains pseudo-class :#{pseudo_class}" do
+
+      before do
+        eyeliner.add_css %{
+          a:#{pseudo_class} { color: red; }
+        }
+      end
+
+      it "is ignored" do
+        should_not_modify("<a>xyz</a>")
+      end
+
+    end
+  end
+
+  context "when the document contains a <style> block" do
+
+    before do
+      @input = <<-HTML
+      <html>
+      <head>
+        <style>
+          strong { text-decoration: underline; }
+        </style>
+      </head>
+      <body>
+        <p>
+          Feeling <strong>STRONG</strong>.
+        </p>
+      </body>
+      </html>
+      HTML
+    end
+
+    describe "#apply_to" do
+
+      before do
+        @output = eyeliner.apply_to(@input)
+        @output_doc = Nokogiri::HTML.fragment(@output)
+      end
+
+      it "inlines the styles" do
+        strong_element = @output_doc.css("strong").first
+        strong_element["style"].should == "text-decoration: underline;"
+      end
+
+      it "removes the <style> element" do
+        @output_doc.css("style").should be_empty
+      end
+
+    end
+
+  end
+
+  context "when the document contains a linked stylesheet" do
+
+    before do
+
+      $tmp_dir.mkdir
+      ($tmp_dir + "styles.css").open("w") do |css_io|
+        css_io.puts <<-CSS
+        .email h1 { text-decoration: underline; }
+        CSS
+      end
+
+      @input = <<-HTML
+      <html>
+      <head>
+        <link rel="stylesheet" href="styles.css" type="text/css" />
+      </head>
+      <body class="email">
+        <h1>Hello</h1>
+      </body>
+      </html>
+      HTML
+
+    end
+
+    describe "#apply_to" do
+
+      before do
+        eyeliner.stylesheet_base = $tmp_dir.to_s
+        @output = eyeliner.apply_to(@input)
+        @output_doc = Nokogiri::HTML.fragment(@output)
+      end
+
+      it "inlines the styles" do
+        h1_element = @output_doc.css("h1").first
+        h1_element["style"].should == "text-decoration: underline;"
+      end
+
+      it "removes the <link> element" do
+        @output_doc.css("link").should be_empty
+      end
+
     end
 
   end

data/spec/spec_helper.rb

@@ -1,3 +1,18 @@
 require 'rspec'
 
-require 'eyeliner'
+require 'eyeliner'
+
+require 'pathname'
+
+$project_dir = Pathname(__FILE__).expand_path.parent.parent
+$tmp_dir = $project_dir + "tmp"
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    if $tmp_dir.exist?
+      $tmp_dir.rmtree
+    end
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: eyeliner
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Williams
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 Z
+date: 2011-07-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -67,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3190977879137818689
+      hash: -1764815189923101084
       segments: 
       - 0
       version: "0"
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3190977879137818689
+      hash: -1764815189923101084
       segments: 
       - 0
       version: "0"