inferred_crumpets 0.2.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62dd5a686657e7ac35de533b178e8a06a0523ae6
-  data.tar.gz: 2f2eb671e2c074abe798766c06351ad463127066
+SHA256:
+  metadata.gz: df7c96a402d26e19410b2e36b5f5627ba7d82d9133ca4505ac2d56e83698a7bd
+  data.tar.gz: 37f975409e519768f883c815924253e727a385b2c956d0b4ad83b3d84998550d
 SHA512:
-  metadata.gz: 055a30abcc20d6277d8b849751b9df67910d6f05259c8be9ea9ad85827fe2c9f6a55cb45156fa50307445ed1b10c35069dbd7d457b8849621e262034dea68ce2
-  data.tar.gz: b8fc00da8bfc2b6a2b025996046468ac62136f850f24032cc9b450f7d351d871916ea41613731e9c37b264726e8fca1215f80c8c8f60648bd8453f5dd941b326
+  metadata.gz: 5bf10586c402d098f3a7bf290156d70f6ed00f431c360616cdba24c68101f9dc723f799e5f97a59e1b3f2fcbcffde5bd703c88b4414cc2511e4a642845ba91e3
+  data.tar.gz: e86965e111940f9493a4a120e27af1cf308c7c22f06afc7ccfcee468b2364aa649f0dfc4a2468cffbfc95c2e449a9d7c349c57a937d4b183ef422ac422d23326

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec rake
+
+  release:
+    needs: build
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Generate Changelog
+        run: |
+          # Get version from github ref (remove 'refs/tags/' and prefix 'v')
+          version="${GITHUB_REF#refs/tags/v}"
+          npx changelog-parser CHANGELOG.md | jq -cr ".versions | .[] | select(.version == \"$version\") | .body" > ${{ github.workflow }}-CHANGELOG.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: ${{ github.workflow }}-CHANGELOG.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: [build, release]
+    name: Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,16 @@
+name: Build and Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6", "2.7", "3.0"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+3.0.0

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # InferredCrumpets
 
+## 0.5.0
+
+- [TT-8631] Update to build with github actions / ruby 3.0 / rails 6.1
+
+## 0.4.2
+
+* [TT-6224] ActiveRecord::Base subjects can now take a custom crumb name
+
+## 0.4.1
+
+* [TT-5835] Fix crumb title for active record relation
+
+## 0.4.0
+
+* [TT-5807] Use crumb title for the subject name
+
+## 0.3.0
+
+* [TT-5087] Add parent to be displayed on index routes
+* [TT-5088] Add ability to link to all actions
+
 ## 0.2.6
 
 * [TT-4479] Added grandparent support

data/README.md

@@ -1,6 +1,7 @@
 # InferredCrumpets
 
