RubyGems - style_inliner - Versions diffs - 0.0.1 - Mend

style_inliner 0.0.1

Files changed (19) hide show

checksums.yaml +7 -0
data/.gitignore +9 -0
data/.rspec +2 -0
data/.travis.yml +6 -0
data/CHANGELOG.md +2 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +69 -0
data/Rakefile +5 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/lib/style_inliner.rb +2 -0
data/lib/style_inliner/declaration_block.rb +37 -0
data/lib/style_inliner/document.rb +136 -0
data/lib/style_inliner/node_style_folding.rb +105 -0
data/lib/style_inliner/rule_set.rb +32 -0
data/lib/style_inliner/version.rb +3 -0
data/style_inliner.gemspec +21 -0
metadata +146 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7481c1d3452a48020915539d4244a6458c097e9
+  data.tar.gz: 3f348b7b787d8f67cb81270766046f5aa11cdf44
+SHA512:
+  metadata.gz: a08494863a4a41ad2b028682d3c19ce49cef2fc7215045e0134e4b27f40d766036dca8d06a46ae58d6300d48e122ce083454862c92a7845b931286a3d1063503
+  data.tar.gz: 9fb35e3c483ca933539082f5e5f66d544f52636a68f828b0675837e6520befed1ffccc5d76f6df138f1038807f578e1223d711ece804ad060174baf92c457b8e

data/.gitignore ADDED Viewed

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --color
2	+ --require spec_helper

data/.travis.yml ADDED Viewed

@@ -0,0 +1,6 @@
+cache: bundler
+before_install:
+  - gem install bundler
+language: ruby
+rvm:
+  - 2.2.0

data/CHANGELOG.md ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ## 0.0.1
2	+ - 1st release :tada:

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in style_inliner.gemspec
+gemspec

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2016 Ryo Nakamura
+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.md ADDED Viewed

@@ -0,0 +1,69 @@
+# StyleInliner [![Build Status](https://travis-ci.org/r7kamura/style_inliner.svg?branch=master)](https://travis-ci.org/r7kamura/style_inliner)
+Inline CSS style rules into style attributes of each HTML element.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem "style_inliner"
+```
+And then execute:
+```sh
+bundle
+```
+Or install it yourself as:
+```sh
+gem install style_inliner
+```
+## Usage
+```rb
+html = <<-EOS
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <style>
+      body {
+        background: red;
+      }
+    </style>
+  </head>
+  <body>
+  </body>
+</html>
+EOS
+puts StyleInliner::Document.new(html).inline
+```
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  </head>
+  <body style="background-color: red">
+  </body>
+</html>
+```
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/style_inliner.
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "style_inliner"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+require "irb"
+IRB.start

data/bin/setup ADDED Viewed

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install
+# Do any other automated setup that you need to do here

data/lib/style_inliner.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require "style_inliner/document"
2	+ require "style_inliner/version"

data/lib/style_inliner/declaration_block.rb ADDED Viewed

@@ -0,0 +1,37 @@
+module StyleInliner
+  class DeclarationBlock
+    # @param rule_sets [Array<StyleInliner::RuleSet>]
+    def initialize(rule_sets)
+      @rule_sets = rule_sets
+    end
+    def delete_property(property_name)
+      merged_rule_set.instance_variable_get(:@declarations).delete(property_name)
+    end
+    # @return [String]
+    def get_property(property_name)
+      merged_rule_set[property_name]
+    end
+    # @return [String]
+    def to_s
+      merged_rule_set.declarations_to_s.gsub('"', "'").split(/;(?![^(]*\))/).map(&:strip).sort.join("; ")
+    end
+    private
+    # @return [CssParser::RuleSet]
+    def merged_rule_set
+      @merged_rule_set ||= ::CssParser.merge(
+        @rule_sets.map do |rule_set|
+          ::CssParser::RuleSet.new(
+            nil,
+            rule_set.declarations,
+            rule_set.specificity,
+          )
+        end
+      ).tap(&:expand_shorthand!)
+    end
+  end
+end

data/lib/style_inliner/document.rb ADDED Viewed

@@ -0,0 +1,136 @@
+require "css_parser"
+require "nokogiri"
+require "style_inliner/node_style_folding"
+require "style_inliner/rule_set"
+module StyleInliner
+  class Document
+    UNMERGEABLE_PSEUDO_CLASS_NAMES = %w(
+      active
+      after
+      before
+      first-letter
+      first-line
+      focus
+      hover
+      selection
+      target
+      visited
+    )
+    # @param html [String]
+    def initialize(html)
+      @html = html
+    end
+    # @return [Nokogiri::XML::Node]
+    def inline
+      load_styles_from_html
+      merge_styles_into_each_element
+      fold_style_attributes
+      append_style_element_for_unmergeable_rule_sets
+      root
+    end
+    private
+    # @param selector [Stirng]
+    # @param declarations [String]
+    # @param media_types [Array<Symbol>]
+    def add_unmergeable_rule_set(selector, declarations, media_types)
+      css_parser_for_unmergeable_rules.add_rule_set!(
+        ::CssParser::RuleSet.new(selector, declarations),
+        media_types,
+      )
+    end
+    def append_style_element_for_unmergeable_rule_sets
+      rule_set_string = css_parser_for_unmergeable_rules.to_s
+      unless rule_set_string.empty?
+        if (body_node = root.at("body"))
+          body_node.prepend_child(
+            ::Nokogiri::XML.fragment("<style>\n#{rule_set_string}</style>")
+          )
+        end
+      end
+    end
+    # @param node [Nokogiri::XML::Node]
+    # @return [false, true]
+    def check_node_stylability(node)
+      node.element? && node.name != "head" && node.parent.name != "head"
+    end
+    # @param selector [String]
+    # @return [false, true]
+    def check_selector_mergeability(selector)
+      !selector.start_with?("@") && !UNMERGEABLE_PSEUDO_CLASS_NAMES.any? { |name| selector.include?(":#{name}") }
+    end
+    # @return [CssParser::Parser]
+    def css_parser_for_mergeable_rules
+      @css_parser_for_mergeable_rules ||= ::CssParser::Parser.new
+    end
+    # @return [CssParser::Parser]
+    def css_parser_for_unmergeable_rules
+      @css_parser_for_unmergeable_rules ||= ::CssParser::Parser.new
+    end
+    def fold_style_attributes
+      root.search("*[@style]").each do |node|
+        NodeStyleFolding.new(node).call
+      end
+    end
+    # Load styles from <style> and <link> elements from a given HTML document.
+    def load_styles_from_html
+      load_styles_from_link_elements
+      load_styles_from_style_elements
+    end
+    # @todo
+    def load_styles_from_link_elements
+    end
+    def load_styles_from_style_elements
+      root.search("style").each do |style_node|
+        css_parser_for_mergeable_rules.add_block!(style_node.inner_html)
+        style_node.remove
+      end
+    end
+    def merge_styles_into_each_element
+      css_parser_for_mergeable_rules.each_selector(:all) do |selector, declarations, specificity, media_types|
+        if check_selector_mergeability(selector)
+          root.search(strip_link_pseudo_class(selector)).each do |node|
+            if check_node_stylability(node)
+              push_encoded_rule_set_into_style_attribute(node, declarations, specificity)
+            end
+          end
+        else
+          add_unmergeable_rule_set(selector, declarations, media_types)
+        end
+      end
+    end
+    # @param node [Nokogiri::XML::Node]
+    # @param declarations [String]
+    # @param specificity [Integer]
+    def push_encoded_rule_set_into_style_attribute(node, declarations, specificity)
+      rule_set = RuleSet.new(declarations: declarations, specificity: specificity)
+      node["style"] = "#{node['style']} #{rule_set.encode}"
+    end
+    # @return [Nokogiri::XML::Node]
+    def root
+      @root ||= ::Nokogiri.HTML(@html)
+    end
+    # @param selector [String]
+    # @return [String]
+    def strip_link_pseudo_class(selector)
+      selector.gsub(":link", "")
+    end
+  end
+end

data/lib/style_inliner/node_style_folding.rb ADDED Viewed

