plan_my_stuff 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea3a8ca1126f0be8286e82ef98774da81ea78bc771d27bc2006e18f926c97f1d
-  data.tar.gz: 412880ac9fccf6bd35e35b276854c53f267384bae8a56d9f57520f9683f45a5b
+  metadata.gz: a70108268136db83554f3bda05e5ab384b1d2c6f1d8d05f4554cef037eeee8a8
+  data.tar.gz: 5c713eca795782628fab95c61c3d5876934d22b04e0c539e26d35369a376491b
 SHA512:
-  metadata.gz: fa973f02a46eab0d5385e59f8d8a667e1549c2bbd3fd0108edb0f3cc4d09d5a9f73f6d64f1760cc6dbc568237d7508df15d727958159eab2ea8b317fe0cd10e6
-  data.tar.gz: 4a5a4a24c661a32d5b8866882b41c71fb52991cb83d3cf92b7a7c7d442b86c13fb2881db781fd0aa393e8335a3679937a829325ea75402c8a32d2c65e0d1ceb4
+  metadata.gz: 253f04b4c10e8d1557d5915daa1a757d5678c717cd4b7b97d50450ed4e8417c05f044bbf97c235de17328a4fd3ee27f8a08bbaf1b874ce0dccd294760f370114
+  data.tar.gz: 331d2a9b48418722eb3049099817e390095c07deb70e59670ead47cbf98555bb2c44e12b1cdc9824abd28fd6795c80fa8aac124ea5779dd9262323a7bc96c10a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.5.0
+
+### Added
+
+- `post_install_message` in gemspec listing available rake tasks and generators
+- `rake plan_my_stuff:install` and `rake plan_my_stuff:views` aliases for the Rails generators
+
+### Fixed
+
+- `TestingProjectItem.create!` left new items with a blank Test Status; now defaults to `Todo`
+- `TestingProjectItem.create!` left new items with no Pass Mode; now defaults to `all`
+
 ## 0.4.0
 
 - Full feature set release before PR

data/lib/generators/plan_my_stuff/install/templates/initializer.rb

@@ -56,6 +56,14 @@ PMS.configure do |config|
   # config.support_method = :support?
   # config.support_method = ->(user) { user.role.in?(%w[support admin]) }
 
+  # Map of app user id (whatever `user_id_method` returns) to GitHub login.
+  # Used by the "Take" UI flow to assign the GitHub user when a support
+  # user claims an issue.
+  # config.github_login_for = {
+  #   1 => 'some_username',
+  #   2 => 'octocat',
+  # }
+
   # --------------------------------------------------------------------------
   # Engine authentication
   # --------------------------------------------------------------------------
@@ -72,6 +80,16 @@ PMS.configure do |config|
   # :commonmarker (default) or :redcarpet -- the chosen gem must be in your Gemfile.
   # config.markdown_renderer = :commonmarker
 
+  # Default options passed to the markdown renderer. Per-call options merge on top.
+  # For :commonmarker -- passed as `options:` to `Commonmarker.to_html`:
+  #   config.markdown_options = { render: { hardbreaks: true } }
+  # For :redcarpet -- :render_options and :renderer are extracted for the HTML
+  #   renderer; remaining keys are extensions passed to `Redcarpet::Markdown.new`:
+  #   config.markdown_options = {
+  #     render_options: { hard_wrap: true, no_styles: true },
+  #     autolink: true,
+  #   }
+
   # --------------------------------------------------------------------------
   # URL prefix
   # --------------------------------------------------------------------------
@@ -118,6 +136,12 @@ PMS.configure do |config|
   # Comment-only fields (merged on top of shared, context wins on conflicts):
   # config.comment_custom_fields = {}
 
+  # Project-only fields (merged on top of shared, context wins on conflicts):
+  # config.project_custom_fields = {}
+
+  # Testing-project-only fields (merged on top of shared, context wins on conflicts):
+  # config.testing_custom_fields = {}
+
   # --------------------------------------------------------------------------
   # Release pipeline
   # --------------------------------------------------------------------------
@@ -204,6 +228,16 @@ PMS.configure do |config|
   # config.sns_verifier_class = Aws::SNS::MessageVerifier
   # config.sns_verifier_error = Aws::SNS::MessageVerifier::VerificationError
 
+  # --------------------------------------------------------------------------
+  # Caching
+  # --------------------------------------------------------------------------
+  # ETag-based HTTP caching of GitHub reads via Rails.cache. Defaults to true.
+  # config.cache_enabled = true
+
+  # Opaque version string baked into every PMS cache key. Bump it to invalidate
+  # all cached entries from the consuming app's side (e.g. after a deploy).
+  # config.cache_version = Rails.configuration.x.image_tag
+
   # --------------------------------------------------------------------------
   # Route mounting
   # --------------------------------------------------------------------------

data/lib/plan_my_stuff/testing_project_item.rb

@@ -4,6 +4,38 @@ module PlanMyStuff
   # A project item belonging to a TestingProject. Extends BaseProjectItem with
   # testing-specific field updaters and pass/fail sign-off logic.
   class TestingProjectItem < PlanMyStuff::BaseProjectItem
+    # Default "Test Status" applied to newly-created testing items so they do
+    # not land in GitHub's blank-status lane.
+    DEFAULT_STATUS = 'Todo'
+
+    # Default "Pass Mode" applied to newly-created testing items so sign-off
+    # semantics are defined up front (every tester must pass).
+    DEFAULT_PASS_MODE = 'all'
+
+    class << self
+      # @see super
+      #
+      # Sets Test Status to +DEFAULT_STATUS+ on the new item so it lands in
+      # the Todo column rather than the blank-status lane. Uses +move_item+
+      # directly (not +item.move_to!+) so the initial status does not fire
+      # a spurious +project_item.status_changed+ event.
+      #
+      # Also seeds Pass Mode to +DEFAULT_PASS_MODE+ so sign-off semantics
+      # are defined from item creation forward.
+      #
+      def create!(issue_or_title, draft: false, body: nil, project_number: nil, user: nil)
+        item = super
+        move_item(project_number: item.project.number, item_id: item.id, status: DEFAULT_STATUS)
+        update_single_select_field!(
+          project_number: item.project.number,
+          item_id: item.id,
+          field_name: 'Pass Mode',
+          value: DEFAULT_PASS_MODE,
+        )
+        item
+      end
+    end
+
     # Updates the Pass Mode single-select field on this testing project item.
     #
     # @param value [String] "all" or "any"

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)

data/lib/tasks/plan_my_stuff.rake

@@ -1,6 +1,22 @@
 # frozen_string_literal: true
 
 namespace :plan_my_stuff do
+  desc 'Run the plan_my_stuff install generator (alias for `rails g plan_my_stuff:install`)'
+  task install: :environment do
+    require 'rails/generators'
+
+    require 'generators/plan_my_stuff/install/install_generator'
+    PlanMyStuff::Generators::InstallGenerator.start([])
+  end
+
+  desc 'Copy plan_my_stuff view templates (alias for `rails g plan_my_stuff:views`)'
+  task views: :environment do
+    require 'rails/generators'
+
+    require 'generators/plan_my_stuff/views/views_generator'
+    PlanMyStuff::Generators::ViewsGenerator.start([])
+  end
+
   namespace :webhooks do
     desc 'Create an organization webhook (URL=... [EVENTS=ev1,ev2])'
     task create_org: :environment do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brands Insurance
@@ -158,7 +158,33 @@ metadata:
   homepage_uri: https://github.com/brandsinsurance/PlanMyStuff/
   source_code_uri: https://github.com/brandsinsurance/PlanMyStuff
   changelog_uri: https://github.com/brandsinsurance/PlanMyStuff/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: |
+  Thanks for installing plan_my_stuff!
+
+  Getting started:
+
+    rake plan_my_stuff:install
+      Generates config/initializers/plan_my_stuff.rb and mounts the engine
+
+    rake plan_my_stuff:views
+      Copies view templates to app/views/plan_my_stuff/ (optional)
+
+  Available rake tasks:
+
+    plan_my_stuff:verify
+      Verify token, org, repos, and project access
+
+    plan_my_stuff:webhooks:create_org       URL=... [EVENTS=...]
+    plan_my_stuff:webhooks:create_repo      URL=... [REPO=owner/name] [EVENTS=...]
+    plan_my_stuff:webhooks:replay           ENDPOINT_URL=... WEBHOOK_URL=... [SCOPE=org|repo]
+    plan_my_stuff:webhooks:listen           ENDPOINT_URL=... [ORG_WEBHOOK_URL=...] [REPO_WEBHOOK_URL=... REPO=...]
+    plan_my_stuff:webhooks:simulate_aws     ENDPOINT_URL=... [EVENT=...]
+
+    plan_my_stuff:reminders:sweep           [REPO=<key>]
+
+    plan_my_stuff:testing:create_template   [TITLE=...]
+
+  Run `rake -D plan_my_stuff` for full descriptions.
 rdoc_options: []
 require_paths:
 - lib