breadcrumb_key 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bef4969b9ceecd94de53667c3285c2e28430bbdbddc9f0a50dbe59d0f56d2d70
+  data.tar.gz: af07fd9e84b317661f7e31c8102f8da920c6e9e3503622c3c1505b44f03cac75
+SHA512:
+  metadata.gz: 81457994b44bc28bf7d044c346324ee6c8362da952717b7d8cfb1fc74e5f795315d3c642b8403af148772a7e0c29384074266d372a231b64e73dd546b672ce94
+  data.tar.gz: 422f0c1e96a6e7fb0ee40010e0c90aa0a2a7620ffca35d16b7df2745df278a0e575f86f29ac8799cf30baaeb22dc85b501e5299b42f50715b46b7809fb831d1d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in breadcrumb_key.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    breadcrumb_key (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  breadcrumb_key!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 yamitake
+
+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/README.md

@@ -0,0 +1,35 @@
+# BreadcrumbKey
+
+BreadcrumbKey is a gem that provides a straightforward way to generate consistent and standardized breadcrumb keys for Rails applications. It's optimized for seamless integration with breadcrumb generation libraries, especially Gretel.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add breadcrumb_key
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install breadcrumb_key
+
+## Usage
+
+BreadcrumbKey works hand-in-hand with breadcrumb generation libraries, and while it's not exclusive to any particular library, it's optimized for a seamless experience with [Gretel](https://github.com/kzkn/gretel).
+
+```erb
+<%# app/views/items/show.html.erb %>
+<% breadcrumb breadcrumb_key, @item.name, item_path(@item) %>
+```
+
+By using breadcrumb_key, you can automatically generate the appropriate breadcrumb key based on the controller and action name, reducing the potential for typos and inconsistency.
+
+For a controller named items and an action named show, the breadcrumb_key would return items_show, which can be directly utilized with Gretel's breadcrumb definitions.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yapr/breadcrumb_key.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/breadcrumb_key.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/breadcrumb_key/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "breadcrumb_key"
+  spec.version = BreadcrumbKey::VERSION
+  spec.authors = ["yamitake"]
+  spec.email = ["take.yapr@gmail.com"]
+
+  spec.summary = "A gem for generating consistent breadcrumb keys in Rails applications."
+  spec.description = <<~DESC
+    BreadcrumbKey provides a straightforward way to generate consistent and
+    standardized breadcrumb keys for Rails applications. It's optimized for
+    smooth integration with breadcrumb generation libraries, especially Gretel.
+    By offering flexible configurations, it ensures breadcrumb management
+    is seamless and efficient.
+  DESC
+  spec.homepage = "https://github.com/yapr/breadcrumb_key"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/yapr/breadcrumb_key/commits/main"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/breadcrumb_key/helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# BreadcrumbKey module serves as a namespace for all related functionality.
+module BreadcrumbKey
+  # The Helper module provides utility methods for generating breadcrumb keys
+  # based on the current controller and action.
+  module Helper
+    # Generates a key for breadcrumbs based on the normalized controller path
+    # and action name.
+    #
+    # @return [Symbol] the generated breadcrumb key
+    def breadcrumb_key
+      "#{normalized_controller_path}_#{normalized_action_name}".to_sym
+    end
+
+    private
+
+    # Converts the controller path to a format suitable for breadcrumb key generation.
+    # This primarily involves replacing slashes with underscores.
+    #
+    # @return [String] the normalized controller path
+    def normalized_controller_path
+      controller_path.tr("/", "_")
+    end
+
+    # Retrieves the action name in a format suitable for breadcrumb key generation.
+    # Specific actions like 'create' and 'update' are mapped to more general ones
+    # like 'new' and 'show' respectively.
+    #
+    # @return [String] the normalized action name
+    def normalized_action_name
+      case action_name
+      when "create"
+        "new"
+      when "update"
+        "show"
+      else
+        action_name
+      end
+    end
+  end
+end

data/lib/breadcrumb_key/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "breadcrumb_key/helper"
+require "rails"
+
+module BreadcrumbKey
+  # Railtie integrates BreadcrumbKey::Helper with Rails' ActionView,
+  # based on the `BreadcrumbKey.auto_include_helpers` configuration.
+  class Railtie < Rails::Railtie
+    initializer "breadcrumb_key.view_helpers" do
+      ActiveSupport.on_load :action_view do
+        include BreadcrumbKey::Helper if BreadcrumbKey.auto_include_helpers?
+      end
+    end
+  end
+end

data/lib/breadcrumb_key/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BreadcrumbKey
+  VERSION = "0.1.0"
+end

data/lib/breadcrumb_key.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "breadcrumb_key/version"
+require "breadcrumb_key/railtie" if defined?(Rails)
+
+# This module provides methods related to breadcrumb key generation.
+module BreadcrumbKey
+  class << self
+    attr_accessor :auto_include_helpers
+
+    def auto_include_helpers?
+      auto_include_helpers
+    end
+  end
+
+  self.auto_include_helpers = true
+end

data/sig/breadcrumb_key.rbs

@@ -0,0 +1,4 @@
+module BreadcrumbKey
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: breadcrumb_key
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yamitake
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-27 00:00:00.000000000 Z
+dependencies: []
+description: |
+  BreadcrumbKey provides a straightforward way to generate consistent and
+  standardized breadcrumb keys for Rails applications. It's optimized for
+  smooth integration with breadcrumb generation libraries, especially Gretel.
+  By offering flexible configurations, it ensures breadcrumb management
+  is seamless and efficient.
+email:
+- take.yapr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- breadcrumb_key.gemspec
+- lib/breadcrumb_key.rb
+- lib/breadcrumb_key/helper.rb
+- lib/breadcrumb_key/railtie.rb
+- lib/breadcrumb_key/version.rb
+- sig/breadcrumb_key.rbs
+homepage: https://github.com/yapr/breadcrumb_key
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yapr/breadcrumb_key
+  source_code_uri: https://github.com/yapr/breadcrumb_key
+  changelog_uri: https://github.com/yapr/breadcrumb_key/commits/main
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A gem for generating consistent breadcrumb keys in Rails applications.
+test_files: []