slugster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f914424daf6b6d560696e48004ee38e6a1b1e34
+  data.tar.gz: 05d4bef73f6f5ef8b5a09d5916027accb3081691
+SHA512:
+  metadata.gz: c5e39b9d9d2902e000256478b9b1ea21a349d0869d69479d20b8905037ea66dd3b547c882506bf44a9b31ebbf4804c7fdf1f2bc13c64f0bf458d5540812ed57d
+  data.tar.gz: 423881d8d8d04037b1c246c2aa08ba275b78bc9cb68a2a502728e81a6ca3afbea47a9a3b061ba4c13ba64dc039a92096cd5be2461e9ed6225bb3deb6f1ce6a11

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at collin@zipnosis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Collin Graves
+
+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,41 @@
+# Slugster
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slugify`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slugify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slugify
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slugify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run all specs.'
+task :default => :spec
+
+desc 'Run all specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slugster"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slugster/version.rb

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

data/lib/slugster.rb

@@ -0,0 +1,147 @@
+require "slugster/version"
+
+class String #reopen string class to include #slugify
+  # Generate a slug for the string +value+.
+  #
+  # A slug should consist of numbers (0-9), lowercase letters (a-z) and
+  # dashes (-). Any other characters should be filtered.
+  #
+  # ==== Example
+  #
+  #   "One Bourbon, One Scotch, One Beer!".slugify # => "one-bourbon-one-scotch-one-beer"
+  #
+  # ==== Returns
+  # String:: A 'sluggified' version of this string
+  #
+  # --
+  # @api public
+  def to_slug(options={})
+
+    string = self
+    delimiter = options[:delimiter].nil? ? "-" : options[:delimiter]
+
+        # Define which accents map to which ascii characters
+    accents = {
+      # Uppercase
+      'A'   => %w(À Á Â Ã Ā Ă Ȧ Ả Ä Å Ǎ Ȁ Ȃ Ą Ạ Ḁ Ầ Ấ Ẫ Ẩ Ằ Ắ Ẵ Ẳ Ǡ Ǟ Ǻ Ậ Ặ),
+      'AE'  => %w(Æ Ǽ Ǣ),
+      'B'   => %w(Ḃ Ɓ Ḅ Ḇ Ƃ Ƅ),
+      'C'   => %w(C Ć Ĉ Ċ Č Ƈ Ç Ḉ),
+      'D'   => %w(D Ḋ Ɗ Ḍ Ḏ Ḑ Ḓ Ď Đ Ɖ Ƌ),
+      'E'   => %w(È É Ê Ẽ Ē Ĕ Ė Ë Ẻ Ě Ȅ Ȇ Ẹ Ȩ Ę Ḙ Ḛ Ề Ế Ễ Ể Ḕ Ḗ Ệ Ḝ Ǝ Ɛ),
+      'F'   => %w(Ḟ Ƒ),
+      'G'   => %w(Ǵ Ĝ Ḡ Ğ Ġ Ǧ Ɠ Ģ Ǥ),
+      'H'   => %w(Ĥ Ḣ Ḧ Ȟ Ƕ Ḥ Ḩ Ḫ Ħ),
+      'I'   => %w(Ì Í Î Ĩ Ī Ĭ İ Ï Ỉ Ǐ Ị Į Ȉ Ȋ Ḭ Ɨ Ḯ),
+      'IJ'  => %w(IJ),
+      'J'   => %w(Ĵ),
+      'K'   => %w(Ḱ Ǩ Ḵ Ƙ Ḳ Ķ),
+      'L'   => %w(Ĺ Ḻ Ḷ Ļ Ḽ Ľ Ŀ Ł Ḹ),
+      'M'   => %w(Ḿ Ṁ Ṃ Ɯ),
+      'N'   => %w(Ǹ Ń Ñ Ṅ Ň Ŋ Ɲ Ṇ Ņ Ṋ Ṉ Ƞ),
+      'O'   => %w(Ò Ó Ô Õ Ō Ŏ Ȯ Ö Ỏ Ő Ǒ Ȍ Ȏ Ơ Ǫ Ọ Ɵ Ø Ồ Ố Ỗ Ổ Ȱ Ȫ Ȭ Ṍ Ṏ Ṑ Ṓ Ờ Ớ Ỡ Ở Ợ Ǭ Ộ Ǿ Ɔ),
+      'OE'  => %w(Œ),
+      'P'   => %w(Ṕ Ṗ Ƥ),
+      'R'   => %w(Ŕ Ṙ Ř Ȑ Ȓ Ṛ Ŗ Ṟ Ṝ Ʀ),
+      'S'   => %w(Ś Ŝ Ṡ Š Ṣ Ș Ş Ṥ Ṧ Ṩ),
+      'T'   => %w(Ṫ Ť Ƭ Ʈ Ṭ Ț Ţ Ṱ Ṯ Ŧ),
+      'U'   => %w(Ù Ú Û Ũ Ū Ŭ Ü Ủ Ů Ű Ǔ Ȕ Ȗ Ư Ụ Ṳ Ų Ṷ Ṵ Ṹ Ṻ Ǜ Ǘ Ǖ Ǚ Ừ Ứ Ữ Ử Ự),
+      'V'   => %w(Ṽ Ṿ Ʋ),
+      'W'   => %w(Ẁ Ẃ Ŵ Ẇ Ẅ Ẉ),
+      'X'   => %w(Ẋ Ẍ),
+      'Y'   => %w(Ỳ Ý Ŷ Ỹ Ȳ Ẏ Ÿ Ỷ Ƴ Ỵ),
+      'Z'   => %w(Ź Ẑ Ż Ž Ȥ Ẓ Ẕ Ƶ),
+
+      # Lowercase
+      'a'   => %w(à á â ã ā ă ȧ ä ả å ǎ ȁ ȃ ą ạ ḁ ẚ ầ ấ ẫ ẩ ằ ắ ẵ ẳ ǡ ǟ ǻ ậ ặ),
+      'ae'  => %w(æ ǽ ǣ),
+      'b'   => %w(ḃ ɓ ḅ ḇ ƀ ƃ ƅ),
+      'c'   => %w(ć ĉ ċ č ƈ ç ḉ),
+      'd'   => %w(ḋ ɗ ḍ ḏ ḑ ḓ ď đ ƌ ȡ),
+      'e'   => %w(è é ê ẽ ē ĕ ė ë ẻ ě ȅ ȇ ẹ ȩ ę ḙ ḛ ề ế ễ ể ḕ ḗ ệ ḝ ɛ),
+      'f'   => %w(ḟ ƒ),
+      'g'   => %w(ǵ ĝ ḡ ğ ġ ǧ ɠ ģ ǥ),
+      'h'   => %w(ĥ ḣ ḧ ȟ ƕ ḩ ḫ ẖ ħ),
+      'i'   => %w(ì í î ĩ ī ĭ ı ï ỉ ǐ į į ȋ ḭ ɨ ḯ),
+      'ij'  => %w(ij),
+      'j'   => %w(ĵ ǰ),
+      'k'   => %w(ḱ ǩ ƙ ḳ ķ),
+      'l'   => %w(ĺ ḻ ḷ ļ ḽ ľ ŀ ł ƚ ḹ ȴ),
+      'm'   => %w(ḿ ṁ ṃ ɯ),
+      'n'   => %w(ǹ ń ñ ṅ ň ŋ ɲ ṇ ņ ṋ ṉ ʼn ȵ),
+      'o'   => %w(ò ó ô õ ō ŏ ȯ ö ỏ ő ǒ ȍ ȏ ơ ǫ ọ ɵ ø ồ ố ỗ ổ ȱ ȫ ȭ ṍ ṏ ṑ ṓ ờ ớ ỡ ở ợ ǭ ộ ǿ ɔ),
+      'oe'  => %w(œ),
+      'p'   => %w(ṕ ṗ ƥ),
+      'r'   => %w(ŕ ṙ ř ȑ ȓ ṛ ŗ ṟ ṝ),
+      's'   => %w(ś ŝ ṡ š ṣ ș ş ṥ ṧ ṩ ß ſ ẛ),
+      't'   => %w(ṫ ẗ ť ƭ ʈ ƫ ṭ ț ţ ṱ ṯ ŧ ȶ),
+      'u'   => %w(ù ú û ũ ū ŭ ü ủ ů ű ǔ ȕ ȗ ư ụ ṳ ų ṷ ṵ ṹ ṻ ǖ ǜ ǘ ǖ ǚ ừ ứ ữ ử ự),
+      'v'   => %w(ṽ ṿ),
+      'w'   => %w(ẁ ẃ ŵ ẇ ẅ ẘ ẉ),
+      'x'   => %w(ẋ ẍ),
+      'y'   => %w(ỳ ý ŷ ỹ ȳ ẏ ÿ ỷ ẙ ƴ ỵ),
+      'z'   => %w(ź ẑ ż ž ȥ ẓ ẕ ƶ),
+
+      # Not sure what to do with these
+      ''    => %w(Ð Þ Ə Ɣ Ɩ Ƣ Ƨ Ʃ Ʊ Ʒ Ǯ Ƹ Ȝ ƿ Ȣ ð þ ə ɣ ɩ ƣ ƨ ʃ ƪ ʊ ʒ ǯ ƹ ƺ ȝ Ƿ ȣ DZ Dz dz DŽ Dž dž LJ Lj lj NJ Nj nj ĸ ƍ ƛ ƾ ƻ Ƽ ƽ)
+    }
+
+    accents.each do |replacement, accent|
+      regex = Regexp.new("[#{accent.join("|")}]")
+      string = string.gsub(regex, replacement)
+    end
+
+    # Strip any HTML decimal/hexadecimal entites
+    string = string.gsub(
+      /           # begin matching a string
+        &         # an ampersand
+        [^ ]     # Match any character except whitespace -- enables matching of hex or decimal
+        [0-9A-F]  # a hex digit
+        {1,4}     # 1 to 4 of them
+        ;         # a semicolon
+      /xi,        # / = end matching; x = allow spaces/comments; i = ignore case; , = end argument
+      ''          # replace matches with nothing (remove matches)
+    )
+
+    # Convert periods to dashs
+    string = string.gsub(/[.]/,"-")
+
+    unless options[:preserve_underscore]
+      # Convert underscores to dashs
+      string = string.gsub(/[_]/, "-")
+    end
+
+    # Remove any characters that aren't alphanumeric (or a dash)
+    string = string.gsub(/[^a-zA-Z0-9 \-_]/,"")
+
+    #Replace multiple spaces with single space
+    string = string.gsub(/[ ]+/," ")
+
+    # Remove single quotes
+    string.gsub!(/[']+/, '')
+
+    # Replace non-word characters (\W) with a space
+    string.gsub!(/\W+/, ' ')
+
+    # A little off the edges
+    string.strip!
+
+    # Replace single spaces with a URL friendly dash (-)
+    string = string.gsub(/ /,"#{delimiter}")
+
+    # Do a greedy replace on multiple dashes
+    string = string.gsub(/-+/,"-")
+
+    # Do a greedy replace on multiple underscores
+    string = string.gsub(/_+/,"_")
+
+    # Replace spaces with dashes
+    string.gsub!(' ', '-')
+
+    # All characters should be downcased
+    string.downcase!
+
+    # Return the resulting slug
+    string
+  end
+end

data/slugster.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slugster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slugster"
+  spec.version       = Slugster::VERSION
+  spec.authors       = ["Collin Graves"]
+  spec.email         = ["collin@zipnosis.com"]
+
+  spec.summary       = %q{Slugify strings safely}
+  spec.homepage      = "http://github.com/collingraves/slugster"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: slugster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Collin Graves
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: 
+email:
+- collin@zipnosis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slugster.rb
+- lib/slugster/version.rb
+- slugster.gemspec
+homepage: http://github.com/collingraves/slugster
+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: Slugify strings safely
+test_files: []
+has_rdoc: