templates-rails 0.1.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba3404b80094f0d0f90ed138958043745a3baa8ce34dc8d53f8b23687a35110
-  data.tar.gz: 391039bac56e0ea87e23095ff32a99698a31c9d700e2baf99e7ff21129e87ba0
+  metadata.gz: e9a04898081b6a1962d47d73e9d1e1a328e10dc957135808f8da06335fd3a43b
+  data.tar.gz: 770942c7484c6174911b7e4653c2f32bbfdfc63d5f0c296e710b717ed29c1c7f
 SHA512:
-  metadata.gz: cffb5d6fdab47c90b9490cbe1a7ef46f259acc9cc700651cca738eb1b1bbd549dc14cddb9893e46f7bb7303f17450be9fc48e80f1a0f9d4cf723eab150dadd53
-  data.tar.gz: b8cf1abb68cdae12b7a18c19a087c187657419f149b866b2b7292edeb2d3911b43a4ec61499d2aefdad4bb38ea64d0bd785ebdad0c83f9c826053733a6a4eac7
+  metadata.gz: b99c74fc2347ef62109b75abb0f660a189dbafa9cff3a1c1d5346ad32c309326b883e6d3ac24792ed938408195b1543f1bab8c96aaf332a42780fb8f85f0a9dc
+  data.tar.gz: f343e9a9d4900b4fb5df9135400646615e82a8b5da5159dd020b83fdf828cfc6a005a72eb1212eb579d3c2996253281a225ab565df280d497fac7d6b156079f7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Changelog
 
+### 0.2.1 - 07-05-2026
+* **Bug fix**: Move the engine's bundled `index` and `nested_index` views from `app/views/templates/` to `app/views/templates/templates/` (matching the namespaced `Templates::TemplatesController` view path). Host apps with their own `app/views/templates/` views were shadowing the engine's templates, causing `MissingTemplate` errors at the engine root. No host-app changes are needed — Rails resolves the views via the controller's natural lookup path.
+
+### 0.2.0 - 07-05-2026
+* **Breaking**: `TemplatesController` is now namespaced as `Templates::TemplatesController` to avoid collisions with controllers of the same name in host apps. Routes inside the engine point at `templates/templates#index` / `templates/templates#show` automatically; no host-app changes are needed unless you reference the controller class directly.
+* Added `Templates.mount_at` (default `/templates`) — configures the auto-mount path
+* Added `Templates.views_path` (default `templates`) — configures the directory under `app/views/` that the engine scans and renders from. Lets you point the engine at an existing styleguide views tree without moving files
+* Added `Templates.auto_mount` (default `true`) — set to `false` to mount the engine manually in the host app's `routes.rb` (e.g. behind a namespace or auth constraint)
+
 ### 0.1.5 - 14-07-2023
 * Added `Templates.parent_controller` configuration option
 * Fixed CI and updated checkout/branch strategy from V2 to V3

data/README.md

@@ -18,10 +18,34 @@ Or install it yourself as:
 
 
 ## Setup
-To override the default inheritance controller for e.g. compatibility with tenant based applications where there is a differently named inheritance controller copy the line below to your desired environment (most likely `development.rb`). Our default is set to `ApplicationController` as it's commonly used. If you don't have an `ApplicationController`, set the `parent_controller` to e.g. `ActionController::Base`
+
+All configuration can go in an initializer (e.g. `config/initializers/templates.rb`) or in an environment file like `config/environments/development.rb`. All options have sensible defaults — set only what you need to change.
 
 ```ruby
+# Parent controller for Templates::TemplatesController. Default: 'ApplicationController'.
+# Change this for tenant-based apps or when you don't have an ApplicationController
+# (e.g. set to 'ActionController::Base').
 Templates.parent_controller = 'ApplicationController'
+
+# Path the engine mounts at. Default: '/templates'.
+Templates.mount_at = '/admin/styleguide'
+
+# Directory under app/views/ that the engine reads templates from. Default: 'templates'.
+# Set this to point the engine at an existing views tree without moving files.
+Templates.views_path = 'admin/styleguide'
+
+# When true (default) the engine auto-mounts at `Templates.mount_at`. Set to false to
+# mount manually in your routes.rb — useful when you only want the styleguide
+# available locally, or want to mount it inside a scope/constraint.
+Templates.auto_mount = false
+```
+
+If you set `auto_mount = false`, mount the engine yourself. A common pattern is
+to expose the styleguide only in development and test:
+
+```ruby
+# config/routes.rb
+mount Templates::Engine => '/admin/styleguide' if Rails.env.local?
 ```
 
 ## TODO

data/app/controllers/templates/templates_controller.rb

@@ -0,0 +1,15 @@
+module Templates
+  class TemplatesController < Templates.parent_controller.constantize
+    def index
+      render template: 'templates/templates/index', layout: 'templates/index'
+    end
+
+    def show
+      if params[:id].present? && File.directory?("./app/views/#{Templates.views_path}/#{params[:id]}")
+        render template: 'templates/templates/nested_index', layout: 'templates/index'
+      else
+        render "#{Templates.views_path}/#{params[:id]}", layout: 'templates/show'
+      end
+    end
+  end
+end

data/app/views/templates/{index.html.erb → templates/index.html.erb}

@@ -1,7 +1,7 @@
 <% provide(:title, 'Templates') %>
 
 <div>
-  <% Dir.children('./app/views/templates').excluding('partials').sort.each do |child| %>
+  <% Dir.children("./app/views/#{Templates.views_path}").excluding('partials').sort.each do |child| %>
     <%= link_to child.chomp('.html.erb').humanize.titleize, templates_engine.template_path(child.chomp('.html.erb')), class: 'button button--blue' %>
   <% end %>
 </div>

data/app/views/templates/{nested_index.html.erb → templates/nested_index.html.erb}

@@ -1,7 +1,7 @@
 <% provide(:title, params[:id].gsub('/', ' / ').titleize) %>
 
 <div>
-  <% Dir.children("./app/views/templates/#{params[:id]}").excluding('partials').sort.each do |child| %>
+  <% Dir.children("./app/views/#{Templates.views_path}/#{params[:id]}").excluding('partials').sort.each do |child| %>
     <%= link_to child.chomp('.html.erb').humanize.titleize, templates_engine.template_path('') + params[:id] + '/' + child.chomp('.html.erb'), class: 'button button--blue' %>
   <% end %>
 </div>

data/config/routes.rb

@@ -1,4 +1,4 @@
 Templates::Engine.routes.draw do
-  root 'templates#index'
-  get ':id', to: 'templates#show', as: :template, constraints: { id: /.*/ }
+  root 'templates/templates#index'
+  get ':id', to: 'templates/templates#show', as: :template, constraints: { id: /.*/ }
 end

data/lib/templates/engine.rb

@@ -1,8 +1,10 @@
 module Templates
   class Engine < ::Rails::Engine
     initializer 'templates', before: :load_config_initializers do
-      Rails.application.routes.append do
-        mount Templates::Engine => '/templates'
+      if Templates.auto_mount
+        Rails.application.routes.append do
+          mount Templates::Engine => Templates.mount_at
+        end
       end
     end
 

data/lib/templates/version.rb

@@ -1,3 +1,3 @@
 module Templates
-  VERSION = '0.1.6'
+  VERSION = '0.2.1'
 end

data/lib/templates-rails.rb

@@ -7,4 +7,22 @@ module Templates
   # It needs to be a string so the parent controller reloads whenever there are changes in development.
   mattr_accessor :parent_controller
   @@parent_controller = 'ApplicationController'
+
+  # Path the engine mounts at. Used when `auto_mount` is true and as the default
+  # for users who mount the engine themselves.
+  mattr_accessor :mount_at
+  @@mount_at = '/templates'
+
+  # Directory under `app/views/` that the engine reads templates from. Used both
+  # for `Dir.children` listings on the index/nested_index pages and for the
+  # `render` paths in the controller. Set this to use an existing views tree
+  # without moving files.
+  mattr_accessor :views_path
+  @@views_path = 'templates'
+
+  # When true (default), the engine appends a mount point at `Templates.mount_at`
+  # during initialization. Set to false to mount manually in the host app's
+  # routes.rb (e.g. inside a namespace or behind authentication constraints).
+  mattr_accessor :auto_mount
+  @@auto_mount = true
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: templates-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - Lukasz Czapiewski
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,9 +29,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
-description: A templating system for creating and making design decisions for your
-  Rails application. Make your design decisions before you build your application
-  views.
+description: Create View templates and bootstrap interfaces in HTML without controllers.
+  A system for creating and making design decisions. Make design decisions before
+  building your app.
 email:
 - luke@mmtm.io
 executables: []
@@ -43,11 +42,11 @@ files:
 - README.md
 - app/assets/config/templates_manifest.js
 - app/assets/stylesheets/templates/application.css
-- app/controllers/templates_controller.rb
+- app/controllers/templates/templates_controller.rb
 - app/views/layouts/templates/index.html.erb
 - app/views/layouts/templates/show.html.erb
-- app/views/templates/index.html.erb
-- app/views/templates/nested_index.html.erb
+- app/views/templates/templates/index.html.erb
+- app/views/templates/templates/nested_index.html.erb
 - config/routes.rb
 - lib/install/templates.rb
 - lib/tasks/templates_tasks.rake
@@ -61,7 +60,6 @@ metadata:
   homepage_uri: https://github.com/Ancez/templates-rails
   source_code_uri: https://github.com/Ancez/templates-rails
   changelog_uri: https://github.com/Ancez/templates-rails/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,9 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
-summary: Simple to use templating system for your Rails application. Design your views
-  before implementation.
+summary: View templating system for your Rails application. Design your app.
 test_files: []

data/app/controllers/templates_controller.rb

@@ -1,13 +0,0 @@
-class TemplatesController < Templates.parent_controller.constantize
-  def index
-    render :index, layout: 'templates/index'
-  end
-
-  def show
-    if params[:id].present? && File.directory?("./app/views/templates/#{params[:id]}")
-      render :nested_index, layout: 'templates/index'
-    else
-      render "templates/#{params[:id]}", layout: 'templates/show'
-    end
-  end
-end