inline_image 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+InlineImage
+===========
+
+Description
+-----------
+Inline image parses css and html files to replace small file by a data URI reprentation in base64. Small files are files shorter than 1024 bytes by default.
+File type must be either css or html. Extension is used to determine file type, _so it is important that your file end with .css or .html_
+If file extension does not match either html or css, html will be used.
+
+Installation
+------------
+    gem install inline_image
+
+Usage and documentation
+-----------------------
+    inline_image inline /path/to/your.css # search for url(img/name.png)
+    inline_image inline /path/to/your.html # search for src="img/name.png"
+    inline_image help inline # Brief usage description
+
+Todo
+----
+Add option to specify how small the file must be transformed
+
+License
+-------
+Released under The Unlicense, aka public domain. See the [LICENSE][license] file for further details.
+
+[license]: http://unlicense.org/

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/inline_image

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "thor"
+require "inline_image"
+
+class InlineImg < Thor
+  desc "inline FILENAME", "Inline images contained in FILENAME. FILENAME must be a css or html file. Extension is used to determine if it is either a css or a html file"
+  def inline(filename) 
+    return false unless File.exist? filename
+
+    FileUtils.cp filename, "#{filename}.bak"
+
+    dir = File.dirname(filename)
+    extension = filename.split('.').last
+
+    File.open(filename, File::RDWR) do |file|
+      content = if extension == "css" then 
+                  InlineImage.replace_in_css file.read, dir
+                else 
+                  InlineImage.replace_in_html file.read, dir
+                end
+      file.rewind
+      file.truncate(0)
+      file.write content
+    end
+
+  end
+
+end
+
+InlineImg.start

