slugg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27f8a91d281fb6ba75bcb503d666a86dd39c84f4
+  data.tar.gz: 37540b10705932b43dfad8f7921d039e8551e85f
+SHA512:
+  metadata.gz: 34cd62b2980a64d106f080139bde8d0cf81d93c95abf2a89e0d9847300d80032555af5436ed7d015cb44cdab237c1c5bfdaaf5f03027c1c26fde7c40c986d4b3
+  data.tar.gz: e23e7722ae46335027eaf86811f19d3207adf8a40eba3f7689d2b7572031a422da22706f47ab0e675c7977a16b24c76f57e40b0b7b06ff3862a166b871427bd1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--order random

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :test do
+  gem 'rspec', '>= 2.11'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yuri Artemev
+
+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,63 @@
+# Slugg
+
+Make safety urls from strings
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'slugg'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slugg
+
+## Usage
+
+```ruby
+require 'slug'
+
+Slugg.new "generate url, please"
+# => "generate-url-please"
+
+# Slugg.make is alias to Slugg.new
+Slugg.make "generate url, please"
+# => "generate-url-please"
+
+# you may provide some options
+Slugg.make "generate url, please", separator: "_"
+# => "generate_url_please"
+
+Slugg.make "generate url, please", stripper: "please"
+# => "generate-url"
+
+Slugg.make "strip 100$", stripper: /\d/
+# => "strip"
+
+# and you may use instance
+slugg = Slugg::Sanitizer.new separator: "_"
+slugg.safe "make url"
+# => "make_url"
+
+slugg.options[:separator] = "-"
+slugg.safe "make url"
+# => "make-url"
+
+# options
+{
+  separator: '-', # define custom separator
+  stripper: ''    # strip text, allows String and Regexp
+}
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/slugg.rb

@@ -0,0 +1,13 @@
+require 'slugg/sanitizer'
+require 'slugg/version'
+require 'slugg/chars'
+
+module Slugg
+  class << self
+    def new str, options = {}
+      Slugg::Sanitizer.new(options).safe str
+    end
+
+    alias_method :make, :new
+  end
+end

data/lib/slugg/chars.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+module Slugg
+  CHARS = {
+    # latin
+    'À' => 'A',  'Á' => 'A',  'Â' => 'A',  'Ã' => 'A',  'Ä' => 'A',
+    'Å' => 'A',  'Æ' => 'AE', 'Ç' => 'C',  'È' => 'E',  'É' => 'E',
+    'Ê' => 'E',  'Ë' => 'E',  'Ì' => 'I',  'Í' => 'I',  'Î' => 'I',
+    'Ï' => 'I',  'Ð' => 'D',  'Ñ' => 'N',  'Ò' => 'O',  'Ó' => 'O',
+    'Ô' => 'O',  'Õ' => 'O',  'Ö' => 'O',  'Ő' => 'O',  'Ø' => 'O',
+    'Ù' => 'U',  'Ú' => 'U',  'Û' => 'U',  'Ü' => 'U',  'Ű' => 'U',
+    'Ý' => 'Y',  'Þ' => 'TH', 'ß' => 'ss', 'à' => 'a',  'á' => 'a',
+    'â' => 'a',  'ã' => 'a',  'ä' => 'a',  'å' => 'a',  'æ' => 'ae',
+    'ç' => 'c',  'è' => 'e',  'é' => 'e',  'ê' => 'e',  'ë' => 'e',
+    'ì' => 'i',  'í' => 'i',  'î' => 'i',  'ï' => 'i',  'ð' => 'd',
+    'ñ' => 'n',  'ò' => 'o',  'ó' => 'o',  'ô' => 'o',  'õ' => 'o',
+    'ö' => 'o',  'ő' => 'o',  'ø' => 'o',  'ù' => 'u',  'ú' => 'u',
+    'û' => 'u',  'ü' => 'u',  'ű' => 'u',  'ý' => 'y',  'þ' => 'th',
+    'ÿ' => 'y',  'ẞ' => 'SS',
+    # greek
+    'α' => 'a',  'β' => 'b',  'γ' => 'g',  'δ' => 'd',  'ε' => 'e',
+    'ζ' => 'z',  'η' => 'h',  'θ' => '8',  'ι' => 'i',  'κ' => 'k',
+    'λ' => 'l',  'μ' => 'm',  'ν' => 'n',  'ξ' => '3',  'ο' => 'o', 
+    'π' => 'p',  'ρ' => 'r',  'σ' => 's',  'τ' => 't',  'υ' => 'y',
+    'φ' => 'f',  'χ' => 'x',  'ψ' => 'ps', 'ω' => 'w',  'ά' => 'a',
+    'έ' => 'e',  'ί' => 'i',  'ό' => 'o',  'ύ' => 'y',  'ή' => 'h',
+    'ώ' => 'w',  'ς' => 's',  'ϊ' => 'i',  'ΰ' => 'y',  'ϋ' => 'y',
+    'ΐ' => 'i',
+    'Α' => 'A',  'Β' => 'B',  'Γ' => 'G',  'Δ' => 'D',  'Ε' => 'E',
+    'Ζ' => 'Z',  'Η' => 'H',  'Θ' => '8',  'Ι' => 'I',  'Κ' => 'K',
+    'Λ' => 'L',  'Μ' => 'M',  'Ν' => 'N',  'Ξ' => '3',  'Ο' => 'O',
+    'Π' => 'P',  'Ρ' => 'R',  'Σ' => 'S',  'Τ' => 'T',  'Υ' => 'Y',
+    'Φ' => 'F',  'Χ' => 'X',  'Ψ' => 'PS', 'Ω' => 'W',  'Ά' => 'A',
+    'Έ' => 'E',  'Ί' => 'I',  'Ό' => 'O',  'Ύ' => 'Y',  'Ή' => 'H',
+    'Ώ' => 'W',  'Ϊ' => 'I',  'Ϋ' => 'Y',
+    #turkish
+    'ş' => 's',  'Ş' => 'S',  'ı' => 'i',  'İ' => 'I',  'ğ' => 'g',
+    'Ğ' => 'G',
+    # russian
+    'а' => 'a',  'б' => 'b',  'в' => 'v',  'г' => 'g',  'д' => 'd',
+    'е' => 'e',  'ё' => 'yo', 'ж' => 'zh', 'з' => 'z',  'и' => 'i',
+    'й' => 'j',  'к' => 'k',  'л' => 'l',  'м' => 'm',  'н' => 'n',
+    'о' => 'o',  'п' => 'p',  'р' => 'r',  'с' => 's',  'т' => 't',
+    'у' => 'u',  'ф' => 'f',  'х' => 'h',  'ц' => 'c',  'ч' => 'ch',
+    'ш' => 'sh', 'щ' => 'sh', 'ъ' => 'u',  'ы' => 'y',  'ь' => '', 
+    'э' => 'e',  'ю' => 'yu', 'я' => 'ya',
+    'А' => 'A',  'Б' => 'B',  'В' => 'V',  'Г' => 'G',  'Д' => 'D',
+    'Е' => 'E',  'Ё' => 'Yo', 'Ж' => 'Zh', 'З' => 'Z',  'И' => 'I',
+    'Й' => 'J',  'К' => 'K',  'Л' => 'L',  'М' => 'M',  'Н' => 'N',
+    'О' => 'O',  'П' => 'P',  'Р' => 'R',  'С' => 'S',  'Т' => 'T',
+    'У' => 'U',  'Ф' => 'F',  'Х' => 'H',  'Ц' => 'C',  'Ч' => 'Ch',
+    'Ш' => 'Sh', 'Щ' => 'Sh', 'Ъ' => 'U',  'Ы' => 'Y',  'Ь' => '',
+    'Э' => 'E',  'Ю' => 'Yu', 'Я' => 'Ya',
+    # ukranian
+    'Є' => 'Ye', 'І' => 'I',  'Ї' => 'Yi', 'Ґ' => 'G',  'є' => 'ye',
+    'і' => 'i',  'ї' => 'yi', 'ґ' => 'g',
+    # czech
+    'č' => 'c',  'ď' => 'd',  'ě' => 'e',  'ň' => 'n',  'ř' => 'r',
+    'š' => 's',  'ť' => 't',  'ů' => 'u',  'ž' => 'z',  'Č' => 'C',
+    'Ď' => 'D',  'Ě' => 'E',  'Ň' => 'N',  'Ř' => 'R',  'Š' => 'S',
+    'Ť' => 'T',  'Ů' => 'U',  'Ž' => 'Z',
+    # polish
+    'ą' => 'a',  'ć' => 'c',  'ę' => 'e',  'ł' => 'l',  'ń' => 'n',
+    'ś' => 's',  'ź' => 'z',  'ż' => 'z',  'Ą' => 'A',  'Ć' => 'C',
+    'Ę' => 'e',  'Ł' => 'L',  'Ń' => 'N',  'Ś' => 'S',  'Ź' => 'Z',
+    'Ż' => 'Z',
+    # latvian
+    'ā' => 'a',  'ē' => 'e',  'ģ' => 'g',  'ī' => 'i',  'ķ' => 'k',
+    'ļ' => 'l',  'ņ' => 'n',  'ū' => 'u',  'Ā' => 'A',  'Ē' => 'E',
+    'Ģ' => 'G',  'Ī' => 'i',  'Ķ' => 'k',  'Ļ' => 'L',  'Ņ' => 'N',
+    'Ū' => 'u'
+  }
+end

data/lib/slugg/sanitizer.rb

@@ -0,0 +1,25 @@
+module Slugg
+  class Sanitizer
+    attr_accessor :options
+
+    def initialize options = {}
+      @options = {
+       :separator => "-",
+       :stripper  => ""
+      }.merge options
+    end
+
+    def safe string
+      string
+        .split('')
+        .map { |c| c = Slugg::CHARS.include?(c) ? Slugg::CHARS[c] : c }
+        .join
+        .downcase
+        .gsub(@options[:stripper], '')
+        .gsub(/[\W|_]+/, @options[:separator])
+        .gsub(%r"^#{@options[:separator]}+", '')
+        .gsub(%r"#{@options[:separator]}+$", '')
+
+    end
+  end
+end

data/lib/slugg/version.rb

@@ -0,0 +1,3 @@
+module Slugg
+  VERSION = "0.0.1"
+end

data/slugg.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slugg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slugg"
+  spec.version       = Slugg::VERSION
+  spec.authors       = ["Yuri Artemev"]
+  spec.email         = ["i@artemeff.com"]
+  spec.description   = %q{Make safety urls from strings}
+  spec.summary       = %q{Generates safe urls from strings}
+  spec.homepage      = "https://github.com/artemeff/slugg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+end

data/spec/slugg/sanitizer_spec.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Slugg::Sanitizer do
+  describe ".new" do
+    let(:options) do
+      described_class.new(separator: "_", stripper: 'a').options
+    end
+
+    it "set separator" do
+      options[:separator].should eq "_"
+    end
+
+    it "set custom stripper" do
+      options[:stripper].should eq 'a'
+    end
+  end
+
+  describe "#safe" do
+    context "with default options" do
+      let(:safe) do
+        -> (string) { described_class.new.safe string }
+      end
+
+      it "replace with separator" do
+        safe.("string with spaces").should eq "string-with-spaces"
+      end
+
+      it "downcase string" do
+        safe.("STRRRING").should eq "strrring"
+      end
+
+      it "replace non-english chars" do
+        safe.("кто вообще это читает?").should eq "kto-voobshe-eto-chitaet"
+      end
+
+      it "remove separator from left and right" do
+        safe.("     much    spaces  !     ").should eq "much-spaces"
+      end
+    end
+
+    context "with custom separator" do
+      let(:safe) do
+        -> (string, separator) do
+          described_class.new(separator: separator).safe string
+        end
+      end
+
+      it "replace with separator '_'" do
+        safe.("string with spaces", "_").should eq "string_with_spaces"
+      end
+    end
+
+    context "with custom stripper" do
+      let(:safe) do
+        -> (string, stripper) do
+          described_class.new(stripper: stripper).safe string
+        end
+      end
+
+      it "strips all 'the'" do
+        safe.("strip the string", "the").should eq "strip-string"
+      end
+
+      it "strips all /\\d/" do
+        safe.("strip 123 string", /\d/).should eq "strip-string"
+      end
+    end
+  end
+end

data/spec/slugg_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Slugg do
+  context "VERSION" do
+    subject { Slugg::VERSION }
+    it { should be_a String }
+  end
+
+  shared_examples "alias" do |method, options|
+    it "is alias to Sanitizer.safe" do
+      expect(Slugg.send(method.to_sym, "str")).to be_a String
+    end
+
+    it "may assign options" do
+      expect(Slugg.send(method.to_sym, "str", options)).to be_a String
+    end
+  end
+
+  describe ".new" do
+    include_examples "alias", "new", { separator: '_' }
+  end
+
+  describe ".make" do
+    include_examples "alias", "make", { separator: '_' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'slugg'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: slugg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuri Artemev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies: []
+description: Make safety urls from strings
+email:
+- i@artemeff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slugg.rb
+- lib/slugg/chars.rb
+- lib/slugg/sanitizer.rb
+- lib/slugg/version.rb
+- slugg.gemspec
+- spec/slugg/sanitizer_spec.rb
+- spec/slugg_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/artemeff/slugg
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Generates safe urls from strings
+test_files:
+- spec/slugg/sanitizer_spec.rb
+- spec/slugg_spec.rb
+- spec/spec_helper.rb
+has_rdoc: