symbolizify 0.1.0 → 0.2.1

data/README.md

@@ -2,19 +2,22 @@
 
 Converts the given string to a symbol-style symbol.
 
+Adds `ActiveSupport::Inflectors#symbolizify`, `String#symbolizify!`, and `String#symbolizify`.
+
 This is intended to be a kind of inverse of `#humanize`, but a little more robust than [dehumanize](https://github.com/AndyObtiva/dehumanize). This is a strong symbolizer, converting hyphens, non-standard characters, spaces, camelcase, etc. to underscored strings. The main inspiration for this came after finding that `#dehumanize` did not support dehumanizing strings containing numbers, e.g.
 
 ```ruby
-"Abstract Object 1".dehumanize # => "abstract_object1", not "abstract_object_1"
+"Abstract Object 1".dehumanize  # => "abstract_object1"
+"Abstract Object 1".symbolizify # => "abstract_object_1"
 ```
 
-In fact, `dehumanize` was the inspiration, and the overall design of the gem was inspired by this prior art.
+The name `symbolizify` was chosen in order to avoid naming collisions or confusion with other `symbolize` gems in the market, and to reinforce the idea that this doesn't actually convert a string to a symbol, but rather converts it to a symbol-style string.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'symbolizify', '>= 0.1.0'
+    gem 'symbolizify', '>= 0.2.0'
 
 And then execute:
 
@@ -26,16 +29,17 @@ Or install it yourself as:
 
 ## Usage
 
-Call symbolizify on any string to turn it into a symbol-style string! Removes non-word/non-digit characters (except for ! and ? if it's at the end of the string), reduces everything to lowercase with underscores separating things, e.g.
+Call symbolizify on any string to turn it into a symbol-style string! Removes non-word/non-digit characters, reduces everything to lowercase with underscores separating words and numbers, e.g.
 
 ```ruby
-'Personal Phone'.symbolizify            # => 'personal_phone',
+'Personal Phone  '.symbolizify          # => 'personal_phone',
 'Home address'.symbolizify              # => 'home_address',
 'HatRack'.symbolizify                   # => 'hat_rack',
-'Who is _why?'.symbolizify              # => 'who_is_why?',
+'Who is _why?'.symbolizify              # => 'who_is_why',
 'Person 1'.symbolizify                  # => 'person_1',
 'Personel! #231'.symbolizify            # => 'personel_231',
-'Shekibobo is great!'.symbolizify       # => 'shekibobo_is_great!'
+'Wang chung !'.symbolizify              # => 'wang_chung',
+'Shekibobo is great!'.symbolizify       # => 'shekibobo_is_great',
 'test.subject@example.com'.symbolizify  # => 'test_subject_example_com'
 ```
 

data/lib/symbolizify.rb

@@ -3,12 +3,16 @@ require "active_support/inflector"
 
 module ActiveSupport::Inflector
   def symbolizify(s)
-    s.titleize.parameterize('_') << s.strip[-1].match(/[!?]/).to_s
+    parameterize(titleize(s), '_')
   end
 end
 
 class String
   def symbolizify
-    ActiveSupport::Inflector.symbolizify(self)
+    dup.symbolizify!
+  end
+
+  def symbolizify!
+    self.replace ActiveSupport::Inflector.symbolizify(self)
   end
 end

data/lib/symbolizify/version.rb

@@ -1,3 +1,3 @@
 module Symbolizify
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/spec/symbolizify_spec.rb

@@ -4,18 +4,41 @@ require 'symbolizify'
 describe String do
   describe "#symbolizify" do
     {
-      'Personal Phone' => 'personal_phone',
-      'Home address'   => 'home_address',
-      'HatRack'        => 'hat_rack',
-      'Who is _why?'   => 'who_is_why?',
-      'Person 1'       => 'person_1',
-      'Personel! #231' => 'personel_231',
-      'Shekibobo is great!'       => 'shekibobo_is_great!',
+      'Personal Phone  ' => 'personal_phone',
+      'Home address'     => 'home_address',
+      'HatRack'          => 'hat_rack',
+      'Who is _why?'     => 'who_is_why',
+      'Person 1'         => 'person_1',
+      'Personel! #231'   => 'personel_231',
+      'Wang chung !'     => 'wang_chung',
+      'Shekibobo is great!'       => 'shekibobo_is_great',
       'test.subject@example.com'  => 'test_subject_example_com'
     }.each do |original, symbolizified|
       it "should turn '#{original}' to '#{symbolizified}'" do
         original.symbolizify.should eq symbolizified
       end
     end
+
+    it "should return a copy of the original string" do
+      original = original_copy = "I don't know what I was expecting"
+      original.symbolizify
+      original.should eq original_copy
+    end
+  end
+
+  describe "#symbolizify!" do
+    it "should modify the string in place" do
+      string = "Gangnam Style"
+      string.symbolizify!
+      string.should eq "gangnam_style"
+    end
+  end
+end
+
+describe ActiveSupport::Inflector do
+  describe "#symbolizify" do
+    it "should coerce non-strings to strings prior to conversion" do
+      ActiveSupport::Inflector.symbolizify(%w[array of strings!]).should eq "array_of_strings"
+    end
   end
 end

data/symbolizify.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Symbolizify::VERSION
   gem.authors       = ["Joshua Kovach"]
   gem.email         = ["kovach.jc@gmail.com"]
-  gem.description   = %q{Converts any string into a symbol-style symbol.}
+  gem.description   = %q{Converts any string into a symbol-style string.}
   gem.summary       = %q{Adds a method `#symbolizify` on ActiveSupport::Inflector and String which converts a string into a symbol-style string.}
   gem.homepage      = "https://www.github.com/shekibobo/symbolizify"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symbolizify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,7 +43,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
-description: Converts any string into a symbol-style symbol.
+description: Converts any string into a symbol-style string.
 email:
 - kovach.jc@gmail.com
 executables: []
@@ -88,3 +88,4 @@ summary: Adds a method `#symbolizify` on ActiveSupport::Inflector and String whi
 test_files:
 - spec/spec_helper.rb
 - spec/symbolizify_spec.rb
+has_rdoc: