superslug 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bb95a3918571a903c9a509d9c946b210574a044
-  data.tar.gz: ab49423eea4705981fe6f92b3313c6101449b417
+  metadata.gz: 2f0ee11116381b3e24a955f962973bda7198984b
+  data.tar.gz: a10c2275d5ebc3475f2c95633e13595d1ecd34b3
 SHA512:
-  metadata.gz: 42be65db36d8de0dd0f295172faa5c5663ffd37ce4fbd32cd5f210e9792c6992c83a0a1e0515423dcb2dfd6a8644c0f7e01ecfd664e3d98510f8ff7b64fc2a93
-  data.tar.gz: ca55bbda8233c591f3367886019d06e85e68e7977596fd8b1da9a0e6cfe90708334f28a34dca92cd76ae93d4c9bd8bde4c3af08bf55f30454ccc7d8b3078e21f
+  metadata.gz: 5b25d0056ce67fa436c15a7813873a57767429f6329a2ce99564fa7625f4fe417084db1138a2753b6de42e74ffae9755302ec4957393f07edf24402f7023a25c
+  data.tar.gz: dad171b682434a8d8ec046c27a474570ade5dbb8d449b901774c7575779111731b08373d83b89483c40ee85f753cb3e4dec550dcd25746f8e0d2161fe7db7636

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle/
+pkg/

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in mark_it_zero.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    superslug (1.0.0)
+      rails (~> 4.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.10)
+      actionpack (= 4.1.10)
+      actionview (= 4.1.10)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.10)
+      actionview (= 4.1.10)
+      activesupport (= 4.1.10)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.10)
+      activesupport (= 4.1.10)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.10)
+      activesupport (= 4.1.10)
+      builder (~> 3.1)
+    activerecord (4.1.10)
+      activemodel (= 4.1.10)
+      activesupport (= 4.1.10)
+      arel (~> 5.0.0)
+    activesupport (4.1.10)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.5)
+    minitest (5.6.0)
+    rack (1.5.2)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.1.10)
+      actionmailer (= 4.1.10)
+      actionpack (= 4.1.10)
+      actionview (= 4.1.10)
+      activemodel (= 4.1.10)
+      activerecord (= 4.1.10)
+      activesupport (= 4.1.10)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.10)
+      sprockets-rails (~> 2.0)
+    railties (4.1.10)
+      actionpack (= 4.1.10)
+      activesupport (= 4.1.10)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    sprockets (3.0.2)
+      rack (~> 1.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  superslug!

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2015 Warren Harrison, Sean C Davis
+
+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,80 @@
+SuperSlug
+==========
+
+SuperSlug handles automatic generation of slugs (permalinks) for your rails
+models
+
+Installation
+----------
+
+This gem is meant to work with Ruby on Rails projects. I recommend you add it
+to your project's Gemfile:
+
+```ruby
+gem 'superslug'
+```
+
+Then install your bundle:
+
+```text
+$ bundle
+```
+
+Usage
+----------
+
+All you need are two columns on an Active Record model. I use `title` and
+`slug` by default, but you can use whatever you want.
+
+> Note: It's always faster to use string columns unless you absolutely have to
+> use text.
+
+When you have your columns, just add the `has_superslug` method into your
+model.
+
+```ruby
+has_superslug(source = :title, dest = :slug, options = {})
+```
+
+The `source` column is the column *from which you want to generate the slug*,
+while the destination (dest) column is *where the sluggified string is stored*.
+
+### Options
+
+The only option is `separator`, which defines the character with which to fill
+blank spaces in the string. For example, if it is a hyphen, then `Hello World`
+becomes `hello-world`. See below for an example.
+
+### Example
+
+If you have a `Page` model that has a `name` and a `permalink` column, and you
+want to use underscore separators, then your model would look like this:
+
+```ruby
+class Page < ActiveRecord::Base
+  has_superslug :name, :permalink, :separator => '_'
+end
+```
+
+### Query Helpers
+
+When you add the `has_superslug` method to your model, you also get a couple helpers.
+
+First, SuperSlug assumes you are doing this to make friendly URLs, so it adds a
+`to_param` method and uses your destination column for the parameter. Rails
+uses the `id` attribute by default.
+
+And second, the `find` method on an Active Record class using SuperSlug checks
+for the slug first. Using the example above, if you ran `Page.find('hello-
+world')`, it would check for pages with `permalink` matching `hello-world`, and
+not the ID (which is the default).
+
+
+Contributing
+----------
+
+1. Fork it ( https://github.com/[my-github-username]/cambium/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 a new Pull Request

data/Rakefile

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

data/lib/superslug.rb

@@ -1,4 +1,5 @@
 require 'superslug/version'
 require 'superslug/superslug'
+
 module SuperSlug
-end
+end

data/lib/superslug/superslug.rb

@@ -1,59 +1,64 @@
-module SuperSlug
-  extend ActiveSupport::Concern
+class << ActiveRecord::Base
 
-  included do
-    after_save :sluggify_slug
+  def has_superslug(source = :title, dest = :slug, options = {})
 
-    def self.find(input)
+    source = source.to_s
+    dest   = dest.to_s
+
+    # ---------------------------------------- Query Helpers
+
+    def find(input)
       if input.class == Array
         super
       else
         input.to_i.to_s == input.to_s ? super : find_by_slug(input)
       end
     end
-  end
 
-  def sluggify_slug
-    if slug.blank?
-      update_column(:slug, create_slug)
-    else
-      new_slug = slug.gsub(/[^a-zA-Z0-9 \-]/, "") # remove all bad characters
-      new_slug.gsub!(/\ /, "-") # replace spaces with underscores
-      new_slug.gsub!(/\-+/, "-") # replace repeating underscores
-      update_column(:slug, new_slug) unless slug == new_slug
+    define_method "to_param" do
+      send(dest)
     end
-  end
 
-  def create_slug
-    slug = self.title.downcase.gsub(/\&/, ' and ') # & -> and
-    slug.gsub!(/[^a-zA-Z0-9 \-]/, "") # remove all bad characters
-    slug.gsub!(/\ /, "-") # replace spaces with underscores
-    slug.gsub!(/\-+/, "-") # replace repeating underscores
+    # ---------------------------------------- Validations
 
-    dups = self.class.name.constantize.where(:slug => slug)
-    if dups.count == 1 and dups.first != self
-      if self.try(:idx)
-        slug = "#{slug}-#{self.idx}"
-      else
-        slug = "#{slug}-#{self.id}"
-      end
-    end
-    slug
-  end
+    validates :"#{source}", :presence => true
 
-  def make_slug_unique(slug)
-    dups = self.class.name.constantize.where(:slug => slug)
-    if dups.count == 1 and dups.first != self
-      if self.try(:idx)
-        slug = "#{slug}-#{self.idx}"
-      else
-        slug = "#{slug}-#{self.id}"
+    # ---------------------------------------- Callbacks
+
+    after_save :"convert_#{source}_to_#{dest}"
+
+    define_method "convert_#{source}_to_#{dest}" do
+      # reference the separator option
+      separator = options[:separator].present? ? options[:separator] : '-'
+      # Set the slug column to the source column if it's
+      # empty
+      superslug = send(dest).blank? ? self.send(source) : self.send(dest)
+      # make lower case
+      superslug = superslug.downcase
+      # replace ampersands with 'and'
+      superslug.gsub!(/\&/, ' and ')
+      # remove all bad characters
+      # (we allow hyphens, underscores, and plus marks)
+      superslug.gsub!(/[^a-zA-Z0-9 \-\_\+]/, "")
+      # replace spaces with underscores
+      superslug.gsub!(/\ /, separator)
+      # replace repeating underscores
+      superslug.gsub!(/#{separator}+/, separator)
+      # Find all records with the same slug value for the
+      # slug column
+      duplicates = self.class.name.constantize.where(dest.to_sym => superslug)
+      # Append the ID to the end of the slug if the slug
+      # column is already taken
+      if (duplicates - [self]).size > 0
+        superslug = "#{superslug}#{separator}#{self.id}"
+      end
+      # Update the column in the database unless it matches
+      # what's already there
+      unless superslug == self.send(dest)
+        update_columns(dest.to_sym => superslug)
       end
     end
-    slug
-  end
 
-  def to_param
-    slug
   end
-end
+
+end

data/lib/superslug/version.rb

@@ -1,3 +1,3 @@
 module SuperSlug
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/superslug.gemspec

@@ -1,13 +1,22 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'superslug/version'
-Gem::Specification.new do |s|
-  s.name        = 'superslug'
-  s.version     = SuperSlug::VERSION
-  s.summary     = "Slugs, yo!"
-  s.description = "A simple gem to autocreate slugs"
-  s.authors     = ['Warren Harrison','Sean Davis']
-  s.email       = ['warren@hungry-media.com','scdavis41@gmail.com']
-  s.files       = `git ls-files -z`.split("\x0")
-  s.license       = 'MIT'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'superslug'
+  spec.version     = SuperSlug::VERSION
+  spec.authors     = ['Warren Harrison','Sean Davis']
+  spec.email       = ['warren@hungry-media.com','scdavis41@gmail.com']
+  spec.homepage    = "https://github.com/seancdavis/mark_it_zero"
+  spec.summary     = "Automate slug creation in your rails app"
+  spec.description = ""
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 4.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: superslug
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Warren Harrison
@@ -9,9 +9,37 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
-dependencies: []
-description: A simple gem to autocreate slugs
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: ''
 email:
 - warren@hungry-media.com
 - scdavis41@gmail.com
@@ -19,11 +47,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
 - lib/superslug.rb
 - lib/superslug/superslug.rb
 - lib/superslug/version.rb
 - superslug.gemspec
-homepage: 
+homepage: https://github.com/seancdavis/mark_it_zero
 licenses:
 - MIT
 metadata: {}
@@ -46,5 +80,5 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Slugs, yo!
+summary: Automate slug creation in your rails app
 test_files: []