jemoji-plus 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +7 -0
  2. data/lib/jemoji-plus.rb +111 -0
  3. metadata +141 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0abad1d6ff4196054895e4c9a0335ca3d907eeebb702125ef683df04dd420e85
4
+ data.tar.gz: 73d9e8a8d9c24ffed1a65f82e97ed233d50c4676770f482d95e78c356d57ebc4
5
+ SHA512:
6
+ metadata.gz: '068ea34f78b9a8a87cd1922a21b16fbf45669ca330eec0a6502ae7a3255fbdacf7679c54f012729d49de465a3eda491bd8e06b714810c6edcac0b0fcbc0d7349'
7
+ data.tar.gz: 2393ac93abaea26719ef23b42cd91236d71a26940e33366009416cea5cc7797df56a9a7a2727c970c2d4c431fd272025407e40c4609a4278ef12f2ec5ca57a47
data/lib/jemoji-plus.rb ADDED
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "jekyll"
4
+ require "gemoji"
5
+ require "html/pipeline"
6
+
7
+ module Jekyll
8
+ class Emoji
9
+ ASSET_HOST = "https://github.githubassets.com"
10
+ ASSET_PATH = "/images/icons/"
11
+ BODY_START_TAG = "<body"
12
+ OPENING_BODY_TAG_REGEX = %r!<body(.*?)>\s*!.freeze
13
+
14
+ class << self
15
+ def emojify(doc)
16
+ return unless doc.output =~ HTML::Pipeline::EmojiFilter.emoji_pattern
17
+
18
+ doc.output = if doc.output.include? BODY_START_TAG
19
+ replace_document_body(doc)
20
+ else
21
+ src = emoji_src(doc.site.config)
22
+ filter_with_emoji(src).call(doc.output)[:output].to_s
23
+ end
24
+ end
25
+
26
+ # Public: Create or fetch the filter for the given {{src}} asset root.
27
+ #
28
+ # src - the asset root URL (e.g. https://github.githubassets.com/images/icons/)
29
+ #
30
+ # Returns an HTML::Pipeline instance for the given asset root.
31
+ def filter_with_emoji(src)
32
+ filters[src] ||= HTML::Pipeline.new([
33
+ HTML::Pipeline::EmojiFilter,
34
+ ], :asset_root => src, :img_attrs => { :align => nil })
35
+ end
36
+
37
+ # Public: Filters hash where the key is the asset root source.
38
+ # Effectively a cache.
39
+ def filters
40
+ @filters ||= {}
41
+ end
42
+
43
+ # Public: Calculate the asset root source for the given config.
44
+ # The custom emoji asset root can be defined in the config as
45
+ # emoji.src, and must be a valid URL (i.e. it must include a
46
+ # protocol and valid domain)
47
+ #
48
+ # config - the hash-like configuration of the document's site
49
+ #
50
+ # Returns a full URL to use as the asset root URL. Defaults to the root
51
+ # URL for assets provided by an ASSET_HOST environment variable,
52
+ # otherwise the root URL for emoji assets at assets-cdn.github.com.
53
+ def emoji_src(config = {})
54
+ if config.key?("jemoji-plus") && config["jemoji-plus"].key?("host")
55
+ && config["jemoji-plus"].key?("path")
56
+ config_asset_root
57
+ else
58
+ default_asset_root
59
+ end
60
+ end
61
+
62
+ # Public: Defines the conditions for a document to be emojiable.
63
+ #
64
+ # doc - the Jekyll::Document or Jekyll::Page
65
+ #
66
+ # Returns true if the doc is written & is HTML.
67
+ def emojiable?(doc)
68
+ (doc.is_a?(Jekyll::Page) || doc.write?) &&
69
+ doc.output_ext == ".html" || (doc.permalink&.end_with?("/"))
70
+ end
71
+
72
+ private
73
+
74
+ def config_asset_root
75
+ # Ensure that any trailing "/" is trimmed.
76
+ asset_host_url = config["jemoji-plus"]["host"].chomp("/")
77
+ asset_path = config["jemoji-plus"]["path"]
78
+ # If asset_path is not empty, ensure it is start with "/" character.
79
+ if !asset_path.empty?
80
+ # '/' ascii code is 47
81
+ if asset_path[0] != 47
82
+ asset_path = '/' + asset_path
83
+ end
84
+ end
85
+ "#{asset_host_url}#{asset_path}"
86
+ end
87
+
88
+ def default_asset_root
89
+ if !ENV["ASSET_HOST_URL"].to_s.empty?
90
+ # Ensure that any trailing "/" is trimmed
91
+ asset_host_url = ENV["ASSET_HOST_URL"].chomp("/")
92
+ "#{asset_host_url}#{ASSET_PATH}"
93
+ else
94
+ "#{ASSET_HOST}#{ASSET_PATH}"
95
+ end
96
+ end
97
+
98
+ def replace_document_body(doc)
99
+ src = emoji_src(doc.site.config)
100
+ head, opener, tail = doc.output.partition(OPENING_BODY_TAG_REGEX)
101
+ body_content, *rest = tail.partition("</body>")
102
+ processed_markup = filter_with_emoji(src).call(body_content)[:output].to_s
103
+ String.new(head) << opener << processed_markup << rest.join
104
+ end
105
+ end
106
+ end
107
+ end
108
+
109
+ Jekyll::Hooks.register [:pages, :documents], :post_render do |doc|
110
+ Jekyll::Emoji.emojify(doc) if Jekyll::Emoji.emojiable?(doc)
111
+ end
metadata ADDED
@@ -0,0 +1,141 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jemoji-plus
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - shines77 and GitHub, Inc.
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-02-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: gemoji
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: html-pipeline
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.2'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.2'
41
+ - !ruby/object:Gem::Dependency
42
+ name: jekyll
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '12.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '12.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rubocop-jekyll
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.4'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.4'
111
+ description:
112
+ email: gz_shines@msn.com
113
+ executables: []
114
+ extensions: []
115
+ extra_rdoc_files: []
116
+ files:
117
+ - lib/jemoji-plus.rb
118
+ homepage: https://github.com/shines77/jemoji-plus
119
+ licenses:
120
+ - MIT
121
+ metadata: {}
122
+ post_install_message:
123
+ rdoc_options: []
124
+ require_paths:
125
+ - lib
126
+ required_ruby_version: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ version: 2.3.0
131
+ required_rubygems_version: !ruby/object:Gem::Requirement
132
+ requirements:
133
+ - - ">="
134
+ - !ruby/object:Gem::Version
135
+ version: '0'
136
+ requirements: []
137
+ rubygems_version: 3.0.2
138
+ signing_key:
139
+ specification_version: 4
140
+ summary: Highly customized version emoji plugin for Jekyll
141
+ test_files: []