decidim 0.0.1.alpha2 → 0.0.1.alpha3

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of decidim might be problematic. Click here for more details.

Files changed (166) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +8 -2
  3. data/.dockerignore +5 -0
  4. data/.gitignore +2 -1
  5. data/.hound.yml +4 -0
  6. data/.rubocop.yml +16 -3
  7. data/.ruby-version +1 -0
  8. data/.travis.yml +28 -0
  9. data/Dockerfile +36 -0
  10. data/Gemfile +7 -2
  11. data/Gemfile.lock +188 -30
  12. data/README.md +40 -6
  13. data/Rakefile +4 -20
  14. data/codecov.yml +71 -0
  15. data/common_gemfile.rb +6 -18
  16. data/decidim-admin/Gemfile +17 -0
  17. data/decidim-admin/Gemfile.lock +383 -0
  18. data/decidim-admin/README.md +28 -0
  19. data/decidim-admin/Rakefile +32 -0
  20. data/decidim-admin/app/assets/config/decidim_admin_manifest.js +2 -0
  21. data/{template.rb → decidim-admin/app/assets/images/decidim/admin/.keep} +0 -0
  22. data/decidim-admin/app/assets/javascripts/decidim/admin.js +21 -0
  23. data/decidim-admin/app/assets/stylesheets/decidim/admin.scss +8 -0
  24. data/decidim-admin/app/assets/stylesheets/decidim/admin/_actions.scss +8 -0
  25. data/decidim-admin/app/assets/stylesheets/decidim/admin/_foundation_and_overrides.scss +52 -0
  26. data/decidim-admin/app/assets/stylesheets/decidim/admin/_layout.scss +16 -0
  27. data/decidim-admin/app/assets/stylesheets/decidim/admin/_login.scss +36 -0
  28. data/decidim-admin/app/assets/stylesheets/decidim/admin/_settings.scss +566 -0
  29. data/decidim-admin/app/assets/stylesheets/decidim/admin/_sidebar.scss +73 -0
  30. data/decidim-admin/app/assets/stylesheets/decidim/admin/_tables.scss +5 -0
  31. data/decidim-admin/app/constraints/decidim/admin/organization_dashboard_constraint.rb +36 -0
  32. data/decidim-admin/app/controllers/decidim/admin/application_controller.rb +10 -0
  33. data/decidim-admin/app/controllers/decidim/admin/dashboard_controller.rb +9 -0
  34. data/decidim-admin/app/helpers/decidim/admin/application_helper.rb +12 -0
  35. data/decidim-admin/app/jobs/decidim/admin/application_job.rb +9 -0
  36. data/decidim-admin/app/mailers/decidim/admin/application_mailer.rb +11 -0
  37. data/decidim-admin/app/models/decidim/admin/application_record.rb +10 -0
  38. data/decidim-admin/app/policies/decidim/admin/application_policy.rb +20 -0
  39. data/decidim-admin/app/policies/decidim/admin/organization_policy.rb +15 -0
  40. data/decidim-admin/app/views/decidim/admin/dashboard/show.html.erb +3 -0
  41. data/decidim-admin/app/views/decidim/admin/devise/mailers/password_change.html.erb +3 -0
  42. data/decidim-admin/app/views/decidim/admin/devise/mailers/reset_password_instructions.html.erb +8 -0
  43. data/decidim-admin/app/views/layouts/decidim/admin/_header.html.erb +4 -0
  44. data/decidim-admin/app/views/layouts/decidim/admin/_login_items.html.erb +8 -0
  45. data/decidim-admin/app/views/layouts/decidim/admin/_sidebar.html.erb +13 -0
  46. data/decidim-admin/app/views/layouts/decidim/admin/application.html.erb +40 -0
  47. data/decidim-admin/app/views/layouts/decidim/admin/login.html.erb +19 -0
  48. data/decidim-admin/bin/rails +14 -0
  49. data/decidim-admin/config/i18n-tasks.yml +120 -0
  50. data/decidim-admin/config/locales/en.yml +8 -0
  51. data/decidim-admin/config/routes.rb +4 -0
  52. data/decidim-admin/decidim-admin.gemspec +38 -0
  53. data/decidim-admin/lib/decidim/admin.rb +12 -0
  54. data/decidim-admin/lib/decidim/admin/engine.rb +31 -0
  55. data/decidim-admin/lib/tasks/decidim/admin_tasks.rake +5 -0
  56. data/decidim-admin/spec/factories.rb +1 -0
  57. data/decidim-admin/spec/features/admin_access_control.rb +52 -0
  58. data/decidim-admin/spec/features/admin_invite_spec.rb +38 -0
  59. data/decidim-admin/spec/policies/organization_policy_spec.rb +41 -0
  60. data/decidim-admin/spec/spec_helper.rb +3 -0
  61. data/decidim-dev/Gemfile +17 -0
  62. data/decidim-dev/Gemfile.lock +381 -0
  63. data/decidim-dev/README.md +28 -0
  64. data/decidim-dev/decidim-dev.gemspec +30 -0
  65. data/decidim-dev/lib/decidim/common_rake.rb +14 -0
  66. data/decidim-dev/lib/decidim/test/base_spec_helper.rb +44 -0
  67. data/decidim-dev/lib/decidim/test/i18n_spec.rb +18 -0
  68. data/decidim-dev/lib/decidim/test/rspec_support/action_mailer.rb +46 -0
  69. data/decidim-dev/lib/decidim/test/rspec_support/active_job.rb +11 -0
  70. data/decidim-dev/lib/decidim/test/rspec_support/capybara.rb +19 -0
  71. data/decidim-dev/lib/decidim/test/rspec_support/database_cleaner.rb +13 -0
  72. data/decidim-dev/lib/decidim/test/rspec_support/factory_girl.rb +4 -0
  73. data/decidim-dev/lib/decidim/test/rspec_support/i18n.rb +12 -0
  74. data/decidim-dev/lib/decidim/test/rspec_support/warden.rb +8 -0
  75. data/decidim-dev/lib/decidim/test/rspec_support/wisper.rb +6 -0
  76. data/decidim-dev/lib/generators/decidim/dummy_generator.rb +65 -0
  77. data/decidim-system/Gemfile +17 -0
  78. data/decidim-system/Gemfile.lock +377 -0
  79. data/decidim-system/README.md +28 -0
  80. data/decidim-system/Rakefile +32 -0
  81. data/decidim-system/app/assets/config/decidim_system_manifest.js +2 -0
  82. data/decidim-system/app/assets/images/decidim/system/.keep +0 -0
  83. data/decidim-system/app/assets/javascripts/decidim/system.js +21 -0
  84. data/decidim-system/app/assets/stylesheets/decidim/system.scss +8 -0
  85. data/decidim-system/app/assets/stylesheets/decidim/system/_actions.scss +8 -0
  86. data/decidim-system/app/assets/stylesheets/decidim/system/_foundation_and_overrides.scss +52 -0
  87. data/decidim-system/app/assets/stylesheets/decidim/system/_layout.scss +16 -0
  88. data/decidim-system/app/assets/stylesheets/decidim/system/_login.scss +36 -0
  89. data/decidim-system/app/assets/stylesheets/decidim/system/_settings.scss +566 -0
  90. data/decidim-system/app/assets/stylesheets/decidim/system/_sidebar.scss +73 -0
  91. data/decidim-system/app/assets/stylesheets/decidim/system/_tables.scss +5 -0
  92. data/decidim-system/app/commands/decidim/system/create_admin.rb +40 -0
  93. data/decidim-system/app/commands/decidim/system/register_organization.rb +59 -0
  94. data/decidim-system/app/commands/decidim/system/update_admin.rb +52 -0
  95. data/decidim-system/app/commands/decidim/system/update_organization.rb +51 -0
  96. data/decidim-system/app/controllers/decidim/system/admins_controller.rb +67 -0
  97. data/decidim-system/app/controllers/decidim/system/application_controller.rb +11 -0
  98. data/decidim-system/app/controllers/decidim/system/dashboard_controller.rb +9 -0
  99. data/decidim-system/app/controllers/decidim/system/devise/passwords_controller.rb +12 -0
  100. data/decidim-system/app/controllers/decidim/system/devise/sessions_controller.rb +12 -0
  101. data/decidim-system/app/controllers/decidim/system/organizations_controller.rb +59 -0
  102. data/decidim-system/app/forms/decidim/system/admin_form.rb +33 -0
  103. data/decidim-system/app/forms/decidim/system/register_organization_form.rb +20 -0
  104. data/decidim-system/app/forms/decidim/system/update_organization_form.rb +28 -0
  105. data/decidim-system/app/helpers/decidim/system/application_helper.rb +12 -0
  106. data/decidim-system/app/jobs/decidim/system/application_job.rb +9 -0
  107. data/decidim-system/app/mailers/decidim/system/application_mailer.rb +11 -0
  108. data/decidim-system/app/models/decidim/system/admin.rb +18 -0
  109. data/decidim-system/app/models/decidim/system/application_record.rb +10 -0
  110. data/decidim-system/app/views/decidim/system/admins/_form.html.erb +11 -0
  111. data/decidim-system/app/views/decidim/system/admins/edit.html.erb +11 -0
  112. data/decidim-system/app/views/decidim/system/admins/index.html.erb +33 -0
  113. data/decidim-system/app/views/decidim/system/admins/new.html.erb +11 -0
  114. data/decidim-system/app/views/decidim/system/admins/show.html.erb +9 -0
  115. data/decidim-system/app/views/decidim/system/dashboard/show.html.erb +3 -0
  116. data/decidim-system/app/views/decidim/system/devise/mailers/password_change.html.erb +3 -0
  117. data/decidim-system/app/views/decidim/system/devise/mailers/reset_password_instructions.html.erb +8 -0
  118. data/decidim-system/app/views/decidim/system/devise/passwords/edit.html.erb +23 -0
  119. data/decidim-system/app/views/decidim/system/devise/passwords/new.html.erb +15 -0
  120. data/decidim-system/app/views/decidim/system/devise/sessions/new.html.erb +23 -0
  121. data/decidim-system/app/views/decidim/system/devise/shared/_links.html.erb +25 -0
  122. data/decidim-system/app/views/decidim/system/organizations/edit.html.erb +17 -0
  123. data/decidim-system/app/views/decidim/system/organizations/index.html.erb +34 -0
  124. data/decidim-system/app/views/decidim/system/organizations/new.html.erb +25 -0
  125. data/decidim-system/app/views/decidim/system/organizations/show.html.erb +11 -0
  126. data/decidim-system/app/views/layouts/decidim/system/_header.html.erb +4 -0
  127. data/decidim-system/app/views/layouts/decidim/system/_login_items.html.erb +8 -0
  128. data/decidim-system/app/views/layouts/decidim/system/_sidebar.html.erb +15 -0
  129. data/decidim-system/app/views/layouts/decidim/system/application.html.erb +40 -0
  130. data/decidim-system/app/views/layouts/decidim/system/login.html.erb +19 -0
  131. data/decidim-system/bin/rails +14 -0
  132. data/decidim-system/config/i18n-tasks.yml +120 -0
  133. data/decidim-system/config/locales/en.yml +60 -0
  134. data/decidim-system/config/routes.rb +17 -0
  135. data/decidim-system/db/migrate/20160919105637_devise_create_decidim_admins.rb +26 -0
  136. data/decidim-system/db/seeds.rb +9 -0
  137. data/decidim-system/decidim-system.gemspec +36 -0
  138. data/decidim-system/lib/decidim/system.rb +12 -0
  139. data/decidim-system/lib/decidim/system/engine.rb +31 -0
  140. data/decidim-system/lib/tasks/decidim/system_tasks.rake +5 -0
  141. data/decidim-system/spec/commands/decidim/system/create_admin_spec.rb +48 -0
  142. data/decidim-system/spec/commands/decidim/system/register_organization_spec.rb +68 -0
  143. data/decidim-system/spec/factories.rb +9 -0
  144. data/decidim-system/spec/features/manage_admins_spec.rb +67 -0
  145. data/decidim-system/spec/features/organizations_spec.rb +62 -0
  146. data/decidim-system/spec/features/sessions_spec.rb +38 -0
  147. data/decidim-system/spec/models/admin_spec.rb +23 -0
  148. data/decidim-system/spec/spec_helper.rb +2 -0
  149. data/decidim.gemspec +3 -1
  150. data/docker-compose.yml +24 -0
  151. data/lib/decidim.rb +8 -0
  152. data/lib/generators/decidim/app_builder.rb +1 -1
  153. data/lib/generators/decidim/app_generator.rb +35 -4
  154. data/lib/generators/decidim/install_generator.rb +121 -0
  155. data/lib/generators/decidim/templates/Dockerfile.erb +26 -0
  156. data/lib/generators/decidim/templates/Gemfile.erb +8 -1
  157. data/lib/generators/decidim/templates/README.md.erb +26 -0
  158. data/lib/generators/decidim/templates/app.json.erb +13 -0
  159. data/lib/generators/decidim/templates/cable.yml.erb +9 -0
  160. data/lib/generators/decidim/templates/database.yml.erb +85 -0
  161. data/lib/generators/decidim/templates/docker-compose.yml.erb +28 -0
  162. data/lib/generators/decidim/templates/initializer.rb +4 -0
  163. data/lib/generators/decidim/templates/secrets.yml.erb +30 -0
  164. data/run_ci.sh +7 -0
  165. metadata +183 -8
  166. data/circle.yml +0 -19
