string-utility 2.7.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a2b5e87c8eacc1c8298288a863648479d79a92b
-  data.tar.gz: ea2d2bfdfefea83ff19aaa28ff851ee037377e85
+  metadata.gz: 95e1b97ed7145c00bb717a2e8fa57683cfac3297
+  data.tar.gz: 19f34fccbd7246f8872eaefdf952f825e62ebb73
 SHA512:
-  metadata.gz: 6dad12d0aa07187cc0c682b1c9d6242dd89b1494dbf5eeaac50451563044cc4e300c0f7c44eeac2e8be0697e3adf1353f125a31dd2f874133dc86a0152ae90d7
-  data.tar.gz: f786694beb1eba79692b5b1676169d253504ee84dbbd128b1ddae01e738e03af19f7320f65336246e33b31cc3bb86115b62464fe3e606b09689f18fd378b968d
+  metadata.gz: f0fbe197ee5d28cb514ff235d07c424c1aa39ed8a487b592de9ac0442093b1666c86b0753ea1e68b05958eacca4d0ab1738face77d7471969e77a0b4e1cbe125
+  data.tar.gz: cb83fbb6f3c57aca226cfa4223553631793fd7184810cfd6ec5c5e974e891fd04fb08f447b42d3ee448223147c6f60202f8830ab92fba301a0ac5cdeee5c3589

data/CHANGELOG.md

@@ -1,4 +1,16 @@
 # Changelog
