zalgor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b3a69a05f82d14b61fbec2e224d4acb29da7069e8fb04dd068109defde4a0dd
+  data.tar.gz: da1da7a3a1ad0aeeea6ba4cf88a31e678a1485cf2512b564d19f99bfa63db5b0
+SHA512:
+  metadata.gz: 7a59af9898a9065e246ad6eb8e1f732ef2119c223d735c4a83bee77e31816c1b0a3c79f1213df430bf418ead0ec668879718c1d6fdff138791faf6f7c0d4bd97
+  data.tar.gz: 492d13975f204342e5a51505553d8746f9935aeaf95dc637d962514e940195d1a4363ed1cf563e44de84ee83f088fade5a2fb3f20584ac7b0e40a9736ffc1936

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## [v1.0.0] 2021-11-30
+- initial release

data/README.md

@@ -0,0 +1,76 @@
+DESCRIPTION
+-----------
+
+Zalgo text is digital text that has been modified with combining characters (Unicode symbols that are generally used to stack diacritics above and below letters) to appear creepy or glitchy.
+see: https://en.wikipedia.org/wiki/Zalgo_text
+
+INSTALLATION
+------------
+
+```
+# gem install zalgor
+```
+
+USAGE
+-----
+
+Simple transformation:
+
+```ruby
+require 'zalgor'
+
+# transform a string
+str = 'Hello World'
+puts Zalgor.transform str
+```
+
+Simple purification:
+
+```ruby
+require 'zalgor'
+
+# purify a string
+
+str = 'Hello World'
+str = Zalgor.transform(str)
+puts str
+# exemple : H̵͉̣̀̀̊è̖̻͒̎͘ļ̵̙̥̐̽l̸̡̖̠̿ͫŏ̸̭̲̑͡ ̷̱̃͑͡ͅẀ̘͙̐͞͡o͠҉̻̮ͬ̌r̨͔̜͂̈̕l͏̴̪̙̏̎d̴̡ͮ͛
+
+str = Zalgor.purify(str)
+puts str
+# 'Hello World'
+
+```
+
+Simple transformation directly in String class:
+
+```ruby
+require 'zalgor/string'
+
+# String has "to_zalgo" instance method
+puts 'Hello World'.to_zalgo
+```
+
+Transformation options:
+
+```ruby
+# Zalgor.transform(string, **options)
+# options can be:
+# down:   Integer, the number of down combining chars
+# mid:    Integer, the number of mid combining chars
+# up:     Integer, the number of up combining chars
+# random: Boolean, random each options (0..down|mid|up)
+# default options if not specified
+str = 'Hello World'
+
+# with options
+Zalgor.transform(str, down: 10, mid: 5, up: 1, random: true)
+
+# with default options
+Zalgor.transform(str)
+```
+
+LICENSE
+-------
+
+MIT

data/lib/zalgor/combining_chars.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Zalgor
+  # CHARS  = %W[\u0300 \u0301 \u0302 \u0303 \u0304 \u0305 \u0306 \u0307 \u0308 \u0309 \u030a \u030b \u030c \u030d \u030e \u030f \u0310 \u0311 \u0312 \u0313 \u0314 \u0315 \u0316 \u0317 \u0318 \u0319 \u031a \u031b \u031c \u031d \u031e \u031f \u0320 \u0321 \u0322 \u0323 \u0324 \u0325 \u0326 \u0327 \u0328 \u0329 \u032a \u032b \u032c \u032d \u032e \u032f \u0330 \u0331 \u0332 \u0333 \u0334 \u0335 \u0336 \u0337 \u0338 \u0339 \u033a \u033b \u033c \u033d \u033e \u033f \u0340 \u0341 \u0342 \u0343 \u0344 \u0345 \u0346 \u0347 \u0348 \u0349 \u034a \u034b \u034c \u034d \u034e \u034f \u0350 \u0351 \u0353 \u0354 \u0355 \u0356 \u0357 \u0358 \u0359 \u035a \u035b \u035c \u035d \u035e \u035f \u0360 \u0361 \u0362 \u0363 \u0364 \u0365 \u0366 \u0367 \u0368 \u0369 \u036a \u036b \u036c \u036d \u036e \u036f \u0489 ].freeze
+
+  ##
+  # The all combining unicode chars
+  # see : https://en.wikipedia.org/wiki/Zalgo_text
+  # inspired by : https://eeemo.net/
+  COMBINING_CHARS = {
+    down: [
+      "\u0316", # ̖
+      "\u0317", # ̗
+      "\u0318", # ̘
+      "\u0319", # ̙
+      "\u031c", # ̜
+      "\u031d", # ̝
+      "\u031e", # ̞
+      "\u031f", # ̟
+      "\u0320", # ̠
+      "\u0324", # ̤
+      "\u0325", # ̥
+      "\u0326", # ̦
+      "\u0329", # ̩
+      "\u032a", # ̪
+      "\u032b", # ̫
+      "\u032c", # ̬
+      "\u032d", # ̭
+      "\u032e", # ̮
+      "\u032f", # ̯
+      "\u0330", # ̰
+      "\u0331", # ̱
+      "\u0332", # ̲
+      "\u0333", # ̳
+      "\u0339", # ̹
+      "\u033a", # ̺
+      "\u033b", # ̻
+      "\u033c", # ̼
+      "\u0345", # ͅ
+      "\u0347", # ͇
+      "\u0348", # ͈
+      "\u0349", # ͉
+      "\u034d", # ͍
+      "\u034e", # ͎
+      "\u0353", # ͓
+      "\u0354", # ͔
+      "\u0355", # ͕
+      "\u0356", # ͖
+      "\u0359", # ͙
+      "\u035a", # ͚
+      "\u0323"  # ̣
+    ].freeze,
+
+    mid: [
+      "\u0315", # ̕
+      "\u031b", # ̛
+      "\u0340", # ̀
+      "\u0341", # ́
+      "\u0358", # ͘
+      "\u0321", # ̡
+      "\u0322", # ̢
+      "\u0327", # ̧
+      "\u0328", # ̨
+      "\u0334", # ̴
+      "\u0335", # ̵
+      "\u0336", # ̶
+      "\u034f", # ͏
+      "\u035c", # ͜
+      "\u035d", # ͝
+      "\u035e", # ͞
+      "\u035f", # ͟
+      "\u0360", # ͠
+      "\u0362", # ͢
+      "\u0338", # ̸
+      "\u0337", # ̷
+      "\u0361", # ͡
+      "\u0489"  # ҉_
+    ].freeze,
+
+    up: [
+      "\u030d", # ̍
+      "\u030e", # ̎
+      "\u0304", # ̄
+      "\u0305", # ̅
+      "\u033f", # ̿
+      "\u0311", # ̑
+      "\u0306", # ̆
+      "\u0310", # ̐
+      "\u0352", # ͒
+      "\u0357", # ͗
+      "\u0351", # ͑
+      "\u0307", # ̇
+      "\u0308", # ̈
+      "\u030a", # ̊
+      "\u0342", # ͂
+      "\u0343", # ̓
+      "\u0344", # ̈́
+      "\u034a", # ͊
+      "\u034b", # ͋
+      "\u034c", # ͌
+      "\u0303", # ̃
+      "\u0302", # ̂
+      "\u030c", # ̌
+      "\u0350", # ͐
+      "\u0300", # ̀
+      "\u0301", # ́
+      "\u030b", # ̋
+      "\u030f", # ̏
+      "\u0312", # ̒
+      "\u0313", # ̓
+      "\u0314", # ̔
+      "\u033d", # ̽
+      "\u0309", # ̉
+      "\u0363", # ͣ
+      "\u0364", # ͤ
+      "\u0365", # ͥ
+      "\u0366", # ͦ
+      "\u0367", # ͧ
+      "\u0368", # ͨ
+      "\u0369", # ͩ
+      "\u036a", # ͪ
+      "\u036b", # ͫ
+      "\u036c", # ͬ
+      "\u036d", # ͭ
+      "\u036e", # ͮ
+      "\u036f", # ͯ
+      "\u033e", # ̾
+      "\u035b", # ͛
+      "\u0346", # ͆
+      "\u031a"  # ̚
+    ].freeze
+  }.freeze
+end

data/lib/zalgor/handler.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'combining_chars'
+
+module Zalgor
+  class << self
+    ##
+    # The default options to transform the text.
+    #
+    DEFAULT_OPTIONS = {
+      down: 2,
+      mid: 2,
+      up: 2,
+      random: false
+    }.freeze
+
+    ##
+    # Transform a string to zalgo string.
+    #
+    def transform(string, **options)
+      down   = options[:down]   || DEFAULT_OPTIONS[:down]
+      mid    = options[:mid]    || DEFAULT_OPTIONS[:mid]
+      up     = options[:up]     || DEFAULT_OPTIONS[:up]
+      random = options[:random] || DEFAULT_OPTIONS[:random]
+
+      '' +
+        string.chars.map do |char|
+          set_combining_chars('',       down, COMBINING_CHARS[:down], random) +
+            set_combining_chars(char,   mid,  COMBINING_CHARS[:mid],  random) +
+            set_combining_chars('',     up,   COMBINING_CHARS[:up],   random)
+        end.join
+    end
+
+    ##
+    # Purify a zalgo String to normale string.
+    #
+    def purify(string)
+      combining_chars = (COMBINING_CHARS[:down] + COMBINING_CHARS[:mid] + COMBINING_CHARS[:up])
+      string.chars.map do |char|
+        next if combining_chars.include? char
+
+        char
+      end.join
+    end
+
+    private
+
+    def set_combining_chars(char, num, combining_chars, random)
+      num = rand(num).to_i if random
+      num.times do
+        char += combining_chars.sample
+      end
+      char
+    end
+  end
+end

data/lib/zalgor/string.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'handler'
+
+class String
+  ##
+  # Transform a String into zalgo String.
+  # @return [String]
+  #
+  def to_zalgo(**options)
+    Zalgor.transform(self, **options)
+  end
+end

data/lib/zalgor/version.rb

@@ -0,0 +1,3 @@
+module Zalgor
+  VERSION = '1.0.0'
+end

data/lib/zalgor.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'zalgor/handler'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: zalgor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Richard Kranich
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-30 00:00:00.000000000 Z
+dependencies: []
+description: "    Zalgor (Zalgo Ruby) uses combining chars to create creepy and insane
+  string.\n"
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/zalgor.rb
+- lib/zalgor/combining_chars.rb
+- lib/zalgor/handler.rb
+- lib/zalgor/string.rb
+- lib/zalgor/version.rb
+homepage: https://github.com/kurukuruk
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: A string destroyer with combining chars.
+test_files: []