administrate-bootstrap-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0396fa4e9ab92f78876de55aa3ccf3af5ebbe66a014a746dbed2f97554c2ffb
+  data.tar.gz: 05f582a06a3b2861dc395104c6b62e6e092031d7d185167fba1bf07a65f20ea7
+SHA512:
+  metadata.gz: 1b6fdd711e9935f557014cd8f82d53578d360c96efc76c076ad768e093ac6014247b26b669156cac266ee01dd06b2a0cc0377454b5a65fbb527feedb25bd06db
+  data.tar.gz: 108fe161bd0edf8113c4d62954af9c66c623cac765950f7121f0cbacf566ff7fc3e744aaf5c3c73de85fe6ae34b06da23c6411ad66f15971342f564210eea0e5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Mattia Roccoberton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Administrate Bootstrap Theme [![Gem Version](https://badge.fury.io/rb/administrate-bootstrap-theme.svg)](https://badge.fury.io/rb/administrate-bootstrap-theme)
+A Bootstrap 5 (_beta_) theme for [Administrate](https://github.com/thoughtbot/administrate).
+
+Features:
+- easy to install, just include CSS to apply the theme to a default Administrate structure;
+- customizable via SASS variables;
+- allow to use *Bootstrap* components in the admin.
+
+![screenshot](screenshot.png)
+
+## Installation
+- Add to the *Gemfile* (of an Administrate project): `gem 'administrate-bootstrap-theme'` (and execute `bundle`)
+- Modify *app/assets/config/manifest.js*, replacing the administrate assets with:
+
+```js
+//= link administrate-bootstrap-theme/theme.css
+
+// OFF link administrate/application.css
+// OFF link administrate/application.js
+```
+
+- Edit *app/views/layouts/admin/application.html.erb* (you can generate it using `rails generate administrate:views:layout`),
+  adding before head closing tag:
+
+```html
+<%= stylesheet_link_tag 'administrate-bootstrap-theme/theme', media: 'all' %>
+```
+
+## Customizations
+To change variables it's necessary to create a new *.scss* (or *.sass*) file like this one (ex. *admin.scss*):
+
+```scss
+// app/assets/stylesheets/admin.scss
+$navigation-width: 300px;
+@import 'administrate-bootstrap-theme/theme';
+```
+
+And replace the link tag in the *application.html.erb* with: `<%= stylesheet_link_tag 'admin', media: 'all' %>`
+
+For the complete list of options take a look [here](app/assets/stylesheets/administrate-bootstrap-theme/_variables.scss).
+
+## Do you like it? Star it!
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
+
+## Contributors
+- [Mattia Roccoberton](https://blocknot.es/): author
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/administrate-bootstrap-theme_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/administrate-bootstrap-theme .css

data/app/assets/stylesheets/administrate-bootstrap-theme/_base.scss

@@ -0,0 +1,21 @@
+@import "../../../node_modules/bootstrap/scss/bootstrap";
+
+@import "variables";
+
+@import "components/navigation";
+@import "components/content_header";
+@import "components/content_body";
+@import "components/pagination";
+
+.app-container {
+  display: flex;
+  flex-wrap: nowrap;
+  height: 100vh;
+}
+
+.main-content {
+  @extend .d-flex, .flex-column;
+
+  overflow-y: scroll;
+  width: calc(100% - #{$navigation-width});
+}

data/app/assets/stylesheets/administrate-bootstrap-theme/_variables.scss

@@ -0,0 +1,2 @@
+
+$navigation-width: 250px !default;

data/app/assets/stylesheets/administrate-bootstrap-theme/components/_content_body.scss

@@ -0,0 +1,54 @@
+.main-content__body {
+  @extend .container-fluid;
+
+  @import "form";
+
+  > dl {
+    @extend .row;
+
+    dt {
+      @extend .col-2, .text-end;
+    }
+
+    dd {
+      @extend .col-10;
+    }
+  }
+
+  a {
+    text-decoration: none;
+  }
+
+  table {
+    @extend .table;
+  }
+
+  .cell-label__sort-indicator > svg {
+    height: 20px;
+    width: 20px;
+  }
+
+  .cell-label__sort-indicator--desc > svg {
+    transform: rotate(180deg);
+  }
+
+  .js-table-row {
+    > td {
+      padding: 0.25rem 0.25rem;
+      text-align: center;
+
+      &.cell-data {
+        padding: 0.5rem 0.5rem;
+        text-align: left;
+      }
+    }
+
+    .action-edit {
+      @extend .btn, .btn-sm;
+    }
+
+    [data-method="delete"] {
+      @extend .btn, .btn-sm;
+    }
+  }
+}

data/app/assets/stylesheets/administrate-bootstrap-theme/components/_content_header.scss

@@ -0,0 +1,37 @@
+.main-content__header {
+  @extend .p-3, .mb-3, .border-bottom;
+  @extend .d-flex, .flex-wrap, .align-items-center, .justify-content-center, .justify-content-lg-start;
+
+  > div:last-child {
+    @extend .text-end;
+  }
+
+  > form {
+    @extend .d-flex, .col-12, .col-lg-auto, .mb-3, .mb-lg-0, .me-md-4;
+
+    input {
+      @extend .form-control, .form-control-sm;
+    }
+  }
+
+  > h1 {
+    @extend .nav, .col-12, .col-lg-auto, .me-lg-auto, .mb-2, .justify-content-center, .mb-md-0;
+
+    font-size: 1.6rem;
+  }
+
+  svg {
+    &.search__eyeglass-icon, &.search__clear-icon {
+      height: 20px;
+      width: 20px;
+    }
+  }
+
+  .button {
+    @extend .btn, .btn-sm;
+  }
+
+  .search__input {
+    @extend .mx-2;
+  }
+}

data/app/assets/stylesheets/administrate-bootstrap-theme/components/_form.scss

@@ -0,0 +1,25 @@
+// Imported in content_body
+
+.form-actions > input {
+  @extend .btn;
+}
+
+.field-unit {
+  @extend .row;
+}
+
+.field-unit__field {
+  @extend .col-10;
+
+  > input[type="text"], > textarea {
+    @extend .form-control;
+  }
+}
+
+.field-unit__label {
+  @extend .col-2;
+
+  > label {
+    @extend .col-form-label;
+  }
+}

data/app/assets/stylesheets/administrate-bootstrap-theme/components/_navigation.scss

@@ -0,0 +1,17 @@
+nav.navigation {
+  @extend .nav, .nav-pills, .flex-column, .p-3;
+
+  width: $navigation-width;
+
+  .button--alt {
+    @extend .btn, .btn-outline-light, .mb-2;
+  }
+
+  .navigation__link {
+    @extend .nav-link;
+  }
+
+  .navigation__link--active {
+    @extend .active;
+  }
+}

data/app/assets/stylesheets/administrate-bootstrap-theme/components/_pagination.scss

@@ -0,0 +1,7 @@
+nav.pagination {
+  @extend .justify-content-center, .mb-3;
+
+  > span {
+    @extend .nav-link;
+  }
+}

data/app/assets/stylesheets/administrate-bootstrap-theme/theme.scss

@@ -0,0 +1,43 @@
+@import "base";
+
+nav.navigation {
+  @extend .text-white, .bg-dark;
+
+  .button--alt {
+    @extend .btn-outline-light;
+  }
+
+  .navigation__link {
+    @extend .btn-outline-light;
+  }
+}
+
+nav.pagination {
+  @extend .border;
+}
+
+.main-content {
+  @extend .bg-light;
+}
+
+.main-content__body {
+  .form-actions > input {
+    @extend .btn-primary;
+  }
+
+  .js-table-row {
+    .action-edit {
+      @extend .btn-secondary;
+    }
+
+    [data-method="delete"] {
+      @extend .btn-danger;
+    }
+  }
+}
+
+.main-content__header {
+  .button {
+    @extend .btn-primary;
+  }
+}

data/lib/administrate-bootstrap-theme.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'administrate-bootstrap-theme/version'
+require 'administrate-bootstrap-theme/engine'

data/lib/administrate-bootstrap-theme/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AdministrateBootstrapTheme
+  class Engine < ::Rails::Engine
+    isolate_namespace AdministrateBootstrapTheme
+  end
+end

data/lib/administrate-bootstrap-theme/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AdministrateBootstrapTheme
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: administrate-bootstrap-theme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+description: A Bootstrap theme for Administrate
+email:
+- mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/administrate-bootstrap-theme_manifest.js
+- app/assets/stylesheets/administrate-bootstrap-theme/_base.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/_variables.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/components/_content_body.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/components/_content_header.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/components/_form.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/components/_navigation.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/components/_pagination.scss
+- app/assets/stylesheets/administrate-bootstrap-theme/theme.scss
+- lib/administrate-bootstrap-theme.rb
+- lib/administrate-bootstrap-theme/engine.rb
+- lib/administrate-bootstrap-theme/version.rb
+homepage: https://github.com/blocknotes/administrate-bootstrap-theme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blocknotes/administrate-bootstrap-theme
+  source_code_uri: https://github.com/blocknotes/administrate-bootstrap-theme
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Bootstrap Administrate Theme
+test_files: []