-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a Bootstrap layout to the CRUD add-on #485
Merged
malparty
merged 6 commits into
develop
from
feature/gh483-crud-addon-add-bootstrap-layout
Mar 7, 2024
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b000fd9
[#483] Add the first version of the CRUD addon with a simple bootstra…
malparty b44fefa
[#483] Add tests to the CRUD layout
malparty ae18248
[#483] Fix the check for slim and erb layout files
malparty 265ae25
Fix lint issues
malparty 179f653
Makes error condition more explicit
malparty 59e1551
Fix rubocop issue
malparty File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
@import './bootstrap'; | ||
@import 'bootstrap'; |
93 changes: 93 additions & 0 deletions
93
.template/addons/crud/app/assets/stylesheets/layouts/_application.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
body { | ||
display: flex; | ||
flex-direction: column; | ||
min-height: 100vh; | ||
} | ||
|
||
.app { | ||
display: flex; | ||
flex-direction: row; | ||
flex-grow: 1; | ||
|
||
&__container { | ||
display: flex; | ||
flex-direction: column; | ||
flex-grow: 1; | ||
justify-content: space-between; | ||
} | ||
|
||
&__main { | ||
padding: rem(16px); | ||
margin: rem(16px); | ||
} | ||
|
||
&__footer { | ||
grid-area: footer; | ||
padding: rem(8px); | ||
} | ||
|
||
&__nav-bar-top { | ||
grid-area: navBar; | ||
border-bottom: solid var(--bs-border-width) var(--bs-gray-400); | ||
} | ||
|
||
&__side-bar { | ||
grid-area: sideBar; | ||
display: flex; | ||
flex-flow: column; | ||
padding: rem(32px); | ||
background-color: var(--bs-light); | ||
width: rem(280px); | ||
height: 100%; | ||
|
||
.dropdown-toggle { | ||
outline: 0; | ||
} | ||
|
||
.btn-toggle { | ||
padding: 0.25rem 0.5rem; | ||
font-weight: 600; | ||
color: var(--bs-emphasis-color); | ||
background-color: transparent; | ||
|
||
&:hover, | ||
&:focus { | ||
color: rgba(var(--bs-emphasis-color-rgb), 0.85); | ||
background-color: var(--bs-tertiary-bg); | ||
} | ||
|
||
&::before { | ||
width: 1.25em; | ||
line-height: 0; | ||
content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%280,0,0,.5%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e"); | ||
transition: transform 0.35s ease; | ||
transform-origin: 0.5em 50%; | ||
} | ||
} | ||
|
||
[data-bs-theme="dark"] .btn-toggle::before { | ||
content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%28255,255,255,.5%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e"); | ||
} | ||
|
||
.btn-toggle[aria-expanded="true"] { | ||
color: rgba(var(--bs-emphasis-color-rgb), 0.85); | ||
} | ||
.btn-toggle[aria-expanded="true"]::before { | ||
transform: rotate(90deg); | ||
} | ||
|
||
.btn-toggle-nav a { | ||
padding: 0.1875rem 0.5rem; | ||
margin-top: 0.125rem; | ||
margin-left: 1.25rem; | ||
} | ||
.btn-toggle-nav a:hover, | ||
.btn-toggle-nav a:focus { | ||
background-color: var(--bs-tertiary-bg); | ||
} | ||
|
||
.scrollarea { | ||
overflow-y: auto; | ||
} | ||
} | ||
} |
1 change: 1 addition & 0 deletions
1
.template/addons/crud/app/assets/stylesheets/layouts/index.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
@import "application"; |
25 changes: 25 additions & 0 deletions
25
.template/addons/crud/app/views/layouts/application.html.slim.tt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
doctype html | ||
html lang=I18n.locale | ||
head | ||
meta charset="utf-8" | ||
meta name="viewport" content="width=device-width, initial-scale=1.0" | ||
title= content_for?(:title) ? yield(:title) : '<%= app_name %>' | ||
= csrf_meta_tags | ||
= csp_meta_tag | ||
= stylesheet_link_tag 'application', :media => 'all' | ||
= javascript_include_tag 'application' | ||
|
||
body class=class_names(controller_name.dasherize, action_name.dasherize) | ||
malparty marked this conversation as resolved.
Show resolved
Hide resolved
|
||
header | ||
= render('layouts/application/nav_bar_top') | ||
.app | ||
.side-bar | ||
= render('layouts/application/side_bar') | ||
.app__container | ||
main.app__main | ||
= yield | ||
footer.app__footer | ||
p.text-center.text-muted | ||
| © | ||
= ' <%= app_name %>' | ||
= Date.today.year |
33 changes: 33 additions & 0 deletions
33
.template/addons/crud/app/views/layouts/application/_nav_bar_top.html.slim
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.app__nav-bar-top | ||
nav.navbar.navbar-expand-lg.navbar-light.bg-light | ||
.container-fluid | ||
a.navbar-brand[href="#"] | ||
| NavbarTop | ||
malparty marked this conversation as resolved.
Show resolved
Hide resolved
|
||
button.navbar-toggler[type="button" data-bs-toggle="collapse" data-bs-target="#top_navbar_nav" aria-controls="top_navbar_nav" aria-expanded="false" aria-label="Toggle navigation"] | ||
span.navbar-toggler-icon | ||
#top_navbar_nav.collapse.navbar-collapse | ||
ul.navbar-nav.me-auto.mb-2.mb-lg-0 | ||
li.nav-item | ||
a.nav-link.active[aria-current="page" href="#"] | ||
| Home | ||
li.nav-item | ||
a.nav-link[href="#"] | ||
| Link | ||
li.nav-item | ||
a.nav-link.disabled[href="#" tabindex="-1" aria-disabled="true"] | ||
| Disabled | ||
li.nav-item.dropdown | ||
a#dropdown09.nav-link.dropdown-toggle[href="#" data-bs-toggle="dropdown" aria-expanded="false"] | ||
| Account | ||
ul.dropdown-menu[aria-labelledby="dropdown09"] | ||
li | ||
a.dropdown-item[href="#"] | ||
| Profile | ||
li | ||
a.dropdown-item[href="#"] | ||
| Settings | ||
li | ||
a.dropdown-item[href="#"] | ||
| Logout | ||
form | ||
input.form-control[type="text" placeholder="Search" aria-label="Search"] |
74 changes: 74 additions & 0 deletions
74
.template/addons/crud/app/views/layouts/application/_side_bar.html.slim
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
.app__side-bar | ||
a.d-flex.align-items-center.mb-3.mb-md-0.me-md-auto.link-dark.text-decoration-none[href="/"] | ||
svg.bi.pe-none.me-2[width="40" height="32"] | ||
use[xlink:href="#bootstrap"] | ||
span.fs-4 | ||
| Sidebar | ||
hr | ||
ul.list-unstyled.ps-0 | ||
li.mb-1 | ||
button.btn.btn-toggle.d-inline-flex.align-items-center.rounded.border-0.collapsed[data-bs-toggle="collapse" data-bs-target="#home-collapse" aria-expanded="false"] | ||
| Home | ||
#home-collapse.collapse[style=""] | ||
ul.btn-toggle-nav.list-unstyled.fw-normal.pb-1.small | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Overview | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Updates | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Reports | ||
li.mb-1 | ||
button.btn.btn-toggle.d-inline-flex.align-items-center.rounded.border-0.collapsed[data-bs-toggle="collapse" data-bs-target="#dashboard-collapse" aria-expanded="false"] | ||
| Dashboard | ||
#dashboard-collapse.collapse[style=""] | ||
ul.btn-toggle-nav.list-unstyled.fw-normal.pb-1.small | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Overview | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Weekly | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Monthly | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Annually | ||
li.mb-1 | ||
button.btn.btn-toggle.d-inline-flex.align-items-center.rounded.border-0.collapsed[data-bs-toggle="collapse" data-bs-target="#orders-collapse" aria-expanded="false"] | ||
| Orders | ||
#orders-collapse.collapse[style=""] | ||
ul.btn-toggle-nav.list-unstyled.fw-normal.pb-1.small | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| New | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Processed | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Shipped | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Returned | ||
li.border-top.my-3 | ||
li.mb-1 | ||
button.btn.btn-toggle.d-inline-flex.align-items-center.rounded.border-0.collapsed[data-bs-toggle="collapse" data-bs-target="#account-collapse" aria-expanded="false"] | ||
| Account | ||
#account-collapse.collapse | ||
ul.btn-toggle-nav.list-unstyled.fw-normal.pb-1.small | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| New... | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Profile | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Settings | ||
li | ||
a.link-body-emphasis.d-inline-flex.text-decoration-none.rounded[href="#"] | ||
| Sign out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# frozen_string_literal: true | ||
|
||
use_source_path __dir__ | ||
|
||
remove_file 'app/views/layouts/application.html.erb' | ||
directory 'app/views/layouts/application' | ||
template 'app/views/layouts/application.html.slim.tt' | ||
|
||
# SCSS Layout | ||
directory 'app/assets/stylesheets/layouts' | ||
insert_into_file 'app/assets/stylesheets/application.scss', after: %r{// Layouts\n} do | ||
<<~SCSS | ||
@import 'layouts'; | ||
SCSS | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
.template/spec/addons/variants/web/crud/application_layout_slim_spec.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# frozen_string_literal: true | ||
|
||
describe 'CRUD Addon - application layout' do | ||
it 'attaches the current locale to the html tag' do | ||
expect(file('app/views/layouts/application.html.slim')).to contain('html lang=I18n.locale') | ||
end | ||
|
||
it 'loads the stylesheet entry file in the layout' do | ||
expect(file('app/views/layouts/application.html.slim')).to contain("javascript_include_tag 'application'") | ||
end | ||
|
||
it 'loads the javascript entry file in the layout' do | ||
expect(file('app/views/layouts/application.html.slim')).to contain("stylesheet_link_tag 'application'") | ||
end | ||
end |
9 changes: 9 additions & 0 deletions
9
.template/spec/addons/variants/web/crud/application_scss_spec.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# frozen_string_literal: true | ||
|
||
describe 'CRUD Addon - application.scss' do | ||
subject { file('app/assets/stylesheets/application.scss') } | ||
|
||
it 'imports layouts stylesheets' do | ||
expect(subject).to contain("@import 'layouts';") | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# frozen_string_literal: true | ||
|
||
describe 'CRUD addon - template' do | ||
it 'creates app/assets/stylesheets/layouts/index.scss' do | ||
expect(file('app/assets/stylesheets/layouts/index.scss')).to exist | ||
end | ||
|
||
it 'removes app/views/layouts/application.html.erb' do | ||
expect(file('app/views/layouts/application.html.erb')).not_to exist | ||
end | ||
|
||
it 'creates javascript/vendor/index.js' do | ||
expect(file('app/javascript/vendor/index.js')).to exist | ||
end | ||
|
||
it 'creates app/views/layouts/application.html.slim' do | ||
expect(file('app/views/layouts/application.html.slim')).to exist | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
.template/variants/web/app/assets/stylesheets/application.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.template/variants/web/app/assets/stylesheets/functions/index.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
@import './sizing'; | ||
@import 'sizing'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file will be reviewed and improved in #491