breadcrumbs_rails 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d28a2673f20c576627472cdb98978eccd61e2cf2f2a850cc226bfc60a74110ac
+  data.tar.gz: b24469f0e3ff01edd282af0c4d39570d5b402010996aae8139fffd6acb63f011
+SHA512:
+  metadata.gz: 559cf5bbdcb461a721f37d05ba0e4f601f4ee166e09266d19e42b78525738d25b9ba45d97dbafb11bcbf9e59fe7ef9a054640f4eac904610dbe3592675c88590
+  data.tar.gz: 0d6f7a5b9232c82e5dc037a214b9631a702b2b0e8690463af0eed5f09800f416582c02e7fafabb89c42cb4647957cac65346cb7d648ab1903a316b4007e6c108

data/.gitignore

@@ -0,0 +1,3 @@
+.idea/
+.bundle
+Gemfile.lock

data/Gemfile

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

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/rails.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="70" height="20" role="img" aria-label="rails: 3.0+"><title>rails: 3.0+</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="70" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="33" height="20" fill="#555"/><rect x="33" width="37" height="20" fill="#fe7d37"/><rect width="70" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="175" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="230">rails</text><text x="175" y="140" transform="scale(.1)" fill="#fff" textLength="230">rails</text><text aria-hidden="true" x="505" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">3.0+</text><text x="505" y="140" transform="scale(.1)" fill="#fff" textLength="270">3.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,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'breadcrumbs_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'breadcrumbs_rails'
+  spec.version               = BreadcrumbsRails::VERSION
+  spec.authors               = %w(EdCordata)
+  spec.summary               = %q{Rails breadcrumbs gem}
+  spec.description           = %q{Rails breadcrumbs gem}
+  spec.homepage              = 'https://github.com/EdCordata-Ruby-Gems/breadcrumbs_rails'
+  spec.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'
+  }
+  spec.license               = 'CC BY 4.0'
+  spec.files                 = `git ls-files`.split($/)
+  spec.require_paths         = %w(lib)
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rails', '>= 3.0'
+end

data/lib/breadcrumbs_rails.rb

@@ -0,0 +1,85 @@
+require 'breadcrumbs_rails/version'
+require 'breadcrumbs_rails/railtie'
+require 'breadcrumbs_rails/breadcrumb'
+require 'breadcrumbs_rails/breadcrumbs'
+
+module BreadcrumbsRails
+  extend ActiveSupport::Concern
+
+
+  # ----------------------------------------------------------
+  included do |base|
+
+
+    unless base.respond_to?(:before_action)
+      base.alias_method :before_filter, :before_action
+    end
+
+
+    helper_method :render_breadcrumbs_title, :render_breadcrumbs
+
+
+    def add_breadcrumb(name, options = {})
+      self.breadcrumbs_gem.breadcrumbs << ::BreadcrumbsRails::Breadcrumb.new(
+        name_string: name,
+        path_string: options[:path],
+        locale:      options[:locale],
+        localize:    options[:localize],
+      )
+
+      self.breadcrumbs_gem.localize     = options[:localize] if options.has_key?(:localize)
+      self.breadcrumbs_gem.locale       = options[:locale]   if options.has_key?(:locale)
+      self.breadcrumbs_gem.scope        = options[:scope]    if options.has_key?(:scope)
+      self.breadcrumbs_gem.title_string = options[:title]    if options.has_key?(:title)
+    end
+
+
+    def breadcrumbs_gem
+      @breadcrumbs_gem ||= ::BreadcrumbsRails::Breadcrumbs.new
+    end
+
+
+    def render_breadcrumbs_title(default = nil)
+      breadcrumbs_gem.title || default
+    end
+
+
+    def render_breadcrumbs(template: nil, &block)
+      if block_given?
+        yield(breadcrumbs_gem)
+      else
+
+        if template.nil?
+          partial = 'breadcrumbs/breadcrumbs'
+          partial = (breadcrumbs_gem.scope + '/' + partial) unless breadcrumbs_gem.scope.nil?
+        else
+          partial = "breadcrumbs/#{template}"
+        end
+
+        partial += '.html'
+
+        render(partial:  partial,
+               locals:   { breadcrumbs: breadcrumbs_gem },
+               handlers: [:erb, :haml])
+      end
+    end
+
+
+  end
+  # ----------------------------------------------------------
+
+
+  # ----------------------------------------------------------
+  class_methods do
+
+    def add_breadcrumb(name, options = {})
+      before_action(options) do |controller|
+        controller.send(:add_breadcrumb, name, options)
+      end
+    end
+
+  end
+  # ----------------------------------------------------------
+
+
+end

data/lib/breadcrumbs_rails/breadcrumb.rb

@@ -0,0 +1,46 @@
+module BreadcrumbsRails
+  class Breadcrumb
+
+
+    attr_accessor :name,     :name_string,
+                  :path,     :path_string,
+                  :localize, :locale
+
+
+    def initialize(name_string: nil, path_string: nil, localize: nil, locale: nil)
+      @locale      = locale   || 'en'
+      @localize    = localize || false
+
+      @name_string = name_string
+      @name        = generate_name
+
+      @path_string = path_string
+      @path        = generate_path
+    end
+
+
+    private
+
+
+    def generate_name
+      if @localize
+        ::I18n.t(@name_string, locale: @locale, default: @name_string)
+      else
+        @name_string
+      end
+    end
+
+
+    def generate_path
+      url_helpers = ::Rails.application.routes.url_helpers
+
+      if url_helpers.methods.include?(@path_string.to_s.to_sym)
+        url_helpers.send(@path_string)
+      else
+        @path_string
+      end
+    end
+
+
+  end
+end

data/lib/breadcrumbs_rails/breadcrumbs.rb

@@ -0,0 +1,37 @@
+module BreadcrumbsRails
+  class Breadcrumbs
+
+    attr_accessor :breadcrumbs,
+                  :scope,    :format,
+                  :title,    :title_string,
+                  :localize, :locale
+
+    def initialize(breadcrumbs: [], title_string: nil, scope: nil, format: nil, localize: nil, locale: nil)
+      @breadcrumbs = breadcrumbs || []
+      @format      = format || 'html'
+      @scope       = scope
+
+      @title_string = title_string
+      @title        = generate_title
+
+      @localize = localize || false
+      @locale   = locale   || 'en'
+    end
+
+    def title_string=(title_string)
+      @title_string = title_string
+      @title        = generate_title
+    end
+
+    private
+
+    def generate_title
+      if @localize
+        ::I18n.t(@title_string, locale: @locale, default: @title_string)
+      else
+        @title_string
+      end
+    end
+
+  end
+end

data/lib/breadcrumbs_rails/railtie.rb

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

data/lib/breadcrumbs_rails/version.rb

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

data/lib/generators/breadcrumbs/config_generator.rb

@@ -0,0 +1,11 @@
+module Breadcrumbs
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root ::File.expand_path(::File.join(::File.dirname(__FILE__), 'templates/config/initializers'))
+
+      def copy_config_file
+        template 'breadcrumbs_config.rb', 'config/initializers/breadcrumbs.rb'
+      end
+    end
+  end
+end

data/lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_bootstrap.html.erb

@@ -0,0 +1,13 @@
+<% render_breadcrumbs.each do |breadcrumbs| %>
+  <ul class="pagination">
+    <% breadcrumbs.breadcrumbs.each do |breadcrumb| %>
+      <li>
+        <% if breadcrumb.path %>
+          <%= link_to breadcrumb.name, breadcrumb.path %>
+        <% else %>
+          <%= breadcrumb.name %>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_bootstrap.html.haml

@@ -0,0 +1,8 @@
+- render_breadcrumbs.each do |breadcrumbs|
+  %ul.pagination
+    - breadcrumbs.breadcrumbs.each do |breadcrumb|
+      %li
+        - if breadcrumb.path
+          = link_to breadcrumb.name, breadcrumb.path
+        - else
+          = breadcrumb.name

