tramway 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc95797d7be71f61b7a8350b3ef71905d41c8281d3a134feefc4e8477b910b44
-  data.tar.gz: 9fc4aa0e0bbec968e96620532082142b3ad48ab701e97ab52c2bd05a8236c047
+  metadata.gz: dee256141e588202061885354d7669ee2a5bb1ce99a57a709129031002ab13c8
+  data.tar.gz: 36b036fc2890c2710a12684f78ea36f9a2d8ae7e5f11f252973d81ae905f9e3a
 SHA512:
-  metadata.gz: ef921bd83394ebde2404a8e5e1b7332af573713553ed73676850955ff8e32f9fc93cdddfa0124658ad40c096557fcd60ed420a55d252f5e5c3fb40ea34cae19e
-  data.tar.gz: d0a2b72e6e35ea9a297a9af346e794cf1833e8b5922c2e09d98a5f8f06a2d283db49b33753510535a0594365b072aff666712ee50a0b2c9d6036aa530ab52e38
+  metadata.gz: b8ee38fd18865625ffdb1c9671cedbba4c780d001b47743f3b0be3657e525eb0d96c84529a9023dc6a68acc6507df1646ca712f4c26dd47df8caadc174c66aa3
+  data.tar.gz: 453471063d91beecf588b590008b37546a36b035fed4065499b87f4ef6182ea8fd2a551fcc124f88f1ee07a1ec4df501bfbbafa607a03ea05d1ca28925f5f7c9

data/README.md

@@ -8,6 +8,7 @@ Unite Ruby on Rails brilliance. Streamline development with Tramway.
   * [Tramway Form](https://github.com/Purple-Magic/tramway#tramway-form)
   * [Tramway Navbar](https://github.com/Purple-Magic/tramway#tramway-navbar)
   * [Tailwind-styled forms](https://github.com/Purple-Magic/tramway#tailwind-styled-forms)
+  * [Tailwind-styled pagination](https://github.com/Purple-Magic/tramway#tailwind-styled-pagination)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -248,6 +249,24 @@ class Admin::UsersController < Admin::ApplicationController
 end
 ```
 
+### Form inheritance
+
+Tramway Form supports inheritance of `properties`
+
+**Example**
+
+```ruby
+class UserForm < TramwayForm
+  properties :email, :password
+end
+
+class AdminForm < UserForm
+  properties :permissions
+end
+
+AdminForm.properties # returns [:email, :password, :permissions]
+```
+
 ### Make flexible and extendable forms
 
 Tramway Form properties are not mapped to a model. You're able to make extended forms.
@@ -362,6 +381,32 @@ Available form helpers:
 * select
 * submit
 
+### Tailwind-styled pagination for Kaminari
+
+Tramway uses [Tailwind](https://tailwindcss.com/) by default. It has tailwind-styled pagination for [kaminari](https://github.com/kaminari/kaminari).
+
+#### How to use
+
+*Gemfile*
+```ruby
+gem 'tramway'
+gem 'kaminari'
+```
+
+*config/initializers/tramway.rb*
+```ruby
+Tramway.configure do |config|
+  config.pagination = { enabled: true } # enabled is false by default
+end
+```
+
+*app/views/users/index.html.haml*
+```haml
+= paginate @users # it will render tailwind-styled pagination buttons by default
+```
+
+Pagination buttons looks like [this](https://play.tailwindcss.com/mqgDS5l9oY)
+
 ## Contributing
 
 Install [lefthook](https://github.com/evilmartians/lefthook)
@@ -369,6 +414,7 @@ Install [lefthook](https://github.com/evilmartians/lefthook)
 ```
 bundle
 lefthook install
+rspec
 ```
 
 ## License

data/app/components/tailwind_component.rb

@@ -6,9 +6,9 @@ require 'view_component'
 class TailwindComponent < ViewComponent::Base
   extend Dry::Initializer[undefined: false]
 
-  option :template
+  option :input
   option :attribute
-  option :object_name
+  option :value, optional: true
   option :options
   option :label
   option :for

data/app/components/tailwinds/form/builder.rb

@@ -6,19 +6,33 @@ module Tailwinds
     # :reek:InstanceVariableAssumption
     class Builder < Tramway::Views::FormBuilder
       def text_field(attribute, **options, &)
-        render(Tailwinds::Form::TextFieldComponent.new(**default_options(attribute, options)), &)
+        render(Tailwinds::Form::TextFieldComponent.new(
+                 input: input(:text_field),
+                 value: get_value(attribute, options),
+                 **default_options(attribute, options)
+               ), &)
       end
 
       def password_field(attribute, **options, &)
-        render(Tailwinds::Form::TextFieldComponent.new(**default_options(attribute, options)), &)
+        render(Tailwinds::Form::TextFieldComponent.new(
+                 input: input(:password_field),
+                 **default_options(attribute, options)
+               ), &)
       end
 
       def file_field(attribute, **options, &)
-        render(Tailwinds::Form::FileFieldComponent.new(**default_options(attribute, options)), &)
+        input = super(attribute, **options.merge(class: :hidden))
+
+        render(Tailwinds::Form::FileFieldComponent.new(input:, **default_options(attribute, options)), &)
       end
 
       def select(attribute, collection, **options, &)
-        render(Tailwinds::Form::SelectComponent.new(**default_options(attribute, options).merge(collection:)), &)
+        render(Tailwinds::Form::SelectComponent.new(
+                 input: input(:select),
+                 value: options[:selected] || object.public_send(attribute),
+                 collection:,
+                 **default_options(attribute, options)
+               ), &)
       end
 
       def submit(action, **options, &)
@@ -27,11 +41,18 @@ module Tailwinds
 
       private
 
+      def input(method_name)
+        unbound_method = self.class.superclass.instance_method(method_name)
+        unbound_method.bind(self)
+      end
+
+      def get_value(attribute, options)
+        options[:value] || object.public_send(attribute)
+      end
+
       def default_options(attribute, options)
         {
-          template: @template,
           attribute:,
-          object_name:,
           label: label(attribute, options),
           for: for_id(attribute),
           options:

data/app/components/tailwinds/form/file_field_component.html.haml

@@ -1,4 +1,4 @@
 .mb-4
   %label.inline-block.bg-blue-500.hover:bg-blue-700.text-white.font-bold.py-2.px-4.rounded.cursor-pointer.mt-4{ for: @for }
     = @label
-  = @template.file_field @object_name, @attribute
+  = @input

data/app/components/tailwinds/form/file_field_component.rb

@@ -4,6 +4,7 @@ module Tailwinds
   module Form
     # Tailwind-styled file_field input
     class FileFieldComponent < TailwindComponent
+      option :input
     end
   end
 end

data/app/components/tailwinds/form/select_component.html.haml

@@ -1,4 +1,4 @@
 .mb-4
   %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
     = @label
-  = @template.select @object_name, @attribute, @collection, {}, @options.merge(class: 'bg-white border border-gray-300 text-gray-700 py-2 px-2 rounded-lg focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent')
+  = @input.call(@attribute, @collection, { selected: @value }, @options.merge(class: 'bg-white border border-gray-300 text-gray-700 py-2 px-2 rounded-lg focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent'))

data/app/components/tailwinds/form/text_field_component.html.haml

@@ -1,4 +1,4 @@
 .mb-4
   %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
     = @label
-  = @template.text_field @object_name, @attribute, **@options.merge(class: 'w-full px-3 py-2 border border-gray-300 rounded focus:outline-none focus:border-red-500')
+  = @input.call @attribute, **@options.merge(class: 'w-full px-3 py-2 border border-gray-300 rounded focus:outline-none focus:border-red-500'), value: @value

data/app/views/kaminari/_first_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "First" page
+-#  available local variables
+-#    url:           url to the first page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.first{ class: 'px-3 py-2 text-sm font-medium text-purple-700 bg-white rounded-md hover:bg-purple-100' }
+  = link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote

data/app/views/kaminari/_gap.html.haml

@@ -0,0 +1,8 @@
+-#  Non-link tag that stands for skipped pages...
+-#  available local variables
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.page.gap{ class: 'px-3 py-2 text-sm font-medium text-purple-700' }
+  = t('views.pagination.truncate').html_safe

data/app/views/kaminari/_last_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "Last" page
+-#  available local variables
+-#    url:           url to the last page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.last{ class: 'px-3 py-2 text-sm font-medium text-purple-700 bg-white rounded-md hover:bg-purple-100' }
+  = link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote

data/app/views/kaminari/_next_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "Next" page
+-#  available local variables
+-#    url:           url to the next page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.next{ class: 'px-3 py-2 text-sm font-medium text-purple-700 bg-white rounded-md hover:bg-purple-100' }
+  = link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote

data/app/views/kaminari/_page.html.haml

@@ -0,0 +1,14 @@
+-#  Link showing page number
+-#  available local variables
+-#    page:          a page object for "this" page
+-#    url:           url to this page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+- if page.current?
+  %span{class: "px-3 py-2 font-medium rounded-md bg-purple-500 text-white" }
+    = page
+- else
+  %span{class: "cursor px-3 py-2 font-medium text-purple-700 bg-white rounded-md hover:bg-purple-100"}
+    = link_to_unless page.current?, page, url, {remote: remote, rel: page.rel}

data/app/views/kaminari/_paginator.html.haml

@@ -0,0 +1,12 @@
+= paginator.render do
+  %nav.pagination.flex.items-center.justify-center.space-x-1
+    = first_page_tag unless current_page.first? 
+    = prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.display_tag?
+        = page_tag page
+      - elsif !page.was_truncated?
+        = gap_tag
+    = next_page_tag unless current_page.last?
+    = last_page_tag unless current_page.last?
+

data/app/views/kaminari/_prev_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "Previous" page
+-#  available local variables
+-#    url:           url to the previous page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.prev{ class: 'px-3 py-2 text-sm font-medium text-purple-700 bg-white rounded-md hover:bg-purple-100' }
+  = link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote

data/lib/tramway/base_form.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# :reek:ClassVariable { enabled: false }
 module Tramway
   # Provides form object for Tramway
   #
@@ -17,22 +18,40 @@ module Tramway
     end
 
     class << self
-      def property(attribute, _proc_obj = nil)
-        @properties ||= []
+      def inherited(subclass)
+        subclass.instance_variable_set(:@properties, [])
+
+        super
+      end
+
+      def property(attribute)
         @properties << attribute
 
         delegate attribute, to: :object
       end
 
       def properties(*attributes)
-        if attributes.any?
-          attributes.each do |attribute|
-            property(attribute)
-          end
-        else
-          @properties || []
+        attributes.any? ? __set_properties(attributes) : __properties
+      end
+
+      def __set_properties(attributes)
+        attributes.each do |attribute|
+          property(attribute)
         end
       end
+
+      def __properties
+        (__ancestor_properties + @properties).uniq
+      end
+
+      # :reek:ManualDispatch { enabled: false }
+      def __ancestor_properties(klass = superclass)
+        superklass = klass.superclass
+
+        return [] unless superklass.respond_to?(:properties)
+
+        klass.properties + __ancestor_properties(superklass)
+      end
     end
 
     def submit(params)

data/lib/tramway/config.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
+require 'anyway'
 require 'singleton'
 require 'tramway/configs/entity'
 
 module Tramway
   # Basic configuration of Tramway
   #
-  class Config
+  class Config < Anyway::Config
     include Singleton
 
-    def initialize
-      @entities = []
-    end
+    attr_config(
+      pagination: { enabled: false },
+      entities: []
+    )
 
     def entities=(collection)
-      @entities = collection.map do |entity|
+      super(collection.map do |entity|
         entity_options = entity.is_a?(Hash) ? entity : { name: entity }
 
         Tramway::Configs::Entity.new(**entity_options)
-      end
+      end)
     end
-
-    attr_reader :entities
   end
 end

data/lib/tramway/engine.rb

@@ -7,29 +7,65 @@ module Tramway
     isolate_namespace Tramway
 
     initializer 'tramway.load_helpers' do
+      load_navbar_helper
+      load_views_helper
+      load_decorator_helper
+      load_form_helper
+      configure_pagination if Tramway.config.pagination[:enabled]
+    end
+
+    private
+
+    def load_navbar_helper
       ActiveSupport.on_load(:action_view) do |loaded_class|
         require 'tramway/helpers/navbar_helper'
 
         loaded_class.include Tramway::Helpers::NavbarHelper
       end
+    end
 
+    def load_views_helper
       ActiveSupport.on_load(:action_view) do |loaded_class|
         require 'tramway/helpers/views_helper'
 
         loaded_class.include Tramway::Helpers::ViewsHelper
       end
+    end
 
+    def load_decorator_helper
       ActiveSupport.on_load(:action_controller) do |loaded_class|
         require 'tramway/helpers/decorate_helper'
 
         loaded_class.include Tramway::Helpers::DecorateHelper
       end
+    end
 
+    def load_form_helper
       ActiveSupport.on_load(:action_controller) do |loaded_class|
         require 'tramway/helpers/form_helper'
 
         loaded_class.include Tramway::Helpers::FormHelper
       end
     end
+
+    # :reek:NestedIterators { enabled: false }
+    # :reek:TooManyStatements { enabled: false }
+    def configure_pagination
+      ActiveSupport.on_load(:action_controller) do
+        # Detecting tramway views path
+        tramway_spec = Gem.loaded_specs['tramway']
+        tramway_views_path = File.join(tramway_spec.full_gem_path, 'app/views')
+
+        paths = view_paths.to_ary
+
+        # Determine index to insert tramway views path
+        rails_views_index = paths.find_index { |path| path.to_s.ends_with?('app/views') }
+        insert_index = rails_views_index ? rails_views_index + 1 : 0
+
+        # Inserting tramway views path
+        paths.insert(insert_index, tramway_views_path)
+        self.view_paths = paths
+      end
+    end
   end
 end

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '0.3.2'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -106,6 +106,13 @@ files:
 - app/components/tailwinds/nav/item_component.rb
 - app/components/tailwinds/navbar_component.html.haml
 - app/components/tailwinds/navbar_component.rb
+- app/views/kaminari/_first_page.html.haml
+- app/views/kaminari/_gap.html.haml
+- app/views/kaminari/_last_page.html.haml
+- app/views/kaminari/_next_page.html.haml
+- app/views/kaminari/_page.html.haml
+- app/views/kaminari/_paginator.html.haml
+- app/views/kaminari/_prev_page.html.haml
 - config/routes.rb
 - lib/rules/turbo_html_attributes_rules.rb
 - lib/tasks/tramway_tasks.rake