agnostic_slugs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60d42bf414ee63ea0fff3b603f39d81ef623c055
+  data.tar.gz: aec643b42421f40dc26b1757c848018ca86639de
+SHA512:
+  metadata.gz: 800a7886f1002f94b05c1edbf4af3feae6c9d05b563457cc5745d6906ff17650cf91557811eee6228914e44f5ff2403f123bb8da967f670d94206d649035fd47
+  data.tar.gz: 36a809879ccc72f27a10fd687fc77b56a9a7d806b9fed663be77afe681179514d2616dc7bb8bbcdb9aadf64d0029603c14a400f337d4f1d153f2a0e37b7ed091

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1
+
+Initial version with basic functionality

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lasse Skindstad Ebert
+
+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,30 @@
+# AgnosticSlugs
+
+agnostic_slugs is a simple slug generator that is agnostic.
+
+* It does not care about ORMs.
+* It will not monkey patch
+
+It can create slugs. Period.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'agnostic_slugs'
+```
+
+## Usage
+
+    slug = AgnosticSlugs::Slug.new('Look at my pretty new shoes! :)')
+    slug.to_s       # => "look-at-my-pretty-new-shoes"
+    slug.next.to_s  # => "look-at-my-pretty-new-shoes-2"
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/agnostic_slugs/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,2 @@
+require "bundler/gem_tasks"
+

data/agnostic_slugs.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agnostic_slugs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agnostic_slugs"
+  spec.version       = AgnosticSlugs::VERSION
+  spec.authors       = ["Lasse Skindstad Ebert"]
+  spec.email         = ["lasse@lasseebert.dk"]
+  spec.summary       = %q{Slug generator that is agnostic about ORMs}
+  spec.homepage      = "https://github.com/lasseebert/agnostic_slugs"
+  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 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+end

data/lib/agnostic_slugs.rb

@@ -0,0 +1,5 @@
+require 'agnostic_slugs/slug'
+require 'agnostic_slugs/version'
+
+module AgnosticSlugs
+end

data/lib/agnostic_slugs/slug.rb

@@ -0,0 +1,111 @@
+module AgnosticSlugs
+  class Slug
+    attr_reader :original, :counter
+
+    def initialize(original, counter = 1)
+      @original = original
+      @counter  = counter
+    end
+
+    def next
+      self.class.new(original, counter + 1)
+    end
+
+    def to_s
+      @slug ||= generate
+    end
+
+    private
+
+    def generate
+      result = original
+      result = replace_accents(result)
+      result = result.gsub(/[\s_\-]+/, '-')
+      result = result.downcase
+      result = result.gsub(/[^a-z0-9\-]/, '')
+
+      if counter > 1
+        "#{result}-#{counter}"
+      else
+        result
+      end
+    end
+
+    def replace_accents(string)
+      # This was taken directly from https://github.com/ericboehs/to_slug
+      # Thanks, ericboehs :)
+
+      # 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
+      string
+    end
+  end
+end

data/lib/agnostic_slugs/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'pry-byebug'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/unit/slug_spec.rb

@@ -0,0 +1,46 @@
+require 'agnostic_slugs/slug'
+
+module AgnosticSlugs
+  describe Slug do
+    describe '#to_s' do
+
+      subject { Slug.new(input, counter).to_s }
+      let(:counter) { 1 }
+
+      describe 'simple input' do
+        let(:input) { 'Simple string' }
+        it { should eq('simple-string') }
+      end
+
+      describe 'accented input' do
+        let(:input) { 'Hellø Wårld' }
+        it { should eq('hello-warld') }
+      end
+
+      describe 'punctuations' do
+        let(:input) { 'Hello world!' }
+        it { should eq('hello-world') }
+      end
+
+      describe 'with a counter' do
+        let(:input) { 'hello-world' }
+        let(:counter) { 2 }
+        it { should eq('hello-world-2') }
+      end
+    end
+
+    describe '#next' do
+      it 'should increment counter' do
+        actual = Slug.new('foo').next.counter
+        expect(actual).to eq(2)
+      end
+
+      it 'should be immutable' do
+        slug = Slug.new('foo')
+        next_slug = slug.next
+
+        expect(slug.counter).to eq(1)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: agnostic_slugs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lasse Skindstad Ebert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-09 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: pry-byebug
+  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'
+- !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.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- lasse@lasseebert.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- agnostic_slugs.gemspec
+- lib/agnostic_slugs.rb
+- lib/agnostic_slugs/slug.rb
+- lib/agnostic_slugs/version.rb
+- spec/spec_helper.rb
+- spec/unit/slug_spec.rb
+homepage: https://github.com/lasseebert/agnostic_slugs
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Slug generator that is agnostic about ORMs
+test_files:
+- spec/spec_helper.rb
+- spec/unit/slug_spec.rb