slim_string 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7809507e7ec9cd436f92b3a3f90150994eec48c70925fe1a971e97a53867d32b
+  data.tar.gz: d74f135e5475123d3d4c60b0e35dbd641fe109cdcb7f5ee2cbaaabcb6b76b178
+SHA512:
+  metadata.gz: 38b24b2d3841629ec0f1c3d24bd7a18a05f7b00b44d69501ea1fbb1b6c410b2d6f615c966132e31224ba39c953696ed71ca7781dc889f3cc4429be6923ad6501
+  data.tar.gz: 44b0d9508421a804730a59a32e31bf6b2631b51d3f34ccda833a6966f1299f395d3e267ba7a1e780e3a5f60127a9630b0b38268959f9b8f3442c113eda91f0ef

data/.gitignore

@@ -0,0 +1,51 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+/vendor/bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+.rbenv-version
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/node_modules
+/yarn-error.log
+
+.byebug_history
+
+*.[oa]
+*.so
+*~
+*.nogem
+*nogem.*
+*.bak
+*.BAK
+*.backup
+*.org
+*.orig
+*.elc
+*.pyc
+\#*\#
+
+# Elastic Beanstalk Files
+.elasticbeanstalk/*
+!.elasticbeanstalk/*.cfg.yml
+!.elasticbeanstalk/*.global.yml
+
+# yard
+*.yardoc
+
+# Ruby Gem doc
+*.gem
+doc/*
+

data/ChangeLog

@@ -0,0 +1,10 @@
+-----
+(Version: v.1.0.1)
+2021-07-04  Masa Sakano
+  * Minor update in document.
+
+-----
+(Version: 1.0)
+2021-07-04  Masa Sakano
+
+ * Initial commit.

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2018 Scott Chacon and others
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,24 @@
+ALL	= 
+
+objs	= 
+
+.SUFFIXES:	.so .o .c .f
+
+#.o.so:
+#	${LD} ${LFLAGS} -o $@ $< ${LINK_LIB}
+
+all: ${ALL}
+
+
+.PHONY: clean test doc
+clean:
+	$(RM) bin/*~
+
+## You may need RUBYLIB=`pwd`/lib:$RUBYLIB
+test:
+	rake test
+
+## yard2md_afterclean in Gem plain_text https://rubygems.org/gems/plain_text
+doc:
+	yard doc; [[ -x ".github" && ( "README.en.rdoc" -nt ".github/README.md" ) ]] && ( ruby -r rdoc -e 'puts RDoc::Markup::ToMarkdown.new.convert ARGF.read' < README.en.rdoc | yard2md_afterclean > .github/README.md.$$ && ( mv -f .github/README.md.$$ .github/README.md && echo ".github/README.md is updated." ) || ( echo "ERROR: failed to create .github/README.md" >&2 ) ) || exit 0
+

data/README.en.rdoc

@@ -0,0 +1,81 @@
+
+= SlimString - Ruby method to slim down UTF-8 character strings
+
+== Summary
+
+Module {SlimString} contains a single method of the same (but
+snake-case) name +SlimString#slim_string+, which offers functionality
+to "slim down" character String, such as truncating extra spaces with many
+options you can select.
+It fully takes into account *UTF-8 characters* like CJK Zenkaku spaces.
+
+The full package of this class is found in
+{SlimString Ruby Gems page}[http://rubygems.org/gems/slim_string]
+(with document created from source annotation with yard) and
+in {Github}[https://github.com/masasakano/slim_string]
+
+== Description
+
+=== How to use it?
+
+1. Simply call it in a full path (it is extended and so you can call it in this way.
+
+  SlimString.slim_string("\nabc\n\n", strip: false) # => "\nabc"
+2. Include in your class/module (or top level), and you can use it without the module name.
+
+  include SlimString
+  slim_string("\nabc\n\n", strip: false) # => "\nabc"
+3. Include it in +String+ class like and you can use it as an instance method.
+
+  class String
+    include SlimString
+  end
+
+  "\nabc\n\n".slim_string(trim: false) # => "\nabc"
+
+=== Options
+
+All options (aka, arguments) are Boolean.
+The given string is processed in this order regardless how you do or
+do not specify them.
+
++delete_newlines+:: (Def: false) Delete all new lines (\f\n\r\v) (maybe useful for Japanese text, unless more than 1 alphabet word are split across 2 lines).
++convert_spaces+:: (Def: false) Convert any sort of spaces (including new lines) into an ASCII space.
++convert_blanks+:: (Def: true) Convert all blanks (=spaces except kind of new lines) into an ASCII space.
++truncate_spaces+:: (Def: false) Truncate any consecutive spaces into one.
++truncate_blanks+:: (Def: true) Truncate any consecutive blanks into (the last) one.
++truncate_triple_newlines+:: (Def: false) Truncate 3 or more consecutive newlines into 2.
++delete_blanks+:: (Def: false) Simply delete all blanks excluding new lines (n.b., "a top" and "atop" are regarded identical.
++strip+:: (Def: true) Ruby strip; strip spaces including new lines at the head and tail.
++trim_blanks+:: (Def: false) strip blanks (but new lines) at the tail.
++trim+:: (Def: true) Trim the tail to strip any spaces including new lines at the tail.
+
+== Install
+
+This script requires {Ruby}[http://www.ruby-lang.org] Version 2.0
+or above.  Also, all this library depends on {SubObject (sub_object)}[https://rubygems.org/gems/sub_object], which you can
+find in RubyGems.
+
+== Developer's note
+
+The source code is maintained also in
+{Github}[https://github.com/masasakano/slim_string] with no intuitive
+interface for annotation but with easily-browsable {ChangeLog}[https://github.com/masasakano/slim_string/blob/master/ChangeLog]
+
+=== Tests
+
+The Ruby codes under the directory <tt>test/</tt> are the test scripts.
+You can run them from the top directory as <tt>ruby test/test_****.rb</tt>
+or simply run <tt>make test</tt> or <tt>rake test</tt>.
+
+== Known bugs and Todo items
+
+* None
+
+
+== Copyright
+
+Author::  Masa Sakano < info a_t wisebabel dot com >
+Versions:: The versions of this package follow Semantic Versioning (2.0.0) http://semver.org/
+License:: MIT
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/lib/slim_string.rb

@@ -0,0 +1,108 @@
+# -*- coding: utf-8 -*-
+
+# A module containing a method to slim down a UTF-8 String
+#
+# It handles UTF8 characters, such as CJK (Zenkaku) spaces
+# and offers many choices how to slim down a character string.
+#
+# There are 3 ways to use the method {SlimString#slim_string}
+#
+# (1) Simply call it in a full path
+#       SlimString.slim_string("abc", trim: false)
+# (2) Include in your class/module (or top level), and you can
+#     use it like: slim_string("abc", trim: false)
+# (3) Include it in String class like and you can used it like
+#     an instance method.
+#       class String
+#         include SlimString
+#       end
+#       "abc".slim_string(trim: false)
+#
+module SlimString
+
+  # Default options of operations for {#slim_string}, which processes
+  # in this order if specified.
+  DEF_SLIM_OPTIONS = {
+    :delete_newlines => false,  # Delete all new lines (\f\n\r\v) (useful for Japanese text, unless more than 1 alphabet word are split across 2 lines).
+    :convert_spaces  => false,  # Convert any sort of spaces (including new lines) into an ASCII space.
+    :convert_blanks  => true,   # Convert all blanks (=spaces except kind of new lines) into an ASCII space.
+    :truncate_spaces => false,  # Truncate any consecutive spaces into one.
+    :truncate_blanks => true,   # Truncate any consecutive blanks into (the last) one.
+    :truncate_triple_newlines => false, # Truncate 3 or more consecutive newlines into 2.
+    :delete_blanks   => false,  # Simply delete all blanks excluding new lines (n.b., "a top" and "atop" are regarded identical.
+    :strip       => true,   # Ruby strip; strip spaces including new lines at the head and tail.
+    :trim_blanks => false,  # strip blanks (but new lines) at the tail.
+    :trim        => true,   # Trim the tail to strip any spaces including new lines at the tail.
+  }
+
+  # Returns a slimmed down string
+  #
+  # @option str [String] Mandatory unless you use it as an instance
+  #    method of String class.
+  # @param delete_newlines: [Boolean] (Def: false) Delete all new lines
+  #    (\f\n\r\v) (maybe useful for Japanese text, unless more than 1
+  #    alphabet word are split across 2 lines).
+  # @param convert_spaces: [Boolean] (Def: false) Convert any sort of
+  #    spaces (including new lines) into an ASCII space.
+  # @param convert_blanks: [Boolean] (Def: true) Convert all blanks
+  #    (=spaces except kind of new lines) into an ASCII space.
+  # @param truncate_spaces: [Boolean] (Def: false) Truncate any
+  #    consecutive spaces into one.
+  # @param truncate_blanks: [Boolean] (Def: true) Truncate any
+  #    consecutive blanks into (the last) one.
+  # @param truncate_triple_newlines: [Boolean] (Def: false) Truncate
+  #    3 or more consecutive newlines into 2.
+  # @param delete_blanks: [Boolean] (Def: false) Simply delete all blanks 
+  #   excluding new lines (n.b., "a top" and "atop" are regarded identical.
+  # @param strip: [Boolean] (Def: true) Ruby strip; strip spaces
+  #   including new lines at the head and tail.
+  # @param trim_blanks: [Boolean] (Def: false) strip blanks (but new lines)
+  #   at the tail.
+  # @param trim: [Boolean] (Def: true) Trim the tail to strip any spaces
+  #   including new lines at the tail.
+  # @return [String]
+  # @raise [ArgumentError] Unless you include this module from
+  #    String class and use it as an instance method, the first
+  #    argument is mandatory.
+  def slim_string(str=nil, **opts)
+    begin
+      ret = (str || self).dup
+    rescue NoMethodError
+      raise ArgumentError, 'first argument is mandatory and must be String-like.'
+    end
+
+    DEF_SLIM_OPTIONS.merge(opts).each_pair do |ek, tf|
+      next if !tf
+      case ek
+      when :delete_newlines
+           ret.tr! "\f\n\r\v", "" # ASCII Formfeed (FF), Linefeed (LF), Carriage Return (CR), Vertical Tab (VT)
+      when :convert_spaces
+           ret.gsub!(/[[:space:]]/,  ' ')
+      when :convert_blanks
+           ret.gsub!(/[[:blank:]]/,  ' ')
+      when :truncate_spaces
+           ret.gsub!(/([[:space:]])+/, '\1')
+      when :truncate_blanks
+           ret.gsub!(/([[:blank:]])+/, '\1')
+      when :truncate_triple_newlines 
+           ret.gsub!(/([\f\n\r\v]){3,}/, '\1\1')
+      when :delete_blanks
+           ret.gsub!(/[[:blank:]]+/, "")
+      when :strip
+           ret.strip!
+      when :trim_blanks
+           ret.gsub!(/[[:blank:]]+\z/, "")
+      when :trim
+           ret.gsub!(/([[:space:]])+\z/, "")
+      else
+        raise ArgumentError, 'Invalid optional argument: '+tf.inspect
+      end
+    end
+    ret
+  end
+end
+
+module SlimString
+  extend self
+end
+

data/slim_string.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = 'slim_string'.sub(/.*/){|c| (c == File.basename(Dir.pwd)) ? c : raise("ERROR: s.name=(#{c}) in gemspec seems wrong!")}
+  s.version = "1.0.1".sub(/.*/){|c| fs = Dir.glob('changelog{,.*}', File::FNM_CASEFOLD); raise('More than one ChangeLog exist!') if fs.size > 1; warn("WARNING: Version(s.version=#{c}) already exists in #{fs[0]} - ok?") if fs.size == 1 && !IO.readlines(fs[0]).grep(/^\(Version: #{Regexp.quote c}\)$/).empty? ; c }  # n.b., In macOS, changelog and ChangeLog are identical in default.
+  # s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  # s.bindir = 'bin'
+  # %w(slim_string).each do |f|
+  #   path = s.bindir+'/'+f
+  #   File.executable?(path) ? s.executables << f : raise("ERROR: Executable (#{path}) is not executable!")
+  # end
+  s.authors = ["Masa Sakano"]
+  s.date = %q{2021-07-04}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
+  s.summary = %q{Slim down a UTF-8 String object}
+  s.description = <<-EOF
+    A little (module) method to "slim down" a UTF-8 String, such as truncting consecutive CJK spaces.
+  EOF
+  # s.email = %q{abc@example.com}
+  s.extra_rdoc_files = [
+     #"LICENSE.txt",
+     "README.en.rdoc",
+  ]
+  s.license = 'MIT'
+  s.files = FileList['.gitignore','lib/**/*.rb','[A-Z]*','test/**/*.rb', '*.gemspec'].to_a.delete_if{ |f|
+    ret = false
+    arignore = IO.readlines('.gitignore')
+    arignore.map{|i| i.chomp}.each do |suffix|
+      if File.fnmatch(suffix, File.basename(f))
+        ret = true
+        break
+      end
+    end
+    ret
+  }
+  s.files.reject! { |fn| File.symlink? fn }
+
+  # s.add_runtime_dependency 'nkf', '>= 0.1.0'  # built-in so far
+
+  # s.add_development_dependency "", [">= 0.6"]
+  s.homepage = "https://www.wisebabel.com"
+  # s.rdoc_options = ["--charset=UTF-8"]  # "-e UTF-8" is now Default...
+
+  # s.require_paths = ["lib"]	# Default "lib"
+  s.required_ruby_version = '>= 2.0'  # respond_to_missing?
+  s.test_files = Dir['test/**/*.rb']
+  s.test_files.reject! { |fn| File.symlink? fn }
+  # s.requirements << 'libmagick, v6.0' # Simply, info to users.
+  # s.rubygems_version = %q{1.3.5}      # This is always set automatically!!
+
+  ## cf. https://guides.rubygems.org/specification-reference/#metadata
+  s.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
+  # s.metadata["changelog_uri"]     = "https://github.com/masasakano/slim_string/blob/master/ChangeLog"
+  # s.metadata["source_code_uri"]   = "https://github.com/masasakano/slim_string"
+  # s.metadata["documentation_uri"] = "https://www.example.info/gems/bestgemever/0.0.1"
+end
+

data/test/test_slim_string.rb

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+
+# @author Masa Sakano (Wise Babel Ltd)
+
+#require 'open3'
+require 'slim_string'
+
+$stdout.sync=true
+$stderr.sync=true
+# print '$LOAD_PATH=';p $LOAD_PATH
+
+#################################################
+# Unit Test
+#################################################
+
+gem "minitest"
+# require 'minitest/unit'
+require 'minitest/autorun'
+
+SlimString.slim_string("a\nb\f\vc\r\n d")
+
+include SlimString
+
+class String
+  include SlimString
+end
+
+class TestSlimStringClass < MiniTest::Test
+  T = true
+  F = false
+  SCFNAME = File.basename(__FILE__)
+  # EXE = "%s/../bin/%s" % [File.dirname(__FILE__), File.basename(__FILE__).sub(/^test_(.+)\.rb/, '\1')]
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_slim_string
+    z = "\u3000"
+    s  = "   a\nb\f\vc\r\n "+z*3+"d \r\n\r\n"
+    ex = "   abc "+z*3+"d "
+    assert_equal ex, slim_string(s, delete_newlines: true, convert_blanks: false, truncate_blanks: false, strip: false, trim: false)
+    ex = "   abc    d "
+    assert_equal ex, slim_string(s, delete_newlines: true,                        truncate_blanks: false, strip: false, trim: false)
+    ex =   " abc"+ z+  "d "
+    assert_equal ex, slim_string(s, delete_newlines: true, convert_blanks: false,                         strip: false, trim: false)
+    ex =    "abc "+z*3+"d"
+    assert_equal ex, slim_string(s, delete_newlines: true, convert_blanks: false, truncate_blanks: false,               trim: false)
+    ex = "   abc "+z*3+"d"
+    assert_equal ex, slim_string(s, delete_newlines: true, convert_blanks: false, truncate_blanks: false, strip: false)
+    ex = "   a\nb\f\vc\r\n "+z*3+"d"
+    assert_equal ex, slim_string(s,                        convert_blanks: false, truncate_blanks: false, strip: false)
+    ex =   " a\nb\f\vc\r\n"+ z+  "d"
+    assert_equal ex, slim_string(s,                        convert_blanks: false,                         strip: false)
+    ex =   " a\nb\f\vc\r\n d"
+    assert_equal ex, slim_string(s,                                                                       strip: false)
+    ex =    "a\nb\f\vc\r\n d"
+    assert_equal ex, slim_string(s)
+    ex =    "a b c d"
+    assert_equal ex, slim_string(s, convert_spaces: true)
+    ex =    "a\nb\vc"+       z+  "d"
+    assert_equal ex, slim_string(s,                        convert_blanks: false, truncate_spaces: true)
+    ex = "   a\nb\f\vc\r\n "+z*3+"d \n\n"
+    assert_equal ex, slim_string(s,                        convert_blanks: false, truncate_blanks: false, truncate_triple_newlines: true, strip: false, trim: false), "inspect="+slim_string(s, convert_blanks: false, truncate_blanks: false, truncate_triple_newlines: true, strip: false, trim: false).inspect
+    ex =    "a\nb\f\vc\r\n"+     "d"
+    assert_equal ex, slim_string(s,                        convert_blanks: false, truncate_blanks: false, delete_blanks: true, strip: false)
+    ex = "   a\nb\f\vc\r\n "+z*3+"d \r\n\r\n"
+    assert_equal ex, slim_string(s,                        convert_blanks: false, truncate_blanks: false, strip: false, trim_blanks: true, trim: false)
+
+    assert_raises(ArgumentError){ slim_string(s, dummy: true) }
+
+    assert_equal "a\nb\f\vc\r\n d", s.slim_string()
+    assert_equal "a\nb\f\vc\r\n d", SlimString.slim_string(s)
+  end
+end # class TestUnitSlimString < MiniTest::Test
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: slim_string
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Masa Sakano
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-04 00:00:00.000000000 Z
+dependencies: []
+description: '    A little (module) method to "slim down" a UTF-8 String, such as
+  truncting consecutive CJK spaces.
+
+  '
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.en.rdoc
+files:
+- ".gitignore"
+- ChangeLog
+- LICENSE.txt
+- Makefile
+- README.en.rdoc
+- Rakefile
+- lib/slim_string.rb
+- slim_string.gemspec
+- test/test_slim_string.rb
+homepage: https://www.wisebabel.com
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Slim down a UTF-8 String object
+test_files:
+- test/test_slim_string.rb