mobile_workflow 0.9.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 05a26587c0ada255dbdb65acf88ccb79c9b3c446ba674e94d4abf9f67b0b1e03
|
4
|
+
data.tar.gz: f40ed602bb5aa0d959a98ffc103d0b9413c379104f006664a25650b2786cc05e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 537062506b6b62327e638c58ea0b03681bf288a7ee0ca1b0ade9537a6dfb621eebd592efa43b105a4c5f4b6093ecc17471230cb4f4590ae1bef74ec6ef0b104b
|
7
|
+
data.tar.gz: ba524976812ed3116a354777ff47a1b57734c17352e8609e279a0a0128e29792c9ff46504ef46991a2cd6df1e3f1e3ee5300753c8457f7b62030d861df647e16
|
data/README.md
CHANGED
@@ -26,89 +26,6 @@ Or install it yourself as:
|
|
26
26
|
$ gem install mobile_workflow
|
27
27
|
```
|
28
28
|
|
29
|
-
## Upgrade to version 0.7.7 or higher
|
30
|
-
The following utility methods have changed their parameters:
|
31
|
-
|
32
|
-
```ruby
|
33
|
-
# app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb#20
|
34
|
-
def mw_grid_item(id: self.id, text:, detail_text: nil, preview_url: nil)
|
35
|
-
raise 'Missing id' if id.nil?
|
36
|
-
raise 'Missing text' if text.nil?
|
37
|
-
|
38
|
-
{ id: id, text: text, type: :item, detailText: detail_text, imageURL: preview_url }.compact
|
39
|
-
end
|
40
|
-
|
41
|
-
# app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb#20
|
42
|
-
def mw_stack_list_item(id:, text:, detail_text: nil, preview_url: nil)
|
43
|
-
raise 'Missing id' if id.nil?
|
44
|
-
raise 'Missing text' if text.nil?
|
45
|
-
|
46
|
-
{ id: id.to_s, text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
|
47
|
-
end
|
48
|
-
|
49
|
-
# app/models/concerns/mobile_workflow/displayable/steps/list.rb#5
|
50
|
-
def mw_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, material_icon_name: nil, preview_url: nil)
|
51
|
-
{ id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name, imageURL: preview_url }.compact
|
52
|
-
end
|
53
|
-
|
54
|
-
# app/models/concerns/mobile_workflow/displayable/steps/stack.rb#26
|
55
|
-
def mw_display_video(preview_url:, attachment_url:)
|
56
|
-
{type: :video, previewURL: preview_url, url: attachment_url}
|
57
|
-
end
|
58
|
-
|
59
|
-
# app/models/concerns/mobile_workflow/displayable/steps/stack.rb#11
|
60
|
-
def mw_display_image(preview_url:, attachment_url:, content_mode: :scale_aspect_fill)
|
61
|
-
validate_content_mode!(content_mode)
|
62
|
-
|
63
|
-
{type: :image, contentMode: camelcase_converter(content_mode.to_s, first_letter: :lower), previewURL: preview_url, url: attachment_url}
|
64
|
-
end
|
65
|
-
```
|
66
|
-
|
67
|
-
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.
|
68
|
-
|
69
|
-
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):
|
70
|
-
|
71
|
-
1. Include the concern in the `ApplicationRecord` class, together with `MobileWorkflow::Displayable`:
|
72
|
-
|
73
|
-
```ruby
|
74
|
-
class ApplicationRecord < ActiveRecord::Base
|
75
|
-
include MobileWorkflow::Attachable
|
76
|
-
include MobileWorkflow::Displayable
|
77
|
-
end
|
78
|
-
```
|
79
|
-
|
80
|
-
2. Once included, the following helpers will be available, so use them to generate the intended URLs:
|
81
|
-
|
82
|
-
```ruby
|
83
|
-
def preview_url(attachment, options: { resize_to_fill: [200, 200] })
|
84
|
-
return nil unless attachment.attached?
|
85
|
-
|
86
|
-
if attachment.image?
|
87
|
-
rails_representation_url(attachment.variant(options), host: heroku_attachment_host)
|
88
|
-
elsif attachment.previewable?
|
89
|
-
rails_representation_url(attachment.preview(options), host: heroku_attachment_host)
|
90
|
-
else
|
91
|
-
return nil
|
92
|
-
end
|
93
|
-
end
|
94
|
-
|
95
|
-
def attachment_url(attachment)
|
96
|
-
return nil unless attachment.attached?
|
97
|
-
|
98
|
-
rails_blob_url(attachment, host: heroku_attachment_host)
|
99
|
-
end
|
100
|
-
```
|
101
|
-
|
102
|
-
Example of use:
|
103
|
-
```ruby
|
104
|
-
# Old method call
|
105
|
-
mw_list_item(text: 'John Doe', detail_text: 'Company Name', image_attachment: <ActiveStorage::Attached::One>, image_url: 'https://test.org/preview')
|
106
|
-
|
107
|
-
# New method call
|
108
|
-
preview_url = preview_url(<ActiveStorage::Attached::One>, options: { resize_to_fill: [200, 200] }) || 'https://test.org/preview'
|
109
|
-
mw_list_item(text: 'John Doe', detail_text: 'Company Name', preview_url: preview_url)
|
110
|
-
```
|
111
|
-
|
112
29
|
## Contributing
|
113
30
|
Contribution directions go here.
|
114
31
|
|
@@ -35,12 +35,12 @@ module MobileWorkflow
|
|
35
35
|
placeholder: placeholder, optional: optional, symbol_position: symbol_position, default_text_answer: default_text_answer, hint: hint }
|
36
36
|
end
|
37
37
|
|
38
|
-
def mw_form_text(label:, id:, placeholder: nil, optional: false, multiline: false, default_text_answer: nil)
|
38
|
+
def mw_form_text(label:, id:, placeholder: nil, optional: false, multiline: false, default_text_answer: nil, hint: nil)
|
39
39
|
raise 'Missing label' if label.nil?
|
40
40
|
raise 'Missing id' if id.nil?
|
41
41
|
|
42
42
|
{ item_type: :text, id: id, label: label, placeholder: placeholder,
|
43
|
-
optional: optional, multiline: multiline, default_text_answer: default_text_answer }
|
43
|
+
optional: optional, multiline: multiline, default_text_answer: default_text_answer, hint: hint }
|
44
44
|
end
|
45
45
|
|
46
46
|
def mw_form_date(label:, id:, optional: false, default_text_answer: nil)
|
@@ -1,41 +1,40 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
module MobileWorkflow
|
2
4
|
module Displayable
|
3
5
|
module Steps
|
4
6
|
module StyledContent
|
5
7
|
module Stack
|
6
|
-
def mw_stack_title(
|
7
|
-
raise 'Missing id' if id.nil?
|
8
|
+
def mw_stack_title(title:)
|
8
9
|
raise 'Missing title' if title.nil?
|
9
|
-
|
10
|
+
|
10
11
|
{ id: id, title: title, type: :title }
|
11
12
|
end
|
12
|
-
|
13
|
-
def mw_stack_text(
|
14
|
-
raise 'Missing id' if id.nil?
|
13
|
+
|
14
|
+
def mw_stack_text(text:)
|
15
15
|
raise 'Missing text' if text.nil?
|
16
|
-
|
17
|
-
{
|
16
|
+
|
17
|
+
{ text: text, type: :text }
|
18
18
|
end
|
19
|
-
|
20
|
-
def mw_stack_list_item(
|
21
|
-
raise 'Missing id' if id.nil?
|
19
|
+
|
20
|
+
def mw_stack_list_item(text:, detail_text: nil, preview_url: nil)
|
22
21
|
raise 'Missing text' if text.nil?
|
23
|
-
|
24
|
-
{
|
22
|
+
|
23
|
+
{ text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
|
25
24
|
end
|
26
25
|
|
27
26
|
# Remove `modal_workflow_name` argument once V1 is no longer being used
|
28
|
-
def mw_stack_button(
|
29
|
-
raise 'Missing id' if id.nil?
|
27
|
+
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)
|
30
28
|
raise 'Missing label' if label.nil?
|
31
|
-
|
29
|
+
|
32
30
|
validate_on_success!(on_success)
|
33
31
|
validate_button_style!(style)
|
34
|
-
|
35
|
-
{
|
32
|
+
|
33
|
+
{ type: :button, label: label, url: url, method: method, onSuccess: on_success, style: style,
|
34
|
+
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
|
36
35
|
end
|
37
36
|
end
|
38
37
|
end
|
39
38
|
end
|
40
39
|
end
|
41
|
-
end
|
40
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: mobile_workflow
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Matt Brooke-Smith
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-02-
|
11
|
+
date: 2022-02-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-s3
|