decidim-core 0.22.0 → 0.23.3

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

Potentially problematic release.


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

Files changed (334) hide show
  1. checksums.yaml +4 -4
  2. data/app/assets/config/decidim_core_manifest.js +5 -0
  3. data/app/assets/javascripts/decidim.js.es6 +2 -0
  4. data/app/assets/javascripts/decidim/ajax_modals.js.es6 +3 -3
  5. data/app/assets/javascripts/decidim/confirm.js.es6 +3 -2
  6. data/app/assets/javascripts/decidim/core/bundle.js +1 -1
  7. data/app/assets/javascripts/decidim/core/bundle.js.map +1 -1
  8. data/app/assets/javascripts/decidim/diff_mode_dropdown.js.es6 +18 -4
  9. data/app/assets/javascripts/decidim/editor.js.es6 +4 -4
  10. data/app/assets/javascripts/decidim/geocoding.js.es6 +60 -0
  11. data/app/assets/javascripts/decidim/geocoding/attach_input.js.es6 +106 -0
  12. data/app/assets/javascripts/decidim/geocoding/format_address.js.es6 +29 -0
  13. data/app/assets/javascripts/decidim/geocoding/provider/here.js.es6 +107 -0
  14. data/app/assets/javascripts/decidim/geocoding/provider/photon.js.es6 +77 -0
  15. data/app/assets/javascripts/decidim/map.js.es6 +34 -124
  16. data/app/assets/javascripts/decidim/map/controller.js.es6 +92 -0
  17. data/app/assets/javascripts/decidim/map/controller/markers.js.es6 +65 -0
  18. data/app/assets/javascripts/decidim/map/controller/static.es6 +48 -0
  19. data/app/assets/javascripts/decidim/map/factory.js.es6 +51 -0
  20. data/app/assets/javascripts/decidim/map/icon.js.es6 +31 -0
  21. data/app/assets/javascripts/decidim/map/legacy.js.es6 +87 -0
  22. data/app/assets/javascripts/decidim/map/provider/default.js.es6 +22 -0
  23. data/app/assets/javascripts/decidim/map/provider/here.js.es6 +22 -0
  24. data/app/assets/javascripts/decidim/security/selfxss_warning.js.es6 +19 -0
  25. data/app/assets/stylesheets/decidim/_decidim.scss +2 -0
  26. data/app/assets/stylesheets/decidim/layouts/_home.scss +5 -0
  27. data/app/assets/stylesheets/decidim/modules/_cards.scss +15 -0
  28. data/app/assets/stylesheets/decidim/modules/_forms.scss +14 -0
  29. data/app/assets/stylesheets/decidim/modules/_layout.scss +11 -3
  30. data/app/assets/stylesheets/decidim/modules/_map.scss +35 -0
  31. data/app/assets/stylesheets/decidim/modules/_progress-bar.scss +4 -0
  32. data/app/assets/stylesheets/decidim/modules/_reveal.scss +5 -0
  33. data/app/assets/stylesheets/decidim/modules/_status-labels.scss +2 -1
  34. data/app/cells/decidim/author/flag.erb +1 -1
  35. data/app/cells/decidim/author/profile_inline.erb +2 -2
  36. data/app/cells/decidim/author_cell.rb +5 -2
  37. data/app/cells/decidim/card_cell.rb +21 -7
  38. data/app/cells/decidim/card_m/show.erb +1 -1
  39. data/app/cells/decidim/card_m_cell.rb +6 -4
  40. data/app/cells/decidim/collapsible_authors_cell.rb +1 -1
  41. data/app/cells/decidim/content_blocks/sub_hero/show.erb +3 -1
  42. data/app/cells/decidim/diff/diff_mode_html.erb +5 -5
  43. data/app/cells/decidim/follow_button/show.erb +6 -6
  44. data/app/cells/decidim/follow_button_cell.rb +8 -0
  45. data/app/cells/decidim/progress_bar/show.erb +11 -4
  46. data/app/cells/decidim/progress_bar_cell.rb +20 -1
  47. data/app/cells/decidim/tos_page/announcement.erb +0 -1
  48. data/app/cells/decidim/tos_page/form.erb +17 -0
  49. data/app/cells/decidim/translation_bar/show.erb +6 -0
  50. data/app/cells/decidim/translation_bar_cell.rb +52 -0
  51. data/app/cells/decidim/version_cell.rb +1 -1
  52. data/app/cells/decidim/versions_list_cell.rb +1 -1
  53. data/app/commands/decidim/amendable/accept.rb +9 -3
  54. data/app/commands/decidim/amendable/create_draft.rb +2 -0
  55. data/app/commands/decidim/amendable/update_draft.rb +2 -0
  56. data/app/commands/decidim/attachment_methods.rb +20 -5
  57. data/app/commands/decidim/destroy_account.rb +1 -0
  58. data/app/commands/decidim/gallery_methods.rb +16 -9
  59. data/app/commands/decidim/messaging/reply_to_conversation.rb +1 -1
  60. data/app/commands/decidim/multiple_attachments_methods.rb +56 -0
  61. data/app/controllers/concerns/decidim/devise_controllers.rb +1 -0
  62. data/app/controllers/concerns/decidim/filter_resource.rb +24 -6
  63. data/app/controllers/concerns/decidim/flaggable.rb +20 -0
  64. data/app/controllers/concerns/decidim/force_authentication.rb +1 -0
  65. data/app/controllers/concerns/decidim/impersonate_users.rb +1 -1
  66. data/app/controllers/concerns/decidim/needs_snippets.rb +20 -0
  67. data/app/controllers/concerns/decidim/paginable.rb +5 -1
  68. data/app/controllers/concerns/decidim/withdrawable.rb +20 -0
  69. data/app/controllers/decidim/application_controller.rb +16 -0
  70. data/app/controllers/decidim/components/base_controller.rb +6 -1
  71. data/app/controllers/decidim/cookie_policy_controller.rb +6 -3
  72. data/app/controllers/decidim/messaging/conversations_controller.rb +5 -2
  73. data/app/forms/decidim/account_form.rb +5 -1
  74. data/app/forms/decidim/amendable/create_form.rb +1 -1
  75. data/app/forms/decidim/amendable/form.rb +44 -3
  76. data/app/forms/decidim/attachment_form.rb +6 -1
  77. data/app/forms/decidim/user_group_form.rb +5 -1
  78. data/app/helpers/decidim/cells_helper.rb +3 -15
  79. data/app/helpers/decidim/check_boxes_tree_helper.rb +21 -12
  80. data/app/helpers/decidim/cookies_helper.rb +1 -1
  81. data/app/helpers/decidim/decidim_form_helper.rb +1 -1
  82. data/app/helpers/decidim/filter_params_helper.rb +30 -0
  83. data/app/helpers/decidim/map_helper.rb +86 -23
  84. data/app/helpers/decidim/orders_helper.rb +6 -1
  85. data/app/helpers/decidim/paginate_helper.rb +1 -8
  86. data/app/helpers/decidim/sanitize_helper.rb +8 -0
  87. data/app/helpers/decidim/scopes_helper.rb +5 -5
  88. data/app/helpers/decidim/translations_helper.rb +7 -1
  89. data/app/jobs/decidim/data_portability_export_job.rb +3 -3
  90. data/app/jobs/decidim/machine_translation_fields_job.rb +30 -0
  91. data/app/jobs/decidim/machine_translation_resource_job.rb +113 -0
  92. data/app/jobs/decidim/machine_translation_save_job.rb +33 -0
  93. data/app/jobs/decidim/open_data_job.rb +1 -1
  94. data/app/mailers/decidim/application_mailer.rb +1 -0
  95. data/app/mailers/decidim/reported_mailer.rb +8 -1
  96. data/app/models/decidim/action_log.rb +1 -1
  97. data/app/models/decidim/area.rb +3 -0
  98. data/app/models/decidim/area_type.rb +4 -0
  99. data/app/models/decidim/attachment.rb +30 -2
  100. data/app/models/decidim/attachment_collection.rb +3 -0
  101. data/app/models/decidim/authorization.rb +3 -0
  102. data/app/models/decidim/category.rb +4 -0
  103. data/app/models/decidim/component.rb +7 -0
  104. data/app/models/decidim/content_block.rb +11 -1
  105. data/app/models/decidim/contextual_help_section.rb +4 -0
  106. data/app/models/decidim/follow.rb +3 -1
  107. data/app/models/decidim/messaging/message.rb +1 -1
  108. data/app/models/decidim/moderation.rb +1 -1
  109. data/app/models/decidim/newsletter.rb +3 -0
  110. data/app/models/decidim/oauth_application.rb +2 -0
  111. data/app/models/decidim/organization.rb +54 -10
  112. data/app/models/decidim/scope.rb +4 -1
  113. data/app/models/decidim/scope_type.rb +3 -0
  114. data/app/models/decidim/share_token.rb +49 -0
  115. data/app/models/decidim/static_page.rb +4 -1
  116. data/app/models/decidim/static_page_topic.rb +3 -0
  117. data/app/models/decidim/user.rb +11 -3
  118. data/app/models/decidim/user_base_entity.rb +6 -2
  119. data/app/permissions/decidim/permissions.rb +9 -0
  120. data/app/presenters/decidim/admin_log/component_presenter.rb +2 -2
  121. data/app/presenters/decidim/admin_log/moderation_presenter.rb +2 -2
  122. data/app/presenters/decidim/admin_log/organization_presenter.rb +2 -2
  123. data/app/presenters/decidim/admin_log/user_presenter.rb +2 -2
  124. data/app/presenters/decidim/log/base_presenter.rb +10 -2
  125. data/app/presenters/decidim/log/value_types/default_presenter.rb +1 -1
  126. data/app/presenters/decidim/official_author_presenter.rb +36 -0
  127. data/app/presenters/decidim/resource_locator_presenter.rb +63 -12
  128. data/app/queries/decidim/similar_emendations.rb +4 -4
  129. data/app/scrubbers/decidim/newsletter_scrubber.rb +31 -0
  130. data/app/scrubbers/decidim/user_input_scrubber.rb +1 -1
  131. data/app/serializers/decidim/importers/participatory_space_components_importer.rb +1 -1
  132. data/app/services/decidim/base_diff_renderer.rb +17 -0
  133. data/app/services/decidim/open_data_exporter.rb +2 -0
  134. data/app/services/decidim/resource_search.rb +95 -6
  135. data/app/services/decidim/static_map_generator.rb +10 -26
  136. data/app/services/decidim/tokenizer.rb +38 -0
  137. data/app/services/decidim/traceability.rb +3 -0
  138. data/app/uploaders/decidim/application_uploader.rb +19 -1
  139. data/app/uploaders/decidim/attachment_uploader.rb +23 -17
  140. data/app/uploaders/decidim/banner_image_uploader.rb +1 -1
  141. data/app/uploaders/decidim/hero_image_uploader.rb +1 -1
  142. data/app/uploaders/decidim/homepage_image_uploader.rb +1 -1
  143. data/app/uploaders/decidim/image_uploader.rb +6 -2
  144. data/app/uploaders/decidim/oauth_application_logo_uploader.rb +1 -1
  145. data/app/uploaders/decidim/official_image_footer_uploader.rb +1 -1
  146. data/app/uploaders/decidim/official_image_header_uploader.rb +1 -1
  147. data/app/uploaders/decidim/organization_logo_uploader.rb +1 -1
  148. data/app/uploaders/decidim/record_image_uploader.rb +15 -0
  149. data/app/validators/etiquette_validator.rb +0 -7
  150. data/app/validators/geocoding_validator.rb +9 -4
  151. data/app/validators/passthru_validator.rb +111 -0
  152. data/app/validators/scope_belongs_to_component_validator.rb +16 -0
  153. data/app/validators/uploader_content_type_validator.rb +44 -0
  154. data/app/views/decidim/authorization_modals/_content.html.erb +2 -2
  155. data/app/views/decidim/devise/registrations/new.html.erb +3 -1
  156. data/app/views/decidim/devise/sessions/new.html.erb +3 -1
  157. data/app/views/decidim/messaging/conversations/_error_modal.html.erb +21 -0
  158. data/app/views/decidim/messaging/conversations/error.js.erb +10 -0
  159. data/app/views/decidim/newsletter_mailer/newsletter.html.erb +1 -1
  160. data/app/views/decidim/notification_mailer/event_received.html.erb +2 -2
  161. data/app/views/decidim/pages/_standalone.html.erb +1 -1
  162. data/app/views/decidim/pages/_tabbed.html.erb +1 -1
  163. data/app/views/decidim/reported_mailer/report.html.erb +49 -3
  164. data/app/views/decidim/scopes/_scopes_picker_input.html.erb +15 -14
  165. data/app/views/decidim/searches/_filters.html.erb +1 -0
  166. data/app/views/decidim/shared/_login_modal.html.erb +14 -3
  167. data/app/views/decidim/shared/_static_map.html.erb +1 -1
  168. data/app/views/layouts/decidim/_head.html.erb +2 -0
  169. data/app/views/layouts/decidim/_js_configuration.html.erb +7 -1
  170. data/config/locales/am-ET.yml +1 -0
  171. data/config/locales/ar.yml +3 -4
  172. data/config/locales/bg.yml +1508 -0
  173. data/config/locales/ca.yml +36 -9
  174. data/config/locales/cs.yml +54 -27
  175. data/config/locales/da.yml +1 -0
  176. data/config/locales/de.yml +156 -128
  177. data/config/locales/el.yml +0 -4
  178. data/config/locales/en.yml +30 -3
  179. data/config/locales/eo.yml +92 -0
  180. data/config/locales/es-MX.yml +29 -2
  181. data/config/locales/es-PY.yml +28 -1
  182. data/config/locales/es.yml +44 -17
  183. data/config/locales/et.yml +1 -0
  184. data/config/locales/eu.yml +9 -4
  185. data/config/locales/fi-plain.yml +28 -1
  186. data/config/locales/fi.yml +34 -7
  187. data/config/locales/fr-CA.yml +32 -4
  188. data/config/locales/fr.yml +65 -37
  189. data/config/locales/ga-IE.yml +0 -8
  190. data/config/locales/gl.yml +10 -5
  191. data/config/locales/hr.yml +1 -0
  192. data/config/locales/hu.yml +7 -5
  193. data/config/locales/id-ID.yml +3 -4
  194. data/config/locales/is-IS.yml +3 -9
  195. data/config/locales/is.yml +463 -0
  196. data/config/locales/it.yml +37 -9
  197. data/config/locales/ja-JP.yml +25 -16
  198. data/config/locales/ja.yml +1605 -0
  199. data/config/locales/ko-KR.yml +1 -0
  200. data/config/locales/ko.yml +1 -0
  201. data/config/locales/lt.yml +1 -0
  202. data/config/locales/{lv-LV.yml → lv.yml} +2 -5
  203. data/config/locales/mt.yml +1 -0
  204. data/config/locales/nl.yml +34 -12
  205. data/config/locales/no.yml +150 -8
  206. data/config/locales/om-ET.yml +1 -0
  207. data/config/locales/pl.yml +89 -72
  208. data/config/locales/pt-BR.yml +4 -5
  209. data/config/locales/pt.yml +10 -4
  210. data/config/locales/ro-RO.yml +10 -4
  211. data/config/locales/ru.yml +3 -10
  212. data/config/locales/si-LK.yml +1 -0
  213. data/config/locales/sk.yml +3 -5
  214. data/config/locales/sl.yml +8 -7
  215. data/config/locales/so-SO.yml +1 -0
  216. data/config/locales/sr-CS.yml +0 -9
  217. data/config/locales/sv.yml +19 -8
  218. data/config/locales/sw-KE.yml +1 -0
  219. data/config/locales/ti-ER.yml +1 -0
  220. data/config/locales/tr-TR.yml +588 -247
  221. data/config/locales/uk.yml +3 -11
  222. data/config/locales/vi-VN.yml +1 -0
  223. data/config/locales/vi.yml +1 -0
  224. data/config/locales/zh-CN.yml +1584 -0
  225. data/config/locales/zh-TW.yml +1 -0
  226. data/db/migrate/20200525184143_add_enable_machine_translation_to_decidim_organizations.rb +7 -0
  227. data/db/migrate/20200702073419_create_decidim_share_tokens.rb +16 -0
  228. data/db/migrate/20200707132401_add_comments_max_length_to_decidim_organization.rb +7 -0
  229. data/db/migrate/20200730142511_add_file_upload_settings_to_decidim_organizations.rb +36 -0
  230. data/db/migrate/20200806092109_add_machine_translation_display_priority_to_organizations.rb +17 -0
  231. data/db/migrate/20201004160335_remove_notifications_with_continuity_badge.rb +9 -0
  232. data/db/seeds.rb +12 -6
  233. data/lib/decidim/authorable.rb +22 -1
  234. data/lib/decidim/authorization_form_builder.rb +7 -0
  235. data/lib/decidim/coauthorable.rb +22 -0
  236. data/lib/decidim/component_manifest.rb +1 -1
  237. data/lib/decidim/content_processor.rb +52 -29
  238. data/lib/decidim/content_renderers/base_renderer.rb +1 -1
  239. data/lib/decidim/content_renderers/hashtag_renderer.rb +2 -0
  240. data/lib/decidim/content_renderers/link_renderer.rb +4 -1
  241. data/lib/decidim/content_renderers/user_group_renderer.rb +3 -1
  242. data/lib/decidim/content_renderers/user_renderer.rb +3 -1
  243. data/lib/decidim/core.rb +67 -12
  244. data/lib/decidim/core/engine.rb +65 -21
  245. data/lib/decidim/core/test.rb +8 -0
  246. data/lib/decidim/core/test/factories.rb +34 -8
  247. data/lib/decidim/core/test/shared_examples/admin_log_presenter_examples.rb +34 -0
  248. data/lib/decidim/core/test/shared_examples/amendable/accept_amendment_examples.rb +4 -4
  249. data/lib/decidim/core/test/shared_examples/amendable_proposals_interface_examples.rb +8 -8
  250. data/lib/decidim/core/test/shared_examples/comments_examples.rb +52 -1
  251. data/lib/decidim/core/test/shared_examples/counts_commentators_as_newsletter_participants.rb +31 -0
  252. data/lib/decidim/core/test/shared_examples/embed_resource_examples.rb +49 -0
  253. data/lib/decidim/core/test/shared_examples/follows_examples.rb +3 -3
  254. data/lib/decidim/core/test/shared_examples/manage_component_share_tokens.rb +83 -0
  255. data/lib/decidim/core/test/shared_examples/map_examples.rb +186 -0
  256. data/lib/decidim/core/test/shared_examples/preview_component_with_share_token_examples.rb +55 -0
  257. data/lib/decidim/core/test/shared_examples/resource_search_examples.rb +200 -0
  258. data/lib/decidim/core/test/shared_examples/scopable_resource_examples.rb +43 -0
  259. data/lib/decidim/core/test/shared_examples/scope_helper_examples.rb +12 -1
  260. data/lib/decidim/core/test/shared_examples/searchable_participatory_space_examples.rb +2 -2
  261. data/lib/decidim/core/test/shared_examples/searchable_results_examples.rb +15 -2
  262. data/lib/decidim/core/test/shared_examples/simple_event.rb +7 -0
  263. data/lib/decidim/core/test/shared_examples/system_endorse_resource_examples.rb +1 -0
  264. data/lib/decidim/core/test/shared_examples/traceable_interface_examples.rb +1 -1
  265. data/lib/decidim/core/test/shared_examples/uncommentable_component_examples.rb +1 -1
  266. data/lib/decidim/core/version.rb +1 -1
  267. data/lib/decidim/diffy_extension.rb +21 -0
  268. data/lib/decidim/events/base_event.rb +29 -11
  269. data/lib/decidim/exporters.rb +7 -0
  270. data/lib/decidim/exporters/csv.rb +15 -1
  271. data/lib/decidim/exporters/excel.rb +1 -1
  272. data/lib/decidim/exporters/export_manifest.rb +29 -0
  273. data/lib/decidim/exporters/pdf.rb +56 -0
  274. data/lib/decidim/file_validator_humanizer.rb +98 -0
  275. data/lib/decidim/form_builder.rb +68 -56
  276. data/lib/decidim/geocodable.rb +79 -0
  277. data/lib/decidim/has_attachments.rb +10 -0
  278. data/lib/decidim/has_private_users.rb +1 -1
  279. data/lib/decidim/has_upload_validations.rb +36 -0
  280. data/lib/decidim/map.rb +214 -0
  281. data/lib/decidim/map/autocomplete.rb +67 -0
  282. data/lib/decidim/map/dynamic_map.rb +89 -0
  283. data/lib/decidim/map/frontend.rb +97 -0
  284. data/lib/decidim/map/geocoding.rb +115 -0
  285. data/lib/decidim/map/provider.rb +12 -0
  286. data/lib/decidim/map/provider/autocomplete/here.rb +20 -0
  287. data/lib/decidim/map/provider/autocomplete/osm.rb +20 -0
  288. data/lib/decidim/map/provider/dynamic_map/here.rb +51 -0
  289. data/lib/decidim/map/provider/dynamic_map/osm.rb +13 -0
  290. data/lib/decidim/map/provider/geocoding/here.rb +58 -0
  291. data/lib/decidim/map/provider/geocoding/osm.rb +30 -0
  292. data/lib/decidim/map/provider/here.rb +21 -0
  293. data/lib/decidim/map/provider/osm.rb +22 -0
  294. data/lib/decidim/map/provider/static_map/here.rb +35 -0
  295. data/lib/decidim/map/provider/static_map/osm.rb +29 -0
  296. data/lib/decidim/map/static_map.rb +133 -0
  297. data/lib/decidim/map/utility.rb +38 -0
  298. data/lib/decidim/newsletter_participant.rb +2 -4
  299. data/lib/decidim/organization_settings.rb +267 -0
  300. data/lib/decidim/paddable.rb +11 -4
  301. data/lib/decidim/resource_manifest.rb +1 -1
  302. data/lib/decidim/scopable.rb +9 -6
  303. data/lib/decidim/scopable_component.rb +29 -1
  304. data/lib/decidim/scopable_participatory_space.rb +19 -0
  305. data/lib/decidim/scopable_resource.rb +21 -0
  306. data/lib/decidim/search_resource_fields_mapper.rb +17 -4
  307. data/lib/decidim/searchable.rb +6 -0
  308. data/lib/decidim/settings_manifest.rb +2 -1
  309. data/lib/decidim/shareable_with_token.rb +27 -0
  310. data/lib/decidim/snippets.rb +30 -0
  311. data/lib/decidim/translatable_attributes.rb +42 -4
  312. data/lib/decidim/translatable_resource.rb +78 -0
  313. data/lib/decidim/view_model.rb +1 -0
  314. data/lib/premailer/adapter/decidim.rb +33 -0
  315. data/lib/tasks/decidim_locales_tasks.rake +35 -0
  316. data/lib/tasks/decidim_tasks.rake +1 -0
  317. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.bg.js +14 -0
  318. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.da.js +14 -0
  319. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.eo.js +17 -0
  320. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.et.js +18 -0
  321. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.fr-CA.js +16 -0
  322. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.ga.js +15 -0
  323. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.hr.js +13 -0
  324. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.is.js +14 -0
  325. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.ja.js +16 -0
  326. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.lt.js +16 -0
  327. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.lv.js +17 -0
  328. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.mt.js +15 -0
  329. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.sl.js +14 -0
  330. data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.sr.js +16 -0
  331. metadata +149 -30
  332. data/app/cells/decidim/tos_page/sticky_form.erb +0 -29
  333. data/app/helpers/decidim/multi_translation_helper.rb +0 -0
  334. data/lib/decidim/hashtaggable.rb +0 -24
