app_rail-steps 0.2.4 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eec3b376b102a4001550f293763e044c96cc0031cc42f5cefdbc960824be46a
-  data.tar.gz: b1de751d8d17653b2c3d42d117325e8b3339b02374881c2dcd515eb7081a0dc6
+  metadata.gz: c2d5bad1ddf33cb2a28dd8fb15796f908b637f596e65ba339990abd6e023a37d
+  data.tar.gz: 1d8608a1a47a3dfae2ab1f2adb641fe91a1958adf1482097daa6519fd093f050
 SHA512:
-  metadata.gz: dfbdce5969408464b564756c18c7f4603d9a23b926d884328f2184aa0e1ee7e4cbd4509121c35a34dd77eba1efce3a36d25dc2aadf9fd48238352d4956e9fe5e
-  data.tar.gz: 8eef9412eec72784ea95026c94934f0744a70546e80662f6126c419817b17d09c7c8cbbbea66762a2e508729d093e92b032513998a25c07a5e90568ffc0f334d
+  metadata.gz: 8a5bc64794f64cbce9f8804d184562f8f05fccd54e68b4091521ca43955fb294c4fbb7f36e38ee47e92834df7ce204edfec01cd5aa3ab1c7ad1ca124450ba603
+  data.tar.gz: 4b5f215882c55f047d3fc6053846e70ab8414b86061a51e66afcbaf83015e72cb3680e8ec1a75d0e4b958e9a5f036f45ff50a6d29d642dafd8ee55e0dd58460d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-steps (0.2.4)
+    app_rail-steps (0.2.7)
 
 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/charts/dashboard.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module AppRail
+  module Steps
+    module Charts
+      module Dashboard
+        def ar_charts_dashboard_statistic(id:, title:, text:)
+          {
+            id: id,
+            chartType: :none,
+            title: title,
+            text: text
+          }.compact
+        end
+
+        def ar_charts_dashboard_line_chart(id:, title:, values:, text: nil, footer: nil)
+          {
+            id: id,
+            chartType: :line,
+            title: title,
+            text: text,
+            footer: footer,
+            chartValues: values
+          }.compact
+        end
+
+        def ar_charts_dashboard_bar_chart(id:, title:, values:)
+          {
+            id: id,
+            chartType: :bar,
+            title: title,
+            chartValues: values
+          }.compact
+        end
+
+        def ar_charts_dashboard_bar_pie(id:, title:, values:, light_colors: nil, dark_colors: nil)
+          {
+            id: id,
+            chartType: :pie,
+            title: title,
+            chartValues: values,
+            chartColors: light_colors,
+            chartColorsDark: dark_colors
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,9 @@ 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"
+require_relative "charts/dashboard"
 
 module AppRail
   module Steps
@@ -12,6 +15,9 @@ module AppRail
       include Steps::Core::Stack
       include Steps::CoreForms::Form
       include Steps::Maps::Map
+      include Steps::StyledContent::Grid
+      include Steps::StyledContent::Stack
+      include Steps::Charts::Dashboard
 
       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.4"
+    VERSION = "0.2.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-steps
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.7
 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:
@@ -27,11 +27,14 @@ files:
 - Rakefile
 - app_rail-steps.gemspec
 - lib/app_rail/steps.rb
+- lib/app_rail/steps/charts/dashboard.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: