Giter Club home page Giter Club logo

zalgor's Introduction

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:

require 'zalgor'

# transform a string
str = 'Hello World'
puts Zalgor.transform str

Simple purification:

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:

require 'zalgor/string'

# String has "to_zalgo" instance method
puts 'Hello World'.to_zalgo

Transformation options:

# 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

zalgor's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.