mightystring 0.1.0

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Daniel P. Clark & 6ft Dan(TM)
+
+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/README

@@ -0,0 +1,20 @@
+MightyString
+by Daniel P. Clark
+
+Description: Add Array functionality to Strings and other tools for Strings: Matching, Indexing, Substitution, Deletion, and more.
+
+Pain points this solves.
+ * After working with Python, it's obvious Ruby strings are lacking... so lets spiff them up.
+ * Strings are Arrays... I mean really, think about it.  This works toward making Strings function as Arrays.
+ * Also this provides additional string tools under MightyString... like strip_html.
+
+My method.
+ * I believe code should be beautiful, simple, and well rounded.  No animals were harmed in ... err I mean no regex was used in the making of this library.
+
+Some tools to consider here.
+ * MightyString::HTML.strip_html provides a more ideal HTML to ASCII formatting output.  This is an advanced block "filtering" module.  It works very well with, currently, extremely rare cases that fall through it's fingers.  Regardless it's beautiful, and will strive to be more so.
+ 
+Advanced detail.
+ * Look at the test/test_ms.rb for case usages of each feature.
+
+Follow this project and contribute via github http://www.github.com/danielpclark/mightystring

data/bin/ms-striphtml

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby
+
+require 'getoptlong'
+begin
+	require 'mightystring'
+rescue LoadError
+	require 'rubygems'
+	require 'mightystring'
+end
+
+include MightyString
+opts = GetoptLong.new(
+["--license",	"-l",		GetoptLong::NO_ARGUMENT],
+["--test",	"-t",		GetoptLong::NO_ARGUMENT],
+["--help",	"-h",		GetoptLong::NO_ARGUMENT]
+)
+opts.each do |opt, arg|
+	case opt
+		when "--help"
+			puts "Yes.  You do indeed need help.  Go seek it."
+			#RDoc::usage
+		when "--test"
+			#Strip_HTML.test = true
+			HTML.testCase
+		when "--license"
+			#Strip_HTML.license = true
+			HTML.license
+	end
+end
+if ARGV.any? { |s| s.downcase.include?('.htm') } then
+	ARGV.each do |s|
+		if s.downcase.include?('.htm') and File.exists?(s)
+			puts HTML.strip_html( File.open(s, "rb").read )
+		end
+	end
+end

data/lib/mightystring.rb

@@ -0,0 +1,30 @@
+$: << File.join(File.dirname(__FILE__), "/mightystring")
+require 'mightystring/string_matchpci'
+require 'mightystring/string_index_all'
+require 'mightystring/string_at'
+require 'mightystring/string_del'
+require 'mightystring/string_stripbyac'
+require 'mightystring/strip_html'
+require 'mightystring/version'
+
+# Author: Daniel P. Clark / 6ft Dan(TM) Website: http://www.6ftdan.com
+
+=begin LICENSE
+MightyString is licensed under 'The MIT License (MIT)'
+
+Copyright (c) 2012 Daniel P. Clark & 6ft Dan(TM)
+
+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."
+=end
+
+class String
+    include At::String
+    include Del::String
+    include Index_All::String
+    include Match_PCI::String
+    include StripbyAC::String
+end

data/lib/mightystring/string_at.rb

@@ -0,0 +1,16 @@
+# Part of MightyString
+# by Daniel P. Clark
+# webmaster@6ftdan.com
+
+# At
+module At
+    module String
+    	# At : Returns string instead of char number.
+        def at(in_srch = nil)
+        	if in_srch.is_a?(Integer)
+			return self[in_srch..in_srch]
+		end
+		return nil
+	end
+    end
+end

data/lib/mightystring/string_del.rb

@@ -0,0 +1,49 @@
+# Part of MightyString
+# by Daniel P. Clark
+# webmaster@6ftdan.com
+
+# Del : Delete by index/slice
+module Del
+    module String
+    	# Del : Delete by index/slice
+        def del(in_srch = nil)
+        	if not in_srch.nil?
+        		if in_srch.is_a?(Range) and in_srch.first.is_a?(Integer) and in_srch.last.is_a?(Integer)
+        			if not self[in_srch.first].nil? and not self[in_srch.last-1].nil?
+        				if in_srch.first < 0
+        					in_srch = self[0..in_srch.first-1].length..in_srch.last
+        				end
+        				if in_srch.last < 0
+        					in_srch = in_srch.first..self[0..in_srch.last].length
+        				end
+        				if in_srch.first < in_srch.last
+        					if in_srch.first == 0
+        						return self[in_srch.last+1..-1]
+        					elsif in_srch.last == self.length
+        						return self[0..in_srch.first-1]
+        					else
+        						return self[0..in_srch.first-1] + self[in_srch.last+1..-1]
+        					end
+        				else
+        					raise Exception.new("Invalid Range Provided!")
+        				end
+        			else
+        				raise Exception.new("Index Out of Range!")
+        			end
+        		elsif in_srch.is_a?(Integer) and -self.length-1 < in_srch and in_srch < self.length
+        			if in_srch == -1
+        				in_srch = self.length-1
+				elsif in_srch < -1 and not self[in_srch].nil?
+					in_srch = self.length + in_srch
+				end
+        			if in_srch == 0
+        				return self[(in_srch+1)..self.length]
+        			else
+        				return self[0..in_srch-1] + self[(in_srch+1)..self.length]
+        			end
+        		end			
+		end
+		return nil
+	end
+    end
+end

