auto_html 1.6.4 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a15b23417dc35ee0ff8097c15b5eba4847142e2
+  data.tar.gz: b94279092cc3fcb0f60affc58a733894e6f8993c
+SHA512:
+  metadata.gz: aef39b00d5a58cf5b32fcdeddd42f5c5c7691dbc506ff38b0f43784339bd55eeceed67f88aefa7badd8fc61c69b922970709f4a2a2661bd49fcb39dbd2d83fb6
+  data.tar.gz: bf49c7aa022c56fbc3b3d58b7e27d83e447dfac562c33e8bcd0a308e7180edc8c2274e326a9a88d0b83559d89af6724a650dd91e475f93091d31472e83887e2d

data/README.md

@@ -1,123 +1,72 @@
-auto_html [![Build Status](https://secure.travis-ci.org/dejan/auto_html.png?branch=master)](http://travis-ci.org/dejan/auto_html)
-=========
+# AutoHtml
 
+AutoHtml is a collection of filters that transform plain text into HTML code.
 
-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).
+## Installation
 
+Add this line to your application's Gemfile:
 
-## Install
+```ruby
+gem 'auto_html'
+```
 
-Specify the gem in Gemfile of the project
+And then execute:
 
-    gem "auto_html"
+```sh
+$ bundle
+```
 
+Or install it yourself as:
 
-## Example usage
+```sh
+$ gem install auto_html
+```
 
-Transforming string with text and URLs is done with *auto_html* method:
+## Abstract
 
-    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>"
+AutoHtml uses concepts found in "Pipes and Filters" processing design pattern:
 
-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: 
+* `Filter` - transforms an input. In AutoHtml context, this is any object that does the transformation through `#call(String)` method. Filter options should be passed in initializer. AutoHtml provides some filters already, ie Link, Image, Markdown, etc.
+* `Pipeline` - a composition of filters that transforms input by passing the output of one filter as input for the next filter in line. In AutoHtml context, this is the `AutoHtml::Pipeline` class. Since the same interface (method `#call`) is used to pass input, we can say that Pipeline is just another Filter, which means it can be used as a building block for other Pipelines, in a mix with other filters.
 
-    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
+## Examples
 
-... and you'll have this behavior: 
+```ruby
+link_filter = AutoHtml::Link.new(target: '_blank')
+link_filter.call('Checkout out my blog: http://rors.org')
+# => 'Checkout out my blog: <a target="blank" href="http://rors.org">http://rors.org</a>'
 
-    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>'>
+emoji_filter = AutoHtml::Emoji.new
+emoji_filter.call(':point_left: yo!')
+# => '<img src="/images/emoji/unicode/1f448.png" class="emoji" title=":point_left:" alt=":point_left:" height="20" witdh="20" align="absmiddle" /> yo!'
 
-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
+# Use Pipeline to combine filters
+base_format = AutoHtml::Pipeline.new(link_filter, emoji_filter)
+base_format.call('Checkout out my blog: http://rors.org :point_left: yo!')
+# => 'Checkout out my blog: <a href="http://rors.org">http://rors.org</a> <img src="/images/emoji/unicode/1f448.png" class="emoji" title=":point_left:" alt=":point_left:" height="20" witdh="20" align="absmiddle" /> yo!'
 
+# A pipeline can be reused in another pipeline. Note that the order of filters is important - ie you want
+# `Image` before `Link` filter so that URL of the image gets transformed to `img` tag and not `a` tag.
+comment_format = AutoHtml::Pipeline.new(AutoHtml::Markdown.new, AutoHtml::Image.new, base_format)
+comment_format.call("Hello!\n\n Checkout out my blog: http://rors.org :point_left: yo! \n\n http://gifs.joelglovier.com/boom/booyah.gif")
+# => "<p>Hello!</p>\n\n<p>Checkout out my blog: <a href="<img src="http://rors.org" target="_blank">http://rors.org</a> <img src="/images/emoji/unicode/1f448.png" />" class="emoji" title=":point_left:" alt=":point_left:" height="20" witdh="20" align="absmiddle" /> yo! </p>\n\n<p><a href="<img src="http://gifs.joelglovier.com/boom/booyah.gif" />" target="_blank"><img src="http://gifs.joelglovier.com/boom/booyah.gif" /></a></p>\n"
+```
 
 ## 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.
+Bellow is the list of bundled filters along with their optional arguments on initialization and their default values.
 
-If you want to run it on remote server, just add this to your `deploy.rb`:
+* `AutoHtml::Emoji`, width: 20, height: 20, asset_root: '/images'
+* `AutoHtml::HtmlEscape`
+* `AutoHtml::Image`, proxy: nil, alt: nil
+* `AutoHtml::Link`, target: nil, rel: nil
+* `AutoHtml::Markdown`
+* `AutoHtml::SimpleFormat`
 
-    require 'auto_html/capistrano'
-    
-Now you can run `cap auto_html:rebuild CLASS=[your_model]`.
+## Code status
 
+[![Circle CI](https://circleci.com/gh/dejan/auto_html.svg?style=svg&circle-token=57823c8b62302106564f97b58b64643b9760ed99)](https://circleci.com/gh/dejan/auto_html)
 
 ## 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.
+AutoHtml is released under the [MIT License](https://raw.githubusercontent.com/dejan/auto_html/master/MIT-LICENCE).

data/Rakefile

@@ -1,9 +1,8 @@
-require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-desc 'Default: run tests'
-task :default => :test
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-desc 'Test AutoHtml'
-Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
-end
+task default: [:rubocop, :spec]

data/lib/auto_html.rb

@@ -1,17 +1,11 @@
-%w(base filter builder auto_html_for).each do |f|
-  require File.expand_path("../auto_html/#{f}", __FILE__)
-end
+# AutoHtml is a collection of filters that transform plain text into HTML code.
+module AutoHtml
+  autoload :Pipeline,     'auto_html/pipeline'
 
-Dir["#{File.dirname(__FILE__) + '/auto_html/filters'}/**/*"].each do |filter|
-  require "#{filter}"
+  autoload :Emoji,        'auto_html/emoji'
+  autoload :HtmlEscape,   'auto_html/html_escape'
+  autoload :Image,        'auto_html/image'
+  autoload :Link,         'auto_html/link'
+  autoload :Markdown,     'auto_html/markdown'
+  autoload :SimpleFormat, 'auto_html/simple_format'
 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/emoji.rb

@@ -0,0 +1,57 @@
+require 'tag_helper'
+require 'gemoji'
+
+module AutoHtml
+  # Emoji filter
+  class Emoji
+    def initialize(asset_root: '/images', width: 20, height: 20)
+      @asset_root = asset_root
+      @width = width
+      @height = height
+    end
+
+    def call(text)
+      text.gsub(emoji_pattern) do
+        name = Regexp.last_match(1)
+        alt = ":#{name}:"
+        html_options = {
+          src: emoji_url(name),
+          class: 'emoji',
+          title: alt,
+          alt: alt,
+          height: @width,
+          witdh: @height,
+          align: 'absmiddle'
+        }
+        TagHelper.tag(:img, html_options)
+      end
+    end
+
+    private
+
+    def emoji_url(name)
+      File.join(@asset_root, asset_path(name))
+    end
+
+    def asset_path(name)
+      File.join('emoji', emoji_filename(name))
+    end
+
+    def self.emoji_pattern
+      @emoji_pattern ||=
+        /:(#{emoji_names.map { |name| Regexp.escape(name) }.join('|')}):/
+    end
+
+    def emoji_pattern
+      self.class.emoji_pattern
+    end
+
+    def self.emoji_names
+      ::Emoji.all.map(&:aliases).flatten.sort
+    end
+
+    def emoji_filename(name)
+      ::Emoji.find_by_alias(name).image_filename
+    end
+  end
+end

data/lib/auto_html/html_escape.rb

@@ -0,0 +1,10 @@
+require 'cgi'
+
+module AutoHtml
+  # HTML escape filter
+  class HtmlEscape
+    def call(text)
+      CGI.escapeHTML(text)
+    end
+  end
+end

data/lib/auto_html/image.rb

@@ -0,0 +1,23 @@
+require 'tag_helper'
+
+module AutoHtml
+  # Image filter
+  class Image
+    def initialize(proxy: nil, alt: nil)
+      @proxy = proxy || ''
+      @alt = alt
+    end
+
+    def call(text)
+      text.gsub(image_pattern) do |match|
+        TagHelper.tag(:img, src: @proxy + match, alt: @alt)
+      end
+    end
+
+    private
+
+    def image_pattern
+      %r{(?<!src=")https?:\/\/.+?\.(jpg|jpeg|bmp|gif|png)(\?\S+)?}i
+    end
+  end
+end

data/lib/auto_html/link.rb

@@ -0,0 +1,31 @@
+require 'uri'
+require 'rinku'
+require 'rexml/document'
+
+module AutoHtml
+  # Link filter
+  class Link
+    def initialize(target: nil, rel: nil)
+      @target = target
+      @rel = rel
+    end
+
+    def call(text)
+      Rinku.auto_link(text, :all, target_attr)
+    end
+
+    private
+
+    def attributes
+      [target_attr, rel_attr].compact.join(' ')
+    end
+
+    def rel_attr
+      %(rel="#{@rel}") if @rel
+    end
+
+    def target_attr
+      %(target="#{@target}") if @target
+    end
+  end
+end

data/lib/auto_html/markdown.rb

@@ -0,0 +1,15 @@
+require 'redcarpet'
+
+module AutoHtml
+  # Markdown filter
+  class Markdown
+    def initialize
+      render = Redcarpet::Render::HTML
+      @markdown = Redcarpet::Markdown.new(render)
+    end
+
+    def call(text)
+      @markdown.render(text)
+    end
+  end
+end

data/lib/auto_html/pipeline.rb

@@ -0,0 +1,15 @@
+module AutoHtml
+  # Applies collection of filters to a text
+  class Pipeline
+    def initialize(*filters)
+      @filters = filters.flatten
+    end
+
+    def call(text)
+      return '' if text.nil? || text.empty?
+      @filters.inject(text) do |content, filter|
+        filter.call(content)
+      end
+    end
+  end
+end

data/lib/auto_html/simple_format.rb

@@ -0,0 +1,22 @@
+require 'tag_helper'
+
+module AutoHtml
+  # SimpleFormat filter
+  class SimpleFormat
+    def call(text)
+      paragraphs = split_paragraphs(text)
+      paragraphs.map! do |paragraph|
+        TagHelper.tag(:p) { paragraph }
+      end.join("\n\n")
+    end
+
+    private
+
+    def split_paragraphs(text)
+      return [] if text.nil? || text.empty?
+      text.to_s.gsub(/\r\n?/, "\n").split(/\n\n+/).map! do |t|
+        t.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />') || t
+      end
+    end
+  end
+end

data/spec/emoji_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe AutoHtml::Emoji do
+  it 'converts emoji to HTML' do
+    expect(subject.call(':joy:')).to eq(
+      '<img src="/images/emoji/unicode/1f602.png" class="emoji" title=":joy:" '\
+      'alt=":joy:" height="20" witdh="20" align="absmiddle" />')
+  end
+end

data/spec/html_escape_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+RSpec.describe AutoHtml::HtmlEscape do
+  it 'escapes html tags' do
+    result = subject.call('<script>alert(0)</script>')
+    expect(result).to eq '&lt;script&gt;alert(0)&lt;/script&gt;'
+  end
+end

data/spec/image_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+RSpec.describe AutoHtml::Image do
+  it 'transforms an image link to image tag' do
+    result = subject.call('http://rors.org/images/rails.png')
+    expect(result).to eq('<img src="http://rors.org/images/rails.png" />')
+  end
+
+  it 'transforms image link with a param to image tag' do
+    result = subject.call('http://farm4.static.flickr.com/3664/3512431377_71b8d002ef.jpg?v=0')
+    expect(result).to eq('<img src="http://farm4.static.flickr.com/3664/3512431377_71b8d002ef.jpg?v=0" />')
+  end
+
+  it 'transforms image link on https to image tag' do
+    result = subject.call('https://img.skitch.com/20100910-1wrbg5749xe29ya5t3s85bnaiy.png')
+    expect(result).to eq('<img src="https://img.skitch.com/20100910-1wrbg5749xe29ya5t3s85bnaiy.png" />')
+  end
+
+  it 'transforms image link to a image tag with proxy as source' do
+    filter = AutoHtml::Image.new(proxy: 'https://proxy/?url=')
+    result = filter.call('http://img.skitch.com/20100910-1wrbg5749xe29ya5t3s85bnaiy.png')
+    expect(result).to eq('<img src="https://proxy/?url=http://img.skitch.com/20100910-1wrbg5749xe29ya5t3s85bnaiy.png" />')
+  end
+
+  it 'does not transforms already transformed image' do
+    result = subject.call('<img src="http://farm4.static.flickr.com/3459/3270173112_5099d3d730.jpg" />')
+    expect(result).to eq('<img src="http://farm4.static.flickr.com/3459/3270173112_5099d3d730.jpg" />')
+  end
+
+  it 'transforms an image link within text to image tag' do
+    result = subject.call('Which do you prefer, this one http://www.lockhartfineart.com/images/Rio_Grande_Frost.JPG, or this one http://rors.org/images/rails.png?')
+    expect(result).to eq('Which do you prefer, this one <img src="http://www.lockhartfineart.com/images/Rio_Grande_Frost.JPG" />, or this one <img src="http://rors.org/images/rails.png" />?')
+  end
+
+  it 'transforms an image link with a lot of param to image tag' do
+    result = subject.call('http://tbn3.google.com/images?q=tbn:vS-jtEi9Xc8K6M:http://upload.wikimedia.org/wikipedia/commons/b/ba/Potturinn.jpeg')
+    expect(result).to eq('<img src="http://tbn3.google.com/images?q=tbn:vS-jtEi9Xc8K6M:http://upload.wikimedia.org/wikipedia/commons/b/ba/Potturinn.jpeg" />')
+  end
+end