sluggi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e34bbe2f4b5982b3866ede14c2df9c616cd2e96
-  data.tar.gz: 61c5635cd1e788d9d9acadb875abeb0a7a4ab2fd
+  metadata.gz: 1d47ac0cb584d36352b4ac43a1e2f7fc7cde0b85
+  data.tar.gz: a62c76432d186ab0024492c686fc45cb505f6768
 SHA512:
-  metadata.gz: 086b5ecf2710ebf4ed4679b26611e8ba4e500047a184341a7ff4e5658f61f12ebd09d149507f164f837b74542f28a7419c787c04ee2a3a7175f03f593d02ca78
-  data.tar.gz: 0052170046dc4116492555ab5f0a9d2760637b5123e9ab809f6a8d883224b00a73e79f0c3942fade85a7b19ea501e7ba8eaadbd200098462d882d43f03511e74
+  metadata.gz: 7584d82c191aa1c70e35c8ff16c1d0bc39c286340f9a01fb299e9e542b0fe6099bc89c9d55f3bc1147a45bfdf205b9d58d346b58ede60ef2e26e8c418a096ee0
+  data.tar.gz: f9740626f5c05f675848f399fecd486f296e957420fb52cb726346e47428915e3a185a71dd84261d7e8b834431ac394c3eb755ef802c9a1a1e40ccd4ce3e8a01

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.2
+  - 2.1.4
   - 2.0.0
   - 1.9.3

data/README.md

@@ -20,13 +20,7 @@ gem 'sluggi'
 Add a string column named `slug` to any models you want to slug. You can generate a migration like so:
 
 ```sh
-rails generate migration AddSlugToCats slug:string
-```
-```ruby
-# edit the migration to add a unique index:
-add_index :cats, :slug, unique: true
-```
-```sh
+rails generate migration AddSlugToCats slug:string:uniq:index
 rake db:migrate
 ```
 

data/lib/sluggi.rb

@@ -1,5 +1,9 @@
 require "sluggi/version"
 require "sluggi/slug"
 require "sluggi/history"
+require "sluggi/validate_exclusion_of"
+require "sluggi/validate_presence"
+require "sluggi/validate_uniqueness"
+require "sluggi/model"
 require "sluggi/slugged"
 require "sluggi/generators/sluggi_generator"

data/lib/sluggi/history.rb

@@ -3,7 +3,12 @@ module Sluggi
     extend ActiveSupport::Concern
 
     included do
-      has_many :slugs, -> { order('slugs.id DESC') }, class_name: 'Sluggi::Slug', as: :sluggable, dependent: :destroy
+      has_many :slugs,
+        -> { order('slugs.id DESC') },
+        class_name: 'Sluggi::Slug',
+        as: :sluggable,
+        dependent: :destroy
+
       after_save :create_slug
     end
 

data/lib/sluggi/model.rb

@@ -0,0 +1,52 @@
+module Sluggi
+  module Model
+    extend ActiveSupport::Concern
+
+    NOT_IMPLEMENTED_MESSAGE = 'You must implement #slug_value_changed? '\
+      'and either #slug_value or #slug_candidates'.freeze
+
+    included do
+      before_validation :set_slug
+    end
+
+    def to_param
+      slug_was
+    end
+
+  private
+
+    def clean_slug(value)
+      value.try :parameterize
+    end
+
+    def set_slug
+      return unless new_record? || slug_value_changed?
+      new_slug = clean_slug(slug_value)
+      return if new_slug.blank?
+      self.slug = new_slug
+    end
+
+    # these are generally good to override:
+
+    def slug_value
+      slug_candidates.each do |value|
+        next if value.blank?
+        candidate = clean_slug(value)
+        return candidate if candidate == slug
+        return candidate unless self.class.exists?(slug: candidate)
+      end
+      nil
+    end
+
+    # return an array of candidate slug values
+    # Example:
+    #   [first_name, full_name, id_and_full_name]
+    def slug_candidates
+      raise NotImplementedError, NOT_IMPLEMENTED_MESSAGE
+    end
+
+    def slug_value_changed?
+      raise NotImplementedError, NOT_IMPLEMENTED_MESSAGE
+    end
+  end
+end

data/lib/sluggi/slugged.rb

@@ -1,77 +1,11 @@
 module Sluggi
   module Slugged
     extend ActiveSupport::Concern
-
-    RESERVED_SLUGS = %w(
-      create
-      edit
-      index
-      new
-      update
-      admin
-      assets
-      images
-      javascripts
-      login
-      logout
-      stylesheets
-      session
-      users
-    )
-
-    NOT_IMPLEMENTED_MESSAGE = 'You must implement #slug_value_changed? and either #slug_value or #slug_candidates'
-
     included do
-      before_validation :set_slug
-      validates :slug, presence: true, uniqueness: true
-      validates_exclusion_of :slug, in: ->(_) { reserved_slugs }
+      include Sluggi::ValidatePresence
+      include Sluggi::ValidateUniqueness
+      include Sluggi::ValidateExclusionOf
+      include Sluggi::Model
     end
