polaris_view_helpers 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33469dde16259e76722932874e586026edb048ff
-  data.tar.gz: dad2ab9dd213a8f2f861bc1fae20d381f396c523
+  metadata.gz: 9d438b1e0a74c191a1fd04454b76a4dc19419eac
+  data.tar.gz: 39b9f5d35e090586361401b5134b269d19bc9539
 SHA512:
-  metadata.gz: e9adb02354582941d9f5cc4eaf8203b4e3047cadebf2a78f0729a002979a5febf083969d39c76264e2d583cd5aa152230dfcd6bad061ad3cae11f8b1ae566e27
-  data.tar.gz: fc8249947ca95744c2fa7bcf5a7ef2ded0deb45d79ed28faee5e0ebc6375b3c20bd1ebb14200063972d9479ad97d7234fffd643369814e46d0e65c0d943614c8
+  metadata.gz: 9c6418119541e5d3c0530a0b41312017e38be771cc0dffc0da61688b89cc3c28a3f5d2c46cc2e2ad5285b66515283143c4b57ce060bf31b05149dc98c5f7243a
+  data.tar.gz: 510e317eab3a14349ae275bee2dfc189a796bacfb77fe1f224f5e8212e6295a8ded1dab6e7d8119b3aaaf5dece34646cdd709b11fd6dc12023eca58b55e09e49

data/app/views/polaris/_annotated_section.html.erb

@@ -3,7 +3,11 @@
     <div class="Polaris-Layout__Annotation">
       <div class="Polaris-TextContainer">
         <h2 class="Polaris-Heading"><%= heading %></h2>
-        <%= description %>
+        <% if description.html_safe? %>
+          <%= description %>
+        <% else %>
+          <p><%= description %></p>
+        <% end %>
       </div>
     </div>
     <div class="Polaris-Layout__AnnotationContent">

data/app/views/polaris/_form_layout.html.erb

@@ -0,0 +1,4 @@
+<div class="Polaris-FormLayout">
+  <%= capture(&block) %>
+</div>
+

data/app/views/polaris/_heading.html.erb

@@ -0,0 +1 @@
+<h2 class="Polaris-Heading"><%= title %></h2>

data/app/views/polaris/_layout.html.erb

@@ -0,0 +1,4 @@
+<div class="Polaris-Layout">
+  <%= capture(&block) %>
+</div>
+

data/app/views/polaris/_page.html.erb

@@ -0,0 +1,4 @@
+<div class="Polaris-Page">
+  <%= capture(&block) %>
+</div>
+

data/app/views/polaris/_page_content.html.erb

@@ -0,0 +1,4 @@
+<div class="Polaris-Page__Content">
+  <%= capture(&block) %>
+</div>
+

data/app/views/polaris/_page_header.html.erb

@@ -0,0 +1,7 @@
+<div class="Polaris-Page__Header">
+  <h1 class="Polaris-DisplayText Polaris-DisplayText--sizeLarge"><%= title %></h1>
+  <% if block.present? %>
+    <%= capture(&block) %>
+  <% end %>
+</div>
+

data/app/views/polaris/_text_field.html.erb

@@ -0,0 +1,15 @@
+<% attribute.each do |att| %>
+  <div class="Polaris-FormLayout__Item">
+    <div class="">
+      <div class="Polaris-Labelled__LabelWrapper">
+        <div class="Polaris-Label">
+          <%= form.label att, options[:label], class: 'Polaris-Label__Text' %>
+        </div>
+      </div>
+      <div class="Polaris-TextField">
+        <%= form.send element_type, att, id: "#{form.object.class.name.tableize.singularize}_#{att}", class: "Polaris-TextField__Input", placeholder: options[:placeholder] %>
+        <div class="Polaris-TextField__Backdrop"></div>
+      </div>
+    </div>
+  </div>
+<% end %>

data/lib/polaris_view_helpers/helper.rb

@@ -1,6 +1,52 @@
 module PolarisViewHelpers
   module Helper
 
+    def polaris_css version = '1.6.0'
+      %[<link rel="stylesheet" href="https://sdks.shopifycdn.com/polaris/#{version}/polaris.min.css" />].html_safe
+    end
+
+    def polaris_page(&block)
+      render(
+        partial: 'polaris/page',
+        locals: { block: block }
+      )
+    end
+
+    def polaris_page_header(title, &block)
+      render(
+        partial: 'polaris/page_header',
+        locals: { title: title, block: block }
+      )
+    end
+
+    def polaris_heading(title)
+      render(
+        partial: 'polaris/heading',
+        locals: { title: title }
+      )
+    end
+
+    def polaris_page_content(&block)
+      render(
+        partial: 'polaris/page_content',
+        locals: { block: block }
+      )
+    end
+
+    def polaris_layout(&block)
+      render(
+        partial: 'polaris/layout',
+        locals: { block: block }
+      )
+    end
+
+    def polaris_form_layout(&block)
+      render(
+        partial: 'polaris/form_layout',
+        locals: { block: block }
+      )
+    end
+
     def polaris_tabs(&block)
       render(
         partial: 'polaris/tabs',
@@ -121,6 +167,23 @@ module PolarisViewHelpers
       )
     end
 
