This instance will be upgraded to Heptapod 0.31.0 (final) on 2022-05-24 at 14:00 UTC+2 (a few minutes of down time)

gemojione.rake 7.2 KB
Newer Older
1
namespace :gemojione do
Yorick Peterse's avatar
Yorick Peterse committed
2
  desc 'Generates Emoji SHA256 digests'
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

  task aliases: ['yarn:check', 'environment'] do
    require 'json'

    aliases = {}

    index_file = File.join(Rails.root, 'fixtures', 'emojis', 'index.json')
    index = JSON.parse(File.read(index_file))

    index.each_pair do |key, data|
      data['aliases'].each do |a|
        a.tr!(':', '')

        aliases[a] = key
      end
    end

    out = File.join(Rails.root, 'fixtures', 'emojis', 'aliases.json')
    File.open(out, 'w') do |handle|
      handle.write(JSON.pretty_generate(aliases, indent: '   ', space: '', space_before: ''))
    end
  end

26
  task digests: ['yarn:check', 'environment'] do
Yorick Peterse's avatar
Yorick Peterse committed
27
28
29
    require 'digest/sha2'
    require 'json'

30
31
32
    # We don't have `node_modules` available in built versions of GitLab
    FileUtils.cp_r(Rails.root.join('node_modules', 'emoji-unicode-version', 'emoji-unicode-version-map.json'), File.join(Rails.root, 'fixtures', 'emojis'))

33
    dir = Gemojione.images_path
Eric Eastwood's avatar
Eric Eastwood committed
34
35
    resultant_emoji_map = {}

Eric Eastwood's avatar
Eric Eastwood committed
36
    Gitlab::Emoji.emojis.each do |name, emoji_hash|
Eric Eastwood's avatar
Eric Eastwood committed
37
38
39
40
41
      # Ignore aliases
      unless Gitlab::Emoji.emojis_aliases.key?(name)
        fpath = File.join(dir, "#{emoji_hash['unicode']}.png")
        hash_digest = Digest::SHA256.file(fpath).hexdigest

42
43
44
45
46
        category = emoji_hash['category']
        if name == 'gay_pride_flag'
          category = 'flags'
        end

Eric Eastwood's avatar
Eric Eastwood committed
47
        entry = {
48
          category: category,
Eric Eastwood's avatar
Eric Eastwood committed
49
          moji: emoji_hash['moji'],
50
          description: emoji_hash['description'],
Eric Eastwood's avatar
Eric Eastwood committed
51
          unicodeVersion: Gitlab::Emoji.emoji_unicode_version(name),
52
          digest: hash_digest
Eric Eastwood's avatar
Eric Eastwood committed
53
        }
54

Eric Eastwood's avatar
Eric Eastwood committed
55
        resultant_emoji_map[name] = entry
56
      end
Yorick Peterse's avatar
Yorick Peterse committed
57
58
59
60
    end

    out = File.join(Rails.root, 'fixtures', 'emojis', 'digests.json')
    File.open(out, 'w') do |handle|
Eric Eastwood's avatar
Eric Eastwood committed
61
      handle.write(JSON.pretty_generate(resultant_emoji_map))
Yorick Peterse's avatar
Yorick Peterse committed
62
63
64
65
66
67
68
69
70
    end
  end

  # This task will generate a standard and Retina sprite of all of the current
  # Gemojione Emojis, with the accompanying SCSS map.
  #
  # It will not appear in `rake -T` output, and the dependent gems are not
  # included in the Gemfile by default, because this task will only be needed
  # occasionally, such as when new Emojis are added to Gemojione.
71
  task sprite: :environment do
Yorick Peterse's avatar
Yorick Peterse committed
72
73
74
75
76
77
78
    begin
      require 'sprite_factory'
      require 'rmagick'
    rescue LoadError
      # noop
    end

79
80
81
82
83
    check_requirements!

    SIZE   = 20
    RETINA = SIZE * 2

84
85
86
87
88
    # Update these values to the width and height of the spritesheet when
    # new emoji are added.
    SPRITESHEET_WIDTH = 860
    SPRITESHEET_HEIGHT = 840

89
    # Set up a map to rename image files
Eric Eastwood's avatar
Eric Eastwood committed
90
91
    emoji_unicode_string_to_name_map = {}
    Gitlab::Emoji.emojis.each do |name, emoji_hash|
Eric Eastwood's avatar
Eric Eastwood committed
92
93
      # Ignore aliases
      unless Gitlab::Emoji.emojis_aliases.key?(name)
Eric Eastwood's avatar
Eric Eastwood committed
94
        emoji_unicode_string_to_name_map[emoji_hash['unicode']] = name
Eric Eastwood's avatar
Eric Eastwood committed
95
96
97
98
99
100
101
102
      end
    end

    # Copy the Gemojione assets to the temporary folder for renaming
    emoji_dir = "app/assets/images/emoji"
    FileUtils.rm_rf(emoji_dir)
    FileUtils.mkdir_p(emoji_dir, mode: 0700)
    FileUtils.cp_r(File.join(Gemojione.images_path, '.'), emoji_dir)
Eric Eastwood's avatar
Eric Eastwood committed
103
104
105
    Dir[File.join(emoji_dir, "**/*.png")].each do |png|
      image_path = png
      rename_to_named_emoji_image!(emoji_unicode_string_to_name_map, image_path)
Eric Eastwood's avatar
Eric Eastwood committed
106
107
    end

108
    Dir.mktmpdir do |tmpdir|
