comment_strip-ruby 0.0.13 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 365f9e298b8b89aa08070e00af4b79218bff7a4f
-  data.tar.gz: ab83b0154b585c48128815611fb7d095d2bcb111
+SHA256:
+  metadata.gz: 69539de8b13faa339084af8667f5e062f1b7d3244861a3008d74622d74af5eb6
+  data.tar.gz: acc60fe0c8e9d094b204ad35e2d6b6370d4e11d5f5e677103ffd2ba943f0fc7f
 SHA512:
-  metadata.gz: b2330a16d54e0b3675d76883fb85a03e970ba59aedc37e232763a2b999efae4b10a53ce6fcabb317f3606dfe0e45fa38be3670792e88462fddadcd10a5a4819b
-  data.tar.gz: a5f0d316237a029cba4cd959ba8276147192cb7d62226654806ad08f60fb9c8d482c8f192ab8f010152250d8dafdf7ab3313846e4c673ae5e845a24677d83e2e
+  metadata.gz: 76a23018cbd60b02fc811132a103676158603b6dfd8c038b15f5671a0704d983ba3bfe54c0e70dedd72e98cf3e9de1cf972c48c3268cdc4385c6f685c9e04332
+  data.tar.gz: d4c21de13d0bf22a7b482b71899bd9a7163dc712c685d4b336234b30d4318d04f9621769723a9e56a914fbe8e58f1ddf0f7dec7d2ee1a2b3bff98ba70f2fb6fb

data/README.md

@@ -16,7 +16,17 @@ T.B.C.
 
 ## Installation
 
-Install using `gem install comment_strip-ruby` or add it to your `Gemfile`.
+Install directly:
+
+```bash
+$ gem install comment_strip-ruby
+```
+
+or add it to your `Gemfile`:
+
+```plaintext
+gem 'comment_strip-ruby'
+```
 
 ## Components
 
@@ -24,7 +34,16 @@ T.B.C.
 
 ## Examples
 
-T.B.C.
+It is as simple as the following:
+
+```Ruby
+require 'comment_strip'
+
+stripped = CommentStrip.strip($stdin.read, :C)
+
+puts "Stripped form of input:\n#{stripped}"
+```
+
 
 ## Project Information
 

data/lib/comment_strip/language_families/c.rb

@@ -0,0 +1,250 @@
+# ######################################################################## #
+# File:         comment_strip/language_families/c.rb
+#
+# Purpose:      Definition of strip() function for C-family languages.
+#
+# Created:      14th September 2020
+# Updated:      11th July 2022
+#
+# Home:         http://github.com/synesissoftware/comment_strip.r
+#
+# Copyright (c) 2020-2022, 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 C
+
+    def self.strip input, lf, **options
+
+        return nil if input.nil?
+        return input if input.empty?
+
+        line    =   0
+        column  =   0
+
+        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 :c_comment, :c_comment_star
+
+                    cc_lines += 1
+
+                    state = :c_comment
+                when :cpp_comment
+
+                    state = :text
+                when :sq_string, :sq_string_escape, :sq_string_closing
+
+                    state = :text
+                when :dq_string_escape
+
+                    state = :dq_string
+                when :slash_start
+
+                    r << '/'
+
+                    state = :text
+                end
+            else
+
+                # special cases:
+                #
+                # - for escaped single/double quote
+                # - for slash-start
+                # - for comment-star
+
+                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
+                when :c_comment_star
+
+                    case c
+                    when ?/
+
+                        r << ?\n * cc_lines
+                        cc_lines = 0
+
+                        state = :text
+                        skip = true
+                    when '*'
+
+                        ;
+                    else
+
+                        state = :c_comment
+                    end
+                else
+
+                    if false
+                    elsif state == :slash_start && ('/' != c && '*' != c)
+
+                        state = :text
+                        r << '/'
+                    else
+
+                        case c
+                        when '/'
+
+                            case state
+                            when :text
+
+                                state = :slash_start
+                            when :slash_start
+
+                                state = :cpp_comment
+                            when :c_comment_star
+
+                                r << ?\n * cc_lines
+                                cc_lines = 0
+
+                                state = :text
+                                skip = true
+                            end
+                        when '*'
+
+                            case state
+                            when :slash_start
+
+                                state = :c_comment
+                            when :c_comment
+
+                                state = :c_comment_star
+                            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
+                            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
+            end
+
+
+            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
+end # module CommentStrip
+
+# ############################## end of file ############################# #
+

data/lib/comment_strip/strip.rb

@@ -4,11 +4,11 @@
 # Purpose:      Definition of strip() function
 #
 # Created:      14th September 2020
-# Updated:      14th September 2020
+# Updated:      11th July 2022
 #
 # Home:         http://github.com/synesissoftware/comment_strip.r
 #
-# Copyright (c) 2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2020-2022, Matthew Wilson and Synesis Information Systems
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -37,216 +37,49 @@
 # ######################################################################## #
 
 
+require File.join(__dir__, 'language_families', 'c')
+
+require 'xqsr3/quality/parameter_checking'
 
 =begin
 =end
 
 module CommentStrip
 
-# Strips comments
-def strip s, lf, *options
-
-    case lf.upcase
-    when 'C'
-
-        ;
-    else
-
-        raise "language family '#{lf}' unrecognised"
-    end
-
-    return nil if s.nil?
-    return s if s.empty?
-
-    line    =   0
-    column  =   0
-
-    state   =   :text
-
-    r       =   ''
-
-    cc_lines =   0
-
-    s.each_char do |c|
-
-        case c
-        when ?\r, ?\n
-
-            line += 1
-            column = 0
+    include ::Xqsr3::Quality::ParameterChecking
+
+    # Strips comments from an input string, according to the rules and
+    # conventions of a given language-family
+    #
+    # === 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
+    #
+    # * *Options:*
+    # None currently defined.
+    #
+    # === Signature
+    # (String) The stripped for of the input.
+    def strip input, lf, **options
+
+        check_parameter input, 'input', responds_to: [ :each_char, :empty?, :nil?, ], nil: true
+        check_parameter lf, 'lf', types: [ ::String, ::Symbol ]
+
+        case lf.to_s.upcase
+        when 'C'
+
+            LanguageFamilies::C.strip input, lf, **options
         else
 
-            column += 1
-        end
-
-        skip = false
-
-        case c
-        when ?\r, ?\n
-
-            case state
-            when :c_comment, :c_comment_star
-
-                cc_lines += 1
-
-                state = :c_comment
-            when :cpp_comment
-
-                state = :text
-            when :sq_string, :sq_string_escape, :sq_string_closing
-
-                state = :text
-            when :dq_string_escape
-
-                state = :dq_string
-            when :slash_start
-
-                r << '/'
-
-                state = :text
-            end
-        else
-
-            # special cases:
-            #
-            # - for escaped single/double quote
-            # - for slash-start
-            # - for comment-star
-
-            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
-            when :c_comment_star
-
-                case c
-                when ?/
-
-                    r << ?\n * cc_lines
-                    cc_lines = 0
-
-                    state = :text
-                    skip = true
-                when '*'
-
-                    ;
-                else
-
-                    state = :c_comment
-                end
-            else
-
-                if false
-                elsif state == :slash_start && ('/' != c && '*' != c)
-
-                    state = :text
-                    r << '/'
-                else
-
-                    case c
-                    when '/'
-
-                        case state
-                        when :text
-
-                            state = :slash_start
-                        when :slash_start
-
-                            state = :cpp_comment
-                        when :c_comment_star
-
-                            r << ?\n * cc_lines
-                            cc_lines = 0
-
-                            state = :text
-                            skip = true
-                        end
-                    when '*'
-
-                        case state
-                        when :slash_start
-
-                            state = :c_comment
-                        when :c_comment
-
-                            state = :c_comment_star
-                        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
-                        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
-        end
-
-        case state
-        when :slash_start
-        when :cpp_comment
-        when :c_comment
-        when :c_comment_star
-
-        else
-
-            r << c unless skip
+            raise "language family '#{lf}' unrecognised or not supported1"
         end
     end
 
-    r
-end
-
+    extend self
 end # module CommentStrip
 
 # ############################## end of file ############################# #

data/lib/comment_strip/version.rb

@@ -4,11 +4,11 @@
 # Purpose:      Version for comment_strip.r library
 #
 # Created:      14th September 2020
-# Updated:      14th September 2020
+# Updated:      11th July 2022
 #
 # Home:         http://github.com/synesissoftware/comment_strip.r
 #
-# Copyright (c) 2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2020-2022, Matthew Wilson and Synesis Information Systems
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -43,7 +43,7 @@
 module CommentStrip
 
     # Current version of the comment_strip.r library
-    VERSION                 =   '0.0.13'
+    VERSION                 =   '0.1.2'
 
     private
     VERSION_PARTS_          =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/lib/comment_strip.rb

@@ -4,11 +4,11 @@
 # Purpose:      Top-level include for comment_strip.r library
 #
 # Created:      14th September 2020
-# Updated:      14th September 2020
+# Updated:      11th July 2022
 #
 # Home:         http://github.com/synesissoftware/comment_strip.r
 #
-# Copyright (c) 2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2020-2022, Matthew Wilson and Synesis Information Systems
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -37,10 +37,17 @@
 # ######################################################################## #
 
 
+%w{
+    strip
+    version
+}.each { |mod_name| require File.join(__dir__, 'comment_strip', mod_name) }
+
 =begin
 =end
 
-require File.join(File.dirname(__FILE__), 'comment_strip', 'comment_strip')
+# Main module for comment_strip.r library
+module CommentStrip
+end # module CommentStrip
 
 # ############################## end of file ############################# #
 

data/test/scratch/ex1.rb

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+
+require 'comment_strip'
+
+stripped = CommentStrip.strip($stdin.read, :C)
+
+puts "Stripped form of input:\n#{stripped}"

data/test/unit/tc_strip.rb

@@ -1,6 +1,6 @@
 #! /usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+$:.unshift File.join(__dir__, '../..', 'lib')
 
 
 require 'comment_strip'
@@ -16,6 +16,8 @@ class Test_strip_1 < Test::Unit::TestCase
     def test_nil
 
         assert_nil strip(nil, 'C')
+
+        assert_nil ::CommentStrip.strip(nil, 'C')
     end
 
     def test_unrecognised_families
@@ -36,12 +38,14 @@ class Test_strip_1 < Test::Unit::TestCase
         unrecognised_families.each do |family|
 
             assert_raise_with_message(::RuntimeError, /family.*unrecognised/) { strip('', family) }
+            assert_raise_with_message(::RuntimeError, /family.*unrecognised/) { ::CommentStrip.strip('', family) }
         end
     end
 
     def test_empty
 
         assert_equal "", strip('', 'C')
+        assert_equal "", ::CommentStrip.strip('', :C)
     end
 
     def test_simple_main
@@ -56,6 +60,7 @@ EOF_main
         expected = input
 
         assert_equal expected, strip(input, 'C')
+        assert_equal expected, ::CommentStrip.strip(input, 'C')
     end
 
     def test_x_1
@@ -88,6 +93,7 @@ EOF_main
 EOF_main
 
         actual = strip(input, 'C')
+        actual = ::CommentStrip.strip(input, 'C')
 
         assert_equal expected, actual
     end
@@ -104,6 +110,7 @@ EOF_main
 EOF_main
 
         actual = strip(input, 'C')
+        actual = ::CommentStrip.strip(input, 'C')
 
         assert_equal expected, actual
     end
@@ -120,6 +127,7 @@ EOF_main
 EOF_main
 
         actual = strip(input, 'C')
+        actual = ::CommentStrip.strip(input, 'C')
 
         assert_equal expected, actual
     end

data/test/unit/tc_version.rb

@@ -1,6 +1,6 @@
 #! /usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+$:.unshift File.join(__dir__, '../..', 'lib')
 
 
 require 'comment_strip'

data/test/unit/ts_all.rb

@@ -2,7 +2,7 @@
 #
 # executes all other tests
 
-this_dir    =   File.expand_path(File.dirname(__FILE__))
+this_dir = File.expand_path(__dir__)
 
 # all tc_*rb in current directory
 Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }

metadata

@@ -1,71 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: comment_strip-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.1.2
 platform: ruby
 authors:
 - Matt Wilson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: clasp-ruby
+  name: xqsr3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '0.37'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: libclimate-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.37.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: recls-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: xqsr3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.36'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '0.37'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.36'
+        version: 0.37.2
 description: "Source code comment stripping library\n\n"
 email: matthew@synesis.com.au
 executables: []
@@ -75,9 +39,10 @@ files:
 - LICENSE
 - README.md
 - lib/comment_strip.rb
-- lib/comment_strip/comment_strip.rb
+- lib/comment_strip/language_families/c.rb
 - lib/comment_strip/strip.rb
 - lib/comment_strip/version.rb
+- test/scratch/ex1.rb
 - test/unit/tc_strip.rb
 - test/unit/tc_version.rb
 - test/unit/ts_all.rb
@@ -85,7 +50,7 @@ homepage: https://github.com/synesissoftware/comment_strip.r
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,16 +58,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: comment_strip.r
 test_files: []

data/lib/comment_strip/comment_strip.rb

@@ -1,52 +0,0 @@
-# ######################################################################## #
-# File:         comment_strip/comment_strip.rb
-#
-# Purpose:      Main file for comment_strip.r library
-#
-# Created:      14th September 2020
-# Updated:      14th September 2020
-#
-# Home:         http://github.com/synesissoftware/comment_strip.r
-#
-# Copyright (c) 2020, 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 File.join(File.dirname(__FILE__), 'strip')
-require File.join(File.dirname(__FILE__), 'version')
-
-=begin
-=end
-
-# Main module for comment_strip.r library
-module CommentStrip
-end # module CommentStrip
-
-# ############################## end of file ############################# #
-
-