@@ -0,0 +1,73 @@
1
+ @mixin menu-title{
2
+ text-transform: uppercase;
3
+ letter-spacing: 5px;
4
+ }
5
+
6
+ .title-bar-title{
7
+ @include menu-title;
8
+ }
9
+
10
+ .sidebar{
11
+ color: $light-gray;
12
+
13
+ .title{
14
+ background-color: black;
15
+ background-color: map-get($foundation-palette, primary);
16
+
17
+ h1{
18
+ margin: 0;
19
+ padding: 0;
20
+ font-size: rem-calc(18);
21
+ font-weight: bold;
22
+ }
23
+
24
+ a{
25
+ display: block;
26
+ color: inherit;
27
+ padding: rem-calc(20) $global-padding;
28
+ @include menu-title;
29
+ }
30
+
31
+ @include show-for(large);
32
+ }
33
+
34
+ .main-menu{
35
+ border-top: 1px solid black;
36
+ border-bottom: 1px solid black;
37
+ a{
38
+ padding: $global-padding;
39
+ display: block;
40
+ color: $light-gray;
41
+ text-transform: uppercase;
42
+ font-weight: bold;
43
+ font-size: 0.9em;
44
+ border-left: 2px solid transparent;
45
+
46
+ transition: all 0.3s;
47
+
48
+ &.active {
49
+ border-color: map-get($foundation-palette, primary);
50
+ &, &:hover{
51
+ background-color: #101010;
52
+ }
53
+ }
54
+
55
+ &:hover {
56
+ background-color: #1a1a1a;
57
+ }
58
+ }
59
+ }
60
+
61
+ .session-box {
62
+ padding: $global-padding 0;
63
+
64
+ @include grid-row;
65
+
66
+ .admin-email {
67
+ @include grid-column(8);
68
+ text-overflow: ellipsis;
69
+ overflow: hidden;
70
+ }
71
+ .sign-out{ @include grid-column(4); }
72
+ }
73
+ }
@@ -0,0 +1,5 @@
1
+ table{
2
+ td.actions, th.actions{
3
+ text-align: right;
4
+ }
5
+ }
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # A Rails routes constraint to only allow access to an Organization admin to
5
+ # the organization dashboard.
6
+ class OrganizationDashboardConstraint
7
+ # Initializes the contraint.
8
+ #
9
+ # request [Rack::Request]
10
+ def initialize(request)
11
+ @request = request
12
+ end
13
+
14
+ # Checks if the user can access the organization dashboard.
15
+ #
16
+ # Returns boolean.
17
+ def matches?
18
+ OrganizationPolicy.new(user, organization).update?
19
+ end
20
+
21
+ private
22
+
23
+ attr_reader :request
24
+
25
+ def organization
26
+ request.env["decidim.current_organization"]
27
+ end
28
+
29
+ def user
30
+ return unless request.env["warden"].authenticate!(scope: :user)
31
+
32
+ @user ||= request.env["warden"].user("user")
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # The main application controller that inherits from Rails.
5
+ class ApplicationController < ActionController::Base
6
+ include NeedsOrganization
7
+ protect_from_forgery with: :exception, prepend: true
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ require_dependency "decidim/admin/application_controller"
3
+
4
+ module Decidim
5
+ module Admin
6
+ class DashboardController < ApplicationController
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # Custom helpers, scoped to the admin panel.
5
+ #
6
+ module ApplicationHelper
7
+ def title
8
+ current_organization.name
9
+ end
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # Custom ApplicationJob scoped to the admin panel.
5
+ #
6
+ class ApplicationJob < ActiveJob::Base
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # Custom application mailer, scoped to the admin mailer.
5
+ #
6
+ class ApplicationMailer < ActionMailer::Base
7
+ default from: "from@example.com"
8
+ layout "mailer"
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # Custom ApplicationRecord scoped to the Admin panel.
5
+ #
6
+ class ApplicationRecord < ActiveRecord::Base
7
+ self.abstract_class = true
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # Main application policy so we don't ahve to repeat the initialization
5
+ # code in each Policy. To be used with Pundit.
6
+ class ApplicationPolicy
7
+ attr_reader :user, :record
8
+
9
+ # Initializes a Policy.
10
+ #
11
+ # user - The User that we want to authorize.
12
+ # record - The record on which to perform the authorizations.
13
+ #
14
+ def initialize(user, record)
15
+ @user = user
16
+ @record = record
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ module Decidim
3
+ module Admin
4
+ # A policy to define all the authorizations regarding an Organization, to
5
+ # be used with Pundit.
6
+ class OrganizationPolicy < ApplicationPolicy
7
+ # Checks if the user can update an organization.
8
+ #
9
+ # Returns a Boolean.
10
+ def update?
11
+ user.roles.include?("admin") && user.organization == record
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,3 @@
1
+ <% content_for :title do %>
2
+ <h2><%= t("decidim.admin.titles.dashboard") %></h2>
3
+ <% end %>
@@ -0,0 +1,3 @@
1
+ <p>Hello <%= @resource.email %>!</p>
2
+
3
+ <p>We're contacting you to notify you that your password has been changed.</p>
@@ -0,0 +1,8 @@
1
+ <p>Hello <%= @resource.email %>!</p>
2
+
3
+ <p>Someone has requested a link to change your password. You can do this through the link below.</p>
4
+
5
+ <p><%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %></p>
6
+
7
+ <p>If you didn't request this, please ignore this email.</p>
8
+ <p>Your password won't change until you access the link above and create a new one.</p>
@@ -0,0 +1,4 @@
1
+ <meta name="viewport" content="width=device-width, initial-scale=1">
2
+ <%= csrf_meta_tags %>
3
+ <%= stylesheet_link_tag 'decidim/admin', media: 'all', 'data-turbolinks-track': 'reload' %>
4
+ <%= javascript_include_tag 'decidim/admin', 'data-turbolinks-track': 'reload' %>
@@ -0,0 +1,8 @@
1
+ <div class="session-box">
2
+ <div class="admin-email">
3
+ <%= current_user.email %>
4
+ </div>
5
+ <div class="sign-out">
6
+ <%= link_to('Logout', decidim.destroy_user_session_path, method: :delete) %>
7
+ </div>
8
+ </div>
@@ -0,0 +1,13 @@
1
+ <div class="title">
2
+ <h1>
3
+ <%= link_to root_path do %>
4
+ <%= title %>
5
+ <% end %>
6
+ </h1>
7
+ </div>
8
+
9
+ <nav class="main-menu">
10
+ <%= active_link_to t("menu.dashboard", scope: "decidim.admin"), root_path, active: :exact %>
11
+ </nav>
12
+
13
+ <%= render partial: 'layouts/decidim/admin/login_items' %>
@@ -0,0 +1,40 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Decidim - admin</title>
5
+ <%= render partial: 'layouts/decidim/admin/header' %>
6
+ </head>
7
+
8
+ <body>
9
+ <div class="off-canvas-wrapper">
10
+ <div class="off-canvas-wrapper-inner" data-off-canvas-wrapper>
11
+ <div class="off-canvas position-left reveal-for-large" id="my-info" data-off-canvas data-position="left">
12
+ <div class="sidebar">
13
+ <%= render partial: 'layouts/decidim/admin/sidebar' %>
14
+ </div>
15
+ </div>
16
+
17
+ <div class="off-canvas-content" data-off-canvas-content>
18
+ <div class="title-bar hide-for-large">
19
+ <div class="title-bar-left">
20
+ <button class="menu-icon" type="button" data-open="my-info"></button>
21
+ <span class="title-bar-title"><%= title %></span>
22
+ </div>
23
+ </div>
24
+ <div class="row main-content">
25
+ <div class="small-12 column">
26
+ <% if content_for?(:title) %>
27
+ <section class="page-title">
28
+ <%= content_for :title %>
29
+ </section>
30
+ <% end %>
31
+
32
+ <%= display_flash_messages %>
33
+ <%= yield %>
34
+ </div>
35
+ </div>
36
+ </div>
37
+ </div>
38
+ </div>
39
+ </body>
40
+ </html>
@@ -0,0 +1,19 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Decidim - Login</title>
5
+ <%= render partial: 'layouts/decidim/admin/header' %>
6
+ </head>
7
+
8
+ <body class="login">
9
+ <div class="login-form-wrapper">
10
+ <div class="login-form">
11
+ <h1>Decidim</h1>
12
+ <%= display_flash_messages %>
13
+ <div class="login-form-inner">
14
+ <%= yield %>
15
+ </div>
16
+ </div>
17
+ </div>
18
+ </body>
19
+ </html>
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+ # This command will automatically be run when you run "rails" with Rails gems
4
+ # installed from the root of your application.
5
+
6
+ ENGINE_ROOT = File.expand_path("../..", __FILE__)
7
+ ENGINE_PATH = File.expand_path("../../lib/decidim/admin/engine", __FILE__)
8
+
9
+ # Set up gems listed in the Gemfile.
10
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
11
+ require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
12
+
13
+ require "rails/all"
14
+ require "rails/engine/commands"
@@ -0,0 +1,120 @@
1
+ # i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
2
+
3
+ # The "main" locale.
4
+ base_locale: en
5
+ ## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
6
+ # locales: [es, fr]
7
+ ## Reporting locale, default: en. Available: en, ru.
8
+ # internal_locale: en
9
+
10
+ # Read and write translations.
11
+ data:
12
+ ## Translations are read from the file system. Supported format: YAML, JSON.
13
+ ## Provide a custom adapter:
14
+ # adapter: I18n::Tasks::Data::FileSystem
15
+
16
+ # Locale files or `File.find` patterns where translations are read from:
17
+ read:
18
+ ## Default:
19
+ # - config/locales/%{locale}.yml
20
+ ## More files:
21
+ # - config/locales/**/*.%{locale}.yml
22
+ ## Another gem (replace %#= with %=):
23
+ # - "<%#= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
24
+
25
+ # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
26
+ # `i18n-tasks normalize -p` will force move the keys according to these rules
27
+ write:
28
+ ## For example, write devise and simple form keys to their respective files:
29
+ # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
30
+ ## Catch-all default:
31
+ # - config/locales/%{locale}.yml
32
+
33
+ ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
34
+ # router: convervative_router
35
+
36
+ yaml:
37
+ write:
38
+ # do not wrap lines at 80 characters
39
+ line_width: -1
40
+
41
+ ## Pretty-print JSON:
42
+ # json:
43
+ # write:
44
+ # indent: ' '
45
+ # space: ' '
46
+ # object_nl: "\n"
47
+ # array_nl: "\n"
48
+
49
+ # Find translate calls
50
+ search:
51
+ ## Paths or `File.find` patterns to search in:
52
+ # paths:
53
+ # - app/
54
+
55
+ ## Root directories for relative keys resolution.
56
+ # relative_roots:
57
+ # - app/controllers
58
+ # - app/helpers
59
+ # - app/mailers
60
+ # - app/presenters
61
+ # - app/views
62
+
63
+ ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
64
+ ## %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
65
+ exclude:
66
+ - app/assets/images
67
+ - app/assets/fonts
68
+
69
+ ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
70
+ ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
71
+ # only: ["*.rb", "*.html.slim"]
72
+
73
+ ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
74
+ # strict: true
75
+
76
+ ## Multiple scanners can be used. Their results are merged.
77
+ ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
78
+ ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
79
+
80
+ ## Google Translate
81
+ # translation:
82
+ # # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
83
+ # api_key: "AbC-dEf5"
84
+
85
+ ## Do not consider these keys missing:
86
+ # ignore_missing:
87
+ # - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
88
+ # - '{devise,simple_form}.*'
89
+
90
+ ## Consider these keys used:
91
+ # ignore_unused:
92
+ # - 'activerecord.attributes.*'
93
+ # - '{devise,kaminari,will_paginate}.*'
94
+ # - 'simple_form.{yes,no}'
95
+ # - 'simple_form.{placeholders,hints,labels}.*'
96
+ # - 'simple_form.{error_notification,required}.:'
97
+
98
+ ## Exclude these keys from the `i18n-tasks eq-base' report:
99
+ # ignore_eq_base:
100
+ # all:
101
+ # - common.ok
102
+ # fr,es:
103
+ # - common.brand
104
+
105
+ ## Ignore these keys completely:
106
+ # ignore:
107
+ # - kaminari.*
108
+
109
+ ## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
110
+ ## e.g. in case of a relative key defined in a helper method.
111
+ ## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
112
+ #
113
+ # <%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
114
+ # only: %w(*.html.haml *.html.slim),
115
+ # patterns: [['= title\b', '.page_title']] %>
116
+ #
117
+ # The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
118
+ #
119
+ # <%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
120
+ # patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>