slugs 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00e75d7a3a7e005f39790db95f1053626859c9dc
+  data.tar.gz: 92fb5f77bee8f71dd8be53eb6a07a1c9c217c9cd
+SHA512:
+  metadata.gz: a6fe58b872f2914c9356a1db8101f79f6bec94846254b0a087d558a56ac83ddf4a46bc2ada764b2f9f3d1418d6f65d6b45b4bd78e85ae064947baff0df735d25
+  data.tar.gz: 140603af972f5750aaa335e672352847e9bf1ed058558d5a891729144411e974fb01b4455a82755642f2f271a2e7ac2a5804ec1443e34dd44414b500480b95b6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Mattways
+
+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.rdoc

@@ -0,0 +1,34 @@
+{<img src="https://codeclimate.com/github/mattways/slugs.png" />}[https://codeclimate.com/github/mattways/slugs] {<img src="https://secure.travis-ci.org/mattways/slugs.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/slugs] {<img src="https://gemnasium.com/mattways/slugs.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/slugs]
+
+= Slugs
+
+Inspired in friendly_id but more minimalistic.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'slugs'
+  
+Then bundle:
+  $ bundle
+  
+= Usage
+
+Add the column in your migration:
+  t.string :slug
+
+(If you are using translatable_records you need to place the column in the translation table, this has been done this way because it’s easier to maintain and your queries will be faster avoiding extra joins)  
+
+Update your db:
+  rake db:migrate
+
+Call the slug method in your model:
+
+If you want to use the value of one field:
+  slug :prop
+  
+To concatenate the value of multiple fields:
+  slug :prop1, :prop2, :prop3
+  
+Or if you need a very custom slug you can use a lambda, proc or block:
+  slug proc { |record| "#{record.prop}-custom" }

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Slugs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/slugs/active_record/base.rb

@@ -0,0 +1,76 @@
+module Slugs
+  module ActiveRecord
+    module Base
+      extend ActiveSupport::Concern
+
+      def to_param
+        self.class.sluggable? ? (slug_changed? ? slug_was : slug) : super
+      end
+
+      protected
+
+      def assign_slug
+        if slug.nil? or not slug_changed?
+          options = self.class.slug
+          case options
+          when Symbol
+            value = send(options)
+          when Array
+            value = options.each.map{ |p| send(p) }.join(' ')
+          else
+            value = options.call(self) if options.respond_to? :call
+          end
+          if value.present?
+            value = value.parameterize
+            previous_value = previous_slug?(value)
+            if previous_value != false
+              if previous_value.present?
+                index = Regexp.new(value + '-(\d+)$').match(previous_value)
+                if index.present?
+                  value << "-#{index[1].to_i + 1}"
+                else
+                  value << '-1'
+                end
+              end
+              self.slug = value
+            end
+          end
+        end
+      end
+
+      module ClassMethods
+
+        def inherited(subclass)
+          subclass.instance_variable_set(:@slug, @slug)
+          super
+        end
+        
+        def sluggable?
+          !defined?(@slug).nil? and @slug.present?
+        end
+        
+        def slug(*args, &block)
+          if block_given? or args.any?
+            unless sluggable?
+              if respond_to? :translatable? and translatable?
+                include Slugs::ActiveRecord::Translatable
+                attr_translatable :slug 
+                before_validation :generate_slugs
+              else
+                include Slugs::ActiveRecord::NonTranslatable
+                before_validation :generate_slug
+              end
+              if block_given?
+                @slug = block
+              else
+                @slug = args.size == 1 ? args[0] : args                              
+              end
+            end
+          end
+          @slug
+        end
+      
+      end
+    end
+  end
+end

data/lib/slugs/active_record/non_translatable.rb

@@ -0,0 +1,30 @@
+module Slugs
+  module ActiveRecord 
+    module NonTranslatable
+      extend ActiveSupport::Concern
+
+      protected
+      
+      def previous_slug?(slug)
+        r = self.class.where(
+          "(slug = '#{slug}' OR slug LIKE '#{slug}-_')"
+        ).order(
+          'slug DESC'
+        ).first
+        r.respond_to?(:slug) ? (r == self ? false : r.slug) : nil
+      end
+
+      def generate_slug
+        assign_slug
+      end
+
+      module ClassMethods
+
+        def exists_by_slug(id)
+          exists? slug: id
+        end
+    
+      end
+    end
+  end
+end

data/lib/slugs/active_record/relation.rb

@@ -0,0 +1,18 @@
+module Slugs
+  module ActiveRecord
+    module Relation
+      extend ActiveSupport::Concern
+
+      def find_one(id)
+        r = (sluggable? and id.is_a? String) ? find_by_slug(id) : nil
+        r.nil? ? super : r
+      end
+
+      def exists?(id = false)
+        r = (sluggable? and id.is_a? String) ? exists_by_slug(id) : nil
+        r.nil? ? super : r
+      end
+
+    end
+  end
+end

data/lib/slugs/active_record/translatable.rb

@@ -0,0 +1,53 @@
+module Slugs
+  module ActiveRecord 
+    module Translatable
+      extend ActiveSupport::Concern
+    
+      protected
+
+      def change_locale(locale)
+        I18n.locale = locale
+        with_locale locale
+      end
+
+      def previous_slug?(slug)
+        t = self.class.reflect_on_association(:translations)
+        r = self.class.joins(
+          "INNER JOIN #{t.table_name} t ON t.#{t.foreign_key} = #{self.class.table_name}.#{t.active_record_primary_key}"
+        ).where(
+          "(t.slug = '#{slug}' OR t.slug LIKE '#{slug}-_') AND t.locale = '#{I18n.locale.to_s}'"
+        ).order(
+          't.slug DESC'
+        ).first
+        r.respond_to?(:slug) ? (r == self ? false : r.slug) : nil
+      end
+
+      def generate_slugs
+        locale = current_locale
+        I18n.available_locales.each do |locale|
+          change_locale locale
+          assign_slug
+        end
+        change_locale locale
+      end
+
+      module ClassMethods
+
+        def find_by_slug(id)
+          t = reflect_on_association(:translations)
+          joins(
+            "INNER JOIN #{t.table_name} t ON t.#{t.foreign_key} = #{table_name}.#{t.active_record_primary_key}"
+          ).where(
+            "t.slug = '#{id}' AND t.locale = '#{I18n.locale.to_s}'"
+          ).readonly(false).first
+        end
+        
+        def exists_by_slug(id)
+          t = reflect_on_association(:translations)
+          joins(:translations).exists? t.table_name.to_sym => { slug: id, locale: I18n.locale }
+        end
+
+      end      
+    end
+  end
+end

data/lib/slugs/railtie.rb

@@ -0,0 +1,10 @@
+module Slugs
+  class Railtie < Rails::Railtie
+
+    initializer 'slugs' do
+      ::ActiveRecord::Relation.send :include, Slugs::ActiveRecord::Relation
+      ::ActiveRecord::Base.send :include, Slugs::ActiveRecord::Base
+    end
+
+  end
+end

data/lib/slugs/version.rb

@@ -0,0 +1,5 @@
+module Slugs
+
+  VERSION = '1.1.0'
+
+end

data/lib/slugs.rb

@@ -0,0 +1,9 @@
+require 'slugs/active_record/base'
+require 'slugs/active_record/non_translatable'
+require 'slugs/active_record/translatable'
+require 'slugs/active_record/relation'
+require 'slugs/railtie'
+require 'slugs/version'
+
+module Slugs
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/simple.rb

@@ -0,0 +1,5 @@
+class Simple < ActiveRecord::Base
+
+  slug :name
+
+end

data/test/dummy/app/models/translatable.rb

@@ -0,0 +1,7 @@
+class Translatable < ActiveRecord::Base
+
+  attr_translatable :name, :age
+
+  slug :name
+
+end

data/test/dummy/app/models/translatable_translation.rb

@@ -0,0 +1,9 @@
+class TranslatableTranslation < ActiveRecord::Base
+  
+  belongs_to :translatables
+  
+  validates :locale, presence: true    
+  validates :locale, inclusion: { in: I18n.available_locales.map(&:to_s) }
+  validates :translatable_id, uniqueness: { scope: :locale }  
+  
+end

data/test/dummy/app/models/without.rb

@@ -0,0 +1,2 @@
+class Without < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "slugs"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!