data/lib/mightystring/string_index_all.rb

@@ -0,0 +1,27 @@
+# Part of MightyString
+# by Daniel P. Clark
+# webmaster@6ftdan.com
+
+# Index_All
+module Index_All
+	module String
+	# find_all(search string): Returns indexes of search string as an index array.
+		def index_all(in_srch = "")
+			in_srch = in_srch.to_s
+			if not in_srch.empty?
+				arr_indexes = []
+				srch_index = self.rindex(in_srch)
+				while not srch_index.nil? do
+					tmpStr = self[0..srch_index-1]
+					arr_indexes += [srch_index] # Put it in the list
+					if srch_index == 0
+						srch_index = nil
+					else
+						srch_index = tmpStr.rindex(in_srch)
+					end
+				end
+				return arr_indexes.reverse
+			end
+		end
+	end
+end

data/lib/mightystring/string_matchpci.rb

@@ -0,0 +1,16 @@
+# Part of MightyString
+# by Daniel P. Clark
+# webmaster@6ftdan.com
+
+# Match Partial Case-Insensitive
+module Match_PCI
+    module String
+    	# Match Partial Case-Insensitive: Usage: "My string has this?".matchpci('RinG') => true
+        def match_pci(in_srch = "")
+        	if not in_srch.empty?
+			return !self.find_all{|item| item.downcase.include?(in_srch.downcase)}.empty?
+		end
+		return false
+	end
+    end
+end

data/lib/mightystring/string_stripbyac.rb

@@ -0,0 +1,28 @@
+# Part of MightyString
+# by Daniel P. Clark
+# webmaster@6ftdan.com
+
+# Example acceptable charachters = (Range.new('a','z').to_a + Range.new('A','Z').to_a + Range.new('0','9').to_a + ['.','-','_',"'",'"',',']).flatten
+
+# Strip by Acceptable Characters
+module StripbyAC
+    module String
+    	# Strip by Acceptable Characters : String.stripbyac(charlist) => Copy of New String (removes any character not in list)
+        def strip_byac(acceptchars)
+        	if not acceptchars.nil?
+        		if acceptchars.is_a?(String)
+        			return self.split('').map!{|x| if acceptchars.split('').include?(x); x end }.join
+        		elsif acceptchars.is_a?(Array)
+        			return self.split('').map!{|x| if acceptchars.include?(x); x end }.join
+        		elsif acceptchars.respond_to?(:[])
+        			acceptchars = acceptchars.to_a
+        			return self.split('').map!{|x| if acceptchars.include?(x); x end }.join        		
+        		else
+        			raise "#{puts acceptchars.class}"
+        		end
+        	else
+        		raise StandardError.new('You must include a list of acceptable characters for this string in stripbyac(acceptchars)!')
+		end
+	end
+    end
+end

data/lib/mightystring/strip_html.rb

