auto_html 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4a15b23417dc35ee0ff8097c15b5eba4847142e2
-  data.tar.gz: b94279092cc3fcb0f60affc58a733894e6f8993c
+SHA256:
+  metadata.gz: 1c4554b35676a92a446754ad032d363e1f4be41613ae4923f376ddbb8229a334
+  data.tar.gz: 32062562a065326482d93d164caa849ff81029eb872ee66d973d435e528f99bb
 SHA512:
-  metadata.gz: aef39b00d5a58cf5b32fcdeddd42f5c5c7691dbc506ff38b0f43784339bd55eeceed67f88aefa7badd8fc61c69b922970709f4a2a2661bd49fcb39dbd2d83fb6
-  data.tar.gz: bf49c7aa022c56fbc3b3d58b7e27d83e447dfac562c33e8bcd0a308e7180edc8c2274e326a9a88d0b83559d89af6724a650dd91e475f93091d31472e83887e2d
+  metadata.gz: f22718875cce1764c67e795badf8dca2596697d22e9cd3b31d08b71a2abfe0d2b1c726eefee905b263ecf7352cb2e12c5a8aae4fbc1808e1169b45e2f350e3a2
+  data.tar.gz: ad11106a8df96b900a20df3a0665ec7b9227ba8a92a1728725381d540a11c8df41057dba72feeb9f22fefab82749336038d74c4bd6efa718d263da440eb82452

data/README.md

@@ -1,6 +1,6 @@
 # AutoHtml
 
