headmin 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f3322a28300a8474d9e3eb6de7426ffc1e29ce1d335538acecc185b7a0a622
-  data.tar.gz: c8ed8550f75532b996fe507407abf724f0899e0db61d1881a2320ff97a0fa0fe
+  metadata.gz: 5b4489879289d2643f3045d91f28b3530f3c21e5a888246ceb36029106ea0692
+  data.tar.gz: 0e161c13ca9f3fd26f96401eefea905cd3858d0c3b3dfe86cd8ce4bda718d8f8
 SHA512:
-  metadata.gz: 252e757eb913f233271e7b41f474dada9913446af1ef48cc2b2d55d435e2d5b9dfab8199c18ebbb6a19cd260541ea1c1bc996bf1feecd9d8ee67a779ada5a1d3
-  data.tar.gz: 0d7c2ec678aea04c6317af5117d91ca622f08754a532d7baa93478925d509bf569783d828ea4b43053aca2d48c427bf6b13fd4e07701c32b8fa363a239efcf39
+  metadata.gz: 78d063e6e740edba6d1a849e1bacbff2a8750300848c20134b3e15bc5217b216e53a15be5d923de6671aecf768ce98c41cffa31bbd8939abd42e6a12ee877c7f
+  data.tar.gz: c515db4260d09f9a402d8b46d7d8b36acc10a3dbad433248a19716c5b3b59459ee965dfc8a862d8a35137b58aa4b8af734a6ef73a094b425a9f6ee81140a7261

data/Gemfile

@@ -8,5 +8,4 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
-
 gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -1,12 +1,30 @@
 PATH
   remote: .
   specs:
-    headmin (0.1.0)
+    headmin (0.2.1)
+      closure_tree (~> 7.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
+    closure_tree (7.4.0)
+      activerecord (>= 4.2.10)
+      with_advisory_lock (>= 4.0.0)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     parallel (1.20.1)
     parser (3.0.0.0)
@@ -27,11 +45,15 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    with_advisory_lock (4.6.0)
+      activerecord (>= 4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-19
-  x86_64-darwin-20
 
 DEPENDENCIES
   headmin!

data/README.md

@@ -1,7 +1,10 @@
 # Headmin
 A complete library of commonly used components to build an admin interface in your Ruby on Rails project.
 
-For information about different features: [click here](docs/README.md)
+## Interesting links
+- [Full documentation](docs/README.md)
+- [Rubygems](https://rubygems.org/gems/headmin)
+- [NPM](https://www.npmjs.com/package/headmin)
 
 ## Installation
 
@@ -47,38 +50,6 @@ Finally import Headmin in your stylesheet.
 ## Development
 For development purposes it's helpful to have both the test project and Headmin located in the same directory.
 
-There are 2 ways of working locally:
-1. **Configure package managers (preferred)**: setup bundler and yarn to look for local checkouts 
-2. **Use relative paths**: refer to Headmin by it's relative path
-
-### Solution #1: Configure package managers (preferred)
-This is the preferred way because you can develop locally, and deploy in a staging environment without changing configurations.
-
-Force bundler to use the local gem with:
-```shell
-bundle config local.headmin /usr/local/var/www/headmin
-```
-In your Gemfile you need to refer to the feature branch you're working on
-```ruby
-gem 'headmin', git: 'git@github.com:insiting/headmin.git', branch: 'feature/test'
-```
-
-Symlink the headmin node module like this.
-
-In your Headmin directory:
-```shell
-yarn link
-```
-
-In your project directory
-```shell
-yarn link headmin
-```
-
-### Solution #2: Use relative paths
-We don't prefer this solution because you have to switch sources regularly in Gemfile or package.json for each deployment.
-
-
 In Gemfile
 ```ruby
 gem "headmin", path: "../headmin"
@@ -88,7 +59,7 @@ In package.json
 ```json
 {
   "dependencies": {
-    "bar": "file:../headmin"
+    "bar": "link:../headmin"
   }
 }
 ```
@@ -128,16 +99,10 @@ $ gem tag -p
 $ gem release
 ```
 
-Use the generated version number for the node module as well
+Update the node module
 ```
-// In package.json
-
-{
-  "name": "headmin",
-  "version": "{new version number here}",
-  ...
-}
-
+# Manually update the version number in package.json
+$ npm publish
 ```
 
 ## Deployment

data/app/controllers/concerns/headmin/authentication.rb

@@ -3,15 +3,7 @@ module Headmin
     extend ActiveSupport::Concern
 
     included do
-      alias_method :devise_current_user, :current_user
       before_action :authenticate_admin!
-
-      def current_user
-        devise_current_user || current_admin
-      end
     end
-
-
-
   end
 end

data/app/controllers/concerns/headmin/pagination.rb

@@ -16,7 +16,7 @@ module Headmin
     end
 
     def per_page
-      length = (params[:per_page] || params[:length]).to_i
+      length = params[:per_page].to_i
       length > 0 ? length : 24
     end
   end

data/app/helpers/headmin/admin_helper.rb

@@ -13,14 +13,14 @@ module Headmin
       content_tag(:i, class: "bi bi-#{icon} #{klass}", data: data) {}
     end
 
-    def menu_item_active?(link)
-      uri = URI(link)
+    def current_url?(url)
+      uri = URI(url)
       path = uri.path
       query_string = uri.query
       matches_path = request.path.include?(path)
       matches_query = uri.query ? request.query_string.include?(query_string) : true
-      is_root = request.fullpath == link
-      if link == admin_root_path
+      is_root = request.fullpath == url
+      if url == admin_root_path
         is_root
       else
         matches_path && matches_query

data/app/models/concerns/headmin/block.rb

@@ -0,0 +1,11 @@
+module Headmin
+  module Block
+    extend ActiveSupport::Concern
+
+    included do
+
+      # Associations
+      belongs_to :blockable, polymorphic: true, optional: true, touch: true
+    end
+  end
+end

data/app/models/concerns/headmin/blockable.rb

@@ -0,0 +1,10 @@
+module Headmin
+  module Blockable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :blocks, as: :blockable
+      accepts_nested_attributes_for :blocks, allow_destroy: true
+    end
+  end
+end

data/app/models/concerns/headmin/field.rb

@@ -0,0 +1,17 @@
+module Headmin
+  module Field
+    extend ActiveSupport::Concern
+
+    included do
+      # Configuration
+      has_closure_tree
+
+      # Associations
+      belongs_to :fieldable, polymorphic: true, optional: true, touch: true
+      belongs_to :field, optional: true, touch: true
+      has_many :fields, foreign_key: "parent_id"
+      accepts_nested_attributes_for :fields, allow_destroy: true
+      has_one_attached :file
+    end
+  end
+end

data/app/models/concerns/headmin/fieldable.rb

@@ -0,0 +1,44 @@
+module Headmin
+  module Fieldable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :fields, as: :fieldable, dependent: :destroy
+      accepts_nested_attributes_for :fields, allow_destroy: true
+
+      def fields_hash
+        save_pair(fields.hash_tree)
+      end
+
+      private
+
+      def save_pair(my_hash, array = false)
+        if array
+          my_hash.map { |key, value|
+            save_pair(value)
+          }
+        else
+          Hash[my_hash.map { |key, value|
+            if value.empty?
+              case key.field_type
+              when 'group'
+                [key.name, save_pair(key.hash_tree[key])]
+              when 'list'
+                [key.name, save_pair(key.hash_tree[key], true)]
+              else
+                [key.name, return_field_output(key)]
+              end
+            else
+              key.field_type == 'list' ? [key.name, save_pair(value, true)] : [key.name, save_pair(value)]
+            end
+          }]
+        end
+      end
+
+      # returns what a field_type should return, e.g. its value, the file, the object ...
+      def return_field_output(key)
+        key.field_type == 'image' ? key.file : key.value
+      end
+    end
+  end
+end

data/app/services/block_service.rb

@@ -0,0 +1,68 @@
+class BlockService
+  def self.block_names(path:)
+    form_views(path: path).map do |view|
+      filename = File.basename(view, '.html.erb')
+
+      # Removes leading _ if exists
+      filename.sub!(/^_/, '')
+    end
+  end
+
+  def self.form_view(name, path:)
+    view_by_name(name, form_view_paths(path))
+  end
+
+  def self.frontend_view(name, path:)
+    view_by_name(name, frontend_view_paths(path))
+  end
+
+  def self.frontend_views(path:)
+    views(frontend_view_paths(path))
+  end
+
+  def self.form_views(path:)
+    views(form_view_paths(path))
+  end
+
+  private
+
+  # Looks for a block view by its name.
+  #
+  # It will first search in a specified path and will fallback to the default path
+  # An exception will be raised if the view is nowhere to be found
+  def self.view_by_name(name, paths)
+    views = views(paths)
+    view = views.find { |view| view.include?("/_#{name}.html.erb") }
+
+    unless view
+      prefixes = paths.map { |path| path.split('app/views/').last }
+      raise ActionView::MissingTemplate.new(paths, name, prefixes, true, "headmin") unless view
+    end
+
+    view
+  end
+
+  def self.form_view_paths(path)
+    [app_view_path(path), app_view_path('admin/blocks')].uniq
+  end
+
+  def self.frontend_view_paths(path)
+    [app_view_path(path), app_view_path('website/blocks')].uniq
+  end
+
+  def self.app_view_path(path)
+    base_path = 'app/views'
+    [base_path, path].join('/')
+  end
+
+  def self.views(paths)
+    paths.map { |path| views_in_path(path) }.flatten
+  end
+
+  def self.views_in_path(path)
+    files = Dir.glob("#{path}/*")
+    files.map do |file|
+      file.split('app/views/').last
+    end
+  end
+end

data/app/views/headmin/_blocks.html.erb

@@ -0,0 +1,24 @@
+<%
+  # headmin/blocks
+  #
+  # ==== Options
+  # * <tt>blockable</tt> - Object with blocks association
+  # * <tt>path</tt> - Directory where to look for block templates
+  #
+  # ==== Examples
+  #   Basic version. This will only look for blocks in 'website/blocks'
+  #   <%= render "headmin/blocks", blockable: @page %#>
+  #
+  #   Define the path to look for block templates like this:
+  #   <%= render "headmin/blocks", blockable: @page, path: 'website/pages/blocks' %#>
+
+  blockable = local_assigns.has_key?(:blockable) ? blockable : nil
+  path = local_assigns.has_key?(:path) ? path : nil
+%>
+
+<% if blockable && blockable.respond_to?(:blocks) %>
+  <% blockable.blocks.order(:position).each do |block| %>
+    <% view_path = BlockService.frontend_view(block.name, path: path).gsub('/_', '/') %>
+    <%= render view_path, block: block %>
+  <% end %>
+<% end %>

data/app/views/headmin/_breadcrumbs.html.erb

@@ -1,8 +1,12 @@
-<%#
-    name: headmin/heading/breadcrumbs
-    accepts block: no
-    parameters:
-      breadcrumbs: Breadcrumbs collection
+<%
+  # headmin/breadcrumbs
+  #
+  # ==== Options
+  # * <tt>breadcrumbs</tt> - Object with blocks association
+  #
+  # ==== Examples
+  #   Basic version. This will use the publicly available `breadcrumbs` variable
+  #   <%= render "headmin/breadcrumbs" %#>
 %>
 
 <nav aria-label="breadcrumb">

data/app/views/headmin/_card.html.erb

@@ -0,0 +1,48 @@
+<%
+  # headmin/card
+  #
+  # ==== Options
+  # * <tt>title</tt> - Title for card
+  # * <tt>description</tt> - Description for card
+  # * <tt>padded</tt> - Set to true if you want to render the block content inside the card-body element
+  #
+  # ==== Examples
+  #   Basic version.
+  #   <%= render 'headmin/card' do %#>
+  #      Your content
+  #   <% end %#>
+  #
+  #   Title and description
+  #   <%= render 'headmin/card', title: 'Title', description: 'Description' do %#>
+  #      Your content
+  #   <% end %#>
+
+  title = local_assigns.has_key?(:title) ? title : nil
+  description = local_assigns.has_key?(:description) ? description : nil
+  padded = local_assigns.has_key?(:padded) ? padded : true
+%>
+
+<div class="card mb-3 shadow-sm">
+
+  <% if padded || title || description %>
+    <div class="card-body">
+      <% if title.present? %>
+        <h5 class="card-title"><%= title %></h5>
+      <% end %>
+
+      <% if description.present? %>
+        <p class="card-text text-secondary"><%= description %></p>
+      <% end %>
+
+      <!-- Render inside body-->
+      <% if padded %>
+        <%= yield if block_given? %>
+      <% end %>
+    </div>
+  <% end %>
+
+  <!-- Render outside body-->
+  <% unless padded %>
+    <%= yield if block_given? %>
+  <% end %>
+</div>

data/app/views/headmin/_dropdown.html.erb

@@ -0,0 +1,18 @@
+<%
+  # headmin/dropdown
+  #
+  # ==== Options
+  # * <tt>class</tt> - Custom class names to put on the dropdown
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/dropdown" do %#>
+  #     Your content
+  #   <% end %#>
+
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : 'btn-group'
+%>
+
+<div class="dropdown <%= class_names %>">
+  <%= yield %>
+</div>

data/app/views/headmin/_filters.html.erb

@@ -1,47 +1,69 @@
-<%#
-    name: headmin/filters
-    accepts block: yes
-    parameters:
-      url: base url to send filter query to
+<%
+  # headmin/filters
+  #
+  # ==== Options
+  # * <tt>url</tt> - Base url to send filter query to. Defaults to current URL
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/filters" %#>
+  #
+  #   With custom URL
+  #   <%= render "headmin/filters", url: admin_polls_path %#>
+
+  action = local_assigns.has_key?(:url) ? url : request.url
 %>
-<% action = local_assigns.has_key?(:url) ? url : request.url %>
 
-<form class="h-filters d-flex align-items-center mb-2" action="<%= action %>" data-controller="filters" data-filters-target="form">
-  <%= yield if block_given? %>
+<form action="<%= action %>" data-controller="filters" data-filters-target="form">
 
   <!-- Default parameters (e.g. sorting, pagination) -->
-  <% default_params.each do |name, value| %>
+  <% default_params.except('page').each do |name, value| %>
     <%= hidden_field_tag(name.to_sym, value) %>
   <% end %>
 
-  <!-- Filter buttons -->
-  <div class="h-filter-list d-flex" data-filters-target="list">
-    <%= content_for :filters_buttons %>
-  </div>
+  <%= yield if block_given? %>
 
-  <!-- Filter templates -->
-  <%= content_for :filters_templates %>
+  <div class="d-flex flex-column flex-md-row align-content-start align-items-md-center">
+    <div class="d-flex align-items-center">
+
+      <!-- Search -->
+      <div class="h-filters-search d-flex my-1 w-100">
+        <%= content_for :filters_search %>
 
-  <!-- Menu -->
-  <% if content_for :filters_menu %>
-    <div class="btn-group">
-      <button type="button" class="btn btn-link dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
-        <%= bootstrap_icon('funnel-fill') %>
-        <%= t('.button') %>
-      </button>
-      <ul class="dropdown-menu">
-        <%= content_for :filters_menu %>
-        <li><hr class="dropdown-divider"></li>
-        <li><a class="dropdown-item text-danger" href="#" data-action="click->filters#removeAll"><%= t('.remove_all') %></a></li>
-      </ul>
+        <!-- Separator -->
+        <% if content_for(:filters_menu) && content_for(:filters_search) %>
+          <div class="vr mx-2"></div>
+        <% end %>
+      </div>
+
+      <!-- Menu -->
+      <div class="h-filters-menu d-flex align-items-center w-auto my-1">
+        <% if content_for :filters_menu %>
+          <div class="btn-group">
+            <button type="button" class="btn h-btn-outline-light dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
+              <%= bootstrap_icon('funnel') %>
+              <%= t('.button') %>
+            </button>
+            <ul class="dropdown-menu">
+              <%= content_for :filters_menu %>
+              <li>
+                <hr class="dropdown-divider">
+              </li>
+              <li>
+                <a class="dropdown-item text-danger" href="#" data-action="click->filters#removeAll"><%= t('.remove_all') %></a>
+              </li>
+            </ul>
+          </div>
+        <% end %>
+      </div>
     </div>
-  <% end %>
 
-  <!-- Separator -->
-  <% if content_for(:filters_menu) && content_for(:filters_search) %>
-    <span class="separator"></span>
-  <% end %>
+    <!-- Filter list -->
+    <div class="h-filter-list d-flex ms-md-1 flex-wrap" data-filters-target="list">
+      <%= content_for :filters_buttons %>
+    </div>
+  </div>
 
-  <!-- Search -->
-  <%= content_for :filters_search %>
+  <!-- Filter templates -->
+  <%= content_for :filters_templates %>
 </form>

data/app/views/headmin/_form.html.erb

@@ -1,11 +1,65 @@
-<%#
-    name: headmin/form
-    accepts block: yes (required)
-    parameters: model
+<%
+  # headmin/form
+  #
+  # ==== Options
+  # * <tt>model<tt> - A model to infer :url and :scope
+  # * <tt>scope<tt> - The scope to prefix input field names with
+  # * <tt>url<tt> - The URL the form submits to
+  # * <tt>format<tt> - The format of the route the form submits to
+  # * <tt>namespace<tt> - A namespace for your form to ensure uniqueness of id attributes on form elements
+  # * <tt>method<tt> - The method to use when submitting the form
+  # * <tt>authenticity_token<tt> - Authenticity token to use in the form
+  # * <tt>local<tt> - By default form submits are remote and unobtrusive XHRs
+  # * <tt>skip_enforcing_utf8<tt> - If set to true, a hidden input with name utf8 is not output
+  # * <tt>builder<tt> - Override the object used to build the form
+  # * <tt>html<tt> - Other optional HTML attributes for the form tag
+  # * <tt>id<tt> - Optional HTML id attribute
+  # * <tt>class<tt> - Optional HTML class attribute
+  # * <tt>data<tt> - Optional HTML data attributes
+  #
+  # === Examples
+  #   Basic version
+  #   <%= render 'headmin/form', model: @product do |form| %#>
+  #     Form content
+  #   <% end %#>
+  #
+  #   Specify URL to post to
+  #   <%= render 'headmin/form', model: @product, url: admin_products_path do |form| %#>
+  #     Form content
+  #   <% end %#>
+
+  model = local_assigns.has_key?(:model) ? local_assigns[:model] : nil
+  scope = local_assigns.has_key?(:scope) ? local_assigns[:scope] : nil
+  url = local_assigns.has_key?(:url) ? local_assigns[:url] : nil
+  format = local_assigns.has_key?(:format) ? local_assigns[:format] : nil
+
+  namespace = local_assigns.has_key?(:namespace) ? namespace : nil
+  method = local_assigns.has_key?(:method) ? method : nil
+  authenticity_token = local_assigns.has_key?(:authenticity_token) ? authenticity_token : nil
+  local = local_assigns.has_key?(:local) ? local : true
+  skip_enforcing_utf8 = local_assigns.has_key?(:skip_enforcing_utf8) ? skip_enforcing_utf8 : nil
+  builder = local_assigns.has_key?(:builder) ? builder : nil
+  html = local_assigns.has_key?(:html) ? html : {}
+  id = local_assigns.has_key?(:id) ? id : nil
+  option_class = local_assigns.has_key?(:class) ? local_assigns[:class] : nil
+  data = local_assigns.has_key?(:data) ? data : nil
+
+  options = {
+    namespace: namespace,
+    method: method,
+    authenticity_token: authenticity_token,
+    local: local,
+    skip_enforcing_utf8: skip_enforcing_utf8,
+    builder: builder,
+    html: html,
+    id: id,
+    class: option_class,
+    data: data
+  }
 %>
 
-<div class="headmin-form container">
-  <%= form_with model: model do |form| %>
+<div class="container">
+  <%= form_with model: model, scope: scope, url: url, format: format, **options do |form| %>
     <%= yield(form) %>
   <% end %>
 </div>

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

@@ -1,7 +1,11 @@
-<%#
-    name: headmin/heading
-    accepts block: yes
-    parameters: none
+<%
+  # headmin/heading
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/heading" do %#>
+  #     Your content
+  #   <% end %#>
 %>
 
 <div class="h-heading d-flex flex-column flex-md-row align-items-start align-items-md-end justify-content-between">