data/lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_html.html.erb

@@ -0,0 +1,13 @@
+<% render_breadcrumbs.each do |breadcrumbs| %>
+  <ul>
+    <% breadcrumbs.breadcrumbs.each do |breadcrumb| %>
+      <li>
+        <% if breadcrumb.path %>
+          <%= link_to breadcrumb.name, breadcrumb.path %>
+        <% else %>
+          <%= breadcrumb.name %>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_html.html.haml

@@ -0,0 +1,8 @@
+- render_breadcrumbs.each do |breadcrumbs|
+  %ul
+    - breadcrumbs.breadcrumbs.each do |breadcrumb|
+      %li
+        - if breadcrumb.path
+          = link_to breadcrumb.name, breadcrumb.path
+        - else
+          = breadcrumb.name

data/lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_inspinia.html.erb

@@ -0,0 +1,21 @@
+<% render_breadcrumbs do |breadcrumbs| %>
+  <div class="row wrapper border-bottom white-bg page-heading">
+    <div class="col-lg-10">
+
+      <h2><%= breadcrumbs.title %></h2>
+
+      <ol class="breadcrumb">
+        <% breadcrumbs.breadcrumbs.each do |breadcrumb| %>
+          <li>
+            <% if breadcrumb.path %>
+              <%= link_to breadcrumb.name, breadcrumb.path %>
+            <% else %>
+              <%= breadcrumb.name %>
+            <% end %>
+          </li>
+        <% end %>
+      </ol>
+
+    </div>
+  </div>
+<% end %>

data/lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_inspinia.html.haml

@@ -0,0 +1,13 @@
+- render_breadcrumbs do |breadcrumbs|
+  .row.wrapper.border-bottom.white-bg.page-heading
+    .col-lg-10
+
+      %h2= breadcrumbs.title
+
+      %ol.breadcrumb
+        - breadcrumbs.breadcrumbs.each do |breadcrumb|
+          %li
+            - if breadcrumb.path
+              = link_to breadcrumb.name, breadcrumb.path
+            - else
+              = breadcrumb.name

data/lib/generators/breadcrumbs/templates/config/initializers/breadcrumbs_config.rb

@@ -0,0 +1 @@
+# breadcrumbs config coming soon

data/lib/generators/breadcrumbs/views_generator.rb

@@ -0,0 +1,22 @@
+module Breadcrumbs
+  module Generators
+    class ViewsGenerator < ::Rails::Generators::NamedBase
+      source_root ::File.expand_path(::File.join(::File.dirname(__FILE__), 'templates/app/views/breadcrumbs'))
+      desc 'Template engine for the views. Available options are "erb", "haml".'
+
+      class_option :format, type: :string, default: 'all'
+
+      def copy_default_views
+        case options['format'].try(:to_s).try(:downcase)
+        when 'haml'
+          copy_file("_#{@name}.html.haml", 'app/views/breadcrumbs/_breadcrumbs.html.haml')
+        when 'erb'
+          copy_file("_#{@name}.html.erb", 'app/views/breadcrumbs/_breadcrumbs.html.erb')
+        else
+          copy_file("_#{@name}.html.haml", 'app/views/breadcrumbs/_breadcrumbs.html.haml')
+          copy_file("_#{@name}.html.erb", 'app/views/breadcrumbs/_breadcrumbs.html.erb')
+        end
+      end
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,114 @@
+## Breadcrumbs Rails
+
+![Ruby Version](badges/ruby.svg)
+![Ruby Version](badges/rails.svg)
+[![License](badges/license.svg)](https://creativecommons.org/licenses/by/4.0/)
+
+
+<br/>
+
+
+#### Installation
+
+As usual, add to Gemfile:
+```ruby
+gem 'breadcrumbs_rails'
+```
+
+Generate config:
+```bash
+rails g breadcrumbs:config
+```
+
+
+<br/>
+
+
+#### Usage:
+
+In controllers
+```ruby
+class ApplicationController < ActionController::Base
+  include BreadcrumbsRails
+  
+  # non-required attributes:
+  # * path        - if not specified, item will be text, instead of link. Possible STRING values: '/', 'root_path'
+  # * scope       - views scope, in case you want different breadcrumbs for different namespaces, like 'admin'
+  # * views_title - only for inspinia template. This is title above breadcrumbs.
+  # * template    - template of views to use: 'html', 'bootstrap', 'inspinia' (only if not using custom views).
+  #                 Note that, if this argument is passed, gems views will be used.
+  add_breadcrumb 'views.home', path: 'root_path', title: 'Home', scope: 'views.admin', localize: true
+end
+
+class UsersController < ApplicationController
+  add_breadcrumb 'Users', path: 'users_path', title: 'Users'
+  
+  def edit
+    add_breadcrumb('User')
+  end
+end
+```
+
+To use `title` functionality:
+```haml
+%title= render_breadcrumbs_title
+```
+
+Using gem's views
+```haml
+= render_breadcrumbs
+
+# or with specific template
+= render_breadcrumbs(template: 'bootstrap') # default: 'html'; available: 'html', 'bootstrap', 'inspinia'
+```
+
+Or creating custom:
+```haml
+- render_breadcrumbs do |breadcrumbs|
+  - breadcrumbs.breadcrumbs.each do |breadcrumb|
+    %li= link_to_if breadcrumb.path, breadcrumb.name, breadcrumb.path
+```
+
+Available methods:
+```haml
+- render_breadcrumbs do |breadcrumbs|
+
+  - breadcrumbs.scope    # current scope
+  - breadcrumbs.format   # current format
+  
+    breadcrumb.localize # boolean if should localize title
+    breadcrumb.locale   # current locale
+    
+  - breadcrumbs.title_string # string, provided in admin panel
+  - breadcrumbs.title        # string or translation of title, provided in admin panel
+  
+  - breadcrumbs.breadcrumbs.each do |breadcrumb|
+    
+    breadcrumb.localize # boolean if should localize name
+    breadcrumb.locale   # current locale
+    
+    breadcrumb.name_string # string, provided in admin panel
+    breadcrumb.name        # string or translation of string, provided in admin panel
+    
+    breadcrumb.path_path # path string, provided in admin panel
+    breadcrumb.path      # path string or url, provided in admin
+```
+
+
+<br/>
+
+
+
+#### Generate views
+
+You can also specify only one format (`haml`, `erb.html`), by adding `--format` parameter:
+```bash
+rails g breadcrumbs:views haml --format haml
+rails g breadcrumbs:views haml --format erb
+
+rails g breadcrumbs:views inspinia --format haml
+rails g breadcrumbs:views inspinia --format erb
+
+rails g breadcrumbs:views bootstrap --format haml
+rails g breadcrumbs:views bootstrap --format erb
+```

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: breadcrumbs_rails
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- EdCordata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-28 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
+- badges/license.svg
+- badges/rails.svg
+- badges/ruby.svg
+- breadcrumbs_rails.gemspec
+- lib/breadcrumbs_rails.rb
+- lib/breadcrumbs_rails/breadcrumb.rb
+- lib/breadcrumbs_rails/breadcrumbs.rb
+- lib/breadcrumbs_rails/railtie.rb
+- lib/breadcrumbs_rails/version.rb
+- lib/generators/breadcrumbs/config_generator.rb
+- lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_bootstrap.html.erb
+- lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_bootstrap.html.haml
+- lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_html.html.erb
+- lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_html.html.haml
+- lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_inspinia.html.erb
+- lib/generators/breadcrumbs/templates/app/views/breadcrumbs/_inspinia.html.haml
+- lib/generators/breadcrumbs/templates/config/initializers/breadcrumbs_config.rb
+- lib/generators/breadcrumbs/views_generator.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.2.22
+signing_key: 
+specification_version: 4
+summary: Rails breadcrumbs gem
+test_files: []