Merge pull request #40 from blocknotes/refactor/fix-phlex-template-deprecation

blocknotes · web-flow · commit b2e0d46eca0c · 2024-04-18T18:03:23.000+02:00
refactor: fix Phlex template deprecation
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ Gemfile.lock
 /spec/dummy_rails/log
 /spec/dummy_rails/tmp
 /spec/dummy_rails/db/*.sqlite3
+/spec/dummy_rails/db/*.sqlite3-*
diff --git a/Gemfile b/Gemfile
@@ -6,9 +6,9 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 gemspec
 
 group :development, :test do
-  gem 'rails', '~> 7.0'
+  gem 'rails', '~> 7.1'
 
-  gem 'sqlite3'
+  gem 'sqlite3', '< 2.0'
   gem 'tilt'
   gem 'warden'
   gem 'webrick'
diff --git a/extra/sample_features_app/admin/sample_page.rb b/extra/sample_features_app/admin/sample_page.rb
@@ -2,7 +2,7 @@
 
 module Admin
   class SamplePage < TinyAdmin::Views::DefaultLayout
-    def template
+    def view_template
       super do
         h1 { 'Sample page' }
         p { 'This is a sample page' }
diff --git a/extra/sample_features_app/admin/sample_page2.rb b/extra/sample_features_app/admin/sample_page2.rb
@@ -2,7 +2,7 @@
 
 module Admin
   class SamplePage2 < TinyAdmin::Views::DefaultLayout
-    def template
+    def view_template
       super do
         h1 { 'Sample page 2' }
         p { 'This is another sample page' }
diff --git a/extra/tiny_admin_settings.rb b/extra/tiny_admin_settings.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class SamplePage < TinyAdmin::Views::DefaultLayout
-  def template
+  def view_template
     super do
       h1 { 'Sample page' }
       p { 'This is a sample page' }
@@ -10,7 +10,7 @@ def template
 end
 
 class SamplePage2 < TinyAdmin::Views::DefaultLayout
-  def template
+  def view_template
     super do
       h1 { 'Sample page 2' }
       p { 'This is another sample page' }
diff --git a/lib/tiny_admin/views/actions/index.rb b/lib/tiny_admin/views/actions/index.rb
@@ -13,7 +13,7 @@ class Index < DefaultLayout
                       :records,
                       :slug
 
-        def template
+        def view_template
           super do
             div(class: 'index') {
               div(class: 'row') {
diff --git a/lib/tiny_admin/views/actions/show.rb b/lib/tiny_admin/views/actions/show.rb
@@ -11,7 +11,7 @@ class Show < DefaultLayout
                       :reference,
                       :slug
 
-        def template
+        def view_template
           super do
             div(class: 'show') {
               div(class: 'row') {
diff --git a/lib/tiny_admin/views/components/field_value.rb b/lib/tiny_admin/views/components/field_value.rb
@@ -12,7 +12,7 @@ def initialize(field, value, record:)
           @record = record
         end
 
-        def template
+        def view_template
           translated_value = field.translate_value(value)
           value_class = field.options[:options]&.include?('value_class') ? "value-#{value}" : nil
           if field.options[:link_to]
diff --git a/lib/tiny_admin/views/components/filters_form.rb b/lib/tiny_admin/views/components/filters_form.rb
@@ -6,7 +6,7 @@ module Components
       class FiltersForm < BasicComponent
         attr_accessor :filters, :section_path
 
-        def template
+        def view_template
           form(class: 'form_filters', method: 'get') {
             filters.each do |field, filter|
               name = field.name
diff --git a/lib/tiny_admin/views/components/flash.rb b/lib/tiny_admin/views/components/flash.rb
@@ -6,7 +6,7 @@ module Components
       class Flash < BasicComponent
         attr_accessor :messages
 
-        def template
+        def view_template
           @messages ||= {}
           notices = messages[:notices]
           warnings = messages[:warnings]
diff --git a/lib/tiny_admin/views/components/head.rb b/lib/tiny_admin/views/components/head.rb
@@ -6,7 +6,7 @@ module Components
       class Head < BasicComponent
         attr_accessor :extra_styles, :page_title, :style_links
 
-        def template
+        def view_template
           head {
             meta charset: 'utf-8'
             meta name: 'viewport', content: 'width=device-width, initial-scale=1'
diff --git a/lib/tiny_admin/views/components/navbar.rb b/lib/tiny_admin/views/components/navbar.rb
@@ -6,7 +6,7 @@ module Components
       class Navbar < BasicComponent
         attr_accessor :current_slug, :items, :root_path, :root_title
 
-        def template
+        def view_template
           nav(class: 'navbar navbar-expand-lg') {
             div(class: 'container') {
               a(class: 'navbar-brand', href: root_path) { root_title }
diff --git a/lib/tiny_admin/views/components/pagination.rb b/lib/tiny_admin/views/components/pagination.rb
@@ -6,7 +6,7 @@ module Components
       class Pagination < BasicComponent
         attr_accessor :current, :pages, :query_string, :total_count
 
-        def template
+        def view_template
           div(class: 'container') {
             div(class: 'row') {
               div(class: 'col total-count') {
diff --git a/lib/tiny_admin/views/components/widgets.rb b/lib/tiny_admin/views/components/widgets.rb
@@ -8,7 +8,7 @@ def initialize(widgets)
           @widgets = widgets
         end
 
-        def template
+        def view_template
           return if @widgets.nil? || @widgets.empty?
 
           div(class: 'container widgets') {
diff --git a/lib/tiny_admin/views/default_layout.rb b/lib/tiny_admin/views/default_layout.rb
@@ -5,7 +5,7 @@ module Views
     class DefaultLayout < BasicLayout
       attr_accessor :flash_component, :head_component, :messages, :navbar_component, :options, :title
 
-      def template(&block)
+      def view_template(&block)
         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)
diff --git a/lib/tiny_admin/views/pages/content.rb b/lib/tiny_admin/views/pages/content.rb
@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class Content < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'content') {
               div(class: 'content-data') {
diff --git a/lib/tiny_admin/views/pages/page_not_allowed.rb b/lib/tiny_admin/views/pages/page_not_allowed.rb
@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class PageNotAllowed < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'page_not_allowed') {
               h1(class: 'title') { title }
diff --git a/lib/tiny_admin/views/pages/page_not_found.rb b/lib/tiny_admin/views/pages/page_not_found.rb
@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class PageNotFound < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'page_not_found') {
               h1(class: 'title') { title }
diff --git a/lib/tiny_admin/views/pages/record_not_found.rb b/lib/tiny_admin/views/pages/record_not_found.rb
@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class RecordNotFound < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'record_not_found') {
               h1(class: 'title') { title }
diff --git a/lib/tiny_admin/views/pages/root.rb b/lib/tiny_admin/views/pages/root.rb
@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class Root < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'root') {
               render TinyAdmin::Views::Components::Widgets.new(widgets)
diff --git a/lib/tiny_admin/views/pages/simple_auth_login.rb b/lib/tiny_admin/views/pages/simple_auth_login.rb
@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class SimpleAuthLogin < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'simple_auth_login') {
               h1(class: 'title') { title }
diff --git a/sig/tiny_admin/views/actions/index.rbs b/sig/tiny_admin/views/actions/index.rbs
@@ -11,7 +11,7 @@ module TinyAdmin
         attr_accessor records: Enumerable[untyped]
         attr_accessor slug: String
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
 
         private
 
diff --git a/sig/tiny_admin/views/actions/show.rbs b/sig/tiny_admin/views/actions/show.rbs
@@ -9,7 +9,7 @@ module TinyAdmin
         attr_accessor reference: untyped
         attr_accessor slug: String
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
 
         private
 
diff --git a/sig/tiny_admin/views/components/field_value.rbs b/sig/tiny_admin/views/components/field_value.rbs
@@ -8,7 +8,7 @@ module TinyAdmin
 
         def initialize: (Field, untyped, record: untyped) -> void
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
       end
     end
   end
diff --git a/sig/tiny_admin/views/components/filters_form.rbs b/sig/tiny_admin/views/components/filters_form.rbs
@@ -5,7 +5,7 @@ module TinyAdmin
         attr_accessor filters: (Hash[Field, Hash[Symbol, untyped]])
         attr_accessor section_path: String
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
       end
     end
   end
diff --git a/sig/tiny_admin/views/components/flash.rbs b/sig/tiny_admin/views/components/flash.rbs
@@ -4,7 +4,7 @@ module TinyAdmin
       class Flash
         attr_accessor messages: Hash[Symbol, Array[String]?]?
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
       end
     end
   end
diff --git a/sig/tiny_admin/views/components/head.rbs b/sig/tiny_admin/views/components/head.rbs
@@ -6,7 +6,7 @@ module TinyAdmin
         attr_accessor page_title: String?
         attr_accessor style_links: Array[Hash[Symbol, String]]
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
       end
     end
   end
diff --git a/sig/tiny_admin/views/components/navbar.rbs b/sig/tiny_admin/views/components/navbar.rbs
@@ -7,7 +7,7 @@ module TinyAdmin
         attr_accessor root_path: String
         attr_accessor root_title: String?
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
       end
     end
   end
diff --git a/sig/tiny_admin/views/components/pagination.rbs b/sig/tiny_admin/views/components/pagination.rbs
@@ -7,7 +7,7 @@ module TinyAdmin
         attr_accessor query_string: String
         attr_accessor total_count: Integer
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
 
         private
 
diff --git a/sig/tiny_admin/views/components/widgets.rbs b/sig/tiny_admin/views/components/widgets.rbs
@@ -6,7 +6,7 @@ module TinyAdmin
 
         def initialize: (Array[untyped]?) -> void
 
-        def template: () ?{ (untyped) -> void } -> void
+        def view_template: () ?{ (untyped) -> void } -> void
       end
     end
   end
diff --git a/sig/tiny_admin/views/default_layout.rbs b/sig/tiny_admin/views/default_layout.rbs
@@ -8,7 +8,7 @@ module TinyAdmin
       attr_accessor options: Array[Symbol]?
       attr_accessor title: String?
 
-      def template: () ?{ (untyped) -> void } -> void
+      def view_template: () ?{ (untyped) -> void } -> void
 
       private
 
diff --git a/spec/dummy_rails/app/tiny_admin/latest_authors_widget.rb b/spec/dummy_rails/app/tiny_admin/latest_authors_widget.rb
@@ -1,5 +1,5 @@
 class LatestAuthorsWidget < TinyAdmin::Views::BasicWidget
-  def template
+  def view_template
     h2 { 'Latest authors' }
 
     ul {
diff --git a/spec/dummy_rails/app/tiny_admin/latest_posts_widget.rb b/spec/dummy_rails/app/tiny_admin/latest_posts_widget.rb
@@ -1,5 +1,5 @@
 class LatestPostsWidget < TinyAdmin::Views::BasicWidget
-  def template
+  def view_template
     h2 { 'Latest posts' }
 
     ul {
diff --git a/spec/dummy_rails/app/tiny_admin/page_not_found.rb b/spec/dummy_rails/app/tiny_admin/page_not_found.rb
@@ -1,5 +1,5 @@
 class PageNotFound < TinyAdmin::Views::DefaultLayout
-  def template
+  def view_template
     super do
       h1 { 'Page not found!' }
     end
diff --git a/spec/dummy_rails/app/tiny_admin/record_not_found.rb b/spec/dummy_rails/app/tiny_admin/record_not_found.rb
@@ -1,5 +1,5 @@
 class RecordNotFound < TinyAdmin::Views::DefaultLayout
-  def template
+  def view_template
     super do
       h1 { 'Record not found!' }
     end
diff --git a/spec/dummy_rails/app/tiny_admin/root_page.rb b/spec/dummy_rails/app/tiny_admin/root_page.rb
@@ -1,5 +1,5 @@
 class RootPage < TinyAdmin::Views::DefaultLayout
-  def template
+  def view_template
     super do
       h1 { 'Root page' }
       p { 'This is just a root page' }
diff --git a/spec/dummy_rails/app/tiny_admin/sample_collection_action.rb b/spec/dummy_rails/app/tiny_admin/sample_collection_action.rb
@@ -1,5 +1,5 @@
 class SampleCollectionPage < Phlex::HTML
-  def template
+  def view_template
     p {
       'Custom collection action'
     }
diff --git a/spec/dummy_rails/app/tiny_admin/sample_member_action.rb b/spec/dummy_rails/app/tiny_admin/sample_member_action.rb
@@ -1,5 +1,5 @@
 class SampleMemberPage < Phlex::HTML
-  def template
+  def view_template
     p {
       'Custom member action'
     }
diff --git a/spec/dummy_rails/app/tiny_admin/sample_page.rb b/spec/dummy_rails/app/tiny_admin/sample_page.rb
@@ -1,5 +1,5 @@
 class SamplePage < TinyAdmin::Views::DefaultLayout
-  def template
+  def view_template
     super do
       h1 { 'Sample page' }
       p { 'This is just a sample page' }
diff --git a/spec/dummy_rails/db/migrate/20180607053739_create_posts.rb b/spec/dummy_rails/db/migrate/20180607053739_create_posts.rb
@@ -3,6 +3,7 @@
 class CreatePosts < ActiveRecord::Migration[5.2]
   def change
     create_table :posts do |t|
+      t.integer :state
       t.string :title
       t.text :description
       t.belongs_to :author, foreign_key: true
diff --git a/spec/dummy_rails/db/schema.rb b/spec/dummy_rails/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2018_06_07_053857) do
+ActiveRecord::Schema[7.1].define(version: 2018_06_07_053857) do
   create_table "authors", force: :cascade do |t|
     t.string "name"
     t.integer "age"
@@ -29,6 +29,7 @@
   end
 
   create_table "posts", force: :cascade do |t|
+    t.integer "state"
     t.string "title"
     t.text "description"
     t.integer "author_id"
diff --git a/tiny_admin.gemspec b/tiny_admin.gemspec
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir['{app,db,lib}/**/*', 'LICENSE.txt', 'README.md']
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'phlex', '~> 1'
+  spec.add_runtime_dependency 'phlex', '~> 1', '>= 1.10.0'
   spec.add_runtime_dependency 'roda', '~> 3'
   spec.add_runtime_dependency 'tilt', '~> 2'
   spec.add_runtime_dependency 'zeitwerk', '~> 2'