data/inline_image.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inline_image/version"
+
+Gem::Specification.new do |s|
+  s.name        = "inline_image"
+  s.version     = InlineImage::VERSION
+  s.authors     = ["Yann Mainier"]
+  s.email       = ["yann.mainier@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Inline images within css and html files using data URI}
+  s.description = %q{Inline image parses css and html files to replace small file by a data URI reprentation in base64.}
+
+  s.rubyforge_project = "inline_image"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('thor')
+
+  s.add_development_dependency('rspec')
+
+end

data/lib/inline_image/version.rb

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

data/lib/inline_image.rb

@@ -0,0 +1,52 @@
+require "inline_image/version"
+require "base64"
+require "fileutils"
+
+module InlineImage
+  # Maximum file size to be inlined in bytes
+  MAX_FILE_SIZE = 1024
+
+  def in_css(filename, max_file_size = MAX_FILE_SIZE, options = {})
+    return false unless File.exist? filename
+
+    # TODO : Option to disable the copy
+    FileUtils.cp filename, "#{filename}.bak"
+
+    dir = File.dirname(filename)
+    extension = filename.split('.').last
+
+    File.open(filename, File::RDWR) do |file|
+      css = replace_in_css file.read, dir
+
+      file.rewind
+      file.truncate(0)
+      file.write css
+    end
+
+  end
+
+  def self.replace_in_css(css_text, base_dir = '.', max_file_size = MAX_FILE_SIZE)
+    css_text.gsub(/url\(['"]?([^'"\)]+)['"]?\)/m) do |match| 
+      "url(#{process base_dir, $1, max_file_size})"
+    end
+  end
+
+  def self.replace_in_html(html_text, base_dir = '.', max_file_size = MAX_FILE_SIZE)
+    html_text.gsub(/src=['"]([^'"\)]+)['"]/m) do |match| 
+      "src=\"#{process base_dir, $1, max_file_size}\""
+    end
+  end
+
+  def self.process(base_dir, name_in_file, max_file_size = MAX_FILE_SIZE)
+    image_filename = "#{base_dir}/#{name_in_file}"
+    extension = name_in_file.split('.').last
+    if File.size(image_filename) <= max_file_size then
+      File.open(image_filename) do |img|
+        base64encoded = Base64.encode64(img.read).gsub("\n", "")
+        "data:image/#{extension};base64,#{base64encoded}"
+      end if File.exist? image_filename
+    else
+      name_in_file
+    end
+  end
+end

data/spec/fixtures/test.css

@@ -0,0 +1,7 @@
+.with-small {
+  background: white url(images/small.png) no-repeat center;
+}
+.with-large {
+  background: white url(images/large.png)
+}
+

data/spec/fixtures/test.html

@@ -0,0 +1,3 @@
+<img src="images/small.png" />
+<img src="images/large.png" />
+

data/spec/inline_image_spec.rb

@@ -0,0 +1,63 @@
+require "lib/inline_image"
+
+SMALL_PNG_DATA_URI = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAMAAADz0U65AAAAw1BMVEWooJK5rJTTxKqxp5RrVVNuTE6ngG+skoeFjHatqYnEsJagk4GBWVOwfGfRoX/Mq492Z150XVSwloiScmqyfGrXpYa+jHCme2ulg3bJqZjEn4yneGmMVUyeZ1ibYVO6kYDOt57SrZfKoYyWZVtcKS6pbVurZlW3h3i5mIDEmoKudWZpOztpUD+QZVF8OTGQVUlsQj9VIyFOICdbQy6jpFZyajY1BgtmOj15Y2ZCJTNFKTljT0KLhFF5cklVNjd/YWb///+DUmMKAAAAAWJLR0RA/tlc2AAAAAlwSFlzAAAASAAAAEgARslrPgAAABJJREFUCNdjZGCEAg4ozUIWAwATLwCLd45LKgAAAABJRU5ErkJggg=="
+
+SMALL_PNG_IN_CSS_BEFORE = <<-END_CSS
+.with-small {
+background: white url(images/small.png) no-repeat center;
+}
+END_CSS
+
+SMALL_PNG_IN_CSS_AFTER = <<-END_CSS
+.with-small {
+background: white url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAMAAADz0U65AAAAw1BMVEWooJK5rJTTxKqxp5RrVVNuTE6ngG+skoeFjHatqYnEsJagk4GBWVOwfGfRoX/Mq492Z150XVSwloiScmqyfGrXpYa+jHCme2ulg3bJqZjEn4yneGmMVUyeZ1ibYVO6kYDOt57SrZfKoYyWZVtcKS6pbVurZlW3h3i5mIDEmoKudWZpOztpUD+QZVF8OTGQVUlsQj9VIyFOICdbQy6jpFZyajY1BgtmOj15Y2ZCJTNFKTljT0KLhFF5cklVNjd/YWb///+DUmMKAAAAAWJLR0RA/tlc2AAAAAlwSFlzAAAASAAAAEgARslrPgAAABJJREFUCNdjZGCEAg4ozUIWAwATLwCLd45LKgAAAABJRU5ErkJggg==) no-repeat center;
+}
+END_CSS
+
+LARGE_PNG_IN_CSS = <<-END_CSS
+.with-large {
+background: white url(images/large.png)
+}
+END_CSS
+
+SMALL_PNG_IN_HTML_BEFORE = <<-END_HTML
+<img src="images/small.png" />
+END_HTML
+
+SMALL_PNG_IN_HTML_AFTER = <<-END_HTML
+<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAMAAADz0U65AAAAw1BMVEWooJK5rJTTxKqxp5RrVVNuTE6ngG+skoeFjHatqYnEsJagk4GBWVOwfGfRoX/Mq492Z150XVSwloiScmqyfGrXpYa+jHCme2ulg3bJqZjEn4yneGmMVUyeZ1ibYVO6kYDOt57SrZfKoYyWZVtcKS6pbVurZlW3h3i5mIDEmoKudWZpOztpUD+QZVF8OTGQVUlsQj9VIyFOICdbQy6jpFZyajY1BgtmOj15Y2ZCJTNFKTljT0KLhFF5cklVNjd/YWb///+DUmMKAAAAAWJLR0RA/tlc2AAAAAlwSFlzAAAASAAAAEgARslrPgAAABJJREFUCNdjZGCEAg4ozUIWAwATLwCLd45LKgAAAABJRU5ErkJggg==" />
+END_HTML
+
+LARGE_PNG_IN_HTML = <<-END_HTML
+<img src="images/large.png" />
+END_HTML
+
+describe InlineImage do
+  it "encodes small images" do
+    InlineImage.process("spec/fixtures", "images/small.png").should eq(SMALL_PNG_DATA_URI)
+  end
+
+  it "does not modify large image" do
+    InlineImage.process("spec/fixtures", "images/large.png").should eq("images/large.png")
+  end
+
+  context "when processing css" do
+    it "replace small images in css" do
+      InlineImage.replace_in_css(SMALL_PNG_IN_CSS_BEFORE, "spec/fixtures").should eq(SMALL_PNG_IN_CSS_AFTER)
+    end
+
+    it "does not modify large image in css" do
+      InlineImage.replace_in_css(LARGE_PNG_IN_CSS, "spec/fixtures").should eq(LARGE_PNG_IN_CSS)
+    end
+  end
+
+  context "when processing html" do
+    it "replace small images in html" do
+      InlineImage.replace_in_html(SMALL_PNG_IN_HTML_BEFORE, "spec/fixtures").should eq(SMALL_PNG_IN_HTML_AFTER)
+    end
+
+    it "does not modify large image in html" do
+      InlineImage.replace_in_html(LARGE_PNG_IN_HTML, "spec/fixtures").should eq(LARGE_PNG_IN_HTML)
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: inline_image
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Yann Mainier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-24 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Inline image parses css and html files to replace small file by a data URI reprentation in base64.
+email: 
+- yann.mainier@gmail.com
+executables: 
+- inline_image
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/inline_image
+- inline_image.gemspec
+- lib/inline_image.rb
+- lib/inline_image/version.rb
+- spec/fixtures/images/large.png
+- spec/fixtures/images/small.png
+- spec/fixtures/test.css
+- spec/fixtures/test.html
+- spec/inline_image_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: inline_image
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Inline images within css and html files using data URI
+test_files: 
+- spec/fixtures/images/large.png
+- spec/fixtures/images/small.png
+- spec/fixtures/test.css
+- spec/fixtures/test.html
+- spec/inline_image_spec.rb