the_string_to_slug 0.0.8 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee96cdf83aae4e27d147ffe28a082a53a304e497
-  data.tar.gz: 670d91f17e1405c90528b0d0b939cdeaf4c4e468
+  metadata.gz: 4a4835e1fce9b86bfd6d2972a1962e2e49cd3fb2
+  data.tar.gz: bb2cc21692b00c62be219635b3481c5e23a878d2
 SHA512:
-  metadata.gz: bd4ef70a8fc9734f82b611eed07feb210639d9172538e77e0da2e70c2449f50380876680aea18a95fc9414f93f01eea5a04b0107318663e8b86184b062903664
-  data.tar.gz: 2fa8fb13d35d6df3be99ba52c818915afbfbec3dcfa6eb4b892fc60361cc6e36425a745cc2737a1241ab81ef442f9d2c36fa41132bd2d0bb275d310077c4ecff
+  metadata.gz: 0b2c161d669135b2a8859f5a434f2605d440d34f14b55ad22825034d5642389efe1088ff486b85afee2867922c71f5f03714a4d201c1fb9cea3f2fcb7ce63607
+  data.tar.gz: 85f45fe0904df42af44f4e277763c9a3b3b666a472735e1c2c9ad82118c6cf18a524ecb344c60786dc3bcc3f6879f0c9f7709c962839c1ab0ac3217d4d0d5af4

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_store

data/README.md

@@ -34,4 +34,26 @@ For filenames:
 ```ruby
 "/доки/dir/тест/документ.doc".slugged_filename         #=> "dokument.doc"
 String.slugged_filename("/доки/dir/тест/документ.doc") #=> "dokument.doc"
+```
+
+For full file path:
+
+```ruby
+"/доки/dir/тест/документ.doc".slugged_file             #=> "/доки/dir/тест/dokument.doc"
+String.slugged_filename("/доки/dir/тест/документ.doc") #=> "/доки/dir/тест/dokument.doc"
+```
+
+Params
+
+```ruby
+"Документ.doc".to_slug_param(locale: :en)
+# => "doc"
+
+"Документ.doc".to_slug_param(locale: :en)
+# => "dokument-doc"
+```
+
+```ruby
+"Документ.doc".to_slug_param(delimiter: '_')
+# => "dokument_doc"
 ```

data/lib/the_string_to_slug.rb

@@ -4,48 +4,54 @@ require "the_string_to_slug/version"
 module TheStringToSlug; end
 
 class String
-  def to_slug_param
-    self.class.to_slug_param(self)
+  def to_slug_param opts = {}
+    self.class.to_slug_param(self, opts)
   end
 
-  def slugged_filename
-    self.class.slugged_filename(self)
+  def slugged_filename opts = {}
+    self.class.slugged_filename(self, opts)
   end
 
-  def slugged_file
-    self.class.slugged_file(self)
+  def slugged_file opts = {}
+    self.class.slugged_file(self, opts)
   end
 
   # -----------------------------------
   # Self methods
   # -----------------------------------
   class << self
-    def to_slug_param str
-      I18n::transliterate(str).gsub('_','-').parameterize('-').downcase
+    def to_slug_param str, opts = {}
+      delimiter = opts.delete(:delimiter) || '-'
+      str = str.gsub(/\-{2,}/, '-').mb_chars
+      str = I18n::transliterate(str, opts)
+        .gsub('_', delimiter)
+        .gsub('-', delimiter)
+        .parameterize(delimiter)
+        .downcase.to_s
     end
 
-    def file_ext file_name
-      File.extname(file_name)[1..-1].to_s.to_slug_param
+    def file_ext file_name, opts = {}
+      File.extname(file_name)[1..-1].to_s.to_slug_param opts
     end
 
-    def file_name file_name
-      file_name = File.basename(file_name)
-      ext       = File.extname(file_name)
-      File.basename(file_name, ext).to_s.to_slug_param
+    def file_name name, opts = {}
+      name = File.basename name
+      ext  = File.extname  name
+      File.basename(name, ext).to_s.to_slug_param opts
     end
 
-    def slugged_filename file_name
-      file_name = File.basename(file_name)
-      fname     = self.file_name(file_name)
-      ext       = self.file_ext(file_name)
+    def slugged_filename name, opts = {}
+      name  = File.basename  name
+      fname = self.file_name name, opts
+      ext   = self.file_ext  name, opts
 
       return fname if ext.blank?
       [fname, ext].join('.')
     end
 
-    def slugged_file file_full_path
-      file_name = slugged_filename file_full_path
-      file_full_path.split('/')[0...-1].push(file_name).join '/'
+    def slugged_file file_full_path, opts = {}
+      fname = slugged_filename file_full_path, opts
+      file_full_path.split('/')[0...-1].push(fname).join '/'
     end
   end
 end

data/lib/the_string_to_slug/version.rb

@@ -1,3 +1,3 @@
 module TheStringToSlug
-  VERSION = "0.0.8"
+  VERSION = "1.1"
 end

data/spec/dummy_app/config/application.rb

@@ -6,6 +6,8 @@ require 'rails/all'
 # you've limited to :test, :development, or :production.
 Bundler.require(:default, Rails.env)
 
+I18n.enforce_available_locales = true
+
 module DummyApp
   class Application < Rails::Application
     # Settings in config/environments/* take precedence over those specified here.

