app_rail-steps 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e76006e6ef3b5fafdaa50fc32aaeaab212bf70dfee24cfb6f905cdef1be3039
-  data.tar.gz: c2e413b573460f167e06e83f4882c56d0001fbef9e8cac3b3751cd89477586ac
+  metadata.gz: ca74f487f4684642560554261e441d4df0b2eed0ada21e69ed2ac9c71f739fc8
+  data.tar.gz: cd1aca03335d201619cf3fb4470ec3725d63dbdb626e0d48ede2658f4302bbe1
 SHA512:
-  metadata.gz: 00c80403094689ce0fa611e24e12b870f484297387c048a6ca28a525dff8cc27118991c955589a9deb4c84cddfaab774a74ccf8b992d7637ae4b13ffa4d042ea
-  data.tar.gz: 5b91a19cf979b9caf5dcd0ad1c43d816ef1a75b29617dd04c3b4770575b4ffe8c804b146d0741314749c84536ba5b6780953f48a3b968d864d8d13f0d5a69f91
+  metadata.gz: a7679afece3e67d9b261b928885644484fe4af7e66cc9d91c7d5761262f257414919c2d9a18c3284967d7a3e5881715ca15d8e8701ac7c644d650e844ce03155
+  data.tar.gz: b09961425c5d21e7c134368c745e0cee24eee31fcf6c35eb2d693481bee6585671465cb1b55f845ecdf00d9bd5750269ea2ff4b02b933e1f3703084218672b41

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-steps (0.2.2)
+    app_rail-steps (0.2.5)
 
 GEM
   remote: https://rubygems.org/

data/lib/app_rail/steps/core/stack.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module AppRail
+  module Steps
+    module Core
+      module Stack
+        CONTENT_MODE_OPTIONS = %i[scale_aspect_fill scale_aspect_fit].freeze
+
+        def ar_core_stack_text(text:, label: nil)
+          { type: :text, label: label, text: text.to_s }.compact
+        end
+
+        def ar_core_stack_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
+
+        def ar_core_stack_unsplash_image(image_url)
+          if image_url.start_with? "https://unsplash.com/photos"
+            unsplash_id = image_url.split("/").last
+            image_url = "https://source.unsplash.com/#{unsplash_id}/800x600"
+          end
+
+          { type: :image, previewURL: image_url, url: image_url }.compact
+        end
+
+        def ar_core_stack_video(preview_url:, attachment_url:)
+          { type: :video, previewURL: preview_url, url: attachment_url }
+        end
+
+        def ar_core_stack_button(label:, style: :primary, on_success: :forward, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+
+          { type: :button, label: label, style: style, onSuccess: on_success, sfSymbolName: sf_symbol_name,
+            materialIconName: material_icon_name }.compact
+        end
+
+        def ar_core_stack_delete_button(url:, label: "Delete", method: :delete, style: :danger, on_success: :backward)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+
+          { type: :button, label: label, url: url, method: method, style: style, onSuccess: on_success,
+            sfSymbolName: "trash", materialIconName: "delete" }.compact
+        end
+
+        def ar_core_stack_url_button(url:, label:, method: :put, style: :primary, confirm_title: nil, confirm_text: nil, on_success: :reload, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+
+          { type: :button, label: label, url: url, method: method, style: style, confirmTitle: confirm_title,
+            confirmText: confirm_text, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name }.compact
+        end
+        alias ar_core_stack_button_for_url ar_core_stack_url_button
+
+        def ar_core_stack_system_url_button(label:, apple_system_url: nil, android_deep_link: nil, style: :primary, sf_symbol_name: nil, material_icon_name: nil)
+          validate_button_style!(style)
+          raise "Invalid android_deep_link" if android_deep_link && !android_deep_link.start_with?("http")
+
+          { type: :button, label: label, appleSystemURL: apple_system_url, androidDeepLink: android_deep_link,
+            style: style, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name }.compact
+        end
+        alias ar_core_stack_button_for_system_url ar_core_stack_system_url_button
+
+        def ar_core_stack_link_button(label:, link_id:, style: :primary, on_success: :none, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+
+          { type: :button, label: label, linkId: link_id, style: style, onSuccess: on_success,
+            sfSymbolName: sf_symbol_name, materialIconName: material_icon_name }.compact
+        end
+
+        # Remove this method once V1 is no longer being used
+        def ar_core_stack_modal_workflow_button(label:, modal_workflow_name:, style: :primary, on_success: :none, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+
+          { type: :button, label: label, modalWorkflow: modal_workflow_name, style: style, onSuccess: on_success,
+            sfSymbolName: sf_symbol_name, materialIconName: material_icon_name }.compact
+        end
+        alias ar_core_stack_button_for_modal_workflow ar_core_stack_modal_workflow_button
+
+        private
+
+        def validate_content_mode!(on_success)
+          raise "Unknown content_mode" unless CONTENT_MODE_OPTIONS.include?(on_success)
+        end
+      end
+    end
+  end
+end

data/lib/app_rail/steps/core_forms/form.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module AppRail
+  module Steps
+    module CoreForms
+      module Form
+        def ar_core_forms_form_section(label:, id:)
+          raise "Missing label" if label.nil?
+          raise "Missing id" if id.nil?
+
+          { item_type: :section, id: id, label: label }
+        end
+
+        def ar_core_forms_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 id" if id.nil?
+          raise "Missing multiple selection options" if multiple_selection_options.nil?
+
+          { 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 ar_core_forms_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 ar_core_forms_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 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 ar_core_forms_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, hint: hint }
+        end
+
+        def ar_core_forms_form_date(label:, id:, optional: false, default_text_answer: nil)
+          raise "Missing label" if label.nil?
+          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 ar_core_forms_form_time(label:, id:, optional: false, default_text_answer: nil)
+          raise "Missing label" if label.nil?
+          raise "Missing id" if id.nil?
+
+          { item_type: :time, id: id, label: label, optional: optional,
+            default_text_answer: default_text_answer }
+        end
+
+        def ar_core_forms_form_email(label:, id:, placeholder: nil, optional: false, default_text_answer: nil)
+          raise "Missing label" if label.nil?
+          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 ar_core_forms_form_password(label:, id:, placeholder: nil, optional: false, default_text_answer: nil, hint: nil)
+          raise "Missing label" if label.nil?
+          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

data/lib/app_rail/steps/displayable.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
 require_relative "core/list"
+require_relative "core/stack"
+require_relative "core_forms/form"
 require_relative "maps/map"
+require_relative "styled_content/grid"
+require_relative "styled_content/stack"
 
 module AppRail
   module Steps
     module Displayable
       include Steps::Core::List
+      include Steps::Core::Stack
+      include Steps::CoreForms::Form
       include Steps::Maps::Map
+      include Steps::StyledContent::Grid
+      include Steps::StyledContent::Stack
 
       BUTTON_STYLES = %i[primary outline danger textOnly].freeze
       ON_SUCCESS_OPTIONS = %i[none reload backward forward].freeze

data/lib/app_rail/steps/maps/map.rb

@@ -5,7 +5,8 @@ module AppRail
     module Maps
       module Map
         def ar_maps_map_item(text:, latitude:, longitude:, id: self.id, detail_text: nil)
-          { id: id.to_s, text: text, latitude: latitude.to_f, longitude: longitude.to_f, detailText: detail_text }.compact
+          { id: id.to_s, text: text, latitude: latitude.to_f, longitude: longitude.to_f,
+            detailText: detail_text }.compact
         end
       end
     end

data/lib/app_rail/steps/styled_content/grid.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AppRail
+  module Steps
+    module StyledContent
+      module Grid
+        def ar_styled_content_grid_large_section(id:, text:)
+          raise "Missing id" if id.nil?
+          raise "Missing text" if text.nil?
+
+          { id: id, text: text, type: :largeSection }
+        end
+
+        def ar_styled_content_grid_small_section(id:, text:)
+          raise "Missing id" if id.nil?
+          raise "Missing text" if text.nil?
+
+          { id: id, text: text, type: :smallSection }
+        end
+
+        def ar_styled_content_grid_item(text:, id: self.id, 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
+      end
+    end
+  end
+end

data/lib/app_rail/steps/styled_content/stack.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AppRail
+  module Steps
+    module StyledContent
+      module Stack
+        def ar_styled_content_stack_title(title:)
+          raise "Missing title" if title.nil?
+
+          { id: id, title: title, type: :title }
+        end
+
+        def ar_styled_content_stack_text(text:)
+          raise "Missing text" if text.nil?
+
+          { text: text, type: :text }
+        end
+
+        def ar_styled_content_stack_list_item(text:, detail_text: nil, preview_url: nil)
+          raise "Missing text" if text.nil?
+
+          { 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 ar_styled_content_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)
+
+          { 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

data/lib/app_rail/steps/version.rb

@@ -2,6 +2,6 @@
 
 module AppRail
   module Steps
-    VERSION = "0.2.2"
+    VERSION = "0.2.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-steps
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Matt Brooke-Smith
@@ -28,8 +28,12 @@ files:
 - app_rail-steps.gemspec
 - lib/app_rail/steps.rb
 - lib/app_rail/steps/core/list.rb
+- lib/app_rail/steps/core/stack.rb
+- lib/app_rail/steps/core_forms/form.rb
 - lib/app_rail/steps/displayable.rb
 - lib/app_rail/steps/maps/map.rb
+- lib/app_rail/steps/styled_content/grid.rb
+- lib/app_rail/steps/styled_content/stack.rb
 - lib/app_rail/steps/version.rb
 homepage: https://github.com/FutureWorkshops/app_rail-steps
 licenses: