polaris_view_components 0.10.1 → 0.12.0

data/app/components/polaris/resource_item/shortcut_actions_component.rb

@@ -0,0 +1,88 @@
+class Polaris::ResourceItem::ShortcutActionsComponent < Polaris::Component
+  renders_many :buttons, ->(**system_arguments) do
+    ShortcutActionsButtonComponent.new(
+      persist_actions: @persist_actions,
+      **system_arguments
+    )
+  end
+
+  def initialize(
+    persist_actions: false,
+    wrapper_arguments: {},
+    disclosure_arguments: {},
+    popover_arguments: {},
+    **system_arguments
+  )
+    @persist_actions = persist_actions
+    @wrapper_arguments = wrapper_arguments
+    @disclosure_arguments = disclosure_arguments
+    @popover_arguments = popover_arguments
+    @system_arguments = system_arguments
+  end
+
+  def wrapper_arguments
+    @wrapper_arguments.tap do |opts|
+      opts[:tag] = "div"
+      opts[:classes] = class_names(
+        @wrapper_arguments[:classes],
+        "Polaris-ResourceItem__Actions"
+      )
+    end
+  end
+
+  def disclosure_arguments
+    @disclosure_arguments.tap do |opts|
+      opts[:tag] = "div"
+      opts[:classes] = class_names(
+        @disclosure_arguments[:classes],
+        "Polaris-ResourceItem__Disclosure"
+      )
+    end
+  end
+
+  def popover_arguments
+    {
+      alignment: :right,
+      position: :below,
+      append_to_body: true
+    }.deep_merge(@popover_arguments)
+  end
+
+  def system_arguments
+    @system_arguments.tap do |opts|
+      opts[:segmented] = !@persist_actions
+    end
+  end
+
+  class ShortcutActionsButtonComponent < Polaris::Component
+    attr_reader :content
+
+    def initialize(
+      url:,
+      content:,
+      persist_actions:,
+      action_list_item_arguments: {},
+      **system_arguments
+    )
+      @url = url
+      @content = content
+      @persist_actions = persist_actions
+      @action_list_item_arguments = action_list_item_arguments
+      @system_arguments = system_arguments
+    end
+
+    def system_arguments
+      @system_arguments.tap do |opts|
+        opts[:url] = @url
+        opts[:size] = :slim unless @persist_actions
+        opts[:plain] = true if @persist_actions
+      end
+    end
+
+    def action_list_item_arguments
+      @action_list_item_arguments.tap do |opts|
+        opts[:url] = @url
+      end
+    end
+  end
+end

data/app/components/polaris/resource_item_component.html.erb

@@ -31,6 +31,9 @@
         <div class="Polaris-ResourceItem__Content">
           <%= content %>
         </div>
+        <% if shortcut_actions.present? %>
+          <%= shortcut_actions %>
+        <% end %>
       <% end %>
     <% end %>
   </div>

data/app/components/polaris/resource_item_component.rb

@@ -26,12 +26,20 @@ module Polaris
     end
     renders_one :media
 
+    renders_one :shortcut_actions, ->(**system_arguments) do
+      Polaris::ResourceItem::ShortcutActionsComponent.new(
+        persist_actions: @persist_actions,
+        **system_arguments
+      )
+    end
+
     def initialize(
       url: nil,
       vertical_alignment: ALIGNMENT_DEFAULT,
       cursor: CURSOR_DEFAULT,
       selectable: false,
       selected: false,
+      persist_actions: false,
       offset: false,
       wrapper_arguments: {},
       container_arguments: {},
@@ -42,6 +50,7 @@ module Polaris
       @cursor = fetch_or_fallback(CURSOR_OPTIONS, cursor, CURSOR_DEFAULT)
       @selectable = selectable
       @selected = selected
+      @persist_actions = persist_actions
       @offset = offset
       @wrapper_arguments = wrapper_arguments
       @container_arguments = container_arguments
@@ -82,7 +91,8 @@ module Polaris
           args[:classes],
           "Polaris-ResourceItem",
           "Polaris-ResourceItem--selectable": @selectable,
-          "Polaris-ResourceItem--selected": @selected
+          "Polaris-ResourceItem--selected": @selected,
+          "Polaris-ResourceItem--persistActions": @persist_actions
         )
         prepend_option(args, :style, "cursor: #{@cursor};")
         prepend_option(args[:data], :action, "click->polaris-resource-item#open")

data/app/components/polaris/resource_list_component.html.erb

@@ -4,6 +4,17 @@
       <%= filters %>
     </div>
   <% end %>
+
+  <% if header_title.present? %>
+    <div class="Polaris-ResourceList__HeaderOuterWrapper">
+      <div class="Polaris-ResourceList__HeaderWrapper">
+        <div class="Polaris-ResourceList__HeaderContentWrapper">
+          <div class="Polaris-ResourceList__HeaderTitleWrapper"><%= header_title %></div>
+        </div>
+      </div>
+    </div>
+  <% end %>
+
   <%= render(Polaris::BaseComponent.new(**@system_arguments)) do %>
     <%= content %>
   <% end %>

data/app/components/polaris/resource_list_component.rb

@@ -5,9 +5,16 @@ module Polaris
     renders_one :filters, Polaris::FiltersComponent
 
     def initialize(
+      items: [],
+      resource_name: nil,
+      total_items_count: nil,
       wrapper_arguments: {},
       **system_arguments
     )
+      @items = items
+      @resource_name = resource_name
+      @total_items_count = total_items_count
+
       @wrapper_arguments = wrapper_arguments
       @wrapper_arguments[:tag] = "div"
       @wrapper_arguments[:classes] = class_names(
@@ -22,5 +29,19 @@ module Polaris
         "Polaris-ResourceList"
       )
     end
+
+    def header_title
+      count unless @total_items_count.nil?
+    end
+
+    def resource_string
+      return @resource_name[:singular] if @items.size === 1 && !@total_items_count
+
+      @resource_name[:plural]
+    end
+
+    def count
+      "Showing #{@items.size} of #{@total_items_count} #{resource_string}"
+    end
   end
 end

data/app/components/polaris/skeleton_page_component.html.erb

@@ -0,0 +1,23 @@
+<%= render Polaris::BaseComponent.new(**system_arguments) do %>
+  <div class="Polaris-SkeletonPage__Header">
+    <div class="Polaris-SkeletonPage__TitleAndPrimaryAction">
+      <div class="Polaris-SkeletonPage__TitleWrapper">
+        <% if @title.present? %>
+          <h1 class="Polaris-SkeletonPage__Title">
+            <%= @title %>
+          </h1>
+        <% else %>
+          <div class="Polaris-SkeletonPage__SkeletonTitle"></div>
+        <% end %>
+      </div>
+      <% if @primary_action %>
+        <div class="Polaris-SkeletonPage__PrimaryAction">
+          <%= polaris_skeleton_display_text(size: :large) %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+  <div class="Polaris-SkeletonPage__Content">
+    <%= content %>
+  </div>
+<% end %>

data/app/components/polaris/skeleton_page_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Polaris
+  class SkeletonPageComponent < Polaris::Component
+    def initialize(title: nil, primary_action: false, **system_arguments)
+      @title = title
+      @primary_action = primary_action
+      @system_arguments = system_arguments
+    end
+
+    def system_arguments
+      @system_arguments.tap do |opts|
+        opts[:tag] = "div"
+        opts[:role] = "status"
+        opts[:classes] = class_names(
+          @system_arguments[:classes],
+          "Polaris-SkeletonPage__Page"
+        )
+      end
+    end
+  end
+end

data/app/helpers/polaris/url_helper.rb

@@ -15,5 +15,42 @@ module Polaris
         content
       end
     end
+
+    def polaris_link_to(name = nil, options = nil, html_options = nil, &block)
+      html_options, options, name = options, name, block if block
+      options ||= {}
+
+      html_options = convert_options_to_data_attributes(options, html_options)
+      html_options[:classes] = html_options[:class]
+      html_options.delete(:class)
+
+      url = url_target(name, options)
+
+      link = Polaris::LinkComponent.new(url: url, **html_options)
+      link = link.with_content(name) unless block
+
+      render(link, &block)
+    end
+
+    def polaris_mail_to(email_address, name = nil, html_options = {}, &block)
+      html_options, name = name, nil if name.is_a?(Hash)
+      html_options = (html_options || {}).stringify_keys
+      html_options[:classes] = html_options[:class]
+      html_options.delete(:class)
+
+      extras = %w[cc bcc body subject reply_to].map! { |item|
+        option = html_options.delete(item).presence || next
+        "#{item.dasherize}=#{ERB::Util.url_encode(option)}"
+      }.compact
+      extras = extras.empty? ? "" : "?" + extras.join("&")
+
+      encoded_email_address = ERB::Util.url_encode(email_address).gsub("%40", "@")
+      url = "mailto:#{encoded_email_address}#{extras}"
+
+      link = Polaris::LinkComponent.new(url: url, **html_options)
+      link = link.with_content(name || email_address) unless block
+
+      render(link, &block)
+    end
   end
 end

data/app/helpers/polaris/view_helper.rb

@@ -24,6 +24,7 @@ module Polaris
       description_list:         "Polaris::DescriptionListComponent",
       display_text:             "Polaris::DisplayTextComponent",
       dropzone:                 "Polaris::DropzoneComponent",
+      empty_search_results:     "Polaris::EmptySearchResultsComponent",
       empty_state:              "Polaris::EmptyStateComponent",
       exception_list:           "Polaris::ExceptionListComponent",
       footer_help:              "Polaris::FooterHelpComponent",
@@ -59,6 +60,7 @@ module Polaris
       spinner:                  "Polaris::SpinnerComponent",
       skeleton_body_text:       "Polaris::SkeletonBodyTextComponent",
       skeleton_display_text:    "Polaris::SkeletonDisplayTextComponent",
+      skeleton_page:            "Polaris::SkeletonPageComponent",
       skeleton_thumbnail:       "Polaris::SkeletonThumbnailComponent",
       spacer:                   "Polaris::SpacerComponent",
       tabs:                     "Polaris::TabsComponent",

data/lib/install/install.rb

@@ -0,0 +1,57 @@
+APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
+IMPORTMAP_BINSTUB = Rails.root.join("bin/importmap")
+IMPORTMAP_CONFIG_PATH = Rails.root.join("config/importmap.rb")
+STIMULUS_PATH = Rails.root.join("app/javascript/controllers/index.js")
+
+if APPLICATION_LAYOUT_PATH.exist?
+  say "Add Polaris styles in application layout"
+  insert_into_file APPLICATION_LAYOUT_PATH.to_s, "\n    <%= stylesheet_link_tag \"polaris_view_components\" %>", before: /\s*<\/head>/
+
+  if File.read(APPLICATION_LAYOUT_PATH).include?("<body>")
+    say "Add Polaris inline styles for <body> in application layout"
+    gsub_file APPLICATION_LAYOUT_PATH.to_s, "<body>", "<body style=\"<%= polaris_body_styles %>\">"
+  else
+    say "<body> tag is not found in application layout.", :red
+    say "        Replace <body> with <body style=\"<%= polaris_body_styles %>\"> in your custom layour."
+  end
+else
+  say "Default application.html.erb is missing!", :red
+  say "        1. Add <%= stylesheet_link_tag \"polaris_view_components\" %> within the <head> tag in your custom layout."
+  say "        2. Replace <body> with <body style=\"<%= polaris_body_styles %>\"> in your custom layour."
+end
+
+if IMPORTMAP_BINSTUB.exist?
+  importmaps = File.read(IMPORTMAP_CONFIG_PATH)
+
+  unless importmaps.include?("@rails/request.js")
+    say "Pin @rails/request.js dependency"
+    run "bin/importmap pin @rails/request.js --download"
+  end
+
+  say "Pin polaris_view_components"
+  append_to_file IMPORTMAP_CONFIG_PATH do
+    'pin "polaris-view-components", to: "polaris_view_components.js"\n'
+  end
+else
+  package_json = File.read(Rails.root.join("package.json"))
+
+  unless package_json.include?("@rails/request.js")
+    say "Add @rails/request.js dependency"
+    run "yarn add @rails/request.js"
+  end
+
+  say "Add polaris-view-components package"
+  run "yarn add polaris-view-components"
+end
+
+if STIMULUS_PATH.exist?
+  say "Add Polaris Stimulus controllers"
+  append_to_file STIMULUS_PATH do
+    "\nimport { registerPolarisControllers } from \"polaris-view-components\"\nregisterPolarisControllers(Stimulus)\n"
+  end
+else
+  say "Default Stimulus location is missing: app/javascript/controllers/index.js", :red
+  say "        Add to your Stimulus index.js:"
+  say "            import { registerPolarisControllers } from \"polaris-view-components\""
+  say "            registerPolarisControllers(Stimulus)"
+end

data/lib/polaris/view_components/version.rb

@@ -1,5 +1,5 @@
 module Polaris
   module ViewComponents
-    VERSION = "0.10.1"
+    VERSION = "0.12.0"
   end
 end

data/lib/tasks/polaris_view_components_tasks.rake

@@ -0,0 +1,6 @@
+namespace :polaris_view_components do
+  desc "Setup Polaris::ViewComponents for the app"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install.rb", __dir__)}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polaris_view_components
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Dan Gamble
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -615,6 +615,8 @@ files:
 - app/components/polaris/display_text_component.rb
 - app/components/polaris/dropzone_component.html.erb
 - app/components/polaris/dropzone_component.rb
+- app/components/polaris/empty_search_results_component.html.erb
+- app/components/polaris/empty_search_results_component.rb
 - app/components/polaris/empty_state_component.html.erb
 - app/components/polaris/empty_state_component.rb
 - app/components/polaris/exception_list/item_component.html.erb
@@ -693,6 +695,8 @@ files:
 - app/components/polaris/progress_bar_component.rb
 - app/components/polaris/radio_button_component.html.erb
 - app/components/polaris/radio_button_component.rb
+- app/components/polaris/resource_item/shortcut_actions_component.html.erb
+- app/components/polaris/resource_item/shortcut_actions_component.rb
 - app/components/polaris/resource_item_component.html.erb
 - app/components/polaris/resource_item_component.rb
 - app/components/polaris/resource_list_component.html.erb
@@ -708,6 +712,8 @@ files:
 - app/components/polaris/skeleton_body_text_component.html.erb
 - app/components/polaris/skeleton_body_text_component.rb
 - app/components/polaris/skeleton_display_text_component.rb
+- app/components/polaris/skeleton_page_component.html.erb
+- app/components/polaris/skeleton_page_component.rb
 - app/components/polaris/skeleton_thumbnail_component.rb
 - app/components/polaris/spacer_component.rb
 - app/components/polaris/spinner_component.html.erb
@@ -741,14 +747,12 @@ files:
 - app/helpers/polaris/view_helper.rb
 - app/validators/type_validator.rb
 - config/locales/en.yml
-- lib/generators/polaris_view_components/USAGE
-- lib/generators/polaris_view_components/install_generator.rb
-- lib/generators/polaris_view_components/templates/README
-- lib/generators/polaris_view_components/templates/stimulus_index.js
+- lib/install/install.rb
 - lib/polaris/view_components.rb
 - lib/polaris/view_components/engine.rb
 - lib/polaris/view_components/version.rb
 - lib/polaris_view_components.rb
+- lib/tasks/polaris_view_components_tasks.rake
 homepage: https://github.com/baoagency/polaris-view-components
 licenses:
 - MIT

data/lib/generators/polaris_view_components/USAGE

@@ -1,5 +0,0 @@
-Description:
-    Creates or adds import of NPM package to your application + additional installation steps.
-
-Example:
-    rails generate polaris_view_components:install

data/lib/generators/polaris_view_components/install_generator.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/active_record"
-
-module PolarisViewComponents
-  class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path("templates", __dir__)
-
-    def add_npm_package
-      say "Adding NPM package", :green
-      run "yarn add polaris-view-components"
-    end
-
-    def add_to_stimulus_controller
-      say "Adding import to to Stimulus controller", :green
-      dir_path = "app/javascript/controllers"
-      empty_directory("app/javascript")
-      empty_directory(dir_path)
-
-      file_path = "#{dir_path}/index.js"
-
-      unless File.exist?(file_path)
-        copy_file "stimulus_index.js", file_path
-      end
-
-      append_to_file file_path do
-        "import { registerPolarisControllers } from \"polaris-view-components\"\nregisterPolarisControllers(Stimulus)"
-      end
-    end
-
-    def show_readme
-      readme "README"
-    end
-  end
-end

data/lib/generators/polaris_view_components/templates/README

@@ -1,14 +0,0 @@
-===============================================================================
-
-Some manual setup is still required:
-
-  1. Setup Polaris styles in your layouts <head> tag:
-
-       <link rel="stylesheet" href="https://unpkg.com/@shopify/polaris@6.6.0/dist/styles.css" />
-       <%= stylesheet_link_tag 'polaris_view_components' %>
-
-  2. Define Polaris style on your <body> tag:
-
-       <body style="<%= polaris_body_styles %>">
-
-===============================================================================

data/lib/generators/polaris_view_components/templates/stimulus_index.js

@@ -1,6 +0,0 @@
-import { Application } from "@hotwired/stimulus"
-import { definitionsFromContext } from "@hotwired/stimulus-webpack-helpers"
-
-window.Stimulus = Application.start()
-const context = require.context("./", true, /\.js$/)
-Stimulus.load(definitionsFromContext(context))