data/spec/dummy_app/spec/helpers/string.rb

@@ -7,6 +7,11 @@ describe 'StringToSlug' do
       "Привет Мир! Hello world!".to_slug_param.should eq "privet-mir-hello-world"
       "Документ.doc".to_slug_param.should eq "dokument-doc"
     end
+
+    it 'When wrong translation' do
+      "Привет Мир! Hello world!".to_slug_param(locale: :en).should eq "hello-world"
+      "Документ.doc".to_slug_param(locale: :en).should eq "doc"
+    end
   end
 
   context 'Filename test' do
@@ -19,6 +24,17 @@ describe 'StringToSlug' do
 
       String.slugged_filename("/доки/dir/тест/доку мент").should eq "doku-ment"
     end
+
+    it 'When wrong translation' do
+      "/doc/dir/test/document.doc".to_slug_param(locale: :ru).should     eq "doc-dir-test-document-doc"
+      "/doc/dir/test/document.doc".slugged_filename(locale: :ru).should  eq "document.doc"
+      
+      "/доки/dir/тест/документ.doc".slugged_filename(locale: :en).should eq ".doc"
+      "/доки/dir/тест/документ".slugged_filename(locale: :en).should     eq ""
+      "/доки/dir/тест/доку мент".slugged_filename(locale: :en).should    eq ""
+
+      String.slugged_filename("/доки/dir/тест/доку мент", locale: :en).should eq ""
+    end
   end
 
   context 'Full path to file' do
@@ -30,5 +46,77 @@ describe 'StringToSlug' do
 
       String.slugged_file("/доки/dir/тест/доку мент").should eq "/доки/dir/тест/doku-ment"
     end
+
+    it 'When wrong translation' do
+      "/doc/dir/test/document.doc".slugged_file(locale: :en).should  eq "/doc/dir/test/document.doc"
+      "/доки/dir/тест/документ.doc".slugged_file(locale: :en).should eq "/доки/dir/тест/.doc"
+      
+      "/доки/dir/тест/документ".slugged_file(locale: :en).should     eq "/доки/dir/тест/"
+      "/доки/dir/тест/доку мент".slugged_file(locale: :en).should    eq "/доки/dir/тест/"
+
+      String.slugged_file("/доки/dir/тест/доку мент", locale: :en).should eq "/доки/dir/тест/"
+    end
+  end
+
+  context 'Delimiter' do
+    it 'should be true' do
+      "Привет Мир! Hello world!".to_slug_param(delimiter: '_').should eq "privet_mir_hello_world"
+      "Документ.doc".to_slug_param(delimiter: '_').should eq "dokument_doc"
+
+      "/доки/dir/тест/документ".slugged_file(delimiter: '_').should      eq "/доки/dir/тест/dokument"
+      "/доки/dir/тест/доку мент".slugged_file(delimiter: '_').should     eq "/доки/dir/тест/doku_ment"
+      "/доки/dir/тест/доку мент".slugged_filename(delimiter: '_').should eq "doku_ment"
+    end
+  end
+
+  context "spec chars" do
+    it "should works" do
+      "[$&+,:;=?@Hello world!#|'<>.^*()%!-]".to_slug_param.should eq 'hello-world'
+    end
+
+    it "should works" do
+      "教師 — the-teacher".to_slug_param.should eq 'the-teacher'
+      "Hello ^, I'm here!".to_slug_param.should eq 'hello-i-m-here'
+    end
+
+    it "should works" do
+      "HELLO---WorlD".to_slug_param(delimiter: '_').should eq 'hello_world'
+    end
+
+    it "should works" do
+      str = "__...HELLO-___--+++--WorlD----__&&***...__.---"
+      
+      str.to_slug_param.should eq 'hello-world'
+      str.to_slug_param(delimiter: '_').should eq 'hello_world'
+      str.to_slug_param(delimiter: '+').should eq 'hello+world'
+    end
+
+    it "should works" do
+      str = "Ilya zykin aka   Killich, $$$ aka the-teacher"
+      str.to_slug_param(delimiter: '+').should eq "ilya+zykin+aka+killich+aka+the+teacher"
+    end
+  end
+
+  context 'Scopes' do
+    it "should work with Nested Controller Name" do
+      class PagesController < ApplicationController; end
+      ctrl = PagesController.new
+      ctrl.controller_path.to_slug_param.should eq 'pages'
+    end
+
+    it "should work with Nested Controller Name" do
+      module Admin; end
+      class Admin::PagesController < ApplicationController; end
+      ctrl = Admin::PagesController.new
+      ctrl.controller_path.to_slug_param.should eq 'admin-pages'
+    end
+
+    it "should work with Nested Controller Name" do
+      module Admin; end
+      class Admin::PagesController < ApplicationController; end
+      ctrl = Admin::PagesController.new
+      params = { delimiter: '_' }
+      ctrl.controller_path.to_slug_param(params).should eq 'admin_pages'
+    end
   end
 end

metadata

@@ -1,65 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: the_string_to_slug
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: '1.1'
 platform: ruby
 authors:
 - Ilya N. Zykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-26 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails-i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0.pre
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! ' Convert text string to slug param '
+description: " Convert text string to slug param "
 email:
 - zykin-ilya@ya.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,17 +133,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Translite, downcase, parameterize