app_rail-steps 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42519d84340141281c5aafa11a20c515f5be53567ebb6f53df920c6ac6870170
-  data.tar.gz: b665ddd40d4d904d676af85f7cee1cce6ed8e8e1a42e68420cfb7d80a04551e2
+  metadata.gz: a141fb3b658dd53261624e501490700e20e8659856c107022597092a2fe29469
+  data.tar.gz: 17a66d80b87ecb6305d88b56decf82ef5445e7d44b5062d49adef43132a3a0f0
 SHA512:
-  metadata.gz: 1bf6eef1061548b2226b1d5b3f6428165f7443338101cdd5350b0fdc106d7e0a685c0598fe83d1075acbf59c33ba59a8d13ce1a95403de7c74cc2d461dd6ac00
-  data.tar.gz: ecb72f5f9271a9c97d661637898ef16edd4bb1eec847100188bc50553081bb821f7b286edd564a64c41d7db1cc4082764d4f7f4700b9a75a19313e03dd0e4b60
+  metadata.gz: fea4a473618b0e1129c641f9195c2cd84f8718ce1a3f6a6713aaf9eb064cc07eed26d29ef20b84e512ea6206052ac163cde9c32defe9dbcda38ccd0cc511664f
+  data.tar.gz: c7c443db93e21aa566c7a23b73ba5cd8905f8ca25e6c1d555b5a7ae2a9bf74ec90fc8bf8f09f79a54f22742c586a5778c8dea3c2ed607a7e5a89c3e1053d73bd

data/Gemfile.lock

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

data/README.md

@@ -22,7 +22,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+#require the gem in your script
+require 'app_rail/steps'
+
+...
+#inside your module/class include the displayable modile
+include AppRail::Steps::Displayable
+
+...
+#now you can use the methods from the gem for example:
+def ar_list_item_as_json
+      ar_core_list_item(id: self.id, text: self.name, detail_text: self.detail_text)
+end
+
+
+```
 
 ## Development
 
@@ -32,7 +47,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/app_rail-steps.
+Bug reports and pull requests are welcome on GitHub at https://github.com/FutureWorkshops/app_rail-steps.
 
 ## License
 

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

@@ -4,9 +4,16 @@ module AppRail
   module Steps
     module Core
       module List
-        def ar_core_list_item(text:, id: self.id, 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
+        def ar_core_list_item(text:, id: self.id, detail_text: nil, section_name: nil, sf_symbol_name: nil, material_icon_name: nil, preview_url: nil)
+          {
+            id: id,
+            text: text,
+            detailText: detail_text,
+            sectionName: section_name,
+            sfSymbolName: sf_symbol_name,
+            materialIconName: material_icon_name,
+            imageURL: preview_url
+          }.compact
         end
 
         def ar_core_list_search_suggestion(text:, section_name:, id: self.id, sf_symbol_name: nil)

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/displayable.rb

@@ -1,15 +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/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.3"
+    VERSION = "0.2.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-steps
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -28,9 +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: