breadcrumbs_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 481a041e6639cb0a33b985322c02c98dcc60a496fd528f2cf647406b479057a7
+  data.tar.gz: 368657c68d3be4bfd57105a8c6764a7dbad3f13831207c6a4840d0298194663c
+SHA512:
+  metadata.gz: b7828dc371a46f67aacda7a74d93854603791f4afec2f6ce6ac1270003b9e34ddc5491439530fa7fbe899b58f3307b5bc275ce97c9fc01cea0f17835e07af20c
+  data.tar.gz: 19553a7b9208d91ee61a86a77097ede252c3e9e843c43f089e2f86ce7ba4a8a25cb0812ad397efef1279e4fa90f421d81dbe7e3b8747daaaeceec87accf07671

data/.gitignore

@@ -0,0 +1,7 @@
+# IDE
+.idea/
+.atom/
+.vscode/
+
+# Gem builds
+breadcrumbs_rails-*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: .
+  specs:
+    breadcrumbs_rails (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.8.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  breadcrumbs_rails!
+  bundler
+  rails (>= 3.0)
+  rake
+
+BUNDLED WITH
+   2.1.2

data/badges/license.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="112" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="112" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h47v20H0z"/><path fill="#4c1" d="M47 0h65v20H47z"/><path fill="url(#b)" d="M0 0h112v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="245" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">license</text><text x="245" y="140" transform="scale(.1)" textLength="370">license</text><text x="785" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="550">CC BY 4.0</text><text x="785" y="140" transform="scale(.1)" textLength="550">CC BY 4.0</text></g> </svg>

data/badges/ruby.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="84" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="84" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h37v20H0z"/><path fill="#007ec6" d="M37 0h47v20H37z"/><path fill="url(#b)" d="M0 0h84v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">Ruby</text><text x="195" y="140" transform="scale(.1)" textLength="270">Ruby</text><text x="595" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">1.9.3+</text><text x="595" y="140" transform="scale(.1)" textLength="370">1.9.3+</text></g> </svg>

data/breadcrumbs_rails.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'breadcrumbs_rails/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'breadcrumbs_rails'
+  s.version               = BreadcrumbsRails::VERSION.dup
+  s.platform              = Gem::Platform::RUBY
+  s.authors               = 'EdCordata'
+  s.description           = 'Rails breadcrumbs gem'
+  s.summary               = 'Rails breadcrumbs gem'
+  s.licenses              = ['CC BY 4.0']
+  s.require_paths         = %w(lib)
+  s.files                 = `git ls-files`.split("\n")
+  s.homepage              = 'https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails'
+  s.require_paths         = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+  s.rubygems_version      = '1.6.2'
+  s.metadata      = {
+    'documentation_uri' => 'https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails/blob/master/readme.md',
+    'source_code_uri'   => 'https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails',
+    'bug_tracker_uri'   => 'https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails/issues'
+  }
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rails', '>= 3.0'
+end

data/lib/breadcrumbs_rails.rb

@@ -0,0 +1,8 @@
+require 'breadcrumbs_rails/version'
+require 'breadcrumbs_rails/action_controller'
+require 'breadcrumbs_rails/railtie'
+
+module BreadcrumbsRails
+  NAME = 'Breadcrumbs Rails'
+  GEM  = 'breadcrumbs_rails'
+end

data/lib/breadcrumbs_rails/action_controller.rb

@@ -0,0 +1,158 @@
+module BreadcrumbsRails
+  module ActionController
+    extend ActiveSupport::Concern
+
+
+    # -----------------------------------------------------------
+    included do |base|
+      extend ClassMethods
+      helper HelperMethods
+
+      helper_method :add_breadcrumb, :breadcrumbs_gem
+
+      unless base.respond_to?(:before_action)
+        base.alias_method :before_action, :before_filter
+      end
+    end
+    # -----------------------------------------------------------
+
+
+    protected
+
+
+    # -----------------------------------------------------------
+    def add_breadcrumb(name, options = {})
+      url_helpers = Rails.application.routes.url_helpers
+
+      if options[:path]
+        options[:path] = if url_helpers.methods.include?(options[:path])
+                           url_helpers.send(options[:path])
+                         else
+                           options[:path]
+                         end
+      end
+
+      self.breadcrumbs_gem[:breadcrumbs] << {
+        name:      name,
+        path:      options[:path].to_s,
+        params:    options[:params] || {},
+        title:     options[:title],
+        html_safe: options[:html_safe] == true
+      }
+
+      self.breadcrumbs_gem[:localize]  = options[:localize]  == true unless options[:localize].nil?
+      self.breadcrumbs_gem[:html_safe] = options[:html_safe] == true unless options[:html_safe].nil?
+    end
+
+    def breadcrumbs_gem
+      @breadcrumbs_gem ||= { breadcrumbs: [], scope: nil, localize: false }
+    end
+    # -----------------------------------------------------------
+
+
+    # Class Methods
+    # -----------------------------------------------------------
+    module ClassMethods
+
+      def add_breadcrumb(name, options = {})
+        before_action(options) do |controller|
+          controller.send(:add_breadcrumb, name, options)
+        end
+      end
+
+    end
+    # -----------------------------------------------------------
+
+
+    # Helper Methods
+    # -----------------------------------------------------------
+    module HelperMethods
+
+
+      def render_breadcrumbs_title(default = nil)
+        return default if breadcrumbs_gem[:breadcrumbs].last[:title].nil?
+        return ''      if breadcrumbs_gem[:breadcrumbs].last[:title].to_s.blank?
+
+        if breadcrumbs_gem[:localize]
+          I18n.t(breadcrumbs_gem[:breadcrumbs].last[:title])
+        else
+          breadcrumbs_gem[:breadcrumbs].last[:title]
+        end
+      end
+
+
+      def render_breadcrumbs(options = {}, &block)
+        format = (options[:format] || :html).to_sym
+
+        if block_given?
+          yield(breadcrumbs_gem)
+        else
+
+          case format
+
+            when :html
+              content_tag(:ul) do
+                breadcrumbs_gem[:breadcrumbs].map do |breadcrumb|
+                  concat content_tag(:li, breadcrumbs_name_or_link(breadcrumbs_gem, breadcrumb))
+                end
+              end
+
+            when :bootstrap
+              content_tag(:ul, class: 'pagination') do
+                breadcrumbs_gem[:breadcrumbs].map do |breadcrumb|
+                  concat content_tag(:li, breadcrumbs_name_or_link(breadcrumbs_gem, breadcrumb))
+                end
+              end
+
+            when :inspinia
+              html = ''
+              html << '<div class="row wrapper border-bottom white-bg page-heading">'
+              html << '  <div class="col-lg-9">'
+              html << (render_breadcrumbs_title ? "<h2>#{render_breadcrumbs_title}</h2>" : '<br/>')
+              html << '    <ol class="breadcrumb">'
+
+              breadcrumbs_gem[:breadcrumbs].each_with_index do |breadcrumb, index|
+                if (index + 1) == breadcrumbs_gem[:breadcrumbs].length
+                  html << "<li class='active'><strong>#{breadcrumbs_name_or_link(breadcrumbs_gem, breadcrumb)}</strong></li>"
+                else
+                  html << "<li>#{breadcrumbs_name_or_link(breadcrumbs_gem, breadcrumb)}</li>"
+                end
+              end
+
+              html << '    </ol>'
+              html << '  </div>'
+              html << '</div>'
+              html.html_safe
+
+            else
+              raise "Breadcrumbs-rails: unknown format '#{format.to_s}'"
+          end
+
+        end
+      end
+
+
+      private
+
+
+      def breadcrumbs_name_or_link(breadcrumbs_gem, breadcrumb)
+        return '' if breadcrumb[:name].to_s.blank?
+
+        name = (breadcrumbs_gem[:localize] ? I18n.t(breadcrumb[:name]) : breadcrumb[:name])
+        name = CGI::escapeHTML(name) unless breadcrumb[:html_safe] # escape name as we call html_safe
+
+        if breadcrumb[:path].to_s.blank?
+          name.html_safe
+        else
+          url = Rails.application.routes.url_helpers.send(breadcrumb[:path].to_s, breadcrumb[:params])
+          link_to(name.html_safe, url)
+        end
+      end
+
+
+    end
+    # -----------------------------------------------------------
+
+
+  end
+end

data/lib/breadcrumbs_rails/railtie.rb

@@ -0,0 +1,11 @@
+module BreadcrumbsRails
+  class Railtie < Rails::Railtie
+
+    ActiveSupport.on_load(:action_controller) do
+      ::ActionController::Base.send(:include, BreadcrumbsRails::ActionController)
+      views_path = "#{File.dirname(__FILE__)}/../generators/breadcrumbs/templates/app/views/breadcrumbs"
+      ::ActionController::Base.prepend_view_path(views_path)
+    end
+
+  end
+end

data/lib/breadcrumbs_rails/version.rb

@@ -0,0 +1,3 @@
+module BreadcrumbsRails
+  VERSION = '1.0.0'
+end

data/readme.md

@@ -0,0 +1,82 @@
+# Breadcrumbs Rails
+
+![Ruby Version](badges/ruby.svg)
+[![License](badges/license.svg)](https://creativecommons.org/licenses/by/4.0/)
+
+Breadcrumbs rails is easy way to create breadcrumbs from controllers and render them in view. This gem also
+includes functionality to easily change title.
+
+### Installation
+
+As usual, add to Gemfile:
+```ruby
+gem 'breadcrumbs_rails'
+```
+
+and run:
+```bash
+$ bundle install
+```
+
+
+### Introduction
+
+Syntax is `add_breadcrumb(name, options)`
+Available options:
+  * `html_safe` - (type: boolean, default: false) - specifies if title is html safe and shouldn't be escaped
+  * `:path` - (type: string, default: nil) - link path as string. It must be a string, not symbol
+  * `:params` - (type: hash, default: {}) - params to pass to `:path`
+  * `:title`  - (type: string, default: nil) - title for `:render_breadcrumbs_title` method
+
+
+
+### Usage
+
+In controllers
+```ruby
+class ApplicationController < ActionController::Base
+  add_breadcrumb 'Home',  path: 'root_path',  params: { locale: 'en' }
+end
+
+class UsersController < ApplicationController
+  add_breadcrumb 'Users', path: 'users_path',  params: { locale: 'en' }, title: 'Users'
+  
+  def edit
+    add_breadcrumb('User')
+  end
+end
+```
+
+If you want to use translations, do it like so:
+```ruby
+class ApplicationController < ActionController::Base
+  add_breadcrumb 'links.home',  path: 'root_path',  params: { locale: 'en' }, title: '', localize: true # Only name is required
+end
+
+class UsersController < ApplicationController
+  add_breadcrumb 'links.users', path: 'users_path',  params: { locale: 'en' }, title: 'Users'
+  
+  def edit
+    add_breadcrumb('links.user')
+  end
+end
+```
+
+### Rendering breadcrumbs
+Default format is `:html`. Available: `:html`, `:bootstrap`, `:inspinia`.
+```haml
+= render_breadcrumbs(format: :html)
+```
+
+Or by using block:
+```haml
+- render_breadcrumbs do |renderer|
+  - renderer[:breadcrumbs].each do |breadcrumb|
+    %li= link_to_if breadcrumb[:path], breadcrumb[:name], breadcrumb[:path]
+```
+
+### To use `title` functionality:
+```haml
+%html
+  %title= render_breadcrumbs_title
+```

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: breadcrumbs_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- EdCordata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rails breadcrumbs gem
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- badges/license.svg
+- badges/ruby.svg
+- breadcrumbs_rails.gemspec
+- lib/breadcrumbs_rails.rb
+- lib/breadcrumbs_rails/action_controller.rb
+- lib/breadcrumbs_rails/railtie.rb
+- lib/breadcrumbs_rails/version.rb
+- readme.md
+homepage: https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails
+licenses:
+- CC BY 4.0
+metadata:
+  documentation_uri: https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails/blob/master/readme.md
+  source_code_uri: https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails
+  bug_tracker_uri: https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Rails breadcrumbs gem
+test_files: []