ree_lib 1.0.103 → 1.0.104

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/excerpt.schema.json

@@ -1,45 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "excerpt",
-  "path": "packages/ree_text/package/ree_text/functions/excerpt.rb",
-  "mount_as": "fn",
-  "class": "ReeText::Excerpt",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Extracts an excerpt from +text+ that matches the first instance of +phrase+.\nThe <tt>:radius</tt> option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters\ndefined in <tt>:radius</tt> (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,\nthen the <tt>:omission</tt> option (which defaults to \"...\") will be prepended/appended accordingly. Use the\n<tt>:separator</tt> option to choose the delimitation. The resulting string will be stripped in any case. If the +phrase+\nisn't found, +nil+ is returned.\n\n  excerpt('This is an example', 'an', radius: 5)\n  # => ...s is an exam...\n\n  excerpt('This is an example', 'is', radius: 5)\n  # => This is a...\n\n  excerpt('This is an example', 'is')\n  # => This is an example\n\n  excerpt('This next thing is an example', 'ex', radius: 2)\n  # => ...next...\n\n  excerpt('This is also an example', 'an', radius: 8, omission: '<chop> ')\n  # => <chop> is also an example\n\n  excerpt('This is a very beautiful morning', 'very', separator: ' ', radius: 1)\n  # => ...a very beautiful...",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "text",
-          "arg_type": "req",
-          "type": "String"
-        },
-        {
-          "arg": "phrase",
-          "arg_type": "req",
-          "type": "Or[String, Regexp]"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:radius? => Integer, :omission? => String, :separator? => String]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "is_blank",
-      "package_name": "ree_object",
-      "as": "is_blank",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/highlight.schema.json

@@ -1,50 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "highlight",
-  "path": "packages/ree_text/package/ree_text/functions/highlight.rb",
-  "mount_as": "fn",
-  "class": "ReeText::Highlight",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Highlights one or more +phrases+ everywhere in +text+ by inserting it into\na <tt>:highlighter</tt> string. The highlighter can be specialized by passing <tt>:highlighter</tt>\nas a single-quoted string with <tt>\u0001</tt> where the phrase is to be inserted (defaults to\n<tt><mark>\u0001</mark></tt>) or passing a block that receives each matched term. By default +text+\nis sanitized to prevent possible XSS attacks.If the input is trustworthy, passing false\nfor <tt>:sanitize</tt> will turn sanitizing off.\n\n  highlight('You searched for: rails', 'rails')\n  # => You searched for: <mark>rails</mark>\n\n  highlight('You searched for: rails', /for|rails/)\n  # => You searched <mark>for</mark>: <mark>rails</mark>\n\n  highlight('You searched for: ruby, rails, dhh', 'actionpack')\n  # => You searched for: ruby, rails, dhh\n\n  highlight('You searched for: rails', ['for', 'rails'], highlighter: '<em>\u0001</em>')\n  # => You searched <em>for</em>: <em>rails</em>\n\n  highlight('You searched for: rails', 'rails', highlighter: '<a href=\"search?q=\u0001\">\u0001</a>')\n  # => You searched for: <a href=\"search?q=rails\">rails</a>\n\n  highlight('You searched for: rails', 'rails') { |match| link_to(search_path(q: match, match)) }\n  # => You searched for: <a href=\"search?q=rails\">rails</a>\n\n  highlight('<a href=\"javascript:alert('no!')\">ruby</a> on rails', 'rails', sanitize: false)\n  # => <a href=\"javascript:alert('no!')\">ruby</a> on <mark>rails</mark>",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "text",
-          "arg_type": "req",
-          "type": "String"
-        },
-        {
-          "arg": "phrases",
-          "arg_type": "opt",
-          "type": "Nilor[String, ArrayOf[String], Regexp]"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:highlighter? => String, :sanitize? => Bool]"
-        },
-        {
-          "arg": "block",
-          "arg_type": "block",
-          "type": "Block"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "sanitize_html",
-      "package_name": "ree_text",
-      "as": "sanitize_html",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/safe_join.schema.json

@@ -1,40 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "safe_join",
-  "path": "packages/ree_text/package/ree_text/functions/safe_join.rb",
-  "mount_as": "fn",
-  "class": "ReeText::SafeJoin",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "This method returns an string similar to what <tt>Array#join</tt>\nwould return. The array is flattened, and all items, including\nthe supplied separator, are HTML escaped.\n\n  safe_join([\"<p>foo</p>\", \"<p>bar</p>\"], sep: \"<br />\")\n  # => \"&lt;p&gt;foo&lt;/p&gt;&lt;br /&gt;&lt;p&gt;bar&lt;/p&gt;\"",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "array",
-          "arg_type": "req",
-          "type": "Array"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:sep? => String]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "escape_html",
-      "package_name": "ree_text",
-      "as": "escape_html",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/sanitize_css.schema.json

@@ -1,28 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "sanitize_css",
-  "path": "packages/ree_text/package/ree_text/functions/sanitize_css.rb",
-  "mount_as": "fn",
-  "class": "ReeText::SanitizeCss",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Sanitizes a block of CSS code",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "str",
-          "arg_type": "req",
-          "type": "String"
-        }
-      ]
-    }
-  ],
-  "links": [
-
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/sanitize_html.schema.json

@@ -1,38 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "sanitize_html",
-  "path": "packages/ree_text/package/ree_text/functions/sanitize_html.rb",
-  "mount_as": "fn",
-  "class": "ReeText::SanitizeHtml",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Sanitizes both html and css via the safe lists found here:\nhttps://github.com/flavorjones/loofah/blob/master/lib/loofah/html5/safelist.rb\n\nTags and attributes can also be passed to +sanitize+.\nPassed options take precedence over the class level options.",
-      "throws": [
-        "ArgumentError"
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "html",
-          "arg_type": "req",
-          "type": "String"
-        },
-        {
-          "arg": "prune",
-          "arg_type": "key",
-          "type": "Bool"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:tags? => ArrayOf[String], :attributes? => ArrayOf[String]]"
-        }
-      ]
-    }
-  ],
-  "links": [
-
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/simple_format.schema.json

@@ -1,56 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "simple_format",
-  "path": "packages/ree_text/package/ree_text/functions/simple_format.rb",
-  "mount_as": "fn",
-  "class": "ReeText::SimpleFormat",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Returns +text+ transformed into HTML using simple formatting rules.\nTwo or more consecutive newlines (<tt>\n\n</tt> or <tt>\r\n\r\n</tt>) are\nconsidered a paragraph and wrapped in <tt><p></tt> tags. One newline\n(<tt>\n</tt> or <tt>\r\n</tt>) is considered a linebreak and a\n<tt><br /></tt> tag is appended. This method does not remove the\nnewlines from the +text+.\n\nYou can pass any HTML attributes into <tt>html_options</tt>. These\nwill be added to all created paragraphs.\n\n==== Options\n* <tt>:sanitize</tt> - If +false+, does not sanitize +text+.\n* <tt>:wrapper_tag</tt> - String representing the wrapper tag, defaults to <tt>\"p\"</tt>\n\n==== Examples\n  my_text = \"Here is some basic text...\n...with a line break.\"\n\n  simple_format(my_text)\n  # => \"<p>Here is some basic text...\n<br />...with a line break.</p>\"\n\n  simple_format(my_text, wrapper_tag: \"div\")\n  # => \"<div>Here is some basic text...\n<br />...with a line break.</div>\"\n\n  more_text = \"We want to put a paragraph...\n\n...right there.\"\n\n  simple_format(more_text)\n  # => \"<p>We want to put a paragraph...</p>\n\n<p>...right there.</p>\"\n\n  simple_format(\"Look ma! A class!\", class: 'description')\n  # => \"<p class='description'>Look ma! A class!</p>\"\n\n  simple_format(\"<blink>Unblinkable.</blink>\", sanitize: true)\n  # => \"<p>Unblinkable.</p>\"\n\n  simple_format(\"<blink>Blinkable!</blink> It's true.\", sanitize: false)\n  # => \"<p><blink>Blinkable!</blink> It's true.</p>\"",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "text",
-          "arg_type": "req",
-          "type": "Nilor[String]"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:html_options? => Hash, :wrapper_tag? => Or[Symbol, String], :sanitize? => Bool]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "escape_html",
-      "package_name": "ree_text",
-      "as": "escape_html",
-      "imports": [
-
-      ]
-    },
-    {
-      "target": "is_blank",
-      "package_name": "ree_object",
-      "as": "is_blank",
-      "imports": [
-
-      ]
-    },
-    {
-      "target": "sanitize_html",
-      "package_name": "ree_text",
-      "as": "sanitize_html",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/strip_links.schema.json

@@ -1,28 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "strip_links",
-  "path": "packages/ree_text/package/ree_text/functions/strip_links.rb",
-  "mount_as": "fn",
-  "class": "ReeText::StripLinks",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Removes +a+ tags and +href+ attributes leaving only the link text.\nstrip_links('<a href=\"example.com\">Only the link text will be kept.</a>')\n#\n#  => 'Only the link text will be kept.'",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "html",
-          "arg_type": "req",
-          "type": "String"
-        }
-      ]
-    }
-  ],
-  "links": [
-
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/strip_tags.schema.json

@@ -1,35 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "strip_tags",
-  "path": "packages/ree_text/package/ree_text/functions/strip_tags.rb",
-  "mount_as": "fn",
-  "class": "ReeText::StripTags",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Strips all HTML tags from +html+, including comments and special characters.\n\n  strip_tags(\"Strip <i>these</i> tags!\")\n  # => Strip these tags!\n\n  strip_tags(\"<b>Bold</b> no more!  <a href='more.html'>See more here</a>...\")\n  # => Bold no more!  See more here...\n\n  strip_tags(\"<div id='top-bar'>Welcome to my website!</div>\")\n  # => Welcome to my website!\n\n  strip_tags(\"> A quote from Smith & Wesson\")\n  # => &gt; A quote from Smith &amp; Wesson",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "html",
-          "arg_type": "req",
-          "type": "String"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "is_blank",
-      "package_name": "ree_object",
-      "as": "is_blank",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/to_sentence.schema.json

@@ -1,61 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "to_sentence",
-  "path": "packages/ree_text/package/ree_text/functions/to_sentence.rb",
-  "mount_as": "fn",
-  "class": "ReeText::ToSentence",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Converts the array to a comma-separated sentence where the last element is\njoined by the connector word.\n\n  to_sentence([\"one\", \"two\", \"three\"])                                      # => \"one, two, and three\"\n  to_sentence([\"one\", \"two\", \"three\"], words_connector: \" \"))               # => \"one two, and three\"\n  to_sentence([\"one\", \"two\", \"three\"], last_word_connector: \", and also \")  # =>\"one, two, and also three\"\n  to_sentence([\"one\", \"two\"], two_words_connector: \" & \")                   # => \"one & two\"",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "array",
-          "arg_type": "req",
-          "type": "Array"
-        },
-        {
-          "arg": "locale",
-          "arg_type": "key",
-          "type": "Symbol"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:words_connector? => String, :two_words_connector? => String, :last_word_connector? => String]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "escape_html",
-      "package_name": "ree_text",
-      "as": "escape_html",
-      "imports": [
-
-      ]
-    },
-    {
-      "target": "safe_join",
-      "package_name": "ree_text",
-      "as": "safe_join",
-      "imports": [
-
-      ]
-    },
-    {
-      "target": "t",
-      "package_name": "ree_i18n",
-      "as": "t",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/unescape_html.schema.json

@@ -1,28 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "unescape_html",
-  "path": "packages/ree_text/package/ree_text/functions/unescape_html.rb",
-  "mount_as": "fn",
-  "class": "ReeText::UnescapeHtml",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "A utility method for unescaping HTML.",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "str",
-          "arg_type": "req",
-          "type": "String"
-        }
-      ]
-    }
-  ],
-  "links": [
-
-  ]
-}

