slug_fu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b2b860388aa2f04e298622c041a7cdb2a74eca6
+  data.tar.gz: fd1024cf2d9a19e7692e329e31c3683f12e000bf
+SHA512:
+  metadata.gz: 86a6e691ed16991366d7963929190c691da0b8cfedf9caf60935678f8383f2b028a9b60e4b6419174daf9bffd735ac70dfe95ef4c5eda7a4366a1ef717d69115
+  data.tar.gz: 35908b4ea2a0303645369a552c87795f22e07b8d5c482c62a69ccfa7f36a87509da774817324f87b5c95e37adc0f77f949879537c2eea121f63d5a48f85df6be

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bradley Schaefer
+
+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,67 @@
+# SlugFu
+
+Yet Another gem for generating slug strings suitable for URLs (or whatever your slug business may be).
+
+**What makes this one different?** This gives you tools for ensuring the uniqueness of your slugs,
+and if your slug is not unique it allows you to plug in different strategies for generating unique slugs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slug_fu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slug_fu
+
+## Usage
+
+```ruby
+include SlugFu
+
+SlugFu(string) # doesn't need to check uniqueness, just make a slug string
+
+SlugFu(string, context: %w(one two)) # generated slug will unique as far as `context.include?(slug)` is concerned
+
+class NamingStrategy
+  def initialize(str)
+    @str = str
+  end
+
+  def next
+    @next = @next.nil? ? @str : @next + "-"
+  end
+end
+SlugFu("one", context: %w(one one-), naming_strategy: NamingStrategy) # Use a custom strategy for naming, calling #next until a unique name is found
+```
+
+### Usage with Rails
+
+SlugFu supplies `SlugFu::ModelContext` for ensuring uniqueness on Rails models.
+
+```ruby
+include SlugFu
+
+SlugFu(str, context: SlugFu::ModelContext.new(Book)) # slug will be unique for the `Book#slug` attribute
+SlugFu(str, context: SlugFu::ModelContext.new(Book.where(language: "en")) # slug will be unique for the `Book#slug` attribute in the given scope
+SlugFu(str, context: SlugFu::ModelContext.new(Book, :url_slug)) # slug will be unique for the `Book#url_slug` attribute
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/soulcutter/slug_fu
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slug_fu"
+
+require "pry"
+Pry.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/slug_fu.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require "singleton"
+
+require "slug_fu/version"
+require "slug_fu/default_naming_strategy"
+require "slug_fu/model_context"
+
+module SlugFu
+  def SlugFu(str, context: NoContext.instance, naming_strategy: DefaultNamingStrategy)
+    namer = naming_strategy.new(::SlugFu.slugify(str))
+
+    begin
+      result = namer.next
+    end while context.include?(result)
+    result
+  end
+  module_function :SlugFu
+
+  def self.slugify(str)
+    str.to_s.gsub(/^\s\s*/, "") # Trim left
+      .gsub(/\s\s*$/, "") # Trim right
+      .gsub(/\_/, "-")   # Convert underscores to hyphens
+      .gsub(/&/, " and ") # Replace ampersand with " and "
+      .gsub(/\s+/, "-")  # Replace extra spaces with only one hyphen
+      .gsub(/[^\w\-\u00E0-\u00FC]/, "") # Strip everything but alphanumeric, hypen, and accented characters
+      .gsub(/\-+/, "-") # Replace multiple hypens with one
+      .downcase
+  end
+
+  class NoContext
+    include Singleton
+
+    def include?(*)
+      false
+    end
+  end
+end

data/lib/slug_fu/default_naming_strategy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module SlugFu
+  # This strategy tries the original slug first, then appends increasing
+  # numbers. The sequence would look like so:
+  #
+  # "slug"
+  # "slug-1"
+  # "slug-2"
+  # "slug-3"
+  class DefaultNamingStrategy
+    def initialize(str)
+      @str = str
+      @count = 0
+    end
+
+    def next
+      slug = @count > 0 ? "#{@str}-#{@count}" : @str
+      @count += 1
+      slug
+    end
+  end
+end

data/lib/slug_fu/model_context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module SlugFu
+  # Context that can be used with ActiveRecord models to check if a slug
+  # already exists in a given scope.
+  #
+  # Example:
+  #
+  # SlugFu(str, context: SlugFu::ModelContext.new(Book, :url_slug))
+  class ModelContext
+    def initialize(scope, attr = :slug)
+      @scope = scope
+      @attr = attr
+      freeze
+    end
+
+    def include?(value)
+      @scope.exists?(@attr => value)
+    end
+  end
+end

data/lib/slug_fu/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module SlugFu
+  VERSION = "1.0.0"
+end

data/slug_fu.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slug_fu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slug_fu"
+  spec.version       = SlugFu::VERSION
+  spec.authors       = ["Bradley Schaefer"]
+  spec.email         = ["bradley.schaefer@gmail.com"]
+
+  spec.summary       = %q{Yet another gem for creating slugs from arbitrary strings}
+  spec.description   = %q{What sets this slug gem apart is its pluggable naming strategy and that it validates slug uniqueness}
+  spec.homepage      = "https://www.github.com/soulcutter/slug_fu"
+  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.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: slug_fu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bradley Schaefer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-30 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: What sets this slug gem apart is its pluggable naming strategy and that
+  it validates slug uniqueness
+email:
+- bradley.schaefer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slug_fu.rb
+- lib/slug_fu/default_naming_strategy.rb
+- lib/slug_fu/model_context.rb
+- lib/slug_fu/version.rb
+- slug_fu.gemspec
+homepage: https://www.github.com/soulcutter/slug_fu
+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.6
+signing_key: 
+specification_version: 4
+summary: Yet another gem for creating slugs from arbitrary strings
+test_files: []