-
-    module ClassMethods
-      def reserved_slugs
-        RESERVED_SLUGS
-      end
-    end
-
-    def to_param
-      slug_was
-    end
-
-  private
-
-    def clean_slug(value)
-      value.try :parameterize
-    end
-
-    def set_slug
-      return unless new_record? || slug_value_changed?
-      new_slug = clean_slug(slug_value)
-      return if new_slug.blank?
-      self.slug = new_slug
-    end
-
-    # these are generally good to override:
-
-    def slug_value
-      slug_candidates.each do |value|
-        next if value.blank?
-        candidate = clean_slug(value)
-        return candidate if candidate == slug
-        return candidate unless self.class.exists?(slug: candidate)
-      end
-      nil
-    end
-
-    # return an array of candidate slug values
-    # Example:
-    #   [first_name, full_name, id_and_full_name]
-    def slug_candidates
-      raise NotImplementedError.new(NOT_IMPLEMENTED_MESSAGE)
-    end
-
-    def slug_value_changed?
-      raise NotImplementedError.new(NOT_IMPLEMENTED_MESSAGE)
-    end
-
   end
 end

data/lib/sluggi/validate_exclusion_of.rb

@@ -0,0 +1,32 @@
+module Sluggi
+  module ValidateExclusionOf
+    extend ActiveSupport::Concern
+
+    RESERVED_SLUGS = %w(
+      admin
+      assets
+      create
+      edit
+      images
+      index
+      javascripts
+      login
+      logout
+      new
+      session
+      stylesheets
+      update
+      users
+    )
+
+    included do
+      validates_exclusion_of :slug, in: ->(_) { reserved_slugs }
+    end
+
+    module ClassMethods
+      def reserved_slugs
+        RESERVED_SLUGS
+      end
+    end
+  end
+end

data/lib/sluggi/validate_presence.rb

@@ -0,0 +1,9 @@
+module Sluggi
+  module ValidatePresence
+    extend ActiveSupport::Concern
+
+    included do
+      validates :slug, presence: true
+    end
+  end
+end

data/lib/sluggi/validate_uniqueness.rb

@@ -0,0 +1,9 @@
+module Sluggi
+  module ValidateUniqueness
+    extend ActiveSupport::Concern
+
+    included do
+      validates :slug, uniqueness: true
+    end
+  end
+end

data/lib/sluggi/version.rb

@@ -1,3 +1,3 @@
 module Sluggi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/model_test.rb

@@ -0,0 +1,73 @@
+require "test_helper"
+
+class ModelTest < MiniTest::Spec
+  class IncompleteCat < ActiveRecord::Base
+    self.table_name = 'cats'
+    include Sluggi::Model
+  end
+
+  class Cat < ActiveRecord::Base
+    include Sluggi::Model
+
+    def slug_value
+      name
+    end
+
+    def slug_value_changed?
+      name_changed?
+    end
+  end
+
+  class CandidateCat < ActiveRecord::Base
+    self.table_name = 'cats'
+    include Sluggi::Model
+
+    def slug_candidates
+      [nil, name]
+    end
+
+    def slug_value_changed?
+      name_changed?
+    end
+  end
+
+  it "raises when slug_value is not implemented" do
+    assert_raises(NotImplementedError) do
+      IncompleteCat.new.valid?
+    end
+  end
+
+  describe "#to_param" do
+    before do
+      Cat.delete_all
+      @cat = Cat.new(name: 'Tuxedo Stan')
+    end
+
+    it "is nil when new" do
+      assert_nil @cat.to_param
+    end
+
+    it "is the slug when persisted" do
+      @cat.save!
+      assert_equal 'tuxedo-stan', @cat.to_param
+    end
+
+    it "is the old slug when changed but not saved" do
+      @cat.save!
+      @cat.slug = 'ketzel'
+      assert_equal 'tuxedo-stan', @cat.to_param
+    end
+  end
+
+  it "sets slug from candidates on validation" do
+    cat = CandidateCat.new(name: 'Smokey')
+    assert cat.valid?
+    assert_equal 'smokey', cat.slug
+  end
+
+  it "sets slug on validation" do
+    cat = Cat.new(name: 'Prince Chunk')
+    assert cat.valid?
+    assert_equal 'prince-chunk', cat.slug
+  end
+end

data/test/slugged_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class SluggedTest < MiniTest::Spec
-  class ::Cat < ActiveRecord::Base
+  class Cat < ActiveRecord::Base
     include Sluggi::Slugged
 
     def slug_value
@@ -13,93 +13,19 @@ class SluggedTest < MiniTest::Spec
     end
   end
 
