auto_html-whistlerbrk 2.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2220b1eb921c79b4707bb45ecb0f76fdf8006b62
+  data.tar.gz: 36a8fc8048d33adca21900d15613e979523c4391
+SHA512:
+  metadata.gz: 92705cade08e1209263d509782740600f6f1eb260b45c6425337f7315ffbc819d6f43416e798da188bd52b12374b65fe9fcfce46e20b83dbe9975cb157cf690c
+  data.tar.gz: 7ece2134b243221e03a3204083390730db1179a773358394908e333369ae328f73547232f46ecc6c6c722ea49b003763ddcaaf85b5653dd9e2fd2fc08f9bcae7

data/README.md

@@ -0,0 +1,123 @@
+auto_html [![Build Status](https://secure.travis-ci.org/dejan/auto_html.png?branch=master)](http://travis-ci.org/dejan/auto_html)
+=========
+
+
+auto_html is a Rails extension for transforming URLs to appropriate resource (image, link, YouTube, Vimeo video,...). It's the perfect choice if you don't want to bother visitors with rich HTML editor or markup code, but you still want to allow them to embed video, images, links and more on your site, purely by pasting URL. Check out the [live demo](http://rors.org/demos/auto_html).
+
+
+## Install
+
+Specify the gem in Gemfile of the project
+
+    gem "auto_html"
+
+
+## Example usage
+
+Transforming string with text and URLs is done with *auto_html* method:
+
+    include AutoHtml
+    
+    auto_html('Hey! Checkout out: http://vukajlija.com') { simple_format; link(:target => 'blank') }
+    => "<p>Hey! Checkout out: <a href='http://vukajlija.com' target='blank'>http://vukajlija.com</a></p>"
+
+You'll probably have user input stored in model, so it's a good place to automate and even store this conversion for performance reason. This is done with *auto_html_for* method. Let's say you have model Comment with attribute body. Create another column in table Comments called body_html (again, this is optional but recommended for performance reasons). Now have something like this: 
+
+    class Comment < ActiveRecord::Base
+      auto_html_for :body do
+        html_escape
+        image
+        youtube(:width => 400, :height => 250, :autoplay => true)
+        link :target => "_blank", :rel => "nofollow"
+        simple_format
+      end
+    end
+
+... and you'll have this behavior: 
+
+    Comment.create(:body => 'Hey check out this cool video: http://www.youtube.com/watch?v=WdsGihou8J4')  
+    => #<Comment id: 123, body: '<p>Hey check out this cool video: <div class="video youtube"><iframe class="youtube-player" type="text/html" width="587" height="350" src="http://www.youtube.com/embed/WdsGihou8J4" frameborder="0"> <br /></iframe></div></p>'>
+
+Note that order of invoking filters is important, i.e. you want html_escape as first and link amongst last, so that it doesn't transform youtube URL to plain link.
+
+
+Now all you have to do is to display it in template without escaping, since plugin took care of that:
+
+    <% for comment in @comments %>
+       <li><%= comment.body_html %></li>
+    <% end %>
+
+
+If you need to display preview, no problem. Have something like this as action in your controller:
+
+    def preview
+      comment = Comment.new(params[:comment])
+      render :text => comment.body_html
+    end
+
+AutoHtml is highly customizable, and you can easily create new filters that will transform user input any way you like. For instance, this is the image filter that comes bundled with plugin:
+
+    AutoHtml.add_filter(:image) do |text|
+      text.gsub(/http:\/\/.+\.(jpg|jpeg|bmp|gif|png)(\?\S+)?/i) do |match|
+        %|<img src="#{match}" alt=""/>|
+      end
+    end
+
+
+## Bundled filters
+
+For filter list and options they support check: <http://github.com/dejan/auto_html/tree/master/lib/auto_html/filters>
+
+
+## Non-ActiveRecord models
+
+AutoHtml uses standard ActiveModel API, which means that you can include AutoHtmlFor module (that automates transformation of the field) in any non-ActiveRecord model that uses ActiveModel. Here's working [mongoid](http://mongoid.org/) example:
+
+    class Post
+      include Mongoid::Document
+      include AutoHtmlFor
+
+      field :body
+
+      auto_html_for :body do
+        simple_format
+        link
+      end
+    end
+
+
+## Rake and Capistrano tasks
+
+AutoHtml has a Rake task for rebuilding cached in DB column values
+Usage: `rake auto_html:rebuild CLASS=[your model]`
+Where `[your model]` is the name of model which values you want to rebuild.
+
+If you want to run it on remote server, just add this to your `deploy.rb`:
+
+    require 'auto_html/capistrano'
+    
+Now you can run `cap auto_html:rebuild CLASS=[your_model]`.
+
+
+## Licence
+
+Copyright (c) 2009 Dejan Simic
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+desc 'Default: run tests'
+task :default => :test
+
+desc 'Test AutoHtml'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/auto_html.rb

@@ -0,0 +1,17 @@
+%w(base filter builder).each do |f|
+  require File.expand_path("../auto_html/#{f}", __FILE__)
+end
+
+Dir["#{File.dirname(__FILE__) + '/auto_html/filters'}/**/*"].each do |filter|
+  require "#{filter}"
+end
+
+# if rails
+require 'auto_html/railtie' if defined?(Rails::Railtie)
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, AutoHtmlFor
+
+  module ActionView::Helpers::TextHelper
+    include AutoHtml
+  end
+end

data/lib/auto_html/auto_html_for.rb

@@ -0,0 +1,64 @@
+require 'rails'
+
+require 'active_support/core_ext/module/attribute_accessors' if Rails::VERSION::MAJOR >= 4
+
+module AutoHtmlFor
+
+  # default options that can be overridden on the global level
+  @@auto_html_for_options = {
+    :htmlized_attribute_suffix => '_html'
+  }
+  mattr_reader :auto_html_for_options
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def auto_html_for(raw_attrs, &proc)
+      include AutoHtmlFor::InstanceMethods
+
+      if defined?(ActiveRecord) == "constant"
+        return unless ActiveRecord::Base.connection.table_exists? self.table_name
+      end
+
+      suffix =  AutoHtmlFor.auto_html_for_options[:htmlized_attribute_suffix]
+      auto_html_for_columns = [raw_attrs].flatten.map { |a| "#{a}#{suffix}" }
+      
+      # Needed for Mongoid
+      column_names = self.respond_to?(:column_names) ? self.column_names : fields.keys
+      
+      missing_cache_columns =  auto_html_for_columns - column_names
+      missing_cache_columns.each do |missing_cache_column|
+        raw_attr = missing_cache_column.gsub(suffix, '')
+        define_method(missing_cache_column) do
+          val = self[raw_attr] || self.send(raw_attr.to_sym)
+          auto_html(val, &proc)
+        end
+      end
+      
+      cache_columns = auto_html_for_columns - missing_cache_columns
+      cache_columns.each do |cache_column|
+        raw_attr = cache_column.gsub(suffix, '')
+        define_method("#{raw_attr}=") do |val|
+          self[raw_attr] = val
+          result = auto_html(val, &proc)
+          self.send("#{cache_column}=", result)
+          val
+        end
+        
+        define_method(cache_column) do
+          result = self[cache_column]
+          result.respond_to?(:html_safe) ? result.html_safe : result
+        end
+      end
+
+    end
+  end
+
+  module InstanceMethods
+    include AutoHtml
+  end
+end
+
+

data/lib/auto_html/base.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module AutoHtml
+  extend self
+
+  def self.add_filter(name, &block)
+    AutoHtml::Builder.add_filter(name, &block)
+  end
+
+  def auto_html(raw, options = {}, &proc)
+    return "" if raw.blank?
+    builder = Builder.new(raw, options)
+    result = builder.instance_eval(&proc)
+    return raw if result.nil?
+    result.respond_to?(:html_safe) ?
+      result.html_safe :
+        result
+  end
+
+end

data/lib/auto_html/builder.rb

@@ -0,0 +1,22 @@
+module AutoHtml
+  class Builder
+    @@filters = {}
+
+    def initialize(text, options = {})
+      @text = text.dup
+      @options = options
+    end
+
+    def self.add_filter(name, &block)
+      filter = Filter.new(block)
+      @@filters.merge!(name => filter)
+      src = %|
+        def #{name}(options = {})
+          @text = @@filters["#{name}".to_sym].apply(@text, options)
+        end
+      |
+      class_eval src, __FILE__, __LINE__
+      filter
+    end
+  end
+end

data/lib/auto_html/capistrano.rb

@@ -0,0 +1,17 @@
+require 'auto_html/task'
+
+# Capistrano task for AutoHtml.
+# Just add:
+
+# require 'auto_html/capistrano'
+# in your Capistrano deploy.rb, you will have AutoHtml rake task in Capistrano
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :auto_html do
+    desc "Rebuild auto_html columns"
+    task :rebuild do
+      klass = AutoHtml::Task.obtain_class
+      run "cd #{current_path} && bundle exec rake auto_html:rebuild CLASS=#{klass} RAILS_ENV=#{rails_env}"
+    end
+  end
+end

data/lib/auto_html/filter.rb

@@ -0,0 +1,22 @@
+module AutoHtml
+  class Filter
+    def initialize(block)
+      @block = block
+      @options = nil
+    end
+
+    def with(options, &block)
+      @options = options
+      @block = block
+    end
+
+    def apply(text, options = {})
+      _options = @options && @options.merge(options)
+      if _options
+        @block.call(text.to_s.dup, _options)
+      else
+        @block.call(text.to_s.dup)
+      end
+    end
+  end
+end

data/lib/auto_html/filters/dailymotion.rb

@@ -0,0 +1,6 @@
+AutoHtml.add_filter(:dailymotion).with(:width => 480, :height => 360) do |text, options|
+  text.gsub(/(?<!=")https?:\/\/www\.dailymotion\.com.*\/video\/(.+)_*/) do
+    video_id = $1
+    %{<div class="video-container dailymotion"><object type="application/x-shockwave-flash" data="http://www.dailymotion.com/swf/#{video_id}&related=0" width="#{options[:width]}" height="#{options[:height]}"><param name="movie" value="http://www.dailymotion.com/swf/#{video_id}&related=0"></param><param name="allowFullScreen" value="true"></param><param name="allowScriptAccess" value="always"></param><a href="http://www.dailymotion.com/video/#{video_id}?embed=1"><img src="http://www.dailymotion.com/thumbnail/video/#{video_id}" width="#{options[:width]}" height="#{options[:height]}"/></a></object></div>}
+  end
+end

data/lib/auto_html/filters/flickr.rb

@@ -0,0 +1,20 @@
+AutoHtml.add_filter(:flickr).with(:maxwidth => nil, :maxheight => nil, :link_options => {}) do |text, options|
+  require 'uri'
+  require 'net/http'
+  require 'rexml/document'
+
+  regex = %r{http://(www\.)?flickr\.com/photos/[^\s<]*}
+
+  text.gsub(regex) do |match|
+    params = { :url => match, :format => "json" }
+    [:maxwidth, :maxheight].each { |p| params[p] = options[p] unless options[p].nil? or not options[p] > 0 }
+
+    uri = URI("http://www.flickr.com/services/oembed")
+    uri.query = URI.encode_www_form(params)
+
+    response = JSON.parse(Net::HTTP.get(uri))
+
+    link_options = Array(options[:link_options]).reject { |k,v| v.nil? }.map { |k, v| %{#{k}="#{REXML::Text::normalize(v)}"} }.join(' ')
+    %{<a href="#{match}"#{ ' ' + link_options unless link_options.empty? }><img src="#{response["url"]}" alt="#{response["title"]}" title="#{response["title"]}" /></a>}
+  end
+end

data/lib/auto_html/filters/gist.rb

@@ -0,0 +1,8 @@
+AutoHtml.add_filter(:gist).with({}) do |text, options|
+  # E.g. https://gist.github.com/1710276
+  regex = %r{https?://gist\.github\.com/(\w+/)?(\d+)}
+  text.gsub(regex) do
+    gist_id = $2
+    %{<script type="text/javascript" src="https://gist.github.com/#{gist_id}.js"></script>}
+  end
+end

data/lib/auto_html/filters/google_map.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+AutoHtml.add_filter(:google_map).with(:width => 420, :height => 315, :style => "color:#000;text-align:left", :link_text => "View Larger Map", :show_info => true, :type => :normal, :zoom => 18, :more => '') do |text, options|
+  map_type = { :normal => '&t=m', :satellite => '&t=k', :terrain => '&t=p', :hibrid => '&t=h' }
+  regex = /(https?):\/\/maps\.google\.([a-z\.]+)\/maps\?(.*)/
+  text.gsub(regex) do
+    domain_country = $2
+    map_query = $3
+    width = options[:width]
+    height = options[:height]
+    style = options[:style]
+    link_text = options[:link_text]
+    type = options[:type].to_sym
+    map_options = (options[:show_info] ? '' : '&iwloc=near')
+    map_options << map_type[type] if map_type.has_key?(type)
+    map_options << "&amp;z=#{options[:zoom]}"
+    map_options << options[:more]
+    %{<iframe width="#{width}" height="#{height}" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="//maps.google.#{domain_country}/maps?f=q&amp;source=s_q&amp;#{map_query}&amp;output=embed#{map_options}"></iframe><br /><small><a href="//maps.google.#{domain_country}/maps?f=q&amp;source=embed&amp;#{map_query}" style="#{style}">#{link_text}</a></small>}
+  end
+end

data/lib/auto_html/filters/hashtag.rb

@@ -0,0 +1,7 @@
+AutoHtml.add_filter(:hashtag).with(:source => :twitter) do |text, options|
+  if options[:source] == :twitter
+    text.gsub(/#([^\s]+)/, '<a href="http://twitter.com/search?q=%23\1&f=realtime" class="hashtag" target="_blank">#\1</a>')
+  elsif options[:source] == :facebook
+    text.gsub(/#([^\s]+)/, '<a href="https://www.facebook.com/hashtag/\1" class="hashtag" target="_blank">#\1</a>')
+  end
+end

data/lib/auto_html/filters/html_escape.rb

@@ -0,0 +1,9 @@
+AutoHtml.add_filter(:html_escape).with(
+  :map => { 
+    '&' => '&',  
+    '>' => '>',
+    '<' => '&lt;',
+    '"' => '&quot;' }) do |text, options|
+
+  text.to_s.gsub(/[&"><]/) { |special| options[:map][special] }
+end

data/lib/auto_html/filters/image.rb

@@ -0,0 +1,16 @@
+require 'redcarpet'
+
+class NoParagraphRenderer < ::Redcarpet::Render::XHTML
+  def paragraph(text)
+    text
+  end
+end
+
+AutoHtml.add_filter(:image).with({:alt => ''}) do |text, options|
+  r = Redcarpet::Markdown.new(NoParagraphRenderer)
+  alt = options[:alt]
+  options[:proxy] ||= ""
+  text.gsub(/(?<=^|\s)https?:\/\/.+?\.(jpg|jpeg|bmp|gif|png)(\?\S+)?/i) do |match|
+    r.render("![#{alt}](#{options[:proxy]}#{match})")
+  end
+end

data/lib/auto_html/filters/instagram.rb

@@ -0,0 +1,10 @@
+require 'uri'
+require 'net/http'
+
+AutoHtml.add_filter(:instagram) do |text|
+  regex = %r{https?:\/\/(www.)?instagr(am\.com|\.am)/p/.+}
+  text.gsub(regex) do |match|
+    match << '/' unless match.end_with?('/')
+    %{<iframe src="#{match}embed" height="714" width="616" frameborder="0" scrolling="no"></iframe>}
+  end
+end

data/lib/auto_html/filters/link.rb

@@ -0,0 +1,16 @@
+AutoHtml.add_filter(:link).with({}) do |text, options|
+  require 'uri'
+  require 'rinku'
+  require 'rexml/document'
+  option_short_link_name = options.delete(:short_link_name)
+  attributes = Array(options).reject { |k,v| v.nil? }.map { |k, v| %{#{k}="#{REXML::Text::normalize(v)}"} }.join(' ')
+  Rinku.auto_link(text, :all, attributes) do |url|
+    if option_short_link_name
+      uri = URI.parse(URI.encode(url.strip))
+      uri.query = nil
+      uri.to_s
+    else
+      url
+    end
+  end
+end

data/lib/auto_html/filters/liveleak.rb

@@ -0,0 +1,19 @@
+AutoHtml.add_filter(:liveleak).with(:width => 420, :height => 315, :frameborder => 0, :wmode => nil, :autoplay => false, :hide_related => false) do |text, options|
+  regex = %r{http://www\.liveleak\.com/(?:ll_embed|view)\?.=(\w+)}
+  text.gsub(regex) do
+    liveleak_id = $1
+    width = options[:width]
+    height = options[:height]
+    frameborder = options[:frameborder]
+    wmode = options[:wmode]
+    autoplay = options[:autoplay]
+    hide_related = options[:hide_related]
+    src = "http://www.liveleak.com/ll_embed?f=#{liveleak_id}"
+    params = []
+    params << "wmode=#{wmode}" if wmode
+    params << "autoplay=1" if autoplay
+    params << "rel=0" if hide_related
+    src += "?#{params.join '&'}" unless params.empty?
+    %{<div class="video-container liveleak"><iframe width="#{width}" height="#{height}" src="#{src}" frameborder="#{frameborder}" allowfullscreen></iframe></div>}
+  end
+end