-AutoHtml is a collection of filters that transform plain text into HTML code.
+AutoHtml is a collection of filters that transforms plain text into HTML code. See [live demo](https://autohtml.rors.org).
 
 ## Installation
 
@@ -56,17 +56,39 @@ comment_format.call("Hello!\n\n Checkout out my blog: http://rors.org :point_lef
 
 Bellow is the list of bundled filters along with their optional arguments on initialization and their default values.
 
-* `AutoHtml::Emoji`, width: 20, height: 20, asset_root: '/images'
+* `AutoHtml::Emoji`
 * `AutoHtml::HtmlEscape`
 * `AutoHtml::Image`, proxy: nil, alt: nil
 * `AutoHtml::Link`, target: nil, rel: nil
 * `AutoHtml::Markdown`
 * `AutoHtml::SimpleFormat`
 
-## Code status
+## Using AutoHtml with ActiveRecord
 
-[![Circle CI](https://circleci.com/gh/dejan/auto_html.svg?style=svg&circle-token=57823c8b62302106564f97b58b64643b9760ed99)](https://circleci.com/gh/dejan/auto_html)
+For performance reasons it's a good idea to store the formated output in the database, in a separate column, to avoid generating the same content on each access.
+This can be acomplished simply by overriding the attribute writter:
+
+```ruby
+class Comment < ActiveRecord::Base
+  FORMAT = AutoHtml::Pipeline.new(
+    AutoHtml::HtmlEscape.new,
+    AutoHtml::Markdown.new
+  )
+
+  def text=(t)
+    super(t)
+    self[:text_html] = FORMAT.call(t)
+  end
+end
+```
+
+Now, every time `text` attribute is set, `text_html` will be set as well:
+
+```Ruby
+comment = Comment.new(text: 'Hey!')
+comment.text_html # => '<p>Hey!</p>'
+```
 
 ## Licence
 
-AutoHtml is released under the [MIT License](https://raw.githubusercontent.com/dejan/auto_html/master/MIT-LICENCE).
+AutoHtml is released under the [MIT License](https://raw.githubusercontent.com/dejan/auto_html/master/MIT-LICENSE).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -5,4 +7,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/lib/auto_html/emoji.rb

@@ -1,57 +1,24 @@
-require 'tag_helper'
+# frozen_string_literal: true
+
 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
+      text.gsub(self.class.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)
+        ::Emoji.find_by_alias(name).raw
       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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 module AutoHtml

data/lib/auto_html/image.rb

@@ -1,4 +1,4 @@
-require 'tag_helper'
+# frozen_string_literal: true
 
 module AutoHtml
   # Image filter
@@ -17,7 +17,7 @@ module AutoHtml
     private
 
     def image_pattern
-      %r{(?<!src=")https?:\/\/.+?\.(jpg|jpeg|bmp|gif|png)(\?\S+)?}i
+      %r{(?<!src=")https?://.+?\.(jpg|jpeg|bmp|gif|png|svg)(\?\S+)?}i
     end
   end
 end

data/lib/auto_html/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'rinku'
 require 'rexml/document'
@@ -5,19 +7,20 @@ require 'rexml/document'
 module AutoHtml
   # Link filter
   class Link
-    def initialize(target: nil, rel: nil)
+    def initialize(target: nil, rel: nil, short_domains: false)
       @target = target
       @rel = rel
+      @short_domains = short_domains
     end
 
     def call(text)
-      Rinku.auto_link(text, :all, target_attr)
+      Rinku.auto_link(text, :all, attributes, nil, flags)
     end
 
     private
 
     def attributes
-      [target_attr, rel_attr].compact.join(' ')
+      [target_attr, rel_attr].compact.join(' ') unless [target_attr, rel_attr].compact.empty?
     end
 
     def rel_attr
@@ -27,5 +30,9 @@ module AutoHtml
     def target_attr
       %(target="#{@target}") if @target
     end
+
+    def flags
+      @short_domains ? Rinku::AUTOLINK_SHORT_DOMAINS : 0
+    end
   end
 end

data/lib/auto_html/markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'redcarpet'
 
 module AutoHtml

data/lib/auto_html/pipeline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AutoHtml
   # Applies collection of filters to a text
   class Pipeline
@@ -7,6 +9,7 @@ module AutoHtml
 
     def call(text)
       return '' if text.nil? || text.empty?
+
       @filters.inject(text) do |content, filter|
         filter.call(content)
       end

data/lib/auto_html/simple_format.rb

@@ -1,4 +1,4 @@
-require 'tag_helper'
+# frozen_string_literal: true
 
 module AutoHtml
   # SimpleFormat filter
@@ -14,6 +14,7 @@ module AutoHtml
 
     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

data/lib/auto_html/tag_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AutoHtml
+  # XHTML tags builder
+  module TagHelper
+    def tag(tag_name, attrs = {})
+      if block_given?
+        content_tag(tag_name, yield, attrs)
+      else
+        unary_tag(tag_name, attrs)
+      end
+    end
+
+    private
+
+    def unary_tag(tag_name, attrs = {})
+      "<#{tag_and_attributes(tag_name, tag_attributes(attrs))} />"
+    end
+
+    def content_tag(tag_name, value, attrs = {})
+      start_tag = "<#{tag_and_attributes(tag_name, tag_attributes(attrs))}>"
+      end_tag   = "</#{tag_name}>"
+      [start_tag, value, end_tag].join
+    end
+
+    def tag_and_attributes(tag_name, attributes)
+      attributes.empty? ? tag_name : "#{tag_name} #{attributes}"
+    end
+
+    def tag_attributes(hash)
+      hash.compact
+          .to_a
+          .map { |k, v| %(#{k}="#{v}") }.join(' ')
+    end
+
+    extend self
+  end
+end

data/lib/auto_html.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # AutoHtml is a collection of filters that transform plain text into HTML code.
 module AutoHtml
   autoload :Pipeline,     'auto_html/pipeline'
-
+  autoload :TagHelper,    'auto_html/tag_helper'
   autoload :Emoji,        'auto_html/emoji'
   autoload :HtmlEscape,   'auto_html/html_escape'
   autoload :Image,        'auto_html/image'

data/spec/auto_html/emoji_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe AutoHtml::Emoji do
+  it 'converts emoji to HTML' do
+    expect(subject.call(':joy:')).to eq('😂')
+  end
+end

data/spec/{html_escape_spec.rb → auto_html/html_escape_spec.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe AutoHtml::HtmlEscape do

data/spec/{image_spec.rb → auto_html/image_spec.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe AutoHtml::Image do

data/spec/{link_spec.rb → auto_html/link_spec.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe AutoHtml::Link do
@@ -31,9 +33,32 @@ RSpec.describe AutoHtml::Link do
     expect(result).to eq '<a href="http://www.google.com/#q=nikola+tesla&ct=tesla09&oi=ddle&fp=Xmf0jJ9P_V0">http://www.google.com/#q=nikola+tesla&ct=tesla09&oi=ddle&fp=Xmf0jJ9P_V0</a>'
   end
 
-  it 'transforms with options' do
+  it 'not transforms short domain URL' do
+    result = subject.call('http://localhost:3000')
+    expect(result).to eq 'http://localhost:3000'
+  end
+
+  it 'transforms with target options' do
     filter = described_class.new(target: '_blank')
     result = filter.call('http://rors.org')
     expect(result).to eq '<a href="http://rors.org" target="_blank">http://rors.org</a>'
   end
+
+  it 'transforms with rel options' do
+    filter = described_class.new(rel: 'nofollow')
+    result = filter.call('http://rors.org')
+    expect(result).to eq '<a href="http://rors.org" rel="nofollow">http://rors.org</a>'
+  end
+
+  it 'transforms with short_domains options' do
+    filter = described_class.new(short_domains: true)
+    result = filter.call('http://localhost:3000')
+    expect(result).to eq '<a href="http://localhost:3000">http://localhost:3000</a>'
+  end
+
+  it 'transforms with target and rel options' do
+    filter = described_class.new(target: '_blank', rel: 'nofollow')
+    result = filter.call('http://rors.org')
+    expect(result).to eq '<a href="http://rors.org" target="_blank" rel="nofollow">http://rors.org</a>'
+  end
 end

data/spec/{markdown_spec.rb → auto_html/markdown_spec.rb}

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe AutoHtml::Markdown do
   it 'formats input using simple GFM rules' do
-    expect(subject.call '*hello*').to eq "<p><em>hello</em></p>\n"
+    expect(subject.call('*hello*')).to eq "<p><em>hello</em></p>\n"
   end
 end

data/spec/{pipeline_spec.rb → auto_html/pipeline_spec.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe AutoHtml::Pipeline do
@@ -15,10 +17,10 @@ RSpec.describe AutoHtml::Pipeline do
   end
 
   it 'is blank if input is blank' do
-    expect(subject.call '').to eq ''
+    expect(subject.call('')).to eq ''
   end
 
   it 'is blank if input is nil' do
-    expect(subject.call nil).to eq ''
+    expect(subject.call(nil)).to eq ''
   end
 end

data/spec/{simple_format_spec.rb → auto_html/simple_format_spec.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe AutoHtml::SimpleFormat do

data/spec/auto_html/tag_helper_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe AutoHtml::TagHelper do
+  it 'generates tag with attributes' do
+    result = subject.tag(:img, src: '1.png', alt: 'number one!')
+    expect(result).to eq '<img src="1.png" alt="number one!" />'
+  end
+
+  it 'generates tag without attributes' do
+    result = subject.tag(:br)
+    expect(result).to eq '<br />'
+  end
+
+  it 'generates content tags' do
+    result = subject.tag(:label, for: 'name') { 'Name' }
+    expect(result).to eq '<label for="name">Name</label>'
+  end
+
+  it 'generates content tags without attributes' do
+    result = subject.tag(:label) { 'Username' }
+    expect(result).to eq '<label>Username</label>'
+  end
+
+  it 'generates nested tags' do
+    result = subject.tag(:form) { subject.tag(:input, type: 'text') }
+    expect(result).to eq '<form><input type="text" /></form>'
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'auto_html'
 
 RSpec.configure do |config|

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: auto_html
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Dejan Simic
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: tag_helper
+  name: gemoji
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 4.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 4.0.0.rc2
 - !ruby/object:Gem::Dependency
-  name: rinku
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: gemoji
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 3.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 3.2.5
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rinku
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '1.23'
 description: Collection of filters for transforming text into HTML code
 email: desimic@gmail.com
 executables: []
@@ -138,19 +138,22 @@ files:
 - lib/auto_html/markdown.rb
 - lib/auto_html/pipeline.rb
 - lib/auto_html/simple_format.rb
-- spec/emoji_spec.rb
-- spec/html_escape_spec.rb
-- spec/image_spec.rb
-- spec/link_spec.rb
-- spec/markdown_spec.rb
-- spec/pipeline_spec.rb
-- spec/simple_format_spec.rb
+- lib/auto_html/tag_helper.rb
+- spec/auto_html/emoji_spec.rb
+- spec/auto_html/html_escape_spec.rb
+- spec/auto_html/image_spec.rb
+- spec/auto_html/link_spec.rb
+- spec/auto_html/markdown_spec.rb
+- spec/auto_html/pipeline_spec.rb
+- spec/auto_html/simple_format_spec.rb
+- spec/auto_html/tag_helper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dejan/auto_html
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,17 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Plain text to HTML conversion
 test_files: []
-has_rdoc: 

data/spec/emoji_spec.rb

@@ -1,9 +0,0 @@
-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