app_rail-steps 0.2.5 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca74f487f4684642560554261e441d4df0b2eed0ada21e69ed2ac9c71f739fc8
-  data.tar.gz: cd1aca03335d201619cf3fb4470ec3725d63dbdb626e0d48ede2658f4302bbe1
+  metadata.gz: 1d0a2c468bb3b453ff93e93ac803fe9324bf980cc163bd8414671da9a13555b2
+  data.tar.gz: 92466c77d31fc18967683165cfed515f4dafcb5fe223fd1b12e13978b1bb89ff
 SHA512:
-  metadata.gz: a7679afece3e67d9b261b928885644484fe4af7e66cc9d91c7d5761262f257414919c2d9a18c3284967d7a3e5881715ca15d8e8701ac7c644d650e844ce03155
-  data.tar.gz: b09961425c5d21e7c134368c745e0cee24eee31fcf6c35eb2d693481bee6585671465cb1b55f845ecdf00d9bd5750269ea2ff4b02b933e1f3703084218672b41
+  metadata.gz: e5dc6f5f0cd3dde62e3f75bced4e6f89898979f7e866ded7480393bf38e09eaebe618c6ab4012b49c205b5b8e1abd8f371cb3bd5320a0b4281727974cb532b69
+  data.tar.gz: cc025b7a0775e2c4eeedeb46242f243a24146129a08e6d0edf65712037859983a35b0253301b85418742e8edf42ced5df45b6da712e897f4fa8d48a8a52e98a3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_rail-steps (0.2.5)
+    app_rail-steps (0.2.8)
 
 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.to_s,
+            chartType: :statistic,
+            title: title,
+            text: text
+          }.compact
+        end
+
+        def ar_charts_dashboard_line_chart(id:, title:, values:, text: nil, footer: nil)
+          {
+            id: id.to_s,
+            chartType: :line,
+            title: title,
+            text: text,
+            footer: footer,
+            chartValues: values
+          }.compact
+        end
+
+        def ar_charts_dashboard_bar_chart(id:, title:, values:)
+          {
+            id: id.to_s,
+            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.to_s,
+            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

@@ -6,6 +6,7 @@ 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
@@ -16,6 +17,7 @@ module AppRail
       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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_rail-steps
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.8
 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,6 +27,7 @@ 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