breadcrumb_helper 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bbd36c4cc2857a4e4b8c9c60aa0fc56f8f541e36a5cdaaba7e2ff01d227e024
-  data.tar.gz: ee46ee95fd366635e758df07725d1ffe078cb0c7a7c8ed9d13b078497a9afd50
+  metadata.gz: 3931b76ff470a9c63291b8aea824a303adc155c6c238e8318c3192607a9b43f1
+  data.tar.gz: 45718826d12b2a2961af56fe250a3927c4aacb72126c26c1a225e3403338eb49
 SHA512:
-  metadata.gz: 36867717f2dd6337899e2d70f65ca150c7499f6abb821afd0788651852f135b5779a1dbffe3460a522646f7eaebc1bfed778b34f8f1894162b15d116b16d463f
-  data.tar.gz: dc8a21f2648139a9c3cc473c904a6793c70334d11e6a372b194a2c07abd468da286129be47f51dcb25017cea0d049acadd37b98f45dfba91cc636995b272bfb9
+  metadata.gz: a7d6217f08eea2596a885dc4716dc6d2e538fb6fae02992d1e8adf1f5deb1d896b22369d85d61fe448ce1a30e6ad70705af8a0ada32ec9259be6612a7d269299
+  data.tar.gz: ace507d1dad54a246864fe3a22deb1ed00bc5efa760c384cf18f33e00c8324d64c3bd8ebf5604deeabddf167812954afe0e3be5ca34683cd920b26585f8eb657

data/README.md

@@ -1,34 +1,105 @@
-# BreadcrumbHelper
+# Breadcrumb Helper for Rails
 
-TODO: Delete this and the text below, and describe your gem
+## Installation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/breadcrumb_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
+Add this to your Gemfile:
 
-## Installation
+```bash
+gem 'breadcrumb_helper', '~> 0.1'
+```
+
+## Usage
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+### Generate the files
 
-Install the gem and add to the application's Gemfile by executing:
+To start, use the provided generator for a simplified and streamlined workflow:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+rails generate breadcrumbs namespace
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+For example:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+rails generate breadcrumbs test/namespace
+```
+will generate the following files in `test/namespace` folder structure respectively.
+1. `app/helpers/concerns/breadcrumb_helper/test/namespace.rb`
+2. `app/views/test/namespace/_breadcrumbs.html.erb`
+3. `app/views/test/namespace/_breadcrumb_items.html.erb`
 
-## Usage
+### Structuring the breadcrumbs
+
+The generator will provide a file inside `concerns` folder of `helpers`. This should be included (`include`) or prepended (`prepend`) to your helper files. Assume that we have a `Test::Namespace::SomeController` with `show` and `index` actions. There should exist a `Test::Namespace::SomeHelper` file that includes or prepends the `BreadcrumbHelper::Test::Namespace` module.
+
+```ruby
+module Test::Namespace
+  module SomeHelper
+    include BreadcrumbHelper::Test::Namespace
+    # or prepend BreadcrumbHelper::Test::Namespace
+
+    # ...
+  end
+end
+```
+
+Since `SomeController` have `show` and `index` actions, our helper can define breadcrumbs for each action as such:
+
+```ruby
+module Test::Namespace
+  module SomeHelper
+    include BreadcrumbHelper::Test::Namespace
+
+    def index_breadcrumbs
+      add_breadcrumb name: 'Home'
+    end
+
+    def show_breadcrumbs
+      add_breadcrumb name: 'Home', path: root_path
+      add_breadcrumb name: 'Specific Data'
+    end
+  end
+end
+```
+
+With this setup, the controller's `index` and `show` actions will have their respective breadcrumbs rendered as defined in your helper.
+
+### Render the breadcrumbs
+
+Somewhere in your `layouts` (anywhere, really), simply call `render 'breadcrumbs'` to render them.
+
+## Gotchas
+
+### Railtie Configuration
+
+This gem's Railtie sets the Rails application's `config.action_controller.include_all_helpers` to `false`. This is a non-negotiable setup as the way breadcrumbs are defined in each helper *will have unavoidably similar method names*.
+
+By default, Rails includes **all helper files** into a controller. This will result to some method names getting replaced when there are similar ones across all helpers. In order to avoid this, the mentioned config needs to be disabled so that **it only loads the related helper associated with the controller**.
+
+### Crumb Stoppers
+
+As of `0.2.0`, this gem now supports a feature called Crumb Stoppers. Suppose we have the given code:
 
-TODO: Write usage instructions here
+```ruby
+module Some::Namespace
+  module MyHelper
+    prepend BreadcrumbHelper::Some::Namespace
 
-## Development
+    def show_breadcrumbs
+      add_breadcrumb name: 'Home', path: root_path
+      add_breadcrumb name: @product.name # Assume this does not exist because of an unauthorized error that was rendered earlier.
+    end
+  end
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+With Crumb Stoppers, the breadcrumb trails will still display Home, and will not raise an exception.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Without Crumb Stoppers, the developer will need to add support for code *in each breadcrumb action*. To avoid this problem, the current default code of the gem is changed so that it stops the breadcrumb trail when it encounters a `NoMethodError` exception. Do note that it will still display the breadcrumbs that has no errors prior for a more beautiful display. However, the implementation is only integrated mostly in the view template, so for those who are updating the gem from `0.1.*`, I would advise to copy the code style found in the template to avail the Crumb Stoppers feature.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/breadcrumb_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/breadcrumb_helper/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/tieeeeen1994/breadcrumb_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tieeeeen1994/breadcrumb_helper/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +107,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the BreadcrumbHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/breadcrumb_helper/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the BreadcrumbHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tieeeeen1994/breadcrumb_helper/blob/master/CODE_OF_CONDUCT.md).

data/lib/breadcrumb_helper/main.rb

@@ -21,6 +21,23 @@ module BreadcrumbHelper
       render('breadcrumb_items', items: breadcrumb_items)
     end
 
+    # Tries to render the item name.
+    # This is a dynamic value, hence this method exists so that it can become the interface for displaying item names
+    # with the benefit of added guard clauses.
+    # It is recommended to use this in the view files.
+    def render_breadcrumb_item_name(item)
+      item[:name].to_s
+    rescue NoMethodError
+      nil
+    end
+
+    # Tries to render the item path.
+    # It does nothing special, but support for it is added just in case there are updates.
+    # It is still more recommended to use this in the view files.
+    def render_breadcrumb_item_path(item)
+      item[:path]
+    end
+
     private
 
     # Absolute source of truth for breadcrumb items, only modifiable through add_breadcrumb method.

data/lib/breadcrumb_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BreadcrumbHelper
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/generators/templates/breadcrumb_items.html.erb

@@ -1,11 +1,15 @@
 <% items.each do |item| %>
-  <% if item[:path] %>
+  <% item_name = render_breadcrumb_item_name(item) %>
+  <% break unless item_name %>
+
+  <% item_path = render_breadcrumb_item_path(item) %>
+  <% if item_path %>
     <li class="breadcrumb-item">
-      <a href="<%= item[:path] %>"><%= item[:name] %></a>
+      <a href="<%= item_path %>"><%= item_name %></a>
     </li>
   <% else %>
     <li class="breadcrumb-item active" aria-current="page">
-      <%= item[:name] %>
+      <%= item_name %>
     </li>
   <% end %>
 <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breadcrumb_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tien
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7'
-description:
+description: 
 email:
 - tieeeeen1994@gmail.com
 executables: []
@@ -50,7 +50,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tieeeeen1994/rails-breadcrumb-helpers
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Provides easy helper methods to generate breadcrumbs in Rails views.
 test_files: []