slug_less 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9ff9c3f4e32a8804da8bd90c6a76ab53535d132
+  data.tar.gz: 48a1ddeb9251d925be70cdfb1bf56bb8e336e0af
+SHA512:
+  metadata.gz: ec33510c4bbe90615e94f45086217ca88a3a594a1b9d95985e03b3c0c96d779969cc22872a27ea10889f11d83390a538738975520ed6a6b35e353d62e3647b00
+  data.tar.gz: 2a9543cdd7f506cbb82e76cdc957f0f670f18795681e618c776289975639aa18e989c20bcdaa823c658bacbaabccac13240f0a87918863bfd532520984e7930c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slug_less.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 René Maya
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# SlugLess
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slug_less'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slug_less
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/renemaya/slug_less/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+  task.pattern = 'test/*_test.rb'
+end

data/lib/slug_less.rb

@@ -0,0 +1,3 @@
+require "slug_less/version"
+require "slug_less/to_slug"
+Gem.find_files("slug_less/encoding_approximations/*.rb").each { |path| require path }

data/lib/slug_less/encoding_approximations/latin_diacritics1.rb

@@ -0,0 +1,29 @@
+module SlugLess
+
+  LATIN_DIACRITICS1 = {"a" => ["\u{00C0}", "\u{00C1}", "\u{00C2}", "\u{00C3}",
+                                         "\u{00C4}", "\u{00C5}", "\u{00E0}",
+                                         "\u{00E1}", "\u{00E2}", "\u{00E3}", "\u{00E4}",
+                                         "\u{00E5}"
+                                       ],
+                               "e" => ["\u{00C8}", "\u{00C9}", "\u{00CA}", "\u{00CB}",
+                                         "\u{00E8}", "\u{00E9}", "\u{00EA}", "\u{00EB}"
+                                       ],
+                               "i" => ["\u{00CC}", "\u{00CD}", "\u{00CE}", "\u{00CF}",
+                                         "\u{00EC}", "\u{00ED}", "\u{00EE}", "\u{00EF}"
+                                       ],
+                               "o" => ["\u{00D2}", "\u{00D3}", "\u{00D4}", "\u{00D5}",
+                                         "\u{00D6}", "\u{00D8}", "\u{00F2}", "\u{00F3}",
+                                         "\u{00F4}", "\u{00F5}", "\u{00F6}", "\u{00F8}"
+                                       ],
+                               "u" => ["\u{00D9}", "\u{00DA}", "\u{00DB}", "\u{00DC}",
+                                         "\u{00F9}", "\u{00FA}", "\u{00FB}", "\u{00FC}"
+                                       ],
+                               "ae" => ["\u{00C6}", "\u{00E6}"],
+                               "c" => ["\u{00C7}", "\u{00E7}"],
+                               "d" => ["\u{00D0}", "\u{00F0}"],
+                               "n" => ["\u{00D1}", "\u{00F1}"],
+                               "y" => ["\u{00DD}", "\u{00FD}"],
+                               "th" => ["\u{00DE}"],
+                               "ss" => ["\u{00DF}"]
+                               }.freeze
+end

data/lib/slug_less/to_slug.rb

@@ -0,0 +1,46 @@
+module SlugLess
+
+  String.class_eval do
+    def to_slug
+      text = self.dup
+      transliterate(text)
+      sanitize(text)
+      remove_special_characters(text)
+    end
+
+    private
+
+    def transliterate(text)
+      # TODO: figure out how to make this so others can choose which
+      # dictionaries to load or even load custom ones.
+      substitute_characters(text)
+    end
+
+    def substitute_characters(text, char_table = SlugLess::LATIN_DIACRITICS1)
+      characters_to_change = char_table.values
+      slug_friendly_characters = char_table.keys
+
+      characters_to_change.each_with_index do |set, idx|
+        text.chars.each do |char|
+          text.gsub!(char, slug_friendly_characters[idx]) if set.include?(char)
+        end
+      end
+
+      text
+    end
+
+    def sanitize(text)
+      text.downcase!
+      text.gsub! ' ','-'
+      text.gsub!(/-+/, '-')
+      text.gsub!(/\A-|-\z/, '')
+      text
+    end
+
+    def remove_special_characters(text)
+      text.gsub!(/[^a-z0-9-]/, '')
+      text
+    end
+  end
+
+end

data/lib/slug_less/version.rb

@@ -0,0 +1,3 @@
+module SlugLess
+  VERSION = "0.1.0"
+end

data/slug_less.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slug_less/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slug_less"
+  spec.version       = SlugLess::VERSION
+  spec.authors       = ["René Maya"]
+  spec.email         = ["rene.maya1@gmail.com"]
+  spec.summary       = %q{Generate slugs using less code}
+  spec.description   = %q{Simple gem that aims at doing one thing: generate slugs with as few lines of clean code as possible.}
+  spec.homepage      = "https://github.com/renemaya/slug_less"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+require 'slug_less'

data/test/to_slug_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+class ToSlugTest < Minitest::Test
+  def test_lowercase_string
+    str = 'HeLLo'
+    assert_equal "hello", str.to_slug
+  end
+
+  def test_strip_trailing_space
+    str = 'trailing space '
+    assert_equal 'trailing-space', str.to_slug
+  end
+
+  def test_strip_leading_space
+    str = ' leading space'
+    assert_equal 'leading-space', str.to_slug
+  end
+
+  def test_replace_whitespace_with_dashes
+    str = 'Hello World'
+    assert_equal 'hello-world', str.to_slug
+  end
+
+  def test_keep_numbers_in_slug
+    str = "2015 Learning Ruby"
+    assert_equal '2015-learning-ruby', str.to_slug
+  end
+
+  def test_strip_trailing_dashes
+    str = 'trailing dash-'
+    assert_equal 'trailing-dash', str.to_slug
+  end
+
+  def test_strip_leading_dashes
+    str = '-leading dash'
+    assert_equal 'leading-dash', str.to_slug
+  end
+
+  def test_replace_nspaces_with_one_dash
+    str = 'hola    muNdo'
+    assert_equal 'hola-mundo', str.to_slug
+  end
+
+  def test_no_modification_to_valid_slug_strings
+    str = 'a-b-c-d'
+    assert_equal 'a-b-c-d', str.to_slug
+  end
+
+  def test_remove_double_dashes
+    str = 'two--dashes--in--between'
+    assert_equal 'two-dashes-in-between', str.to_slug
+  end
+
+  def test_consider_acronyms_single_words
+    str = "N.Y.P.D. vs. N.S.A. vs. F.B.I."
+    assert_equal 'nypd-vs-nsa-vs-fbi', str.to_slug
+  end
+
+  def test_no_dashes_for_apostrophes
+    str = "Thomas Jefferson's Papers"
+    assert_equal 'thomas-jeffersons-papers', str.to_slug
+  end
+
+  def test_remove_special_characters
+    str = 'xyz!@#$%^&*•¶§∞¢89££¡¿()><?""\':;][]\.,/'
+    assert_equal 'xyz89', str.to_slug
+  end
+
+  def test_remove_diacritics_as_prescribe_in_latin_diacritics1
+    diacritics = "À Á Â Ã Ä Å Æ " +
+                  "à á â ã ä å æ " +
+                  "Ç È É Ê Ë Ð Ñ " +
+                  "ç è é ê ë ð ñ " +
+                  "Ì Í Î Ï Ý " +
+                  "ì í î ï ý " +
+                  "Ò Ó Ô Õ Ö Ø " +
+                  "ò ó ô õ ö ø " +
+                  "Ù Ú Û Ü " +
+                  "ù ú û ü " +
+                  "Þ ß"
+
+    expected = %w{a a a a a a ae
+                     a a a a a a ae
+                     c e e e e d n
+                     c e e e e d n
+                     i i i i y
+                     i i i i y
+                     o o o o o o
+                     o o o o o o
+                     u u u u
+                     u u u u
+                     th ss
+                   }
+
+    output = diacritics.to_slug.split('-')
+
+    output.each_index do |idx|
+      assert_equal expected[idx], output[idx]
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: slug_less
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- René Maya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: 'Simple gem that aims at doing one thing: generate slugs with as few
+  lines of clean code as possible.'
+email:
+- rene.maya1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slug_less.rb
+- lib/slug_less/encoding_approximations/latin_diacritics1.rb
+- lib/slug_less/to_slug.rb
+- lib/slug_less/version.rb
+- slug_less.gemspec
+- test/test_helper.rb
+- test/to_slug_test.rb
+homepage: https://github.com/renemaya/slug_less
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generate slugs using less code
+test_files:
+- test/test_helper.rb
+- test/to_slug_test.rb
+has_rdoc: