mightystring 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14ab77de0c0623e196cb95a7d2a49a7a4f0f085d
-  data.tar.gz: fa10b832c88aa8a17143f557c1d4901abaa96f19
+  metadata.gz: f2c6db7592a53f3b0b8da6aad7805996123c093d
+  data.tar.gz: 5fc669e5824168df43677c94810d259173b82d17
 SHA512:
-  metadata.gz: 76283e2d96e380443c9aad53d9c1a1bfb719e045c5901f1897a9a09ae00625c7fc71e49bbd5bac005ad7eebb32b932dcb068294a86705e936e69edfb1d059241
-  data.tar.gz: af4651a7787a3d247f1a082555baabe9feb7f40a3fc4fd38f6b60db35a2a86291340338c6a7369b6c19f05de0e5d76c7059d33bb9839a0bee24033877bc271e5
+  metadata.gz: e7183e152148b74707088434bb0c4a66be906b40a213d1903155679a41ff41e9d01d2a98024d2e12a4677d6d47585c93e3ed445f019d00a580f6f769dbe009bc
+  data.tar.gz: db097d0fe3c382ea1548eb88dde6262781993ae7e2ee27cf369267cd204a1c2d4f81dfb78a9d8f63f2442af8081166492ae57d24cc1908e25bfe9c0a2dda8305

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.2.4
+  - 2.3.0

data/README.md

@@ -1,25 +1,119 @@
-# MightyString
-by Daniel P. Clark
-
+##MightyString
 [![Gem Version](https://badge.fury.io/rb/mightystring.svg)](http://badge.fury.io/rb/mightystring)
 
+Powerful methods for your strings.
+
+##Install
+
+Add this to your Gemfile and then run `bundle install`.
+```ruby
+gem 'mightystring', '~> 1.0'
+```
+
+Or you can just install and use it manually.
+```ruby
+gem install mightystring
+```
+##Usage
+
+```ruby
+# String#at
+"abc".at(0)
+# => "a"
+"0123456789".at(-1)
+# => "9"
+"vwq".at(5)
+# => nil
+
+# String#del
+"asdfasdf".del(0..2)
+# => "fasdf"
+"asdfasdf".del(1)
+# => "adfasdf"
+"asdfasdf".del([1,3])
+# => "adasdf"
+"asdfasdf".del("a")
+# => "sdfsdf"
+
+# String#del!
+str = "asdfasdf"
+str.del!("sd")
+str
+# => "afaf"
+str.del!(1..2)
+str
+# => "af"
+
+# String#first
+"asdf".first
+# => "a"
+
+# String#last
+"asdf".last
+# => "f"
 
-*Description:* Add Array functionality to Strings and other tools for Strings: Matching, Indexing, Substitution, Deletion, and more.
+# String#pop
+"asdf".pop
+# => "f"
 
-Install: `gem install mightystring`
+# String#push
+"asdf".push("r")
+# => "asdfr"
 
-*Pain points this aims to solve*
- * 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 parsing HTML into text.
+# String#shift
+"asdf".shift
+# => "a"
 
-*My method*
- * I believe code should be beautiful, simple, and well rounded.  I've come to expect strings to be handled easily like arrays.  There's no reason why not.  So I've brought that reality to Ruby.
+# String#sort
+str = "asdf"
+str.sort
+# => "adfs"
+str
+# => "asdf"
 
-*Some tools to consider here*
+# String#sort!
+str = "asdf"
+str.sort!
+# => "adfs"
+str
+# => "adfs"
+
+# String#unshift
+"asdf".unshift("r")
+# => "rasdf"
+
+# String#values_at
+"asdfasdfasdf".values_at(0,5,-1)
+# => ["a", "s", "f"]
+
+# String#index_all
+"012324507654301243".index_all( "0" )
+# => [0,7,13]
+"the apple is the best fruit in the world".index_all( "the" )
+# => [0, 13, 31]
+"asdfasdfasdf".index_all( /sd/ )
+# => [1,5,9]
+
+# String#sift
+"qwertyuiop".sift( "aeiou" )
+# => "euio"
+"qa2ws3ed4rf5tg6yh7uj8ik9ol".sift( Range.new( "0", "9" ) )
+# => "23456789"
+
+# String#head
+"asdf".head
+# => "a"
+"asdf".head(3)
+# => "asd"
+
+# String#tail
+"asdf".tail
+# => "sdf"
+"asdf".tail(3)
+# => "f"
+```
+
+##Extras
  * MightyString::HTML.text 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/mightystring_test.rb for case usages of each feature.
-
-> NOTES: Implementing the flatten and join methods on String breaks functionality within Rails and Rubygems so this has been avoided.
+Look at the test/mightystring_test.rb for case usages of each feature.

data/lib/mightystring/string.rb

@@ -27,6 +27,10 @@ module MightyString
       replace del(indexes)
     end
 
+    def head offset = 1
+      self[0...offset]
+    end
+
     def index_all matcher
       arr_indexes = []
       srch_index = rindex(matcher)
@@ -75,6 +79,10 @@ module MightyString
       replace sort
     end
 
+    def tail offset = 1
+      self[offset..-1]
+    end
+
     def unshift str
       replace str.+(self)
     end

data/lib/mightystring/version.rb

@@ -1,3 +1,3 @@
 module MightyString
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/mightystring_test.rb

@@ -2,11 +2,11 @@ require 'minitest_helper'
 
 describe MightyString do
   it "String#at returns character at position" do
-		_("abc".at(0)).must_equal "a"
+    _("abc".at(0)).must_equal "a"
     _("0123456789".at(-1)).must_equal "9"
     _("vwq".at(5)).must_be_nil
     _("vwq".at(-5)).must_be_nil
-	end
+  end
 
   it "String#del deletes characters at positions" do
     _("asdfasdf".del(0..2)).must_equal "fasdf"
@@ -19,7 +19,7 @@ describe MightyString do
     str.del! (1..2)
     _(str).must_equal "af"
   end
- 
+
   it "Can get the first and last character" do
     _("asdf".first).must_equal "a"
     _("asdf".last).must_equal "f"
@@ -37,6 +37,16 @@ describe MightyString do
     _("asdf".shift).must_equal "a"
   end
 
+  it "String#head" do
+    _("asdf".head).must_equal "a"
+    _("asdf".head(3)).must_equal "asd"
+  end
+
+  it "String#tail" do
+    _("asdf".tail).must_equal "sdf"
+    _("asdf".tail(3)).must_equal "f"
+  end
+
   it "sorts" do
     str = "asdf"
     _(str.sort).must_equal "adfs"
@@ -53,31 +63,33 @@ describe MightyString do
     _("asdfasdfasdf".values_at(0,5,-1)).must_equal ["a", "s", "f"]
   end
 
-	it "String#index_all returns all indexes of given string" do
+  it "String#index_all returns all indexes of given string" do
     _("012324507654301243".index_all("0")).must_equal [0,7,13]
     _("the apple is the best fruit in the world".index_all("the")).must_equal [0, 13, 31]
     _("asdfasdfasdf".index_all(/sd/)).must_equal [1,5,9]
-	end
-	
-	it "sifts out bad characters" do
+    _("asdfasdfasdf".index_all('a')).must_equal [0,4,8]
+    _("asdfasdfasdf".index_all('f')).must_equal [3,7,11]
+  end
+
+  it "sifts out bad characters" do
     _("qa2ws3ed4rf5tg6yh7uj8ik9ol".sift(Range.new( "0", "9" ))).must_equal "23456789"
-		
-		custRange = (Range.new('a','z').to_a + Range.new('A','Z').to_a + [" "]).flatten
+
+    custRange = (Range.new('a','z').to_a + Range.new('A','Z').to_a + [" "]).flatten
     _("<html><body> Content </body></html>".sift(custRange)).must_equal "htmlbody Content bodyhtml"
-	end
-	
-	def test_strip_first_seq
-    MightyString::HTML.strip_first_seq("APPLES n APPLES ARE Yummy!","APPLES",{"APPLES" => "COWS"}).must_equal "COWS n APPLES ARE Yummy!"
-    MightyString::HTML.strip_first_seq("Cows Cows and more Cows!","Cows", {"Cows" => "Winner"}).must_equal "Winner Cows and more Cows!"
-    MightyString::HTML.strip_first_seq("&nbsp; ---- &nbsp; APPLES &nbps;", "&nbsp;" ).must_equal "  ---- &nbsp; APPLES &nbps;"
-    MightyString::HTML.strip_first_seq("&trade; ---- &trade; TradeMark &trade;", "&trade;" ).must_equal "(TM) ---- &trade; TradeMark &trade;"
-	end
-	
-	def test_strip_html
-    MightyString::HTML.text("<html>").must_equal ""
-    MightyString::HTML.text("<table><tr><td>Piped sides.</td></tr></table>", :mappings => {"td" => ' | '}).must_equal " | Piped sides. | "
-    MightyString::HTML.text("Hello<br>World!").must_equal "Hello\nWorld!"
-    MightyString::HTML.text("<p>&quot;Quoted&quot; Copyright &copy; TradeMark &trade;</p>").must_equal "'Quoted' Copyright (c) TradeMark (TM)"
-	end
+  end
+
+  it "strips/substitues custom sequences" do
+    _(MightyString::HTML.strip_first_seq("APPLES n APPLES ARE Yummy!","APPLES",{"APPLES" => "COWS"})).must_equal "COWS n APPLES ARE Yummy!"
+    _(MightyString::HTML.strip_first_seq("Cows Cows and more Cows!","Cows", {"Cows" => "Winner"})).must_equal "Winner Cows and more Cows!"
+    _(MightyString::HTML.strip_first_seq("&nbsp; ---- &nbsp; APPLES &nbps;", "&nbsp;" )).must_equal "  ---- &nbsp; APPLES &nbps;"
+    _(MightyString::HTML.strip_first_seq("&trade; ---- &trade; TradeMark &trade;", "&trade;" )).must_equal "(TM) ---- &trade; TradeMark &trade;"
+  end
+
+  it "strips HTML and substitues new mappings" do
+    _(MightyString::HTML.text("<html>")).must_equal ""
+    _(MightyString::HTML.text("<table><tr><td>Piped sides.</td></tr></table>", :mappings => {"td" => ' | '})).must_equal " | Piped sides. | "
+    _(MightyString::HTML.text("Hello<br>World!")).must_equal "Hello\nWorld!"
+    _(MightyString::HTML.text("<p>&quot;Quoted&quot; Copyright &copy; TradeMark &trade;</p>")).must_equal "'Quoted' Copyright (c) TradeMark (TM)"
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mightystring
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Daniel P. Clark / 6ftDan(TM)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler