simple_slug 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38033c0b797c80a5f1ea79325d95605f9f35dae9
+  data.tar.gz: 9bcc30728ffaaa925711bf374b94d359579a84aa
+SHA512:
+  metadata.gz: 2a2135bcbc5a5aa951989a6a073c692598ff1bbb7b73195347be469a749c14a1f65a24e93f9cbc553f12632dcf39b7cf8223cacb64e6c3c275cab6db0e82ce8e
+  data.tar.gz: 74200571bf0ca1c83747b034920c07fe432f24d9afb977caf89c61de3fe406bca3d5478ff4f208da967c668fb8de414c7fc6ee88fa7338e3d8e3ccd0648cd26e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+.idea
+.rspec
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Leschenko
+
+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,43 @@
+# SimpleSlug
+
+This is not a "bulldozer", this is just friendly id generator for ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_slug'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_slug
+
+## Usage
+
+Add basic slugs to your model:
+
+```ruby
+class User < ActiveRecord::Base
+  simple_slug :full_name
+end
+```
+
+Or with custom slug column and history:
+
+```ruby
+class User < ActiveRecord::Base
+  simple_slug :full_name, slug_column: 'my_slug_column', history: true
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/simple_slug/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 new Pull Request

data/Rakefile

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

data/db/migrate/20140113000001_create_simple_slug_history_slug.rb

@@ -0,0 +1,13 @@
+class CreateSimpleSlugHistorySlug < ActiveRecord::Migration
+  def change
+    create_table :simple_slug_history_slug do |t|
+      t.string :slug, null: false
+      t.integer :sluggable_id, null: false
+      t.string :sluggable_type, limit: 50, null: false
+      t.datetime :created_at
+    end
+
+    add_index :simple_slug_history_slug, [:slug, :sluggable_type], unique: true
+    add_index :simple_slug_history_slug, [:sluggable_type, :sluggable_id]
+  end
+end

data/lib/simple_slug/history_slug.rb

@@ -0,0 +1,5 @@
+module SimpleSlug
+  class HistorySlug < ActiveRecord::Base
+    belongs_to :sluggable, polymorphic: true
+  end
+end

data/lib/simple_slug/model_addition.rb

@@ -0,0 +1,113 @@
+module SimpleSlug
+  module ModelAddition
+    def self.included(base)
+      base.send :extend, SingletonMethods
+    end
+
+    module SingletonMethods
+      def simple_slug(*args)
+        class_attribute :simple_slug_options, instance_writer: false
+        options = args.extract_options!
+        self.simple_slug_options = options.reverse_merge(slug_column: SimpleSlug.slug_column, slug_method: args)
+
+        include InstanceMethods
+        extend ClassMethods
+
+        before_validation :simple_slug_generate, if: :should_generate_new_slug?
+        validates simple_slug_options[:slug_column],
+                  presence: true,
+                  exclusion: {in: SimpleSlug.excludes},
+                  format: {without: SimpleSlug.exclude_regexp}
+        if simple_slug_options[:history]
+          after_save :simple_slug_create_history_slug
+          after_destroy :simple_slug_cleanup_history
+          include InstanceHistoryMethods
+        end
+      end
+    end
+
+    module ClassMethods
+      def simple_slug_find(id_param)
+        return unless id_param
+        if id_param.is_a?(Integer) || id_param =~ /\A\d+\z/
+          find(id_param)
+        else
+          finder_method = simple_slug_options[:history] ? :find_by : :find_by!
+          send(finder_method, simple_slug_options[:slug_column] => id_param) or find(::SimpleSlug::HistorySlug.find_by!(slug: id_param).sluggable_id)
+        end
+      end
+
+      alias_method :friendly_find, :simple_slug_find
+    end
+
+    module InstanceMethods
+      def to_param
+        send(simple_slug_options[:slug_column]).presence || super
+      end
+
+      def should_generate_new_slug?
+        send(simple_slug_options[:slug_column]).blank? || simple_slug_options[:history]
+      end
+
+      def simple_slug_generate
+        simple_slug = simple_slug_normalize(simple_slug_base)
+        return true if simple_slug == send(simple_slug_options[:slug_column]).to_s.sub(/--\d+\z/, '')
+        resolved_simple_slug = simple_slug_resolve(simple_slug)
+        send "#{simple_slug_options[:slug_column]}=", resolved_simple_slug
+      end
+
+      def simple_slug_base
+        simple_slug_options[:slug_method].map{|m| send(m).to_s }.reject(&:blank?).join(' ')
+      end
+
+      def simple_slug_normalize(base)
+        normalized = I18n.transliterate(base).parameterize('-').downcase
+        normalized.to_s =~ /\A\d+/ ? "_#{normalized}" : normalized
+      end
+
+      def simple_slug_resolve(slug_value)
+        if simple_slug_exists?(slug_value)
+          loop do
+            slug_value_with_suffix = simple_slug_next(slug_value)
+            break slug_value_with_suffix unless simple_slug_exists?(slug_value_with_suffix)
+          end
+        else
+          slug_value
+        end
+      end
+
+      def simple_slug_next(slug_value)
+        "#{slug_value}--#{rand(99999)}"
+      end
+
+      def simple_slug_exists?(slug_value)
+        simple_slug_base_exists?(slug_value) || simple_slug_history_exists?(slug_value)
+      end
+
+      def simple_slug_base_exists?(slug_value)
+        base_scope = self.class.unscoped.where(simple_slug_options[:slug_column] => slug_value)
+        base_scope = base_scope.where('id != ?', id) if persisted?
+        base_scope.exists?
+      end
+
+      def simple_slug_history_exists?(slug_value)
+        return false unless simple_slug_options[:history]
+        base_scope = ::SimpleSlug::HistorySlug.where(sluggable_type: self.class.name, slug: slug_value)
+        base_scope = base_scope.where('sluggable_id != ?', id) if persisted?
+        base_scope.exists?
+      end
+    end
+
+    module InstanceHistoryMethods
+      def simple_slug_cleanup_history
+        ::SimpleSlug::HistorySlug.where(sluggable_type: self.class.name, sluggable_id: id).delete_all
+      end
+
+      def simple_slug_create_history_slug
+        return true unless slug_changed?
+        ::SimpleSlug::HistorySlug.where(sluggable_type: self.class.name, sluggable_id: id, slug: send(simple_slug_options[:slug_column])).first_or_create
+      end
+    end
+
+  end
+end

data/lib/simple_slug/railtie.rb

@@ -0,0 +1,11 @@
+module SimpleSlug
+  class Railtie < Rails::Railtie
+    initializer 'simple_slug.model_additions' do
+
+      ActiveSupport.on_load :active_record do
+        include SimpleSlug::ModelAddition
+      end
+
+    end
+  end
+end

data/lib/simple_slug/version.rb

@@ -0,0 +1,3 @@
+module SimpleSlug
+  VERSION = '0.0.1'
+end

data/lib/simple_slug.rb

@@ -0,0 +1,22 @@
+require 'simple_slug/version'
+require 'active_support/core_ext'
+require 'simple_slug/model_addition'
+require 'simple_slug/railtie' if Object.const_defined?(:Rails)
+
+module SimpleSlug
+  autoload :HistorySlug, 'simple_slug/history_slug'
+
+  mattr_accessor :excludes
+  @@excludes = %w(new edit show index session login logout sign_in sign_out users admin stylesheets assets javascripts images)
+
+  mattr_accessor :exclude_regexp
+  @@exclude_regexp = /\A\d+\z/
+
+  mattr_accessor :slug_column
+  @@slug_column = 'slug'
+
+  def self.setup
+    yield self
+  end
+
+end

data/simple_slug.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_slug/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_slug'
+  spec.version       = SimpleSlug::VERSION
+  spec.authors       = ['Alex Leschenko']
+  spec.email         = ['leschenko.al@gmail.com']
+  spec.summary       = %q{Simple slug generator with history.}
+  spec.description   = %q{This is not a "bulldozer. This is just friendly id generator fo ActiveRecord."}
+  spec.homepage      = 'https://github.com/leschenko/simple_slug'
+  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_dependency 'activerecord', '~> 4.0.0'
+  spec.add_dependency 'i18n', '~> 0.6.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/simple_slug/base_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SimpleSlug do
+  context 'defaults' do
+    it 'slug column' do
+      SimpleSlug.slug_column.should == 'slug'
+    end
+
+    it 'excludes' do
+      SimpleSlug.excludes.should include('new', 'edit')
+    end
+
+    it 'exclude regexps' do
+      SimpleSlug.exclude_regexp.should == /\A\d+\z/
+    end
+  end
+end

data/spec/simple_slug/history_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+class SlugHistoryRspecModel < RspecActiveModelBase
+  simple_slug :name, history: true
+end
+
+describe 'slug history' do
+  describe 'history records handling' do
+    before do
+      SlugHistoryRspecModel.any_instance.stub(:simple_slug_exists?).and_return(false)
+    end
+
+    it 'create' do
+      relation = double
+      ::SimpleSlug::HistorySlug.should_receive(:where).once.ordered.with(sluggable_type: 'SlugHistoryRspecModel', sluggable_id: 1, slug: 'hello').and_return(relation)
+      relation.should_receive(:first_or_create)
+      SlugHistoryRspecModel.create(id: 1, name: 'Hello')
+    end
+
+    it 'cleanup' do
+      relation = double
+      relation.stub(:first_or_create)
+      ::SimpleSlug::HistorySlug.stub(:where).and_return(relation)
+      relation.should_receive(:delete_all)
+      SlugHistoryRspecModel.create(name: 'Hello', id: 1).destroy
+    end
+  end
+
+  describe 'conflicts' do
+    it 'history slug exists' do
+      record = SlugGenerationRspecModel.new(name: 'Hi')
+      record.stub(:simple_slug_base_exists?).and_return(false)
+      record.should_receive(:simple_slug_history_exists?).once.ordered.and_return(true)
+      record.should_receive(:simple_slug_history_exists?).once.ordered.and_return(false)
+      record.save
+      record.slug.should start_with('hi--')
+    end
+  end
+
+  describe '#friendly_find' do
+    before do
+      SlugHistoryRspecModel.stub(:find_by)
+    end
+
+    it 'find from history' do
+      record = double('history')
+      record.stub(:sluggable_id).and_return(1)
+      ::SimpleSlug::HistorySlug.should_receive(:find_by!).with(slug: 'title').and_return(record)
+      SlugHistoryRspecModel.should_receive(:find).with(1).and_return(record)
+      SlugHistoryRspecModel.friendly_find('title')
+    end
+  end
+
+end

data/spec/simple_slug/model_addition_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class SlugGenerationRspecModel < RspecActiveModelBase
+  simple_slug :name
+end
+
+describe SimpleSlug::ModelAddition do
+  describe 'slug generation' do
+    before do
+      SlugGenerationRspecModel.any_instance.stub(:simple_slug_exists?).and_return(false)
+    end
+
+    it 'after save' do
+      SlugGenerationRspecModel.create(name: 'Hello').slug.should == 'hello'
+    end
+
+    it 'skip excludes' do
+      SlugGenerationRspecModel.new(name: 'new').should_not be_valid
+    end
+
+    it 'skip integers' do
+      SlugGenerationRspecModel.new(name: '123').should_not be_valid
+    end
+
+    it 'skip slug generation' do
+      SlugGenerationRspecModel.any_instance.stub(:should_generate_new_slug?).and_return(false)
+      SlugGenerationRspecModel.create(name: 'Hello').slug.should be_blank
+    end
+  end
+
+  describe 'resolve conflicts' do
+    it 'duplicate slug' do
+      record = SlugGenerationRspecModel.new(name: 'Hi')
+      record.should_receive(:simple_slug_exists?).once.ordered.with('hi').and_return(true)
+      record.should_receive(:simple_slug_exists?).once.ordered.with(/hi--\d+/).and_return(false)
+      record.save
+      record.slug.should start_with('hi--')
+    end
+
+    it 'numeric slug' do
+      record = SlugGenerationRspecModel.new(name: '123')
+      record.should_receive(:simple_slug_exists?).with('_123').and_return(false)
+      record.save
+      record.slug.should == '_123'
+    end
+  end
+
+  describe '#to_param' do
+    before do
+      SlugGenerationRspecModel.any_instance.stub(:simple_slug_exists?).and_return(false)
+    end
+
+    it 'slug if exists' do
+      SlugGenerationRspecModel.create(name: 'Hello').to_param.should == 'hello'
+    end
+
+    it 'id without slug' do
+      SlugGenerationRspecModel.create(id: 1).to_param.should == '1'
+    end
+  end
+
+  describe '#friendly_find' do
+    it '#find if integer like' do
+      SlugGenerationRspecModel.should_receive(:find).with(1)
+      SlugGenerationRspecModel.friendly_find(1)
+    end
+
+    it '#find if numeric string' do
+      SlugGenerationRspecModel.should_receive(:find).with('1')
+      SlugGenerationRspecModel.friendly_find('1')
+    end
+
+    it 'find by slug' do
+      SlugGenerationRspecModel.should_receive(:find_by!).with('slug' => 'title').and_return(double)
+      SlugGenerationRspecModel.friendly_find('title')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+require 'i18n'
+require 'active_support/core_ext'
+require 'simple_slug'
+
+# just silence warning
+I18n.enforce_available_locales = false
+
+class RspecActiveModelBase
+  include ActiveModel::Model
+  include ActiveModel::AttributeMethods
+  extend ActiveModel::Callbacks
+
+  include SimpleSlug::ModelAddition
+
+  define_model_callbacks :validation, :save, :destroy
+
+  attr_accessor :id, :slug, :name, :created_at
+
+  def self.create(attributes, *)
+    record = new(attributes)
+    record.save
+    record
+  end
+
+  def save
+    run_callbacks(:validation) { run_callbacks(:save) { } }
+  end
+
+  def destroy
+    run_callbacks(:destroy) { @destroyed = true }
+  end
+
+  def persisted?
+    true
+  end
+
+  def slug_changed?
+    slug.present?
+  end
+
+  def destroyed?
+    !!@destroyed
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: simple_slug
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Leschenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: This is not a "bulldozer. This is just friendly id generator fo ActiveRecord."
+email:
+- leschenko.al@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/migrate/20140113000001_create_simple_slug_history_slug.rb
+- lib/simple_slug.rb
+- lib/simple_slug/history_slug.rb
+- lib/simple_slug/model_addition.rb
+- lib/simple_slug/railtie.rb
+- lib/simple_slug/version.rb
+- simple_slug.gemspec
+- spec/simple_slug/base_spec.rb
+- spec/simple_slug/history_spec.rb
+- spec/simple_slug/model_addition_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/leschenko/simple_slug
+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.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Simple slug generator with history.
+test_files:
+- spec/simple_slug/base_spec.rb
+- spec/simple_slug/history_spec.rb
+- spec/simple_slug/model_addition_spec.rb
+- spec/spec_helper.rb