@@ -0,0 +1,149 @@
+
+# APP_VERSION = '0.1 11-27-2012'
+
+# Mighty String - Strip HTML
+# Ruby should be easy to read, regex is not.  I believe string block handling can be done better than rough regex'ing.
+#
+# TODO *FIXME* A rare href exception gets by, as well as some comment cases. 0.1 11-27-2012 "Release Version" 
+#
+# Ver 0.1 11-27-2012 "Release Version"
+# - Modularized and Gemified
+# - Fixed mathmatical exceptions. Code is completely functional with test case.
+#
+# Ver Pre_0.3.0 8-7-2012
+# - Added String modules for a healthy and useful String library
+# - Finished mathmatical and generic & exceptions
+#
+# Ver Pre_0.2.1
+# - Fixed indexing problem when only 1 of two cases where 'paired'.  Such as '<' and not '>'.  It died previously on nil.
+# - Added test case
+# 
+# Ver Pre_0.2
+# - Added command line html file processing
+# - Added case insensitivity for HTML snippets
+#
+# Ver Pre_0.1
+# - HTML tag stripper with ASCII output
+
+Strip_HTML_License = "
+
+MightyString is licensed under 'The MIT License (MIT)'
+
+Copyright (c) 2012 Daniel P. Clark & 6ft Dan(TM)
+
+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."
+#   REQUIRE   #
+begin
+	require 'string_match_pci'
+	require 'string_index_all'
+rescue LoadError # For test-unit
+	$: << File.join(File.dirname(__FILE__), "/../lib")
+	$: << File.join(File.dirname(__FILE__), "/../lib/mightystring")
+	require 'string_matchpci'
+	require 'string_index_all'
+end
+# END REQUIRE #
+class String
+    include Index_All::String
+    include Match_PCI::String
+end
+
+module MightyString
+	module HTML
+		# Define some generic rules here ***
+		# ---- COOL note: you can insert ASCII color escape code rules here... like for href then blue and for /a then plain
+		def self.html_to_text_codes 
+			{"&quot;"=>"'","br"=>"\n","&#39;" => "'", "td" => " | ", "&nbsp;" => " ", "&trade;" => "(TM)", "&copy;" => "(c)"} # replace html segment and insert plan text equivalent
+		end
+
+		def self.math_by_space
+			true # if this is set then < followed by a space is considered not a html tag, like wise > with a space beforehand
+		end
+
+		# End define generic rules ***
+	
+		def self.html_math_exceptions(in_str = "")
+			if in_str["< "] or in_str["& "]
+				return 1 # Execption found at beginning
+			elsif in_str["&"] and in_str[";"] and (in_str[" "] or in_str.length > 7) # Shouldn't have spaces in html &code;s or be greater than 7 in length
+				return 2 # Exception found for both
+			else
+				return 0
+			end
+
+		end
+
+		# strip sequence out ( master string, sequence to remove, any characters to swap inplace this for that )
+		def self.strip_first_seq( mstr = "", mseq = "", cmpchar = self.html_to_text_codes )
+			if not cmpchar.empty? and cmpchar.keys.any? {|mkey| mseq.match_pci(mkey) } # keys exist and one of the keys match
+				cmpchar.each_key { |mkey|
+					if mseq.match_pci(mkey)
+						mstr = mstr[0,mstr.index(mseq)] + cmpchar[mkey] + mstr[(mstr.index(mseq)+mseq.length)..-1]
+					end
+				}
+			elsif mstr.index(mseq)
+				mstr = mstr[0,mstr.index(mseq)] + mstr[(mstr.index(mseq)+mseq.length)..-1]
+			end
+			return mstr
+		end
+
+		# Pick tags/blocks of string to remove (ex: "&", ";" like in "&quot;" can become "" or "'" if rules set))
+		def self.strip_html( htmlstr = "", xarg = [["<",">"],["&",";"]] ) # xarg start, end
+			xarg.each { |g|
+				sh_endpoints = htmlstr.index_all(g[1])
+				if sh_endpoints.nil?
+					break
+				end
+				sh_end = htmlstr.rindex(g[1])
+				sh_start = htmlstr.rindex(g[0])
+				while !!sh_end and !!sh_start do
+					if sh_end > sh_start
+						sh_seq = htmlstr[sh_start,sh_end - sh_start + 1]
+						until sh_seq.count(g[1]) == 1 do # until we've selected only the inner block
+							sh_end = htmlstr[0,sh_end-1].rindex(g[1])
+							sh_seq = htmlstr[sh_start,sh_end - sh_start + 1]
+						end
+						if not (math_by_space and not html_math_exceptions(htmlstr[sh_start,sh_end - sh_start + 1]) == 0)
+							htmlstr = strip_first_seq( htmlstr, htmlstr[sh_start,sh_end - sh_start + 1])
+						else
+							sh_end = sh_end - 1
+						end
+					else
+						sh_start = sh_start - 1
+					end
+					sh_end = htmlstr[0..sh_end].rindex(g[1])
+					sh_start = htmlstr[0..sh_start].rindex(g[0])
+				end
+			}
+			return htmlstr
+		end
+
+		def self.testCase
+			pagesample = "<html><body>This code primarily removes (less than)tags(greater than) and (amperstand)code(semicolon).<br>This default behavior can be modified to fit your needs.<br>4>3 doesn't pair up, so it's visible.<br>As well as this with a space 4 > 3.<br>The opposite is 3 < 4.  Can you see me?<br>These following punctions don't get removed because they are out of matching order. ';and&'.<br>< This is visible because of the first space before the less than symbol. ><br>&This shows because it's longer then characters in length and has a space in it.;<br><br><table><tr><td>My Box Table</td></tr></table> <!-- <div>Old HTML commented out.  This is a unique case.<br>The code finds the innermost blocks and removes them outwards.  So something like '< !-- < tag >' or '< /tag > -- >' won't raise an error.<br>(I added the spaces so you can still see the ouput print.)</div> --><br><br><h1>Ruby is quite nice!</h1><br><a href='_blank'>http://www.6ftdan.com</a></body></html>"
+			puts pagesample
+			puts
+			puts " * - * - * - Before test is above. - * - * - after striphtml follows - * - * - *"
+			puts
+			puts strip_html(pagesample)
+		end
+	
+		def self.license
+			license = "Mighty_String::Strip_HTML is licensed under 'The MIT License (MIT)'
+
+	Copyright (c) 2012 Daniel P. Clark & 6ft Dan(TM)
+
+	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."
+			puts
+			puts license
+			puts
+		end
+	end # module Strip_HTML
+end # MightyString

