ruby-slugify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5354609d5f05b94f8ad516d552b55640505751562e3aac60c43af274d823dacb
+  data.tar.gz: 56e4f89879eff6d902d5a469bdafde8382fc4e52a722c07ca96bfe788b080275
+SHA512:
+  metadata.gz: eccd017ef1bca3fbc0845d7d7f8b71e0451d8d0bc169a8e22366d4d8e8fa371081e257862dfe6c1d6e4810785f5a8db411d26974f43eee0afd8b0a8f2c02b4e8
+  data.tar.gz: 8fbcb453f631e5498b71c2b94b4efc5bdad1973c9c95b814a2642d8c2f18811cb1461c5d092a7240660cb94754dbd30664745e4038571ce9c9bea262f8763c10

data/lib/language-support.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+$defaultMap = {
+    '"' =>  "",
+    '\'' => "",
+    '’' =>  "",
+    '‒' =>  "-", 
+    '–' =>  "-", 
+    '—' =>  "-", 
+    '―' =>  "-",
+}
+
+$deutscheMap = {
+    '&' => "und",
+    '@' => "an",
+    'ä' => "ae",
+    'Ä' => "Ae",
+    'ö' => "oe",
+    'Ö' => "Oe",
+    'ü' => "ue",
+    'Ü' => "Ue",
+}
+
+$englishMap = {
+    '&' => "and",
+    '@' => "at",
+}
+
+$spanishMap = {
+    '&' => "y",
+    '@' => "en",
+}
+
+$finnishMap = {
+    '&' => "ja",
+    '@' => "at",
+}
+
+$greekMap = {
+    '&' => "kai",
+    'η' => "i",
+    'ή' => "i",
+    'Η' => "i",
+    'ι' => "i",
+    'ί' => "i",
+    'ϊ' => "i",
+    'Ι' => "i",
+    'χ' => "x",
+    'Χ' => "x",
+    'ω' => "w",
+    'ώ' => "w",
+    'Ω' => "w",
+    'ϋ' => "u",
+}
+
+$dutchMap = {
+    '&' => "en",
+    '@' => "at",
+}
+
+$polishMap = {
+    '&' => "i",
+    '@' => "na",
+}
+
+$turkishMap = {
+    '&' => "ve",
+    '@' => "et",
+    'ş' => "s",
+    'Ş' => "S",
+    'ü' => "u",
+    'Ü' => "U",
+    'ö' => "o",
+    'Ö' => "O",
+    'İ' => "I",
+    'ı' => "i",
+    'ğ' => "g",
+    'Ğ' => "G",
+    'ç' => "c",
+    'Ç' => "C",
+}
+
+$referenceTable = {
+    "en" => $englishMap,
+    "es" => $spanishMap,
+    "de" => $deutscheMap, 
+    "fi" => $finnishMap,
+    "nl" => $dutchMap,
+    "po" => $polishMap,
+    "tr" => $turkishMap, 
+    "gr" => $greekMap,
+    "el" => $greekMap,
+    "ell" => $greekMap
+}

data/lib/ruby-slugify.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + "/language-support"
+require 'stringex/unidecoder'
+
+class RubySlugify
+    
+    @inputString = nil
+    @language = "en"
+    @maxLength = 100
+    @toLower = true
+    @customMap = nil
+    @slugString = nil
+
+    # Initializes the object with all necessary instance variables
+    # Parameters : 
+    #   1. inputString - The string to be slugified
+    #   2. language - If any language translations are required. Available options : ["en", "es", "de", "nl", "gr", "el", "ell", "po", "fi"]. Default is 'en' or english
+    #   3, customMap - If any custom mappings are required i.e custom substituions for words in the slugString
+    #   4. maxLength - Limits the size of the slugified string. Default is 100 characters
+    #   5. toLower - Whether the slugified string needs to be lower cased. Default is true, i.e it is lower cased. 
+    def initialize(inputString, language = "en", customMap = nil,  maxLength = 100, toLower = true)
+        # Initialise all the instance variables
+        @inputString = inputString
+        @maxLength = maxLength
+        @toLower = toLower
+        @customMap = customMap
+
+        # If the language is not supported use default as english
+        if $referenceTable.key?(language)
+            @language = language
+        else
+            @language = "en"
+        end
+    end
+
+    # Creates the slugified string from the given input string
+    # Returns : slugified string
+    def createSlug()
+        # Strip leading and trailing spaces
+        @slugString = @inputString.strip()
+
+        # If custom mapping is given, first substitute these key, value pairs
+        unless @customMap.nil?
+            substituteCustom(@customMap)
+        end
+
+        # Substitute all the common characters present in the default map
+        substituteChars($defaultMap)
+        
+        # Substitute all the  characters present in the given language
+        substituteChars($referenceTable[@language])
+        
+        # Process all non ASCII characters and convert them to nearest ASCII
+        @slugString = Stringex::Unidecoder.decode(@slugString)
+
+        # If required in lowercase, convert it. Always coverts to lowercase unless specified otherwise
+        unless @toLower == false
+            @slugString = @slugString.downcase
+        end
+        
+        # Any character other than a-z A-Z 0-9 _ and - will be replaced with -
+        @slugString = @slugString.gsub(/[^a-zA-Z0-9\-\_]/, '-')
+        
+        # Replace multiple '-'s with a single '-' and multiple '_'s with a single '_'
+        @slugString = @slugString.gsub(/-+/, '-')
+        @slugString = @slugString.gsub(/_+/, '_')
+
+        # Remove any leading and trailing '-'s and '_'s
+        @slugString = @slugString.delete_prefix('-')
+        @slugString = @slugString.delete_prefix('_')
+        @slugString = @slugString.delete_suffix('-')
+        @slugString = @slugString.delete_suffix('_')
+        
+        # If the size of slug string is greater than the maxLength, trim it
+        if @slugString.length > @maxLength
+            @slugString = trimString(@slugString, @maxLength)
+        end
+        
+        @slugString
+    end
+
+    # Substitutes the characters in slugString with their mapped values 
+    # Parameters :
+    #   1. mapping - The hashmap that contains the one to one mapping of characters to be replaced
+    def substituteChars(mapping)
+        len = @slugString.length - 1
+        for i in 0..len
+            if mapping.key?(@slugString[i])
+                @slugString[i] = mapping[@slugString[i]]
+            end
+        end
+    end
+
+    # Substitutes the patterns in slugString with their mapped values given by the user
+    # Parameters :
+    #   1. mapping - The hashmap that contains the one to one mapping of character runs to be replaced
+    def substituteCustom(mapping)
+        mapping.each do |key, value|
+            find = key.to_s
+            replace = value.to_s
+            @slugString = @slugString.gsub(find, replace)
+        end
+    end
+
+    # Truncates a string if it is longer than a given length
+    # Parameters :
+    #   1. longString - the string that is to be truncated
+    #   2. mlen - maximum length of the string
+    # Returns :
+    #   1. Truncated string
+    def trimString(longString, mlen)
+
+        # Split at '-' to obtain all the words in the slug
+        splitString = longString.split('-')
+
+        # If the first word is longer than maxLength, return the slice as the trimmed string
+        if splitString[0].length > mlen
+            return splitString[0][0..mlen-1]
+        end
+        
+        # Ensure the truncated version is below maxLength but has whole words in the slug
+        trimmedString = ''
+        for string in splitString
+            if string.length + trimmedString.length + 1 <= mlen 
+                trimmedString = trimmedString + '-' + string
+            else
+                break
+            end
+        end
+
+        # Remove leading '-' due to concatenation
+        trimmedString = trimmedString.delete_prefix('-')
+        return trimmedString
+    end
+
+    # Returns true if the given string is a slug. Can be invoked without an object.
+    # Parameters :
+    #   1. inputString - The string that is to be checked
+    # Returns : 
+    #   1. Boolean value (true / false) - If the string is a slug or not
+    def self.isSlug(inputString)
+        if inputString == "" || inputString.length > @maxLength || inputString[0] == '-' || inputString[0] == '_' || inputString[inputString.length - 1] == '-' || inputString[inputString.length - 1] == '_'
+            return false
+        else
+            return inputString.match(/[^a-zA-Z0-9\-\_]/).nil?
+        end
+    end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: ruby-slugify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aditi Srinivas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- aditisrinivas97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/language-support.rb
+- lib/ruby-slugify.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: URL-friendly slugify in Ruby
+test_files: []