Eric Eastwood's avatar
Eric Eastwood committed
109
      FileUtils.cp_r(File.join(emoji_dir, '.'), tmpdir)
110
111
112

      Dir.chdir(tmpdir) do
        Dir["**/*.png"].each do |png|
Eric Eastwood's avatar
Eric Eastwood committed
113
114
          tmp_image_path = File.join(tmpdir, png)
          resize!(tmp_image_path, SIZE)
115
116
117
        end
      end

118
      style_path = Rails.root.join(*%w(app assets stylesheets framework emoji_sprites.scss))
119
120
121

      # Combine the resized assets into a packed sprite and re-generate the SCSS
      SpriteFactory.cssurl = "image-url('$IMAGE')"
Eric Eastwood's avatar
Eric Eastwood committed
122
      SpriteFactory.run!(tmpdir, {
123
124
125
126
127
128
129
130
131
132
133
134
135
        output_style: style_path,
        output_image: "app/assets/images/emoji.png",
        selector:     '.emoji-',
        style:        :scss,
        nocomments:   true,
        pngcrush:     true,
        layout:       :packed
      })

      # SpriteFactory's SCSS is a bit too verbose for our purposes here, so
      # let's simplify it
      system(%Q(sed -i '' "s/width: #{SIZE}px; height: #{SIZE}px; background: image-url('emoji.png')/background-position:/" #{style_path}))
      system(%Q(sed -i '' "s/ no-repeat//" #{style_path}))
Eric Eastwood's avatar
Eric Eastwood committed
136
      system(%Q(sed -i '' "s/ 0px/ 0/g" #{style_path}))
137
138
139
140
141
142
143
144

      # Append a generic rule that applies to all Emojis
      File.open(style_path, 'a') do |f|
        f.puts
        f.puts <<-CSS.strip_heredoc
        .emoji-icon {
          background-image: image-url('emoji.png');
          background-repeat: no-repeat;
Eric Eastwood's avatar
Eric Eastwood committed
145
146
          color: transparent;
          text-indent: -99em;
147
148
149
150
151
152
153
154
155
156
          height: #{SIZE}px;
          width: #{SIZE}px;

          @media only screen and (-webkit-min-device-pixel-ratio: 2),
                 only screen and (min--moz-device-pixel-ratio: 2),
                 only screen and (-o-min-device-pixel-ratio: 2/1),
                 only screen and (min-device-pixel-ratio: 2),
                 only screen and (min-resolution: 192dpi),
                 only screen and (min-resolution: 2dppx) {
            background-image: image-url('emoji@2x.png');
157
            background-size: #{SPRITESHEET_WIDTH}px #{SPRITESHEET_HEIGHT}px;
158
159
160
161
162
163
164
165
166
          }
        }
        CSS
      end
    end

    # Now do it again but for Retina
    Dir.mktmpdir do |tmpdir|
      # Copy the Gemojione assets to the temporary folder for resizing
Eric Eastwood's avatar
Eric Eastwood committed
167
      FileUtils.cp_r(File.join(emoji_dir, '.'), tmpdir)
168
169
170

      Dir.chdir(tmpdir) do
        Dir["**/*.png"].each do |png|
Eric Eastwood's avatar
Eric Eastwood committed
171
172
          tmp_image_path = File.join(tmpdir, png)
          resize!(tmp_image_path, RETINA)
173
174
175
176
        end
      end

      # Combine the resized assets into a packed sprite and re-generate the SCSS
Eric Eastwood's avatar
Eric Eastwood committed
177
      SpriteFactory.run!(tmpdir, {
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
        output_image: "app/assets/images/emoji@2x.png",
        style:        false,
        nocomments:   true,
        pngcrush:     true,
        layout:       :packed
      })
    end
  end

  def check_requirements!
    return if defined?(SpriteFactory) && defined?(Magick)

    puts <<-MSG.strip_heredoc
      This task is disabled by default and should only be run when the Gemojione
      gem is updated with new Emojis.

      To enable this task, *temporarily* add the following lines to Gemfile and
      re-bundle:

      gem 'sprite-factory'
      gem 'rmagick'
    MSG

    exit 1
  end

  def resize!(image_path, size)
    # Resize the image in-place, save it, and free the object
    image = Magick::Image.read(image_path).first
    image.resize!(size, size)
    image.write(image_path) { self.quality = 100 }
    image.destroy!
  end
Eric Eastwood's avatar
Eric Eastwood committed
211
212

  EMOJI_IMAGE_PATH_RE = /(.*?)(([0-9a-f]-?)+)\.png$/i
Eric Eastwood's avatar
Eric Eastwood committed
213
  def rename_to_named_emoji_image!(emoji_unicode_string_to_name_map, image_path)
Eric Eastwood's avatar
Eric Eastwood committed
214
215
216
217
    # Rename file from unicode to emoji name
    matches = EMOJI_IMAGE_PATH_RE.match(image_path)
    preceding_path = matches[1]
    unicode_string = matches[2]
Eric Eastwood's avatar
Eric Eastwood committed
218
    name = emoji_unicode_string_to_name_map[unicode_string]
Eric Eastwood's avatar
Eric Eastwood committed
219
220
221
222
223
    if name
      new_png_path = File.join(preceding_path, "#{name}.png")
      FileUtils.mv(image_path, new_png_path)
      new_png_path
    else
Eric Eastwood's avatar
Eric Eastwood committed
224
      puts "Warning: emoji_unicode_string_to_name_map missing entry for #{unicode_string}. Full path: #{image_path}"
Eric Eastwood's avatar
Eric Eastwood committed
225
226
    end
  end
227
end