data/lib/ree_lib/packages/ree_text/schemas/ree_text/functions/word_wrap.schema.json

@@ -1,33 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "word_wrap",
-  "path": "packages/ree_text/package/ree_text/functions/word_wrap.rb",
-  "mount_as": "fn",
-  "class": "ReeText::WordWrap",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "Wraps the +text+ into lines no longer than +line_width+ width. This method\nbreaks on the first whitespace character that does not exceed +line_width+\n(which is 80 by default).\n\n  word_wrap('Once upon a time')\n  # => Once upon a time\n\n  word_wrap('Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding a successor to the throne turned out to be more trouble than anyone could have imagined...')\n  # => Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding\na successor to the throne turned out to be more trouble than anyone could have\nimagined...\n\n  word_wrap('Once upon a time', line_width: 8)\n  # => Once\nupon a\ntime\n\n  word_wrap('Once upon a time', line_width: 1)\n  # => Once\nupon\na\ntime\n\n  You can also specify a custom +break_sequence+ (\"\n\" by default)\n\n  word_wrap('Once upon a time', line_width: 1, break_sequence: \"\r\n\")\n  # => Once\r\nupon\r\na\r\ntime",
-      "throws": [
-
-      ],
-      "return": "String",
-      "args": [
-        {
-          "arg": "text",
-          "arg_type": "req",
-          "type": "String"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:line_width? => Integer, :break_sequence? => String]"
-        }
-      ]
-    }
-  ],
-  "links": [
-
-  ]
-}

data/lib/ree_lib/packages/ree_validator/schemas/ree_validator/functions/validate_email.schema.json

@@ -1,40 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "validate_email",
-  "path": "packages/ree_validator/package/ree_validator/functions/validate_email.rb",
-  "mount_as": "fn",
-  "class": "ReeValidator::ValidateEmail",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "",
-      "throws": [
-        "ReeValidator::ValidateEmail::InvalidEmailErr"
-      ],
-      "return": "Bool",
-      "args": [
-        {
-          "arg": "email",
-          "arg_type": "req",
-          "type": "String"
-        },
-        {
-          "arg": "error",
-          "arg_type": "opt",
-          "type": "Nilor[StandardError]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "t",
-      "package_name": "ree_i18n",
-      "as": "t",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_validator/schemas/ree_validator/functions/validate_exclusion.schema.json

@@ -1,45 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "validate_exclusion",
-  "path": "packages/ree_validator/package/ree_validator/functions/validate_exclusion.rb",
-  "mount_as": "fn",
-  "class": "ReeValidator::ValidateExclusion",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "",
-      "throws": [
-
-      ],
-      "return": "Bool",
-      "args": [
-        {
-          "arg": "value",
-          "arg_type": "req",
-          "type": "Any"
-        },
-        {
-          "arg": "list_or_set",
-          "arg_type": "req",
-          "type": "Or[ArrayOf[Any], SetOf[Any], RangeOf[Any]]"
-        },
-        {
-          "arg": "error",
-          "arg_type": "opt",
-          "type": "Nilor[StandardError]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "t",
-      "package_name": "ree_i18n",
-      "as": "t",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_validator/schemas/ree_validator/functions/validate_inclusion.schema.json

@@ -1,45 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "validate_inclusion",
-  "path": "packages/ree_validator/package/ree_validator/functions/validate_inclusion.rb",
-  "mount_as": "fn",
-  "class": "ReeValidator::ValidateInclusion",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "",
-      "throws": [
-
-      ],
-      "return": "Bool",
-      "args": [
-        {
-          "arg": "value",
-          "arg_type": "req",
-          "type": "Any"
-        },
-        {
-          "arg": "list_or_set",
-          "arg_type": "req",
-          "type": "Or[ArrayOf[Any], SetOf[Any], RangeOf[Any]]"
-        },
-        {
-          "arg": "error",
-          "arg_type": "opt",
-          "type": "Nilor[StandardError]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "t",
-      "package_name": "ree_i18n",
-      "as": "t",
-      "imports": [
-
-      ]
-    }
-  ]
-}

data/lib/ree_lib/packages/ree_validator/schemas/ree_validator/functions/validate_length.schema.json

@@ -1,45 +0,0 @@
-{
-  "schema_type": "object",
-  "schema_version": "1.1",
-  "name": "validate_length",
-  "path": "packages/ree_validator/package/ree_validator/functions/validate_length.rb",
-  "mount_as": "fn",
-  "class": "ReeValidator::ValidateLength",
-  "factory": null,
-  "methods": [
-    {
-      "doc": "",
-      "throws": [
-        "ReeValidator::ValidateLength::LenthErr"
-      ],
-      "return": "Bool",
-      "args": [
-        {
-          "arg": "object",
-          "arg_type": "req",
-          "type": "Proc#call"
-        },
-        {
-          "arg": "error",
-          "arg_type": "opt",
-          "type": "Nilor[StandardError]"
-        },
-        {
-          "arg": "opts",
-          "arg_type": "keyrest",
-          "type": "Ksplat[:min? => Integer, :max? => Integer, :equal_to? => Integer, :not_equal_to? => Integer]"
-        }
-      ]
-    }
-  ],
-  "links": [
-    {
-      "target": "t",
-      "package_name": "ree_i18n",
-      "as": "t",
-      "imports": [
-
-      ]
-    }
-  ]
-}