html-pipeline-abbr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd2f77d1c2671b8049eb2fc22eb37a23ee733c18
+  data.tar.gz: a87f98ce3d7f43032eb84d11c753fecdf06196f1
+SHA512:
+  metadata.gz: b913c06f4f63af85f8fea0e6a2ef83ec5abfcb1e2e86b312ee6e1abf9864e0963507533019db112877847cf014e0cb26841f043a7a64301bbcec66fcf20242b9
+  data.tar.gz: 01232a4db85b04a369fa55c2d80f3a1c15198aa0928207c910c8288a2aae2bfd2ce35819e1a272f7fb45d559cfe98c5d40b3e9c1eecee9d7ee983c109df9b5dd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html-pipeline-abbr.gemspec
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+# Html::Pipeline::Abbr
+
+This adds Abbreviation support to your html-pipeline.
+
+Some implementations of Markdown support `<abbr>`, but it is not standard yet.
+It does look like [CommonMark] may include it. In the mean time, hope this
+helps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-abbr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-abbr
+
+## Usage
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::MarkdownFilter,
+  HTML::Pipeline::AbbrFilter,
+  HTML::Pipeline::SyntaxHighlightFilter,
+]
+result = pipeline.call <<-CODE
+Lets generate some *great* HTML.
+
+*[HTML]: Hypertext
+CODE
+puts result[:output].to_s
+```
+Prints:
+
+```
+<p>Lets generate some <strong>great</strong> <abbr title="Hypertxt">HTML</abbr>.</p>
+```
+
+On the flip side, there is also the `ShortenFilter` which will find words that can be abbreviated and shorten them.
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::MarkdownFilter,
+  HTML::Pipeline::ShortenFilter,
+  HTML::Pipeline::SyntaxHighlightFilter,
+]
+result = pipeline.call <<-CODE
+Lets generate some *great* Hypertext.
+
+*[HTML]: Hypertext
+CODE
+puts result[:output].to_s
+```
+
+It produces the same output:
+
+```
+<p>Lets generate some <strong>great</strong> <abbr title="Hypertxt">HTML</abbr>.</p>
+```
+
+## Development
+
+## Thanks
+
+Appreciated the sample tests and code from:
+
+- https://github.com/lifted-studios/html-pipeline-cite
+- https://github.com/JuanitoFatas/html-pipeline-rouge_filter
+
+## Contributing
+
+1. Fork it ( https://github.com/kbrock/html-pipeline-abbr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/html-pipeline-abbr.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/pipeline/abbr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-pipeline-abbr"
+  spec.version       = Html::Pipeline::Abbr::VERSION
+  spec.authors       = ["Keenan Brock"]
+  spec.email         = ["keenan@thebrocks.net"]
+
+  spec.summary       = %q{html-pipeline filter to add or replace abbreviations}
+  spec.description   = %q{abbr tags are part of the html spec. They are currently
+                          not part of markdown but potentially part of common mark.
+                          In the mean time this adds abbr tags}
+  spec.homepage      = "http://github.com/kbrock/html-pipeline-abbr/"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = ""
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline", ">= 1.0"
+  spec.add_dependency "nokogiri", [">= 1.4", "<= 1.6.5"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "yard", "~> 0.8"
+end

data/lib/html/pipeline/abbr/version.rb

@@ -0,0 +1,7 @@
+module Html
+  module Pipeline
+    module Abbr
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/html/pipeline/abbr.rb

@@ -0,0 +1,4 @@
+require "html/pipeline"
+require "html/pipeline/abbr/version"
+require "html/pipeline/abbr_filter.rb"
+require "html/pipeline/shorten_filter.rb"

data/lib/html/pipeline/abbr_filter.rb

@@ -0,0 +1,93 @@
+module HTML
+  class Pipeline
+    # uses defined abbreviations and add abbr tags around them
+
+    class AbbrFilter < Filter
+      DEFAULT_IGNORED_ANCESTOR_TAGS = %w(pre code tt).freeze
+      DEFINITION_PATTERN=%r{(?:^|\n)\*\[([^\]]+)\]: *(.+)$}
+
+      def call
+        abbrs = extract_defs
+        replace_abbrs(abbrs) unless abbrs.empty?
+        doc
+      end
+
+      private
+
+      def extract_defs
+        abbrs ||= {}
+        replace_nodes do |content|           
+          def_filter(content, abbrs) if content.include?("*[")
+        end
+        abbrs
+      end
+
+      # find abbrs in the code
+      def replace_abbrs(abbrs)
+        replace_nodes do |content|
+          abbrs_filter(content, abbrs)
+        end
+      end
+
+      # for reach of the text nodes that we can modify
+      def replace_nodes
+        doc.xpath(".//text()").each do |node|
+          next if has_ancestor?(node, ignored_ancestor_tags)
+
+          content = node.to_html
+          html = yield content
+
+          next if html == content || html.nil?
+          if html.length == 0
+            node.parent.remove
+          else
+            node.replace(html)
+          end
+        end
+      end
+
+      def def_filter(content, abbrs)
+        content.gsub(DEFINITION_PATTERN) do |match|
+          abbrs[$1] = $2
+          ""
+        end
+      end
+
+      # Return html with abbreviations replaced
+      #
+      # @return [String] html with all abbreviations replaced
+      def abbrs_filter(content, abbrs)
+        abbrs.each do |abbr, full|
+          content = abbr_filter(content, abbr, full) if content.include?(abbr)
+        end
+        content
+      end
+
+      # Return html with all of an abbreviation replaced
+      #
+      # @return [String] html with abbreviation tags
+      def abbr_filter(content, abbr, full)
+        target_html = abbr_tag(abbr, full)
+        content.gsub(abbr) { |_| target_html }
+      end
+
+      # Return html string to use as an abbr tag
+      #
+      # @return [String] abbr html
+      def abbr_tag(abbr, full)
+        %(<abbr title="#{full}">#{abbr}</abbr>)
+      end
+
+      # Return ancestor tags to stop processing
+      #
+      # @return [Array<String>] Ancestor tags.
+      def ignored_ancestor_tags
+        if context[:ignored_ancestor_tags]
+          DEFAULT_IGNORED_ANCESTOR_TAGS | context[:ignored_ancestor_tags]
+        else
+          DEFAULT_IGNORED_ANCESTOR_TAGS
+        end
+      end
+    end
+  end
+end

data/lib/html/pipeline/shorten_filter.rb

@@ -0,0 +1,23 @@
+module HTML
+  class Pipeline
+    # Similar to abbreviate
+    # but it starts with the long format and shortens it
+    class ShortenFilter < AbbrFilter
+
+      # Return html with abbreviations replaced
+      #
+      # @return [String] html with all abbreviations replaced
+      def abbrs_filter(content, abbrs)
+        abbrs.each do |abbr, full|
+          content = abbr_filter(content, abbr, full) if content.include?(full)
+        end
+        content
+      end
+
+      def abbr_filter(content, abbr, full)
+        target_html = abbr_tag(abbr, full)
+        content.gsub(full) { |_| target_html }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-abbr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keenan Brock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |-
+  abbr tags are part of the html spec. They are currently
+                            not part of markdown but potentially part of common mark.
+                            In the mean time this adds abbr tags
+email:
+- keenan@thebrocks.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/setup
+- html-pipeline-abbr.gemspec
+- lib/html/pipeline/abbr.rb
+- lib/html/pipeline/abbr/version.rb
+- lib/html/pipeline/abbr_filter.rb
+- lib/html/pipeline/shorten_filter.rb
+homepage: http://github.com/kbrock/html-pipeline-abbr/
+licenses: []
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: html-pipeline filter to add or replace abbreviations
+test_files: []
+has_rdoc: