Roda::HashBranchViewNamespace

roda-hash_branch_view_namespace is a Roda plugin that automatically appends subdirectories to your view template search path (append_view_subdir) matching your hash branch names and namespaces when routing requests.

It builds upon Roda's built-in hash_branches and view_options plugins to streamline organizing template views according to your hash branch namespace hierarchy.

Add this line to your application's Gemfile:

gem "roda-hash_branch_view_namespace"

And then execute:

bundle install

Or install it directly:

gem install roda-hash_branch_view_namespace

Enable the plugin in your Roda application:

class App < Roda
  plugin :render, views: "views"
  plugin :hash_branch_view_namespace

  route do |r|
    r.hash_branches

    r.on "admin" do
      r.hash_branches :admin
    end
  end
end

When you define a hash branch with hash_branch, the plugin automatically calls append_view_subdir("#{namespace}/#{segment}") before executing the branch block.

# Views will automatically look into views/users/
hash_branch("users") do |r|
  # Calls append_view_subdir("users")
  view("index") # renders views/users/index.erb
end

# Views will automatically look into views/admin/users/
hash_branch(:admin, "users") do |r|
  # Calls append_view_subdir("admin/users")
  view("index") # renders views/admin/users/index.erb
end

1. Loads the hash_branches and view_options plugins automatically.
2. Wraps route definitions created via hash_branch(namespace, segment) to automatically execute append_view_subdir prior to yielding control to your route block.
3. Fully supports route redefinition, route removal, subclassing/inheritance, and app freezing (App.freeze).

After checking out the repository, run:

bin/setup

To run the test suite:

bundle exec rake spec

For an interactive prompt to experiment:

bin/console

Bug reports and pull requests are welcome on GitHub at https://github.com/roda-project/roda-hash_branch_view_namespace.

The gem is available as open source under the terms of the MIT License.