tiny_admin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ac2be067ca35c35f40c677c5f9461c5f83e366488a48e6ab50a888f0f22317
-  data.tar.gz: 2289dd33940174e8e614260f96273967ade51f75dc67a04d5e639415c984e65b
+  metadata.gz: 0dfe9b2fef29073201e228daf3a7d89003902f8d98108e58cb8245fdb9a533e3
+  data.tar.gz: 6634891a9bbc2585549a759cd061a25234b834ebdcc0b77fbbb9bd2297b0a626
 SHA512:
-  metadata.gz: f4f80d86ac6b30bc29cf8e2f1efe480edefe84907bf5e9b7a3a8c3b3c3750ff59a1f9e609c87090105c0cd31fa22df7aa913858911a455d918633269c27317e7
-  data.tar.gz: 4fe8a75d9e3c0cc3bd756ab247fecb7575049dcec58559bdb7cdb1c58ecb4b6e7de3f8be96c396b0b304134cc75c6058b3cbeafce92cd027413971a99a812c02
+  metadata.gz: 78b49e3f8b7efe941e24734692db4e4baaa2159f58a10f49ce0563f8c4cfa5950f3e155184016faff12c415ff1a6632d4ee06cd61659a466d170d4b7954becf7
+  data.tar.gz: 16c4fe68dca49b84c4c8ca834c9e3c2ce2304f5a78dc378cfdde837462a96a4e00030e5098083d025ad9ab28060ea2aa581725434ffeec1582715e5fa725ff28

data/README.md

@@ -1,6 +1,6 @@
 # Tiny Admin
 
-[![Gem Version](https://badge.fury.io/rb/tiny_admin.svg)](https://badge.fury.io/rb/tiny_admin) [![Linters](https://github.com/blocknotes/tiny_admin/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/linters.yml) [![Specs Rails 7.0](https://github.com/blocknotes/tiny_admin/actions/workflows/specs_rails_70.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/specs_rails_70.yml)
+[![Gem Version](https://badge.fury.io/rb/tiny_admin.svg)](https://badge.fury.io/rb/tiny_admin) [![Linters](https://github.com/blocknotes/tiny_admin/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/linters.yml) [![Specs](https://github.com/blocknotes/tiny_admin/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/specs.yml)
 
 A compact and composable dashboard component for Ruby.
 
@@ -16,7 +16,7 @@ Please ⭐ if you like it.
 
 ## Install
 
-- Add to your Gemfile: `gem 'tiny_admin', '~> 0.5'`
+- Add to your Gemfile: `gem 'tiny_admin', '~> 0.6'`
 - Mount the app in a route (check some examples with: Hanami, Rails, Roda and standalone in [extra](extra))
   + in Rails, update _config/routes.rb_: `mount TinyAdmin::Router => '/admin'`
 - Configure the dashboard using `TinyAdmin.configure` and/or `TinyAdmin.configure_from_file` with a YAML config file (see [configuration](#configuration) below):
@@ -51,6 +51,7 @@ Plugin available:
 Pages available:
 
 - **Root**: define how to present the content in the main page of the interface;
+- **Content**: define how to present page with inline content;
 - **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;
@@ -122,9 +123,24 @@ authentication:
 
 - `slug` (String): section reference identifier;
 - `name` (String): section's title;
-- `type` (String): the type of section: `url`, `page` or `resource`;
+- `type` (String): the type of section: `content`, `page`, `resource` or `url`;
 - other properties depends on the section's type.
 
+For _content_ sections:
+
+- `content` (String): the HTML content to present.
+
+Example:
+
+```yml
+slug: test-content
+name: Test content
+type: content
+content: >
+  <h1>Test content!</h1>
+  <p>Some test content</p>
+```
+
 For _url_ sections:
 
 - `url` (String): the URL to load when clicking on the section's menu item;

data/lib/tiny_admin/actions/index.rb

@@ -21,7 +21,7 @@ module TinyAdmin
         records, total_count = repository.list(page: current_page, limit: pagination, filters: filters, sort: sort)
 
         prepare_page(Views::Actions::Index) do |page|
-          setup_pagination(page, settings.components[:pagination], total_count: total_count)
+          setup_pagination(page, TinyAdmin.settings.components[:pagination], total_count: total_count)
           page.update_attributes(
             actions: context.actions,
             fields: fields,

data/lib/tiny_admin/authentication.rb

@@ -5,7 +5,7 @@ module TinyAdmin
     route do |r|
       r.get 'unauthenticated' do
         if current_user
-          r.redirect settings.root_path
+          r.redirect TinyAdmin.settings.root_path
         else
           render_login
         end
@@ -17,14 +17,14 @@ module TinyAdmin
 
       r.get 'logout' do
         logout_user
-        r.redirect settings.root_path
+        r.redirect TinyAdmin.settings.root_path
       end
     end
 
     private
 
     def render_login(notices: nil, warnings: nil, errors: nil)
-      page = prepare_page(settings.authentication[:login], options: %i[no_menu compact_layout])
+      page = prepare_page(TinyAdmin.settings.authentication[:login], options: %i[no_menu compact_layout])
       page.messages = {
         notices: notices || flash['notices'],
         warnings: warnings || flash['warnings'],

data/lib/tiny_admin/basic_app.rb

@@ -6,7 +6,7 @@ module TinyAdmin
 
     class << self
       def authentication_plugin
-        plugin = TinyAdmin::Settings.instance.authentication&.dig(:plugin)
+        plugin = TinyAdmin.settings.authentication&.dig(:plugin)
         plugin_class = plugin.is_a?(String) ? Object.const_get(plugin) : plugin
         plugin_class || TinyAdmin::Plugins::NoAuth
       end
@@ -17,8 +17,8 @@ module TinyAdmin
     plugin :render, engine: 'html'
     plugin :sessions, secret: SecureRandom.hex(64)
 
-    plugin authentication_plugin, TinyAdmin::Settings.instance.authentication
+    plugin authentication_plugin, TinyAdmin.settings.authentication
 
-    not_found { prepare_page(settings.page_not_found).call }
+    not_found { prepare_page(TinyAdmin.settings.page_not_found).call }
   end
 end

data/lib/tiny_admin/plugins/active_record_repository.rb

@@ -20,12 +20,12 @@ module TinyAdmin
       def fields(options: nil)
         if options
           types = model.columns.to_h { [_1.name, _1.type] }
-          options.each_with_object({}) do |(name, field_options), result|
-            result[name] = TinyAdmin::Field.create_field(name: name, type: types[name], options: field_options)
+          options.to_h do |name, field_options|
+            [name, TinyAdmin::Field.create_field(name: name, type: types[name], options: field_options)]
           end
         else
-          model.columns.each_with_object({}) do |column, result|
-            result[column.name] = TinyAdmin::Field.create_field(name: column.name, type: column.type)
+          model.columns.to_h do |column|
+            [column.name, TinyAdmin::Field.create_field(name: column.name, type: column.type)]
           end
         end
       end
@@ -42,8 +42,12 @@ module TinyAdmin
         raise BaseRepository::RecordNotFound, e.message
       end
 
+      def collection
+        model.all
+      end
+
       def list(page: 1, limit: 10, sort: nil, filters: nil)
-        query = sort ? model.all.order(sort) : model.all
+        query = sort ? collection.order(sort) : collection
         query = apply_filters(query, filters) if filters
         page_offset = page.positive? ? (page - 1) * limit : 0
         records = query.offset(page_offset).limit(limit).to_a

data/lib/tiny_admin/plugins/base_repository.rb

@@ -18,7 +18,7 @@ module TinyAdmin
             converter = Object.const_get(field[:converter])
             converter.send(method, value, options: options || [])
           else
-            Settings.instance.helper_class.send(method, value, options: options || [])
+            TinyAdmin.settings.helper_class.send(method, value, options: options || [])
           end
         else
           value&.to_s

data/lib/tiny_admin/router.rb

@@ -2,10 +2,11 @@
 
 module TinyAdmin
   class Router < BasicApp
+    TinyAdmin.settings.load_settings
+
     route do |r|
-      context.settings = TinyAdmin::Settings.instance
-      context.settings.load_settings
       context.router = r
+      context.settings = TinyAdmin.settings
 
       r.on 'auth' do
         context.slug = nil
@@ -26,11 +27,11 @@ module TinyAdmin
 
       r.post '' do
         context.slug = nil
-        r.redirect settings.root_path
+        r.redirect TinyAdmin.settings.root_path
       end
 
-      context.pages.each do |slug, data|
-        setup_page_route(r, slug, data)
+      context.pages.each do |slug, page_data|
+        setup_page_route(r, slug, page_data)
       end
 
       context.resources.each do |slug, options|
@@ -51,19 +52,21 @@ module TinyAdmin
 
     def root_route(router)
       context.slug = nil
-      if settings.root[:redirect]
-        router.redirect route_for(settings.root[:redirect])
+      if TinyAdmin.settings.root[:redirect]
+        router.redirect route_for(TinyAdmin.settings.root[:redirect])
       else
-        page = settings.root[:page]
+        page = TinyAdmin.settings.root[:page]
         page_class = page.is_a?(String) ? Object.const_get(page) : page
         render_page prepare_page(page_class)
       end
     end
 
-    def setup_page_route(router, slug, page_class)
+    def setup_page_route(router, slug, page_data)
       router.get slug do
         context.slug = slug
-        render_page prepare_page(page_class)
+        page = prepare_page(page_data[:class])
+        page.update_attributes(content: page_data[:content]) if page_data[:content]
+        render_page page
       end
     end
 
@@ -100,7 +103,7 @@ module TinyAdmin
 
     def setup_member_routes(router, options:)
       context.repository = options[:repository].new(options[:model])
-      action_options = (options[:show] || {}).merge(record_not_found_page: settings.record_not_found)
+      action_options = (options[:show] || {}).merge(record_not_found_page: TinyAdmin.settings.record_not_found)
 
       router.on String do |reference|
         context.reference = reference

data/lib/tiny_admin/settings.rb

@@ -12,6 +12,7 @@ module TinyAdmin
       %i[components head] => Views::Components::Head,
       %i[components navbar] => Views::Components::Navbar,
       %i[components pagination] => Views::Components::Pagination,
+      %i[content_page] => Views::Pages::Content,
       %i[helper_class] => Support,
       %i[page_not_found] => Views::Pages::PageNotFound,
       %i[record_not_found] => Views::Pages::RecordNotFound,
@@ -21,25 +22,40 @@ module TinyAdmin
       %i[root title] => 'TinyAdmin'
     }.freeze
 
-    attr_accessor :authentication,
-                  :components,
-                  :extra_styles,
-                  :helper_class,
-                  :page_not_found,
-                  :record_not_found,
-                  :repository,
-                  :root,
-                  :root_path,
-                  :sections,
-                  :scripts,
-                  :style_links
-
-    def [](key)
-      send(key)
+    OPTIONS = %i[
+      authentication
+      components
+      content_page
+      extra_styles
+      helper_class
+      page_not_found
+      record_not_found
+      repository
+      root
+      root_path
+      sections
+      scripts
+      style_links
+    ].freeze
+
+    OPTIONS.each do |option|
+      define_method(option) do
+        self[option]
+      end
+
+      define_method("#{option}=") do |value|
+        self[option] = value
+      end
+    end
+
+    def [](*path)
+      key, option = fetch_setting(path)
+      option[key]
     end
 
-    def []=(key, value)
-      send("#{key}=", value)
+    def []=(*path, value)
+      key, option = fetch_setting(path)
+      option[key] = value
       convert_value(key, value)
     end
 
@@ -56,17 +72,27 @@ module TinyAdmin
 
       context.pages ||= {}
       context.resources ||= {}
-      @sections ||= []
-      @root_path = '/' if @root_path == ''
+      self.sections ||= []
+      self.root_path = '/' if root_path == ''
 
-      if @authentication[:plugin] <= Plugins::SimpleAuth
-        @authentication[:logout] ||= { name: 'logout', path: "#{root_path}/auth/logout" }
+      if authentication[:plugin] <= Plugins::SimpleAuth
+        authentication[:logout] ||= { name: 'logout', path: "#{root_path}/auth/logout" }
       end
       context.navbar = prepare_navbar(sections, logout: authentication[:logout])
     end
 
+    def reset!
+      @options = {}
+    end
+
     private
 
+    def fetch_setting(path)
+      @options ||= {}
+      *parts, last = path.map(&:to_sym)
+      [last, parts.inject(@options) { |result, part| result[part] ||= {} }]
+    end
+
     def convert_value(key, value)
       if value.is_a?(Hash)
         value.each_key do |key2|
@@ -83,7 +109,7 @@ module TinyAdmin
     def prepare_navbar(sections, logout:)
       items = sections.each_with_object({}) do |section, list|
         unless section.is_a?(Hash)
-          section_class = Object.const_get(section)
+          section_class = section.is_a?(String) ? Object.const_get(section) : section
           next unless section_class.respond_to?(:to_h)
 
           section = section_class.to_h
@@ -91,33 +117,37 @@ module TinyAdmin
 
         slug = section[:slug].to_s
         case section[:type]&.to_sym
-        when :url
-          list[slug] = add_url_section(slug, section)
+        when :content
+          list[slug] = add_content_section(slug, section)
         when :page
           list[slug] = add_page_section(slug, section)
         when :resource
           list[slug] = add_resource_section(slug, section)
+        when :url
+          list[slug] = add_url_section(slug, section)
         end
       end
       items['auth/logout'] = logout if logout
       items
     end
 
-    def add_url_section(_slug, section)
-      section.slice(:name, :options).tap { _1[:path] = section[:url] }
+    def add_content_section(slug, section)
+      context.pages[slug] = { class: content_page, content: section[:content] }
+      { name: section[:name], path: route_for(slug), class: content_page }
     end
 
     def add_page_section(slug, section)
       page = section[:page]
-      context.pages[slug] = page.is_a?(String) ? Object.const_get(page) : page
-      { name: section[:name], path: route_for(slug), class: context.pages[slug] }
+      page_class = page.is_a?(String) ? Object.const_get(page) : page
+      context.pages[slug] = { class: page_class }
+      { name: section[:name], path: route_for(slug), class: page_class }
     end
 
     def add_resource_section(slug, section)
-      repository = section[:repository] || settings.repository
+      repo = section[:repository] || repository
       context.resources[slug] = {
         model: section[:model].is_a?(String) ? Object.const_get(section[:model]) : section[:model],
-        repository: repository.is_a?(String) ? Object.const_get(repository) : repository
+        repository: repo.is_a?(String) ? Object.const_get(repo) : repo
       }
       resource_options = section.slice(:resource, :only, :index, :show, :collection_actions, :member_actions)
       resource_options[:only] ||= %i[index show]
@@ -125,5 +155,9 @@ module TinyAdmin
       hidden = section[:options] && (section[:options].include?(:hidden) || section[:options].include?('hidden'))
       { name: section[:name], path: route_for(slug) } unless hidden
     end
+
+    def add_url_section(_slug, section)
+      section.slice(:name, :options).tap { _1[:path] = section[:url] }
+    end
   end
 end

data/lib/tiny_admin/utils.rb

@@ -17,13 +17,13 @@ module TinyAdmin
     def prepare_page(page_class, options: nil)
       page_class.new.tap do |page|
         page.options = options
-        page.head_component = settings.components[:head]&.new
-        page.flash_component = settings.components[:flash]&.new
-        page.navbar_component = settings.components[:navbar]&.new
+        page.head_component = TinyAdmin.settings.components[:head]&.new
+        page.flash_component = TinyAdmin.settings.components[:flash]&.new
+        page.navbar_component = TinyAdmin.settings.components[:navbar]&.new
         page.navbar_component&.update_attributes(
           current_slug: context&.slug,
-          root_path: settings.root_path,
-          root_title: settings.root[:title],
+          root_path: TinyAdmin.settings.root_path,
+          root_title: TinyAdmin.settings.root[:title],
           items: options&.include?(:no_menu) ? [] : context&.navbar
         )
         yield(page) if block_given?
@@ -31,7 +31,7 @@ module TinyAdmin
     end
 
     def route_for(section, reference: nil, action: nil, query: nil)
-      root_path = settings.root_path == '/' ? nil : settings.root_path
+      root_path = TinyAdmin.settings.root_path == '/' ? nil : TinyAdmin.settings.root_path
       route = [root_path, section, reference, action].compact.join("/")
       route << "?#{query}" if query
       route[0] == '/' ? route : route.prepend('/')
@@ -46,9 +46,5 @@ module TinyAdmin
     def context
       TinyAdmin::Context.instance
     end
-
-    def settings
-      TinyAdmin::Settings.instance
-    end
   end
 end

data/lib/tiny_admin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinyAdmin
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/tiny_admin/views/basic_layout.rb

@@ -5,6 +5,8 @@ module TinyAdmin
     class BasicLayout < Phlex::HTML
       include Utils
 
+      attr_accessor :content
+
       def update_attributes(attributes)
         attributes.each do |key, value|
           send("#{key}=", value)

data/lib/tiny_admin/views/default_layout.rb

@@ -6,7 +6,7 @@ module TinyAdmin
       attr_accessor :flash_component, :head_component, :messages, :navbar_component, :options, :title
 
       def template(&block)
-        extra_styles = settings.extra_styles
+        extra_styles = TinyAdmin.settings.extra_styles
         flash_component&.messages = messages
         head_component&.update_attributes(page_title: title, style_links: style_links, extra_styles: extra_styles)
 
@@ -49,7 +49,7 @@ module TinyAdmin
       end
 
       def style_links
-        settings.style_links || [
+        TinyAdmin.settings.style_links || [
           # Bootstrap CDN
           {
             href: 'https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css',
@@ -61,7 +61,7 @@ module TinyAdmin
       end
 
       def render_scripts
-        (settings.scripts || []).each do |script_attrs|
+        (TinyAdmin.settings.scripts || []).each do |script_attrs|
           script(**script_attrs)
         end
       end

data/lib/tiny_admin/views/pages/content.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TinyAdmin
+  module Views
+    module Pages
+      class Content < DefaultLayout
+        def template
+          super do
+            div(class: 'content') {
+              unsafe_raw(content)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiny_admin.rb

@@ -12,15 +12,20 @@ loader.setup
 
 module TinyAdmin
   def configure(&block)
-    block&.call(TinyAdmin::Settings.instance) || TinyAdmin::Settings.instance
+    block&.call(settings) || settings
   end
 
   def configure_from_file(file)
+    settings.reset!
     config = YAML.load_file(file, symbolize_names: true)
     config.each do |key, value|
-      TinyAdmin::Settings.instance[key] = value
+      settings[key] = value
     end
   end
 
-  module_function :configure, :configure_from_file
+  def settings
+    TinyAdmin::Settings.instance
+  end
+
+  module_function :configure, :configure_from_file, :settings
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_admin
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -101,6 +101,7 @@ files:
 - lib/tiny_admin/views/components/navbar.rb
 - lib/tiny_admin/views/components/pagination.rb
 - lib/tiny_admin/views/default_layout.rb
+- lib/tiny_admin/views/pages/content.rb
 - lib/tiny_admin/views/pages/page_not_found.rb
 - lib/tiny_admin/views/pages/record_not_found.rb
 - lib/tiny_admin/views/pages/root.rb