mobile_workflow 0.9.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 948c45e0602fe9441f2cd0c79e4b4141c9ed357b9489ca7f3f1af599ea370c66
-  data.tar.gz: c84792530d7b0c02a05cc6e6d253e1464e7edea71b4f00e66d290d3a45221ccd
+  metadata.gz: f468888276f739eb0ae572c2d726273b2848cecb81340e63f0808127ff83c917
+  data.tar.gz: 5bc7aff35b9be7f1938f3eabd2e01bf734608eca8db805cfa01b416508f60290
 SHA512:
-  metadata.gz: 1ffd490ac6e267a073cf45c54eeb9226dbf9b2ddc0402a00c923f6e25b38cfdd8345805ed429a8aa1e5c09ee7c368869146387e45c7f3da336931d6f38db06ed
-  data.tar.gz: 58fafb2c69f7562fe3ea2d09226e6459b0eaac2d3056a8f0590aa69b29a7078c22b6287266b283869b00adebbec790149d62f681a9ed64e26553ca0adbd53132
+  metadata.gz: 33f31ce284d0799276f6950c3b0ee6e820cb2107f1ad0de274b55c5fcc2d464b4f2304d6231201ef06419b2a621b85cfed8f8d42f546fc9a7ac47d5e7ea02559
+  data.tar.gz: a298610029408fced69d431c5ebc37d6473570205fadc25e5fa260ed1c9560ae67d3d6c74b163a7efbbbcc3b340c0f98b892a27f59ac580208a59b19054fb08e

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

@@ -35,12 +35,12 @@ module MobileWorkflow
             placeholder: placeholder, optional: optional, symbol_position: symbol_position, default_text_answer: default_text_answer, hint: hint }
         end
 
-        def mw_form_text(label:, id:, 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 id' if id.nil?
 
           { item_type: :text, id: id, label: label, placeholder: placeholder,
-            optional: optional, multiline: multiline, default_text_answer: default_text_answer }
+            optional: optional, multiline: multiline, default_text_answer: default_text_answer, hint: hint }
         end
 
         def mw_form_date(label:, id:, optional: false, default_text_answer: nil)

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

@@ -1,14 +1,12 @@
+require 'app_rail/steps'
+
 module MobileWorkflow
   module Displayable
     module Steps
       module List
-        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
-        
-        def mw_list_search_suggestion(id: self.id, text:, section_name:, sf_symbol_name: nil)
-          {id: id.to_s, text: text, sectionName: section_name, sfSymbolName: sf_symbol_name}.compact
-        end
+        include AppRail::Steps::Core::List
+        alias_method :mw_list_item, :ar_core_list_item
+        alias_method :mw_list_search_suggestion, :ar_core_list_search_suggestion
       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.9.0'
+  VERSION = '0.10.2'
   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.9.0
+  version: 0.10.2
 platform: ruby
 authors:
 - Matt Brooke-Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -51,6 +51,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,6 +61,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: app_rail-steps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +134,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - matt@futureworkshops.com
 executables:
@@ -192,7 +212,7 @@ homepage: https://github.com/futureworkshops/mobile_workflow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,8 +227,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A Rails engine to provide API support for Mobile Workflow Apps.
 test_files: []