slugs 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed7eaf4b4b662abd59ca80f68a4b0eb218a8e112
-  data.tar.gz: f6b020ad3fbb60c5975c739831edab4becfe0f73
+  metadata.gz: 21b9bbbfe8b2a44f63ffb7edf8eaa22fe97cf6ce
+  data.tar.gz: 41e5ec36704f1c403c4cb62030cdbc83dc4e8fb9
 SHA512:
-  metadata.gz: 9522dbe0945c8951ab468c51309e206e260effdcaaac090d8925c4c18b28d1d5ebebe90e7e8575cbdee51665a0916c3f352846add52f3548c7651491a1623e85
-  data.tar.gz: ddb3e6688e11d140e0d87b13c6cb23ca2707d5e54868ecc18d1a09a38765aed3176cddc974662709234dbfbf13847b28fff3db45e66ddb9da35ca297e09a64d2
+  metadata.gz: 1096e6bdcdb42b39622b0a8175c9c2fe7928b1d29e09fd2c4eedf5d1b59745dc871d653f4279cf7277a935632e935ee13dabd573c684034ea4bb6839fd465bc1
+  data.tar.gz: 072aa30a88b10abad83b03a6b45fb65fc383af4d1c3a9e7495822d7d8778fe13e3f8d727b73a020d439f5347d203a19c4fe24536373ec800f5d4006a0185ac81

data/README.md

@@ -5,7 +5,7 @@
 
 # Slugs
 
-Minimalistic slugs inspired in friendly_id for rails.
+Manages slugs for records with minimal efford in rails.
 
 ## Install
 
@@ -21,6 +21,11 @@ $ bundle
 
 ## Configuration
 
+Generate the slugs configuration file:
+```
+bundle exec rails g slugs:install
+```
+
 Add the slug column to the tables of the models you want to have slugs:
 ```ruby
 t.string :slug
@@ -28,10 +33,17 @@ t.string :slug
 
 Update your db:
 ```
-rake db:migrate
+bundle exec rake db:migrate
 ```
 
-NOTE: If you are using translatable_records you need to place the column in the translations table.
+Configure the proc to decide which records will be slugged:
+```ruby
+Slugs.configure do |config|
+  config.use_slug_proc = Proc.new do |record, params|
+    params[:controller] != 'admin'
+  end
+end
+```
 
 ## Usage
 
@@ -47,18 +59,11 @@ To concatenate the value of multiple fields:
 has_slug :prop1, :prop2, :prop3
 ```
 
-If you need a very custom slug you can use a lambda, proc or block:
-```ruby
-has_slug proc { |record| "#{record.prop}-custom" }
-```
-
 To find a record by slug:
 ```ruby
-Model.slugged.find 'slug'
+Model.find_by slug: 'slug'
 ```
 
-NOTE: All the path and url helpers will start using the slug by default.
-
 ## Credits
 
 This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).

data/lib/generators/slugs/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+
+module Cronjobs
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_definitions_file
+        copy_file 'configuration.rb', 'config/initializers/slugs.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/slugs/templates/configuration.rb

@@ -0,0 +1,7 @@
+Slugs.configure do |config|
+
+  config.use_slug_proc = Proc.new do |record, params|
+    # Add your code here
+  end
+
+end

data/lib/slugs/version.rb

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

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

@@ -1,5 +1,7 @@
 Slugs.configure do |config|
+
   config.use_slug_proc = Proc.new do |record, params|
     true
   end
+
 end

data/test/dummy/log/test.log

@@ -4188,3 +4188,75 @@ RoutesTest: test_optimized_url_helper
    (0.2ms)  SELECT COUNT(*) FROM "shops" WHERE "shops"."slug" = $1 AND ("shops"."id" != $2)  [["slug", "guitar-shop"], ["id", 234]]
    (0.1ms)  RELEASE SAVEPOINT active_record_1
    (0.2ms)  ROLLBACK
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (0.3ms)  BEGIN
+------------------------------------
+GeneratorsTest: test_file_generation
+------------------------------------
+   (0.2ms)  ROLLBACK
+   (0.1ms)  BEGIN
+----------------------
+RecordsTest: test_save
+----------------------
+   (0.1ms)  SAVEPOINT active_record_1
+  SQL (0.4ms)  INSERT INTO "users" ("first_name", "last_name", "slug") VALUES ($1, $2, $3) RETURNING "id"  [["first_name", "Zakk"], ["last_name", "Wylde"], ["slug", "zakk-wylde"]]
+   (0.3ms)  SELECT COUNT(*) FROM "users" WHERE "users"."slug" = $1 AND ("users"."id" != $2)  [["slug", "zakk-wylde"], ["id", 48]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+   (0.1ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  UPDATE "users" SET "slug" = $1 WHERE "users"."id" = $2  [["slug", "yngwie-malmsteen"], ["id", 48]]
+   (0.2ms)  SELECT COUNT(*) FROM "users" WHERE "users"."slug" = $1 AND ("users"."id" != $2)  [["slug", "yngwie-malmsteen"], ["id", 48]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+   (0.2ms)  ROLLBACK
+   (0.1ms)  BEGIN
+----------------------------
+RecordsTest: test_uniqueness
+----------------------------
+   (0.2ms)  SAVEPOINT active_record_1
+  SQL (0.3ms)  INSERT INTO "shops" ("name", "slug") VALUES ($1, $2) RETURNING "id"  [["name", "Guitar Shop"], ["slug", "guitar-shop"]]
+   (0.2ms)  SELECT COUNT(*) FROM "shops" WHERE "shops"."slug" = $1 AND ("shops"."id" != $2)  [["slug", "guitar-shop"], ["id", 235]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+   (0.1ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  INSERT INTO "shops" ("name", "slug") VALUES ($1, $2) RETURNING "id"  [["name", "Guitar Shop"], ["slug", "guitar-shop"]]
+   (0.2ms)  SELECT COUNT(*) FROM "shops" WHERE "shops"."slug" = $1 AND ("shops"."id" != $2)  [["slug", "guitar-shop"], ["id", 236]]
+  SQL (0.2ms)  UPDATE "shops" SET "slug" = 'guitar-shop-236' WHERE "shops"."id" = $1  [["id", 236]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+  Shop Load (0.3ms)  SELECT  "shops".* FROM "shops"  ORDER BY "shops"."id" DESC LIMIT 1
+   (0.2ms)  SAVEPOINT active_record_1
+  SQL (0.3ms)  INSERT INTO "categories" ("name", "shop_id", "slug") VALUES ($1, $2, $3) RETURNING "id"  [["name", "Gibson"], ["shop_id", 236], ["slug", "gibson"]]
+   (0.2ms)  SELECT COUNT(*) FROM "categories" WHERE "categories"."shop_id" = $1 AND "categories"."slug" = $2 AND ("categories"."id" != $3)  [["shop_id", 236], ["slug", "gibson"], ["id", 98]]
+   (0.2ms)  RELEASE SAVEPOINT active_record_1
+   (0.2ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  INSERT INTO "categories" ("name", "shop_id", "slug") VALUES ($1, $2, $3) RETURNING "id"  [["name", "Gibson"], ["shop_id", 236], ["slug", "gibson"]]
+   (0.2ms)  SELECT COUNT(*) FROM "categories" WHERE "categories"."shop_id" = $1 AND "categories"."slug" = $2 AND ("categories"."id" != $3)  [["shop_id", 236], ["slug", "gibson"], ["id", 99]]
+  SQL (0.2ms)  UPDATE "categories" SET "slug" = 'gibson-99' WHERE "categories"."id" = $1  [["id", 99]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+  Category Load (0.2ms)  SELECT  "categories".* FROM "categories"  ORDER BY "categories"."id" DESC LIMIT 1
+   (0.1ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  INSERT INTO "products" ("name", "shop_id", "category_id", "slug") VALUES ($1, $2, $3, $4) RETURNING "id"  [["name", "Les Paul"], ["shop_id", 236], ["category_id", 99], ["slug", "les-paul"]]
+   (0.2ms)  SELECT COUNT(*) FROM "products" WHERE "products"."shop_id" = $1 AND "products"."category_id" = $2 AND "products"."slug" = $3 AND ("products"."id" != $4)  [["shop_id", 236], ["category_id", 99], ["slug", "les-paul"], ["id", 94]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+   (0.1ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  INSERT INTO "products" ("name", "shop_id", "category_id", "slug") VALUES ($1, $2, $3, $4) RETURNING "id"  [["name", "Les Paul"], ["shop_id", 236], ["category_id", 99], ["slug", "les-paul"]]
+   (0.2ms)  SELECT COUNT(*) FROM "products" WHERE "products"."shop_id" = $1 AND "products"."category_id" = $2 AND "products"."slug" = $3 AND ("products"."id" != $4)  [["shop_id", 236], ["category_id", 99], ["slug", "les-paul"], ["id", 95]]
+  SQL (0.3ms)  UPDATE "products" SET "slug" = 'les-paul-95' WHERE "products"."id" = $1  [["id", 95]]
+   (0.1ms)  RELEASE SAVEPOINT active_record_1
+  Product Load (0.2ms)  SELECT  "products".* FROM "products"  ORDER BY "products"."id" DESC LIMIT 1
+   (0.2ms)  ROLLBACK
+   (0.1ms)  BEGIN
+--------------------------
+RoutesTest: test_generator
+--------------------------
+   (0.1ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  INSERT INTO "shops" ("name", "slug") VALUES ($1, $2) RETURNING "id"  [["name", "Guitar Shop"], ["slug", "guitar-shop"]]
+   (0.2ms)  SELECT COUNT(*) FROM "shops" WHERE "shops"."slug" = $1 AND ("shops"."id" != $2)  [["slug", "guitar-shop"], ["id", 237]]
+   (0.2ms)  RELEASE SAVEPOINT active_record_1
+   (0.2ms)  ROLLBACK
+   (0.1ms)  BEGIN
+-------------------------------------
+RoutesTest: test_optimized_url_helper
+-------------------------------------
+   (0.2ms)  SAVEPOINT active_record_1
+  SQL (0.2ms)  INSERT INTO "shops" ("name", "slug") VALUES ($1, $2) RETURNING "id"  [["name", "Guitar Shop"], ["slug", "guitar-shop"]]
+   (0.2ms)  SELECT COUNT(*) FROM "shops" WHERE "shops"."slug" = $1 AND ("shops"."id" != $2)  [["slug", "guitar-shop"], ["id", 238]]
+   (0.2ms)  RELEASE SAVEPOINT active_record_1
+   (0.1ms)  ROLLBACK

data/test/generator_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+require 'rails/generators'
+require 'generators/slugs/install_generator'
+
+class GeneratorsTest < Rails::Generators::TestCase
+
+  tests Cronjobs::Generators::InstallGenerator
+  destination Rails.root.join('tmp')
+
+  teardown do
+    FileUtils.rm_rf destination_root
+  end
+
+  test 'file generation' do
+    run_generator
+    assert_file 'config/initializers/slugs.rb'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slugs
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - mmontossi
@@ -54,6 +54,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/slugs/install_generator.rb
+- lib/generators/slugs/templates/configuration.rb
 - lib/slugs.rb
 - lib/slugs/concern.rb
 - lib/slugs/configuration.rb
@@ -108,6 +110,7 @@ files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
+- test/generator_test.rb
 - test/records_test.rb
 - test/routes_test.rb
 - test/test_helper.rb
@@ -182,6 +185,7 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/Rakefile
+- test/generator_test.rb
 - test/records_test.rb
 - test/routes_test.rb
 - test/test_helper.rb