hyrax 1.1.1 → 2.0.0.beta1

data/app/views/records/edit_fields/_based_near.html.erb

@@ -1,8 +1,12 @@
 <%= f.input key,
-            as: :multi_value,
+            as: :controlled_vocabulary,
+            placeholder: 'Search for a location',
             input_html: {
               class: 'form-control',
               data: { 'autocomplete-url' => "/authorities/search/geonames",
                       'autocomplete' => key }
             },
+            ### Required for the ControlledVocabulary javascript:
+            wrapper_html: { data: { 'autocomplete-url' => "/authorities/search/geonames",
+                                    'field-name' => key }},
             required: f.object.required?(key) %>

data/app/views/records/edit_fields/{_rights.html.erb → _license.html.erb}

@@ -1,5 +1,5 @@
 <% license_service = Hyrax::LicenseService.new %>
-<%= f.input :rights, as: :multi_value_select,
+<%= f.input :license, as: :multi_value_select,
     collection: license_service.select_active_options,
     include_blank: true,
     item_helper: license_service.method(:include_current_value),

data/app/views/records/edit_fields/_rights_statement.html.erb

@@ -0,0 +1,5 @@
+<% rights_statements = Hyrax::RightsStatements.new %>
+<%= f.input :rights_statement,
+    collection: rights_statements.select_active_options,
+    include_blank: true,
+    input_html: { class: 'form-control' } %>

data/app/views/shared/_appearance_styles.html.erb

@@ -0,0 +1,59 @@
+<% # Dynamic styles added by the admin in the appearances page %>
+<style>
+<% appearance = Hyrax::Forms::Admin::Appearance.new %>
+a { color: <%= appearance.link_color %>; }
+.navbar-inverse .navbar-link { color: <%= appearance.footer_link_color %>; }
+
+.navbar-inverse { background-color: <%= appearance.header_background_color %>; }
+
+.navbar-inverse .navbar-nav > .open > a,
+.navbar-inverse .navbar-nav > .open > a:hover,
+.navbar-inverse .navbar-nav > .open > a:focus { background-color: <%= appearance.header_background_color %>; }
+
+.navbar-inverse .navbar-nav > li > a,
+.navbar-inverse .navbar-text,
+.navbar-inverse .navbar-brand { color: <%= appearance.header_text_color %>; }
+
+.btn-primary {
+  background-color: <%= appearance.primary_button_background_color %>;
+  border-color: <%= appearance.primary_button_border_color %>;
+}
+
+.btn-primary:focus,
+.btn-primary.focus {
+  background-color: <%= appearance.primary_button_focus_background_color %>;
+  border-color: <%= appearance.primary_button_focus_border_color %>;
+}
+
+.btn-primary:hover {
+  background-color: <%= appearance.primary_button_hover_background_color %>;
+  border-color: <%= appearance.primary_button_hover_border_color %>;
+}
+
+.btn-primary:active,
+.btn-primary.active {
+  background-color: <%= appearance.primary_button_background_color %>;
+  border-color: <%= appearance.primary_button_border_color %>;
+}
+
+.btn-primary:active:hover,
+.btn-primary:active:focus,
+.btn-primary:active.focus,
+.btn-primary.active:hover,
+.btn-primary.active:focus,
+.btn-primary.active.focus{
+  background-color: <%= appearance.primary_button_background_color %>;
+  border-color: <%= appearance.primary_button_border_color %>;
+}
+
+.btn-primary.disabled:hover,
+.btn-primary.disabled:focus,
+.btn-primary.disabled.focus,
+.btn-primary[disabled]:hover,
+.btn-primary[disabled]:focus,
+.btn-primary[disabled].focus {
+  background-color: <%= appearance.primary_button_background_color %>;
+  border-color: <%= appearance.primary_button_border_color %>;
+}
+
+</style>

data/app/views/shared/_citations.html.erb

@@ -6,12 +6,12 @@
   <meta property="og:type" content="object"/>
   <meta property="og:title" content="<%= @presenter.title.first %>"/>
   <meta property="og:description" content="<%= @presenter.description.first.truncate(200) rescue @presenter.title.first %>"/>