+## Version 3
+### Version 3.0.0
+* Improved test coverage and accuracy significantly by (a) having more tests; and (b) having tests cover return values as well as self-modification non-return values (i.e., checking what happens *after* a bang method is called).
+* `spacify` and `underscorify` are no longer Rust native extensions. The Ruby methods were not slow enough to warrant native extensions, and this was complicated when using external build services like Heroku.
+* `to_i_separated` no longer modifies the source string (it is non-destructive).
+* `underscorify` is no longer destructive.
+* New method `underscorify!`, destructive version of `underscorify`.
+* `spacify` is no longer destructive.
+* New method `spacify!`, destructive version of `spacify`.
+* Remove `safely_gsub!`, as it undermines the actual usage of `gsub!` (you probably aren't going to be doing `str = str.gsub!('a', 'b')`, and if you are, you are using it wrongly.)
+* New method `separate!`, destructive version of `separate`.
+
 ## Version 2
 ### Version 2.7.3
 * Optimize underscorify and spacify with native extensions written in Rust, utilizing the ruru crate. These methods are now 2-5x faster. I did attempt to write a Rust extension for random_line, the slowest function in this library, but the performance increase was insignificant.

data/lib/utils.rb

@@ -1,9 +1,4 @@
-require 'fiddle'
-
-LIBRARY = Fiddle.dlopen("#{File.dirname(__FILE__)}/../ext/target/release/libstringutility.dylib")
-
 module StringUtility
-  Fiddle::Function.new(LIBRARY['initialize_me'], [], Fiddle::TYPE_VOIDP).call
   refine String do
     # Separates the string by another string. Useful for converting integers
     #   into human-readable numbers.
@@ -16,20 +11,46 @@ module StringUtility
       chars.reverse!.each_slice(count).map(&:join).join(separator[0]).reverse!
     end
 
-    # Converts a separated string into an integer. This is basically the reverse
-    #   of #separate.
+    # In-place version of #separate. This is about two times slower than the non-destructive variant. This is because
+    #   the destructive version (this one) uses regular expressions to insert the string.
+    # see #separate
+    def separate!(count = 3, separator = ',')
+      reverse!
+      gsub!(/(.{#{count}})/, "\\1#{separator[0]}")
+      # Because of that regular expression, sometimes a separator character will be inserted at the end.
+      # For example, '1000'.separate!(2) would result in ,10,00.
+      # This is not ideal, but it works.
+      chomp!(separator[0])
+      reverse!
+    end
+
+    # Converts a separated string into an integer. This is basically the reverse of #separate. Does not modify the
+    #   source string.
     # @return [Integer] The integer version of the separated string.
     def to_i_separated
-      safely_gsub!(/\D/, '').to_i
+      gsub(/\D/, '').to_i
     end
 
-    # Readable shorthand for the only safe, fast way to use gsub! using || operators. Unlike gsub!, safely_gsub! will
-    # NEVER return nil. This method should not be used instead of gsub! when the string replacement is predictable, as
-    # this method is somewhat slower than gsub! (see spec/benchmark).
-    # @see #{String#gsub!} for parameters and other information.
-    # @return [String] Exactly what gsub! would return, or self. Never nil.
-    def safely_gsub!(pattern, replace)
-      gsub!(pattern, replace) || self
+    # Replaces all whitespace with underscores. Does not modify the source string.
+    # @return [String] A new string with replaced whitespace.
+    def underscorify
+      gsub(/\s/, '_')
+    end
+
+    # Replaces all whitespace with underscores. Modifies the source string in-place.
+    def underscorify!
+      gsub!(/\s/, '_')
+    end
+
+    # Replaces all underscores with whitespace. Does not modify the source string.
+    # @return [String] A new string with replaced underscores.
+    def spacify
+      gsub('_', ' ')
+    end
+
+    # Replaces all underscores with whitespace. Modifies the source string in-place.
+    def spacify!
+      gsub!('_', ' ')
     end
   end
 
@@ -70,14 +91,3 @@ module StringUtility
     str
   end
 end
-
-# A module that contains stub methods for the Rust native extension methods.
-module StringUtilityNativeExtensionDocumentationStubs
-  # Replaces all whitespace with underscores.
-  # @return [String] The string with replaced whitespace.
-  def underscorify; end
-
-  # Replaces all underscores with whitespace.
-  # @return [String] The string with replaced underscores.
-  def spacify; end
-end

metadata

@@ -1,27 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: string-utility
 version: !ruby/object:Gem::Version
-  version: 2.7.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies: []
 description: "    Some simple but handy methods to interact with string objects.\n"
 email: elifosterwy@gmail.com
 executables: []
-extensions:
-- ext/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- ext/Cargo.toml
-- ext/Makefile
-- ext/extconf.rb
-- ext/src/lib.rs
 - lib/string-utility.rb
 - lib/utils.rb
 homepage: https://github.com/elifoster/string-utility-ruby
@@ -45,7 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Provides some basic utilities for interacting with Strings

data/ext/Cargo.toml

@@ -1,16 +0,0 @@
-[package]
-name = "string-utility-rb-native"
-version = "1.0.0"
-authors = ["Eli Clemente Gordillo Foster <elifosterwy@gmail.com>"]
-homepage = "https://rubygems.org/gems/string-utility"
-repository = "https://github.com/elifoster/String-Utility-Ruby"
-readme = "README.md"
-license = "MIT"
-description = "The Rust native extension for the StringUtility Ruby gem."
-
-[lib]
-name = "stringutility"
-crate-type = ["dylib"]
-
-[dependencies]
-ruru = "0.7"

data/ext/Makefile

@@ -1,7 +0,0 @@
-all:
-	cargo build --release
-
-clean:
-	rm -rf target
-
-install: ;

data/ext/extconf.rb

@@ -1 +0,0 @@
-fail 'You have to install Rust with Cargo (https://www.rust-lang.org/)' if !system('cargo --version') || !system('rustc --version')

data/ext/src/lib.rs

@@ -1,29 +0,0 @@
-#[macro_use]
-extern crate ruru;
-
-use ruru::{AnyObject, Class, RString, VM};
-use ruru::types::{Argc, Value};
-use ruru::traits::Object;
-
-class!(StringUtility);
-
-methods!(
-    RString,
-    itself,
-    
-    fn underscorify() -> RString {
-        RString::new(&str::replace(&itself.to_string(), " ", "_"))
-    }
-    
-    fn spacify() -> RString {
-        RString::new(&str::replace(&itself.to_string(), "_", " "))
-    }
-);
-
-#[no_mangle]
-pub extern fn initialize_me() {
-    Class::from_existing("String").define(|itself| {
-        itself.def("underscorify", underscorify);
-        itself.def("spacify", spacify);
-    });
-}