feat: first version

Author: Mattia Roccoberton

.gitignore

@@ -0,0 +1,16 @@
+/.rspec_failures
+/.rubocop-*
+/*.gem
+
+/Gemfile.lock
+
+/_misc/
+/coverage/
+/log/
+/tmp/
+
+/extra/*/log
+/extra/*/tmp
+/spec/dummy/log
+/spec/dummy/tmp
+/spec/dummy/db/*.sqlite3

.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,37 @@
+---
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+require:
+  - rubocop-packaging
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - bin/*
+    - spec/dummy/**/*
+    - vendor/**/*
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+
+Lint/MissingSuper:
+  Exclude:
+    - lib/tiny_admin/views/**/*
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/Rails/InferredSpecType:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/GuardClause:
+  Exclude:
+    - lib/tiny_admin/router.rb

CHANGELOG.md

@@ -0,0 +1 @@
+# TinyAdmin

Gemfile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+group :development, :test do
+  gem 'rails', '~> 7.0'
+
+  gem 'sqlite3'
+  gem 'tilt'
+  gem 'warden'
+  gem 'webrick'
+
+  # Testing
+  gem 'capybara'
+  gem 'capybara-screenshot'
+  gem 'rspec-rails'
+  gem 'simplecov', require: false
+
+  # Linters
+  # gem 'brakeman'
+  # gem 'fasterer'
+  # gem 'reek'
+  gem 'rubocop'
+  gem 'rubocop-packaging'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+
+  # Tools
+  # gem 'overcommit', '~> 0.59'
+  gem 'pry-rails'
+end

LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2023 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.

README.md

@@ -0,0 +1,171 @@
+# Tiny Admin
+
+A compact and composible dashboard component for Ruby.
+
+The main features are:
+- a Rack app that can be mounted in any Rack-enabled framework;
+- some features are handled as plugins, so they can be replaced with little effort;
+- routing is provided by Roda (which is small and performant);
+- views are Phlex components.
+
+See (extra)[extra] folder for usage examples.
+
+Please ⭐ if you like it.
+
+## Install
+
+- Add to your Gemfile: `gem 'tiny_admin'`
+- For a Rails project: add an initializer and the YAML config - see (configuration)[#configuration] below.
+
+## Plugins and components
+
+Every plugin or component can be replaced.
+
+### Authentication
+
+There are 2 plugins included:
+- _SimpleAuth_: provides a simple session authentication based on Warden (`warden` gem must be included in the host project);
+- _NoAuth_: no authentication.
+
+### Repository
+
+There is 1 plugin included:
+- _ActiveRecordRepository_: isolates the query layer to expose the resources in the admin interface.
+
+### View pages
+
+There are 5 view pages included:
+- _Root_: define how to present the content in the main page of the interface;
+- _PageNotFound_: define how to present pages not found;
+- _RecordNotFound_: define how to present record not found page;
+- _SimpleAuthLogin_: define how to present the login form for SimpleAuth plugin;
+- _Index_: define how to present a collection of items;
+- _Show_: define how to present the details of an item.
+
+### View components
+
+There are 5 view components included:
+- _FiltersForm_: define how to present the filters form in the resource collection pages;
+- _Flash_: define how to present the flash messages;
+- _Head_: define how to present the Head tag;
+- _Navbar_: define how to present the navbar (the default one uses the Bootstrap structure);
+- _Pagination_: define how to present the pagination of a collection.
+
+## Configuration
+
+TinyAdmin can be configured programmatically or using a YAML config.
+
+Example:
+
+```rb
+# config/initializers/tiny_admin.rb
+
+# hash generated using: Digest::SHA512.hexdigest("changeme")
+ENV['ADMIN_PASSWORD_HASH'] = 'f1891cea80fc05e433c943254c6bdabc159577a02a7395dfebbfbc4f7661d4af56f2d372131a45936de40160007368a56ef216a30cb202c66d3145fd24380906'
+config = Rails.root.join('config/tiny_admin.yml').to_s
+TinyAdmin.configure_from_file(config)
+```
+
+```yml
+---
+authentication:
+  plugin: TinyAdmin::Plugins::SimpleAuth
+page_not_found: Admin::PageNotFound
+record_not_found: Admin::RecordNotFound
+root:
+  title: 'Tiny Admin'
+  page: Admin::PageRoot
+  # redirect: posts
+sections:
+  - slug: google
+    name: Google.it
+    type: url
+    url: https://www.google.it
+    options:
+      target: '_blank'
+  - slug: stats
+    name: Stats
+    type: page
+    page: Admin::Stats
+  - slug: authors
+    name: Authors
+    type: resource
+    model: Author
+    repository: Admin::AuthorsRepo
+    collection_actions:
+      - latests: Admin::LatestAuthorsAction
+    member_actions:
+      - csv_export: Admin::CsvExportAuthorAction
+    # only:
+    #   - index
+    # options:
+    #   - hidden
+  - slug: posts
+    name: Posts
+    type: resource
+    model: Post
+    index:
+      sort:
+        - author_id DESC
+      pagination: 15
+      attributes:
+        - id
+        - title
+        - field: author_id
+          link_to: authors
+        - state
+        - published
+        - dt
+        - field: created_at
+          converter: Admin::Utils
+          method: datetime_formatter
+      filters:
+        - title
+        - field: state
+          type: select
+          values:
+            - available
+            - unavailable
+            - arriving
+        - published
+    show:
+      attributes:
+        - id
+        - title
+        - description
+        - field: author_id
+          link_to: authors
+        - category
+        - published
+        - state
+        - created_at
+style_links:
+  - href: /bootstrap.min.css
+    rel: stylesheet
+scripts:
+  - src: /bootstrap.bundle.min.js
+extra_styles: >
+  .navbar {
+    background-color: var(--bs-cyan);
+  }
+  .main-content {
+    background-color: var(--bs-gray-100);
+  }
+  .main-content a {
+    text-decoration: none;
+  }
+```
+
+## 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).

bin/rails

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENV['RAILS_ENV'] ||= 'test'
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+APP_PATH = File.expand_path("../spec/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")