trestle-mobility 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a43a43d7175e12ad8e187b457104e27f4d273a0fb94f8f83f8f6f39fb2e409fa
-  data.tar.gz: f6b84afec6c7eb6f418ae541cc8b907a6043feeec9aebd7788f3807e8871788d
+  metadata.gz: 61f40dc820abfc72674027e455750a9c9b6011bed7a16ea257013407895cfe57
+  data.tar.gz: a6f35d96c0ce62a1b31de8441de8341a5372ea1657ce3b227256540d27ecde45
 SHA512:
-  metadata.gz: 72d5f7c872fc6aa8b0700458cbce9de3f96ea49b658a74b4921d3a6e1948a77507dac6993de77c371433808f7c30bf95444fc09be4faaf8ef32bfdd9d16e3b7d
-  data.tar.gz: 956dd0052b15112ed083ece196ab65642fd5f0ad01eda5f8ea2d9a1863a8718af92df66ee502c94f6099feab3da3522e8c24c668a7d5890982ed875a290bab79
+  metadata.gz: e3c4546221bf0a30e3d04bbf41b04513abe31177af38d1b5e9fe04b01d0ac30da33dc94e5ba96974a612badf78f7eaa70571905666ffb52e725fc211d8aa702e
+  data.tar.gz: bdf55d61911e8923ff421fc14a1d3bb80f42fcb8e08b500dfffd9bc3b0dc7a7a83134835d14b00c7672455ab995b77870eaf1c100d88cfc8cd94c6e118d4d02d

data/README.md

@@ -14,6 +14,18 @@
 
 <img src="/screenshot.png?raw=true" width="529" height="242" alt="Trestle Mobility screenshot" />
 
+## Getting started
+
+These instructions assume you have a working Trestle application. To integrate trestle-mobility, first add it to your application's Gemfile:
+
+```ruby
+gem 'trestle-mobility'
+```
+
+Run `bundle install`, and then run the install generator to set up configuration options.
+
+    $ rails generate trestle:auth:install
+
 ## Usage
 
 Trestle Mobility requires you to enable [Mobility's `locale_accessors` plugin](https://github.com/shioyama/mobility#getset).
@@ -31,35 +43,23 @@ Trestle.resource(:posts) do
 end
 ```
 
-### Specifying locales
-
-By default Trestle Mobility uses `I18n.available_locales` to generate the form fields, but you can specify this on a per-field basis:
+Trestle Mobility allows you to specify the language that is selected by default:
 
 ```ruby
-mobility_text_field :title, locales: %w(nl de fr)
+mobility_text_field :subtitle, selected: "nl"
 ```
 
-Quoting Mobility's README:
-
-> (Note however that Mobility will complain if you have I18n.enforce_available_locales set to true and you try accessing a locale not present in I18n.available_locales; set it to false if you want to allow any locale.)
-
-### Default language selection
-
-Trestle Mobility allows you to specify the language that is selected by default. This is possible on an application-wide basis but also per field.
-
-To set the default language that should be selected for all fields, add the following line to your Trestle initializer:
+By default Trestle Mobility uses `I18n.available_locales` to generate the form fields, but you can specify the languages on a per-field basis:
 
 ```ruby
-config.mobility.selected = "nl"
+mobility_text_field :title, locales: %w(nl de fr)
 ```
 
-Or specify it per field:
+Quoting Mobility's README:
 
-```ruby
-mobility_text_field :subtitle, selected: "nl"
-```
+> (Note however that Mobility will complain if you have I18n.enforce_available_locales set to true and you try accessing a locale not present in I18n.available_locales; set it to false if you want to allow any locale.)
 
-### DeepL translation
+## DeepL translation
 
 <img src="/screenshot-deepl.png?raw=true" width="410" height="241" alt="Trestle Mobility DeepL integration screenshot" />
 
@@ -68,13 +68,3 @@ Trestle Mobility can automatically populate empty field values with translations
 ```ruby
 config.mobility.deepl_api_key = "YOUR-API-KEY"
 ```
-
-## Installation
-
-These instructions assume you have a working Trestle application. To integrate trestle-mobility, first add it to your application's Gemfile:
-
-```ruby
-gem 'trestle-mobility'
-```
-
-Run `bundle install`, and then restart your Rails server.

data/lib/generators/trestle/mobility/install/install_generator.rb

@@ -0,0 +1,32 @@
+module Trestle
+  module Mobility
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc "Installs trestle-mobility"
+
+        def check_trestle_installed
+          unless ::File.exist?("config/initializers/trestle.rb")
+            raise Thor::Error, "The file config/initializers/trestle.rb does not appear to exist. Please run `trestle:install` first."
+          end
+        end
+
+        def insert_configuration
+          inject_into_file "config/initializers/trestle.rb", before: /^end/ do
+            <<-RUBY.strip_heredoc.indent(2)
+
+              # == Mobility Options
+              #
+              # Specify the default selected locale
+              #
+              # config.mobility.selected = -> { I18n.locale }
+
+              # Specify your DeepL Pro API key to easily translate values
+              #
+              # config.mobility.deepl_api_key = "YOUR-API-KEY"
+            RUBY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trestle/mobility/configuration.rb

@@ -3,7 +3,7 @@ module Trestle
     class Configuration
       include Configurable
 
-      option :selected
+      option :selected, -> { I18n.locale }, evaluate: false
       option :deepl_api_key
     end
   end

data/lib/trestle/mobility/fields/check_box.rb

@@ -5,7 +5,7 @@ module Trestle
         def field
           label = options[:label] || name.to_s.humanize
           locales = options[:locales] || I18n.available_locales.sort
-          selected = options[:selected] || Trestle.config.mobility.selected || locales.first
+          selected = options[:selected] || Trestle.config.mobility.selected.call || locales.first
 
           @template.render partial: "trestle/mobility/check_box",
                            locals: {

data/lib/trestle/mobility/fields/text_area.rb

@@ -5,7 +5,7 @@ module Trestle
         def field
           label = options[:label] || name.to_s.humanize
           locales = options[:locales] || I18n.available_locales.sort
-          selected = options[:selected] || Trestle.config.mobility.selected || locales.first
+          selected = options[:selected] || Trestle.config.mobility.selected.call || locales.first
           rows = options[:rows] || 5
 
           @template.render partial: "trestle/mobility/text_area",

data/lib/trestle/mobility/fields/text_field.rb

@@ -5,7 +5,7 @@ module Trestle
         def field
           label = options[:label] || name.to_s.humanize
           locales = options[:locales] || I18n.available_locales.sort
-          selected = options[:selected] || Trestle.config.mobility.selected || locales.first
+          selected = options[:selected] || Trestle.config.mobility.selected.call || locales.first
 
           @template.render partial: "trestle/mobility/text_field",
                            locals: {

data/lib/trestle/mobility/version.rb

@@ -1,5 +1,5 @@
 module Trestle
   module Mobility
-    VERSION = "0.5.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trestle-mobility
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Venneman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: emoji_flag
@@ -104,6 +104,7 @@ files:
 - bin/setup
 - config/initializers/trestle.rb
 - config/routes.rb
+- lib/generators/trestle/mobility/install/install_generator.rb
 - lib/trestle/mobility.rb
 - lib/trestle/mobility/configuration.rb
 - lib/trestle/mobility/engine.rb