slugs 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da5d1fa47f7e6e409576151a4968039e74a17100
-  data.tar.gz: 0361f871473aebf05e89564fc51ea8854ce78a85
+  metadata.gz: ed7eaf4b4b662abd59ca80f68a4b0eb218a8e112
+  data.tar.gz: f6b020ad3fbb60c5975c739831edab4becfe0f73
 SHA512:
-  metadata.gz: 10daebc764de1a327d05eabb6db3d5b80965501202331ce85bce8df271fe6354bf1f050dcdbd6baee2885f1bc0ac79be932f94df448e41bba8b27c6927c96ecf
-  data.tar.gz: 110090ea40a80b8df582caf2dd46e9e2820b797b899a07701c959b07b067e5eede960d39074c5e671d1a6846bdf97cb30b8d1fab95795e7ae7710e4f817bac9c
+  metadata.gz: 9522dbe0945c8951ab468c51309e206e260effdcaaac090d8925c4c18b28d1d5ebebe90e7e8575cbdee51665a0916c3f352846add52f3548c7651491a1623e85
+  data.tar.gz: ddb3e6688e11d140e0d87b13c6cb23ca2707d5e54868ecc18d1a09a38765aed3176cddc974662709234dbfbf13847b28fff3db45e66ddb9da35ca297e09a64d2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -17,8 +17,13 @@ end
 
 
 
+
+
 Bundler::GemHelper.install_tasks
 
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|

data/lib/slugs.rb

@@ -1,8 +1,40 @@
-require 'slugs/active_record/base'
-require 'slugs/active_record/non_translatable'
-require 'slugs/active_record/translatable'
-require 'slugs/active_record/finders'
+require 'slugs/extensions/action_dispatch/generator'
+require 'slugs/extensions/action_dispatch/optimized_url_helper'
+require 'slugs/extensions/active_record/base'
+require 'slugs/concern'
+require 'slugs/configuration'
 require 'slugs/railtie'
 
 module Slugs
+  class << self
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def parameterize(record, params)
+      if use_slug_for?(record, params)
+        if record.slug_changed?
+          record.slug_was
+        else
+          record.slug
+        end
+      else
+        record.to_param
+      end
+    end
+
+    def use_slug_for?(record, params)
+      if record.try(:sluggable?) && configuration.use_slug_proc
+        configuration.use_slug_proc.call record, params
+      else
+        false
+      end
+    end
+
+  end
 end

data/lib/slugs/concern.rb

@@ -0,0 +1,50 @@
+module Slugs
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :set_slug
+      after_save :ensure_slug_uniqueness
+      validates_format_of :slug, with: /\A[a-z0-9\-]+\z/, allow_blank: true
+      validates_length_of :slug, maximum: 255, allow_blank: true
+    end
+
+    def sluggable?
+      self.class.sluggable?
+    end
+
+    private
+
+    def set_slug
+      options = self.class.slug
+      self.slug = slice(*options[:attributes]).values.join(' ').parameterize
+    end
+
+    def ensure_slug_uniqueness
+      options = self.class.slug
+      case options[:scope]
+      when Symbol
+        attribute = options[:scope]
+        scope = { attribute => send(attribute) }
+      when Array
+        attributes = options[:scope]
+        scope = attributes.map{ |a| [a, send(a)] }.to_h
+      end
+      if self.class.where(scope).where(slug: slug).where.not(id: id).any?
+        update_column :slug, "#{slug}-#{id}"
+      end
+    end
+
+    module ClassMethods
+
+      def slug
+        @slug ||= {}
+      end
+
+      def sluggable?
+        slug.present?
+      end
+
+    end
+  end
+end

data/lib/slugs/configuration.rb

@@ -0,0 +1,7 @@
+module Slugs
+  class Configuration
+
+    attr_accessor :use_slug_proc
+
+  end
+end

data/lib/slugs/extensions/action_dispatch/generator.rb

@@ -0,0 +1,24 @@
+module Slugs
+  module Extensions
+    module ActionDispatch
+      module Generator
+
+        def generate
+          @set.formatter.generate(
+            named_route,
+            options,
+            recall,
+            lambda do |name, value|
+              if name == :controller
+                value
+              else
+                Slugs.parameterize value, options
+              end
+            end
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/slugs/extensions/action_dispatch/optimized_url_helper.rb

@@ -0,0 +1,20 @@
+module Slugs
+  module Extensions
+    module ActionDispatch
+      module OptimizedUrlHelper
+
+        private
+
+        def parameterize_args(args)
+          parameterized_args = args.map do |arg|
+            Slugs.parameterize arg, @options
+          end
+          params = {}
+          @required_parts.zip(parameterized_args) { |k,v| params[k] = v }
+          params
+        end
+
+      end
+    end
+  end
+end

data/lib/slugs/extensions/active_record/base.rb

@@ -0,0 +1,19 @@
+module Slugs
+  module Extensions
+    module ActiveRecord
+      module Base
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def has_slug(*args)
+            include Slugs::Concern
+            options = args.extract_options!
+            @slug = options.merge(attributes: args)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/slugs/railtie.rb

@@ -2,7 +2,15 @@ module Slugs
   class Railtie < Rails::Railtie
 
     initializer 'slugs' do
-      ::ActiveRecord::Base.send :include, Slugs::ActiveRecord::Base
+      ::ActionDispatch::Routing::RouteSet::NamedRouteCollection::UrlHelper::OptimizedUrlHelper.prepend(
+        Slugs::Extensions::ActionDispatch::OptimizedUrlHelper
+      )
+      ::ActionDispatch::Routing::RouteSet::Generator.prepend(
+        Slugs::Extensions::ActionDispatch::Generator
+      )
+      ::ActiveRecord::Base.include(
+        Slugs::Extensions::ActiveRecord::Base
+      )
     end
 
   end

data/lib/slugs/version.rb

@@ -1,5 +1,5 @@
 module Slugs
 
-  VERSION = '1.3.2'
+  VERSION = '2.0.0'
 
 end

data/test/dummy/Rakefile

@@ -2,5 +2,4 @@
 # 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
+Rails.application.load_tasks

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

@@ -2,12 +2,12 @@
 // 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.
+// or any plugin's vendor/assets/javascripts directory 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
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
 //= require_tree .

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

@@ -3,11 +3,13 @@
  * 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.
+ * or any plugin's vendor/assets/stylesheets directory 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.
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
  *
- *= require_self
  *= require_tree .
+ *= require_self
  */

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

@@ -0,0 +1,7 @@
+class Category < ActiveRecord::Base
+
+  belongs_to :shop
+
+  has_slug :name, scope: :shop_id
+
+end

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

@@ -0,0 +1,8 @@
+class Product < ActiveRecord::Base
+
+  belongs_to :shop
+  belongs_to :category
+
+  has_slug :name, scope: %i(shop_id category_id)
+
+end

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

@@ -0,0 +1,5 @@
+class Shop < ActiveRecord::Base
+
+  has_slug :name
+
+end

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

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+
+  has_slug :first_name, :last_name
+
+end

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

@@ -1,14 +1,12 @@
 <!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>
+  <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/rails

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

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts '== Installing dependencies =='
+  system 'gem install bundler --conservative'
+  system 'bundle check || bundle install'
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   system 'cp config/database.yml.sample config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system 'bin/rake db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system 'rm -f log/*'
+  system 'rm -rf tmp/cache'
+
+  puts "\n== Restarting application server =="
+  system 'touch tmp/restart.txt'
+end

data/test/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/test/dummy/config/application.rb

@@ -4,7 +4,6 @@ require 'rails/all'
 
 Bundler.require(*Rails.groups)
 require 'slugs'
-require 'translatable_records'
 
 module Dummy
   class Application < Rails::Application
@@ -19,5 +18,8 @@ module Dummy
     # 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
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
   end
 end

data/test/dummy/config/boot.rb

@@ -1,5 +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'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -1,25 +1,7 @@
-# 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
+  adapter: postgresql
+  database: slugs_development
 
-# 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: ":memory:"
-  pool: 5
-  timeout: 5000
-
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000
+  adapter: postgresql
+  database: slugs_test