friendly_id-mobility 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b795a77df5b0754c68965a8edcaab982dbf16156
-  data.tar.gz: 45f876b1fbd1390214ee2435406a8c018dadfc76
+  metadata.gz: 3beb3b78d2d0e0eccbc1405b0869f7b102c90e21
+  data.tar.gz: dbe2b5819a7451ab66b1108aa5a3822d5190b480
 SHA512:
-  metadata.gz: f52c7b45cce67256652debbe82f843d465f2d6a80624645b811397dc037225fca021a82e607a18dc358bed13169d099a32ba1083846e7acd297ba26cdc59457f
-  data.tar.gz: d3b91e56dfb308bd22d1f4a670a7c17ef5393f484aa38f4b31f5a5aa84b7685646f541a1e03bac252120b40ba8cf5da7d4762e616bf795e764598b6665fdc7ee
+  metadata.gz: 4b2b51f41c697f16c0288824bd589af0bd377cabfccf4dc366fbb859c37c8f06af68c086bb6c6971095f81cebd3b396d95587041033d96d1a8113afff7aecd65
+  data.tar.gz: 1d810d14699b41e9ab04797820b2531fb94f75fa33f28b19d1c4f3bf9e54d347ade8ff5f6baa34413593463b9993c23b8ec3565d760e21d6dddbc802bce61918

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in friendly_id-mobility.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake'
+
+  gem 'sqlite3'
+
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -20,15 +20,26 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (7.1.4)
+    byebug (9.0.6)
+    coderay (1.1.1)
     concurrent-ruby (1.0.5)
+    database_cleaner (1.5.3)
     diff-lcs (1.3)
     friendly_id (5.2.0)
       activerecord (>= 4.0.0)
     i18n (0.8.1)
+    method_source (0.8.2)
     minitest (5.10.1)
     mobility (0.1.12)
       i18n (>= 0.6.10)
       request_store (~> 1.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
     rake (10.5.0)
     request_store (1.3.2)
     rspec (3.5.0)
@@ -44,6 +55,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    slop (3.6.0)
+    sqlite3 (1.3.13)
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
@@ -53,9 +66,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.12)
+  database_cleaner (~> 1.5.3)
   friendly_id-mobility!
-  rake (~> 10.0)
+  pry
+  pry-byebug
+  rake
   rspec (~> 3.0)
+  sqlite3
 
 BUNDLED WITH
    1.12.5

data/README.md

