tiny_admin 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8059ea24a18bfb14f8e868a70203db8045099e20196f5098f1c63b121421e49
-  data.tar.gz: d0da80d718362c58a50e963b2e79dff550e77a763d7872a0ba96efea43f408b3
+  metadata.gz: 71d42ca63e3a410de95780d584cdfb61dd94feb95b503f5f55379efabec9477e
+  data.tar.gz: 96c4b375cb65327635199296d11f54335e6c5266dacce39a7316e0eb2844046c
 SHA512:
-  metadata.gz: 3067f890f10f10f5dc7379c7b147f01f5cb62b8d59f06ad7b4387c685cd2e32cdeb1f87fbfe36b0e2c388c854ce461f1a18b2659ee479e401ba74ed3c5559a3a
-  data.tar.gz: 0a4b4129b33e0dbf2ab2d01df14ead0ec3971a098dbed39a5b50c287e2a00c5c8448011de81a233c7bb1dda58bb42b648d44069684a65cdb4e42e3faf2a453bb
+  metadata.gz: d377537524247253a871e016d3d5e688e47ab07d40c6d33814c5dfc0be761e734d3de3c8c23d3e3981d3f949ce15d230312b4c71fb2d7d6f33aeb45cc352223f
+  data.tar.gz: 4ddb16c2f1fbfefced95deb426cf369d28201866f800eee1f4b14895bd938233f6f67bf51d784a7edf340b48d7a75230a86b679db9ec71c07f18b726c23971a4

data/README.md

@@ -19,7 +19,7 @@ Please ⭐ if you like it.
 
 ## Install
 
-- Add to your Gemfile: `gem 'tiny_admin', '~> 0.7'`
+- Add to your Gemfile: `gem 'tiny_admin', '~> 0.8'`
 - 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):
@@ -85,6 +85,8 @@ The following options are supported:
 - `redirect` (String): alternative to _page_ option - redirects to a specific slug;
 - `widgets` (Array): list of widgets (as View components) to present.
 
+> 📚 [Wiki Root page](https://github.com/blocknotes/tiny_admin/wiki/Root) available
+
 Example:
 
 ```yml
@@ -98,6 +100,8 @@ root:
 
 `helper_class` (String): class or module with helper methods, used for attributes' formatters.
 
+> 📚 [Wiki Helper methods page](https://github.com/blocknotes/tiny_admin/wiki/Helper-methods) available
+
 `page_not_found` (String): a view object to render when a missing page is requested.
 
 `record_not_found` (String): a view object to render when a missing record is requested.
@@ -113,11 +117,15 @@ root:
 
 `extra_styles` (String): inline CSS styles.
 
+> 📚 [Wiki Styles and scripts page](https://github.com/blocknotes/tiny_admin/wiki/Styles-and-scripts) available
+
 `authentication` (Hash): define the authentication method, properties:
 
 - `plugin` (String): a plugin class to use (ex. `TinyAdmin::Plugins::SimpleAuth`);
 - `password` (String): a password hash used by _SimpleAuth_ plugin (generated with `Digest::SHA512.hexdigest("some password")`).
 
+> 📚 [Wiki Authentication page](https://github.com/blocknotes/tiny_admin/wiki/Authentication) available
+
 Example:
 
 ```yml
@@ -134,6 +142,8 @@ authentication:
 - `widgets` (Array): list of widgets (as View components) to present;
 - other properties depends on the section's type.
 
+> 📚 [Wiki Pages page](https://github.com/blocknotes/tiny_admin/wiki/Pages) available
+
 For _content_ sections:
 
 - `content` (String): the HTML content to present.
@@ -186,6 +196,9 @@ For _resource_ sections:
 
 - `model` (String): the class to use to fetch the data on an item of a collection;
 - `repository` (String): the class to get the properties related to the model;
+
+> 📚 [Wiki Repository page](https://github.com/blocknotes/tiny_admin/wiki/Repository) available
+
 - `index` (Hash): collection's action options (see below);
 - `show` (Hash): detail's action options (see below);
 - `collection_actions` (Array of hashes): custom collection's actions;

data/lib/tiny_admin/authentication.rb

@@ -12,7 +12,11 @@ module TinyAdmin
       end
 
       r.post 'unauthenticated' do
-        render_login(warnings: ['Failed to authenticate'])
+        warning = TinyAdmin.settings.helper_class.label_for(
+          'Failed to authenticate',
+          options: ['authentication.unauthenticated']
+        )
+        render_login(warnings: [warning])
       end
 
       r.get 'logout' do

data/lib/tiny_admin/field.rb

@@ -16,6 +16,19 @@ module TinyAdmin
       messages.inject(target) { |result, msg| result&.send(msg) } if messages.any?
     end
 
+    def translate_value(value)
+      if options && options[:method]
+        method, *args = options[:method].split(',').map(&:strip)
+        if options[:converter]
+          Object.const_get(options[:converter]).send(method, value, options: args || [])
+        else
+          TinyAdmin.settings.helper_class.send(method, value, options: args || [])
+        end
+      else
+        value&.to_s
+      end
+    end
+
     class << self
       def create_field(name:, title: nil, type: nil, options: {})
         field_name = name.to_s

data/lib/tiny_admin/plugins/active_record_repository.rb

@@ -6,10 +6,7 @@ module TinyAdmin
       def index_record_attrs(record, fields: nil)
         return record.attributes.transform_values(&:to_s) unless fields
 
-        fields.to_h do |name, field|
-          value = record.send(name)
-          [name, translate_value(value, field)]
-        end
+        fields.to_h { [_1, record.send(_1)] }
       end
 
       def index_title

data/lib/tiny_admin/plugins/base_repository.rb

@@ -10,20 +10,6 @@ module TinyAdmin
       def initialize(model)
         @model = model
       end
-
-      def translate_value(value, field)
-        if field[:method]
-          method, *options = field[:method].split(',').map(&:strip)
-          if field[:converter]
-            converter = Object.const_get(field[:converter])
-            converter.send(method, value, options: options || [])
-          else
-            TinyAdmin.settings.helper_class.send(method, value, options: options || [])
-          end
-        else
-          value&.to_s
-        end
-      end
     end
   end
 end

data/lib/tiny_admin/settings.rb

@@ -7,6 +7,7 @@ module TinyAdmin
     DEFAULTS = {
       %i[authentication plugin] => Plugins::NoAuth,
       %i[authentication login] => Views::Pages::SimpleAuthLogin,
+      %i[components field_value] => Views::Components::FieldValue,
       %i[components flash] => Views::Components::Flash,
       %i[components head] => Views::Components::Head,
       %i[components navbar] => Views::Components::Navbar,

data/lib/tiny_admin/support.rb

@@ -15,6 +15,10 @@ module TinyAdmin
         Kernel.format(options.first, value) if value && options&.any?
       end
 
+      def label_for(value, options: [])
+        value
+      end
+
       def round(value, options: [])
         value&.round(options&.first&.to_i || 2)
       end

data/lib/tiny_admin/utils.rb

@@ -37,7 +37,7 @@ module TinyAdmin
       klass.is_a?(String) ? Object.const_get(klass) : klass
     end
 
-    def to_label(string)
+    def humanize(string)
       return '' unless string
 
       string.respond_to?(:humanize) ? string.humanize : string.tr('_', ' ').capitalize

data/lib/tiny_admin/version.rb

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

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

@@ -69,13 +69,7 @@ module TinyAdmin
                 attributes.each do |key, value|
                   field = fields[key]
                   td(class: "field-value-#{field.name} field-value-type-#{field.type}") {
-                    if field.options && field.options[:link_to]
-                      a(href: TinyAdmin.route_for(field.options[:link_to], reference: value)) {
-                        field.apply_call_option(record) || value
-                      }
-                    else
-                      value
-                    end
+                    render TinyAdmin.settings.components[:field_value].new(field, value, record: record)
                   }
                 end
 
@@ -86,15 +80,20 @@ module TinyAdmin
                       links.each do |link|
                         whitespace
                         if link == 'show'
-                          a(href: TinyAdmin.route_for(slug, reference: record.id), class: link_class) { 'show' }
+                          a(href: TinyAdmin.route_for(slug, reference: record.id), class: link_class) {
+                            label_for('Show', options: ['actions.index.links.show'])
+                          }
                         else
                           a(href: TinyAdmin.route_for(slug, reference: record.id, action: link), class: link_class) {
-                            to_label(link)
+                            fallback = humanize(link)
+                            label_for(fallback, options: ["actions.index.links.#{link}"])
                           }
                         end
                       end
                     else
-                      a(href: TinyAdmin.route_for(slug, reference: record.id), class: link_class) { 'show' }
+                      a(href: TinyAdmin.route_for(slug, reference: record.id), class: link_class) {
+                        label_for('Show', options: ['actions.index.links.show'])
+                      }
                     end
                   }
                 }

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

@@ -25,13 +25,7 @@ module TinyAdmin
                     div(class: 'field-header col-2') { field.options[:header] || field.title }
                   end
                   div(class: 'field-value col-10') {
-                    if field.options[:link_to]
-                      a(href: TinyAdmin.route_for(field.options[:link_to], reference: value)) {
-                        field.apply_call_option(record) || value
-                      }
-                    else
-                      value
-                    end
+                    render TinyAdmin.settings.components[:field_value].new(field, value, record: record)
                   }
                 }
               end

data/lib/tiny_admin/views/basic_layout.rb

@@ -7,6 +7,10 @@ module TinyAdmin
 
       attr_accessor :content, :widgets
 
+      def label_for(value, options: [])
+        TinyAdmin.settings.helper_class.label_for(value, options: options)
+      end
+
       def update_attributes(attributes)
         attributes.each do |key, value|
           send("#{key}=", value)

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TinyAdmin
+  module Views
+    module Components
+      class FieldValue < BasicComponent
+        attr_reader :field, :value, :record
+
+        def initialize(field, value, record:)
+          @field = field
+          @value = value
+          @record = record
+        end
+
+        def template
+          translated_value = field.translate_value(value)
+          value_class = field.options[:options]&.include?('value_class') ? "value-#{value}" : nil
+          if field.options[:link_to]
+            a(href: TinyAdmin.route_for(field.options[:link_to], reference: translated_value)) {
+              span(class: value_class) {
+                field.apply_call_option(record) || translated_value
+              }
+            }
+          else
+            span(class: value_class) {
+              translated_value
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,8 +17,12 @@ module TinyAdmin
                 when :boolean
                   select(class: 'form-select', id: "filter-#{name}", name: "q[#{name}]") {
                     option(value: '') { '-' }
-                    option(value: '0', selected: filter[:value] == '0') { 'false' }
-                    option(value: '1', selected: filter[:value] == '1') { 'true' }
+                    option(value: '0', selected: filter[:value] == '0') {
+                      TinyAdmin.settings.helper_class.label_for('false', options: ['components.filters_form.boolean.false'])
+                    }
+                    option(value: '1', selected: filter[:value] == '1') {
+                      TinyAdmin.settings.helper_class.label_for('true', options: ['components.filters_form.boolean.true'])
+                    }
                   }
                 when :date
                   input(type: 'date', class: 'form-control', id: "filter-#{name}", name: "q[#{name}]", value: filter[:value])
@@ -40,9 +44,13 @@ module TinyAdmin
             end
 
             div(class: 'mt-3') {
-              a(href: section_path, class: 'button_clear btn btn-secondary text-white') { 'clear' }
+              a(href: section_path, class: 'button_clear btn btn-secondary text-white') {
+                TinyAdmin.settings.helper_class.label_for('Clear', options: ['components.filters_form.buttons.clear'])
+              }
               whitespace
-              button(type: 'submit', class: 'button_filter btn btn-secondary') { 'filter' }
+              button(type: 'submit', class: 'button_filter btn btn-secondary') {
+                TinyAdmin.settings.helper_class.label_for('Filter', options: ['components.filters_form.buttons.submit'])
+              }
             }
           }
         end

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

@@ -11,12 +11,16 @@ module TinyAdmin
 
               form(class: 'form_login', method: 'post') {
                 div(class: 'mt-3') {
-                  label(for: 'secret', class: 'form-label') { 'Password' }
+                  label(for: 'secret', class: 'form-label') {
+                    label_for('Password', options: ['pages.simple_auth_login.inputs.password'])
+                  }
                   input(type: 'password', name: 'secret', class: 'form-control', id: 'secret')
                 }
 
                 div(class: 'mt-3') {
-                  button(type: 'submit', class: 'button_login btn btn-primary') { 'login' }
+                  button(type: 'submit', class: 'button_login btn btn-primary') {
+                    label_for('Login', options: ['pages.simple_auth_login.buttons.submit'])
+                  }
                 }
               }
             }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_admin
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -98,6 +98,7 @@ files:
 - lib/tiny_admin/views/basic_layout.rb
 - lib/tiny_admin/views/basic_widget.rb
 - lib/tiny_admin/views/components/basic_component.rb
+- lib/tiny_admin/views/components/field_value.rb
 - lib/tiny_admin/views/components/filters_form.rb
 - lib/tiny_admin/views/components/flash.rb
 - lib/tiny_admin/views/components/head.rb