mobility 0.1.20 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6778a8402d95ba47fef05d514047e2545e09f0d2
-  data.tar.gz: 27575b20fb80ed574499a1526be8c4583cfe7ff6
+  metadata.gz: 65312461ae32cbb2024100f6a3676ac28949a35b
+  data.tar.gz: 7cebc1fb0666104ab1514beb5966ee711057a178
 SHA512:
-  metadata.gz: 1918d980d4567431243360a7fab301e2240d6632a5c76ca773dc8bf6a22054a1c92a4946dd4f2a5bca0c1103d3c9c254127342f344ab82c31349b1b0a0fed906
-  data.tar.gz: 71a75d941c0d7845d2dd7e88b2bb0d62f6e2fb4826292a25515541a6be6e21a9937c40c1b733c595bbc58378a37acc5b53c051a44e35ab189bfd00c36200ff42
+  metadata.gz: 6a9962e0d3ab3fede8e8de43604435bdbfe2362a56dfaeada04a18cdf1c018060ca3e2f95e96f86eb7fc4cf4e22ed8ff5b7be713f72fe69ad4721619d248cb65
+  data.tar.gz: 294e4a19db85fd3b7645455167f974d6995334a12582a07a3501bbecfb7e6129a0832bb7368036d49357c807c3c798976bcbab2ce4e4d8f88ac9c2109d60e9f1

data.tar.gz.sig

