hanami-utils 1.3.7 → 2.0.0.alpha1

data/lib/hanami/utils/escape.rb

@@ -39,7 +39,7 @@ module Hanami
       # @since 0.4.0
       # @api private
       HEX_CODES = (0..255).each_with_object({}) do |c, codes|
-        if (c >= 0x30 && c <= 0x39) || (c >= 0x41 && c <= 0x5A) || (c >= 0x61 && c <= 0x7A)
+        if (c >= 0x30 && c <= 0x39) || (c >= 0x41 && c <= 0x5A) || (c >= 0x61 && c <= 0x7A) # rubocop:disable Style/ConditionalAssignment
           codes[c] = nil
         else
           codes[c] = c.to_s(HEX_BASE)
@@ -55,8 +55,8 @@ module Hanami
       #
       # @see https://gist.github.com/jodosha/ac5dd54416de744b9600
       NON_PRINTABLE_CHARS = {
-        0x0 => true, 0x1  => true, 0x2  => true, 0x3  => true, 0x4  => true,
-        0x5 => true, 0x6  => true, 0x7  => true, 0x8  => true, 0x11 => true,
+        0x0  => true, 0x1  => true, 0x2  => true, 0x3  => true, 0x4  => true,
+        0x5  => true, 0x6  => true, 0x7  => true, 0x8  => true, 0x11 => true,
         0x12 => true, 0x14 => true, 0x15 => true, 0x16 => true, 0x17 => true,
         0x18 => true, 0x19 => true, 0x1a => true, 0x1b => true, 0x1c => true,
         0x1d => true, 0x1e => true, 0x1f => true, 0x7f => true, 0x80 => true,
@@ -104,166 +104,166 @@ module Hanami
       #
       # @see Hanami::Utils::Escape.html_attribute
       HTML_ENTITIES = {
-        34 => "quot",     # quotation mark
-        38 => "amp",      # ampersand
-        60 => "lt",       # less-than sign
-        62 => "gt",       # greater-than sign
-        160 => "nbsp",     # no-break space
-        161 => "iexcl",    # inverted exclamation mark
-        162 => "cent",     # cent sign
-        163 => "pound",    # pound sign
-        164 => "curren",   # currency sign
-        165 => "yen",      # yen sign
-        166 => "brvbar",   # broken bar
-        167 => "sect",     # section sign
-        168 => "uml",      # diaeresis
-        169 => "copy",     # copyright sign
-        170 => "ordf",     # feminine ordinal indicator
-        171 => "laquo",    # left-pointing double angle quotation mark
-        172 => "not",      # not sign
-        173 => "shy",      # soft hyphen
-        174 => "reg",      # registered sign
-        175 => "macr",     # macron
-        176 => "deg",      # degree sign
-        177 => "plusmn",   # plus-minus sign
-        178 => "sup2",     # superscript two
-        179 => "sup3",     # superscript three
-        180 => "acute",    # acute accent
-        181 => "micro",    # micro sign
-        182 => "para",     # pilcrow sign
-        183 => "middot",   # middle dot
-        184 => "cedil",    # cedilla
-        185 => "sup1",     # superscript one
-        186 => "ordm",     # masculine ordinal indicator
-        187 => "raquo",    # right-pointing double angle quotation mark
-        188 => "frac14",   # vulgar fraction one quarter
-        189 => "frac12",   # vulgar fraction one half
-        190 => "frac34",   # vulgar fraction three quarters
-        191 => "iquest",   # inverted question mark
-        192 => "Agrave",   # Latin capital letter a with grave
-        193 => "Aacute",   # Latin capital letter a with acute
-        194 => "Acirc",    # Latin capital letter a with circumflex
-        195 => "Atilde",   # Latin capital letter a with tilde
-        196 => "Auml",     # Latin capital letter a with diaeresis
-        197 => "Aring",    # Latin capital letter a with ring above
-        198 => "AElig",    # Latin capital letter ae
-        199 => "Ccedil",   # Latin capital letter c with cedilla
-        200 => "Egrave",   # Latin capital letter e with grave
-        201 => "Eacute",   # Latin capital letter e with acute
-        202 => "Ecirc",    # Latin capital letter e with circumflex
-        203 => "Euml",     # Latin capital letter e with diaeresis
-        204 => "Igrave",   # Latin capital letter i with grave
-        205 => "Iacute",   # Latin capital letter i with acute
-        206 => "Icirc",    # Latin capital letter i with circumflex
-        207 => "Iuml",     # Latin capital letter i with diaeresis
-        208 => "ETH",      # Latin capital letter eth
-        209 => "Ntilde",   # Latin capital letter n with tilde
-        210 => "Ograve",   # Latin capital letter o with grave
-        211 => "Oacute",   # Latin capital letter o with acute
-        212 => "Ocirc",    # Latin capital letter o with circumflex
-        213 => "Otilde",   # Latin capital letter o with tilde
-        214 => "Ouml",     # Latin capital letter o with diaeresis
-        215 => "times",    # multiplication sign
-        216 => "Oslash",   # Latin capital letter o with stroke
-        217 => "Ugrave",   # Latin capital letter u with grave
-        218 => "Uacute",   # Latin capital letter u with acute
-        219 => "Ucirc",    # Latin capital letter u with circumflex
-        220 => "Uuml",     # Latin capital letter u with diaeresis
-        221 => "Yacute",   # Latin capital letter y with acute
-        222 => "THORN",    # Latin capital letter thorn
-        223 => "szlig",    # Latin small letter sharp sXCOMMAX German Eszett
-        224 => "agrave",   # Latin small letter a with grave
-        225 => "aacute",   # Latin small letter a with acute
-        226 => "acirc",    # Latin small letter a with circumflex
-        227 => "atilde",   # Latin small letter a with tilde
-        228 => "auml",     # Latin small letter a with diaeresis
-        229 => "aring",    # Latin small letter a with ring above
-        230 => "aelig",    # Latin lowercase ligature ae
-        231 => "ccedil",   # Latin small letter c with cedilla
-        232 => "egrave",   # Latin small letter e with grave
-        233 => "eacute",   # Latin small letter e with acute
-        234 => "ecirc",    # Latin small letter e with circumflex
-        235 => "euml",     # Latin small letter e with diaeresis
-        236 => "igrave",   # Latin small letter i with grave
-        237 => "iacute",   # Latin small letter i with acute
-        238 => "icirc",    # Latin small letter i with circumflex
-        239 => "iuml",     # Latin small letter i with diaeresis
-        240 => "eth",      # Latin small letter eth
-        241 => "ntilde",   # Latin small letter n with tilde
-        242 => "ograve",   # Latin small letter o with grave
-        243 => "oacute",   # Latin small letter o with acute
-        244 => "ocirc",    # Latin small letter o with circumflex
-        245 => "otilde",   # Latin small letter o with tilde
-        246 => "ouml",     # Latin small letter o with diaeresis
-        247 => "divide",   # division sign
-        248 => "oslash",   # Latin small letter o with stroke
-        249 => "ugrave",   # Latin small letter u with grave
-        250 => "uacute",   # Latin small letter u with acute
-        251 => "ucirc",    # Latin small letter u with circumflex
-        252 => "uuml",     # Latin small letter u with diaeresis
-        253 => "yacute",   # Latin small letter y with acute
-        254 => "thorn",    # Latin small letter thorn
-        255 => "yuml",     # Latin small letter y with diaeresis
-        338 => "OElig",    # Latin capital ligature oe
-        339 => "oelig",    # Latin small ligature oe
-        352 => "Scaron",   # Latin capital letter s with caron
-        353 => "scaron",   # Latin small letter s with caron
-        376 => "Yuml",     # Latin capital letter y with diaeresis
-        402 => "fnof",     # Latin small letter f with hook
-        710 => "circ",     # modifier letter circumflex accent
-        732 => "tilde",    # small tilde
-        913 => "Alpha",    # Greek capital letter alpha
-        914 => "Beta",     # Greek capital letter beta
-        915 => "Gamma",    # Greek capital letter gamma
-        916 => "Delta",    # Greek capital letter delta
-        917 => "Epsilon",  # Greek capital letter epsilon
-        918 => "Zeta",     # Greek capital letter zeta
-        919 => "Eta",      # Greek capital letter eta
-        920 => "Theta",    # Greek capital letter theta
-        921 => "Iota",     # Greek capital letter iota
-        922 => "Kappa",    # Greek capital letter kappa
-        923 => "Lambda",   # Greek capital letter lambda
-        924 => "Mu",       # Greek capital letter mu
-        925 => "Nu",       # Greek capital letter nu
-        926 => "Xi",       # Greek capital letter xi
-        927 => "Omicron",  # Greek capital letter omicron
-        928 => "Pi",       # Greek capital letter pi
-        929 => "Rho",      # Greek capital letter rho
-        931 => "Sigma",    # Greek capital letter sigma
-        932 => "Tau",      # Greek capital letter tau
-        933 => "Upsilon",  # Greek capital letter upsilon
-        934 => "Phi",      # Greek capital letter phi
-        935 => "Chi",      # Greek capital letter chi
-        936 => "Psi",      # Greek capital letter psi
-        937 => "Omega",    # Greek capital letter omega
-        945 => "alpha",    # Greek small letter alpha
-        946 => "beta",     # Greek small letter beta
-        947 => "gamma",    # Greek small letter gamma
-        948 => "delta",    # Greek small letter delta
-        949 => "epsilon",  # Greek small letter epsilon
-        950 => "zeta",     # Greek small letter zeta
-        951 => "eta",      # Greek small letter eta
-        952 => "theta",    # Greek small letter theta
-        953 => "iota",     # Greek small letter iota
-        954 => "kappa",    # Greek small letter kappa
-        955 => "lambda",   # Greek small letter lambda
-        956 => "mu",       # Greek small letter mu
-        957 => "nu",       # Greek small letter nu
-        958 => "xi",       # Greek small letter xi
-        959 => "omicron",  # Greek small letter omicron
-        960 => "pi",       # Greek small letter pi
-        961 => "rho",      # Greek small letter rho
-        962 => "sigmaf",   # Greek small letter final sigma
-        963 => "sigma",    # Greek small letter sigma
-        964 => "tau",      # Greek small letter tau
-        965 => "upsilon",  # Greek small letter upsilon
-        966 => "phi",      # Greek small letter phi
-        967 => "chi",      # Greek small letter chi
-        968 => "psi",      # Greek small letter psi
-        969 => "omega",    # Greek small letter omega
-        977 => "thetasym", # Greek theta symbol
-        978 => "upsih",    # Greek upsilon with hook symbol
-        982 => "piv",      # Greek pi symbol
+        34   => "quot",     # quotation mark
+        38   => "amp",      # ampersand
+        60   => "lt",       # less-than sign
+        62   => "gt",       # greater-than sign
+        160  => "nbsp",     # no-break space
+        161  => "iexcl",    # inverted exclamation mark
+        162  => "cent",     # cent sign
+        163  => "pound",    # pound sign
+        164  => "curren",   # currency sign
+        165  => "yen",      # yen sign
+        166  => "brvbar",   # broken bar
+        167  => "sect",     # section sign
+        168  => "uml",      # diaeresis
+        169  => "copy",     # copyright sign
+        170  => "ordf",     # feminine ordinal indicator
+        171  => "laquo",    # left-pointing double angle quotation mark
+        172  => "not",      # not sign
+        173  => "shy",      # soft hyphen
+        174  => "reg",      # registered sign
+        175  => "macr",     # macron
+        176  => "deg",      # degree sign
+        177  => "plusmn",   # plus-minus sign
+        178  => "sup2",     # superscript two
+        179  => "sup3",     # superscript three
+        180  => "acute",    # acute accent
+        181  => "micro",    # micro sign
+        182  => "para",     # pilcrow sign
+        183  => "middot",   # middle dot
+        184  => "cedil",    # cedilla
+        185  => "sup1",     # superscript one
+        186  => "ordm",     # masculine ordinal indicator
+        187  => "raquo",    # right-pointing double angle quotation mark
+        188  => "frac14",   # vulgar fraction one quarter
+        189  => "frac12",   # vulgar fraction one half
+        190  => "frac34",   # vulgar fraction three quarters
+        191  => "iquest",   # inverted question mark
+        192  => "Agrave",   # Latin capital letter a with grave
+        193  => "Aacute",   # Latin capital letter a with acute
+        194  => "Acirc",    # Latin capital letter a with circumflex
+        195  => "Atilde",   # Latin capital letter a with tilde
+        196  => "Auml",     # Latin capital letter a with diaeresis
+        197  => "Aring",    # Latin capital letter a with ring above
+        198  => "AElig",    # Latin capital letter ae
+        199  => "Ccedil",   # Latin capital letter c with cedilla
+        200  => "Egrave",   # Latin capital letter e with grave
+        201  => "Eacute",   # Latin capital letter e with acute
+        202  => "Ecirc",    # Latin capital letter e with circumflex
+        203  => "Euml",     # Latin capital letter e with diaeresis
+        204  => "Igrave",   # Latin capital letter i with grave
+        205  => "Iacute",   # Latin capital letter i with acute
+        206  => "Icirc",    # Latin capital letter i with circumflex
+        207  => "Iuml",     # Latin capital letter i with diaeresis
+        208  => "ETH",      # Latin capital letter eth
+        209  => "Ntilde",   # Latin capital letter n with tilde
+        210  => "Ograve",   # Latin capital letter o with grave
+        211  => "Oacute",   # Latin capital letter o with acute
+        212  => "Ocirc",    # Latin capital letter o with circumflex
+        213  => "Otilde",   # Latin capital letter o with tilde
+        214  => "Ouml",     # Latin capital letter o with diaeresis
+        215  => "times",    # multiplication sign
+        216  => "Oslash",   # Latin capital letter o with stroke
+        217  => "Ugrave",   # Latin capital letter u with grave
+        218  => "Uacute",   # Latin capital letter u with acute
+        219  => "Ucirc",    # Latin capital letter u with circumflex
+        220  => "Uuml",     # Latin capital letter u with diaeresis
+        221  => "Yacute",   # Latin capital letter y with acute
+        222  => "THORN",    # Latin capital letter thorn
+        223  => "szlig",    # Latin small letter sharp sXCOMMAX German Eszett
+        224  => "agrave",   # Latin small letter a with grave
+        225  => "aacute",   # Latin small letter a with acute
+        226  => "acirc",    # Latin small letter a with circumflex
+        227  => "atilde",   # Latin small letter a with tilde
+        228  => "auml",     # Latin small letter a with diaeresis
+        229  => "aring",    # Latin small letter a with ring above
+        230  => "aelig",    # Latin lowercase ligature ae
+        231  => "ccedil",   # Latin small letter c with cedilla
+        232  => "egrave",   # Latin small letter e with grave
+        233  => "eacute",   # Latin small letter e with acute
+        234  => "ecirc",    # Latin small letter e with circumflex
+        235  => "euml",     # Latin small letter e with diaeresis
+        236  => "igrave",   # Latin small letter i with grave
+        237  => "iacute",   # Latin small letter i with acute
+        238  => "icirc",    # Latin small letter i with circumflex
+        239  => "iuml",     # Latin small letter i with diaeresis
+        240  => "eth",      # Latin small letter eth
+        241  => "ntilde",   # Latin small letter n with tilde
+        242  => "ograve",   # Latin small letter o with grave
+        243  => "oacute",   # Latin small letter o with acute
+        244  => "ocirc",    # Latin small letter o with circumflex
+        245  => "otilde",   # Latin small letter o with tilde
+        246  => "ouml",     # Latin small letter o with diaeresis
+        247  => "divide",   # division sign
+        248  => "oslash",   # Latin small letter o with stroke
+        249  => "ugrave",   # Latin small letter u with grave
+        250  => "uacute",   # Latin small letter u with acute
+        251  => "ucirc",    # Latin small letter u with circumflex
+        252  => "uuml",     # Latin small letter u with diaeresis
+        253  => "yacute",   # Latin small letter y with acute
+        254  => "thorn",    # Latin small letter thorn
+        255  => "yuml",     # Latin small letter y with diaeresis
+        338  => "OElig",    # Latin capital ligature oe
+        339  => "oelig",    # Latin small ligature oe
+        352  => "Scaron",   # Latin capital letter s with caron
+        353  => "scaron",   # Latin small letter s with caron
+        376  => "Yuml",     # Latin capital letter y with diaeresis
+        402  => "fnof",     # Latin small letter f with hook
+        710  => "circ",     # modifier letter circumflex accent
+        732  => "tilde",    # small tilde
+        913  => "Alpha",    # Greek capital letter alpha
+        914  => "Beta",     # Greek capital letter beta
+        915  => "Gamma",    # Greek capital letter gamma
+        916  => "Delta",    # Greek capital letter delta
+        917  => "Epsilon",  # Greek capital letter epsilon
+        918  => "Zeta",     # Greek capital letter zeta
+        919  => "Eta",      # Greek capital letter eta
+        920  => "Theta",    # Greek capital letter theta
+        921  => "Iota",     # Greek capital letter iota
+        922  => "Kappa",    # Greek capital letter kappa
+        923  => "Lambda",   # Greek capital letter lambda
+        924  => "Mu",       # Greek capital letter mu
+        925  => "Nu",       # Greek capital letter nu
+        926  => "Xi",       # Greek capital letter xi
+        927  => "Omicron",  # Greek capital letter omicron
+        928  => "Pi",       # Greek capital letter pi
+        929  => "Rho",      # Greek capital letter rho
+        931  => "Sigma",    # Greek capital letter sigma
+        932  => "Tau",      # Greek capital letter tau
+        933  => "Upsilon",  # Greek capital letter upsilon
+        934  => "Phi",      # Greek capital letter phi
+        935  => "Chi",      # Greek capital letter chi
+        936  => "Psi",      # Greek capital letter psi
+        937  => "Omega",    # Greek capital letter omega
+        945  => "alpha",    # Greek small letter alpha
+        946  => "beta",     # Greek small letter beta
+        947  => "gamma",    # Greek small letter gamma
+        948  => "delta",    # Greek small letter delta
+        949  => "epsilon",  # Greek small letter epsilon
+        950  => "zeta",     # Greek small letter zeta
+        951  => "eta",      # Greek small letter eta
+        952  => "theta",    # Greek small letter theta
+        953  => "iota",     # Greek small letter iota
+        954  => "kappa",    # Greek small letter kappa
+        955  => "lambda",   # Greek small letter lambda
+        956  => "mu",       # Greek small letter mu
+        957  => "nu",       # Greek small letter nu
+        958  => "xi",       # Greek small letter xi
+        959  => "omicron",  # Greek small letter omicron
+        960  => "pi",       # Greek small letter pi
+        961  => "rho",      # Greek small letter rho
+        962  => "sigmaf",   # Greek small letter final sigma
+        963  => "sigma",    # Greek small letter sigma
+        964  => "tau",      # Greek small letter tau
+        965  => "upsilon",  # Greek small letter upsilon
+        966  => "phi",      # Greek small letter phi
+        967  => "chi",      # Greek small letter chi
+        968  => "psi",      # Greek small letter psi
+        969  => "omega",    # Greek small letter omega
+        977  => "thetasym", # Greek theta symbol
+        978  => "upsih",    # Greek upsilon with hook symbol
+        982  => "piv",      # Greek pi symbol
         8194 => "ensp",     # en space
         8195 => "emsp",     # em space
         8201 => "thinsp",   # thin space
@@ -370,10 +370,8 @@ module Hanami
       #
       # It's marked with this special class for two reasons:
       #
-      #   * Don't double escape the same string (this is for `Hanami::Helpers`
-      #     compatibility)
-      #   * Leave open the possibility to developers to mark a string as safe
-      #     with an higher API (eg. `#raw` in `Hanami::View` or `Hanami::Helpers`)
+      #   * Don't double escape the same string (this is for `Hanami::Helpers` compatibility)
+      #   * Leave open the possibility to developers to mark a string as safe with an higher API (eg. `#raw` in `Hanami::View` or `Hanami::Helpers`)
       #
       # @since 0.4.0
       # @api private
@@ -401,7 +399,7 @@ module Hanami
         end
       end
 
-      # Escapes HTML contents
+      # Escape HTML contents
       #
       # This MUST be used only for tag contents.
       # Please use `html_attribute` for escaping HTML attributes.
@@ -434,7 +432,7 @@ module Hanami
         result
       end
 
-      # Escapes HTML attributes
+      # Escape HTML attributes
       #
       # This can be used both for HTML attributes and contents.
       # Please note that this is more computational expensive.
@@ -467,7 +465,7 @@ module Hanami
         result
       end
 
-      # Escapes URL for HTML attributes (href, src, etc..).
+      # Escape URL for HTML attributes (href, src, etc..).
       #
       # It extracts from the given input the first valid URL that matches the
       # whitelisted schemes (default: http, https and mailto).
@@ -525,7 +523,7 @@ module Hanami
       class << self
         private
 
-        # Encodes the given string into UTF-8
+        # Encode the given string into UTF-8
         #
         # @param input [String] the input
         #
@@ -559,7 +557,7 @@ module Hanami
 
           hex = REPLACEMENT_HEX if NON_PRINTABLE_CHARS[code]
 
-          if entity = HTML_ENTITIES[code]
+          if entity = HTML_ENTITIES[code] # rubocop:disable Lint/AssignmentInCondition
             "&#{entity};"
           else
             "&#x#{hex};"

data/lib/hanami/utils/file_list.rb

@@ -6,7 +6,7 @@ module Hanami
     #
     # @since 0.9.0
     module FileList
-      # Returns an ordered list of files, consistent across operating systems
+      # Return an ordered list of files, consistent across operating systems
       #
       # It has the same signature of <tt>Dir.glob</tt>, it just guarantees to
       # order the results before to return them.

data/lib/hanami/utils/files.rb

@@ -34,24 +34,6 @@ module Hanami
         open(path, ::File::CREAT | ::File::WRONLY | ::File::TRUNC, *content) # rubocop:disable Security/Open - this isn't a call to `::Kernel.open`, but to `self.open`
       end
 
-      # Rewrites the contents of an existing file.
-      # If the path already exists, it replaces the contents.
-      #
-      # @param path [String,Pathname] the path to file
-      # @param content [String, Array<String>] the content to write
-      #
-      # @raise [Errno::ENOENT] if the path doesn't exist
-      #
-      # @since 1.1.0
-      def self.rewrite(path, *content)
-        Hanami::Utils::Deprecation.new(
-          "`.rewrite' is deprecated, please use `.write'"
-        )
-        raise Errno::ENOENT unless File.exist?(path)
-
-        write(path, *content)
-      end
-
       # Copies source into destination.
       # All the intermediate directories are created.
       # If the destination already exists, it overrides the contents.
@@ -165,7 +147,6 @@ module Hanami
         mkdir_p(path)
 
         content = ::File.readlines(path)
-        content << "\n" if _append_newline?(content)
         content << "#{contents}\n"
 
         write(path, content)
@@ -326,12 +307,12 @@ module Hanami
       #
       #   # class App
       #   # end
-      def self.remove_block(path, target)
+      def self.remove_block(path, target) # rubocop:disable Metrics/AbcSize
         content  = ::File.readlines(path)
         starting = index(content, path, target)
         line     = content[starting]
         size     = line[/\A[[:space:]]*/].bytesize
-        closing  = (" " * size) + (target =~ /{/ ? "}" : "end")
+        closing  = (" " * size) + (/{/.match?(target) ? "}" : "end")
         ending   = starting + index(content[starting..-1], path, closing)
 
         content.slice!(starting..ending)
@@ -454,16 +435,6 @@ module Hanami
       end
 
       private_class_method :line_number
-
-      # @since 1.3.6
-      # @api private
-      def self._append_newline?(content)
-        return false if content.empty?
-
-        !content.last.end_with?("\n")
-      end
-
-      private_class_method :_append_newline?
     end
   end
 end