data/lib/mightystring/version.rb

@@ -0,0 +1,3 @@
+module MightyString
+	VERSION = "0.1.0"
+end

data/test/test_ms.rb

@@ -0,0 +1,49 @@
+$: << File.join(File.dirname(__FILE__), "/../lib")
+$: << File.join(File.dirname(__FILE__), "/../lib/mightystring")
+require 'test/unit'
+require 'mightystring'
+
+class TestMightyString < Test::Unit::TestCase
+	def test_at
+		assert "abc".at(0) == "a"
+		assert "0123456789".at(-1) == "9"
+	end
+	
+	def test_del
+		assert "abc".del(1) == "ac"
+		assert "0123456789".del(0..2) == "3456789"
+	end
+	
+	def test_index_all
+		assert "012324507654301243".index_all 0 == [0,7,13]
+		assert "the apple is the best fruit in the world".index_all "the" == [0, 13, 31]
+	end
+	
+	def test_matchpci
+		assert "<TD>".match_pci("td")
+		assert "<TD>".match_pci("><") == false
+		assert "Principle".match_pci("rINCi")
+	end
+	
+	def test_stripbyac
+		assert "qa2ws3ed4rf5tg6yh7uj8ik9ol".strip_byac( Range.new( "0", "9" ).to_a ) == "23456789"
+		
+		custRange = (Range.new('a','z').to_a + Range.new('A','Z').to_a + [" "]).flatten
+		assert "<html><body> Content </body></html>".strip_byac(custRange) == "htmlbody Content bodyhtml"
+	end
+	
+	def test_strip_first_seq
+		assert MightyString::HTML.strip_first_seq("APPLES n APPLES ARE Yummy!","APPLES",{"APPLES" => "COWS"}) == "COWS n APPLES ARE Yummy!"
+		assert MightyString::HTML.strip_first_seq("Cows Cows and more Cows!","Cows", {"Cows" => "Winner"}) == "Winner Cows and more Cows!"
+		assert MightyString::HTML.strip_first_seq("&nbsp; ---- &nbsp; APPLES &nbps;", "&nbsp;" ) == "  ---- &nbsp; APPLES &nbps;"
+		assert MightyString::HTML.strip_first_seq("&trade; ---- &trade; TradeMark &trade;", "&trade;" ) == "(TM) ---- &trade; TradeMark &trade;"
+	end
+	
+	def test_strip_html
+		assert MightyString::HTML.strip_html("<html>") == ""
+		assert MightyString::HTML.strip_html("<table><tr><td>Piped sides.</td></tr></table>") == " | Piped sides. | "
+		assert MightyString::HTML.strip_html("Hello<br>World!") == "Hello\nWorld!"
+		assert MightyString::HTML.strip_html("<p>&quot;Quoted&quot; Copyright &copy; TradeMark &trade;</p>") == "'Quoted' Copyright (c) TradeMark (TM)"
+	end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: mightystring
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel P. Clark / 6ftDan(TM)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-26 00:00:00 Z
+dependencies: []
+
+description: Array functionality in Strings as well as Matching, Indexing, Substitution, Deletion, and more.
+email: webmaster@6ftdan.com
+executables: 
+- ms-striphtml
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- bin/ms-striphtml
+- lib/mightystring/string_at.rb
+- lib/mightystring/strip_html.rb
+- lib/mightystring/string_index_all.rb
+- lib/mightystring/string_stripbyac.rb
+- lib/mightystring/string_matchpci.rb
+- lib/mightystring/string_del.rb
+- lib/mightystring/version.rb
+- lib/mightystring.rb
+- test/test_ms.rb
+- README
+- LICENSE
+homepage: http://www.github.com/danielpclark/mightystring
+licenses: 
+- The MIT License (MIT)
+post_install_message: |-
+  Enjoy MightyString!  Your strings are now more powerful.
+  Peak around inside String and MightyString.
+  http://www.github.com/danielpclark/mightystring
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Strings (are) Arrays & Matching, Indexing, Substitution, Deletion, and more.
+test_files: 
+- test/test_ms.rb