jensljungblad / elemental_styleguide Goto Github PK

Since the name "styleguide" is already used/blocked on rubygems we should probably find a new name, rename the project/files and work towards an offical release on rubygems?

@jensljungblad do you have any names on your mind already?

While following your README I just stumbled across the wrong namespace
for the install generator. Currently it says to use the bin/rails g components:install generator,
which actually is named bin/rails g styleguide:install ;)

While experimenting with the gem I regularly managed to receive this error:

NameError in Styleguide::Pages#show - undefined local variable or method `navigation' for Class ...

I can reproduce it by following these steps:

1. start rails server (freshly) bin/rails s
2. browse to a controller/action from my rails project e.g. localhost:3000/pages/index
3. browse to the styleguide e.g. localhost:3000/styleguide (thats where I mounted the engine)

The error occurs during the third step.

The error does not show up if I browse the styleguide immediately after starting the server.

The .call method signature of rails template handlers has changed between rails 5 and 6.

Rails 5: (see: https://github.com/rails/rails/blob/5-2-stable/actionview/lib/action_view/template/handlers/html.rb)

def call(template)

Rails 6:
(see: https://github.com/rails/rails/blob/6-0-stable/actionview/lib/action_view/template/handlers/html.rb)

def call(template, source)

Since the "new" renamed ElementalStyleguide::MarkdownHandler currently uses the rails 6 method signature, users trying to view the styleguide in rails 5 receive the following error:

ActionView::Template::Error (wrong number of arguments (given 1, expected 2))

Currently the styleguide:install generator copies the styleguide/example.html.erb file and directory directly into the rails app/ directory - which leads to a "missing template" error while rendering the styleguide.

Current location: /app/layouts/styleguide/example.html.erb (with error)
"Conventional" location: /app/views/layouts/styleguide/example.html.erb (without error)

Currently we mix in helpers from the main application in the ExamplesController class. However, things like routes get prefixed with the engine name regardless. Is there a better way to have the example be executed in the context of the application, which is what we want?

Currently examples are Base64 encoded, then passed to the iframe which, as part of the examples_controller#show method, decodes it and evaluates the erb. This is obviously not a good idea, since anyone with access to the style guide can execute any erb they want. That is why the style guide should currently not be used in a production environment, and is considered experimental.

So, we should figure out a better way to pass and evaluate the erb to the iframe.