voom-presenters 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 411aa64aebeac378f001123d10ae4c7dd45aa7d2f1a92c3593a0687cb9e105ac
-  data.tar.gz: 64bbc79971792a6f68c2f084d65b47631942281ff28faa9a52da15e3595ba020
+  metadata.gz: c58a3f67ab69ad134f50e569b2cb7d2d39529f145c5eede4e6acdc037e382080
+  data.tar.gz: 5f45db82e9c4b3cc40706dea5e951a852a51864be8d2819588ffd72e847b320d
 SHA512:
-  metadata.gz: 67763e55b0cf99dfcef136bc5a0f822a91bfff6295c1b1780486b8c90405abdda5ec4a7c18d34c4043db97289a332dd2eff8cf238aec66db70e43424fdfa9bf2
-  data.tar.gz: f5eb112de819b9bc34b99034c5a1dd73f94871295fd2bf8b8ea5cc5c5eecc067bb90f4c59f0ba927ca8f1a283239a101e5502c3a536b944c10cc709841d306cc
+  metadata.gz: f5b7a05cb8ea9c58dc40286375665e0a2682838fb9cd844423344f13d620863797b589e6cc6a3c9bf32bc11bbaa623df07b128a2d6215d986f1c40e91cd28d5e
+  data.tar.gz: e1610bec38099df78e3af49329b11d0466aa18b756551efda35f22f40ba2cfe50baada829e5ab10d5e4df98c67d06a57f640c32c261a25fc8c958c096c2049cb

data/.circleci/config.yml

@@ -60,4 +60,7 @@ jobs:
           path: /tmp/test-results
       - store_artifacts:
           path: /tmp/test-results
-          destination: test-results
+          destination: test-results
+      - store_artifacts:
+          path: ./coverage
+          destination: code-coverage

data/Gemfile

@@ -10,4 +10,5 @@ group :test do
   gem "webdrivers", "~> 3.0"
   gem 'watir-rspec'
   gem 'rspec_junit_formatter'
+  gem 'simplecov', require: false
 end

data/Gemfile.lock

@@ -19,6 +19,7 @@ GEM
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
     dry-container (0.6.0)
@@ -27,6 +28,7 @@ GEM
     dry-inflector (0.1.2)
     ffi (1.9.23)
     ice_nine (0.11.2)
+    json (2.1.0)
     method_source (0.8.2)
     mini_portile2 (2.3.0)
     mustermann (1.0.2)
