friendly_id-mobility 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3beb3b78d2d0e0eccbc1405b0869f7b102c90e21
-  data.tar.gz: dbe2b5819a7451ab66b1108aa5a3822d5190b480
+  metadata.gz: 69b790ec58bf14c3f05856bd1389093cadcdb1ef
+  data.tar.gz: 0aeace157739811519eac99348a10a71174ba40e
 SHA512:
-  metadata.gz: 4b2b51f41c697f16c0288824bd589af0bd377cabfccf4dc366fbb859c37c8f06af68c086bb6c6971095f81cebd3b396d95587041033d96d1a8113afff7aecd65
-  data.tar.gz: 1d810d14699b41e9ab04797820b2531fb94f75fa33f28b19d1c4f3bf9e54d347ade8ff5f6baa34413593463b9993c23b8ec3565d760e21d6dddbc802bce61918
+  metadata.gz: 72fe6766c35581feccb09092fda83af5c23fae059394a2b4baf8460e1127ce9ccb403a1c86de7a8878b52ad7726fbe34e5068754300b7afe01622cfe173572dd
+  data.tar.gz: c1cd04afb40ab7c4b96c27407a3daa1b0468e10bffd34ced4807bbee18264a8440a2be283039da0531e4b409e63a55ceeaf4fab5b001208e3b77f24ad6b4a233

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# FriendlyId Mobility Changelog
+
+## 0.3
+
+### 0.3.0
+* Add support for history module ([#2](https://github.com/shioyama/friendly_id-mobility/pull/2))
+
+## 0.2.0
+* Add support for translated slugs and translated base attributes
+
+## 0.1.0
+* Mixin Mobility scope into FriendlyId scope
+
+
+
+

data/Gemfile

@@ -10,4 +10,6 @@ group :development, :test do
 
   gem 'pry'
   gem 'pry-byebug'
+
+  gem 'guard-rspec'
 end

data/Gemfile.lock

@@ -1,13 +1,26 @@
 PATH
   remote: .
   specs:
-    friendly_id-mobility (0.1.0)
+    friendly_id-mobility (0.2.0)
       friendly_id (>= 5.0.0, <= 5.3.0)
       mobility (~> 0.1.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
     activemodel (5.0.2)
       activesupport (= 5.0.2)
     activerecord (5.0.2)
@@ -20,19 +33,54 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (7.1.4)
+    builder (3.2.3)
     byebug (9.0.6)
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     database_cleaner (1.5.3)
     diff-lcs (1.3)
+    erubis (2.7.0)
+    ffi (1.9.18)
+    formatador (0.2.5)
     friendly_id (5.2.0)
       activerecord (>= 4.0.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     i18n (0.8.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.11)
     method_source (0.8.2)
+    mini_portile2 (2.1.0)
     minitest (5.10.1)
     mobility (0.1.12)
       i18n (>= 0.6.10)
       request_store (~> 1.0)
+    nenv (0.3.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -40,7 +88,24 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
     request_store (1.3.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -55,8 +120,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
     slop (3.6.0)
     sqlite3 (1.3.13)
+    thor (0.19.4)
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
@@ -68,6 +136,8 @@ DEPENDENCIES
   bundler (~> 1.12)
   database_cleaner (~> 1.5.3)
   friendly_id-mobility!
+  generator_spec (~> 0.9.3)
+  guard-rspec
   pry
   pry-byebug
   rake

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -16,7 +16,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'friendly_id-mobility', '~> 0.2.0'
+gem 'friendly_id-mobility', '~> 0.3.0'
 ```
 
 And then execute:
@@ -126,7 +126,7 @@ locale.
 ### Friendly Finders with Translated Attributes
 
 The Mobility `i18n` scope is mixed into the `friendly` scope for models which
-`use: mobility`, so you can find translated slugs just like you would an
+`use: :mobility`, so you can find translated slugs just like you would an
 untranslated one:
 
 ```ruby
@@ -138,6 +138,35 @@ Article.friendly.find("mon-titre-foo")
 #=> #<Article id: 1 ...>
 ```
 
+### Slug History
+
+To use the FriendlyId history module, use `use: [:history, :mobility]` when
+calling `friendly_id` from your model:
+
+```ruby
+class Article < ActiveRecord::Base
+  include Mobility
+  translates :slug, :title, dirty: true
+
+  extend FriendlyId
+  friendly_id :title, use: [:history, :mobility]
+end
+```
+
+It is important to have `:history` *before* `:mobility` here, since the
+Mobility module looks for the presence of the history module and only adds
+necessary overrides if history has been enabled (so the reverse order will not
+work).
+
+To use the history feature, you must add a `locale` column to your
+`friendly_id_slugs` table, which you can do with the `friendly_id_mobility` generator:
+
+```
+rails generate friendly_id_mobility
+```
+
+Then run the generated migration with `rake db:migrate`.
+
 Contributing
 ------------
 

data/lib/friendly_id/mobility.rb

@@ -1,11 +1,17 @@
 require "friendly_id"
 require "friendly_id/mobility/version"
+require "friendly_id/slug_decorator"
 
 module FriendlyId
   module Mobility
     class << self
       def setup(model_class)
         model_class.friendly_id_config.use :slugged
+        if model_class.friendly_id_config.uses? :history
+          model_class.instance_eval do
+            friendly_id_config.finder_methods = FriendlyId::Mobility::FinderMethods
+          end
+        end
       end
 
       def included(model_class)
@@ -51,5 +57,14 @@ module FriendlyId
         end
       end
     end)
+
+    module FinderMethods
+      include ::FriendlyId::History::FinderMethods
+
+      def exists_by_friendly_id?(id)
+        where(friendly_id_config.query_field => id).exists? ||
+          joins(:slugs).where(slug_history_clause(id)).exists?
+      end
+    end
   end
 end

data/lib/friendly_id/mobility/version.rb

@@ -1,5 +1,5 @@
 module FriendlyId
   module Mobility
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/friendly_id/slug_decorator.rb

@@ -0,0 +1,12 @@
+require "friendly_id"
+
+# This override must handle both the situation where locale column has been
+# added to the slugs table, and also the situation where it has not.
+#
+FriendlyId::Slug.class_eval do
+  default_scope { column_names.include?("locale") ? where(locale: ::Mobility.locale) : all }
+
+  before_save do
+    self.locale ||= ::Mobility.locale if respond_to?(:locale=)
+  end
+end

data/lib/generators/friendly_id_mobility_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+
+class FriendlyIdMobilityGenerator < ::Rails::Generators::Base
+  include ::Rails::Generators::Migration
+
+  desc "Generates migration to add locale column to friendly_id_slugs table."
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(dirname)
+    ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+
+  def create_migration_file
+    template = "add_locale_to_friendly_id_slugs"
+    migration_dir = File.expand_path("db/migrate")
+    if self.class.migration_exists?(migration_dir, template)
+      ::Kernel.warn "Migration already exists."
+    else
+      migration_template "migration.rb", "db/migrate/#{template}.rb"
+    end
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,11 @@
+class AddLocaleToFriendlyIdSlugs < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :friendly_id_slugs, :locale, :string, null: :false, after: :scope
+
+    remove_index :friendly_id_slugs, [:slug, :sluggable_type]
+    add_index :friendly_id_slugs, [:slug, :sluggable_type, :locale], length: { slug: 140, sluggable_type: 50, locale: 2 }
+    remove_index :friendly_id_slugs, [:slug, :sluggable_type, :scope]
+    add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope, :locale], length: { slug: 70, sluggable_type: 50, scope: 70, locale: 2 }, unique: true, name: :index_friendly_id_slugs_unique
+    add_index :friendly_id_slugs, :locale
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id-mobility
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-08 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mobility
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 description: 
 email:
 - chris@dejimata.com
@@ -107,14 +121,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/friendly_id/mobility.rb
 - lib/friendly_id/mobility/version.rb
+- lib/friendly_id/slug_decorator.rb
+- lib/generators/friendly_id_mobility_generator.rb
+- lib/generators/templates/migration.rb
 homepage: https://github.com/shioyama/friendly_id-mobility
 licenses:
 - MIT