code-ruby 4.0.0 → 4.0.1

data/lib/code/object/url.rb

@@ -5,7 +5,8 @@ class Code
     class Url < Object
       CLASS_DOCUMENTATION = {
         name: "Url",
-        description: "encodes text for urls, decodes url-escaped text, and parses strings as urls.",
+        description:
+          "encodes text for urls, decodes url-escaped text, and parses strings as urls.",
         examples: [
           "Url.encode(\"hello world\")",
           "Url.decode(\"a%2Fb%3Fx%3D1\")",
@@ -33,7 +34,8 @@ class Code
         },
         "parse" => {
           name: "parse",
-          description: "returns a url parsed from a value, or an empty url when parsing fails.",
+          description:
+            "returns a url parsed from a value, or an empty url when parsing fails.",
           examples: [
             "Url.parse(\"https://example.com/a?b=1\")",
             "Url.parse(\"/path\")",

data/lib/code/object.rb

@@ -14,11 +14,7 @@ class Code
     CLASS_DOCUMENTATION = {
       name: "Object",
       description: "provides the shared behavior available to every value.",
-      examples: [
-        "Object",
-        "Object.new",
-        "Object.documentation.description"
-      ]
+      examples: %w[Object Object.new Object.documentation.description]
     }.freeze
     INSTANCE_FUNCTIONS = {
       "documentation" => {
@@ -32,7 +28,8 @@ class Code
       },
       "functions" => {
         name: "functions",
-        description: "returns documented instance and class functions available on the value.",
+        description:
+          "returns documented instance and class functions available on the value.",
         examples: [
           "[].functions.keys.include?(:map)",
           "1.functions.keys.include?(:to_string)",
@@ -41,7 +38,8 @@ class Code
       },
       "instance_functions" => {
         name: "instance_functions",
-        description: "returns documented functions available on values of the receiver.",
+        description:
+          "returns documented functions available on values of the receiver.",
         examples: [
           "[].instance_functions.keys.include?(:map)",
           "1.instance_functions.keys.include?(:to_string)",
@@ -50,7 +48,8 @@ class Code
       },
       "class_functions" => {
         name: "class_functions",
-        description: "returns documented functions available on the receiver constructor.",
+        description:
+          "returns documented functions available on the receiver constructor.",
         examples: [
           "[].class_functions",
           "List.class_functions.keys.include?(:new)",
@@ -59,7 +58,8 @@ class Code
       },
       "respond_to?" => {
         name: "respond_to?",
-        description: "returns whether the value responds to the named function.",
+        description:
+          "returns whether the value responds to the named function.",
         examples: [
           "[].respond_to?(:map)",
           "1.respond_to?(:zero?)",
@@ -83,7 +83,8 @@ class Code
       },
       "presence_in" => {
         name: "presence_in",
-        description: "returns the value when it is included in the list, otherwise nothing.",
+        description:
+          "returns the value when it is included in the list, otherwise nothing.",
         examples: [
           "2.presence_in([1, 2, 3])",
           "4.presence_in([1, 2, 3])",
@@ -92,7 +93,8 @@ class Code
       },
       "is_a?" => {
         name: "is_a?",
-        description: "returns whether the value is an instance of the class or one of its subclasses.",
+        description:
+          "returns whether the value is an instance of the class or one of its subclasses.",
         examples: ["1.is_a?(Integer)", ":a.is_a?(String)", "[].is_a?(List)"]
       },
       "is_an?" => {
@@ -103,11 +105,16 @@ class Code
       "kind_of?" => {
         name: "kind_of?",
         description: "alias for is_a?.",
-        examples: ["1.kind_of?(Integer)", ":a.kind_of?(String)", "[].kind_of?(List)"]
+        examples: [
+          "1.kind_of?(Integer)",
+          ":a.kind_of?(String)",
+          "[].kind_of?(List)"
+        ]
       },
       "instance_of?" => {
         name: "instance_of?",
-        description: "returns whether the value is exactly an instance of the class.",
+        description:
+          "returns whether the value is exactly an instance of the class.",
         examples: [
           "1.instance_of?(Integer)",
           ":a.instance_of?(String)",
@@ -117,36 +124,41 @@ class Code
       "!" => {
         name: "!",
         description: "returns the boolean negation of the value.",
-        examples: ["!true", "!false", "!nothing"]
+        examples: %w[!true !false !nothing]
       },
       "not" => {
         name: "not",
         description: "returns the boolean negation of the value.",
-        examples: ["true.not", "false.not", "nothing.not"]
+        examples: %w[true.not false.not nothing.not]
       },
       "!=" => {
         name: "!=",
-        description: "returns whether the value is different from another value.",
+        description:
+          "returns whether the value is different from another value.",
         examples: ["1 != 2", ":a != :b", "[1] != [2]"]
       },
       "different" => {
         name: "different",
-        description: "returns whether the value is different from another value.",
+        description:
+          "returns whether the value is different from another value.",
         examples: ["1.different(2)", ":a.different(:b)", "[1].different([2])"]
       },
       "&&" => {
         name: "&&",
-        description: "returns the other value when the receiver is truthy, otherwise the receiver.",
+        description:
+          "returns the other value when the receiver is truthy, otherwise the receiver.",
         examples: ["true && 1", "false && 1", "1 && 2"]
       },
       "and" => {
         name: "and",
-        description: "returns the other value when the receiver is truthy, otherwise the receiver.",
-        examples: ["true.and(1)", "false.and(1)", "1.and(2)"]
+        description:
+          "returns the other value when the receiver is truthy, otherwise the receiver.",
+        examples: %w[true.and(1) false.and(1) 1.and(2)]
       },
       "+" => {
         name: "+",
-        description: "returns the receiver for object types that do not override plus.",
+        description:
+          "returns the receiver for object types that do not override plus.",
         examples: ["+Object.new", "+nothing", "+[]"]
       },
       "self" => {
@@ -156,30 +168,34 @@ class Code
       },
       ".." => {
         name: "..",
-        description: "builds an inclusive range from the receiver to another value.",
-        examples: ["1..3", ":a..:c", "Date.today..Date.tomorrow"]
+        description:
+          "builds an inclusive range from the receiver to another value.",
+        examples: %w[1..3 :a..:c Date.today..Date.tomorrow]
       },
       "inclusive_range" => {
         name: "inclusive_range",
-        description: "builds an inclusive range from the receiver to another value.",
-        examples: [
-          "1.inclusive_range(3)",
-          ":a.inclusive_range(:c)",
-          "Date.today.inclusive_range(Date.tomorrow)"
+        description:
+          "builds an inclusive range from the receiver to another value.",
+        examples: %w[
+          1.inclusive_range(3)
+          :a.inclusive_range(:c)
+          Date.today.inclusive_range(Date.tomorrow)
         ]
       },
       "..." => {
         name: "...",
-        description: "builds an exclusive range from the receiver to another value.",
-        examples: ["1...3", ":a...:c", "Date.today...Date.tomorrow"]
+        description:
+          "builds an exclusive range from the receiver to another value.",
+        examples: %w[1...3 :a...:c Date.today...Date.tomorrow]
       },
       "exclusive_range" => {
         name: "exclusive_range",
-        description: "builds an exclusive range from the receiver to another value.",
-        examples: [
-          "1.exclusive_range(3)",
-          ":a.exclusive_range(:c)",
-          "Date.today.exclusive_range(Date.tomorrow)"
+        description:
+          "builds an exclusive range from the receiver to another value.",
+        examples: %w[
+          1.exclusive_range(3)
+          :a.exclusive_range(:c)
+          Date.today.exclusive_range(Date.tomorrow)
         ]
       },
       "==" => {
@@ -199,7 +215,8 @@ class Code
       },
       "same_object?" => {
         name: "same_object?",
-        description: "returns whether the value and argument are the same object.",
+        description:
+          "returns whether the value and argument are the same object.",
         examples: [
           "a = [] b = a a.same_object?(b)",
           "[].same_object?([])",
@@ -214,38 +231,42 @@ class Code
       "greater" => {
         name: "greater",
         description: "returns whether the value is greater than another value.",
-        examples: [
-          "2.greater(1)",
-          ":b.greater(:a)",
-          "Date.tomorrow.greater(Date.today)"
+        examples: %w[
+          2.greater(1)
+          :b.greater(:a)
+          Date.tomorrow.greater(Date.today)
         ]
       },
       ">=" => {
         name: ">=",
-        description: "returns whether the value is greater than or equal to another value.",
+        description:
+          "returns whether the value is greater than or equal to another value.",
         examples: ["2 >= 2", ":b >= :a", "Date.today >= Date.today"]
       },
       "greater_or_equal" => {
         name: "greater_or_equal",
-        description: "returns whether the value is greater than or equal to another value.",
-        examples: [
-          "2.greater_or_equal(2)",
-          ":b.greater_or_equal(:a)",
-          "Date.today.greater_or_equal(Date.today)"
+        description:
+          "returns whether the value is greater than or equal to another value.",
+        examples: %w[
+          2.greater_or_equal(2)
+          :b.greater_or_equal(:a)
+          Date.today.greater_or_equal(Date.today)
         ]
       },
       "<=>" => {
         name: "<=>",
-        description: "compares the value with another value and returns -1, 0, or 1.",
+        description:
+          "compares the value with another value and returns -1, 0, or 1.",
         examples: ["1 <=> 2", ":a <=> :b", "Date.today <=> Date.tomorrow"]
       },
       "compare" => {
         name: "compare",
-        description: "compares the value with another value and returns -1, 0, or 1.",
-        examples: [
-          "1.compare(2)",
-          ":a.compare(:b)",
-          "Date.today.compare(Date.tomorrow)"
+        description:
+          "compares the value with another value and returns -1, 0, or 1.",
+        examples: %w[
+          1.compare(2)
+          :a.compare(:b)
+          Date.today.compare(Date.tomorrow)
         ]
       },
       "<" => {
@@ -256,20 +277,22 @@ class Code
       "less" => {
         name: "less",
         description: "returns whether the value is less than another value.",
-        examples: ["1.less(2)", ":a.less(:b)", "Date.today.less(Date.tomorrow)"]
+        examples: %w[1.less(2) :a.less(:b) Date.today.less(Date.tomorrow)]
       },
       "<=" => {
         name: "<=",
-        description: "returns whether the value is less than or equal to another value.",
+        description:
+          "returns whether the value is less than or equal to another value.",
         examples: ["1 <= 1", ":a <= :b", "Date.today <= Date.today"]
       },
       "less_or_equal" => {
         name: "less_or_equal",
-        description: "returns whether the value is less than or equal to another value.",
-        examples: [
-          "1.less_or_equal(1)",
-          ":a.less_or_equal(:b)",
-          "Date.today.less_or_equal(Date.today)"
+        description:
+          "returns whether the value is less than or equal to another value.",
+        examples: %w[
+          1.less_or_equal(1)
+          :a.less_or_equal(:b)
+          Date.today.less_or_equal(Date.today)
         ]
       },
       "===" => {
@@ -280,16 +303,22 @@ class Code
       "strict_equal" => {
         name: "strict_equal",
         description: "returns whether the value strictly equals another value.",
-        examples: ["1.strict_equal(1)", ":a.strict_equal(:a)", "[1].strict_equal([1])"]
+        examples: [
+          "1.strict_equal(1)",
+          ":a.strict_equal(:a)",
+          "[1].strict_equal([1])"
+        ]
       },
       "!==" => {
         name: "!==",
-        description: "returns whether the value does not strictly equal another value.",
+        description:
+          "returns whether the value does not strictly equal another value.",
         examples: ["1 !== 2", ":a !== :b", "[1] !== [2]"]
       },
       "strict_different" => {
         name: "strict_different",
-        description: "returns whether the value does not strictly equal another value.",
+        description:
+          "returns whether the value does not strictly equal another value.",
         examples: [
           "1.strict_different(2)",
           ":a.strict_different(:b)",
@@ -299,32 +328,34 @@ class Code
       "falsy?" => {
         name: "falsy?",
         description: "returns whether the value is falsy.",
-        examples: ["nothing.falsy?", "false.falsy?", "1.falsy?"]
+        examples: %w[nothing.falsy? false.falsy? 1.falsy?]
       },
       "truthy?" => {
         name: "truthy?",
         description: "returns whether the value is truthy.",
-        examples: ["1.truthy?", "true.truthy?", "nothing.truthy?"]
+        examples: %w[1.truthy? true.truthy? nothing.truthy?]
       },
       "true?" => {
         name: "true?",
         description: "returns whether the value is true.",
-        examples: ["true.true?", "false.true?", "1.true?"]
+        examples: %w[true.true? false.true? 1.true?]
       },
       "false?" => {
         name: "false?",
         description: "returns whether the value is false or nothing.",
-        examples: ["false.false?", "nothing.false?", "true.false?"]
+        examples: %w[false.false? nothing.false? true.false?]
       },
       "||" => {
         name: "||",
-        description: "returns the receiver when truthy, otherwise the other value.",
+        description:
+          "returns the receiver when truthy, otherwise the other value.",
         examples: ["nothing || 1", "false || 1", "2 || 1"]
       },
       "or" => {
         name: "or",
-        description: "returns the receiver when truthy, otherwise the other value.",
-        examples: ["nothing.or(1)", "false.or(1)", "2.or(1)"]
+        description:
+          "returns the receiver when truthy, otherwise the other value.",
+        examples: %w[nothing.or(1) false.or(1) 2.or(1)]
       },
       "to_boolean" => {
         name: "to_boolean",
@@ -353,12 +384,16 @@ class Code
       "to_dictionary" => {
         name: "to_dictionary",
         description: "converts the value to a dictionary.",
-        examples: ["[].to_dictionary", "{}.to_dictionary", "[[:a, 1]].to_dictionary"]
+        examples: [
+          "[].to_dictionary",
+          "{}.to_dictionary",
+          "[[:a, 1]].to_dictionary"
+        ]
       },
       "to_duration" => {
         name: "to_duration",
         description: "converts the value to a duration.",
-        examples: ["1.to_duration", "1.day.to_duration", "2.hours.to_duration"]
+        examples: %w[1.to_duration 1.day.to_duration 2.hours.to_duration]
       },
       "to_integer" => {
         name: "to_integer",
@@ -383,11 +418,12 @@ class Code
       "to_string" => {
         name: "to_string",
         description: "converts the value to a string.",
-        examples: ["1.to_string", "true.to_string", ":a.to_string"]
+        examples: %w[1.to_string true.to_string :a.to_string]
       },
       "inspect" => {
         name: "inspect",
-        description: "returns a string representation of the value for inspection.",
+        description:
+          "returns a string representation of the value for inspection.",
         examples: ["1.inspect", ":a.inspect", "[1].inspect"]
       },
       "to_time" => {
@@ -448,7 +484,8 @@ class Code
       },
       "tap" => {
         name: "tap",
-        description: "calls a function with the receiver and returns the receiver.",
+        description:
+          "calls a function with the receiver and returns the receiver.",
         examples: [
           "1.tap((value) => { value })",
           ":a.tap((value) => { value.upcase })",
@@ -457,7 +494,8 @@ class Code
       },
       "then" => {
         name: "then",
-        description: "calls a function with the receiver and returns the function result.",
+        description:
+          "calls a function with the receiver and returns the function result.",
         examples: [
           "1.then((value) => { value + 1 })",
           ":a.then((value) => { value.upcase })",
@@ -472,12 +510,12 @@ class Code
       "nothing?" => {
         name: "nothing?",
         description: "returns whether the value is nothing.",
-        examples: ["nothing.nothing?", "1.nothing?", ":a.nothing?"]
+        examples: %w[nothing.nothing? 1.nothing? :a.nothing?]
       },
       "something?" => {
         name: "something?",
         description: "returns whether the value is not nothing.",
-        examples: ["1.something?", ":a.something?", "nothing.something?"]
+        examples: %w[1.something? :a.something? nothing.something?]
       }
     }.freeze
     CLASS_FUNCTIONS = {
@@ -545,7 +583,9 @@ class Code
     end
 
     def self.documented_functions_for(klass, scope)
-      sorted_dictionary(function_documentation_for(klass, scope).transform_keys(&:to_s))
+      sorted_dictionary(
+        function_documentation_for(klass, scope).transform_keys(&:to_s)
+      )
     end
 
     def self.documentation_for(klass)
@@ -558,8 +598,7 @@ class Code
 
     def self.function_documentation_for(klass, scope)
       documentation = function_documentation_registry_for(klass, scope)
-      inherited_function_documentation_for(klass, scope)
-        .merge(documentation)
+      inherited_function_documentation_for(klass, scope).merge(documentation)
     end
 
     def self.inherited_function_documentation_for(klass, scope)

data/lib/code/parser.rb

@@ -32,37 +32,37 @@ class Code
       while
     ].freeze
 
-    MULTI_CHAR_OPERATORS = [
-      "&.",
-      "&&",
-      "&&=",
-      "**",
-      "*=",
-      "+=",
-      "-=",
-      "..",
-      "...",
-      "/=",
-      "::",
-      "<<=",
-      "<<",
-      "<=>",
-      "<=",
-      "===",
-      "==",
-      "=~",
-      ">=",
-      ">>=",
-      ">>",
-      "||=",
-      "||",
-      "|=",
-      "!==",
-      "!=",
-      "!~",
-      "%=",
-      "^=",
-      "=>"
+    MULTI_CHAR_OPERATORS = %w[
+      &.
+      &&
+      &&=
+      **
+      *=
+      +=
+      -=
+      ..
+      ...
+      /=
+      ::
+      <<=
+      <<
+      <=>
+      <=
+      ===
+      ==
+      =~
+      >=
+      >>=
+      >>
+      ||=
+      ||
+      |=
+      !==
+      !=
+      !~
+      %=
+      ^=
+      =>
     ].sort_by(&:length).reverse.freeze
     CONTINUATION_KEYWORDS = %w[or and rescue].freeze
     POSTFIX_CONTINUATIONS = %w[. :: &.].freeze
@@ -1015,7 +1015,9 @@ class Code
           next
         elsif "([{".include?(char)
           depth += 1
-          raise_parse_error_at("source is too deeply nested", index) if depth > MAX_NESTING
+          if depth > MAX_NESTING
+            raise_parse_error_at("source is too deeply nested", index)
+          end
         elsif ")]}".include?(char)
           depth -= 1 if depth.positive?
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Dorian Marié