coprl 3.0.0.beta.1 → 3.0.0.beta.6

data/README.md

@@ -64,7 +64,7 @@ To see the POM:
 ### Rails
 Presenters are a view templating language in Rails. 
 You can mix and match presenters with your existing views, 
-use them as new views, or call them as partails in existing views.
+use them as new views, or call them as partials in existing views.
 
 #### 1) Add presenters to Gemfile    
     gem 'coprl'
@@ -86,7 +86,12 @@ Navigate to [locahost:3000/hello_world](http://127.0.0.1:3000/hello_world)
 
 Use the [Demo] to get example code to drop into your presenters.
 
-#### 5) Optionally -- use presenters as partials from ERB/HAML
+#### Optional — Setting the root route
+If you name a presenter :index and want the root of the app to serve up that presenter add the following to your `config/initializers/routes.rb`
+
+    root 'coprl#show'
+
+#### Optionally — use presenters as partials from ERB/HAML
 You can render a presenter as a partial from other templating laguages (erb, haml):
 
     <%= render 'show', presenter: 'hello_world' %> 
@@ -96,13 +101,13 @@ You need to add the following to your layout to use presenters as a partial alon
 ##### Inside the &lt;head&gt; tag add the following:
 
       <title><%= @pom.page.title if @pom.page %></title>
-      <%= coprl_headers(@base_url, request, @pom) %> 
+      <%= coprl_headers %> 
 
 ##### Inside the &lt;body&gt; tag, around you existing yield add the following:
 
-    <%= partial "body/preamble", :locals => {pom:@pom} %>
+    <%= with_presenters_wrapper do %>
     <%= yield %>
-    <%= partial "body/postamble", :locals => {pom:@pom} %>
+    <%= end %>
 
 ### Rack
 #### 1) To use it, add this line to your Gemfile:

data/app/demo/components/dialogs.pom

@@ -170,7 +170,7 @@ Coprl::Presenters.define(:dialogs) do
         end
       end
       separator
-      content tag: :second_form_input do
+      content input_tag: :second_form_input do
         dlg_form
       end
       subtitle 'The buttons below are Dialog Action buttons. When clicked, they will process any configured actions, then automatically clsoe the dialog.'

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

@@ -25,7 +25,6 @@ Coprl::Presenters.define('component_menu') do
       layouts
       lists
       number_fields
-      maps
       menus
       multi_selects
       progress

data/app/demo/components/snackbar.pom

@@ -8,10 +8,10 @@ Coprl::Presenters.define(:snackbar) do
 
   indented_grid do
     title 'On Page'
-    body 'You can attach a snackbar on the server side and will render after load.'
+    body 'You can invoke or attach a snackbar on the server side and will render after load.'
     snackbar 'Top Level Important Information!'
-
-    attach :snackbar_attached
+    # This is the same as above -- see POM at end of file
+    # attach :snackbar_attached
 
     title 'As Event'
     button 'Show Snackbar', id: :show_snackbar do
@@ -33,3 +33,9 @@ Coprl::Presenters.define(:snackbar) do
 
   attach :code, file: __FILE__
 end
+
+# Coprl::Presenters.define(:snackbar_attached) do
+#   title 'In Attached'
+#   body  'This can be done in an attached presenter as well'
+#   snackbar 'Attached Snackbar Displayed!'
+# end

data/app/demo/events/content_as_form.pom

@@ -118,7 +118,7 @@ Coprl::Presenters.define(:content_as_form) do
 
   grid do
     column 12 do
-      text_field id: :input_tag_extra, name: :whatever, tag: :test_input_tag do
+      text_field id: :input_tag_extra, name: :whatever, input_tag: :test_input_tag do
         value 'foo bar'
       end
     end
@@ -127,7 +127,7 @@ Coprl::Presenters.define(:content_as_form) do
   indented_grid do
     card do
       title 'Content with input_tag'
-      content id: :content_2, tag: :test_input_tag do
+      content id: :content_2, input_tag: :test_input_tag do
         text_field name: :text1 do
           label 'Text 1'
         end
@@ -275,7 +275,7 @@ end
 
 Coprl::Presenters.define(:dialog_c) do
   dialog id: :dialog_c do
-    content tag: :some_dialog_tag do
+    content input_tag: :some_dialog_tag do
       text_field name: :dialog_text_field do
         value 'whatever'
       end

data/app/demo/events/halted.pom

@@ -0,0 +1,23 @@
+Coprl::Presenters.define(:halted) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :events_drawer
+
+  indented_grid do
+    display 'Halted Events'
+    body 'This demonstrates how to respond to failed, or halted events'
+
+    content do
+      button :failed_post do
+        event :click do
+          posts '_echo_', status: 500
+        end
+        event 'V:eventsHalted' do
+          snackbar 'That did not work! Please try again later.'
+        end
+      end
+
+    end
+  end
+  attach :code, file: __FILE__
+end

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

@@ -1,7 +1,7 @@
 Coprl::Presenters.define(:events_drawer) do
   helpers Coprl::Presenters::Helpers::Inflector
 
-  events = %i[field_level_events form_level_events tagged_input parallel_events].sort
+  events = %i[field_level_events form_level_events tagged_input parallel_events halted].sort
   actions = %i[dialog replaces loads toggle_visibility snackbar updates deletes posts clear last_response prompt_if_dirty].sort
 
   drawer 'Events' do

data/app/demo/events/tagged_input.pom

@@ -18,11 +18,11 @@ Coprl::Presenters.define(:tagged_input) do
 
     title 'Example'
 
-    content tag: :somefields do
+    content input_tag: :somefields do
       radio_button text: :on, name: :check_me, value: :on, checked: true
       radio_button text: :off, name: :check_me, value: :off
     end
-    text_field name: :myfield2, tag: :somefields do
+    text_field name: :myfield2, input_tag: :somefields do
       label 'More Data to post'
     end
 

data/app/demo/patterns/search_select.pom

@@ -21,7 +21,7 @@ Coprl::Presenters.define(:search_select) do
 
   page_title 'Search and Select Pattern'
   indented_grid do
-    grid tag: :input_data_container do
+    grid input_tag: :input_data_container do
       column 6 do
         grid do
           column 4 do

data/app/demo/plugins/animate.pom

@@ -0,0 +1,144 @@
+Coprl::Presenters.define(:animate, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :animate, :scroll_to
+  page_title 'Animate', id: :page_title
+
+  indented_grid do
+    grid do
+      column 4 do
+        heading "Animations plugin", id: :animate_heading
+        subheading "Just-add-POM CSS animations"
+        body "It is based on [animate.css](https://animate.style/)."
+      end
+      column 8 do
+        [["Attention seekers",
+          %i( bounce
+              flash
+              pulse
+              rubber_band
+              shake_x
+              shake_y
+              head_shake
+              swing
+              tada
+              wobble
+              jello
+              heart_beat)],
+         ["Back entrances",
+          %i( back_in_down
+              back_in_left
+              back_in_right
+              back_in_up)],
+         ["Back exits",
+          %i( back_out_down
+              back_out_left
+              back_out_right
+              back_out_up)],
+         ["Bouncing entrances",
+          %i( bounce_in
+              bounce_in_down
+              bounce_in_left
+              bounce_in_right
+              bounce_in_up)],
+         ["Bouncing exits",
+          %i( bounce_out
+              bounce_out_down
+              bounce_out_left
+              bounce_out_right
+              bounce_out_up)],
+         ["Fading entrances",
+          %i( fade_in
+              fade_in_down
+              fade_in_down_big
+              fade_in_left
+              fade_in_left_big
+              fade_in_right
+              fade_in_right_big
+              fade_in_up
+              fade_in_up_big
+              fade_in_top_left
+              fade_in_top_right
+              fade_in_bottom_left
+              fade_in_bottom_right)],
+         ["Fading exits",
+          %i( fade_out
+              fade_out_down
+              fade_out_down_big
+              fade_out_left
+              fade_out_left_big
+              fade_out_right
+              fade_out_right_big
+              fade_out_up
+              fade_out_up_big
+              fade_out_top_left
+              fade_out_top_right
+              fade_out_bottom_right
+              fade_out_bottom_left)],
+         ["Flippers",
+          %i( flip
+              flip_in_x
+              flip_in_y
+              flip_out_x
+              flip_out_y)],
+         ["lightspeed",
+          %i(  light_speed_in_right
+              light_speed_in_left
+              light_speed_out_right
+              light_speed_out_left)],
+         ["Rotating entrances",
+          %i( rotate_in
+              rotate_in_down_left
+              rotate_in_down_right
+              rotate_in_up_left
+              rotate_in_up_right)],
+         ["Rotating exits",
+          %i( rotate_out
+              rotate_out_down_left
+              rotate_out_down_right
+              rotate_out_up_left
+              rotate_out_up_right)],
+         ["Specials",
+          %i( hinge
+              jack_in_the_box
+              roll_in
+              roll_out)],
+         ["Zooming entrances",
+          %i( zoom_in
+              zoom_in_down
+              zoom_in_left
+              zoom_in_right
+              zoom_in_up)],
+         ["Zooming exits",
+          %i( zoom_out
+              zoom_out_down
+              zoom_out_left
+              zoom_out_right
+              zoom_out_up)],
+         ["Sliding entrances",
+          %i( slide_in_down
+              slide_in_left
+              slide_in_right
+              slide_in_up)],
+         ["Sliding exits",
+          %i( slide_out_down
+              slide_out_left
+              slide_out_right
+              slide_out_up)]].each do |animiation_title, animiations|
+          subtitle animiation_title
+          animiations.each do |animation|
+            button animation do
+              event :click do
+                scroll_to :page_title
+                animate :animate_heading, animation, wait: true
+              end
+            end
+          end
+        end
+      end
+    end
+
+    attach :code, file: __FILE__
+  end
+end

data/app/demo/plugins/cacheable.pom

@@ -0,0 +1,64 @@
+require 'ostruct'
+
+Coprl::Presenters.define(:cacheable, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :cacheable
+
+  page_title 'Cacheable'
+
+  helpers do
+    def cache_object
+      OpenStruct.new(cache_key: 'wild')
+    end
+
+    def cache_objects
+      [
+        OpenStruct.new(cache_key: 'abc'),
+        OpenStruct.new(cache_key: '123'),
+      ]
+    end
+  end
+
+  indented_grid do
+    body <<~DOC
+      The caching plugin provides russian doll caching support.
+      Declare the plugin in your pom, `plugin :cacheable`, or configure it globally:
+
+      ```
+      Coprl::Presenters::Settings.configure do |config|
+        config.presenters.plugins.push(:cacheable)
+      end
+      ```
+
+      For Rails it automatically uses the Rails::Cache. For other Rack apps you need to configure it with a block:
+
+      ```
+      Coprl::Presenters::Plugins::Cacheable::Settings.configure do |config|
+        # A cache needs to respond to fetch(key, &block) and exist?(key) or has_key?(key)
+        config.cache=cache_store
+      end
+      ```
+      Simply wrap your POM with the cache directive. 
+      Complex keys are supported.  If an object responds to `cache_key` then that will be used for it.  
+      An object that responds to `map` will be expanded.  As a last resort `to_s` is used.
+               
+      Examples (refresh your browser to observe cached values):
+    DOC
+    title "Not cached at #{DateTime.now}"
+    cache :remember_me do
+      title "Simple Cache Key - cached at #{DateTime.now}"
+    end
+
+    cache [:title, cache_object, cache_objects] do
+      title "Complex Cache Key - cached at #{DateTime.now}"
+    end
+    blank
+    body <<~DOC
+      Note: Confusion alert ... if you are using shotgun for the demo, it **will not cache**, since the demo uses an in memory cache and shotgun reloads its entire process with each refresh.
+    DOC
+
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/plugins/clipboard.pom

@@ -0,0 +1,21 @@
+Coprl::Presenters.define(:clipboard, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :clipboard
+  page_title 'Clipboard'
+
+  indented_grid do
+    headline 'Copy'
+    text_field id: :copy_me do
+      value "Don't copy that floppy!"
+    end
+    button :copy, type: :raised do
+      event :click do
+        clipboard copy: :copy_me
+      end
+    end
+  end
+
+  attach :code, file: __FILE__
+end

data/app/demo/plugins/color_picker.pom

@@ -0,0 +1,17 @@
+Coprl::Presenters.define(:color_picker, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :color_picker
+  page_title 'Color picker'
+
+  indented_grid do
+    subheading 'Add a Color picker to your page'
+    color_picker 'color',
+                 value: '#f44336',
+                 color_per_row: 7,
+                 color_size: 25
+
+    attach :code, file: __FILE__
+  end
+end

data/app/demo/plugins/google_maps.pom

@@ -0,0 +1,24 @@
+Coprl::Presenters.define(:google_maps, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :google_maps
+  page_title 'Maps'
+
+  indented_grid do
+    unless ENV['GOOGLE_API_KEY']
+      headline 'You must define the ENV variable GOOGLE_API_KEY for this to render a map'
+      subtitle 'Dev hint: Create an .env file with a `GOOGLE_API_KEY=yourkey` and restart. Goto [Google Using API Keys](https://developers.google.com/maps/documentation/javascript/get-api-key) to create a key.'
+    end
+    subheading 'Static Maps'
+    address = '125 Park Street, Traverse City, MI'
+    google_map address: address, height: "300px", width: "400px"  do
+      event :click do
+        loads "https://www.google.com/maps/place/#{address}"
+      end
+    end
+
+    attach :code, file: __FILE__
+  end
+
+end