-  <meta property="og:image" content="<%= hyrax.download_url(@presenter, file: 'thumbnail') %>"/>
-  <meta property="og:url" content="<%= polymorphic_path([main_app, @presenter]) %>"/>
+  <meta property="og:image" content="<%= @presenter.download_url %>"/>
+  <meta property="og:url" content="<%= polymorphic_url([main_app, @presenter]) %>"/>
   <meta name="twitter:data1" content="<%= @presenter.keyword.join(', ') %>"/>
   <meta name="twitter:label1" content="Keywords"/>
-  <meta name="twitter:data2" content="<%= @presenter.rights %>"/>
-  <meta name="twitter:label2" content="Rights"/>
+  <meta name="twitter:data2" content="<%= @presenter.rights_statement.first %>"/>
+  <meta name="twitter:label2" content="Rights Statement"/>
 <% end %>
 
 <% content_for(:gscholar_meta) do %>
@@ -20,7 +20,7 @@
   <meta name="citation_author" content="<%= creator %>"/>
   <% end %>
   <meta name="citation_publication_date" content="<%= @presenter.date_created.first %>"/>
-  <meta name="citation_pdf_url" content="<%= hyrax.download_url(@presenter) %>"/>
+  <meta name="citation_pdf_url" content="<%= @presenter.download_url %>"/>
   <!-- Hyrax does not yet support these metadata -->
   <!--
     <meta name="citation_journal_title" content=""/>

data/app/views/shared/_footer.html.erb

@@ -2,7 +2,7 @@
   <div class="container-fluid">
     <div class="navbar-text text-left">
         <p><%= t('hyrax.footer.service_html') %></p>
-        <p>Hyrax v<%= Hyrax::VERSION %></p>
+        <p><%= t('hyrax.product_name') %> v<%= Hyrax::VERSION %></p>
     </div>
     <div class="navbar-right">
       <div class="navbar-text text-right">

data/app/views/shared/_select_work_type_modal.html.erb

@@ -11,8 +11,8 @@
             <div class="select-worktype">
               <label>
                 <input type="radio" name="payload_concern" value="<%= row_presenter.concern %>"
-                                                             data-single="<%= new_polymorphic_path([main_app, row_presenter.concern]) %>"
-                                                             data-batch="<%= hyrax.new_batch_upload_path(payload_concern: row_presenter.concern) %>">
+                                                             data-single="<%= row_presenter.switch_to_new_work_path(route_set: main_app, params: params) %>"
+                                                             data-batch="<%= row_presenter.switch_to_batch_upload_path(route_set: hyrax, params: params) %>">
                 <div class="select-work-icon">
                   <span class="<%= row_presenter.icon_class %>"></span>
                 </div>

data/artifacts/entity-relationship-diagram.dot

@@ -0,0 +1,76 @@
+digraph models_diagram {
+  graph[overlap=false, splines=true]
+  compound=true;
+  node[shape=Mrecord margin="0.25, 0.125"]
+  label="Hyrax Admin Set and Workflow ERD\nClick on the nodes to see the source code"
+
+  subgraph 0 {
+    node[color=green penwidth=2]
+    "AdminSet" [label="{ AdminSet | Root concept for deposit }" URL="http://github.com/samvera/hyrax/blob/master/app/models/admin_set.rb";]
+    "PermissionTemplate" [label="{ Hyrax::PermissionTemplate | Permissions to apply\nto deposited items }" URL="http://github.com/samvera/hyrax/blob/master/app/models/hyrax/permission_template.rb";]
+    "Sipity::Workflow" [label="{ Sipity::Workflow | State machine for \ntransitioning Work's state }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow.rb";]
+  }
+
+  subgraph 2 {
+    node[color=blue penwidth=2]
+    "Sipity::Agent" [label="{ Sipity::Agent | proxy for user or group }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/agent.rb";]
+    "User" [label="{ User | \<Conceptual\> }"]
+    "Group" [label="{ Group | \<Conceptual\> }"]
+    "GroupMembership" [label="{ GroupMembership  | \<Conceptual\> }"]
+  }
+
+  subgraph 3 {
+    "Sipity::EntitySpecificResponsibility" [label="{ Sipity::EntitySpecificResponsibility | The given Sipity::Agent\n has the given role\n for the specific work }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/entity_specific_responsibility.rb";]
+    "Sipity::WorkflowAction" [label="{ Sipity::WorkflowAction | The valid actions\n for the given workflow }"] [URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_action.rb";]
+    "Sipity::WorkflowResponsibility" [label="{ Sipity::WorkflowResponsibility | The given Sipity::Agent\n has the given role\n for all works in this workflow }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_responsibility.rb";]
+    "Sipity::WorkflowRole" [label="{ Sipity::WorkflowRole | The valid roles \n for the given workflow }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_role.rb";]
+    "Sipity::WorkflowState" [label="{ Sipity::WorkflowState | The valid states\n for the given workflow }"] [URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_state.rb";]
+    "Sipity::WorkflowStateAction" [label="{ Sipity::WorkflowStateAction | The actions that can\n be taken for the\n given workflow & state }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_state_action.rb";]
+    "Sipity::WorkflowStateActionPermission" [label="{ Sipity::WorkflowStateActionPermission | The role required to \n take the action \n for the given workflow }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_state_action_permission.rb";]
+    "Sipity::Role" [label="{ Sipity::Role | All of the named \n roles for the site }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/role.rb";]
+    "Sipity::Method" [label=" { Sipity::Method | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/method.rb";]
+  }
+
+  subgraph 4 {
+    node[color=gold penwidth=2]
+    "Sipity::NotifiableContext" [label=" { Sipity::NotifiableContext | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/notifiable_context.rb";]
+    "Sipity::Notification" [label=" { Sipity::Notification | A type of notification to send }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/notification.rb";]
+    "Sipity::NotificationRecipient" [label=" { Sipity::NotificationRecipient | Who receives the notification }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/notification_recipient.rb";]
+  }
+
+  subgraph 1 {
+    node[color=red penwidth=2]
+    "AbstractWork" [label="{ Work |  \<Conceptual\> | \<Generated\> }"]
+    "Sipity::Entity"  [label="{ Sipity::Entity | A database proxy for \n a Work in Fedora }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/entity.rb";]
+  }
+
+  "AdminSet" -> "PermissionTemplate" [arrowtail=none, arrowhead=none, dir=both]
+  "User" -> "GroupMembership" [arrowtail=none, arrowhead=crow, dir=both]
+  "Group" -> "GroupMembership" [arrowtail=none, arrowhead=crow, dir=both]
+  "PermissionTemplate" -> "Sipity::Workflow"  [label="possible" color=gold fontcolor=gold arrowtail=none, arrowhead=crow, dir=both]
+  "PermissionTemplate" -> "Sipity::Workflow"  [label="active" arrowtail=none, arrowhead=none, dir=both]
+  "Sipity::Entity" -> "Sipity::Workflow"  [arrowtail=crow, arrowhead=none, dir=both]
+  "AbstractWork" -> "AdminSet"  [arrowtail=crow, arrowhead=none, dir=both]
+  "Sipity::Entity" -> "AbstractWork" [arrowtail=none, arrowhead=none, dir=both]
+  "Sipity::Entity" -> "Sipity::EntitySpecificResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Agent" -> "Sipity::EntitySpecificResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowRole" -> "Sipity::EntitySpecificResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Workflow" -> "Sipity::WorkflowState" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Workflow" -> "Sipity::WorkflowAction" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Workflow" -> "Sipity::WorkflowRole" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowAction" -> "Sipity::WorkflowStateAction" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowState" -> "Sipity::WorkflowAction" [label="resulting_workflow_state" color=purple fontcolor=purple arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowState" -> "Sipity::WorkflowStateAction" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowStateAction" -> "Sipity::WorkflowStateActionPermission" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowRole" -> "Sipity::WorkflowStateActionPermission" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Role" -> "Sipity::WorkflowRole" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowRole" -> "Sipity::WorkflowResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowAction" -> "Sipity::Method" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Agent" -> "Sipity::WorkflowResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Agent" -> "Group" [label="as proxy" arrowtail=none, arrowhead=none, dir=both]
+  "Sipity::Agent" -> "User" [label="as proxy" arrowtail=none, arrowhead=none, dir=both]
+  "Sipity::WorkflowState" -> "Sipity::Entity" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::WorkflowAction" -> "Sipity::NotifiableContext" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::NotifiableContext" -> "Sipity::Notification" [arrowtail=none, arrowhead=crow, dir=both]
+  "Sipity::Notification" -> "Sipity::NotificationRecipient" [arrowtail=none, arrowhead=crow, dir=both]
+}

data/config/brakeman.ignore

@@ -0,0 +1,105 @@
+{
+  "ignored_warnings": [
+    {
+      "warning_type": "SQL Injection",
+      "warning_code": 0,
+      "fingerprint": "3becf9f631534695c52fd8f73b52d0106531e4c2d89dce371267efb2f2d69ad2",
+      "check_name": "SQL",
+      "message": "Possible SQL injection",
+      "file": "app/controllers/hyrax/users_controller.rb",
+      "line": 35,
+      "link": "http://brakemanscanner.org/docs/warning_types/sql_injection/",
+      "code": "::User.where(*base_query).where(\"#{Hydra.config.user_key_field} like lower(?) OR display_name like lower(?)\", (nil or ((\"%\" + query.downcase) + \"%\")), (nil or ((\"%\" + query.downcase) + \"%\")))",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Hyrax::UsersController",
+        "method": "search"
+      },
+      "user_input": "Hydra.config.user_key_field",
+      "confidence": "Weak",
+      "note": ""
+    },
+    {
+      "warning_type": "Command Injection",
+      "warning_code": 14,
+      "fingerprint": "4e8248816e1ec892a23bec95d9436e09eea45ace7460811086c6c831a439833e",
+      "check_name": "Execute",
+      "message": "Possible command injection",
+      "file": "lib/hyrax/controlled_vocabulary/importer/language.rb",
+      "line": 41,
+      "link": "http://brakemanscanner.org/docs/warning_types/command_injection/",
+      "code": "system(\"gunzip #{download_path}\")",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Hyrax::ControlledVocabulary::Importer::Language",
+        "method": "extract"
+      },
+      "user_input": "download_path",
+      "confidence": "Medium",
+      "note": ""
+    },
+    {
+      "warning_type": "Cross Site Scripting",
+      "warning_code": 4,
+      "fingerprint": "5496595e01ffb5b2e2d79b371c5af19b9d822561a99b38992537cfa03ff7e38f",
+      "check_name": "LinkToHref",
+      "message": "Unsafe parameter value in link_to href",
+      "file": "app/views/hyrax/my/_facet_selected.html.erb",
+      "line": 7,
+      "link": "http://brakemanscanner.org/docs/warning_types/link_to_href",
+      "code": "link_to(\"X\", hyrax.url_for(remove_facet_params(k, selected_facet, params).merge(:action => :index)), :class => \"close\", :data => ({ :dismiss => \"alert\" }))",
+      "render_path": [{"type":"template","name":"hyrax/collections/edit","line":26,"file":"app/views/hyrax/collections/edit.html.erb"}],
+      "location": {
+        "type": "template",
+        "template": "hyrax/my/_facet_selected"
+      },
+      "user_input": "params",
+      "confidence": "Medium",
+      "note": ""
+    },
+    {
+      "warning_type": "SQL Injection",
+      "warning_code": 0,
+      "fingerprint": "9f736ca3e9b879bc7059d894fab1328a959b14574b90a991caef19fa8124b2f5",
+      "check_name": "SQL",
+      "message": "Possible SQL injection",
+      "file": "app/controllers/hyrax/users_controller.rb",
+      "line": 38,
+      "link": "http://brakemanscanner.org/docs/warning_types/sql_injection/",
+      "code": "::User.where(*base_query).where(\"#{Hydra.config.user_key_field} like lower(?) OR display_name like lower(?)\", (nil or ((\"%\" + query.downcase) + \"%\")), (nil or ((\"%\" + query.downcase) + \"%\"))).registered.where(\"#{Hydra.config.user_key_field} not in (?)\", [::User.batch_user_key, ::User.audit_user_key])",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Hyrax::UsersController",
+        "method": "search"
+      },
+      "user_input": "Hydra.config.user_key_field",
+      "confidence": "Weak",
+      "note": ""
+    },
+    {
+      "warning_type": "SQL Injection",
+      "warning_code": 0,
+      "fingerprint": "fd7b410ad29f31e1a743f3b9fff7fe4bb2a2ae2fb2d5f22336c40c5b93374218",
+      "check_name": "SQL",
+      "message": "Possible SQL injection",
+      "file": "app/models/concerns/hyrax/user.rb",
+      "line": 27,
+      "link": "http://brakemanscanner.org/docs/warning_types/sql_injection/",
+      "code": "where(\"#{Hydra.config.user_key_field} not in (?)\", [::User.batch_user_key, ::User.audit_user_key])",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Hyrax::User",
+        "method": null
+      },
+      "user_input": "Hydra.config.user_key_field",
+      "confidence": "Medium",
+      "note": ""
+    }
+  ],
+  "updated": "2017-06-09 16:31:04 -0500",
+  "brakeman_version": "3.6.2"
+}

data/config/features.rb

@@ -26,4 +26,8 @@ Flipflop.configure do
   feature :active_deposit_agreement_acceptance,
           default: Hyrax.config.active_deposit_agreement_acceptance?,
           description: "Require an active acceptance of the deposit agreement by checking a checkbox"
+
+  feature :batch_upload,
+          default: true,
+          description: "Enable uploading batches of works"
 end

data/config/i18n-tasks.yml

@@ -0,0 +1,127 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `File.find` patterns where translations are read from:
+  read:
+    ## Default:
+    # - config/locales/%{locale}.yml
+    ## More files:
+    - config/locales/*.%{locale}.yml
+    - lib/generators/hyrax/templates/config/locales/hyrax.%{locale}.yml
+    # ERB is not supported by i18n-tasks. Keep this line here to remind peeps to update these manually
+    # - lib/generators/hyrax/work/templates/locale.%{locale}.yml.erb
+    ## Another gem (replace %#= with %=):
+    # - "<%#= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
+  write:
+    ## For example, write devise and simple form keys to their respective files:
+    - ['{hyrax, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+    - lib/generators/hyrax/templates/config/locales/hyrax.%{locale}.yml
+    # ERB is not supported by i18n-tasks. Keep this line here to remind peeps to update these manually
+    # - lib/generators/hyrax/work/templates/locale.%{locale}.yml.erb
+
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: conservative_router
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/mailers
+  #   - app/presenters
+  #   - app/views
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+    - app/assets/videos
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # only: ["*.rb", "*.html.slim"]
+
+  ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
+  # strict: true
+
+  ## Multiple scanners can be used. Their results are merged.
+  ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
+  ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
+
+## Google Translate
+# translation:
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   api_key: "AbC-dEf5"
+
+## Do not consider these keys missing:
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used:
+# ignore_unused:
+# - 'activerecord.attributes.*'
+# - '{devise,kaminari,will_paginate}.*'
+# - 'simple_form.{yes,no}'
+# - 'simple_form.{placeholders,hints,labels}.*'
+# - 'simple_form.{error_notification,required}.:'
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*
+
+## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
+## e.g. in case of a relative key defined in a helper method.
+## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       only: %w(*.html.haml *.html.slim),
+#       patterns: [['= title\b', '.page_title']] %>
+#
+# The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>