@@ -0,0 +1,67 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ # A base class for autocomplete geocoding functionality, common to all
6
+ # autocomplete map services.
7
+ class Autocomplete < Map::Frontend
8
+ # A builder for the geocoding autocompletion to be attached to the views.
9
+ # Provides all the necessary functionality to initialize the front-end
10
+ # geocoding autocompletion functionality.
11
+ class Builder < Decidim::Map::Frontend::Builder
12
+ # Displays the geocoding field element's markup for the view.
13
+ #
14
+ # @param object_name [String, Symbol] The name for the object for which
15
+ # the field is generated for.
16
+ # @param method [String, Symbol] The method/property in the object that
17
+ # the field is for.
18
+ # @param options [Hash] Extra options for the field.
19
+ # @return [String] The field element's markup.
20
+ def geocoding_field(object_name, method, options = {})
21
+ options[:autocomplete] ||= "off"
22
+
23
+ template.text_field(
24
+ object_name,
25
+ method,
26
+ options.merge("data-decidim-geocoding" => view_options.to_json)
27
+ )
28
+ end
29
+ end
30
+
31
+ # This module will be included in the main application's form builder in
32
+ # order to provide the geocoding_field method for the normal form
33
+ # builders. This allows you to include geocoding autocompletion in the
34
+ # forms using the following code:
35
+ #
36
+ # <%= form_for record do |form| %>
37
+ # <%= form.geocoding_field(:address) %>
38
+ # <% end %>
39
+ module FormBuilder
40
+ def geocoding_field(attribute, options = {}, geocoding_options = {})
41
+ @autocomplete_utility ||= Decidim::Map.autocomplete(
42
+ organization: @template.current_organization
43
+ )
44
+ return text_field(attribute, options) unless @autocomplete_utility
45
+
46
+ # Decidim::Map::Autocomplete::Builder
47
+ builder = @autocomplete_utility.create_builder(
48
+ @template,
49
+ geocoding_options
50
+ )
51
+
52
+ unless @template.snippets.any?(:geocoding)
53
+ @template.snippets.add(:geocoding, builder.stylesheet_snippets)
54
+ @template.snippets.add(:geocoding, builder.javascript_snippets)
55
+
56
+ # This will display the snippets in the <head> part of the page.
57
+ @template.snippets.add(:head, @template.snippets.for(:geocoding))
58
+ end
59
+
60
+ field(attribute, options) do |opts|
61
+ builder.geocoding_field(@object_name, attribute, opts)
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,89 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ # A base class for dynamic mapping functionality, common to all dynamic map
6
+ # services.
7
+ class DynamicMap < Map::Frontend
8
+ # Creates a builder class for the front-end that is used to build the map
9
+ # HTML markup.
10
+ #
11
+ # @param (see Decidim::Map::DynamicMap::Builder#initialize)
12
+ #
13
+ # @return [Decidim::Map::DynamicMap::Builder] The builder object that can
14
+ # be used to build the map's markup.
15
+ def create_builder(template, options = {})
16
+ builder_class.new(template, builder_options.merge(options))
17
+ end
18
+
19
+ # Returns the builder class for the map. Allows fetching the class name
20
+ # dynamically also in the utility classes that extend this class.
21
+ #
22
+ # @return [Class] The class for the builder object.
23
+ def builder_class
24
+ self.class.const_get(:Builder)
25
+ end
26
+
27
+ # Returns the options for the default builder object.
28
+ #
29
+ # @return [Hash] The default options for the map builder.
30
+ def builder_options
31
+ {
32
+ marker_color: organization.colors.fetch("primary", "#ef604d"),
33
+ tile_layer: tile_layer_configuration
34
+ }
35
+ end
36
+
37
+ protected
38
+
39
+ # Prepares the tile layer configuration hash to be passed for the
40
+ # builder.
41
+ #
42
+ # @return The tile layer configuration hash.
43
+ def tile_layer_configuration
44
+ tile_layer = configuration.fetch(:tile_layer, {})
45
+ tile_layer_options = tile_layer.except(:url).tap do |config|
46
+ config.fetch(:api_key, nil) == true &&
47
+ config[:api_key] = configuration.fetch(:api_key, nil)
48
+ end
49
+
50
+ {
51
+ url: tile_layer.fetch(:url, nil),
52
+ options: tile_layer_options
53
+ }
54
+ end
55
+
56
+ # A builder for the dynamic maps to be used in the views. Provides all the
57
+ # necessary functionality to display and initialize the maps.
58
+ class Builder < Decidim::Map::Frontend::Builder
59
+ # Displays the map element's markup for the view.
60
+ #
61
+ # @param html_options [Hash] Extra options to pass to the map element.
62
+ # @return [String] The map element's markup.
63
+ def map_element(html_options = {})
64
+ map_html_options = {
65
+ "data-decidim-map" => view_options.to_json,
66
+ # The data-markers-data is kept for backwards compatibility
67
+ "data-markers-data" => options.fetch(:markers, []).to_json
68
+ }.merge(html_options)
69
+
70
+ content = template.capture { yield }.html_safe if block_given?
71
+
72
+ template.content_tag(:div, map_html_options) do
73
+ (content || "")
74
+ end
75
+ end
76
+
77
+ # @see Decidim::Map::View::Builder#stylesheet_snippets
78
+ def stylesheet_snippets
79
+ template.stylesheet_link_tag("decidim/map")
80
+ end
81
+
82
+ # @see Decidim::Map::View::Builder#javascript_snippets
83
+ def javascript_snippets
84
+ template.javascript_include_tag("decidim/map/provider/default")
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,97 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ # A base class for front-end mapping functionality, common to all front-end
6
+ # map services, such as dynamic_map.rb and autocomplete.rb. Provides builder
7
+ # classes for the front-end.
8
+ class Frontend < Map::Utility
9
+ # Creates a builder class for the front-end that is used to build the HTML
10
+ # markup related to this utility.
11
+ #
12
+ # @param (see Decidim::Map::BuilderUtility::Builder#initialize)
13
+ #
14
+ # @return [Decidim::Map::BuilderUtility::Builder] The builder object that
15
+ # can be used to build the map's markup.
16
+ def create_builder(template, options = {})
17
+ builder_class.new(template, builder_options.merge(options))
18
+ end
19
+
20
+ # Returns the builder class for the map. Allows fetching the class name
21
+ # dynamically also in the utility classes that extend this class.
22
+ #
23
+ # @return [Class] The class for the builder object.
24
+ def builder_class
25
+ self.class.const_get(:Builder)
26
+ end
27
+
28
+ # Returns the default options for the builder object.
29
+ #
30
+ # @return [Hash] The default options for the map builder.
31
+ def builder_options
32
+ configuration
33
+ end
34
+
35
+ # A general builder for any functionality needed for the views. Provides
36
+ # all the necessary functionality to display and initialize the front-end
37
+ # elements related to the given map utility.
38
+ class Builder
39
+ # Initializes the map builder instance.
40
+ #
41
+ # @param template [ActionView::Template] The template within which the
42
+ # map is displayed.
43
+ # @param options [Hash] Extra options for the builder object.
44
+ def initialize(template, options)
45
+ @template = template
46
+ @options = options
47
+ end
48
+
49
+ # Displays the necessary front-end stylesheet assets for the map
50
+ # element.
51
+ #
52
+ # @return [String, nil] The map element's stylesheet assets markup for
53
+ # the view or nil if there are no stylesheet assets.
54
+ def stylesheet_snippets; end
55
+
56
+ # Displays the necessary front-end JavaScript assets for the map
57
+ # element.
58
+ #
59
+ # @return [String, nil ] The map element's JavaScript assets markup for
60
+ # the view or nil if there are no JavaScript assets.
61
+ def javascript_snippets; end
62
+
63
+ protected
64
+
65
+ attr_reader :template, :options
66
+
67
+ # Returns the options hash that will be passed to the map element as a
68
+ # JSON encoded data attribute. These configurations can be used to pass
69
+ # information to the front-end map functionality, e.g. about the tile
70
+ # layer configurations and markers data.
71
+ #
72
+ # @return [Hash] The configurations passed to the map element's data
73
+ # attribute.
74
+ def view_options
75
+ hash_to_js(options)
76
+ end
77
+
78
+ # Converts a hash with Ruby-style key names (snake_case) to JS-style key
79
+ # names (camelCase).
80
+ #
81
+ # @param [Hash] The original hash with Ruby-style hash keys in
82
+ # snake_case format.
83
+ #
84
+ # @return [Hash] The resulting hash with JS-style hash keys in camelCase
85
+ # format.
86
+ def hash_to_js(hash)
87
+ hash.map do |key, value|
88
+ value = hash_to_js(value) if value.is_a?(Hash)
89
+ value = value.call(self) if value.respond_to?(:call)
90
+
91
+ [key.to_s.camelize(:lower), value]
92
+ end.to_h
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,115 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ # A base class for geocoding functionality, common to all geocoding
6
+ # services.
7
+ class Geocoding < Map::Utility
8
+ # @see Decidim::Map::Utility#initialize
9
+ def initialize(organization:, config:, locale: I18n.locale.to_s)
10
+ super
11
+ prepare!
12
+ end
13
+
14
+ # The "lookup" handle to be passed to the geocoder gem. For the full list,
15
+ # see https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md.
16
+ #
17
+ # @return [Symbol] The handle of the geocoder gem's lookup
18
+ def handle
19
+ @handle ||= self.class.name.to_s.split("::")[-1].underscore.to_sym
20
+ end
21
+
22
+ # A common search method to lookup information about an address or
23
+ # coordinates from the geocoder.
24
+ #
25
+ # @param query [String, Array(<Float, String>, <Float, String>)] The
26
+ # search query to be passed to the geocoder
27
+ # @param options [Hash] Extra options to be provided for the geocoder
28
+ # search
29
+ #
30
+ # @return [Array(Float, Float), String, nil] The corresponding result for
31
+ # the search query, either a string or an array containing the result
32
+ # coordinates or nil when no corresponding result was found.
33
+ def search(query, options = {})
34
+ Geocoder.search(query, geocoder_options(options))
35
+ end
36
+
37
+ # Does a geocoding request with the given address and returns the
38
+ # corresponding geocoordinates as an array where the first element
39
+ # corresponds the latitude and the second element corresponds to the
40
+ # longitude.
41
+ #
42
+ # @param address [String] The address to search the geocoordinates for
43
+ # @param options [Hash] Extra options to be provided for the geocoder
44
+ # search
45
+ #
46
+ # @return [Array(Float, Float), nil] The corresponding coordinates found
47
+ # by the geocoder where the first element corresponds to the latitude
48
+ # coordinate and the second element corresponds to the longitude
49
+ # coordinate or nil when no result was found
50
+ def coordinates(address, options = {})
51
+ Geocoder.coordinates(address, geocoder_options(options))
52
+ end
53
+
54
+ # Does a reverse geocoding request with the given geocoordinates
55
+ # (latitude/longitude) coordinates and returns a clear text address for
56
+ # the closest result.
57
+ #
58
+ # @param coordinates [Array(<Float, String>, <Float, String>)] An array of
59
+ # the coordinates where the first element is the latitude and the second
60
+ # element is the longitude
61
+ # @param options [Hash] Extra options to be provided for the geocoder
62
+ # search
63
+ #
64
+ # @return [String, nil] The corresponding address found by the geocoder
65
+ # or nil when no result was found
66
+ def address(coordinates, options = {})
67
+ results = search(coordinates, options)
68
+ return if results.empty?
69
+
70
+ results.sort! do |result1, result2|
71
+ dist1 = Geocoder::Calculations.distance_between(
72
+ result1.coordinates,
73
+ coordinates
74
+ )
75
+ dist2 = Geocoder::Calculations.distance_between(
76
+ result2.coordinates,
77
+ coordinates
78
+ )
79
+ dist1 <=> dist2
80
+ end
81
+
82
+ results.first.address
83
+ end
84
+
85
+ protected
86
+
87
+ # @see Decidim::Map::Utility#configure
88
+ def configure!(config)
89
+ @configuration = config.merge(
90
+ http_headers: { "Referer" => organization.host }
91
+ )
92
+ end
93
+
94
+ # Prepares the options to be passed to the Geocoder gem.
95
+ #
96
+ # @param options [Hash] The options hash to be passed to Geocoder.
97
+ #
98
+ # @return [Hash]
99
+ def geocoder_options(options)
100
+ { lookup: handle, language: locale }.merge(options)
101
+ end
102
+
103
+ private
104
+
105
+ # Prepares the geocoder for the lookups with the configured geocoding
106
+ # service. This is called when an instance of the geocoding utility is
107
+ # created.
108
+ #
109
+ # @return [void]
110
+ def prepare!
111
+ Geocoder.configure(handle => configuration)
112
+ end
113
+ end
114
+ end
115
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "decidim/map/provider/here"
4
+ require "decidim/map/provider/osm"
5
+
6
+ module Decidim
7
+ module Map
8
+ # Base module for the map providers.
9
+ module Provider
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ module Provider
6
+ module Autocomplete
7
+ # The geocoding autocomplete map utility class for the HERE map
8
+ # services.
9
+ class Here < ::Decidim::Map::Autocomplete
10
+ class Builder < Decidim::Map::Autocomplete::Builder
11
+ # @see Decidim::Map::FrontendUtility::Builder#javascript_snippets
12
+ def javascript_snippets
13
+ template.javascript_include_tag("decidim/geocoding/provider/here")
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ module Provider
6
+ module Autocomplete
7
+ # The geocoding autocomplete utility class for Photon based geocoding
8
+ # autocompletion services which use the OpenStreetMap's (OSM) data.
9
+ class Osm < ::Decidim::Map::Autocomplete
10
+ class Builder < Decidim::Map::Autocomplete::Builder
11
+ # @see Decidim::Map::FrontendUtility::Builder#javascript_snippets
12
+ def javascript_snippets
13
+ template.javascript_include_tag("decidim/geocoding/provider/photon")
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Decidim
4
+ module Map
5
+ module Provider
6
+ module DynamicMap
7
+ # The dynamic map utility class for the HERE maps service
8
+ class Here < ::Decidim::Map::DynamicMap
9
+ protected
10
+
11
+ # @see Decidim::Map::DynamicMap#tile_layer_configuration
12
+ def tile_layer_configuration
13
+ base_config = configuration.fetch(:tile_layer, {})
14
+
15
+ api_key = configuration[:api_key]
16
+ if api_key.is_a?(Array)
17
+ # Support for legacy style configurations
18
+ ActiveSupport::Deprecation.warn(
19
+ <<~DEPRECATION.strip
20
+ Please use a single api_key configuration for HERE maps.
21
+
22
+ For further information, see:
23
+ https://developer.here.com/documentation/maps/3.1.16.1/dev_guide/topics/migration.html
24
+
25
+ Also make sure your Decidim.maps configurations are using the
26
+ up to date format.
27
+ DEPRECATION
28
+ )
29
+
30
+ return base_config.merge(
31
+ app_id: api_key[0],
32
+ app_code: api_key[1]
33
+ )
34
+ end
35
+
36
+ base_config.merge(api_key: api_key)
37
+ end
38
+
39
+ # A builder for the HERE maps which needs to be configured differently
40
+ # than "normal" OSM based tile service providers.
41
+ class Builder < Decidim::Map::DynamicMap::Builder
42
+ # @see Decidim::Map::DynamicMap::Builder#javascript_snippets
43
+ def javascript_snippets
44
+ template.javascript_include_tag("decidim/map/provider/here")
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end