-[![Build Status](https://travis-ci.org/sealink/inferred_crumpets.svg?branch=master)](https://travis-ci.org/sealink/inferred_crumpets)
+[![Gem Version](https://badge.fury.io/rb/inferred_crumpets.svg)](http://badge.fury.io/rb/inferred_crumpets)
+[![Build Status](https://github.com/sealink/inferred_crumpets/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/inferred_crumpets/actions)
 
 Automatic breadcrumbs for Rails. Built with [crumpet](https://github.com/blaknite/crumpet).
 
@@ -24,11 +25,22 @@ In the view call `render_inferred_crumbs`
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+## Release
+
+To publish a new version of this gem the following steps must be taken.
+
+* Update the version in the following files
+  ```
+    CHANGELOG.md
+    lib/inferred_crumpets/version.rb
+  ````
+* Create a tag using the format v0.1.0
+* Follow build progress in GitHub actions
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sealink/inferred_crumpets. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/inferred_crumpets.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.add_dependency "rails", ">= 3"
+  spec.add_dependency "rails", ">= 6"
   spec.add_dependency "crumpet", ">= 0.3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/inferred_crumpets.rb

@@ -1,7 +1,9 @@
 require "inferred_crumpets/route_checker"
+require "inferred_crumpets/subject_finder"
 require "inferred_crumpets/builder"
 require "inferred_crumpets/railtie"
 require "inferred_crumpets/version"
 require "inferred_crumpets/view_helpers"
+require "inferred_crumpets/action_processor"
 
 module InferredCrumpets; end

data/lib/inferred_crumpets/action_processor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module InferredCrumpets
+  class ActionProcessor
+    NEW_ACTIONS = %w[new create].freeze
+    private_constant :NEW_ACTIONS
+
+    EDIT_ACTIONS = %w[edit update].freeze
+    private_constant :EDIT_ACTIONS
+
+    IGNORED_ACTIONS = %w[show].freeze
+    private_constant :IGNORED_ACTIONS
+
+    NEW_LABEL = 'New'
+    private_constant :NEW_LABEL
+
+    EDIT_LABEL = 'Edit'
+    private_constant :EDIT_LABEL
+
+    def self.for_action(action)
+      new(action).call
+    end
+
+    def initialize(action)
+      @action = action
+    end
+
+    def call
+      return build_opts(nil) if IGNORED_ACTIONS.include?(@action)
+      return build_opts(NEW_LABEL, false) if NEW_ACTIONS.include?(@action)
+      return build_opts(EDIT_LABEL) if EDIT_ACTIONS.include?(@action)
+
+      build_opts(@action.humanize)
+    end
+
+    private
+
+    def build_opts(label, has_subject = true)
+      OpenStruct.new(label: label, has_subject?: has_subject)
+    end
+  end
+end

data/lib/inferred_crumpets/builder.rb

@@ -3,7 +3,7 @@ module InferredCrumpets
     attr_reader :view_context, :subject, :parents
 
     def self.build_inferred_crumbs!(view_context)
-      subject = view_context.current_object rescue view_context.collection rescue nil
+      subject = SubjectFinder.for_context(view_context)
       return unless subject
       parents = [view_context.parent_object].compact.flatten rescue []
       build_all!(view_context, subject, parents)
@@ -45,8 +45,10 @@ module InferredCrumpets
     def build_crumb_for_collection!
       return if parents.present? && linkable?
 
-      if subject.is_a?(ActiveRecord::Relation)
-        view_context.crumbs.add_crumb subject_name.pluralize.titleize
+      if subject.class.respond_to?(:collection_title)
+        view_context.crumbs.add_crumb subject.class.collection_title, url_for_collection
+      elsif subject.is_a?(ActiveRecord::Relation)
+        view_context.crumbs.add_crumb relation_name.pluralize.titleize
       elsif subject.is_a?(ActiveRecord::Base)
         view_context.crumbs.add_crumb subject.class.table_name.titleize, url_for_collection
       end
@@ -54,16 +56,13 @@ module InferredCrumpets
 
     def build_crumb_for_action!
       return unless subject.is_a?(ActiveRecord::Base)
+      crumb = ActionProcessor.for_action(action)
+      build_crumb_for_subject! if crumb.has_subject?
+      add_crumb(crumb.label) if crumb.label.present?
+    end
 
-      if %w(new create).include?(action)
-        view_context.crumbs.add_crumb('New', wrapper_options: { class: 'active' })
-        return
-      end
-
-      build_crumb_for_subject!
-      if %w(edit update).include?(action)
-        view_context.crumbs.add_crumb('Edit', wrapper_options: { class: 'active' })
-      end
+    def add_crumb(label)
+      view_context.crumbs.add_crumb(label, wrapper_options: { class: 'active' })
     end
 
     def build_crumb_for_subject!
@@ -110,16 +109,16 @@ module InferredCrumpets
       view_context.params[:action]
     end
 
-    def subject_name
+    def relation_name
       subject.respond_to?(:name) && subject.name.present? ? subject.name : subject.to_s
     end
 
-    def class_with_parents
-      [parents.last, transformed_subject.class].compact
+    def subject_name
+      subject.respond_to?(:crumb_title) && subject.crumb_title.present? ? subject.crumb_title : subject.to_s
     end
 
-    def inherited_resources?
-      defined?(InheritedResources) && view_context.controller.responder == InheritedResources::Responder
+    def class_with_parents
+      [parents.last, transformed_subject.class].compact
     end
   end
 end

data/lib/inferred_crumpets/subject_finder.rb

@@ -0,0 +1,17 @@
+module InferredCrumpets
+  class SubjectFinder
+    def self.for_context(context)
+      new(context).call
+    end
+
+    def initialize(context)
+      @context = context
+    end
+
+    def call
+      current_object = begin @context.current_object rescue nil end
+      collection_object = begin @context.collection rescue nil end
+      current_object || collection_object
+    end
+  end
+end

data/lib/inferred_crumpets/version.rb

@@ -1,3 +1,3 @@
 module InferredCrumpets
-  VERSION = "0.2.6"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inferred_crumpets
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Grant Colegate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: crumpet
   requirement: !ruby/object:Gem::Requirement
@@ -42,44 +42,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Automatic breadcrumbs for Rails.
 email:
 - support@travellink.com.au
@@ -87,10 +87,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -101,9 +103,11 @@ files:
 - bin/setup
 - inferred_crumpets.gemspec
 - lib/inferred_crumpets.rb
+- lib/inferred_crumpets/action_processor.rb
 - lib/inferred_crumpets/builder.rb
 - lib/inferred_crumpets/railtie.rb
 - lib/inferred_crumpets/route_checker.rb
+- lib/inferred_crumpets/subject_finder.rb
 - lib/inferred_crumpets/version.rb
 - lib/inferred_crumpets/view_helpers.rb
 homepage: https://github.com/sealink/inferred_crumpets
@@ -118,15 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Automatic breadcrumbs for Rails.

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.14.6