mobile_workflow 0.8.9 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 229a8fe990726594fdb6036508c678da2c53f8488309874627f743130400cb5b
-  data.tar.gz: 3922375cd7e5e56448780d033f5e7a24e2e2afa1a4169fb651e2ecd5430b48d4
+  metadata.gz: f6bc602fc017e13c879d0af658c78c4602b8fc98c17151cf08f00779e9def092
+  data.tar.gz: a16ece326988573447b5bbd8d6a134c0c4a4bfb663e7901f0f15cfd5e0b10613
 SHA512:
-  metadata.gz: dd63ea333db40bcbed5e72dbce3ed2488c64433245bea45779a50c0373c01c381dd0635c85070ec11083cce855d88894a9ce5ece9112316b69a7d5330c955c15
-  data.tar.gz: 87a0fa463d22dc0e78abf0f3ddd3c96a6f89c6f70a092179845a1d2ca1df328766aeb706e2b75ba6a04cb7ebf093ea1ccd0b2e398bfc11cca6a0a4249f30b4dd
+  metadata.gz: 24da3b05af9fd839b58ac237c520787810f46237bce6ef38d0f443615c83b3a98adc08e989add95922219a466e95f766bc3fce32a9df3333b9c989aba933cbd2
+  data.tar.gz: 3a61512e3e71def3ebcce55f3cffc67c7858355b6d9d0e2912956a66a0ae81c985602f14b32aaa870964db6af3a60a47a896bd36d35f8f0ff1e36d629cd4d848

data/README.md

@@ -26,89 +26,6 @@ Or install it yourself as:
 $ gem install mobile_workflow
 ```
 
-## Upgrade to version 0.7.7 or higher
-The following utility methods have changed their parameters:
-
-```ruby
-# app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb#20
-def mw_grid_item(id: self.id, text:, detail_text: nil, preview_url: nil)
-  raise 'Missing id' if id.nil?
-  raise 'Missing text' if text.nil?
-  
-  { id: id, text: text, type: :item, detailText: detail_text, imageURL: preview_url }.compact
-end
-
-# app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb#20
-def mw_stack_list_item(id:, text:, detail_text: nil, preview_url: nil)
-  raise 'Missing id' if id.nil?
-  raise 'Missing text' if text.nil?
-
-  { id: id.to_s, text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
-end
-
-# app/models/concerns/mobile_workflow/displayable/steps/list.rb#5
-def mw_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, material_icon_name: nil, preview_url: nil)
-  { id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name, imageURL: preview_url }.compact
-end
-
-# app/models/concerns/mobile_workflow/displayable/steps/stack.rb#26
-def mw_display_video(preview_url:, attachment_url:)
-  {type: :video, previewURL: preview_url, url: attachment_url}
-end
-
-# app/models/concerns/mobile_workflow/displayable/steps/stack.rb#11
-def mw_display_image(preview_url:, attachment_url:, content_mode: :scale_aspect_fill)
-  validate_content_mode!(content_mode)
-  
-  {type: :image, contentMode: camelcase_converter(content_mode.to_s, first_letter: :lower), previewURL: preview_url, url: attachment_url}
-end
-```
-
-All URLs MUST now be explicitly sent as arguments to the above methods, which means they must be previously set. If not, the methods will not work.
-
-In order to support projects using `ActiveStorage`, there is a new model concern `MobileWorkflow::Attachable` that provides a few helpers. This is what you can do to upgrade if you use ActiveStorage (otherwise the helpers must be manually created):
-
-1. Include the concern in the `ApplicationRecord` class, together with `MobileWorkflow::Displayable`:
-
-```ruby
-class ApplicationRecord < ActiveRecord::Base
-  include MobileWorkflow::Attachable
-  include MobileWorkflow::Displayable
-end
-```
-
-2. Once included, the following helpers will be available, so use them to generate the intended URLs:
-
-```ruby
-def preview_url(attachment, options: { resize_to_fill: [200, 200] })
-  return nil unless attachment.attached?
-
-  if attachment.image?
-    rails_representation_url(attachment.variant(options), host: heroku_attachment_host)
-  elsif attachment.previewable?
-    rails_representation_url(attachment.preview(options), host: heroku_attachment_host)
-  else
-    return nil
-  end
-end
-
-def attachment_url(attachment)
-  return nil unless attachment.attached?
-
-  rails_blob_url(attachment, host: heroku_attachment_host)
-end
-```
-
-Example of use:
-```ruby
-# Old method call
-mw_list_item(text: 'John Doe', detail_text: 'Company Name', image_attachment: <ActiveStorage::Attached::One>, image_url: 'https://test.org/preview')
-
-# New method call
-preview_url = preview_url(<ActiveStorage::Attached::One>, options: { resize_to_fill: [200, 200] }) || 'https://test.org/preview'
-mw_list_item(text: 'John Doe', detail_text: 'Company Name', preview_url: preview_url)
-```
-
 ## Contributing
 Contribution directions go here.
 

data/app/models/concerns/mobile_workflow/attachable.rb

@@ -17,12 +17,16 @@ module MobileWorkflow
 
     def attachment_url(attachment)
       return nil unless attachment.attached?
-    
-      rails_blob_url(attachment, host: heroku_attachment_host)
+
+      rails_blob_url(attachment, host: attachment_host)
     end
 
     private
 
+    def attachment_host
+      ENV.fetch('ATTACHMENTS_HOST', heroku_attachment_host)
+    end
+
     def heroku_attachment_host
       # TODO: MBS - move this to a configuration property
       app_name = Rails.env.test? ? 'test-app' : ENV.fetch('HEROKU_APP_NAME')

data/app/models/concerns/mobile_workflow/displayable/steps/form.rb

@@ -1,70 +1,80 @@
+# frozen_string_literal: true
+
+
 module MobileWorkflow
   module Displayable
     module Steps
       module Form
-        def mw_form_section(label:, identifier:)
+        def mw_form_section(label:, id:)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :section, label: label, identifier: identifier }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :section, id: id, label: label }
         end
-    
-        def mw_form_multiple_selection(label:, identifier:, multiple_selection_options:, selection_type: :single, optional: false, show_other_option: false)
+
+        def mw_form_multiple_selection(label:, multiple_selection_options:, id:, selection_type: :single, optional: false, show_other_option: false)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
+          raise 'Missing id' if id.nil?
           raise 'Missing multiple selection options' if multiple_selection_options.nil?
-    
-          { item_type: :multiple_selection, label: label, identifier: identifier, multiple_selection_options: multiple_selection_options, selection_type: selection_type, optional: optional, show_other_option: show_other_option }
+
+          { item_type: :multiple_selection, id: id, label: label,
+            multiple_selection_options: multiple_selection_options, selection_type: selection_type, optional: optional, show_other_option: show_other_option }
         end
-    
+
         def mw_form_multiple_selection_options(text:, hint: nil, is_pre_selected: false)
           raise 'Missing text' if text.nil?
-    
+
           { text: text, hint: hint, isPreSelected: is_pre_selected }
         end
-    
-        def mw_form_number(label:, identifier:, placeholder: nil, optional: false, symbol_position: :leading, default_text_answer: nil, hint: nil)
+
+        def mw_form_number(label:, id:, placeholder: nil, optional: false, symbol_position: :leading, default_text_answer: nil, hint: nil)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :number, number_type: :number, label: label, identifier: identifier, placeholder: placeholder, optional: optional, symbol_position: symbol_position, default_text_answer: default_text_answer, hint: hint }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :number, number_type: :number, id: id, label: label,
+            placeholder: placeholder, optional: optional, symbol_position: symbol_position, default_text_answer: default_text_answer, hint: hint }
         end
-    
-        def mw_form_text(label:, identifier:, placeholder: nil, optional: false, multiline: false, default_text_answer: nil)
+
+        def mw_form_text(label:, id:, placeholder: nil, optional: false, multiline: false, default_text_answer: nil, hint: nil)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :text, label: label, identifier: identifier, placeholder: placeholder, optional: optional, multiline: multiline, default_text_answer: default_text_answer }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :text, id: id, label: label, placeholder: placeholder,
+            optional: optional, multiline: multiline, default_text_answer: default_text_answer, hint: hint }
         end
-    
-        def mw_form_date(label:, identifier:, optional: false, default_text_answer: nil)
+
+        def mw_form_date(label:, id:, optional: false, default_text_answer: nil)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :date, date_type: :calendar, label: label, identifier: identifier, optional: optional, default_text_answer: default_text_answer }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :date, date_type: :calendar, id: id, label: label, optional: optional,
+            default_text_answer: default_text_answer }
         end
-    
-        def mw_form_time(label:, identifier:, optional: false, default_text_answer: nil)
+
+        def mw_form_time(label:, id:, optional: false, default_text_answer: nil)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :time, label: label, identifier: identifier, optional: optional, default_text_answer: default_text_answer }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :time, id: id, label: label, optional: optional,
+            default_text_answer: default_text_answer }
         end
-    
-        def mw_form_email(label:, identifier:, placeholder: nil, optional: false, default_text_answer: nil)
+
+        def mw_form_email(label:, id:, placeholder: nil, optional: false, default_text_answer: nil)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :email, label: label, identifier: identifier, placeholder: placeholder, optional: optional, default_text_answer: default_text_answer }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :email, id: id, label: label, placeholder: placeholder,
+            optional: optional, default_text_answer: default_text_answer }
         end
-    
-        def mw_form_password(label:, identifier:, placeholder: nil, optional: false, default_text_answer: nil, hint: nil)
+
+        def mw_form_password(label:, id:, placeholder: nil, optional: false, default_text_answer: nil, hint: nil)
           raise 'Missing label' if label.nil?
-          raise 'Missing identifier' if identifier.nil?
-    
-          { item_type: :secure, label: label, identifier: identifier, placeholder: placeholder, optional: optional, default_text_answer: default_text_answer, hint: hint }
+          raise 'Missing id' if id.nil?
+
+          { item_type: :secure, id: id, label: label, placeholder: placeholder,
+            optional: optional, default_text_answer: default_text_answer, hint: hint }
         end
       end
     end
   end
-end
+end

data/app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb

@@ -1,41 +1,40 @@
+# frozen_string_literal: true
+
 module MobileWorkflow
   module Displayable
     module Steps
       module StyledContent
         module Stack
-          def mw_stack_title(id:, title:)
-            raise 'Missing id' if id.nil?
+          def mw_stack_title(title:)
             raise 'Missing title' if title.nil?
-        
+
             { id: id, title: title, type: :title }
           end
-        
-          def mw_stack_text(id:, text:)
-            raise 'Missing id' if id.nil?
+
+          def mw_stack_text(text:)
             raise 'Missing text' if text.nil?
-        
-            { id: id, text: text, type: :text }
+
+            { text: text, type: :text }
           end
-        
-          def mw_stack_list_item(id:, text:, detail_text: nil, preview_url: nil)
-            raise 'Missing id' if id.nil?
+
+          def mw_stack_list_item(text:, detail_text: nil, preview_url: nil)
             raise 'Missing text' if text.nil?
-        
-            { id: id.to_s, text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
+
+            { text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
           end
 
           # Remove `modal_workflow_name` argument once V1 is no longer being used
-          def mw_stack_button(id:, label:, url: nil, method: :nil, on_success: :none, style: :primary, modal_workflow_name: nil, link_id: nil, link_url: nil, sf_symbol_name: nil, apple_system_url: nil, android_deep_link: nil, confirm_title: nil, confirm_text: nil, share_text: nil, share_image_url: nil)
-            raise 'Missing id' if id.nil?
+          def mw_stack_button(label:, url: nil, method: :nil, on_success: :none, style: :primary, modal_workflow_name: nil, link_id: nil, link_url: nil, sf_symbol_name: nil, apple_system_url: nil, android_deep_link: nil, confirm_title: nil, confirm_text: nil, share_text: nil, share_image_url: nil)
             raise 'Missing label' if label.nil?
-        
+
             validate_on_success!(on_success)
             validate_button_style!(style)
-        
-            { id: id, type: :button, label: label, url: url, method: method, onSuccess: on_success, style: style, modalWorkflow: modal_workflow_name, linkId: link_id, linkURL: link_url, sfSymbolName: sf_symbol_name, appleSystemURL: apple_system_url, androidDeepLink: android_deep_link, confirmTitle: confirm_title, confirmText: confirm_text, shareText: share_text, shareImageURL: share_image_url }.compact
+
+            { type: :button, label: label, url: url, method: method, onSuccess: on_success, style: style,
+              modalWorkflow: modal_workflow_name, linkId: link_id, linkURL: link_url, sfSymbolName: sf_symbol_name, appleSystemURL: apple_system_url, androidDeepLink: android_deep_link, confirmTitle: confirm_title, confirmText: confirm_text, shareText: share_text, shareImageURL: share_image_url }.compact
           end
         end
       end
     end
   end
-end
+end

data/lib/mobile_workflow/version.rb

@@ -1,5 +1,5 @@
 module MobileWorkflow
-  VERSION = '0.8.9'
+  VERSION = '0.10.1'
   RUBY_VERSION = '2.7.3'
   RAILS_VERSION = '6.1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobile_workflow
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.10.1
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3