@@ -0,0 +1,105 @@
+require "style_inliner/declaration_block"
+require "style_inliner/rule_set"
+module StyleInliner
+  class NodeStyleFolding
+    CORRESPONDENCE_TABLES = Hash.new({}).merge(
+      "blockquote" => {
+        "text-align" => "align",
+      },
+      "body" => {
+        "background-color" => "bgcolor",
+      },
+      "div" => {
+        "text-align" => "align",
+      },
+      "h1" => {
+        "text-align" => "align",
+      },
+      "h2" => {
+        "text-align" => "align",
+      },
+      "h3" => {
+        "text-align" => "align",
+      },
+      "h4" => {
+        "text-align" => "align",
+      },
+      "h5" => {
+        "text-align" => "align",
+      },
+      "h6" => {
+        "text-align" => "align",
+      },
+      "img" => {
+        "float" => "align",
+      },
+      "p" => {
+        "text-align" => "align",
+      },
+      "table" => {
+        "background-color" => "bgcolor",
+        "background-image" => "background",
+      },
+      "td" => {
+        "background-color" => "bgcolor",
+        "text-align" => "align",
+        "vertical-align" => "valign",
+      },
+      "th" => {
+        "background-color" => "bgcolor",
+        "text-align" => "align",
+        "vertical-align" => "valign",
+      },
+      "tr" => {
+        "background-color" => "bgcolor",
+        "text-align" => "align",
+      },
+    )
+    # @param node [Nokogiri::XML::Node]
+    def initialize(node)
+      @node = node
+    end
+    def call
+      update_css_compatible_attributes
+      update_style_attribute
+    end
+    private
+    # @return [Hash{String => String}]
+    def correspondence_table
+      CORRESPONDENCE_TABLES[@node.name]
+    end
+    # @return [StyleInliner::RuleSet]
+    def declaration_block
+      @declaration_block ||= DeclarationBlock.new(RuleSet.decode(@node["style"]))
+    end
+    # @param property_value [String]
+    # @return [String]
+    def preprocess_attribute_value(property_value)
+      property_value.gsub(/url\(['|"](.*)['|"]\)/, '\1').gsub(/;$|\s*!important/, '').strip
+    end
+    def update_css_compatible_attributes
+      correspondence_table.each do |property_name, attribute_name|
+        if @node[attribute_name].nil? && !declaration_block.get_property(property_name).empty?
+          @node[attribute_name] = preprocess_attribute_value(declaration_block.get_property(property_name))
+          declaration_block.delete_property(property_name)
+        end
+      end
+    end
+    def update_style_attribute
+      if (value = declaration_block.to_s).empty?
+        @node.remove_attribute("style")
+      else
+        @node["style"] = value
+      end
+    end
+  end
+end

data/lib/style_inliner/rule_set.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module StyleInliner
+  class RuleSet
+    PATTERN = /\[SPEC\=(\d+)\[(.[^\]]*)\]\]/
+    attr_reader :declarations
+    attr_reader :specificity
+    class << self
+      # @param source [String]
+      def decode(source)
+        source.scan(PATTERN).map do |specificity, declarations|
+          new(
+            declarations: declarations,
+            specificity: specificity.to_i,
+          )
+        end
+      end
+    end
+    # @param specificity [Integer] e.g. `1`
+    # @param declarations [String] e.g. `"background: red; color: yellow;"`
+    def initialize(declarations:, specificity:)
+      @declarations = declarations
+      @specificity = specificity
+    end
+    # @return [String]
+    def encode
+      "[SPEC=#{@specificity}[#{@declarations}]]"
+    end
+  end
+end

data/lib/style_inliner/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module StyleInliner
+  VERSION = "0.0.1"
+end

data/style_inliner.gemspec ADDED Viewed

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "style_inliner/version"
+Gem::Specification.new do |spec|
+  spec.name          = "style_inliner"
+  spec.version       = StyleInliner::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Inline CSS style rules into style attributes of each HTML element."
+  spec.homepage      = "https://github.com/r7kamura/style_inliner"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "css_parser"
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "activesupport", "4.2.6"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.4.0"
+end

metadata ADDED Viewed

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: style_inliner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description:
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/style_inliner.rb
+- lib/style_inliner/declaration_block.rb
+- lib/style_inliner/document.rb
+- lib/style_inliner/node_style_folding.rb
+- lib/style_inliner/rule_set.rb
+- lib/style_inliner/version.rb
+- style_inliner.gemspec
+homepage: https://github.com/r7kamura/style_inliner
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Inline CSS style rules into style attributes of each HTML element.
+test_files: []
+has_rdoc: