sluggable-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 524d66a481f56da389dd239d9e1895c11e20740e
+  data.tar.gz: 5758997da24026a3fa780337259ea7b4315ba6bc
+SHA512:
+  metadata.gz: 66477a7d225c4d090f567069bd91974af60e4acc26bb424c16da812ee0bef86afaa54cd1f848408032b2344387108ef8b3e04b2a197b1b315f8eb24dbb670fa7
+  data.tar.gz: 48a5b48fb9b44e51df0753172db659dd6a215280e370368104d0a1f9ec424b608dd67786c9eae28254f6468c93a029f33fa736a53cc04993fe5ee4019ecc30e9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Julien Dargelos
+
+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,55 @@
+# Sluggable Rails
+Provide a unique slug to your records, generated from the attribute of your choice.
+
+## Usage
+Use the `has_slug` method:
+
+```ruby
+# == Schema Information
+#
+# Table name: Post
+#
+#  id         :integer          not null, primary key
+#  title      :string
+#  slug       :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+class Post < ActiveRecord::Base
+  has_slug by: :title
+end
+```
+
+In this example, the slug will be generated from the post title. By default, it will be stored in the slug attribute.
+You can choose another attribute to store it:
+
+```ruby
+has_slug :custom_attribute, by: :title
+```
+
+The slug is generated with the [`parameterize` method](http://api.rubyonrails.org/v5.1/classes/ActiveSupport/Inflector.html#method-i-parameterize), you can specify a separator as it excepts (default: `'-'`):
+
+```ruby
+has_slug :custom_attribute, by: :title, separator: '_'
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sluggable-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sluggable-rails
+```
+
+## 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,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sluggable::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/sluggable/core_ext.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Base.instance_eval do
+  before_save :update_slugs
+
+  def has_slug attribute = :slug, by:, separator: '-'
+    slug_definitions.add attribute, origin: by, separator: separator
+    validates attribute, presence: true, uniqueness: true
+  end
+
+  def slug_definitions
+    @slug_definitions ||= Sluggable::Rails::Definitions.new
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  def slugs
+    self.class.slug_definitions.slugs from: self
+  end
+
+  protected
+
+  def update_slugs
+    slugs.each { |slug| slug.update if slug.needs_an_update? }
+  end
+end

data/lib/sluggable/rails/definition.rb

@@ -0,0 +1,21 @@
+class Sluggable::Rails::Definition
+  attr_reader :attribute, :origin, :separator
+
+  def initialize(attribute = :slug, origin:, separator: '-')
+    self.attribute = attribute
+    self.origin = origin
+    self.separator = separator
+  end
+
+  def attribute=(v)
+    @attribute = v.to_s.to_sym
+  end
+
+  def origin=(v)
+    @origin = v.to_s.to_sym
+  end
+
+  def separator=(v)
+    @separator = v.to_s
+  end
+end

data/lib/sluggable/rails/definitions.rb

@@ -0,0 +1,19 @@
+class Sluggable::Rails::Definitions
+  def initialize
+    @definitions = {}
+  end
+
+  def [](attribute)
+    @definitions[attribute.to_s.to_sym]
+  end
+
+  def add attribute = :slug, origin:, separator: '-'
+    @definitions[attribute.to_s.to_sym] = Sluggable::Rails::Definition.new attribute, origin: origin, separator: separator
+  end
+
+  def slugs from:
+    slugs = Sluggable::Rails::Slugs.new
+    @definitions.each { |_, definition| slugs.add definition, from }
+    slugs
+  end
+end

data/lib/sluggable/rails/slug.rb

@@ -0,0 +1,70 @@
+class Sluggable::Rails::Slug < String
+  attr_accessor :definition, :record
+  attr_reader :offset
+
+  def initialize(definition, record)
+    self.definition = definition
+    self.record = record
+  end
+
+  def update
+    if make
+      record.send "#{definition.attribute}=", self.to_s
+      true
+    else
+      false
+    end
+  end
+
+  def make
+    if makeable?
+      @offset = 0
+      generate until present? && unique?
+      true
+    else
+      false
+    end
+  end
+
+  def base
+    String.try_convert(record.send(definition.origin)).to_s.parameterize separator: definition.separator
+  end
+
+  def makeable?
+    definition.is_a?(Sluggable::Rails::Definition) && record.is_a?(ActiveRecord::Base)
+  end
+
+  def shifted?
+    !offset.zero?
+  end
+
+  def changed?
+    record.send "#{definition.origin}_changed?"
+  end
+
+  def undefined?
+    record.send(definition.attribute).blank?
+  end
+
+  def needs_an_update?
+    undefined? || changed?
+  end
+
+  protected
+
+  def generate
+    clear
+    insert 0, base
+    insert -1, (empty? ? '' : definition.separator) + offset.to_s if shifted?
+    shift
+  end
+
+  def shift
+    @offset += 1
+  end
+
+  def unique?
+    found = record.class.find_by definition.attribute => self.to_s
+    !found || found.id == record.id
+  end
+end

data/lib/sluggable/rails/slugs.rb

@@ -0,0 +1,13 @@
+class Sluggable::Rails::Slugs
+  def initialize
+    @slugs = []
+  end
+
+  def add definition, record
+    @slugs << Sluggable::Rails::Slug.new(definition, record)
+  end
+
+  def each &block
+    @slugs.each &block
+  end
+end

data/lib/sluggable/rails/version.rb

@@ -0,0 +1,5 @@
+module Sluggable
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/lib/sluggable/rails.rb

@@ -0,0 +1,9 @@
+module Sluggable
+  module Rails
+    require 'sluggable/rails/definition'
+    require 'sluggable/rails/definitions'
+    require 'sluggable/rails/slug'
+    require 'sluggable/rails/slugs'
+    require 'sluggable/core_ext'
+  end
+end

data/lib/tasks/sluggable/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sluggable_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: sluggable-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Dargelos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Provide a unique slug to your records, generated from the attribute of
+  your choice.
+email:
+- contact@juliendargelos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sluggable/core_ext.rb
+- lib/sluggable/rails.rb
+- lib/sluggable/rails/definition.rb
+- lib/sluggable/rails/definitions.rb
+- lib/sluggable/rails/slug.rb
+- lib/sluggable/rails/slugs.rb
+- lib/sluggable/rails/version.rb
+- lib/tasks/sluggable/rails_tasks.rake
+homepage: https://www.github.com/juliendargelos/sluggable-rails
+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.13
+signing_key: 
+specification_version: 4
+summary: Slugify your rails records.
+test_files: []