@@ -0,0 +1,2 @@
+����k�`�,m�~�(�����GnxZlBµ���7
d�́��'�/���Y��,b�!��65��e��H��Z2�H�T���g�)�r��P_��ʩ��(i���(���Ӕ�D�+L�A�:z�b�(�(�@���2e�K���ʰ�Rjg:�
�s��s48`�`��Ѳ&
;����Һ������b$XE�CwKX5��ڦ�M@�;=㠸O�7�=��o�Y8�1{=bjl.X�E-H+�s�
+=��St��

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## 0.1
 
+### 0.2.0 (August 13, 2017)
+
+See overview of the changes in [this blog
+post](http://dejimata.com/2017/8/13/mobility-0-2-now-with-plugins).
+
+* Mobility.default_options ([#50](https://github.com/shioyama/mobility/pull/50))
+* Re-organized options under Plugins namespace ([#62](https://github.com/shioyama/mobility/pull/64))
+* Backends are now Enumerable ([#71](https://github.com/shioyama/mobility/pull/71))
+* Replace `autoload` by `require` ([#65](https://github.com/shioyama/mobility/pull/65))
+* Remove mobility/core_ext and replace with `Mobility::Util` ([#60](https://github.com/shioyama/mobility/pull/60))
+* New "default" plugin which sets a default value or proc for an attribute: ([#49](https://github.com/shioyama/mobility/pull/49))
+* Add `super` option ([#62](https://github.com/shioyama/mobility/pull/62))
+* Rename default associations for KeyValue and Table backends ([#59](https://github.com/shioyama/mobility/pull/59) and [#66](https://github.com/shioyama/mobility/pull/66))
+* Refactor cache code ([#57](https://github.com/shioyama/mobility/pull/58))
+* Gem is now signed ([#73](https://github.com/shioyama/mobility/pull/73))
+* Minimum Ruby version: 2.2.7
+
 ### 0.1.20 (July 23, 2017)
 * Fix location of Rails generators to work with plugins
   ([#56](https://github.com/shioyama/mobility/pull/56))

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to Mobility
+
+Thanks for your interest in contributing to Mobility! Contributions are welcomed and encouraged. Bug reports, feature requests, and refactoring are all a great help, but please follow the instructions below to ensure things go as smoothly as possible.
+
+## Bugs
+
+Notice a bug or something that seems not to be working correctly? Great, that's valuable information. First off, make sure you go through the [Github issues](https://github.com/shioyama/mobility/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if what you're experiencing has already been reported.
+
+If not, please post a new issue explaining how the issue happens, and steps to reproduce it. Also include what backend you are using, what ORM (ActiveRecord, Sequel, etc.), what Ruby version, and if relevant what platform, etc.
+
+## Feature Requests
+
+Have an idea for a new feature? Great! Please sketch out what you are thinking of and create an issue describing it in as much detail as possible. Note that Mobility aims to be as simple as possible, so complex features will probably not be added, but extensions and integrations with other gems may be created outside of the Mobility gem itself.
+
+## Questions
+
+If you are having issues understanding how to apply Mobility to your particular use case, or any other questions about the gem, please post a question to [Stack Overflow](http://stackoverflow.com) tagged with "mobility". If you don't get an answer, post an issue to the repository with a link to the question and someone will try to help you asap.
+
+## Features
+
+If you've actually built a new feature for Mobility, go ahead and make a pull request and we will consider it. In general you will need to have tests for whatever feature you are proposing.
+
+To test that your feature does not break existing specs, run the specs with:
+
+```ruby
+bundle exec rspec
+```
+
+This will run specs which are not dependent on any ORM (pure Ruby specs only). To test against ActiveRecord, you will need to set the `ORM` environment variable, like this:
+
+```ruby
+ORM=active_record bundle exec rspec
+```
+
+This will run AR specs with an sqlite3 in-memory database. If you want to run specs against a specific database, you will need to specify which database to use with the `DB` env (either `mysql` or `postgres`), and first create and migrate the database:
+
+```ruby
+ORM=active_record DB=postgres bundle exec rspec
+```
+
+... will run the specs against Mobility running with AR 5.1 with postgres as the database.
+
+For more info, see the [Testing Backends](https://github.com/shioyama/mobility#testing-backends) section of the README.
+
+Once you've ensured that existing specs do not break, please try to write at least one spec covering the new feature. If you have questions about how to do this, first post the PR and we can help you in the PR comments section.
+
+Note that when you submit the pull request, Travis CI will run the [test suite](https://travis-ci.org/mobility/mobility) against your branch and will highlight any failures. Unless there is a good reason for it, we do not generally accept pull requests that take Mobility from green to red.
+
+## Other Resources
+
+Be sure to check out these resources for more detailed info on how Mobility works:
+
+- [API docs](http://www.rubydoc.info/gems/mobility)
+- [Wiki](https://github.com/shioyama/mobility/wiki)
+- [Translating with Mobility](http://dejimata.com/2017/3/3/translating-with-mobility)

data/Gemfile

@@ -21,6 +21,8 @@ group :development, :test do
     end
   end
 
+  gem 'allocation_stats' if ENV['TEST_PERFORMANCE']
+
   platforms :ruby do
     gem 'guard-rspec'
     gem 'pry-byebug'

data/Gemfile.lock

@@ -8,43 +8,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.2)
-      actionview (= 5.1.2)
-      activesupport (= 5.1.2)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.2)
-      activesupport (= 5.1.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.1.2)
-      activesupport (= 5.1.2)
-    activerecord (5.1.2)
-      activemodel (= 5.1.2)
-      activesupport (= 5.1.2)
-      arel (~> 8.0)
-    activesupport (5.1.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (8.0.0)
-    builder (3.2.3)
     byebug (9.0.6)
     coderay (1.1.1)
-    concurrent-ruby (1.0.5)
     database_cleaner (1.6.1)
     diff-lcs (1.3)
-    erubi (1.6.1)
     ffi (1.9.18)
     formatador (0.2.5)
-    generator_spec (0.9.4)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
     guard (2.14.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -64,16 +33,10 @@ GEM
       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.12)
     method_source (0.8.2)
-    mini_portile2 (2.2.0)
-    minitest (5.10.3)
     mysql2 (0.3.21)
     nenv (0.3.0)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -85,20 +48,6 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
-    rack (2.0.3)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.2)
-      actionpack (= 5.1.2)
-      activesupport (= 5.1.2)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)
@@ -118,23 +67,19 @@ GEM
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
     ruby_dep (1.5.0)
+    sequel (4.48.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)
     yard (0.9.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 5.1, < 5.2)
   bundler (~> 1.12)
   database_cleaner (~> 1.5, >= 1.5.3)
-  generator_spec (~> 0.9.4)
   guard-rspec
   mobility!
   mysql2 (~> 0.3.10)
@@ -142,6 +87,7 @@ DEPENDENCIES
   pry-byebug
   rake (~> 10.0)
   rspec (~> 3.0)
+  sequel (>= 4.46.0)
   sqlite3
   yard (~> 0.9.0)
 

data/README.md

@@ -47,11 +47,20 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.1.20'
+gem 'mobility', '~> 0.2.0'
 ```
 
-To translate attributes on a model, include (or extend) `Mobility`, then call
-`translates` passing in one or more attributes as well as a hash of options.
+Mobility is cryptographically signed. To be sure the gem you install hasn't
+been tampered with, first my public key (if you haven’t already) as a trusted
+certificate:
+
+```
+gem cert --add <(curl -Ls https://raw.github.com/shioyama/mobility/master/certs/shioyama.pem)
+gem install shioyama -P MediumSecurity
+```
+
+The MediumSecurity trust profile will verify signed gems, but allow the
+installation of unsigned dependencies.
 
 ### ActiveRecord (Rails)
 
@@ -62,6 +71,9 @@ Requirements:
 ActiveRecord/Rails 4.2, but there are some tests still failing. To see exactly
 what might not work, check pending specs in Rails 4.2 Travis builds.)
 
+To translate attributes on a model, extend `Mobility`, then call `translates`
+passing in one or more attributes as well as a hash of options (see below).
+
 If using Mobility in a Rails project, you can run the generator to create an
 initializer and a migration to create shared translation tables for the
 default `KeyValue` backend:
@@ -95,7 +107,7 @@ See [Getting Started](#quickstart) to get started translating your models.
 Requirements:
 - Sequel >= 4.0
 
-You can include `Mobility` just like in ActiveRecord, or you can use the
+You can extend `Mobility` just like in ActiveRecord, or you can use the
 `mobility` plugin, which does the same thing:
 
 ```ruby
@@ -125,7 +137,7 @@ of options, like this:
 
 ```ruby
 class Word < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :name,    type: :string
   translates :meaning, type: :text
 end
@@ -226,7 +238,7 @@ option when defining translated attributes on the model class:
 
 ```ruby
 class Word < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :name, type: :string, locale_accessors: [:en, :ja]
 end
 ```
@@ -266,7 +278,7 @@ For example, if we define `Word` this way:
 
 ```ruby
 class Word < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :name, type: :string, fallthrough_accessors: true
 end
 ```
@@ -326,6 +338,10 @@ word.name_backend.read(:en)
 Internally, all methods for accessing translated attributes ultimately end up
 reading and writing from the backend instance this way.
 
+The `write` methods do not call underlying backend's methods to persist the change.
+This is up to the user (e.g. with ActiveRecord you should call `save` write
+the changes to the database.
+
 ### Setting the Locale
 
 It may not always be desirable to use `I18n.locale` to set the locale for
@@ -371,7 +387,7 @@ translated attributes on a class:
 
 ```ruby
 class Word < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :name,    type: :string, fallbacks: { de: :ja, fr: :ja }
   translates :meaning, type: :text,   fallbacks: { de: :ja, fr: :ja }
 end
@@ -437,6 +453,39 @@ fallbacks](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Fallbacks)
 and [this article on I18n
 fallbacks](https://github.com/svenfuchs/i18n/wiki/Fallbacks).
 
+### <a name="default"></a>Default values
+
+Another option is to assign a default value, which will be used if the result of a fetch would otherwise be `nil`:
+
+```ruby
+class Word < ApplicationRecord
+  extend Mobility
+  translates :name, type: :string, default: 'foo'
+end
+
+Mobility.locale = :ja
+word = Word.create(name: "モビリティ")
+word.name
+#=> "モビリティ"
+Mobility.locale = :de
+word.name
+#=> "foo"
+```
+
+You can override the default by passing a `default` option to the attribute reader:
+
+```ruby
+word.name
+#=> 'foo'
+word.name(default: nil)
+#=> nil
+word.name(default: 'bar')
+#=> 'bar'
+```
+
+The default can also be a `Proc`, which will be passed the model and attribute
+name as keyword arguments. See the [API docs][docs] for details.
+
 ### <a name="dirty"></a>Dirty Tracking
 
 Dirty tracking (tracking of changed attributes) can be enabled for models which
@@ -456,7 +505,7 @@ dirty tracking is not specific to AR and works for non-persisted models as well)
 
 ```ruby
 class Post < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :title, type: :string, dirty: true
 end
 ```
@@ -530,7 +579,7 @@ false` when defining an attribute, like this:
 
 ```ruby
 class Word < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :name, type: :string, cache: false
 end
 ```
@@ -554,7 +603,7 @@ So assuming a model:
 
 ```ruby
 class Post < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :title,   type: :string
   translates :content, type: :text
 end
@@ -598,7 +647,7 @@ default scope on your model:
 
 ```ruby
 class Post < ApplicationRecord
-  include Mobility
+  extend Mobility
   translates :title,   type: :string
   translates :content, type: :text
   default_scope { i18n }
@@ -633,7 +682,7 @@ This would set the `name` attribute to use the `Table` backend (see below).
 The `type` option (`type: :string` or `type: :text`) is missing here because
 this is an option specific to the KeyValue backend (specifying which shared
 table to store translations on). Backends have their own specific options; see
-the [Wiki][wiki] and [API documentation][api] for which options are available
+the [Wiki][wiki] and [API documentation][docs] for which options are available
 for each.
 
 Everything else described above (fallbacks, dirty tracking, locale accessors,
@@ -712,7 +761,7 @@ class MyBackend
 end
 
 class MyClass
-  include Mobility
+  extend Mobility
   translates :foo, backend: MyBackend
 end
 ```
@@ -745,7 +794,7 @@ describe MyBackend do
 
   before do
     stub_const 'MyPost', Class.new(ActiveRecord::Base)
-    MyPost.include Mobility
+    MyPost.extend Mobility
     MyPost.translates :title, :content, backend: MyBackend
   end
 

data/Rakefile

@@ -6,49 +6,49 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
-task :load_path do
+task :setup do
   %w(lib spec).each do |path|
     $LOAD_PATH.unshift(File.expand_path("../#{path}", __FILE__))
   end
+  require "database"
+  exit if config["database"] == ":memory:"
 end
 
 namespace :db do
   desc "Create the database"
-  task :create => :load_path do
-    require "database"
-    driver = Mobility::Test::Database.driver
-    config = Mobility::Test::Database.config[driver]
-    exit if config["database"] == ":memory:"
+  task create: :setup do
     commands = {
-      "mysql"    => "mysql -u #{config['username']} -e 'create database #{config["database"]};' >/dev/null",
+      "mysql"    => "mysql -u #{config['username']} -e 'create database #{config["database"]} default character set #{config["encoding"]} default collate #{config["collation"]};' >/dev/null",
       "postgres" => "psql -c 'create database #{config['database']};' -U #{config['username']} >/dev/null"
     }
     %x{#{commands[driver] || true}}
+    $?.success? ? puts("Database successfully created.") : puts("There was an error creating the database.")
   end
 
   desc "Drop the database"
-  task :drop => :load_path do
-    require "database"
-    driver = Mobility::Test::Database.driver
-    config = Mobility::Test::Database.config[driver]
-    exit if config["database"] == ":memory:"
+  task drop: :setup do
     commands = {
       "mysql"    => "mysql -u #{config['username']} -e 'drop database #{config["database"]};' >/dev/null",
       "postgres" => "psql -c 'drop database #{config['database']};' -U #{config['username']} >/dev/null"
     }
     %x{#{commands[driver] || true}}
+    $?.success? ? puts("Database successfully dropped.") : puts("There was an error dropping the database.")
   end
 
   desc "Set up the database schema"
-  task :up => :load_path do
-    require "database"
-    driver = Mobility::Test::Database.driver
-    config = Mobility::Test::Database.config[driver]
-    exit if config["database"] == ":memory:"
+  task up: :setup do
     require "spec_helper"
     Mobility::Test::Schema.up
   end
 
   desc "Drop and recreate the database schema"
   task :reset => [:drop, :create]
+
+  def config
+    Mobility::Test::Database.config[driver]
+  end
+
+  def driver
+    Mobility::Test::Database.driver
+  end
 end