tramway 0.5.1 → 0.5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd54b0a803c53d12e50ec585a805ca39dc56b0551e12fa2de66514a9166b750
-  data.tar.gz: 7db6cfe3b24afaed951ac2ca2b52eb65d38bf0bdb49d6625f8508fa2dc594e52
+  metadata.gz: f2716febb35463e08d23262e008c607f0114f5cc49d1734ecbed30c3133e9e06
+  data.tar.gz: 408cfb199f328e21f03f2d99eb04c6a16d5eb875709dede6c2a71292ebb7647b
 SHA512:
-  metadata.gz: a4d807fffc40d7e2cdfd9fec0b513f39f4a4338cd9ea1718d4ece1d0587bc1d86aa26112688ec9fb5e108ed1a04fac01f7f79ae7852f105fb132e4b9361550a3
-  data.tar.gz: 45ac2aec489c85b212938ae99456fe8e5fc54f804cc9525aee1f034c5586d0e080e3c58fd9593f3779aabce5f2c5941ff36198183e81880f23f5d3a4b871aa98
+  metadata.gz: bf77038d704285581baf87b69900c4af9ecf06c6cf5b158c68062ce92c7c8414f3b3e9a1bc77eafe730dfe709b432ba4c5633ba162873d67ec8e7e26004aac7e
+  data.tar.gz: 3ea8c39ac64b9571779c8684d209188c5255c9820967eddfd528f0f5d4d3d66ff0645fd2e62d3906501b432d48393d1cfa7a99a23bda9bdf3382fa8aa3293ff7

data/README.md

@@ -2,6 +2,7 @@
 Unite Ruby on Rails brilliance. Streamline development with Tramway.
 
 * [Installation](https://github.com/Purple-Magic/tramway#installation)
+* [Getting Started](https://github.com/Purple-Magic/tramway?tab=readme-ov-file#getting-started)
 * [Usage](https://github.com/Purple-Magic/tramway#usage)
   * [Tramway Entities](https://github.com/Purple-Magic/tramway#tramway-entities)
   * [Tramway Decorators](https://github.com/Purple-Magic/tramway#tramway-decorators)
@@ -17,6 +18,8 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem "tramway"
+gem "haml-rails"
+gem "kaminari"
 gem "view_component"
 ```
 
@@ -26,8 +29,71 @@ OR
 bundle add tramway view_component
 ```
 
+## Getting Started
+
+**Step 1**
+
+*config/initializers/tramway.rb*
+```ruby
+Tramway.configure do |config|
+  config.entities = [
+    {
+      name: :user,
+      pages: [:index],
+    }
+  ]
+end
+```
+
+**Step 2**
+
+*config/routes.rb*
+
+```ruby
+Rails.application.routes.draw do
+  mount Tramway::Engine, at: '/'
+end
+```
+
+**Step 3**
+
+```ruby
+class UserDecorator < Tramway::BaseDecorator
+  def self.list_attributes
+    [:id, :email, :created_at]
+  end
+end
+```
+
+**Step 4**
+
+Copy this [file](https://github.com/Purple-Magic/tramway/blob/main/config/tailwind.config.js) to config/tailwind.config.js
+
+
+**Step 5**
+
+Run tailwincss-rails compiler
+
+
+```bash
+bin/rails tailwindcss:build
+```
+
+**Step 6**
+
+Run your server
+
+```bash
+bundle exec rails s
+```
+
+**Step 7**
+
+Open [http://localhost:3000/users](http://localhost:3000/users)
+
 ## Usage
 
+
 ### Tramway Entities
 
 Tramway is an entity-based framework. **Entity** is the class on whose objects actions be applied: _index, show, create, update, and destroy_. Tramway will support numerous classes as entities. For now, Entity could be only **ActiveRecord::Base** class.

data/app/components/tailwinds/table/row_component.html.haml

@@ -3,7 +3,7 @@
   - cols = cells.count.times.map { |item| "1fr" }.join(",")
 
   -# desktop view
-  = row_tag class: "div-table-row block grid gap-4 bg-white border-b dark:bg-gray-800 dark:border-gray-700 grid-cols-[#{cols}]" do
+  = row_tag class: "div-table-row block grid gap-4 bg-white border-b dark:bg-gray-800 dark:border-gray-700 cursor-pointer hover:bg-purple-100 grid-cols-[#{cols}]" do
     - cells.each do |(_, value)|
       .div-table-cell.px-6.py-4.font-medium.text-gray-900.whitespace-nowrap.dark:text-white.sm:text-xs.text-base
         = value

data/app/controllers/tramway/entities_controller.rb

@@ -3,6 +3,10 @@
 module Tramway
   # Main controller for entities pages
   class EntitiesController < Tramway.config.application_controller.constantize
+    prepend_view_path "#{Gem::Specification.find_by_name('tramway').gem_dir}/app/views"
+
+    layout 'tramway/layouts/application'
+
     helper Tramway::ApplicationHelper
     include Rails.application.routes.url_helpers
 
@@ -13,7 +17,7 @@ module Tramway
     private
 
     def model_class
-      @model_class ||= params[:entity].classify.constantize
+      @model_class ||= params[:entity][:name].classify.constantize
     end
   end
 end

data/app/views/tramway/entities/index.html.haml

@@ -1,7 +1,7 @@
 - decorator = Tramway::Decorators::NameBuilder.default_decorator_class_name(@model_class)
 - list_attributes = decorator.constantize.list_attributes
 
-.w-full
+.mt-8{ class: 'w-2/3' }
   - content_for :title, page_title
 
   .flex.justify-between.items-center.md:mt-4.mt-2
@@ -16,10 +16,10 @@
       You should fill class-level method `self.list_attributes` inside your
       = decorator
 
-= component 'tailwinds/table' do
-  = component 'tailwinds/table/header', headers: list_attributes.map { |attribute| @model_class.human_attribute_name(attribute) }
-  - @entities.each do |item|
-    = render 'entity', entity: item
+  = component 'tailwinds/table' do
+    = component 'tailwinds/table/header', headers: list_attributes.map { |attribute| @model_class.human_attribute_name(attribute) }
+    - @entities.each do |item|
+      = render 'entity', entity: item
 
-  .flex.mt-4
-    = paginate @entities
+    .flex.mt-4
+      = paginate @entities

data/app/views/tramway/layouts/application.html.haml

@@ -0,0 +1,26 @@
+%html
+  %head
+    %title= content_for(:title) || "Tramway"
+    %meta{name: "viewport", content: "width=device-width,initial-scale=1"}
+    %meta{name: "apple-mobile-web-app-capable", content: "yes"}
+    %meta{name: "mobile-web-app-capable", content: "yes"}
+    = csrf_meta_tags
+    = csp_meta_tag
+
+    = yield :head
+
+    / Enable PWA manifest for installable apps (make sure to enable in config/routes.rb too!)
+    / = tag.link rel: "manifest", href: pwa_manifest_path(format: :json)
+
+    %link{rel: "icon", href: "/icon.png", type: "image/png"}
+    %link{rel: "icon", href: "/icon.svg", type: "image/svg+xml"}
+    %link{rel: "apple-touch-icon", href: "/icon.png"}
+
+    / Includes all stylesheet files in app/assets/stylesheets
+    = stylesheet_link_tag "tailwind", "data-turbo-track": "reload"
+
+  %body.bg-gray-100
+    = tramway_navbar title: 'Tramway'
+
+    .container.mx-auto.p-4.flex.align-center.justify-center
+      = yield

data/config/routes.rb

@@ -2,6 +2,29 @@
 
 Tramway::Engine.routes.draw do
   Tramway.config.entities.each do |entity|
-    resources entity.name.pluralize.to_sym, only: entity.pages, controller: :entities, defaults: { entity: entity.name }
+    define_resource = lambda do |resource_name, entity| # rubocop:disable Lint/ShadowingOuterLocalVariable
+      resources resource_name.pluralize.to_sym,
+                only: [:index],
+                controller: '/tramway/entities',
+                defaults: { entity: }
+    end
+
+    if entity.name.include?('/')
+      *namespaces, resource_name = entity.name.split('/')
+
+      define_namespace = lambda do |index|
+        namespace namespaces[index].to_sym do
+          if namespaces[index] == namespaces.last
+            define_resource.call(resource_name, entity)
+          else
+            define_namespace.call(namespaces[index + 1])
+          end
+        end
+      end
+
+      define_namespace.call(0)
+    else
+      define_resource.call(entity.name, entity)
+    end
   end
 end

data/config/tailwind.config.js

@@ -0,0 +1,61 @@
+const defaultTheme = require('tailwindcss/defaultTheme');
+
+module.exports = {
+  darkMode: 'class',
+  content: [
+    './public/*.html',
+    './app/components/**/*.html.haml',
+    './app/helpers/**/*.rb',
+    './app/javascript/**/*.js',
+    './app/views/**/*.{erb,haml,html,slim}'
+  ],
+  theme: {
+    extend: {
+      screens: {
+        ...defaultTheme.screens,
+      },
+    },
+  },
+  safelist: [
+    'div-table',
+    'div-table-row',
+    'div-table-cell',
+    'hidden',
+    'text-xl',
+    'text-4xl',
+    'font-bold',
+    'xl:hidden',
+    'grid-cols-[1fr]',
+    'grid-cols-[1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr,1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr,1fr,1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr,1fr,1fr,1fr,1fr,1fr]',
+    'grid-cols-[1fr,1fr,1fr,1fr,1fr,1fr,1fr,1fr,1fr,1fr]',
+    'text-right',
+    'w-2/3',
+    'flex',
+    // multiselect styles
+    'absolute', 'shadow', 'top-100', 'z-40', 'w-full', 'lef-0', 'rounded', 'max-h-select', 'overflow-y-auto', 'cursor-pointer', 'rounded-t', 'border-b', 'hover:bg-teal-100', 'items-center', 'border-transparent', 'border-l-2,', 'relative', 'hover:border-teal-100', 'leading-6', 'bg-transparent', 'appearance-none', 'outline-none', 'h-full' , 'justify-center', 'm-1', 'font-medium', 'rounded-full', 'text-teal-700', 'bg-teal-100', 'border', 'border-teal-300', 'text-xs', 'font-normal', 'leading-none', 'max-w-full', 'flex-initial', 'flex-auto', 'flex-row-reverse',, 'flex-col', 'min-w-96', 'w-fit', 'flex-wrap', 'w-8', 'border-l',
+    {
+      pattern: /(text|bg|border)-(purple|blue|gray|yellow|red|white|green)-\d+/,
+      variants: ['dark', 'focus', 'hover', 'dark:hover'],
+    },
+    {
+      pattern: /(text|bg)-(purple|blue|gray|yellow|red|white)/,
+      variants: ['dark', 'focus', 'hover', 'dark:hover'],
+    },
+    {
+      pattern: /(m|p)(l|r|b|t|x|y)-\d+/
+    },
+  ],
+  plugins: [
+    require('@tailwindcss/forms'),
+    require('@tailwindcss/aspect-ratio'),
+    require('@tailwindcss/typography'),
+    require('@tailwindcss/container-queries'),
+  ],
+};

data/lib/tramway/base_decorator.rb

@@ -57,5 +57,24 @@ module Tramway
     end
 
     def show_path = nil
+
+    # :reek:ManualDispatch { enabled: false } because there is the idea to manual dispatch
+    def method_missing(method_name, *, &)
+      url_helpers = Rails.application.routes.url_helpers
+
+      if method_name.to_s.end_with?('_path', '_url')
+        return url_helpers.public_send(method_name, *, &) if url_helpers.respond_to?(method_name)
+
+        raise NoMethodError, "undefined method `#{method_name}` for #{self}" unless respond_to_missing?(method_name)
+
+      end
+
+      super
+    end
+
+    # :reek:BooleanParameter { enabled: false } because it's a part of the duck-typing
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.end_with?('_path', '_url') || super
+    end
   end
 end

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.1.2
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +191,9 @@ files:
 - app/views/kaminari/_prev_page.html.haml
 - app/views/tramway/entities/_entity.html.haml
 - app/views/tramway/entities/index.html.haml
+- app/views/tramway/layouts/application.html.haml
 - config/routes.rb
+- config/tailwind.config.js
 - lib/rules/turbo_html_attributes_rules.rb
 - lib/tasks/tramway_tasks.rake
 - lib/tramway.rb