breadcrumbs 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 638b77085849ea1f06cb4c55b11f3baecaaeae84b5fce2c98e8421ac18e20929
+  data.tar.gz: 3bd0227aa31d6630f29b6d2c7e37a1ba3a76df992cfe716bb1bc343473abff19
+SHA512:
+  metadata.gz: 676edfeedcdd4a914bfbb2ad3caa6a29e6be4ab9f50f4106f715510a52a669eca7504c1ee99854f712cb929a0723436d7cfd63fccd8e471050249c4c40ef9e1e
+  data.tar.gz: 4a015506ccc94efa8cd8b228ac38dda10409e88e60191036a4e3fc5a6fc1f909e36292b9fe3dace9cf5541bc4886f0e5491e250f7a1386aaab66c620e2802bb7

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+doc
+*.lock
+coverage

data/.rubocop.yml

@@ -0,0 +1,22 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - examples/**/*
+    - vendor/**/*
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.7.1
+  - 2.6.5
+notifications:
+  email: false
+env:
+  global:
+    secure: e3cKbK2ru5Wx2Jir+PUUTQFx/lrYESRMhqPPgGQ1Eq6Xc8kQ+ACxuLmgFZEZOD1aUlCVfvm8kpIJ8uVhKystwotjV3ObK2imgWvpoJLfvgIWXZ3dhIWmVI98Da1I2t66LM+1l9LREzQm2bN7zAx7NPr2oRHasDpuNc13BnIcIsg=

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,143 @@
+# Breadcrumbs
+
+[![Travis-CI](https://travis-ci.org/fnando/breadcrumbs.svg)](https://travis-ci.org/fnando/breadcrumbs)
+[![Code Climate](https://codeclimate.com/github/fnando/breadcrumbs/badges/gpa.svg)](https://codeclimate.com/github/fnando/breadcrumbs)
+[![Gem](https://img.shields.io/gem/v/breadcrumbs.svg)](https://rubygems.org/gems/breadcrumbs)
+[![Gem](https://img.shields.io/gem/dt/breadcrumbs.svg)](https://rubygems.org/gems/breadcrumbs)
+
+Breadcrumbs is a simple plugin that adds a `breadcrumbs` object to controllers
+and views.
+
+## Instalation
+
+Just run `gem install breadcrumbs`. Or add `gem "breadcrumbs"` to your Gemfile.
+
+## Usage
+
+On your controller (optional):
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :add_initial_breadcrumbs
+
+  private
+  def add_initial_breadcrumbs
+    breadcrumbs.add "Home", root_path
+  end
+end
+
+class ThingsController < ApplicationController
+  def index
+    breadcrumbs.add "Things", things_path
+  end
+end
+```
+
+You don't need to provide an URL; in that case, a span will be generated instead
+of a link:
+
+```ruby
+breadcrumbs.add "Some page"
+```
+
+You can set additional HTML attributes if you need to:
+
+```ruby
+breadcrumbs.add "Home", root_path, id: "home", title: "Go to the home page"
+```
+
+On your view (possibly application.html.erb):
+
+```erb
+<%= breadcrumbs.render %>
+```
+
+You can render as ordered list.
+
+```erb
+<%= breadcrumbs.render(format: :ordered_list) %>
+```
+
+You can render as inline links.
+
+```erb
+<%= breadcrumbs.render(format: :inline) %>
+```
+
+You can set your own separator:
+
+```erb
+<p>
+  You are here: <%= breadcrumbs.render(format: :inline, separator: "|") %>
+</p>
+```
+
+You can also define your own formatter. Just create a class that implements a
+`render` instance method and you're good to go.
+
+```ruby
+class Breadcrumbs::Render::Dl
+  def render
+    # return breadcrumbs wrapped in a <dl> tag
+  end
+end
+```
+
+To use your new format, just provide the `:format` option.
+
+```ruby
+breadcrumbs.render(format: :dl)
+```
+
+### I18n
+
+Breadcrumbs is integrated with I18n. You can set translations like:
+
+```yaml
+en:
+  breadcrumbs:
+    home: "Home"
+```
+
+And then you just call
+
+```ruby
+breadcrumbs.add :home
+```
+
+In fact, you can provide any scope you want.
+
+```ruby
+breadcrumbs.add :"titles.home"
+```
+
+If you don't want to translate a label, just pass the option `:i18n` as `false`.
+
+```ruby
+breadcrumbs.add :home, nil, i18n: false
+```
+
+## Maintainer
+
+- Nando Vieira - http://nandovieira.com
+
+## License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/breadcrumbs.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "./lib/breadcrumbs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "breadcrumbs"
+  s.version     = Breadcrumbs::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/breadcrumbs"
+  s.summary     = "Breadcrumbs is a simple plugin that adds a `breadcrumbs` " \
+                  "object to controllers and views."
+  s.description = s.summary
+  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`
+                    .split("\n")
+                    .map {|f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "actionview"
+  s.add_dependency "activesupport"
+  s.add_dependency "i18n"
+
+  s.add_development_dependency "actionpack"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "minitest-utils"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "nokogiri"
+  s.add_development_dependency "pry-meta"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-fnando"
+  s.add_development_dependency "simplecov"
+end

data/examples/myapp/.gitignore

@@ -0,0 +1,12 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/examples/myapp/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.0.beta1'
+gem 'sass-rails', '~> 5.0.0.beta1'
+gem 'uglifier', '>= 1.3.0'
+gem 'rails-html-sanitizer', '~> 1.0'
+gem 'breadcrumbs', path: '../..'
+
+group :development, :test do
+  gem 'spring'
+end
+

data/examples/myapp/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/examples/myapp/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/examples/myapp/app/assets/stylesheets/application.css

@@ -0,0 +1,49 @@
+/*
+ *= require_tree .
+ *= require_self
+ */
+
+.breadcrumbs {
+  font-family: sans-serif;
+  font-size: 14px;
+  background: #f5f5f5;
+  list-style: none;
+  margin: 0;
+  padding: 10px;
+  overflow: hidden;
+  color: #777;
+  border-radius: 5px;
+}
+
+.breadcrumbs li {
+  float: left;
+}
+
+.breadcrumbs li + li:before {
+  content: '/';
+  color: #ccc;
+  margin: 0 10px;
+}
+
+.breadcrumbs a {
+  color: #428bca;
+  text-decoration: none;
+}
+
+.breadcrumbs a:hover {
+  text-decoration: underline;
+}
+
+.breadcrumbs .first {
+  position: relative;
+  padding-left: 18px;
+}
+
+.breadcrumbs .first:before {
+  content: '\2302';
+  font-size: 20px;
+  position: absolute;
+  left: 0;
+  top: -2px;
+  color: #ccc;
+}

data/examples/myapp/app/controllers/application_controller.rb

@@ -0,0 +1,13 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+  before_action :set_root_breadcrumb
+
+  private
+
+  def set_root_breadcrumb
+    breadcrumbs.add :home, root_path
+  end
+end

data/examples/myapp/app/controllers/site_controller.rb

@@ -0,0 +1,9 @@
+class SiteController < ApplicationController
+  def home
+  end
+
+  def contact
+    breadcrumbs.add :pages
+    breadcrumbs.add :contact, contact_path
+  end
+end

data/examples/myapp/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/examples/myapp/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Myapp</title>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= breadcrumbs.render(format: 'list') %>
+
+<%= yield %>
+
+</body>
+</html>

data/examples/myapp/app/views/site/contact.html.erb

@@ -0,0 +1 @@
+<h1>Contact</h1>

data/examples/myapp/app/views/site/home.html.erb

@@ -0,0 +1 @@
+<h1>Home page</h1>

data/examples/myapp/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/examples/myapp/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'