migajas 0.9.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2224e900cfa8368a0da6bcd4d8b9fed287645e40
-  data.tar.gz: 219915ed490c9a9d5d4f7336e91ced8735b366f6
+SHA256:
+  metadata.gz: d1c73bd0ffb5454b4eee7071c06cfac143401de7274bd379bf32cdd6209f328f
+  data.tar.gz: d7e83df30e99e86080d09e600b6b0d4cb2b76be50e062175d5d4a3799c446e84
 SHA512:
-  metadata.gz: 7e00e0bb52756db949d5a02827e466e32e600aaf2164d30eea9be9094c7e145b67937d5bb074f19be4959b97c7a722b66ef9e3cc11e66cbb26a079ff717c6454
-  data.tar.gz: 39489dd99c8ce61f52c0eba3af37a715f8c64930b5c414546bf33809617e19024d755dc5777865713c59a4c3a03d1a20ea959a19be2118c1ef3cb55969527fc6
+  metadata.gz: e5b3b988e648cf63a565c1dc6c417ddbe395cd404f7a83bfb10198351b3eeec22c309468a37c4c203bd6b7998c303a8cd70e06e4750d1da24e1473706ccb0331
+  data.tar.gz: fa02e81e1f6dc39ad0ee0ce48b76764c243259d946ebbe591e761907203e0d7995644402108d70d6e074a0fb4c9d63ee89c1a91072441e98b7fc3d0d941b0077

data/README.md

@@ -1,7 +1,8 @@
 # Migajas
 
-Migajas is a tiny library for adding breadcrumbs to a routing tree framework,
-like Cuba or Roda.
+Migajas is a tiny library for adding breadcrumbs to any Rack application. It was
+designed with routing tree frameworks like Cuba or Roda in mind, but works well
+with any Rack-based framework, including Rails.
 
 ## Usage
 
@@ -46,14 +47,59 @@ Then, in the view, go over the `breadcrumbs` list:
 
 That's it :)
 
+## Rails
+
+Start by adding `Migajas::Rails` to your controllers:
+
+``` ruby
+class ApplicationController < ActionController::Base
+  include Migajas::Rails
+end
+```
+
+This gives you a `breadcrumbs` method that you can access from your controllers
+and views. The recommended approach is to use action callbacks to add
+breadcrumbs:
+
+``` ruby
+class ApplicationController < ActionController::Base
+  include Migajas::Rails
+
+  before_action { breadcrumbs.add "Home", root_path }
+end
+
+class UsersController < ApplicationController
+  before_action { breadcrumbs.add "Users", users_path }
+  before_action(only: [:show, :edit, :update]) { breadcrumbs.add @user.name, user_path(@user) }
+end
+```
+
+Then, in your layout, you can iterate over the Array:
+
+``` erb
+<ol class="breadcrumbs">
+  <% breadcrumbs.each do |crumb| %>
+    <%= tag.li class: { active: crumb.current? } do %>
+      <%= link_to crumb.name, crumb.url %>
+    <% end %>
+  <% end %>
+</ol>
+```
+
 ## Install
 
     gem install migajas
 
+## Do we need a gem for this?
+
+Probably not, but after 2 years of using this code, I got bored of copying and
+pasting it from [a gist](https://gist.github.com/foca/44c9f24a759238fba9fb).
+
 ## What's in a name?
 
 `Migajas` is the Spanish word for `breadcrumbs`. It's pronounced like you'd
-pronounce `meegahas` in English (or `miˈɣa.xas` if you're a language nerd.)
+pronounce `me-gha-has` in English (`me` as in the word "me", `gha` as in
+"ghast", and `has` as the word "has".)
 
 ## License
 

data/lib/migajas.rb

@@ -1,4 +1,14 @@
+require_relative "migajas/version"
+require_relative "migajas/rails" if defined?(Rails)
+
 module Migajas
+  # Public: Reader method to get the Rack env. Override if your framework does
+  # not expose an `env` method in the context used when evaluating routing
+  # actions or views (such as Rails).
+  def migajas_env
+    env
+  end
+
   # Public: List of breadcrumbs encountered in this request. Add to this list
   # any breadcrumb as you go through your routing tree in the app:
   #
@@ -41,7 +51,7 @@ module Migajas
   #
   # Returns a Migajas::Trail.
   def breadcrumbs
-    env["app.breadcrumbs"] ||= Trail.new(env)
+    migajas_env["app.breadcrumbs"] ||= Trail.new(migajas_env)
   end
 
   # The Trail is just an `env`-aware Array, with some convenient sugar for

data/lib/migajas/rails.rb

@@ -0,0 +1,50 @@
+require "migajas"
+
+module Migajas
+  # Provides a bridge for Migajas to work in Rails controllers, giving you the
+  # `breadcrumbs` method both in controllers and views.
+  #
+  # You can then add to it via action callbacks, like so:
+  #
+  #   class ApplicationController
+  #     before_action { breadcrumbs.add "Home", root_path }
+  #   end
+  #
+  #   class UsersController < ApplicationController
+  #     before_action { breadcrumbs.add "Users", users_path }
+  #     before_action(only: [:show, :edit, :update]) do
+  #       breadcrumbs.add @user.name, @user
+  #     end
+  #   end
+  #
+  # You can also call `breadcrumbs.add` directly from your controller action:
+  #
+  #   class UsersController < ApplicationController
+  #     def edit_security
+  #       breadcrumbs.add "Password", edit_security_user_path(@user)
+  #     end
+  #   end
+  #
+  # Then, from the view, you can just iterate over the `breadcrumbs` trail:
+  #
+  #   <nav class="breadcrumbs" aria-label="Breadcrumb">
+  #     <ol>
+  #       <% breadcrumbs.each do |crumb| %>
+  #         <li><%= link_to_unless crumb.current?, crumb.name, crumb.url %></li>
+  #       <% end %>
+  #     </ol>
+  #   </nav>
+  #
+  module Rails
+    extend ActiveSupport::Concern
+    include Migajas
+
+    included do
+      helper_method :breadcrumbs
+    end
+
+    def migajas_env # :nodoc:
+      request.env
+    end
+  end
+end

data/lib/migajas/version.rb

@@ -1,3 +1,3 @@
 module Migajas
-  VERSION = "0.9.0".freeze
+  VERSION = "1.0.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: migajas
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nicolas Sanguinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -31,16 +31,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Simple library to add breadcrumbs to your Cuba/Roda app
+description: Simple library to add breadcrumbs to your Rack app
 email:
-- contacto@nicolassanguinetti.info
+- foca@foca.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -48,6 +48,7 @@ files:
 - LICENSE
 - README.md
 - lib/migajas.rb
+- lib/migajas/rails.rb
 - lib/migajas/version.rb
 homepage: http://github.com/foca/migajas
 licenses:
@@ -68,9 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Breadcrumbs for your Cuba/Roda app
+summary: Breadcrumbs for your Rack app
 test_files: []