+    def polaris_text_field(form, attribute, options = {}, element_type = :text_field, &block)
+      unless attribute.is_a? Array
+        attribute = [attribute]
+      end
+
+      render(
+        partial: 'polaris/text_field',
+        locals: {
+          form: form,
+          attribute: attribute,
+          element_type: element_type,
+          options: options,
+          block: block
+        }
+      )
+    end
+
     def polaris_annotated_section_text_field(form, attribute, options = {}, element_type = :text_field, &block)
       unless attribute.is_a? Array
         attribute = [attribute]

data/lib/polaris_view_helpers/version.rb

@@ -1,3 +1,3 @@
 module PolarisViewHelpers
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/test/dummy/app/assets/javascripts/home.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -13,3 +13,9 @@
  *= require_tree .
  *= require_self
  */
+
+code.demo{
+  border-top:1px solid #dedede;
+  border-bottom:1px solid #dedede;
+  display:block;
+}

data/test/dummy/app/assets/stylesheets/home.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,5 @@
 module ApplicationHelper
+  def demo_partial name
+    render 'home/demo_partial', {name: name}
+  end
 end

data/test/dummy/app/helpers/home_helper.rb

@@ -0,0 +1,2 @@
+module HomeHelper
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/models/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ApplicationRecord
+  validates :title, presence: true
+end

data/test/dummy/app/views/home/_annotated_section.html.erb

@@ -0,0 +1,9 @@
+<%= form_with url: root_url do |form| %>
+  <%= polaris_layout do %>
+    <%= polaris_annotated_section( heading: "Some heading", description: "A description of this section") do %>
+      <%= polaris_form_layout_item_select form, :timezone do %>
+        <%= form.time_zone_select :timezone, ActiveSupport::TimeZone.us_zones, {include_blank: true}, id: :setting_timezone, class: "Polaris-Select__Input" %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/test/dummy/app/views/home/_banner.html.erb

@@ -0,0 +1,3 @@
+<%= polaris_banner status: 'warning', title: "Banner title" do %>
+  <p>You could put some useful info here</p>
+<% end %>

data/test/dummy/app/views/home/_banner_success.html.erb

@@ -0,0 +1,6 @@
+<%= polaris_banner status: 'success', title: 'Good news!' do %>
+  <p>This banner means that something good happened. Maybe you want to do anther thing?</p>
+  <%= polaris_banner_actions do %>
+    <%= polaris_button_link_to "Do a thing!", root_path, modifiers: ['outline'] %>
+  <% end %>
+<% end %>

data/test/dummy/app/views/home/_button_links.html.erb

@@ -0,0 +1 @@
+<%= polaris_button_link_to("Button text", root_path) %>

data/test/dummy/app/views/home/_button_links_with_modifiers.html.erb

@@ -0,0 +1 @@
+<%= polaris_button_link_to("Button text", root_path, modifiers: ['primary', 'sizeSlim']) %>

data/test/dummy/app/views/home/_demo_partial.html.erb

@@ -0,0 +1,8 @@
+<p>&nbsp;</p>
+<h3>Demo</h3>
+<%= render name %>
+<p>&nbsp;</p>
+<h3>Code</h3>
+<code class="demo">
+  <pre><%= File.open("test/dummy/app/views/home/_#{name}.html.erb").read %></pre>
+</code>

data/test/dummy/app/views/home/_model_errors.html.erb

@@ -0,0 +1,3 @@
+<% invalid_widget = Widget.new %>
+<% invalid_widget.validate %>
+<%= polaris_model_errors invalid_widget %>

data/test/dummy/app/views/home/_page_actions.html.erb

@@ -0,0 +1,4 @@
+<%= polaris_page_actions({
+  left: polaris_button_link_to("One thing", root_path),
+  right: polaris_button_link_to("Another thing", root_path, modifiers: ['primary'])
+}) %>

data/test/dummy/app/views/home/_tabs.html.erb

@@ -0,0 +1,4 @@
+<%= polaris_tabs do %>
+  <%= polaris_tab "First tab", root_path %>
+  <%= polaris_tab "Second tab", root_path(foo: 'bar') %>
+<% end %>

