{"id":20702906,"url":"https://github.com/ma2gedev/breadcrumble","last_synced_at":"2025-10-11T00:33:08.149Z","repository":{"id":5745571,"uuid":"6958033","full_name":"ma2gedev/breadcrumble","owner":"ma2gedev","description":"A breadcrumbs plugin for Ruby on Rails.","archived":false,"fork":false,"pushed_at":"2022-10-18T15:05:10.000Z","size":503,"stargazers_count":39,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-04T11:52:55.707Z","etag":null,"topics":["breadcrumb-navigation","breadcrumb-trail","breadcrumbs","rails","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"MarvAmBass/docker-versatile-postfix","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ma2gedev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-12-01T19:00:04.000Z","updated_at":"2022-01-02T06:08:29.000Z","dependencies_parsed_at":"2022-09-06T02:51:00.821Z","dependency_job_id":null,"html_url":"https://github.com/ma2gedev/breadcrumble","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/ma2gedev/breadcrumble","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ma2gedev%2Fbreadcrumble","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ma2gedev%2Fbreadcrumble/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ma2gedev%2Fbreadcrumble/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ma2gedev%2Fbreadcrumble/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ma2gedev","download_url":"https://codeload.github.com/ma2gedev/breadcrumble/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ma2gedev%2Fbreadcrumble/sbom","scorecard":{"id":608828,"data":{"date":"2025-08-11","repo":{"name":"github.com/ma2gedev/breadcrumble","commit":"09da60fd6e372879c9c18865917e2a6968a31c72"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Code-Review","score":1,"reason":"Found 2/16 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ruby.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/ma2gedev/breadcrumble/ruby.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ruby.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/ma2gedev/breadcrumble/ruby.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ruby.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 19 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T02:11:04.548Z","repository_id":5745571,"created_at":"2025-08-21T02:11:04.548Z","updated_at":"2025-08-21T02:11:04.548Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005657,"owners_count":26083942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["breadcrumb-navigation","breadcrumb-trail","breadcrumbs","rails","ruby"],"created_at":"2024-11-17T01:05:26.241Z","updated_at":"2025-10-11T00:33:08.122Z","avatar_url":"https://github.com/ma2gedev.png","language":"Ruby","readme":"# Breadcrumble\n\n[![Gem Version](https://badge.fury.io/rb/breadcrumble.png)](http://badge.fury.io/rb/breadcrumble)\n[![Build Status](https://github.com/ma2gedev/breadcrumble/workflows/Ruby/badge.svg?branch=master)](https://github.com/ma2gedev/breadcrumble/actions?query=workflow%3ARuby)\n[![Code Climate](https://codeclimate.com/github/ma2gedev/breadcrumble.png)](https://codeclimate.com/github/ma2gedev/breadcrumble)\n[![Coverage Status](https://coveralls.io/repos/ma2gedev/breadcrumble/badge.png)](https://coveralls.io/r/ma2gedev/breadcrumble)\n[![Inline docs](http://inch-ci.org/github/ma2gedev/breadcrumble.svg?branch=master)](http://inch-ci.org/github/ma2gedev/breadcrumble)\n\n![Breadcrumble Logo](http://ma2gedev.github.io/breadcrumble/images/logo_s.png)\nlogo designed by [@524shoutz_nika](https://twitter.com/524shoutz_nika)\n\nBreadcrumble is a simple breadcrumb navigation plugin for latest Ruby on Rails.\n\nSupport rich snippets mark up using microdata format as default.\n\nAnd also support multiple breadcrumb trails.\n\nSee also about rich snippets -\u003e \u003chttps://developers.google.com/search/docs/data-types/breadcrumb\u003e\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'breadcrumble'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install breadcrumble\n\n## Usage\n\n### Controller\n\nIn your controller, call `add_breadcrumb` to push a new crumb on the breadcrumb stack.\n\n    class SampleController\n\n      add_breadcrumb(\"home\", home_url)\n      add_breadcrumb(-\u003e context { context.title }, -\u003e context { context.sample_path })\n\n      def index\n        add_breadcrumb(\"index\", controller: 'sample', action: 'index')\n        add_breadcrumb(\"show\", show_path(123))\n        add_breadcrumbs([\"book\", \"/book\"], [\"page\", \"/book/page\"])\n      end\n\n    end\n\nSecond arugment passed `url_for` method for convenient use, except specify `nil`.\n\nYou can use `Proc` object for arguments, the library calls proc with controller context as argument.\n\nIf you would like to use multiple breadcrumb, call `add_breadcrumb_to` method with breadcrumb trail index.\n\n    class SampleController\n\n      add_breadcrumb_to(\"level 1\", \"level 1 url\", 0) # same as -\u003e add_breadcrumb(\"level 1\", \"level 1 url\")\n      add_breadcrumb_to(\"level 2\", \"level 2 url\", 1)\n\n      def index\n        add_breadcrumb_to(\"level 1 second item\", \"level 1 second url\", 0)\n        add_breadcrumb_to(\"level 2 second item\", \"level 2 second url\", 1)\n    end\n\n### View\n\nIn your view, you can render the breadcrumb navigation with the `render_breadcrumbs` helper.\n\n    \u003cbody\u003e\n      \u003c%= render_breadcrumbs %\u003e\n    \u003c/body\u003e\n\nYou can render multiple breadcrumb by `render_breadcrumb_trails` helper.\n\n    \u003cbody\u003e\n      \u003c%= render_breadcrumb_trails %\u003e\n    \u003c/body\u003e\n\n### Customizing layout\n\nBreadcrumble generates default partial template for your app.\n\nGenerate template. Run the follwoing.\n\n    $ rails g breadcrumble:views\n\nthen edit the partials in your app's `app/views/breadcrumble/` directory.\n\n### Theme\n\nYou can choose template themes in a single application. Create a directory with theme name in your app's `app/views/breadcrumble/` and create custom template files.\n\n```\n$ rails g breadcrumble:views\n$ cd app/views/breadcrumble\n$ mkdir my_custom_theme\n$ cp _*.erb my_custom_theme/\n```\n\nAnd then calling `render_breadcrumbs` or `render_breadcrumb_trails` method with theme option.\n\n```\n\u003c%= render_breadcrumbs(theme: 'my_custom_theme') %\u003e\n\u003c%= render_breadcrumb_trails(theme: 'my_custom_theme') %\u003e\n```\n\n## Development\n\n### test with specified Rails version\n\nlike the following:\n\n```bash\n$ bundle install --gemfile=gemfiles/6.1.gemfile\n$ BUNDLE_GEMFILE=gemfiles/6.1.gemfile bundle exec rake\n```\n\n## Contributing\n\n### Easy way\n\nIt's easy to contribute. You only push the star button!\n\n### The other way\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Added some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fma2gedev%2Fbreadcrumble","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fma2gedev%2Fbreadcrumble","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fma2gedev%2Fbreadcrumble/lists"}