comment_strip-ruby 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69539de8b13faa339084af8667f5e062f1b7d3244861a3008d74622d74af5eb6
-  data.tar.gz: acc60fe0c8e9d094b204ad35e2d6b6370d4e11d5f5e677103ffd2ba943f0fc7f
+  metadata.gz: e320f9b4b49802d9301139fadb06eaa71c7a28f641e31892c60475bca96d78d5
+  data.tar.gz: 055d162fb3675a3ede834009ae775b0704896bab3d7d865545dbdc7de18e6c32
 SHA512:
-  metadata.gz: 76a23018cbd60b02fc811132a103676158603b6dfd8c038b15f5671a0704d983ba3bfe54c0e70dedd72e98cf3e9de1cf972c48c3268cdc4385c6f685c9e04332
-  data.tar.gz: d4c21de13d0bf22a7b482b71899bd9a7163dc712c685d4b336234b30d4318d04f9621769723a9e56a914fbe8e58f1ddf0f7dec7d2ee1a2b3bff98ba70f2fb6fb
+  metadata.gz: f4e58fe98de4d8592b565d7e3000f8cf7e53daf07029b0d566bc23c457e203c66f16a6162c8235302bed94b599ed1616722e57a97978096a14688f3fdba2b23c
+  data.tar.gz: d0ac2808f789296db1471688584e11508692578bf36608e577a34455ff3b3aedbb3a3378dca02ecce626f50a2e8ec9843abcc0bef5b31ed5b38e2ea0658c7b99

data/README.md

@@ -30,8 +30,10 @@ gem 'comment_strip-ruby'
 
 ## Components
 
-T.B.C.
+Current version supports following language families:
 
+* `'C'` - C-family languages, recognising `//` line and `/* . . . */` block comments;
+* `'Hash_Line'` - Generic support for `#` line comments, as found in shell scripts and languages such as **Perl**, **Python**, and **Ruby**. Does _NOT_ (yet) provide any language-specific smarts such as she-bang comments and directive comments;
 ## Examples
 
 It is as simple as the following:

data/lib/comment_strip/language_families/c.rb

@@ -1,14 +1,14 @@
 # ######################################################################## #
-# File:         comment_strip/language_families/c.rb
+# File:     comment_strip/language_families/c.rb
 #
-# Purpose:      Definition of strip() function for C-family languages.
+# Purpose:  Definition of strip() function for C-family languages.
 #
-# Created:      14th September 2020
-# Updated:      11th July 2022
+# Created:  14th September 2020
+# Updated:  31st March 2024
 #
-# Home:         http://github.com/synesissoftware/comment_strip.r
+# Home:     http://github.com/synesissoftware/comment_strip.r
 #
-# Copyright (c) 2020-2022, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2020-2024, Matthew Wilson and Synesis Information Systems
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -47,200 +47,222 @@ module LanguageFamilies
 
 module C
 
-    def self.strip input, lf, **options
+  def self.strip input, lf, **options
 
-        return nil if input.nil?
-        return input if input.empty?
+    return input if input.nil?
+    return input if input.empty?
 
-        line    =   0
-        column  =   0
+    line    =   0
+    column  =   0
 
-        state   =   :text
+    # States:
+    #
+    # - :c_comment          - in a C comment, i.e. from immediately after "/*"
+    # - :c_comment_star     - in a C comment when just received '*', e.g. from immediately after "/* comment *"
+    # - :cpp_comment        - in a C++ comment, i.e. from immediately after "//"
+    # - :dq_string          - within a double-quoted string
+    # - :dq_string_escape   - within a double-quoted string when just received a '"', e.g. from immediately after '"the next word is quoted \'
+    # - :slash_start        - having found a slash (not in a string)
+    # - :sq_string_closing  - waiting for final '\'' in a single-quoted string
+    # - :sq_string_escape   - within a escaped single-quoted string, i.e. from immediately after "'\"
+    # - :sq_string_open     - within a single-quoted string, i.e. from immediately after "'"
+    # - :text               - regular part of the code
 
-        r       =   ''
+    state   =   :text
 
-        cc_lines =   0
+    r       =   ''
 
-        input.each_char do |c|
+    cc_lines =   0
 
-            case c
-            when ?\r, ?\n
-
-                line += 1
-                column = 0
-            else
-
-                column += 1
-            end
+    input.each_char do |c|
 
-            skip = false
+      case c
+      when ?\r, ?\n
 
-            case c
-            when ?\r, ?\n
+        line += 1
+        column = 0
+      else
 
-                case state
-                when :c_comment, :c_comment_star
+        column += 1
+      end
 
-                    cc_lines += 1
+      skip = false
 
-                    state = :c_comment
-                when :cpp_comment
+      case c
+      when ?\r, ?\n
 
-                    state = :text
-                when :sq_string, :sq_string_escape, :sq_string_closing
+        case state
+        when :c_comment, :c_comment_star
 
-                    state = :text
-                when :dq_string_escape
+          cc_lines += 1
 
-                    state = :dq_string
-                when :slash_start
+          state = :c_comment
+        when :cpp_comment
 
-                    r << '/'
+          state = :text
+        when :sq_string_escape, :sq_string_closing
 
-                    state = :text
-                end
-            else
+          state = :text
+        when :dq_string_escape
 
-                # special cases:
-                #
-                # - for escaped single/double quote
-                # - for slash-start
-                # - for comment-star
+          state = :dq_string
+        when :slash_start
 
-                case state
-                when :sq_string_open
+          r << '/'
 
-                    state = (?\\ == c) ? :sq_string_escape : :sq_string_closing
-                when :sq_string_escape
+          state = :text
+        end
+      else
 
-                    state = :sq_string_closing
-                when :dq_string_escape
+        # special cases:
+        #
+        # - for escaped single/double quote
+        # - for slash-start
+        # - for comment-star
 
-                    state = :dq_string
-                when :c_comment_star
+        case state
+        when :sq_string_open
 
-                    case c
-                    when ?/
+          state = (?\\ == c) ? :sq_string_escape : :sq_string_closing
+        when :sq_string_escape
 
-                        r << ?\n * cc_lines
-                        cc_lines = 0
+          state = :sq_string_closing
+        when :dq_string_escape
 
-                        state = :text
-                        skip = true
-                    when '*'
+          state = :dq_string
+        when :c_comment_star
 
-                        ;
-                    else
+          case c
+          when ?/
 
-                        state = :c_comment
-                    end
-                else
+            r << ?\n * cc_lines
+            cc_lines = 0
 
-                    if false
-                    elsif state == :slash_start && ('/' != c && '*' != c)
+            state = :text
+            skip = true
+          when '*'
 
-                        state = :text
-                        r << '/'
-                    else
+            ;
+          else
 
-                        case c
-                        when '/'
+            state = :c_comment
+          end
+        else
 
-                            case state
-                            when :text
+          if false
+          elsif state == :slash_start && ('/' != c && '*' != c)
 
-                                state = :slash_start
-                            when :slash_start
+            state = :text
+            r << '/'
+          else
 
-                                state = :cpp_comment
-                            when :c_comment_star
+            case c
+            when '/'
 
-                                r << ?\n * cc_lines
-                                cc_lines = 0
+              case state
+              when :text
 
-                                state = :text
-                                skip = true
-                            end
-                        when '*'
+                state = :slash_start
+              when :slash_start
 
-                            case state
-                            when :slash_start
+                state = :cpp_comment
+              when :c_comment_star
 
-                                state = :c_comment
-                            when :c_comment
+                r << ?\n * cc_lines
+                cc_lines = 0
 
-                                state = :c_comment_star
-                            else
+                state = :text
+                skip = true
+              else
 
-                            end
+                ;
+              end
+            when '*'
 
-                        when ?\'
+              case state
+              when :slash_start
 
-                            case state
-                            when :text
+                state = :c_comment
+              when :c_comment
 
-                                state = :sq_string_open
-                            when :sq_string_closing
+                state = :c_comment_star
+              else
 
-                                state = :text
-                            else
+                ;
+              end
+            when ?\'
 
-                            end
-                        when '"'
+              case state
+              when :text
 
-                            case state
-                            when :text
+                state = :sq_string_open
+              when :sq_string_closing
 
-                                state = :dq_string
-                            when :dq_string
+                state = :text
+              else
 
-                                state = :text
-                            else
-                            end
-                        when ?\\
+                ;
+              end
+            when '"'
 
-                            case state
-                            when :sq_string_open
+              case state
+              when :text
 
-                                state = :sq_string_escape
-                            when :sq_string_escape
+                state = :dq_string
+              when :dq_string
 
-                                state = :sq_string
-                            when :dq_string
+                state = :text
+              else
 
-                                state = :dq_string_escape
-                            else
+                ;
+              end
+            when ?\\
 
-                            end
-                        else
+              case state
+              when :sq_string_open
 
-                            case state
-                            when :sq_string_escape
+                state = :sq_string_escape
+              when :sq_string_escape
 
-                                state = :sq_string_closing
-                            else
+                state = :sq_string_closing
+              when :dq_string
 
-                            end
-                        end
-                    end
-                end
-            end
+                state = :dq_string_escape
+              else
 
+                ;
+              end
+            else
 
-            case state
-            when :slash_start
-            when :cpp_comment
-            when :c_comment
-            when :c_comment_star
+              case state
+              when :sq_string_escape
 
-            else
+                state = :sq_string_closing
+              else
 
-                r << c unless skip
+                ;
+              end
             end
+          end
         end
+      end
 
-        r
+
+      case state
+      when :slash_start
+      when :cpp_comment
+      when :c_comment
+      when :c_comment_star
+
+        ;
+      else
+
+        r << c unless skip
+      end
     end
+
+    r
+  end
 end # module C
 
 end # module LanguageFamilies

data/lib/comment_strip/language_families/hash_line.rb

@@ -0,0 +1,211 @@
+# ######################################################################## #
+# File:     comment_strip/language_families/hash_line.rb
+#
+# Purpose:  Definition of strip() function for languages that support single
+#           line comments beginning at the # character.
+#
+# Created:  1st December 2023
+# Updated:  31st March 2024
+#
+# Home:     http://github.com/synesissoftware/comment_strip.r
+#
+# Copyright (c) 2023-2024, Matthew Wilson and Synesis Information Systems
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+require 'xqsr3/quality/parameter_checking'
+
+=begin
+=end
+
+module CommentStrip
+module LanguageFamilies
+
+module HashLine
+
+  def self.strip input, lf, **options
+
+    return input if input.nil?
+    return input if input.empty?
+
+    line    =   0
+    column  =   0
+
+    # States:
+    #
+    # - :dq_string          - within a double-quoted string
+    # - :dq_string_escape   - within a double-quoted string when just received a '"', e.g. from immediately after '"the next word is quoted \'
+    # - :hash_comment       - in a #-comment, i.e. from immediately after "#"
+    # - :sq_string_closing  - waiting for final '\'' in a single-quoted string
+    # - :sq_string_escape   - within a escaped single-quoted string, i.e. from immediately after "'\"
+    # - :sq_string_open     - within a single-quoted string, i.e. from immediately after "'"
+    # - :text               - regular part of the code
+
+    state   =   :text
+
+    r       =   ''
+
+    cc_lines =   0
+
+    input.each_char do |c|
+
+      case c
+      when ?\r, ?\n
+
+        line += 1
+        column = 0
+      else
+
+        column += 1
+      end
+
+      skip = false
+
+      case c
+      when ?\r, ?\n
+
+        case state
+        when :hash_comment
+
+          state = :text
+        when :sq_string_escape, :sq_string_closing
+
+          state = :text
+        when :dq_string_escape
+
+          state = :dq_string
+        when :hash_comment
+
+          state = :text
+        end
+      else
+
+        # special cases:
+        #
+        # - for escaped single/double quote
+        # - for slash-start
+
+        case state
+        when :sq_string_open
+
+          state = (?\\ == c) ? :sq_string_escape : :sq_string_closing
+        when :sq_string_escape
+
+          state = :sq_string_closing
+        when :dq_string_escape
+
+          state = :dq_string
+        else
+
+          case c
+          when '#'
+
+            case state
+            when :text
+
+              state = :hash_comment
+            else
+
+              ;
+            end
+          when ?\'
+
+            case state
+            when :text
+
+              state = :sq_string_open
+            when :sq_string_closing
+
+              state = :text
+            else
+
+              ;
+            end
+          when '"'
+
+            case state
+            when :text
+
+              state = :dq_string
+            when :dq_string
+
+              state = :text
+            else
+
+              ;
+            end
+          when ?\\
+
+            case state
+            when :sq_string_open
+
+              state = :sq_string_escape
+            when :sq_string_escape
+
+              state = :sq_string_closing
+            when :dq_string
+
+              state = :dq_string_escape
+            else
+
+              ;
+            end
+          else
+
+            case state
+            when :sq_string_escape
+
+              state = :sq_string_closing
+            else
+
+              ;
+            end
+          end
+        end
+      end
+
+
+      case state
+      when :hash_comment
+
+        ;
+      else
+
+        r << c unless skip
+      end
+    end
+
+    r
+  end
+end # module HashLine
+
+end # module LanguageFamilies
+end # module CommentStrip
+
+# ############################## end of file ############################# #
+

data/lib/comment_strip/strip.rb

@@ -1,14 +1,14 @@
 # ######################################################################## #
-# File:         comment_strip/strip.rb
+# File:     comment_strip/strip.rb
 #
-# Purpose:      Definition of strip() function
+# Purpose:  Definition of strip() function
 #
-# Created:      14th September 2020
-# Updated:      11th July 2022
+# Created:  14th September 2020
+# Updated:  30th March 2024
 #
-# Home:         http://github.com/synesissoftware/comment_strip.r
+# Home:     http://github.com/synesissoftware/comment_strip.r
 #
-# Copyright (c) 2020-2022, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2020-2024, Matthew Wilson and Synesis Information Systems
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -37,7 +37,15 @@
 # ######################################################################## #
 
 
-require File.join(__dir__, 'language_families', 'c')
+
+%w{
+
+  c
+  hash_line
+}.each do |name|
+
+  require File.join(File.dirname(__FILE__), 'language_families', name)
+end
 
 require 'xqsr3/quality/parameter_checking'
 
@@ -54,16 +62,17 @@ module CommentStrip
     # === Signature
     #
     # * *Parameters:*
-    #   - +input+ (::String, +nil+) the input source code
-    #   - +lf+ (::String) the name of the language family. Currently only
-    #      the value +'C'+ is accepted
-    #   - +options+ (::Hash) options that moderate the behaviour
+    #   - +input+ (+String+, +nil+) the input source code
+    #   - +lf+ (+String+) the name of the language family, which must be one of the following:
+    #      - +'C'+
+    #      - +'Hash_Line'+
+    #   - +options+ (+Hash+) options that moderate the behaviour
     #
     # * *Options:*
     # None currently defined.
     #
     # === Signature
-    # (String) The stripped for of the input.
+    # (+String+) The stripped for of the input.
     def strip input, lf, **options
 
         check_parameter input, 'input', responds_to: [ :each_char, :empty?, :nil?, ], nil: true
@@ -73,6 +82,9 @@ module CommentStrip
         when 'C'
 
             LanguageFamilies::C.strip input, lf, **options
+        when 'HASH_LINE'
+
+            LanguageFamilies::HashLine.strip input, lf, **options
         else
 
             raise "language family '#{lf}' unrecognised or not supported1"