data/test/dummy/app/views/home/_text_field.html.erb

@@ -0,0 +1,6 @@
+<%= form_with url: root_url do |form| %>
+  <%= polaris_form_layout do %>
+    <%= polaris_text_field form, :name %>
+    <%= polaris_text_field form, :email, {}, :email_field %>
+  <% end %>
+<% end %>

data/test/dummy/app/views/home/index.html.erb

@@ -0,0 +1,98 @@
+<% @page_title = 'Polaris View Helpers' %>
+<p>A collection of Rails helpers to make it easy to style a Shopify app.</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+<%= polaris_heading "Installing" %>
+
+<p>Add this to your <code>Gemfile</code>.</p>
+<code class="demo"><pre>
+ gem 'polaris_view_helpers'
+</pre></code>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+<%= polaris_heading "Including the Polaris CSS" %>
+<p>Add this to the <code>&lt;head&gt;</code> of your <code>layouts/application.html.erb</code> and/or
+<code>layouts/embedded_app.html.erb</code>.</p>
+<code class="demo"><pre>
+ &lt;%= polaris_css %&gt;
+</pre></code>
+<p>&nbsp;</p>
+<p>If you need to specify a particular version of the CSS you can do so:</p>
+<code class="demo"><pre>
+ &lt;%= polaris_css '1.0.3' %&gt;
+</pre></code>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+<%= polaris_heading "Setting up your page" %>
+<p>In <code>layouts/application.html.erb</code> and/or
+<code>layouts/embedded_app.html.erb</code>you'll want to replace the conent
+between the <code>&lt;body&gt;</code> tags with something like this.</p>
+<code class="demo"><pre>
+  &lt;%= polaris_page do %&gt;
+    &lt;%= polaris_page_header @page_title %&gt;
+    &lt;%= polaris_page_content do %&gt;
+      &lt;%= yield %&gt;
+    &lt;% end %&gt;
+  &lt;% end %&gt;
+</pre></code>
+<p>&nbsp;</p>
+<p>You can set the <code>@page_title</code> variable either in a controller action or in a template to get a header for each page.</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+
+
+<%= polaris_heading "Button links" %>
+<%= demo_partial 'button_links' %>
+<%= demo_partial 'button_links_with_modifiers' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+
+<%= polaris_heading "Tabs" %>
+<%= demo_partial 'tabs' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+<%= polaris_heading "Banners" %>
+<%= demo_partial 'banner' %>
+<%= demo_partial 'banner_success' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+
+<%= polaris_heading "Text fields" %>
+<%= demo_partial 'text_field' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+
+<%= polaris_heading "Annotated Section" %>
+<%= demo_partial 'annotated_section' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+<%= polaris_heading "Model errors" %>
+<%= demo_partial 'model_errors' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+
+
+<%= polaris_heading "Page actions" %>
+<%= demo_partial 'page_actions' %>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>

data/test/dummy/app/views/layouts/application.html.erb

@@ -3,12 +3,18 @@
 <head>
   <title>Dummy</title>
   <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= polaris_css %>
   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
   <%= csrf_meta_tags %>
 </head>
 <body>
 
-<%= yield %>
+  <%= polaris_page do %>
+    <%= polaris_page_header @page_title %>
+    <%= polaris_page_content do %>
+      <%= yield %>
+    <% end %>
+  <% end %>
 
 </body>
 </html>

data/test/dummy/config/application.rb

@@ -20,7 +20,7 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    #config.active_record.raise_in_transactional_callbacks = true
   end
 end
 

data/test/dummy/config/database.yml

@@ -22,4 +22,7 @@ test:
 
 production:
   <<: *default
-  database: db/production.sqlite3
+  adapter: postgresql
+  database: polaris-view-helpers_production
+  username: polaris-view-helpers
+  password: <%= ENV['POLARIS-VIEW-HELPERS_DATABASE_PASSWORD'] %>

data/test/dummy/config/environments/production.rb

@@ -76,4 +76,10 @@ Rails.application.configure do
 
   # Do not dump schema after migrations.
   config.active_record.dump_schema_after_migration = false
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,6 @@
 Rails.application.routes.draw do
+  root 'home#index'
+
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".
 

data/test/dummy/db/migrate/20171004015121_create_widgets.rb

@@ -0,0 +1,9 @@
+class CreateWidgets < ActiveRecord::Migration[5.1]
+  def change
+    create_table :widgets do |t|
+      t.string :title
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,21 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20171004015121) do
+
+  create_table "widgets", force: :cascade do |t|
+    t.string "title"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end