@@ -65,6 +67,11 @@ GEM
     selenium-webdriver (3.11.0)
       childprocess (~> 0.5)
       rubyzip (~> 1.2)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sinatra (2.0.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
@@ -98,6 +105,7 @@ DEPENDENCIES
   rspec
   rspec-html-matchers
   rspec_junit_formatter
+  simplecov
   voom-presenters!
   watir (~> 6.10.3)
   watir-rspec

data/README.md

@@ -9,6 +9,10 @@ A POM client can fully render user interface from POM.
 
 ## Demo
 
+[Demo](https://powerful-bastion-96181.herokuapp.com)
+
+Or to run locally:
+
     git clone git@github.com:rx/presenters.git
     cd presenters/
     bundle install
@@ -30,6 +34,14 @@ Then posts it to the reference web client.
 That result is then saved to a file and opened up with a browser.
     
     curl localhost:9292/pom/index > $TMPDIR/index.json  && curl -d "@$TMPDIR/index.json" -X POST localhost:9292/index > $TMPDIR/index.html && open $TMPDIR/index.html
+
+## Status
+This project is in a pre-beta status. It is changing frequently as the first user interfaces are being built with it.
+Any use should be for internal use only until the status becomes beta.
+
+[![CircleCI](https://circleci.com/gh/rx/presenters.svg?style=svg)](https://circleci.com/gh/rx/presenters)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8fcea717485230e60f27/maintainability)](https://codeclimate.com/github/rx/presenters/maintainability)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/rx/presenters/master/LICENSE)
     
 ## Usage
 

data/app/demo/components/date_fields.pom

@@ -0,0 +1,96 @@
+require 'date'
+
+Voom::Presenters.define(:date_fields) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :component_drawer
+
+  indented_grid do
+    display 'Date Fields'
+    body <<~DOC
+      A date separates user display format from the value format.  
+      
+      The default date user display [format](/formatting_tokens#date) can be configured globally using the following:      
+      
+      ````
+      Voom::Presenters::Settings.configure do |config|
+        config.presenters.components.defaults.date.format = 'F j, Y'
+      end
+      ````
+            
+      The value format for date times can be the following:
+
+      * Ruby Time/DateTime objects.
+      * ISO/Chronologically Date Strings, e.g. "2017-02-26"
+    DOC
+    grid do
+      column 6 do
+        date_field name: :skydive_at,
+                       format: 'F j, Y' do
+          label 'Select your date to skydive'
+          icon :event
+          event :change do
+            replaces :context_list, :context_list, hide_time: true
+          end
+        end
+      end
+      column 6 do
+        attach :context_list, hide_time: true
+      end
+    end
+    grid do
+      column 6 do
+        title 'Min Date'
+        date_field min_date: "2020-01-01"
+
+        title 'Max Date'
+        date_field max_date: "2017-12-15"
+
+        title 'Min Date (today)'
+        date_field min_date: :today
+
+        title 'Min (today), Max (14 days from now)'
+        date_field min_date: :today, max_date: DateTime.now.next_day(14) # Or in rails Time.now + 14.days
+
+        title 'Disabling specific dates'
+        date_field disable: ["2025-01-30", "2025-02-21", "2025-03-08", DateTime.new(2025, 4, 9)]
+
+        title 'Disable range of dates'
+        date_field disable: [
+            {
+                from: "2025-04-01",
+                to: "2025-05-01"
+            },
+            {
+                from: "2025-09-01",
+                to: "2025-12-01"
+            }
+        ]
+
+        title 'Enabling specific dates'
+        date_field enable: [
+            {
+                from: "2025-04-01",
+                to: "2025-05-01"
+            },
+            {
+                from: "2025-09-01",
+                to: "2025-12-01"
+            }
+        ]
+        title 'Selecting multiple dates'
+        date_field mode: :multiple
+
+        title 'Preloading multiple dates'
+        date_field mode: :multiple do
+          value ["2016-10-20", "2016-11-04"]
+        end
+
+        title 'Range'
+        date_field mode: :range
+      end
+    end
+
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/components/datetime_fields.pom

@@ -0,0 +1,106 @@
+require 'date'
+
+Voom::Presenters.define(:datetime_fields) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :component_drawer
+
+  indented_grid do
+    display 'Date Time'
+    body <<~DOC
+      A date time separates user display format from the value format.  
+      
+      The default date time user display [format](/formatting_tokens#date) can be configured globally using the following:      
+      
+      ````
+      Voom::Presenters::Settings.configure do |config|
+        config.presenters.components.defaults.datetime.format = 'F j, Y H:i'
+      end
+      ````
+            
+      The value format for date times can be the following:
+
+      * Ruby Time/DateTime objects.
+      * ISO Date Strings, e.g. "2017-02-26T19:40:03.243Z"
+      * Chronologically Date Strings, e.g., YYYY-MM-DD HH:MM
+    DOC
+    grid do
+      column 6 do
+        datetime_field name: :skydive_at,
+                       format: 'F j, Y h:i' do
+          label 'Select your date and time to skydive'
+          icon :event
+          event :change do
+            replaces :context_list, :context_list, hide_time: true
+          end
+        end
+      end
+      column 6 do
+        attach :context_list, hide_time: true
+      end
+    end
+    grid do
+      column 6 do
+        title 'Min Date'
+        datetime_field min_date: "2020-01-01 00:15"
+
+        title 'Max Date'
+        datetime_field max_date: "2017-12-15 02:00"
+
+        title 'Min Date (today)'
+        datetime_field min_date: :today
+
+        title 'Min (today), Max (14 days from now)'
+        datetime_field min_date: :today, max_date: DateTime.now.next_day(14) # Or in rails Time.now + 14.days
+
+        title 'Disabling specific dates'
+        datetime_field disable: ["2025-01-30", "2025-02-21", "2025-03-08", DateTime.new(2025, 4, 9)]
+
+        title 'Disable range of dates'
+        datetime_field disable: [
+            {
+                from: "2025-04-01",
+                to: "2025-05-01"
+            },
+            {
+                from: "2025-09-01",
+                to: "2025-12-01"
+            }
+        ]
+
+        title 'Enabling specific dates'
+        datetime_field enable: [
+            {
+                from: "2025-04-01",
+                to: "2025-05-01"
+            },
+            {
+                from: "2025-09-01",
+                to: "2025-12-01"
+            }
+        ]
+        title 'Selecting multiple dates'
+        datetime_field mode: :multiple
+
+        title 'Preloading multiple dates'
+        datetime_field mode: :multiple do
+          value ["2016-10-20", "2016-11-04"]
+        end
+
+        title 'Min Time'
+        datetime_field min_time: "9:00"
+
+        title 'Max Time'
+        datetime_field max_time: "20:00"
+
+        title 'Range'
+        datetime_field mode: :range
+
+        title '24 hour time'
+        datetime_field time_24hr: true, format: 'H:i'
+      end
+    end
+
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/components/nav/drawer.pom

@@ -1,5 +1,5 @@
 Voom::Presenters.define(:component_drawer) do
-  drawer 'Presenters Demo' do
+  drawer 'Components' do
     attach :component_menu
   end
 end

data/app/demo/components/nav/menu.pom

@@ -2,7 +2,7 @@ Voom::Presenters.define('component_menu') do
   helpers Voom::Presenters::Helpers::Inflector
   menu side: :left do
     %i(cards lists expansion_panels tables text_fields selects buttons fabs fabs_mini dialogs layouts headers drawers
-         footers menus toggles chips snackbar badges tooltips hidden_fields text_areas forms icons).sort.each do |comp|
+         footers menus toggles chips snackbar badges tooltips hidden_fields text_areas forms icons datetime_fields date_fields time_fields).sort.each do |comp|
       item titleize(comp) do
         event :click do
           loads comp

data/app/demo/components/time_fields.pom

@@ -0,0 +1,59 @@
+require 'date'
+
+Voom::Presenters.define(:time_fields) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :component_drawer
+
+  indented_grid do
+    display 'Time Field'
+    body <<~DOC
+      A time field separates user display format from the value format.  
+      
+      The default time user display [format](/formatting_tokens#time) can be configured globally using the following:      
+      
+      ````
+      Voom::Presenters::Settings.configure do |config|
+        config.presenters.components.defaults.time.format = 'h:i K'
+      end
+      ````
+            
+      The value format for date times can be the following, they are expected to be in 24 hour time:
+
+      * Ruby Time/DateTime objects.
+      * Chronologically Time Strings, e.g., HH:MM
+    DOC
+    grid do
+      column 6 do
+        time_field name: :skydive_at,
+                       format: 'H:i' do
+          label 'Select your time to skydive'
+          icon :event
+          event :change do
+            replaces :context_list, :context_list, hide_time: true
+          end
+        end
+      end
+      column 6 do
+        attach :context_list, hide_time: true
+      end
+    end
+    grid do
+      column 6 do
+        title 'Min Time'
+        time_field min_time: "9:00"
+
+        title 'Max Time'
+        time_field max_time: "20:00"
+
+        title 'Range'
+        time_field min_time: "16:00", max_time: "20:00"
+
+        title '24 hour time'
+        time_field time_24hr: true
+      end
+    end
+
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/components/toggles.pom

@@ -17,13 +17,40 @@ Voom::Presenters.define(:toggles) do
     radio_button
 
     headline 'ICON TOGGLE'
-    icon_toggle 'format_bold', checked: true 
+    icon_toggle 'format_bold', checked: true
     icon_toggle 'format_italic'
 
     headline 'SWITCH'
     switch checked: true
     switch
 
+    grid do
+      column 6 do
+        display 'Field Level Events'
+        heading 'Text Fields'
+        body 'This demonstrates that a change event will submit the  field value to the event action. '\
+                 'This works with posts and replace actions'
+        switch name: :myfield do
+          event :change do
+            replaces :context_list, :context_list
+          end
+        end
+       
+        display 'Posts in Form'
+        body 'This demonstrates that a change event on **ANY** form input will send all the form inputs to the event action. '\
+                 'This works with posts and replace actions'
+        form do
+          switch name: :myfield
+          switch name: :myfield2
+          event :change do
+            replaces :context_list, :context_list
+          end
+        end
+      end
+      column 6 do
+        attach :context_list
+      end
+    end
     attach :code, file: __FILE__
   end
 end

data/app/demo/events/actions/autocomplete.pom

@@ -0,0 +1,32 @@
+Voom::Presenters.define(:autocomplete_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+
+    heading 'Autocomplete'
+    title 'Work In Progress'
+    body 'Provides a text field that when typed into will fetch a set of items to select base on what was typed.',
+         'Useful for providing search clues as the user types.',
+         'The search command returned should either an array of text terms found,
+              or optionally an id that will also be sumbitted using the same name as plus `_id` as the text field.'
+
+
+    heading 'Search'
+    content id: :search_field do
+      text_field name: :search, full_width: false do
+        label 'Search Silicon Valley'
+        event :input do
+          autocomplete '/_search_'
+        end
+        event :change do
+          replaces :context_list, :context_list, title: 'Search Results'
+        end
+      end
+    end
+    attach :context_list, title: 'Search Results'
+  end
+
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/deletes.pom

@@ -0,0 +1,24 @@
+Voom::Presenters.define(:deletes_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Deletes'
+    body 'Issues a DEL to a given url',
+         'Generally used to destroy/delete a restful resource.'
+    body '*Note: Will generate a 404.*'
+
+    title 'Deletes'
+    body 'issues a DELETE to the passed path'
+    content do
+      button 'deletes' do
+        event :click do
+          # Will generate an error
+          deletes 'deletepath', {optional: :params}
+        end
+      end
+    end
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/dialog.pom

@@ -0,0 +1,19 @@
+Voom::Presenters.define(:dialog_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+  
+  indented_grid do
+    heading 'Dialog'
+    body 'A dialog event displays a, you guessed it, dialog.'
+
+    title 'Dialog'
+    button 'dialog' do
+      event :click do
+        dialog :my_dialog
+      end
+    end
+    attach :show_dialog
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/loads.pom

@@ -0,0 +1,19 @@
+Voom::Presenters.define(:toggle_visibility_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Loads'
+    body 'Loads a new presenter, replacing the whole page.'
+
+    subheading context['reloaded'] ? "Reloaded" : 'Loads'
+    button 'loads' do
+      event :click do
+        loads :events, reloaded: true
+      end
+    end
+    heading context['reloaded'] ? "Reloaded" : 'Loaded'
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/posts.pom

@@ -0,0 +1,23 @@
+Voom::Presenters.define(:posts_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Posts'
+    body 'Issues a POST to a given url',
+         'Generally used to create a restful resource or issue a command.'
+    body '*Note: Will generate a 404.*'
+
+    title 'Posts'
+    body "issues a POST to the passed path\nAlias: creates"
+    content shows_errors: false do
+      button 'posts' do
+        event :click do
+          posts 'postpath', {optional: :params}
+        end
+      end
+    end
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/replaces.pom

@@ -0,0 +1,21 @@
+Voom::Presenters.define(:replaces_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Replaces'
+    body 'Replaces will replace content on the page with another presenter.',
+         'It takes the id of what to replace, usually a content block. And the presenter to replace it with.',
+         "You pass parameters to it as the last argument."
+
+    subheading 'Replaces'
+    button 'replaces' do
+      event :click do
+        replaces :replace_me, :replace_text, text: "I was replaced"
+      end
+    end
+    attach :replace_text
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/snackbar.pom

@@ -0,0 +1,19 @@
+Voom::Presenters.define(:snackbar_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Snackbar'
+    body 'Displays the snackbar at the bottom of the screen.',
+         'Useful for inplace editing notifications of success'
+
+    subheading 'Snackbar'
+    button 'snackbar' do
+      event :click do
+        snackbar 'I want a snack!'
+      end
+    end
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/toggle_visiblity.pom

@@ -0,0 +1,21 @@
+Voom::Presenters.define(:toggle_visibility_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Toggle Visibility'
+    body 'Allows you to toggle visiblity of content on and off on events.',
+         'Takes the id of the element to toggle.',
+         "Optionally takes :on or :off to force visiblity."
+
+    subheading 'Toggle Visibility'
+    button 'toggle visiblity' do
+      event :click do
+        toggle_visiblity :toggle_me
+      end
+    end
+    heading 'Sometimes I appear', id: :toggle_me
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/actions/updates.pom

@@ -0,0 +1,24 @@
+Voom::Presenters.define(:updates_action) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    heading 'Updates'
+    body 'Issues a PUT to a given url',
+         'Generally used to update a restful resource.'
+    body '*Note: Will generate a 404.*'
+    
+    title 'Updates'
+    body 'issues a PUT to the passed path'
+    content do
+      button 'updates' do
+        event :click do
+          # This goes nowhere
+          updates 'updatepath', {optional: :params}
+        end
+      end
+    end
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/field_level.pom

@@ -0,0 +1,20 @@
+Voom::Presenters.define(:field_level_events) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    display 'Field Level Events'
+    heading 'Text Fields'
+    body 'This demonstrates that a change event will submit the  field value to the event action. '\
+             'This works with posts and replace actions'
+    text_field name: :myfield do
+      label 'Data to post'
+      event :change do
+        replaces :context_list, :context_list
+      end
+    end
+    attach :context_list
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/events/form_level.pom

@@ -0,0 +1,24 @@
+Voom::Presenters.define(:form_level_events) do
+  helpers Demo::Helpers::IndentedGrid
+
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    display 'Posts in Form'
+    body 'This demonstrates that a change event on **ANY** form input will send all the form inputs to the event action. '\
+             'This works with posts and replace actions'
+    form do
+      text_field name: :myfield do
+        label 'Data to post'
+      end
+      text_field name: :myfield2 do
+        label 'More Data to post'
+      end
+      event :change do
+        replaces :context_list, :context_list
+      end
+    end
+    attach :context_list
+  end
+end