🦆 Ducktrails

Automatically generates breadcrumbs based on routes.

Warning: This API is still alpha; we welcome PRs and ideas as issues.

Usage

For basic applications using a restful architecture, ducktrails should generate the breadcrumbs automatically.

For example, if the uri is /users/#{user-id}/posts/#{post-id} Putting <%= breadcrumbs %> in the (erb) view.

Would render:

Home / All Users / user-name / All Posts / post-name

Simply include = breadcrumbs in your view. breadcrumbs takes a block argument. The block isn't required but if you want to set some objects for the uri resources (recommend) you can follow the guide below.

Resources are inferred and will be used to manipulate each URI segment. If a resource is not found, Ducktrails will fallback to the URI.

Possible keys for a breadcrumb resource are: resource, key, policy, collection_prefix. The key and collection prefix can be configured in the Ducktrails.rb initializer described below.

<%=breadcrumbs do
    {
      users: {
        resource: @user,
        key: :first_name,
        collection_prefix: 'Some'
      }
    }
  end
%>

Will output

Action	Breadcrumb
index	`Home / Some Users`
show	`Home / Some Users / Kevin`
new	`Home / Some Users / New`
edit	`Home /Some Users / Kevin / edit`

Installation

Add this line to your application's Gemfile:

gem 'ducktrails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ducktrails

Configuration

Ducktrails provides a standard initializer file: Note: Currently ducktrails is the only template theme provided

Ducktrails.configure do |config|
  config.root_path = '/'
  config.home_name = 'Home'
  config.collection_prefix = 'All'
  config.default_key = :id
  config.theme = 'ducktrails'
end

Contributing

Please refer to each project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
bundle
Create the test db bundle exec rake --rakefile test/dummy/Rakefile db:setup
bundle exec rake to test.
Ensure your test coverage is A+
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

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

ProctorU / ducktrails