html-pipeline-negarmoji 0.0.1

data/README.md

@@ -0,0 +1 @@
+## Negareh

data/SUPPORT.md

@@ -0,0 +1 @@
+## Negareh Emoji HTML Pipeline Support

data/html-pipeline-negarmoji.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "html/pipeline/negarmoji-pipeline/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "html-pipeline-negarmoji"
+  spec.version = Html::Pipeline::NegarMojiHtmlPipeline::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Mohammad Mahdi Baghbani Pourvahid"]
+  spec.email = "MahdiBaghbani@protonmail.com"
+  spec.homepage = "https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-HTML-Pipeline"
+  spec.description = "%(Negareh emoji library emoji filter for html pipeline, this package is more
+                      flexible and customizable then the original emoji filter present in
+                      html/pipeline)"
+  spec.summary = "Negareh emoji html pipeline"
+  spec.licenses = "GPL-3.0"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "html-pipeline", "~> 2.2"
+  spec.add_dependency "negarmoji", "~> 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.4"
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+end

data/lib/html/pipeline/negarmoji-pipeline.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "html/pipeline"
+require "html/pipeline/negarmoji-pipeline/version"
+
+module HTML
+  class Pipeline
+    class NegarMojiHtmlPipeline
+      # Negareh Emoji HTML Pipeline related filters for html-pipeline.
+      # Implements new filters used by Negareh Emoji HTML Pipeline
+
+      # Custom filter implementations
+      autoload :NegarehEmojiFilter, "negarmoji-pipeline/filter"
+
+      def initialize(filters)
+        @filters = filters.flatten.freeze
+      end
+
+      def pipeline
+        HTML::Pipeline.new @filters
+      end
+    end
+  end
+end

data/lib/html/pipeline/negarmoji-pipeline/filter.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require "cgi"
+HTML::Pipeline.require_dependency("negarmoji", "NegarehEmojiFilter")
+
+module HTML
+  class Pipeline
+    class NegarMojiHtmlPipeline
+      # HTML filter that replaces :emoji: with images.
+      #
+      # Context:
+      #   :asset_root (required) - base url to link to emoji sprite.
+      #
+      #   :asset_path (optional) - url path to link to emoji sprite. :file_name can be used as
+      #   a placeholder for the sprite file name.
+      #   If no asset_path is set ":file_name" is used.
+      #
+      #   :extension (optional) - extension to be use for emoji files, default extension is svg.
+      #
+      #   :ignored_ancestor_tags (optional) - Tags to stop the emojification. Node has matched
+      #   ancestor HTML tags will not be emojified. Default to pre, code, and tt tags. Extra tags
+      #   please pass in the form of array, e.g., %w(blockquote summary).
+      #
+      #   :img_attrs (optional) - Attributes for generated img tag.
+      #   E.g. Pass { "draggble" => true, "height" => nil } to set draggable attribute to "true"
+      #   and clear height attribute of generated img tag.
+      class NegarehEmojiFilter < Filter
+        DEFAULT_IGNORED_ANCESTOR_TAGS = %w(pre code tt).freeze
+
+        def call
+          doc.search(".//text()").each do |node|
+            content = node.text
+
+            next unless content.include?(":")
+            next if has_ancestor?(node, ignored_ancestor_tags)
+
+            html = emoji_image_filter(content)
+
+            next if html == content
+
+            node.replace(html)
+          end
+          doc
+        end
+
+        # Implementation of validate hook.
+        # Errors should raise exceptions or use an existing validator.
+        def validate
+          needs :asset_root
+        end
+
+        # Replace :emoji: with corresponding images.
+        #
+        # text - String text to replace :emoji: in.
+        #
+        # Returns a String with :emoji: replaced with images.
+        def emoji_image_filter(text)
+          text.gsub(emoji_pattern) do |_match|
+            emoji_image_tag(Regexp.last_match(1))
+          end
+        end
+
+        # The base url to link emoji sprites
+        #
+        # Raises ArgumentError if context option has not been provided.
+        # Returns the context's asset_root.
+        def asset_root
+          context[:asset_root]
+        end
+
+        # The url path to link emoji sprites
+        #
+        # :file_name can be used in the asset_path as a placeholder for the sprite file name.
+        # If no asset_path is set in the context ":file_name" is used.
+        # Returns the context's asset_path or the default path if no context asset_path is given.
+        def asset_path(name)
+          if context[:asset_path]
+            context[:asset_path].gsub(":file_name", emoji_filename(name))
+          else
+            File.join(emoji_filename(name))
+          end
+        end
+
+        # Emoji file extension.
+        #
+        # Extension to be use for emoji files, default extension is svg.
+        def emoji_extension
+          context[:extension] || "svg"
+        end
+
+        private
+
+        # Build an emoji image tag
+        def emoji_image_tag(name)
+          require "active_support/core_ext/hash/indifferent_access"
+          html_attrs =
+            default_img_attrs(name)
+              .merge!((context[:img_attrs] || {}).with_indifferent_access)
+              .map do |attr, value|
+                !value.nil? && %(#{attr}="#{value.respond_to?(:call) && value.call(name) || value}")
+              end
+              .reject(&:blank?).join(" ")
+
+          "<img #{html_attrs}>"
+        end
+
+        # Default attributes for img tag
+        def default_img_attrs(name)
+          {
+            :class  => "emoji",
+            :title  => ":#{name}:",
+            :alt    => ":#{name}:",
+            :src    => emoji_url(name).to_s,
+            :height => "20",
+            :width  => "20",
+            :align  => "absmiddle",
+          }
+        end
+
+        def emoji_url(name)
+          File.join(asset_root, asset_path(name))
+        end
+
+        def emoji_pattern
+          self.class.emoji_pattern
+        end
+
+        def emoji_filename(name)
+          Emoji.find_by_alias(name).image_filename(emoji_extension)
+        end
+
+        # Return ancestor tags to stop the emojification.
+        #
+        # @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
+
+        class << self
+          # Build a regexp that matches all valid :emoji: names.
+          def self.emoji_pattern
+            @emoji_pattern ||= %r!:(#{emoji_names.map { |name| Regexp.escape(name) }.join("|")}):!
+          end
+
+          def self.emoji_names
+            Emoji.all.map(&:aliases).flatten.sort
+          end
+        end
+      end
+    end
+  end
+end

data/lib/html/pipeline/negarmoji-pipeline/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Html
+  module Pipeline
+    module NegarMojiHtmlPipeline
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-negarmoji
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mohammad Mahdi Baghbani Pourvahid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: negarmoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: |-
+  %(Negareh emoji library emoji filter for html pipeline, this package is more
+                        flexible and customizable then the original emoji filter present in
+                        html/pipeline)
+email: MahdiBaghbani@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- ROADMAP.md
+- SUPPORT.md
+- html-pipeline-negarmoji.gemspec
+- lib/html/pipeline/negarmoji-pipeline.rb
+- lib/html/pipeline/negarmoji-pipeline/filter.rb
+- lib/html/pipeline/negarmoji-pipeline/version.rb
+homepage: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-HTML-Pipeline
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Negareh emoji html pipeline
+test_files: []