headmin 0.2.3 → 0.2.7

data/docs/blocks-and-fields.md

@@ -0,0 +1,54 @@
+# Blocks + fields = Magic
+
+## Installation
+Run the following generators to generate the migration files.
+```
+rails generate headmin:blocks
+rails generate headmin:fields
+rails db:migrate
+```
+
+## Getting Started
+### Setup model
+
+Setup a block model by including `Headmin::Fieldable`
+
+```ruby
+class Block < ApplicationRecord
+  include Headmin::Block
+  include Headmin::Fieldable
+end
+```
+
+### Setup forms
+
+```erb
+# app/views/admin/blocks/_contact.html.erb
+<%= form.hidden_field :name, value: :contact %>
+
+<!-- Title -->
+<%= render 'headmin/forms/fields/text', form: form, name: :title do |field, attribute, label| %>
+  <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
+<% end %>
+
+<!-- People list -->
+<%= render 'headmin/forms/fields/list', form: form, name: :people do |item| %>
+  <%= render 'headmin/forms/fields/text', form: item, name: :name do |field, attribute, label| %>
+    <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
+  <% end %>
+<% end %>
+```
+
+### Usage in website
+
+```erb
+# app/views/website/blocks/_contact.html.erb
+<% fields = block.fields_hash %>
+
+<h1><%= fields["title"] %></h1>
+<ul>
+  <% fields["people"].each do |person| %>
+    <li><%= person["name"] %></h2></li>
+  <% end %>
+</ul>
+```

data/docs/blocks.md

@@ -30,15 +30,8 @@ A hidden template form will be rendered for all types defined in `allow:`
 ```
 
 For each type of block you want to include, create a template in `views/admin/blocks`.
-Make sure to include a hidden field to store the name of the block.
 
-```erb
-# app/views/admin/blocks/_contact.html.erb
-<%= form.hidden_field :name, value: :contact %>
-...
-```
-
-### Render blocks in frontend
+### Usage in frontend
 
 ```erb
 # app/views/website/pages/show.html.erb
@@ -53,49 +46,3 @@ For each block in the admin, you'll need to create a corresponding template in y
 # app/views/website/blocks/_contact.html.erb
 <%= block.name %>
 ```
-
-## Blocks + fields = Magic
-
-### Add fields to blocks
-
-Setup a block model by including `Headmin::Fieldable`
-
-```ruby
-class Block < ApplicationRecord
-  include Headmin::Block
-  include Headmin::Fieldable
-end
-```
-
-### Use fields in admin blocks
-
-```erb
-# app/views/admin/blocks/_contact.html.erb
-<%= form.hidden_field :name, value: :contact %>
-
-<!-- Title -->
-<%= render 'headmin/forms/fields/text', form: form, name: :title do |field, attribute, label| %>
-  <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-<% end %>
-
-<!-- People list -->
-<%= render 'headmin/forms/fields/list', form: form, name: :people do |item| %>
-  <%= render 'headmin/forms/fields/text', form: item, name: :name do |field, attribute, label| %>
-    <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-  <% end %>
-<% end %>
-```
-
-### Render blocks in your frontend
-
-```erb
-# app/views/website/blocks/_contact.html.erb
-<% fields = block.fields_hash %>
-
-<h1><%= fields["title"] %></h1>
-<ul>
-  <% fields["people"].each do |person| %>
-    <li><%= person["name"] %></h2></li>
-  <% end %>
-</ul>
-```

data/docs/devise.md

@@ -1,3 +1,41 @@
-# Authentication
+# Devise
+Headmin comes with some default views for all devise related pages. 
+To make use of them, follow the guidelines below.
 
-TODO: rewrite
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise'
+```
+
+Run the install generator
+```sh
+$ rails generate devise:install
+```
+
+Create a devise model
+```sh
+$ rails generate devise User
+$ rails db:migrate
+```
+
+Generate the default auth views
+```sh
+$ rails generate headmin:devise
+```
+
+## Getting Started
+
+### Change routes
+Change the default `devise_for` routes with the code below
+
+```ruby
+devise_for :users, controllers: {
+  sessions: 'auth/sessions',
+  registrations: 'auth/registrations',
+  passwords: 'auth/passwords',
+  unlocks: 'auth/unlocks',
+  confirmations: 'auth/confirmations'
+}
+```

data/docs/fields.md

@@ -1,10 +1,12 @@
-# Fields 
+# Fields
 
 ## Installation
+
 Run the following generators to generate the migration files.
-```
-rails generate headmin:fields
-rails db:migrate
+
+```sh
+$ rails generate headmin:fields
+$ rails db:migrate
 ```
 
 ## Getting Started
@@ -12,6 +14,7 @@ rails db:migrate
 ### Setup model
 
 ```ruby
+
 class Settings < ApplicationRecord
   include Headmin::Fieldable
 end
@@ -19,7 +22,7 @@ end
 
 ### Setup forms
 
-```erb
+```html
 # app/views/admin/settings/_form.html.erb
 
 <!-- Company name -->
@@ -36,22 +39,41 @@ end
 ```
 
 #### Type of fields
+
 - Text: `headmin/forms/fields/text`
 - File: `headmin/forms/fields/file`
 - Image: `headmin/forms/fields/image`
 - List: `headmin/forms/fields/list`
 - Group: `headmin/forms/fields/group`
 
-### Render fields in frontend 
+### Seed database
+
+Use the `fields_hash` setter method to set the data, the way you want to retrieve it.
 
-```erb
+```ruby
+# In db/seeds.rb
+Setting.create!(
+  name: 'Website settings',
+  fields_hash: {
+    company_name: 'Insiting BV',
+    people: [
+      { name: 'Jef Vlamings' },
+      { name: 'Gert-Jan Peeters' }
+    ]
+  }
+)
+```
+
+### Usage in frontend
+
+```html
 # app/views/website/settings/show.html.erb
 <% fields = @setting.fields_hash %>
 
 <h1><%= fields["company_name"] %></h1>
 <ul>
-  <% fields["people"].each do |person| %>
+    <% fields["people"].each do |person| %>
     <li><%= person["name"] %></h2></li>
-  <% end %>
+    <% end %>
 </ul>
 ```

data/headmin.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_runtime_dependency 'closure_tree', '~> 7.3'
+  spec.add_runtime_dependency 'closure_tree'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/generators/headmin/blocks_generator.rb

@@ -4,8 +4,11 @@ module Headmin
 
     source_root File.expand_path('../../templates', __FILE__)
 
-    def blocks
+    def copy_models
       template 'models/block.rb', 'app/models/block.rb'
+    end
+
+    def copy_migrations
       migration_template 'migrations/create_blocks.rb', 'db/migrate/create_blocks.rb'
     end
 

data/lib/generators/headmin/devise_generator.rb

@@ -0,0 +1,16 @@
+module Headmin
+  class DeviseGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def copy_controllers
+      directory 'controllers/auth', 'app/controllers/auth'
+    end
+
+    def copy_views
+      directory 'views/auth', 'app/views/auth'
+      copy_file 'views/layouts/auth.html.erb', 'app/views/layouts/auth.html.erb'
+    end
+  end
+end

data/lib/generators/headmin/fields_generator.rb

@@ -4,9 +4,13 @@ module Headmin
 
     source_root File.expand_path('../../templates', __FILE__)
 
-    def blocks
+    def copy_models
       template 'models/field.rb', 'app/models/field.rb'
+    end
+
+    def copy_migrations
       migration_template 'migrations/create_fields.rb', 'db/migrate/create_fields.rb'
+      migration_template 'migrations/create_field_hierarchies.rb', 'db/migrate/create_field_hierarchies.rb'
     end
 
     private

data/lib/generators/templates/controllers/auth/confirmations_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Auth::ConfirmationsController < Devise::ConfirmationsController
+  layout 'auth'
+  # GET /resource/confirmation/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/confirmation
+  # def create
+  #   super
+  # end
+
+  # GET /resource/confirmation?confirmation_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after resending confirmation instructions.
+  # def after_resending_confirmation_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+
+  # The path used after confirmation.
+  # def after_confirmation_path_for(resource_name, resource)
+  #   super(resource_name, resource)
+  # end
+end

data/lib/generators/templates/controllers/auth/omniauth_callbacks_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Auth::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  layout 'auth'
+  # You should configure your model like this:
+  # devise :omniauthable, omniauth_providers: [:twitter]
+
+  # You should also create an action method in this controller like this:
+  # def twitter
+  # end
+
+  # More info at:
+  # https://github.com/heartcombo/devise#omniauth
+
+  # GET|POST /resource/auth/twitter
+  # def passthru
+  #   super
+  # end
+
+  # GET|POST /users/auth/twitter/callback
+  # def failure
+  #   super
+  # end
+
+  # protected
+
+  # The path used when OmniAuth fails
+  # def after_omniauth_failure_path_for(scope)
+  #   super(scope)
+  # end
+end

data/lib/generators/templates/controllers/auth/passwords_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Auth::PasswordsController < Devise::PasswordsController
+  layout 'auth'
+  # GET /resource/password/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/password
+  # def create
+  #   super
+  # end
+
+  # GET /resource/password/edit?reset_password_token=abcdef
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource/password
+  # def update
+  #   super
+  # end
+
+  # protected
+
+  # def after_resetting_password_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sending reset password instructions
+  # def after_sending_reset_password_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+end

data/lib/generators/templates/controllers/auth/registrations_controller.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Auth::RegistrationsController < Devise::RegistrationsController
+  layout 'auth'
+  # before_action :configure_sign_up_params, only: [:create]
+  # before_action :configure_account_update_params, only: [:update]
+
+  # GET /resource/sign_up
+  # def new
+  #   super
+  # end
+
+  # POST /resource
+  # def create
+  #   super
+  # end
+
+  # GET /resource/edit
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource
+  # def update
+  #   super
+  # end
+
+  # DELETE /resource
+  # def destroy
+  #   super
+  # end
+
+  # GET /resource/cancel
+  # Forces the session data which is usually expired after sign
+  # in to be expired now. This is useful if the user wants to
+  # cancel oauth signing in/up in the middle of the process,
+  # removing all OAuth session data.
+  # def cancel
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_up_params
+  #   devise_parameter_sanitizer.permit(:sign_up, keys: [:attribute])
+  # end
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_account_update_params
+  #   devise_parameter_sanitizer.permit(:account_update, keys: [:attribute])
+  # end
+
+  # The path used after sign up.
+  # def after_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sign up for inactive accounts.
+  # def after_inactive_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+end

data/lib/generators/templates/controllers/auth/sessions_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Auth::SessionsController < Devise::SessionsController
+  layout 'auth'
+  # before_action :configure_sign_in_params, only: [:create]
+
+  # GET /resource/sign_in
+  # def new
+  #   super
+  # end
+
+  # POST /resource/sign_in
+  # def create
+  #   super
+  # end
+
+  # DELETE /resource/sign_out
+  # def destroy
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_in_params
+  #   devise_parameter_sanitizer.permit(:sign_in, keys: [:attribute])
+  # end
+end

data/lib/generators/templates/controllers/auth/unlocks_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Auth::UnlocksController < Devise::UnlocksController
+  layout 'auth'
+  # GET /resource/unlock/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/unlock
+  # def create
+  #   super
+  # end
+
+  # GET /resource/unlock?unlock_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after sending unlock password instructions
+  # def after_sending_unlock_instructions_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after unlocking the resource
+  # def after_unlock_path_for(resource)
+  #   super(resource)
+  # end
+end

data/lib/generators/templates/migrations/create_field_hierarchies.rb

@@ -0,0 +1,16 @@
+class CreateFieldHierarchies < ActiveRecord::Migration[6.1]
+  def change
+    create_table :field_hierarchies, id: false do |t|
+      t.integer :ancestor_id, null: false
+      t.integer :descendant_id, null: false
+      t.integer :generations, null: false
+    end
+
+    add_index :field_hierarchies, [:ancestor_id, :descendant_id, :generations],
+      unique: true,
+      name: "field_anc_desc_idx"
+
+    add_index :field_hierarchies, [:descendant_id],
+      name: "field_desc_idx"
+  end
+end

data/lib/generators/templates/views/auth/confirmations/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/confirmations/new" %>

data/lib/generators/templates/views/auth/mailer/confirmation_instructions.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/confirmation_instructions" %>

data/lib/generators/templates/views/auth/mailer/email_changed.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/email_changed" %>

data/lib/generators/templates/views/auth/mailer/password_change.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/password_change" %>

data/lib/generators/templates/views/auth/mailer/reset_password_instructions.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/reset_password_instructions" %>

data/lib/generators/templates/views/auth/mailer/unlock_instructions.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/unlock_instructions" %>

data/lib/generators/templates/views/auth/passwords/edit.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/passwords/edit" %>

data/lib/generators/templates/views/auth/passwords/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/passwords/new" %>

data/lib/generators/templates/views/auth/registrations/edit.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/registrations/edit" %>

data/lib/generators/templates/views/auth/registrations/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/registrations/new" %>

data/lib/generators/templates/views/auth/sessions/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/sessions/new" %>

data/lib/generators/templates/views/auth/unlocks/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/unlocks/new" %>

data/lib/generators/templates/views/layouts/auth.html.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Authentication</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_pack_tag 'admin', media: 'all', 'data-turbolinks-track': 'reload' %>
+  <%= javascript_pack_tag 'admin', 'data-turbolinks-track': 'reload' %>
+</head>
+<body class="bg-light w-100 vh-100">
+
+<%= render 'headmin/notifications' %>
+
+<main class="d-flex justify-content-center align-items-center w-100 vh-100 p-3">
+  <%= yield %>
+</main>
+
+</body>
+</html>

data/lib/headmin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Headmin
-  VERSION = "0.2.3"
+  VERSION = "0.2.7"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "headmin",
-  "version": "0.2.0",
+  "version": "0.2.6",
   "description": "Admin component library",
   "main": "src/js/headmin.js",
   "sass": "src/scss/headmin.scss",
@@ -20,13 +20,14 @@
   },
   "homepage": "https://github.com/insiting/headmin#readme",
   "dependencies": {
+    "@hotwired/stimulus": "^3.0",
+    "@hotwired/stimulus-webpack-helpers": "^1.0",
     "@popperjs/core": "^2.9.3",
     "@rails/ujs": "^6.0.0",
     "bootstrap": "^5.1.1",
     "ckeditor5-build-classic-simple-upload-adapter-image-resize": "^1.0.4",
     "flatpickr": "^4.6.9",
     "sortablejs": "^1.13.0",
-    "stimulus": "^2.0.0",
     "tom-select": "^2.0.0-rc.4"
   },
   "devDependencies": {
@@ -34,7 +35,7 @@
     "@babel/preset-env": "^7.12.11",
     "autoprefixer": "^10.2.3",
     "babel-loader": "^8.2.2",
-    "node-sass": "^5.0.0",
+    "node-sass": "^6.0.1",
     "node-sass-tilde-importer": "^1.0.2",
     "onchange": "^7.1.0",
     "path": "^0.12.7",

data/src/js/headmin/controllers/blocks_controller.js

@@ -1,4 +1,4 @@
-import {Controller} from "stimulus"
+import {Controller} from "@hotwired/stimulus"
 import Sortable from "sortablejs";
 import { createPopper } from '@popperjs/core';
 

data/src/js/headmin/controllers/filter_controller.js

@@ -1,4 +1,4 @@
-import {Controller} from "stimulus"
+import {Controller} from "@hotwired/stimulus"
 
 export default class extends Controller {
     static get targets() {

data/src/js/headmin/controllers/filters_controller.js

@@ -1,4 +1,4 @@
-import {Controller} from "stimulus"
+import {Controller} from "@hotwired/stimulus"
 
 export default class extends Controller {
     static get targets() {

data/src/js/headmin/controllers/popup_controller.js

@@ -1,4 +1,4 @@
-import {Controller} from "stimulus"
+import {Controller} from "@hotwired/stimulus"
 import Sortable from "sortablejs";
 import {createPopper} from '@popperjs/core';