Skip to content

Commit

Permalink
Merge branch 'release/1.1.14' into v1
Browse files Browse the repository at this point in the history
  • Loading branch information
@khalwat
khalwat committed Oct 6, 2018
2 parents 0163c85 + 5a07744 commit a30b6bd
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 303 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Typogrify Changelog

## 1.1.14 - 2018.10.05
### Changed
* Refactored the Twig Extension to use the same methods that the Variable does
* Normalize text passed in by escaping untrusted strings

## 1.1.13 - 2018.10.05
### Changed
* Reverted `\Twig_Markup` regression; added a note to the docs
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "nystudio107/craft-typogrify",
"description": "Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more",
"type": "craft-plugin",
"version": "1.1.13",
"version": "1.1.14",
"keywords": [
"craft",
"cms",
Expand Down
11 changes: 8 additions & 3 deletions src/Typogrify.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

namespace nystudio107\typogrify;

use nystudio107\typogrify\services\TypogrifyService as TypogrifyService;
use nystudio107\typogrify\services\TypogrifyService;
use nystudio107\typogrify\twigextensions\TypogrifyTwigExtension;
use nystudio107\typogrify\models\Settings;
use nystudio107\typogrify\variables\TypogrifyVariable;
Expand Down Expand Up @@ -42,6 +42,11 @@ class Typogrify extends Plugin
*/
public static $plugin;

/**
* @var TypogrifyVariable
*/
public static $variable;

// Public Methods
// =========================================================================

Expand All @@ -52,17 +57,17 @@ public function init()
{
parent::init();
self::$plugin = $this;
self::$variable = new TypogrifyVariable();

Craft::$app->view->registerTwigExtension(new TypogrifyTwigExtension());

// Register our variables
Event::on(
CraftVariable::class,
CraftVariable::EVENT_INIT,
function (Event $event) {
/** @var CraftVariable $variable */
$variable = $event->sender;
$variable->set('typogrify', TypogrifyVariable::class);
$variable->set('typogrify', self::$variable);
}
);

Expand Down
302 changes: 31 additions & 271 deletions src/twigextensions/TypogrifyTwigExtension.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@

use nystudio107\typogrify\Typogrify;

use craft\helpers\Template;

use Stringy\Stringy;

/**
* @author nystudio107
* @package Typogrify
Expand All @@ -39,21 +35,22 @@ public function getName()
*/
public function getFilters()
{
$variable = Typogrify::$variable;
return [
new \Twig_SimpleFilter('typogrify', [$this, 'typogrify']),
new \Twig_SimpleFilter('typogrifyFeed', [$this, 'typogrifyFeed']),
new \Twig_SimpleFilter('smartypants', [$this, 'smartypants']),
new \Twig_SimpleFilter('truncate', [$this, 'truncate']),
new \Twig_SimpleFilter('truncateOnWord', [$this, 'truncateOnWord']),
new \Twig_SimpleFilter('stringy', [$this, 'stringy']),
new \Twig_SimpleFilter('humanFileSize', [$this, 'humanFileSize']),
new \Twig_SimpleFilter('humanDuration', [$this, 'humanDuration']),
new \Twig_SimpleFilter('humanRelativeTime', [$this, 'humanRelativeTime']),
new \Twig_SimpleFilter('ordinalize', [$this, 'ordinalize']),
new \Twig_SimpleFilter('pluralize', [$this, 'pluralize']),
new \Twig_SimpleFilter('singularize', [$this, 'singularize']),
new \Twig_SimpleFilter('transliterate', [$this, 'transliterate']),
new \Twig_SimpleFilter('wordLimit', [$this, 'wordLimit']),
new \Twig_SimpleFilter('typogrify', [$variable, 'typogrify']),
new \Twig_SimpleFilter('typogrifyFeed', [$variable, 'typogrifyFeed']),
new \Twig_SimpleFilter('smartypants', [$variable, 'smartypants']),
new \Twig_SimpleFilter('truncate', [$variable, 'truncate']),
new \Twig_SimpleFilter('truncateOnWord', [$variable, 'truncateOnWord']),
new \Twig_SimpleFilter('stringy', [$variable, 'stringy']),
new \Twig_SimpleFilter('humanFileSize', [$variable, 'humanFileSize']),
new \Twig_SimpleFilter('humanDuration', [$variable, 'humanDuration']),
new \Twig_SimpleFilter('humanRelativeTime', [$variable, 'humanRelativeTime']),
new \Twig_SimpleFilter('ordinalize', [$variable, 'ordinalize']),
new \Twig_SimpleFilter('pluralize', [$variable, 'pluralize']),
new \Twig_SimpleFilter('singularize', [$variable, 'singularize']),
new \Twig_SimpleFilter('transliterate', [$variable, 'transliterate']),
new \Twig_SimpleFilter('wordLimit', [$variable, 'wordLimit']),
];
}

Expand All @@ -62,260 +59,23 @@ public function getFilters()
*/
public function getFunctions()
{
$variable = Typogrify::$variable;
return [
new \Twig_SimpleFunction('typogrify', [$this, 'typogrify']),
new \Twig_SimpleFunction('typogrifyFeed', [$this, 'typogrifyFeed']),
new \Twig_SimpleFunction('smartypants', [$this, 'smartypants']),
new \Twig_SimpleFunction('getPhpTypographySettings', [$this, 'getPhpTypographySettings']),
new \Twig_SimpleFunction('truncate', [$this, 'truncate']),
new \Twig_SimpleFunction('truncateOnWord', [$this, 'truncateOnWord']),
new \Twig_SimpleFunction('stringy', [$this, 'stringy']),
new \Twig_SimpleFunction('humanFileSize', [$this, 'humanFileSize']),
new \Twig_SimpleFunction('humanDuration', [$this, 'humanDuration']),
new \Twig_SimpleFunction('humanRelativeTime', [$this, 'humanRelativeTime']),
new \Twig_SimpleFunction('ordinalize', [$this, 'ordinalize']),
new \Twig_SimpleFunction('pluralize', [$this, 'pluralize']),
new \Twig_SimpleFunction('singularize', [$this, 'singularize']),
new \Twig_SimpleFunction('transliterate', [$this, 'transliterate']),
new \Twig_SimpleFunction('wordLimit', [$this, 'wordLimit']),
new \Twig_SimpleFunction('typogrify', [$variable, 'typogrify']),
new \Twig_SimpleFunction('typogrifyFeed', [$variable, 'typogrifyFeed']),
new \Twig_SimpleFunction('smartypants', [$variable, 'smartypants']),
new \Twig_SimpleFunction('getPhpTypographySettings', [$variable, 'getPhpTypographySettings']),
new \Twig_SimpleFunction('truncate', [$variable, 'truncate']),
new \Twig_SimpleFunction('truncateOnWord', [$variable, 'truncateOnWord']),
new \Twig_SimpleFunction('stringy', [$variable, 'stringy']),
new \Twig_SimpleFunction('humanFileSize', [$variable, 'humanFileSize']),
new \Twig_SimpleFunction('humanDuration', [$variable, 'humanDuration']),
new \Twig_SimpleFunction('humanRelativeTime', [$variable, 'humanRelativeTime']),
new \Twig_SimpleFunction('ordinalize', [$variable, 'ordinalize']),
new \Twig_SimpleFunction('pluralize', [$variable, 'pluralize']),
new \Twig_SimpleFunction('singularize', [$variable, 'singularize']),
new \Twig_SimpleFunction('transliterate', [$variable, 'transliterate']),
new \Twig_SimpleFunction('wordLimit', [$variable, 'wordLimit']),
];
}

/**
* Typogrify applies a veritable kitchen sink of typographic treatments to
* beautify your web typography
*
* @param string $text The text or HTML fragment to process
* @param bool $isTitle Optional. If the HTML fragment is a title.
* Default false
*
* @return string The processed HTML
*/
public function typogrify($text, $isTitle = false)
{
return Template::raw(Typogrify::$plugin->typogrify->typogrify($text, $isTitle));
}

/**
* Typogrify applies a veritable kitchen sink of typographic treatments to
* beautify your web typography but in a way that is appropriate for RSS
* (or similar) feeds -- i.e. excluding processes that may cause issues in
* contexts with limited character set intelligence.
*
* @param string $text The text or HTML fragment to process
* @param bool $isTitle Optional. If the HTML fragment is a title.
* Default false
*
* @return string The processed HTML
*/
public function typogrifyFeed($text, $isTitle = false)
{
return Template::raw(Typogrify::$plugin->typogrify->typogrifyFeed($text, $isTitle));
}

/**
* @param string $text
*
* @return \Twig_Markup
*/
public function smartypants($text)
{
return Template::raw(Typogrify::$plugin->typogrify->smartypants($text));
}

/**
* @return \PHP_Typography\Settings
*/
public function getPhpTypographySettings()
{
return Typogrify::$plugin->typogrify->phpTypographySettings;
}

/**
* Truncates the string to a given length. If $substring is provided, and
* truncating occurs, the string is further truncated so that the substring
* may be appended without exceeding the desired length.
*
* @param string $string The string to truncate
* @param int $length Desired length of the truncated string
* @param string $substring The substring to append if it can fit
*
* @return string with the resulting $str after truncating
*/
public function truncate($string, $length, $substring = '…'): string
{
return Template::raw(Typogrify::$plugin->typogrify->truncate($string, $length, $substring));
}

/**
* Truncates the string to a given length, while ensuring that it does not
* split words. If $substring is provided, and truncating occurs, the
* string is further truncated so that the substring may be appended without
* exceeding the desired length.
*
* @param string $string The string to truncate
* @param int $length Desired length of the truncated string
* @param string $substring The substring to append if it can fit
*
* @return string with the resulting $str after truncating
*/
public function truncateOnWord($string, $length, $substring = '…'): string
{
return Template::raw(Typogrify::$plugin->typogrify->truncateOnWord($string, $length, $substring));
}

/**
* Creates a Stringy object and assigns both string and encoding properties
* the supplied values. $string is cast to a string prior to assignment, and if
* $encoding is not specified, it defaults to mb_internal_encoding(). It
* then returns the initialized object. Throws an InvalidArgumentException
* if the first argument is an array or object without a __toString method.
*
* @param string $string The string initialize the Stringy object with
* @param string $encoding The character encoding
*
* @return Stringy
*/
public function stringy($string = '', $encoding = null)
{
return Typogrify::$plugin->typogrify->stringy($string, $encoding);
}

/**
* Formats the value in bytes as a size in human readable form for example `12 KB`.
*
* This is the short form of [[asSize]].
*
* If [[sizeFormatBase]] is 1024, [binary prefixes](http://en.wikipedia.org/wiki/Binary_prefix)
* (e.g. kibibyte/KiB, mebibyte/MiB, ...) are used in the formatting result.
*
* @param string|int|float $bytes value in bytes to be formatted.
* @param int $decimals the number of digits after the decimal point.
*
* @return string the formatted result.
*/
public function humanFileSize($bytes, $decimals = 1): string
{
return Template::raw(Typogrify::$plugin->typogrify->humanFileSize($bytes, $decimals));
}

/**
* Represents the value as duration in human readable format.
*
* @param \DateInterval|string|int $value the value to be formatted. Acceptable formats:
* - [DateInterval object](http://php.net/manual/ru/class.dateinterval.php)
* - integer - number of seconds. For example: value `131` represents `2 minutes, 11 seconds`
* - ISO8601 duration format. For example, all of these values represent `1 day, 2 hours, 30 minutes` duration:
* `2015-01-01T13:00:00Z/2015-01-02T13:30:00Z` - between two datetime values
* `2015-01-01T13:00:00Z/P1D2H30M` - time interval after datetime value
* `P1D2H30M/2015-01-02T13:30:00Z` - time interval before datetime value
* `P1D2H30M` - simply a date interval
* `P-1D2H30M` - a negative date interval (`-1 day, 2 hours, 30 minutes`)
*
* @return string the formatted duration.
*/
public function humanDuration($value)
{
return Template::raw(Typogrify::$plugin->typogrify->humanDuration($value));
}

/**
* Formats the value as the time interval between a date and now in human readable form.
*
* This method can be used in three different ways:
*
* 1. Using a timestamp that is relative to `now`.
* 2. Using a timestamp that is relative to the `$referenceTime`.
* 3. Using a `DateInterval` object.
*
* @param int|string|\DateTime|\DateInterval $value the value to be formatted. The following
* types of value are supported:
*
* - an integer representing a UNIX timestamp
* - a string that can be [parsed to create a DateTime object](http://php.net/manual/en/datetime.formats.php).
* The timestamp is assumed to be in [[defaultTimeZone]] unless a time zone is explicitly given.
* - a PHP [DateTime](http://php.net/manual/en/class.datetime.php) object
* - a PHP DateInterval object (a positive time interval will refer to the past, a negative one to the future)
*
* @param int|string|\DateTime $referenceTime if specified the value is used as a reference time instead of `now`
* when `$value` is not a `DateInterval` object.
*
* @return string the formatted result.
*/
public function humanRelativeTime($value, $referenceTime = null)
{
return Template::raw(Typogrify::$plugin->typogrify->humanRelativeTime($value, $referenceTime));
}

/**
* Converts number to its ordinal English form
* For example, converts 13 to 13th, 2 to 2nd
*
* @param int $number
*
* @return \Twig_Markup
*/
public function ordinalize(int $number)
{
return Template::raw(Typogrify::$plugin->typogrify->ordinalize($number));
}

/**
* Converts a word to its plural form
* For example, 'apple' will become 'apples', and 'child' will become 'children'
*
* @param string $word
* @param int $number
*
* @return \Twig_Markup
*/
public function pluralize(string $word, int $number = 2)
{
return Template::raw(Typogrify::$plugin->typogrify->pluralize($word, $number));
}

/**
* Converts a word to its singular form
* For example, 'apples' will become 'apple', and 'children' will become 'child'
*
* @param string $word
* @param int $number
*
* @return \Twig_Markup
*/
public function singularize(string $word, int $number = 1)
{
return Template::raw(Typogrify::$plugin->typogrify->singularize($word, $number));
}

/**
* Returns transliterated version of a string
* For example, 获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español?
* will be transliterated to huo qu dao dochira Ukrainsʹka: g,e, Srpska: d, n, d! ¿Espanol?
*
* @param string $string
* @param null $transliterator
*
* @return \Twig_Markup
*/
public function transliterate(string $string, $transliterator = null)
{
return Template::raw(Typogrify::$plugin->typogrify->transliterate($string, $transliterator));
}

/**
* Limits a string by word count. If $substring is provided, and truncating occurs, the
* string is further truncated so that the substring may be appended without
* exceeding the desired length.
*
* @param string $string
* @param int $length
* @param string $substring
*
* @return string
*/
public function wordLimit(string $string, int $length, string $substring = '…')
{
return Template::raw(Typogrify::$plugin->typogrify->wordLimit($string, $length, $substring));
}
}
Loading

0 comments on commit a30b6bd

Please sign in to comment.