tiny_admin 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10d229ad7389d1fe4392d6f96ec993550470ba67d1b4e140df21b9d247ae3657
-  data.tar.gz: 3f625daa624cdff4e7fe4f13618ac753cce120995daa9140dac17e55d79ef1ba
+  metadata.gz: d203e48b821f195f95847a646e32787c9ffd953212326f64e65ca09d563ed55e
+  data.tar.gz: a133ad428942d240ec8852e4885e12a51bc6a96f9a4bcf426470180671dddf6f
 SHA512:
-  metadata.gz: 7078779b3478f2e28f5864b43839a69ee918a452a97c0851b3be45a75802fd01600f2df6d771f093032e021f98c408b40fcaffac0b4ba5fca61e5e92693bfe86
-  data.tar.gz: c120746d7363cbda9dd39f9de6910181645da4d63bf8325c0e4d8619b2892b008c882a32e4e8b50f63ec9fc6486837843e920f4e4c917424390346fb5af67877
+  metadata.gz: 8955bf003179333debcf4c43dd7091b4d81fc9c1e90a6116119dc33f51b4ab7dca394d90f6f8aa6bb0385339dc5eb07b64bd546f0a92e02497d5c000cc835769
+  data.tar.gz: 5cabb3dc010e73b416068cca3afda56dc07ac7b024c70d734b9409298d2082798a8e5e276d892be81e82dcbfa68bad20360f0d99e4c8e7199a7bdb5067f72124

data/README.md

@@ -4,11 +4,11 @@
 
 A compact and composable dashboard component for Ruby.
 
-The main features are:
-- a Rack app that can be mounted in any Rack-enabled framework, it can even work standalone;
+Main features:
+- a Rack app that can be mounted in any Rack-enabled framework or used standalone;
 - structured with plugins also for main components that can be replaced with little effort;
-- routing is provided by Roda, which is small and performant;
-- views are Phlex components, so plain Ruby objects for views and no assets are needed.
+- routing is provided by Roda which is small and performant;
+- views are Phlex components, so plain Ruby objects for views, no assets are needed.
 
 Please ⭐ if you like it.
 
@@ -16,9 +16,19 @@ Please ⭐ if you like it.
 
 ## Install
 
-- Add to your Gemfile: `gem 'tiny_admin', '~> 0.1'`
+- Add to your Gemfile: `gem 'tiny_admin', '~> 0.3'`
 - Mount the app in a route (check some examples with: Hanami, Rails, Roda and standalone in [extra](extra))
-- Configure the dashboard using `TinyAdmin.configure` and/or `TinyAdmin.configure_from_file` (see [configuration](#configuration) below)
+  + in Rails, update _config/routes.rb_: `mount TinyAdmin::Router => '/admin'`
+- Configure the dashboard using `TinyAdmin.configure` and/or `TinyAdmin.configure_from_file` (see [configuration](#configuration) below):
+
+```rb
+TinyAdmin.configure do |settings|
+  settings.root = {
+    title: 'Home',
+    page: Admin::PageRoot
+  }
+end
+```
 
 ## Plugins and components
 

data/lib/tiny_admin/actions/index.rb

@@ -3,21 +3,24 @@
 module TinyAdmin
   module Actions
     class Index < BasicAction
-      attr_reader :current_page, :fields_options, :filters_list, :pagination, :query_string, :sort
+      attr_reader :current_page, :fields_options, :filters_list, :pagination, :pages, :query_string, :sort
 
       def call(app:, context:, options:, actions:)
         evaluate_options(options)
         fields = repository.fields(options: fields_options)
         filters = prepare_filters(fields, filters_list)
         records, total_count = repository.list(page: current_page, limit: pagination, filters: filters, sort: sort)
-        prepare_record = ->(record) { repository.index_record_attrs(record, fields: fields_options) }
-        title = repository.index_title
-        pages = (total_count / pagination) + 1
-
-        prepare_page(Views::Actions::Index, context: context) do |page|
-          page.setup_pagination(current_page: current_page, pages: pages > 1 ? pages : false)
-          page.setup_records(records: records, fields: fields, prepare_record: prepare_record)
-          page.update_attributes(actions: actions, filters: filters, query_string: query_string, title: title)
+
+        prepare_page(Views::Actions::Index) do |page|
+          setup_pagination(page, settings.components[:pagination], total_count: total_count)
+          page.update_attributes(
+            actions: actions,
+            fields: fields,
+            filters: filters,
+            prepare_record: ->(record) { repository.index_record_attrs(record, fields: fields_options) },
+            records: records,
+            title: repository.index_title
+          )
         end
       end
 
@@ -43,6 +46,14 @@ module TinyAdmin
           result[field] = { value: values[field.name], filter: filters[field.name] } if filters.key?(field.name)
         end
       end
+
+      def setup_pagination(page, pagination_component_class, total_count:)
+        @pages = (total_count / pagination.to_f).ceil
+        return if pages <= 1 || !pagination_component_class
+
+        page.pagination_component = pagination_component_class.new
+        page.pagination_component.update(current: current_page, pages: pages, query_string: query_string)
+      end
     end
   end
 end

data/lib/tiny_admin/actions/show.rb

@@ -11,7 +11,7 @@ module TinyAdmin
         prepare_record = ->(record_data) { repository.show_record_attrs(record_data, fields: fields_options) }
         fields = repository.fields(options: fields_options)
 
-        prepare_page(Views::Actions::Show, context: context) do |page|
+        prepare_page(Views::Actions::Show) do |page|
           page.setup_record(record: record, fields: fields, prepare_record: prepare_record)
           page.update_attributes(actions: actions, title: repository.show_title(record))
         end

data/lib/tiny_admin/plugins/simple_auth.rb

@@ -8,7 +8,7 @@ module TinyAdmin
       class << self
         def configure(app, opts = {})
           @@opts = opts || {} # rubocop:disable Style/ClassVars
-          @@opts[:password] ||= ENV.fetch('ADMIN_PASSWORD_HASH') # NOTE: fallback value
+          @@opts[:password] ||= ENV.fetch('ADMIN_PASSWORD_HASH', nil) # NOTE: fallback value
 
           Warden::Strategies.add(:secret) do
             def authenticate!

data/lib/tiny_admin/router.rb

@@ -54,14 +54,14 @@ module TinyAdmin
       else
         page = settings.root[:page]
         page_class = page.is_a?(String) ? Object.const_get(page) : page
-        render_page prepare_page(page_class, context: context)
+        render_page prepare_page(page_class)
       end
     end
 
     def setup_page_route(router, slug, page_class)
       router.get slug do
         context.slug = slug
-        render_page prepare_page(page_class, context: context)
+        render_page prepare_page(page_class)
       end
     end
 

data/lib/tiny_admin/utils.rb

@@ -13,10 +13,18 @@ module TinyAdmin
       list.join('&')
     end
 
-    def prepare_page(page_class, context: nil, options: nil)
+    def prepare_page(page_class, options: nil)
       page_class.new.tap do |page|
-        page.context = context
         page.options = options
+        page.head_component = settings.components[:head]&.new
+        page.flash_component = settings.components[:flash]&.new
+        page.navbar_component = settings.components[:navbar]&.new(
+          current_slug: context&.slug,
+          root_path: settings.root_path,
+          root_title: settings.root[:title],
+          items: options&.include?(:no_menu) ? [] : settings.navbar
+        )
+
         yield(page) if block_given?
       end
     end

data/lib/tiny_admin/version.rb

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

data/lib/tiny_admin/views/actions/index.rb

@@ -4,21 +4,10 @@ module TinyAdmin
   module Views
     module Actions
       class Index < DefaultLayout
-        attr_reader :current_page, :fields, :pages, :prepare_record, :records
-        attr_accessor :actions, :filters, :query_string
-
-        def setup_pagination(current_page:, pages:)
-          @current_page = current_page
-          @pages = pages
-        end
-
-        def setup_records(records:, fields:, prepare_record:)
-          @records = records
-          @fields = fields.each_with_object({}) { |field, result| result[field.name] = field }
-          @prepare_record = prepare_record
-        end
+        attr_accessor :actions, :fields, :filters, :pagination_component, :prepare_record, :records
 
         def template
+          @fields = fields.each_with_object({}) { |field, result| result[field.name] = field }
           @filters ||= {}
 
           super do
@@ -57,9 +46,7 @@ module TinyAdmin
                 end
               }
 
-              if pages
-                render components[:pagination].new(current: current_page, pages: pages, query_string: query_string)
-              end
+              render pagination_component if pagination_component
             }
           end
         end

data/lib/tiny_admin/views/basic_layout.rb

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

data/lib/tiny_admin/views/components/flash.rb

@@ -6,14 +6,6 @@ module TinyAdmin
       class Flash < Phlex::HTML
         attr_reader :errors, :notices, :warnings
 
-        def initialize(messages:)
-          return unless messages
-
-          @notices = messages[:notices]
-          @warnings = messages[:warnings]
-          @errors = messages[:errors]
-        end
-
         def template
           div(class: 'flash') {
             div(class: 'notices alert alert-success', role: 'alert') { notices.join(', ') } if notices&.any?
@@ -21,6 +13,14 @@ module TinyAdmin
             div(class: 'notices alert alert-danger', role: 'alert') { errors.join(', ') } if errors&.any?
           }
         end
+
+        def update(messages:)
+          return unless messages
+
+          @notices = messages[:notices]
+          @warnings = messages[:warnings]
+          @errors = messages[:errors]
+        end
       end
     end
   end

data/lib/tiny_admin/views/components/head.rb

@@ -6,12 +6,6 @@ module TinyAdmin
       class Head < Phlex::HTML
         attr_reader :extra_styles, :page_title, :style_links
 
-        def initialize(page_title, style_links: [], extra_styles: nil)
-          @page_title = page_title
-          @style_links = style_links
-          @extra_styles = extra_styles
-        end
-
         def template
           head {
             meta charset: 'utf-8'
@@ -25,6 +19,12 @@ module TinyAdmin
             style { extra_styles } if extra_styles
           }
         end
+
+        def update(page_title, style_links: [], extra_styles: nil)
+          @page_title = page_title
+          @style_links = style_links
+          @extra_styles = extra_styles
+        end
       end
     end
   end

data/lib/tiny_admin/views/components/pagination.rb

@@ -6,27 +6,48 @@ module TinyAdmin
       class Pagination < Phlex::HTML
         attr_reader :current, :pages, :query_string
 
-        def initialize(current:, pages:, query_string:)
-          @current = current
-          @pages = pages
-          @query_string = query_string
-        end
-
         def template
           div(class: 'pagination-div') {
             nav('aria-label' => 'Pagination') {
               ul(class: 'pagination justify-content-center') {
-                1.upto(pages) do |i|
-                  li_class = (i == current ? 'page-item active' : 'page-item')
-                  li(class: li_class) {
-                    href = query_string.empty? ? "?p=#{i}" : "?#{query_string}&p=#{i}"
-                    a(class: 'page-link', href: href) { i }
-                  }
+                if pages <= 10
+                  pages_range(1..pages)
+                elsif current <= 4 || current >= pages - 3
+                  pages_range(1..(current <= 4 ? current + 2 : 4), with_dots: true)
+                  pages_range((current > pages - 4 ? current - 2 : pages - 2)..pages)
+                else
+                  pages_range(1..1, with_dots: true)
+                  pages_range(current - 2..current + 2, with_dots: true)
+                  pages_range(pages..pages)
                 end
               }
             }
           }
         end
+
+        def update(current:, pages:, query_string:)
+          @current = current
+          @pages = pages
+          @query_string = query_string
+        end
+
+        private
+
+        def pages_range(range, with_dots: false)
+          range.each do |page|
+            li(class: page == current ? 'page-item active' : 'page-item') {
+              href = query_string.empty? ? "?p=#{page}" : "?#{query_string}&p=#{page}"
+              a(class: 'page-link', href: href) { page }
+            }
+          end
+          dots if with_dots
+        end
+
+        def dots
+          li(class: 'page-item disabled') {
+            a(class: 'page-link') { '...' }
+          }
+        end
       end
     end
   end

data/lib/tiny_admin/views/default_layout.rb

@@ -3,24 +3,22 @@
 module TinyAdmin
   module Views
     class DefaultLayout < BasicLayout
-      attr_accessor :context, :messages, :options, :title
+      attr_accessor :flash_component, :head_component, :messages, :navbar_component, :options, :title
 
       def template(&block)
+        flash_component&.update(messages: messages)
+        head_component&.update(title, style_links: style_links, extra_styles: settings.extra_styles)
+
         doctype
         html {
-          render components[:head].new(title, style_links: style_links, extra_styles: settings.extra_styles)
+          render head_component if head_component
 
           body(class: body_class) {
-            navbar_attrs = {
-              current_slug: context&.slug,
-              root_path: settings.root_path,
-              root_title: settings.root[:title],
-              items: navbar_items
-            }
-            render components[:navbar].new(**navbar_attrs)
+            render navbar_component if navbar_component
 
             main_content {
-              render components[:flash].new(messages: messages || {})
+              render flash_component if flash_component
+
               yield_content(&block)
             }
 
@@ -35,10 +33,6 @@ module TinyAdmin
         "module-#{self.class.to_s.split('::').last.downcase}"
       end
 
-      def navbar_items
-        options&.include?(:no_menu) ? [] : settings.navbar
-      end
-
       def main_content
         div(class: 'container main-content py-4') do
           if options&.include?(:compact_layout)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_admin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex