tramway 0.3.1.2 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0becd1c6b67984097bf36b6e6a2180792863ded76f5e28174ea213e3f5f85ddd
-  data.tar.gz: a74d5284069e8fa7c162b5c1dce27ba3fc85bb3558c0c934527b2365ab37bf8d
+  metadata.gz: 68a5dd780d7427b0c2075f140c891af3a4c33210c88a00d86e33279dc27e6c28
+  data.tar.gz: 63701d608f5545ea95e98fac522624cc34092199fe839b16ba579d9c461c0383
 SHA512:
-  metadata.gz: 45a89fec8a66c5e33f3321d18dfb7971bb0fe52f2c1984b86958453364af2c7327d8fba8a80a36f83e3cb40aa93da5aae2cd2b319658dbf1ca21cea122375692
-  data.tar.gz: e3087975aa2d174982434340b32964c39817c7a95baabbb0f912c54dbfda682e3c1270d6600896ac5ff9ad94c0bebbba59de4ea724933b96c2a1cb95efcb0861
+  metadata.gz: 8e6c295607acc32db6b7a0bea211ddb9ba2d8e2ca141804bce78b7b51fb74a08478c38ead05962f56ecd226a57b2e7398b97c86ac6dcc7aa46c3862bd8a49f30
+  data.tar.gz: bd89050c6d5b3391f457eea7a277cdaaa53c3fbe1f20a0567c39b659ab8a3187d2f161bed38a6b9226782191b884fe94eb63d7e7f8aa292e8ff121dcf149c521

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:
@@ -81,7 +82,7 @@ class UserDecorator < Tramway::BaseDecorator
 end
 ```
 
-#### Decorate single object
+#### Decorate a single object
 
 You can use the same method to decorate a single object either
 
@@ -91,6 +92,20 @@ def show
 end
 ```
 
+#### Decorate a collection of objects
+
+```ruby
+def index
+  @users = tramway_decorate User.all
+end
+```
+
+```ruby
+def index
+  @posts = tramway_decorate user.posts
+end
+```
+
 #### Decorate with a specific decorator
 
 You can implement a specific decorator and ask Tramway to decorate with it
@@ -334,6 +349,7 @@ Tramway provides `tramway_form_for` helper that renders Tailwind-styled forms by
 = tramway_form_for User.new do |f|
   = f.text_field :text
   = f.password_field :password
+  = f.select :role, [:admin, :user]
   = f.file_field :file
   = f.submit "Create User"
 ```
@@ -344,8 +360,35 @@ Available form helpers:
 * text_field
 * password_field
 * file_field
+* 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)
@@ -353,6 +396,7 @@ Install [lefthook](https://github.com/evilmartians/lefthook)
 ```
 bundle
 lefthook install
+rspec
 ```
 
 ## License

data/app/components/tailwind_component.rb

@@ -4,4 +4,12 @@ require 'view_component'
 
 # Base TailwindComponent. Contains base features for all tailwind components
 class TailwindComponent < ViewComponent::Base
+  extend Dry::Initializer[undefined: false]
+
+  option :input
+  option :attribute
+  option :value, optional: true
+  option :options
+  option :label
+  option :for
 end

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

@@ -3,21 +3,36 @@
 module Tailwinds
   module Form
     # Provides Tailwind-styled forms
+    # :reek:InstanceVariableAssumption
     class Builder < Tramway::Views::FormBuilder
       def text_field(attribute, **options, &)
-        input = super(attribute, **options.merge(class: text_input_class))
-        render(Tailwinds::Form::TextFieldComponent.new(input, attribute, object_name:, **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, &)
-        input = super(attribute, **options.merge(class: text_input_class))
-        render(Tailwinds::Form::TextFieldComponent.new(input, attribute, object_name:, **options), &)
+        render(Tailwinds::Form::TextFieldComponent.new(
+                 input: input(:password_field),
+                 **default_options(attribute, options)
+               ), &)
       end
 
       def file_field(attribute, **options, &)
         input = super(attribute, **options.merge(class: :hidden))
 
-        render(Tailwinds::Form::FileFieldComponent.new(input, attribute, object_name:, **options), &)
+        render(Tailwinds::Form::FileFieldComponent.new(input:, **default_options(attribute, options)), &)
+      end
+
+      def select(attribute, collection, **options, &)
+        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, &)
@@ -26,8 +41,31 @@ module Tailwinds
 
       private
 
-      def text_input_class
-        'w-full px-3 py-2 border border-gray-300 rounded focus:outline-none focus:border-red-500'
+      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)
+        {
+          attribute:,
+          label: label(attribute, options),
+          for: for_id(attribute),
+          options:
+        }
+      end
+
+      # :reek:UtilityFunction
+      def label(attribute, options)
+        options[:label] || attribute.to_s.humanize
+      end
+
+      def for_id(attribute)
+        "#{object_name}_#{attribute}"
       end
     end
   end

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

@@ -4,11 +4,7 @@ module Tailwinds
   module Form
     # Tailwind-styled file_field input
     class FileFieldComponent < TailwindComponent
-      def initialize(input, attribute, object_name: nil, **options)
-        @label = options[:label] || attribute.to_s.capitalize
-        @for = "#{object_name}_#{attribute}"
-        @input = input
-      end
+      option :input
     end
   end
 end

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

@@ -0,0 +1,4 @@
+.mb-4
+  %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
+    = @label
+  = @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/select_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Tailwind-styled text field
+    class SelectComponent < TailwindComponent
+      option :collection
+    end
+  end
+end

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
-  = @input
+  = @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/components/tailwinds/form/text_field_component.rb

@@ -4,11 +4,6 @@ module Tailwinds
   module Form
     # Tailwind-styled text field
     class TextFieldComponent < TailwindComponent
-      def initialize(input, attribute, object_name: nil, **options)
-        @label = options[:label] || attribute.to_s.humanize
-        @for = "#{object_name}_#{attribute}"
-        @input = input
-      end
     end
   end
 end

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

@@ -12,6 +12,8 @@ module Tramway
 
     def initialize(object)
       @object = object
+
+      self.class.delegate object.class.primary_key, to: :object
     end
 
     class << self

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/decorators/collection_decorator.rb

@@ -14,7 +14,7 @@ module Tramway
       end
 
       def collection?(object)
-        object.class.name.in? ['ActiveRecord::Relation', 'Array']
+        object.is_a?(Array) || object.is_a?(ActiveRecord::Relation)
       end
     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.1.2'
+  VERSION = '0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.3.1.2
+  version: '0.4'
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-23 00:00:00.000000000 Z
+date: 2024-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -96,6 +96,8 @@ files:
 - app/components/tailwinds/form/builder.rb
 - app/components/tailwinds/form/file_field_component.html.haml
 - app/components/tailwinds/form/file_field_component.rb
+- app/components/tailwinds/form/select_component.html.haml
+- app/components/tailwinds/form/select_component.rb
 - app/components/tailwinds/form/submit_button_component.html.haml
 - app/components/tailwinds/form/submit_button_component.rb
 - app/components/tailwinds/form/text_field_component.html.haml
@@ -104,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