generate_data_uri 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nick Ragaz
+
+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

@@ -0,0 +1,33 @@
+GenerateDataUri
+===============
+
+Generate data-uris from files -- for example, files attached to a model.
+
+These data-uris can be used as the "src" attribute on img tags, to avoid [triggering extra server requests](http://developer.yahoo.com/performance/rules.html#num_http). They can also be used in CSS as the content of the `url()` attribute for background images.
+
+Most browsers (IE8+ and everything else) support data-uris that are smaller than 32k. Modern browsers support data-uris of any size. Obviously this can increase the size of your HTML page substantially (more than the size of the original image, in fact). However the tradeoff of increased size vs. more HTTP requests is often worth it for responsiveness, particularly if the images cannot be cached. Gzipping the response using your webserver will reduce the overhead to a few percent.
+
+I've benchmarked the URI generation itself and it only adds a dozen or so milliseconds per file, even for large images.
+
+See this Wikipedia page for details:
+
+  http://en.wikipedia.org/wiki/Data_URI_scheme
+
+Requires Ruby 1.9.2.
+
+Usage (Rails)
+-------------
+
+    class User < ActiveRecord::Base
+      include GenerateDataUri
+      
+      has_attached_file :avatar
+      
+      def to_uri(style=:original)
+        generate_data_uri avatar.path(style)
+      end
+    end
+    
+    # in view:
+    
+    tag :img, src: User.find(1).to_uri, alt: 'My Avatar'

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GenerateDataUri'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generate_data_uri.rb

@@ -0,0 +1,21 @@
+require 'base64'
+require 'mime/types'
+
+module GenerateDataUri
+  private
+  
+  # Use this in callbacks when the file is updated.
+  def clear_data_uri_cache
+    @_uri_cache = {}
+  end
+  
+  def generate_data_uri(path)
+    return @_uri_cache[path] if @_uri_cache && @_uri_cache[path]
+  
+    @_uri_cache ||= {}
+    data = Base64.encode64(File.open(path, 'rb') {|f| f.read }).gsub(/\n/, '')
+    content_type = MIME::Types.type_for(path)
+    
+    @_uri_cache[path] = "data:#{content_type};charset=utf-8;base64,#{data}"
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: generate_data_uri
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ragaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-29 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &2165493980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165493980
+description: Turn a file into a string to embed as a data-uri in your HTML.
+email: nick.ragaz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generate_data_uri.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/nragaz/generate_data_uri
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Turn a file into a string to embed as a data-uri in your HTML.
+test_files: []