-  class ::CandidateCat < ActiveRecord::Base
-    self.table_name = 'cats'
-    include Sluggi::Slugged
-
-    def slug_candidates
-      [nil, name]
-    end
-
-    def slug_value_changed?
-      name_changed?
-    end
-  end
-
-  class ::IncompleteCat < ActiveRecord::Base
-    self.table_name = 'cats'
-    include Sluggi::Slugged
-  end
-
-  it "raises when slug_value is not implemented" do
-    assert_raises(NotImplementedError) do
-      IncompleteCat.new.valid?
-    end
-  end
-
-  describe "#to_param" do
-    before do
-      Cat.delete_all
-      @cat = Cat.new(name: 'Tuxedo Stan')
-    end
-
-    it "is nil when new" do
-      assert_nil @cat.to_param
-    end
-
-    it "is the slug when persisted" do
-      @cat.save!
-      assert_equal 'tuxedo-stan', @cat.to_param
-    end
-
-    it "is the old slug when changed but not saved" do
-      @cat.save!
-      @cat.slug = 'ketzel'
-      assert_equal 'tuxedo-stan', @cat.to_param
-    end
+  it "includes ValidatePresence" do
+    assert Cat.new.is_a? Sluggi::ValidatePresence
   end
 
-  describe ".reserved_slugs" do
-    %w(create login users).each do |word|
-      it "includes #{word}" do
-        assert_includes Cat.reserved_slugs, word
-      end
-    end
-
-    it "does not include valid slug" do
-      refute_includes Cat.reserved_slugs, 'something'
-    end
+  it "includes ValidateUniqueness" do
+    assert Cat.new.is_a? Sluggi::ValidateUniqueness
   end
 
-  describe "validation" do
-    it "reserved slug is invalid" do
-      refute Cat.new(name: 'edit').valid?
-    end
-
-    it "blank slug is invalid" do
-      refute Cat.new(name: '').valid?
-    end
-
-    it "sets slug on validation" do
-      cat = Cat.new(name: 'Prince Chunk')
-      assert cat.valid?
-      assert_equal 'prince-chunk', cat.slug
-    end
-
-    it "is invalid when slug is taken" do
-      Cat.create(slug: 'mrs-chippy')
-      cat = Cat.new(name: 'Mrs. Chippy')
-      refute cat.valid?
-      assert_nil cat.to_param
-    end
+  it "includes ValidateExclusionOf" do
+    assert Cat.new.is_a? Sluggi::ValidateExclusionOf
   end
 
-  describe "candidates" do
-    it "sets slug from candidates on validation" do
-      cat = CandidateCat.new(name: 'Smokey')
-      assert cat.valid?
-      assert_equal 'smokey', cat.slug
-    end
+  it "includes Model" do
+    assert Cat.new.is_a? Sluggi::Model
   end
-
 end

data/test/validate_presence_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+class ValidatePresenceTest < MiniTest::Spec
+  class Cat < ActiveRecord::Base
+    include Sluggi::ValidatePresence
+  end
+
+  it "validates presence of slug" do
+    refute Cat.new(slug: '').valid?
+    assert Cat.new(slug: 'foo').valid?
+  end
+end

data/test/validate_uniqueness_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class ValidateUniquenessTest < MiniTest::Spec
+  class Cat < ActiveRecord::Base
+    include Sluggi::Model
+    include Sluggi::ValidateUniqueness
+
+    def slug_value
+      name
+    end
+
+    def slug_value_changed?
+      name_changed?
+    end
+  end
+
+  it "validates slug is unique" do
+    Cat.create(slug: 'mrs-chippy')
+    cat = Cat.new(name: 'Mrs. Chippy')
+    refute cat.valid?
+    assert_nil cat.to_param
+  end
+
+end

data/test/validates_exclusion_of_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class ValidatesExclusionOfTest < MiniTest::Spec
+  class Cat < ActiveRecord::Base
+    include Sluggi::ValidateExclusionOf
+  end
+
+  describe ".reserved_slugs" do
+    %w(create login users).each do |word|
+      it "includes #{word}" do
+        assert_includes Cat.reserved_slugs, word
+      end
+    end
+
+    it "does not include valid slug" do
+      refute_includes Cat.reserved_slugs, 'something'
+    end
+  end
+
+  describe "validation" do
+    it "ensures slug is not a reserved word" do
+      refute Cat.new(slug: 'edit').valid?
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sluggi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -97,15 +97,23 @@ files:
 - lib/sluggi/generators/sluggi_generator.rb
 - lib/sluggi/history.rb
 - lib/sluggi/migrations/create_slugs.rb
+- lib/sluggi/model.rb
 - lib/sluggi/slug.rb
 - lib/sluggi/slugged.rb
+- lib/sluggi/validate_exclusion_of.rb
+- lib/sluggi/validate_presence.rb
+- lib/sluggi/validate_uniqueness.rb
 - lib/sluggi/version.rb
 - sluggi.gemspec
 - test/generator_test.rb
 - test/history_test.rb
+- test/model_test.rb
 - test/slug_test.rb
 - test/slugged_test.rb
 - test/test_helper.rb
+- test/validate_presence_test.rb
+- test/validate_uniqueness_test.rb
+- test/validates_exclusion_of_test.rb
 homepage: https://github.com/neighborland/sluggi
 licenses:
 - MIT
@@ -126,14 +134,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Rails Slug Generator
 test_files:
 - test/generator_test.rb
 - test/history_test.rb
+- test/model_test.rb
 - test/slug_test.rb
 - test/slugged_test.rb
 - test/test_helper.rb
+- test/validate_presence_test.rb
+- test/validate_uniqueness_test.rb
+- test/validates_exclusion_of_test.rb
 has_rdoc: