fucking_favicons 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTMxYTAxZjcyOTIwZjc2ZjYyYjc1NTU0ZGIxNjE4NWMxYTQ3ZWY2NA==
+  data.tar.gz: !binary |-
+    NDcwYzQyZDExOGY4MzM5ZmFiY2Q5MWEyYWViMGE1OGNmOGJlOWNlNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWNjZTc3ZjQwZGQzMTNkNzZjOTIzYzA5YWUwYTE4MDJiZWI4YWIxYTlkOWIw
+    ODNkY2UyZGMyZjdhMGQ2NGY3NDY3ZjljYmNmYzllYzM1ZGE0NzJiNzdiODgx
+    NjE2MTYxNWJlMzI0ZTc0YWMzMjQxOThiMmI2NjRhOWQwZmNjNmU=
+  data.tar.gz: !binary |-
+    ZGJjMmNlZWZiNDI2MTJhOWQyOGQyYjY1NzNjNTk0YWM5ZDYwNWZiZGRhNzc0
+    MGVlMGZkZmViNGQyMDNjYzhiZjUwMzY3MzFkYzE5OThjMjA2N2E3ZGFkMjU3
+    YTRiMTkzZjZhMGVhZmVjNzgzMTMxNzAyYTk4YmRjY2U2NDYyNTA=

data/README.md

@@ -0,0 +1,64 @@
+NAME
+====
+  fucking_favicons.rb
+
+  <img src='http://s3.amazonaws.com/drawohara.com.gifs/favicons.gif' style='max-height:100px;'>
+
+TL;DR
+=====
+
+```ruby
+
+  # install the fucking favicon gem
+
+  gem 'fucking_favicons'
+
+```
+
+
+```bash
+
+  # make a fucking favicon
+
+  ~> cd app/views/images
+
+  ~> curl -sO http://s3.amazonaws.com/drawohara.com.images/favicon.png
+
+```
+
+```erb
+
+  <!-- drop it in yer fucking viewz -->
+
+  <%= render :template => 'fucking_favicons' %>
+
+```
+
+ABOUT
+=====
+
+  fucking_favicons.rb is the best gem in the world.
+  
+  if you doubt this, read https://css-tricks.com/favicon-quiz/ 
+
+  fucking_favicons.rb is a rails engine, and rack middleware, which lets you
+  provide a *single* favicon.png file for your project and let all the rest be
+  dynamically generated on the fly.  it also gives you a handy view that
+  vommits this out:
+
+  <img src='https://s3.amazonaws.com/ss.dojo4.com/qrlxRqq0XC7Uweu6DOYrYx8E11A73Qk0tn1YYPMjyzOQqs5bRSC4MBo.png' style='max-height:100px'>
+
+  the favicons are generated on the fly only once, and cached in memory.  they
+  are served with the last-modified time of the file on disk.  so, this will
+  peform just fine.
+
+  you can use this gem in rails, or a rack app
+
+```ruby
+
+  # for rack apps
+
+    use FuckingFavicons, :path => 'path/to/favicon.png'
+
+```
+

data/Rakefile

@@ -0,0 +1,394 @@
+This.rubyforge_project = 'codeforpeople'
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "https://github.com/ahoward/#{ This.lib }"
+
+task :license do
+  open('LICENSE', 'w'){|fd| fd.puts "same as ruby's"}
+end
+
+task :default do
+  puts((Rake::Task.tasks.map{|task| task.name.gsub(/::/,':')} - ['default']).sort)
+end
+
+task :test do
+  run_tests!
+end
+
+namespace :test do
+  task(:unit){ run_tests!(:unit) }
+  task(:functional){ run_tests!(:functional) }
+  task(:integration){ run_tests!(:integration) }
+end
+
+def run_tests!(which = nil)
+  which ||= '**'
+  test_dir = File.join(This.dir, "test")
+  test_glob ||= File.join(test_dir, "#{ which }/**_test.rb")
+  test_rbs = Dir.glob(test_glob).sort
+        
+  div = ('=' * 119)
+  line = ('-' * 119)
+
+  test_rbs.each_with_index do |test_rb, index|
+    testno = index + 1
+    command = "#{ This.ruby } -w -I ./lib -I ./test/lib #{ test_rb }"
+
+    puts
+    say(div, :color => :cyan, :bold => true)
+    say("@#{ testno } => ", :bold => true, :method => :print)
+    say(command, :color => :cyan, :bold => true)
+    say(line, :color => :cyan, :bold => true)
+
+    system(command)
+
+    say(line, :color => :cyan, :bold => true)
+
+    status = $?.exitstatus
+
+    if status.zero? 
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("SUCCESS", :color => :green, :bold => true)
+    else
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("FAILURE", :color => :red, :bold => true)
+    end
+    say(line, :color => :cyan, :bold => true)
+
+    exit(status) unless status.zero?
+  end
+end
+
+
+task :gemspec do
+  ignore_extensions = ['git', 'svn', 'tmp', /sw./, 'bak', 'gem']
+  ignore_directories = ['pkg']
+  ignore_files = ['test/log']
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        dirname = File.expand_path(entry)
+        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
+      end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
+    end
+
+  lib         = This.lib
+  object      = This.object
+  version     = This.version
+  files       = shiteless[Dir::glob("**/**")]
+  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+  #has_rdoc    = true #File.exist?('doc')
+  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+  summary     = object.respond_to?(:summary) ? object.summary : "summary: #{ lib } kicks the ass"
+  description = object.respond_to?(:description) ? object.description : "description: #{ lib } kicks the ass"
+  license     = object.respond_to?(:license) ? object.license : "same as ruby's"
+
+  if This.extensions.nil?
+    This.extensions = []
+    extensions = This.extensions
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  if This.dependencies.nil?
+    dependencies = []
+  else
+    case This.dependencies
+      when Hash
+        dependencies = This.dependencies.values
+      when Array
+        dependencies = This.dependencies
+    end
+  end
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## <%= lib %>.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = <%= lib.inspect %>
+            spec.version = <%= version.inspect %>
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = <%= lib.inspect %>
+            spec.description = <%= description.inspect %>
+            spec.license = <%= license.inspect %>
+
+            spec.files =\n<%= files.sort.pretty_inspect %>
+            spec.executables = <%= executables.inspect %>
+            
+            spec.require_path = "lib"
+
+            spec.test_files = <%= test_files.inspect %>
+
+            <% dependencies.each do |lib_version| %>
+              spec.add_dependency(*<%= Array(lib_version).flatten.inspect %>)
+            <% end %>
+
+            spec.extensions.push(*<%= extensions.inspect %>)
+
+            spec.rubyforge_project = <%= This.rubyforge_project.inspect %>
+            spec.author = <%= This.author.inspect %>
+            spec.email = <%= This.email.inspect %>
+            spec.homepage = <%= This.homepage.inspect %>
+          end
+        __
+      }
+    end
+
+  Fu.mkdir_p(This.pkgdir)
+  gemspec = "#{ lib }.gemspec"
+  open(gemspec, "w"){|fd| fd.puts(template)}
+  This.gemspec = gemspec
+end
+
+task :gem => [:clean, :gemspec] do
+  Fu.mkdir_p(This.pkgdir)
+  before = Dir['*.gem']
+  cmd = "gem build #{ This.gemspec }"
+  `#{ cmd }`
+  after = Dir['*.gem']
+  gem = ((after - before).first || after.first) or abort('no gem!')
+  Fu.mv(gem, This.pkgdir)
+  This.gem = File.join(This.pkgdir, File.basename(gem))
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -I ./lib #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'README.erb')
+      Template{ IO.read('README.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+task :release => [:clean, :gemspec, :gem] do
+  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
+  raise "which one? : #{ gems.inspect }" if gems.size > 1
+  raise "no gems?" if gems.size < 1
+
+  cmd = "gem push #{ This.gem }"
+  puts cmd
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
+
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.gem }"
+  puts cmd
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
+end
+
+
+
+
+
+BEGIN {
+# support for this rakefile
+#
+  $VERBOSE = nil
+
+  require 'ostruct'
+  require 'erb'
+  require 'fileutils'
+  require 'rbconfig'
+  require 'pp'
+
+# fu shortcut
+#
+  Fu = FileUtils
+
+# cache a bunch of stuff about this rakefile/environment
+#
+  This = OpenStruct.new
+
+  This.file = File.expand_path(__FILE__)
+  This.dir = File.dirname(This.file)
+  This.pkgdir = File.join(This.dir, 'pkg')
+
+# grok lib
+#
+  lib = ENV['LIB']
+  unless lib
+    lib = File.basename(Dir.pwd).sub(/[-].*$/, '')
+  end
+  This.lib = lib
+
+# grok version
+#
+  version = ENV['VERSION']
+  unless version
+    require "./lib/#{ This.lib }"
+    This.name = lib.capitalize
+    This.object = eval(This.name)
+    version = This.object.send(:version)
+  end
+  This.version = version
+
+# see if dependencies are export by the module
+#
+  if This.object.respond_to?(:dependencies)
+    This.dependencies = This.object.dependencies
+  end
+
+# we need to know the name of the lib an it's version
+#
+  abort('no lib') unless This.lib
+  abort('no version') unless This.version
+
+# discover full path to this ruby executable
+#
+  c = Config::CONFIG
+  bindir = c["bindir"] || c['BINDIR']
+  ruby_install_name = c['ruby_install_name'] || c['RUBY_INSTALL_NAME'] || 'ruby'
+  ruby_ext = c['EXEEXT'] || ''
+  ruby = File.join(bindir, (ruby_install_name + ruby_ext))
+  This.ruby = ruby
+
+# some utils
+#
+  module Util
+    def indent(s, n = 2)
+      s = unindent(s)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each_line do |line|
+      next if line =~ %r/^\s*$/
+      indent = line[%r/^\s*/] and break
+    end
+    indent ? s.gsub(%r/^#{ indent }/, "") : s
+  end
+    extend self
+  end
+
+# template support
+#
+  class Template
+    def initialize(&block)
+      @block = block
+      @template = block.call.to_s
+    end
+    def expand(b=nil)
+      ERB.new(Util.unindent(@template)).result((b||@block).binding)
+    end
+    alias_method 'to_s', 'expand'
+  end
+  def Template(*args, &block) Template.new(*args, &block) end
+
+# colored console output support
+#
+  This.ansi = {
+    :clear      => "\e[0m",
+    :reset      => "\e[0m",
+    :erase_line => "\e[K",
+    :erase_char => "\e[P",
+    :bold       => "\e[1m",
+    :dark       => "\e[2m",
+    :underline  => "\e[4m",
+    :underscore => "\e[4m",
+    :blink      => "\e[5m",
+    :reverse    => "\e[7m",
+    :concealed  => "\e[8m",
+    :black      => "\e[30m",
+    :red        => "\e[31m",
+    :green      => "\e[32m",
+    :yellow     => "\e[33m",
+    :blue       => "\e[34m",
+    :magenta    => "\e[35m",
+    :cyan       => "\e[36m",
+    :white      => "\e[37m",
+    :on_black   => "\e[40m",
+    :on_red     => "\e[41m",
+    :on_green   => "\e[42m",
+    :on_yellow  => "\e[43m",
+    :on_blue    => "\e[44m",
+    :on_magenta => "\e[45m",
+    :on_cyan    => "\e[46m",
+    :on_white   => "\e[47m"
+  }
+  def say(phrase, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options[:color] = args.shift.to_s.to_sym unless args.empty?
+    keys = options.keys
+    keys.each{|key| options[key.to_s.to_sym] = options.delete(key)}
+
+    color = options[:color]
+    bold = options.has_key?(:bold)
+
+    parts = [phrase]
+    parts.unshift(This.ansi[color]) if color
+    parts.unshift(This.ansi[:bold]) if bold
+    parts.push(This.ansi[:clear]) if parts.size > 1
+
+    method = options[:method] || :puts
+
+    Kernel.send(method, parts.join)
+  end
+
+# always run out of the project dir
+#
+  Dir.chdir(This.dir)
+}

data/lib/fucking_favicons.rb

@@ -0,0 +1,118 @@
+module FuckingFavicons
+#
+  extend(self)
+
+#
+  require_relative 'fucking_favicons/version'
+
+#
+  def dependencies
+    {
+      'mini_magick'             => [ 'mini_magick'             , ' >= 3.1' ]
+    }
+  end
+
+  def description
+    'fucking favicons fucking suck'
+  end
+
+#
+  def libdir(*args, &block)
+    @libdir ||= File.expand_path(__FILE__).sub(/\.rb$/,'')
+    args.empty? ? @libdir : File.join(@libdir, *args)
+  ensure
+    if block
+      begin
+        $LOAD_PATH.unshift(@libdir)
+        block.call()
+      ensure
+        $LOAD_PATH.shift()
+      end
+    end
+  end
+
+#
+  CONFIG = [
+    { path: 'favicon.ico', size: [16, 16], mime_type: 'image/x-icon', format: 'ICO' },
+    { path: 'favicon-16x16.png', size: [16, 16] },
+    { path: 'favicon-32x32.png', size: [32, 32] },
+    { path: 'favicon-96x96.png', size: [96, 96] },
+    { path: 'favicon-160x160.png', size: [160, 160] },
+    { path: 'favicon-196x196.png', size: [196, 196] },
+    { path: 'mstile-70x70.png', size: [70, 70] },
+    { path: 'mstile-144x144.png', size: [144, 144] },
+    { path: 'mstile-150x150.png', size: [150, 150] },
+    { path: 'mstile-310x310.png', size: [310, 310] },
+    { path: 'mstile-310x150.png', size: [310, 150] },
+    { path: 'apple-touch-icon-57x57.png', size: [57, 57] },
+    { path: 'apple-touch-icon-60x60.png', size: [60, 60] },
+    { path: 'apple-touch-icon-72x72.png', size: [72, 72] },
+    { path: 'apple-touch-icon-76x76.png', size: [76, 76] },
+    { path: 'apple-touch-icon-114x114.png', size: [114, 114] },
+    { path: 'apple-touch-icon-120x120.png', size: [120, 120] },
+    { path: 'apple-touch-icon-144x144.png', size: [144, 144] },
+    { path: 'apple-touch-icon-152x152.png', size: [152, 152] },
+    { path: 'apple-touch-icon.png', size: [57, 57] },
+    { path: 'apple-touch-icon-precomposed.png', size: [57, 57] },
+  ]
+
+#
+  SIZES = CONFIG.map{|h| h[:size]}
+
+#
+  PATHS = CONFIG.map{|h| h[:path]}
+
+#
+  CACHE = {}
+
+#
+  GLOBS = [
+    FuckingFavicons.libdir('app/assets/images/favicon.png')
+  ]
+
+#
+  if defined?(Rack)
+    require_relative 'fucking_favicons/middleware'
+  end
+
+#
+  if defined?(Rails)
+    require_relative 'fucking_favicons/rails'
+  end
+
+#
+  def favicon_for(path, info)
+    key = [path, info.map{|kv| kv.join('=')}.join('&')].join('?')
+
+    CACHE[key] ||= (
+      image = MiniMagick::Image.open(path)
+
+      dimensions = info[:size].join('x')
+
+      image.resize(dimensions)
+
+      if info[:format]
+        image.format(info[:format] || 'png')
+      end
+
+      body           = image.to_blob
+      content_length = body.bytesize.to_s
+      content_type   = image.mime_type =~ /ico/ ? 'image/x-icon' : image.mime_type
+      last_modified  = File.stat(path).mtime.httpdate
+
+      favicon = {
+        :body             => body,
+        :content_length   => content_length,
+        :content_type     => content_type,
+        :last_modified    => last_modified,
+
+        :headers => {
+          'Content-Length' => content_length,
+          'Content-Type'   => content_type,
+          'Last-Modified'  => last_modified
+        }
+      }
+    )
+  end
+end
+Fucking_favicons = FuckingFavicons

data/lib/fucking_favicons/app/views/fucking_favicons.html.erb

@@ -0,0 +1,25 @@
+<% 
+  FuckingFavicons::CONFIG.each do |config| 
+
+    case config[:path].to_s
+      when /apple/
+        size = Array(config[:size]).first
+        path = config[:path]
+        rel  = 'apple-touch-icon'
+        type = 'image/png'
+
+      when /favicon-.*png/
+        size = Array(config[:size]).first
+        path = config[:path]
+        rel  = 'image/png'
+        type = 'image/png'
+
+      else
+        next
+    end
+
+%>
+<%= favicon_link_tag path, :rel => rel, :type => type, :sizes => "#{ size }x#{ size }" %>
+<% end %>
+<meta name="msapplication-TileColor" content="#ffffff" />
+<meta name="msapplication-TileImage" content="/mstile-144x144.png" />

data/lib/fucking_favicons/middleware.rb

@@ -0,0 +1,45 @@
+module FuckingFavicons
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @favicon_path = options[:favicon_path] || options[:path]
+
+      unless @favicon_path
+        GLOBS.each do |glob|
+          first = Dir.glob(glob).first
+
+          if first
+            @favicon_path = first
+
+            if STDERR.tty?
+              warn "FuckingFavicon: #{ @favicon_path }"
+            end
+
+            break
+          end
+        end
+      end
+
+      begin
+        MiniMagick::Image.open(@favicon_path)
+      rescue
+        warn "FuckingFavicon: #{ @favicon_path }"
+        raise
+      end
+
+      CONFIG.each do |c|
+        c[:regex] = %r'\A(?:/assets/|/)?#{ Regexp.escape( c[:path] )}'
+      end
+    end
+
+    def call(env)
+      config = CONFIG.detect{|c| env['PATH_INFO'] =~ c[:regex]}
+
+      return @app.call(env) unless config
+
+      favicon = FuckingFavicons.favicon_for(@favicon_path, config)
+
+      [200, favicon[:headers], [favicon[:body]]]
+    end
+  end
+end

data/lib/fucking_favicons/rails.rb

@@ -0,0 +1,13 @@
+module FuckingFavicons
+  class Engine < ::Rails::Engine
+    engine_name :fucking_favicons
+
+    config.before_initialize do |config|
+      config.middleware.use FuckingFavicons::Middleware
+    end
+
+    paths['app/views'] << FuckingFavicons.libdir('app/views')
+
+    FuckingFavicons::GLOBS.unshift(Rails.root.join('app/assets/images/favicon.png'))
+  end
+end

data/lib/fucking_favicons/version.rb

@@ -0,0 +1,7 @@
+module FuckingFavicons
+  VERSION = '1.0.0'
+
+  def FuckingFavicons.version
+    ::FuckingFavicons::VERSION
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: fucking_favicons
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ara T. Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: fucking favicons fucking suck
+email: ara.t.howard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/fucking_favicons.rb
+- lib/fucking_favicons/app/assets/images/favicon.png
+- lib/fucking_favicons/app/views/fucking_favicons.html.erb
+- lib/fucking_favicons/middleware.rb
+- lib/fucking_favicons/rails.rb
+- lib/fucking_favicons/version.rb
+homepage: https://github.com/ahoward/fucking_favicons
+licenses:
+- same as ruby's
+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: codeforpeople
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: fucking_favicons
+test_files: []