slugity 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzdkYjE4NjdiYTA4ZTY0MDVhYjMwZDkzMWY5ZmNlNTE0NThjY2RiNA==
+    NzA0NGY5YTY3YTBjZDc4MjE5YTgzNTJiZTQ5YzQ1ZDM0NjRjODkwOA==
   data.tar.gz: !binary |-
-    ZDZjZWE0YTY0M2M5Yjc4Y2JjNWY3YWVhYjI5MGUwYjljZTU5MTMyMg==
+    NDRkZjhhMmMxMTFmY2E1MjU3ZTYwZDdkY2QzNTg1YzJkZDI5OTc5NQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NGY3Y2QyNzI0MjgyMjdkNGEzNTBkZDQzY2MzOTBkMTk1ZmZhNTFiMzI3MDkw
-    YmE2N2RkYWYzNTBmOWEzNWZiNGM5MTUzOWEwYjgzNjkxNDBkZjUyYmY4MjVi
-    YTQzNzVjNTQ1ZjBhYWI4OTRjZmM2YmYwMzlkNGRhMWU4MGE1Y2M=
+    NzkyNGI1MDk1ZmMxMzlmYzU4MGE4OTNmNmJhY2E3OGUxYjM3MTQyMGE1MmJj
+    MWRjMjkzOGIyZmZjOWUwMmUyMWE0NjAxNTlhZmJiY2JjMzdiMWIxY2FiNDc5
+    MWUyYjQ1NGRhNDJhZDliY2RjY2RmYmIzNTFjNDg2ZjkyMzNkNDk=
   data.tar.gz: !binary |-
-    NTFjOGIzNjNlZWQzYWJiMjQwNzk3NDBlMDQ5MDJiZGI4MTc0ZWIwMTJiMDZh
-    Y2M2YmEzYzRmMTAwMzFhNWU5NTk3M2VjZDU1M2IxNGZjNWIzM2VlODdlNGM2
-    YWNhYjM1ZDM1NjI2MmU1MzIzMzFkZmNhOWM2ZWRjMTE3NTk0ZTA=
+    NzhlMDlhZDZhM2EwYzBmYmZmMzlmYWYxZGNjNjI0ZGIxZDIzM2M2NGIzMDFm
+    NGIxOThmYzk3ZDgwYTYzNmFlY2I5NTNlY2VlNjVhOGI1ZjZlMWEzYWQ1MTU4
+    M2RiMTJiYTRkMjI4ZDU3YjI2ZDA1ZjdlOWI1NTg4MDY3ZWU3Y2Q=

data/lib/slugity/extend_string.rb

@@ -3,8 +3,11 @@ require 'slugity'
 class String
 	include Slugity
 
-	def to_slug
-		slugity self
+  # call slugity on self
+  # @param key [Symbol] the matcher to use
+  # @return [String] the slugged string
+	def to_slug key=:default
+		slugity self, key
 	end
 
 end

data/lib/slugity/matchers.rb

@@ -0,0 +1,34 @@
+module Slugity
+  module Matchers
+
+    @@matchers = {
+      # define the default matchers
+      default: {
+        /\s|\// => '-',
+        /\.|\'|\"|\<|\>|\,|\(|\)|\:/ => '',
+        /\&/ => 'and',
+        /\+/ => 'plus',
+        /\=/ => 'equals'
+      }
+    }
+
+    # fetch a matcher
+    # @param key [Symbol]
+    # @return [Hash]
+    def self.use key
+      @@matchers[key]
+    end
+
+    # add a matcher hash
+    # @param key [Symbol]
+    # @param use_default [Boolean]
+    # @param options [Hash]
+    def self.add key, use_default=true, options={}
+      if use_default
+        options = @@matchers[:default].merge(options)
+      end
+      @@matchers[key] = options
+    end
+
+  end
+end

data/lib/slugity/utilities.rb

@@ -11,11 +11,11 @@ module Slugity
 
         # capture spaces at the begining or end of the string
         pattern = /(^\s+|\s+$)/
-      
+
         # strip characters that match the pattern
         string.gsub( pattern, '' )
       end
-    
+
     end
 
   end

data/lib/slugity/version.rb

@@ -1,3 +1,3 @@
 module Slugity
-	VERSION = '0.0.1'
+	VERSION = '0.1.0'
 end

data/lib/slugity.rb

@@ -1,15 +1,23 @@
 require 'slugity/utilities'
+require 'slugity/matchers'
 
 module Slugity
 
 	# Converts the given string into a slug
 	#
 	# @param string [String] the string to slugity
+  # @param matcher [Symbol] the matcher to use
 	# @return [String] the slug version of the provided string
-  def slugity string
-  	string = Util.trim_string( string )
+  def slugity string, matcher=:default
+  	string = Util.trim_string( string ).downcase
 
-    string.downcase.gsub(/\s|\//, '-').gsub(/\.|\'|\"|\<|\>|,|\(|\)|\:/,'').gsub(/\&/,'and').gsub(/\+/,'plus').gsub(/\=/,'equals')
+    Slugity::Matchers.use(matcher).each do |match,replacement|
+      string.gsub!( match, replacement )
+    end
+
+    string.gsub!( /[^a-z0-9\-\_]/, '' )
+
+    return string
   end
 
 end

data/spec/slugity/matchers_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'slugity'
+
+describe Slugity::Matchers do
+  include Slugity
+
+  describe '#default_matchers' do
+
+    it 'returns a hash table' do
+      Slugity::Matchers.use(:default).class.should == Hash
+    end
+
+  end
+
+  describe '#set_matcher' do
+
+    it 'allows custom matchers to be set' do
+      Slugity::Matchers.add :percent, true, {
+        /\%/ => 'percent'
+      }
+
+      slugity( "hello 20% of the world", :percent ).should == "hello-20percent-of-the-world"
+
+    end
+
+    it 'allows matchers to be overwritten' do
+      Slugity::Matchers.add :plus, true, {
+        /\+/ => 'not-plus'
+      }
+
+      slugity( "one + one", :plus ).should == "one-not-plus-one"
+    end
+
+  end
+end

data/spec/slugity/trim_string_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require File.expand_path("../../../lib/slugity/utilities", __FILE__)
+require 'slugity/utilities'
 
 describe Slugity::Util do
 

data/spec/slugity_spec.rb

@@ -1,5 +1,7 @@
+# encoding: utf-8
+
 require 'spec_helper'
-require File.expand_path("../../lib/slugity", __FILE__)
+require 'slugity'
 
 test_strings = {
   "Hello World" => "hello-world",
@@ -21,6 +23,10 @@ describe Slugity do
         slugity( input ).should == output
       end
     end
+
+    it "strips unrecognized characters" do
+      slugity( "aëòúi".encode("UTF-8") ).should == "ai"
+    end
   end
 
 end

data/spec/string_spec.rb

@@ -7,6 +7,12 @@ describe String do
 		it "should have been included on String" do
 			"hello world".to_slug.should == "hello-world"
 		end
+    it "lets you pass custom matchers" do
+      Slugity::Matchers.add :plus, true, {
+        /\+/ => 'not-plus'
+      }
+      "one + one".to_slug(:plus).should == "one-not-plus-one"
+    end
 	end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slugity
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies: []
 description: ! ' Yet another slugging gem, this one makes sure you want to extend
   the String class instead of assuming. '
@@ -18,9 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/slugity/extend_string.rb
+- lib/slugity/matchers.rb
 - lib/slugity/utilities.rb
 - lib/slugity/version.rb
 - lib/slugity.rb
+- spec/slugity/matchers_spec.rb
 - spec/slugity/trim_string_spec.rb
 - spec/slugity_spec.rb
 - spec/spec_helper.rb
@@ -44,12 +46,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Yet another slugging gem
 test_files:
+- spec/slugity/matchers_spec.rb
 - spec/slugity/trim_string_spec.rb
 - spec/slugity_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb
+has_rdoc: