sequel_slugging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 310373b02b1a7684421da3aa997f6f5d51625dd4
+  data.tar.gz: 91042267dcde3d42202c379738eadf4f49348838
+SHA512:
+  metadata.gz: a05a42095cafd32ed793514508cb8278ccb74c6f3a5178c674e6afed9f49e8fa10be67d79d3e325c00b285614f263fb9fe61e2be40bd5fc899895a884ff35d4e
+  data.tar.gz: e552e856cfe0d4fc2481defafef544c90a23f95dba45868f642a4cbd04021685c559991c9c6a2b1f0703c4228acb98578b3991588b826579e56c9763e25c412b

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.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Hanks
+Copyright (c) 2017 Joakim Nylén
+
+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,64 @@
+# Sequel::Slugging
+
+Slugging is a plugin for Sequel that creates slugs from names or similar with an built-in uuid fix for duplicates.
+
+This gem is quite similar to `friendly_id`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel_slugging', github: 'jnylen/sequel_slugging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-slugging
+
+## Usage
+
+Please look in the spec folder for examples.
+
+Basically it's just `plugin :slugging, source: :name` where name is the column you want to grab the slug from.
+
+## History
+
+You can keep a slug in history so you can still fetch it when it has changed.
+
+First you need to create a table using this:
+```ruby
+create_table :slug_history do
+  primary_key :id
+  text :slug, null: false
+  integer :sluggable_id, null: false
+  text :sluggable_type, null: false
+  timestamptz :created_at, null: false
+end
+```
+
+Then add `history: :slug_history` to your plugin line for slugging.
+
+## 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/jnylen/sequel_slugging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).
+
+## Authors
+
+Creator: [Chris Hanks](https://github.com/chanks/sequel-slugging)
+Maintainer: [Joakim Nylén](https://github.com/jnylen/sequel_slugging)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'spec' << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sequel/slugging'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sequel/plugins/slugging.rb

@@ -0,0 +1,190 @@
+require 'securerandom'
+require 'set'
+require 'babosa'
+
+require 'sequel/plugins/slugging/version'
+
+module Sequel
+  module Plugins
+    module Slugging
+      UUID_REGEX = /\A[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}\z/
+      INTEGER_REGEX = /\A\d{1,}\z/
+
+      class Error < StandardError; end
+
+      class << self
+        attr_writer :slugifier, :maximum_length
+
+        def slugifier
+          @slugifier ||= proc do |string|
+            string.to_slug.normalize.to_s
+          end
+        end
+
+        def maximum_length
+          @maximum_length ||= 50
+        end
+
+        attr_reader :reserved_words
+
+        def reserved_words=(value)
+          @reserved_words = Set.new(value)
+        end
+
+        def apply(model, opts = {})
+          model.instance_eval do
+            plugin :instance_hooks
+          end
+        end
+
+        def configure(model, source:, regenerate_slug: nil, history: nil)
+          model.instance_eval do
+            @slugging_opts = {source: source, regenerate_slug: regenerate_slug, history: history}.freeze
+          end
+        end
+      end
+
+      module ClassMethods
+        attr_reader :slugging_opts
+
+        Sequel::Plugins.inherited_instance_variables(self, :@slugging_opts => ->(h){h.dup.freeze})
+        Sequel::Plugins.def_dataset_methods(self, [:from_slug, :from_slug!])
+
+        def pk_type
+          schema = db_schema[primary_key]
+
+          if schema[:type] == :integer
+            :integer
+          elsif schema[:db_type] == 'uuid'.freeze
+            :uuid
+          else
+            raise "The sequel-slugging plugin can't handle this pk type: #{pk_schema.inspect}"
+          end
+        end
+      end
+
+      module InstanceMethods
+        private
+
+        def before_create
+          set_slug
+          super
+        end
+
+        def before_update
+          if p = self.class.slugging_opts[:regenerate_slug]
+            set_slug if instance_exec(&p)
+          end
+
+          super
+        end
+
+        def set_slug
+          self.slug = find_available_slug
+
+          if table = self.class.slugging_opts[:history]
+            after_save_hook do
+              db[table].insert(slug: slug, sluggable_id: pk, sluggable_type: self.class.to_s, created_at: Time.now)
+            end
+          end
+        end
+
+        def find_available_slug
+          candidates = []
+
+          Array(self.class.slugging_opts[:source]).each do |method_set|
+            candidate = Array(method_set).map{|meth| get_slug_component(meth)}.join(' ')
+            candidate = Sequel::Plugins::Slugging.slugifier.call(candidate)
+            candidate = candidate.slice(0...Sequel::Plugins::Slugging.maximum_length)
+
+            return candidate if acceptable_slug?(candidate)
+            candidates << candidate
+          end
+
+          candidates.each do |candidate|
+            return candidate << '-'.freeze << SecureRandom.uuid if acceptable_string?(candidate)
+          end
+
+          SecureRandom.uuid
+        end
+
+        def get_slug_component(method)
+          case component = send(method)
+          when NilClass, String then component
+          else raise Error, "unexpected slug component: #{component.inspect}"
+          end
+        end
+
+        def acceptable_slug?(slug)
+          return false unless acceptable_string?(slug)
+          reserved = Sequel::Plugins::Slugging.reserved_words
+          return false if reserved && reserved.include?(slug)
+
+          ds =
+            if history_table = self.class.slugging_opts[:history]
+              ds = db[history_table].where(slug: slug, sluggable_type: self.class.to_s)
+              # If the record already exists, don't consider its own slug to be 'taken'.
+              ds = ds.exclude(sluggable_id: pk) if pk
+              ds
+            else
+              ds = self.class.dataset.where(slug: slug)
+              # If the record already exists, don't consider its own slug to be 'taken'.
+              ds = ds.exclude(self.class.primary_key => pk) if pk
+              ds
+            end
+
+          ds.empty?
+        end
+
+        def acceptable_string?(string)
+          string && string != ''.freeze
+        end
+      end
+
+      module DatasetMethods
+        def from_slug!(pk_or_slug)
+          from_slug(pk_or_slug) || raise(Sequel::NoMatchingRow)
+        end
+
+        def from_slug(pk_or_slug)
+          pk = model.primary_key
+
+          case pk_type = model.pk_type
+          when :integer
+            case pk_or_slug
+            when Integer
+              where(pk => pk_or_slug).first
+            when String
+              if pk_or_slug =~ INTEGER_REGEX
+                where(pk => pk_or_slug.to_i).first
+              else
+                lookup_by_slug(pk_or_slug)
+              end
+            else
+              raise "Argument to Dataset#from_slug needs to be a String or Integer"
+            end
+          when :uuid
+            if record = lookup_by_slug(pk_or_slug)
+              record
+            elsif pk_or_slug =~ UUID_REGEX
+              where(pk => pk_or_slug).first
+            end
+          else
+            raise "Unexpected pk_type: #{pk_type.inspect}"
+          end
+        end
+
+        def lookup_by_slug(slug)
+          if history = model.slugging_opts[:history]
+            m = model
+            if pk = m.db[history].where(sluggable_type: m.to_s, slug: slug).get(:sluggable_id)
+              where(m.primary_key => pk).first
+            end
+          else
+            where(slug: slug).first
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/slugging/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module Slugging
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/sequel_slugging.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel/plugins/slugging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel_slugging'
+  spec.version       = Sequel::Plugins::Slugging::VERSION
+  spec.authors       = ["Chris Hanks", "Joakim Nylén"]
+  spec.email         = ['christopher.m.hanks@gmail.com', 'me@jnylen.nu']
+
+  spec.summary       = %q{This gem creates human-friendly string.}
+  spec.homepage      = 'https://github.com/jnylen/sequel-slugging'
+  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.10'
+  spec.add_development_dependency 'rake',           '~> 10.0'
+  spec.add_development_dependency 'minitest',       '~> 5.8.1'
+  spec.add_development_dependency 'minitest-hooks', '~> 1.2.0'
+
+  spec.add_dependency 'sequel', '~> 4.0'
+  spec.add_dependency 'babosa', '~> 1.0.2'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: sequel_slugging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hanks
+- Joakim Nylén
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.1
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: babosa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: 
+email:
+- christopher.m.hanks@gmail.com
+- me@jnylen.nu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sequel/plugins/slugging.rb
+- lib/sequel/plugins/slugging/version.rb
+- sequel_slugging.gemspec
+homepage: https://github.com/jnylen/sequel-slugging
+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.6.11
+signing_key: 
+specification_version: 4
+summary: This gem creates human-friendly string.
+test_files: []