@@ -1,75 +1,145 @@
-# FriendlyId Mobility
+FriendlyId Mobility
+===================
+
+[![Gem Version](https://badge.fury.io/rb/friendly_id-mobility.svg)][gem]
+[![Build Status](https://travis-ci.org/shioyama/friendly_id-mobility.svg?branch=master)][travis]
+
+[gem]: https://rubygems.org/gems/friendly_id-mobility
+[travis]: https://travis-ci.org/shioyama/friendly_id-mobility
 
 [Mobility](https://github.com/shioyama/mobility) support for
 [FriendlyId](https://github.com/norman/friendly_id).
 
-## Installation
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'friendly_id-mobility'
+gem 'friendly_id-mobility', '~> 0.2.0'
 ```
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install friendly_id-mobility
+```
+gem install friendly_id-mobility
+```
+
+Run the Mobility generator and migrate:
 
-## Translating Slugs using Mobility
+```
+rails generate mobility:install
+rake db:migrate
+```
 
-To translate slugs using Mobility, simply translate the attribute you want to
-use to generate slugs and also translate the slug attribute itself, and then
-call `friendly_id` with `use: :mobility`:
+Run the FriendlyId generator, without the migration to generate the slugs
+table:
+
+```
+rails generate friendly_id --skip-migration
+```
+
+You're ready to go!
+
+Usage
+-----
+
+There are two ways to translate FriendlyId slugs with Mobility: with an
+untranslated base column (like the SimpleI18n module included with FriendlyId),
+and with a translated base column.
+
+### Translating Slug
+
+If you only want to translate the slug, include `Mobility` and translate the
+slug with whichever backend you want (here we're assuming the default KeyValue
+backend). Here, `name` is untranslated (so there is a column on the `posts`
+table named `name`):
 
 ```ruby
-class Post < ActiveRecord::Base
+class Journalist < ActiveRecord::Base
   include Mobility
-  translates :title, :slug
+  translates :slug
 
   extend FriendlyId
   friendly_id :title, use: :mobility
 end
 ```
 
-You can now save `title` in any locale and FriendlyId will generate a
-slug, stored by Mobility in the current locale:
+You can now save `name` and generate a slug, and update the slug in any locale
+using `set_friendly_id`
 
 ```ruby
-post = Post.create(title: "My Foo Title")
-post.title
+journalist = Journalist.create(name: "John Smith")
+journalist.slug
+#=> "john-smith"
+journalist.set_friendly_id("Juan Fulano", :es)
+journalist.save!
+I18n.with_locale(:es) { journalist.friendly_id }
+#=> "juan-fulano"
+```
+
+So the slug is translated, but the base attribute (`name`) is not.
+
+### Translating Slug and Base Attribute
+
+You can also translate both slug and base attribute:
+
+```ruby
+class Article < ActiveRecord::Base
+  include Mobility
+  translates :slug, :title, dirty: true
+
+  extend FriendlyId
+  friendly_id :title, use: :mobility
+end
+```
+
+In this case, `title` is translated, and its value in the current locale will
+be used to generate the slug in this locale:
+
+```ruby
+article = Article.create(title: "My Foo Title")
+article.title
 #=> "My Foo Title"
-post.slug
+article.slug
 #=> "my-foo-title"
 Mobility.locale = :fr
-post.title = "Mon titre foo"
-post.save
-post.slug
+article.title = "Mon titre foo"
+article.save
+article.slug
 #=> "mon-titre-foo"
 Mobility.locale = :en
-post.slug
+article.slug
 #=> "my-foo-title"
 ```
 
-Finders work too:
+Setting `dirty: true` on the translated base attribute is recommended in order
+to ensure that changes in any locale trigger updates to the slug in that
+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
+untranslated one:
 
 ```ruby
 Mobility.locale = :en
-Post.friendly.find("my-foo-title")
-#=> #<Post id: 1 ...>
+Article.friendly.find("my-foo-title")
+#=> #<Article id: 1 ...>
 Mobility.locale = :fr
-Post.friendly.find("mon-titre-foo")
-#=> #<Post id: 1 ...>
+Article.friendly.find("mon-titre-foo")
+#=> #<Article id: 1 ...>
 ```
 
-## Development
-
-(TODO)
-
-## Contributing
+Contributing
+------------
 
 Bug reports and pull requests are welcome on GitHub at
 https://github.com/shioyama/friendly_id-mobility. This project is intended to
@@ -77,8 +147,8 @@ be a safe, welcoming space for collaboration, and contributors are expected to
 adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
 conduct.
 
-
-## License
+License
+-------
 
 The gem is available as open source under the terms of the [MIT
 License](http://opensource.org/licenses/MIT).

data/lib/friendly_id/mobility.rb

@@ -26,6 +26,30 @@ module FriendlyId
             "Mobility (add 'translates :#{field}' in your model '#{model.name}')"
         end
       end
+      private :advise_against_untranslated_model
     end
+
+    def set_friendly_id(text, locale = nil)
+      ::Mobility.with_locale(locale || ::Mobility.locale) do
+        set_slug normalize_friendly_id(text)
+      end
+    end
+
+    def should_generate_new_friendly_id?
+      send(friendly_id_config.slug_column).nil?
+    end
+
+    include(Module.new do
+      def set_slug(normalized_slug = nil)
+        super
+        changed.each do |change|
+          if change =~ /\A#{friendly_id_config.base}_([a-z]{2}(_[a-z]{2})?)/
+            locale, suffix = $1.split('_'.freeze)
+            locale = "#{locale}-#{suffix.upcase}".freeze if suffix
+            ::Mobility.with_locale(locale) { super }
+          end
+        end
+      end
+    end)
   end
 end

data/lib/friendly_id/mobility/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id-mobility
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mobility
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
 description: 
 email:
 - chris@dejimata.com