trello_tool 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4cfb13afc59a0bbc26ff8d073ec8205a8be3186078586626f2b1d1a6678534b
+  data.tar.gz: 24100d779e70261e15fd631cf8cc8c6e15bbfe52b4c14e020759244c10ac91f2
+SHA512:
+  metadata.gz: 0645b48ad54aea192469652a91a4d809c502cd32a97a440dbde72a40992ad365ba948c465d8c8e8705b424367f80783111cd36bf13530ad289f8515611a9d34e
+  data.tar.gz: a1a50a0449d75ddd376931d32caf80f057ca973d5825a003d4bee9b5ded2d89aea22501ae235cedebc78e40d89314b972773e701ffb330261aae5dbc314d633b

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  Exclude:
+    - "spec/**/*" # https://github.com/rubocop/rubocop/issues/4222
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - "no_commands" # thor
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,34 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 100`
+# on 2023-12-17 17:00:42 UTC using RuboCop version 1.59.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 35
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 17
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 137

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.2.0] - 2022-05-21
+
+* added `summarize_as_md_long`
+
+## [0.1.0] - 2022-05-21
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tim@red56.uk. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in trello_tool.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "= 1.59.0"
+
+case ENV["TEST_PSYCH_ON"]
+when "3"
+  gem "psych", "< 4"
+when "4"
+  gem "psych", "> 3"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tim Diggins
+
+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,98 @@
+# TrelloTool
+
+Tool for doing basic things to a dev trello using the api. 
+This is for a software development context where the software has explicit version numbers 
+(ie. typically not in a Continuous Delivery situation)
+
+The tool envisages a main trello board with the following lists:
+
+* (some optional lists at the beginning -- "Triage" and "Reference" by default)
+* "To do"
+* "Doing"
+* (at least one "done" list -- "Done" by default)
+* "Next version" (for things that have been merged but not deployed)
+* (a set of lists named after the version numbers e.g. "v1.2.3", "v1.2.2", etc)
+* (a divider list starting with `[` and ending with `]` (which might be empty or contain chores done during that time) named after a month or a sprint, e.g. "[ December ]" or "[ Sprint 1st Sep - 13th Sep ]" etc)
+
+And another board where you archive these lists as they become old
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trello_tool', group: :development
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install trello_tool
+
+
+### Tool Configuration
+
+`bin/trello_tool config` will create a trello_tool.yml file with defaults in it if it doesn't already exist
+
+(This will be in a config directory if you have one, otherwise in the root folder). 
+You will want to add this to your repo to allow this to be shared in your project
+
+You need to configure a couple of things:
+
+* `main_board_url` - this will look something like "https://trello.com/b/sOmeBOarDiD/optional-board-name"
+* `archive_board_url`
+
+You can also configure some defaults
+
+* `next_version_list_name` = "next version"
+* `todo_list_name` = "TO DO"
+* `doing_list_name` = "-- DOING --"
+* `initial_list_names` = ["Triage", "Reference"]
+* `done_list_names` = ["Done"]
+* `version_template` = "v%s"
+* `divider_template` = "[%s]"
+* `too_many_doing` = 2 
+* `too_many_todo` = 10
+
+
+### Trello Authorisation
+
+You need to set the following environment variables to give trello_tool access to your lists
+
+* `TRELLO_DEVELOPER_PUBLIC_KEY` -- you can find this at https://trello.com/app-key/
+* `TRELLO_MEMBER_TOKEN` -- you can create one at https://trello.com/app-key/ "generate a Token"
+
+You can also read more at https://github.com/jeremytregunna/ruby-trello
+
+## Usage
+
+* bin/trello/health
+trello/health
+
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Setup git pre-commit hook
+
+After you clone this repo for the first time you can link in the pre-commit
+script so that rubocop is checked before you commit (you can skip the pre-commit hook with )
+
+    ln -nfs $(pwd)/config/githooks/pre-commit ./.git/hooks/pre-commit
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timdiggins/trello_tool. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/timdiggins/trello_tool/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TrelloTool project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/timdiggins/trello_tool/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config/githooks/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "checking rubocop (committing files only)"
+git diff --cached --name-only | xargs ls | xargs rubocop --force-exclusion

data/exe/trello_tool

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+require File.expand_path("../lib/trello_tool_thor", File.dirname(__FILE__))
+
+TrelloToolThor.start

data/lib/trello_tool/configuration.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "psych"
+
+module TrelloTool
+  # wraps configuration of key features of Trello Tool and automatically pulls in
+  # from a yml file in a specific location and can generate on demand
+  module DefaultConfiguration
+    FILE_NAME = "trello_tool.yml"
+    DEFAULTS = {
+      main_board_url: nil,
+      archive_board_url: nil,
+      next_version_list_name: "next version",
+      todo_list_name: "TO DO",
+      doing_list_name: "-- DOING --",
+      initial_list_names: %w[Triage Reference],
+      done_list_names: ["Done"],
+      version_template: "v%s",
+      divider_template: "[%s]",
+      too_many_doing: 2,
+      too_many_todo: 10
+    }.freeze
+  end
+  Configuration = Struct.new(*DefaultConfiguration::DEFAULTS.keys, keyword_init: true) do
+    include DefaultConfiguration
+
+    def initialize(root_dir = Dir.pwd)
+      @root_dir = root_dir
+      super(DefaultConfiguration::DEFAULTS)
+      load_from_config_file if config_file_exists?
+    end
+
+    # generates a file based on current settings
+    def generate
+      File.open(config_file, "w") do |f|
+        Psych.dump(to_h { |k, v| [k.to_s, v] }, f) # rubocop:disable Style/HashTransformKeys doesn't work
+      end
+    end
+
+    def config_file_exists?
+      File.exist?(config_file)
+    end
+
+    def config_file
+      File.join(config_dir, DefaultConfiguration::FILE_NAME)
+    end
+
+    # an ordered array of expected list names before the version and month names
+    def expected_list_names
+      @expected_list_names ||= initial_list_names + [todo_list_name,
+                                                     doing_list_name] + done_list_names + [next_version_list_name]
+    end
+
+    def divider_list_name?(list_name)
+      divider_list_matcher.match?(list_name)
+    end
+
+    def divider_list_matcher
+      @divider_list_matcher ||= begin
+        pieces = divider_template.split(/(%s)/)
+        pieces = pieces.map { |piece| piece == "%s" ? ".+" : Regexp.escape(piece) }
+        Regexp.new("\\A#{pieces.join}\\Z")
+      end
+    end
+
+    def version_list_name?(list_name)
+      version_list_matcher.match?(list_name)
+    end
+
+    def version_list_matcher
+      @version_list_matcher ||= Regexp.new("\\A#{format(version_template, '\d+[.]\d+[.]\d+')}")
+    end
+
+    def month_template=(template)
+      self.divider_template = template
+      puts "DEPRECATED: use divider_template instead of month_template"
+    end
+
+    protected
+
+    def config_dir
+      @config_dir ||= find_config_dir
+    end
+
+    def find_config_dir
+      [
+        File.join(@root_dir, "config"),
+        @root_dir
+      ].each do |target|
+        return target if Dir.exist?(target)
+      end
+    end
+
+    def load_from_config_file
+      Psych.safe_load(File.read(config_file)).each do |key, value|
+        send("#{key}=", value)
+      end
+      self.initial_list_names ||= []
+    end
+  end
+end

data/lib/trello_tool/health.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module TrelloTool
+  # Health analysis of a board
+  class Health
+    attr_reader :board, :configuration, :symbols_and_colours, :unexpected, :expected_lists
+
+    def initialize(board, configuration)
+      @board = board
+      @configuration = configuration
+      @symbols_and_colours = []
+      @unexpected = []
+      @expected_lists = {}
+      analyze
+    end
+
+    def each_issue_with_severity
+      unexpected.each do |list, index|
+        yield list.name.inspect, "Unexpected @ ##{index + 1}"
+      end
+      yield todo_list_issue if todo_list_issue
+      yield doing_list_issue if doing_list_issue
+    end
+
+    def each_expected_list_with_length
+      expected_lists.each do |name, value|
+        yield name, value[:length]
+      end
+    end
+
+    protected
+
+    def todo_list
+      expected_lists[configuration.todo_list_name]
+    end
+
+    def doing_list
+      expected_lists[configuration.doing_list_name]
+    end
+
+    def doing_list_issue
+      if !doing_list
+        ["No doing list (looking for #{configuration.doing_list_name.inspect})", "Unconfigured"]
+      elsif configuration.too_many_doing <= doing_list[:length]
+        ["Cards in #{configuration.doing_list_name.inspect} has #{doing_list[:length]} cards (> #{configuration.too_many_doing})", "Bad"]
+      end
+    end
+
+    def todo_list_issue
+      if !todo_list
+        ["No to do list (looking for #{configuration.todo_list_name.inspect})", "Unconfigured"]
+      elsif configuration.too_many_todo <= todo_list[:length]
+        ["Cards in #{configuration.todo_list_name.inspect} has #{todo_list[:length]} cards (> #{configuration.too_many_todo})", "Bad"]
+      end
+    end
+
+    def analyze
+      board.lists.each_with_index do |list, index|
+        if list.name == configuration.next_version_list_name
+          add_expected_list(list, "V", Thor::Shell::Color::BOLD)
+        elsif list.name == configuration.todo_list_name
+          add_expected_list(list, "+", Thor::Shell::Color::BOLD)
+        elsif list.name == configuration.doing_list_name
+          add_expected_list(list, "d", Thor::Shell::Color::BOLD)
+        elsif configuration.expected_list_names.include?(list.name)
+          add_expected_list(list, ".", Thor::Shell::Color::CYAN)
+        elsif configuration.divider_list_matcher.match?(list.name)
+          symbols_and_colours << ["|", Thor::Shell::Color::CYAN]
+        elsif configuration.version_list_matcher.match?(list.name)
+          symbols_and_colours << ["v", Thor::Shell::Color::CYAN]
+        else
+          add_unexpected_list(list, index)
+        end
+      end
+    end
+
+    def add_expected_list(list, symbol, colour)
+      expected_lists[list.name] = { length: list.cards.length }
+      symbols_and_colours << [symbol, colour]
+    end
+
+    def add_unexpected_list(list, index)
+      unexpected << [list, index]
+      symbols_and_colours << ["?", Thor::Shell::Color::RED]
+    end
+  end
+end

data/lib/trello_tool/trello_client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "trello"
+require "trello_tool/util"
+
+module TrelloTool
+  # Wrapped client for trello adapting it to things we need it to do
+  class TrelloClient < SimpleDelegator
+    include TrelloTool::Util
+    attr_reader :client, :configuration
+
+    # @param configuration[TrelloTool::Configuration]
+    def initialize(configuration)
+      @configuration = configuration
+      @client = Trello::Client.new(
+        developer_public_key: ENV["TRELLO_DEVELOPER_PUBLIC_KEY"],
+        member_token: ENV["TRELLO_MEMBER_TOKEN"]
+      )
+      super(@client)
+    end
+
+    def authorized(&block)
+      Trello.configure do |config|
+        config.developer_public_key = ENV["TRELLO_DEVELOPER_PUBLIC_KEY"]
+        config.member_token = ENV["TRELLO_MEMBER_TOKEN"]
+      end
+      block.call
+      Trello.configure do |config|
+        config.developer_public_key = nil
+        config.member_token = nil
+      end
+    end
+
+    def main_board
+      @main_board ||= client.find(:boards, extract_id_from_url(configuration.main_board_url))
+    end
+
+    def archive_board
+      @archive_board ||= client.find(:boards, extract_id_from_url(configuration.archive_board_url))
+    end
+
+    # @return [Array] of list names with left index, ordered from right
+    def archiveable_list_names_with_index
+      @archiveable_list_names_with_index ||= [].tap do |lists|
+        all_lists = main_board.lists
+        all_lists.reverse.each_with_index do |list, right_index|
+          if (divider_list?(list) && right_index.zero?) || version_list?(list) # rubocop:disable Style/GuardClause
+            left_index = all_lists.length - right_index - 1
+            lists << [list.name, left_index]
+          else
+            break
+          end
+        end
+      end
+    end
+
+    def next_version_list
+      @next_version_list ||= find_list_by_list_name(main_board, configuration.next_version_list_name)
+    end
+
+    protected
+
+    def divider_list?(list)
+      configuration.divider_list_name?(list.name)
+    end
+
+    def version_list?(list)
+      configuration.version_list_name?(list.name)
+    end
+  end
+end

data/lib/trello_tool/util.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "trello"
+
+module TrelloTool
+  # small utility methods for handling trello urls
+  module Util
+    private
+
+    def extract_id_from_url(trello_board_url)
+      match_data = %r{https://trello.com/b/([a-zA-Z0-9]+)/?.*}.match(trello_board_url)
+      raise "Unexpectedly #{trello_board_url} doesn't match https://trelloc.om/b/ID/description" unless match_data
+
+      match_data[1]
+    end
+
+    # @param board [Trello::Board]
+    # @param list_name [String]
+    # @return [Trello::List]
+    def find_list_by_list_name(board, list_name)
+      list = board.lists.detect { |l| l.name == list_name }
+      return list if list
+
+      puts "couldn't find list called #{list_name.inspect}. found: #{board.lists.map(&:name).map(&:inspect).join(', ')}."
+      nil
+    end
+
+    def find_pos_before_list(board, target_list)
+      previous_list_pos = 0
+      board.lists.each do |this_list|
+        return previous_list_pos && ((target_list.pos + previous_list_pos) / 2) if this_list == target_list
+
+        previous_list_pos = this_list.pos
+      end
+
+      puts "couldn't find list"
+      nil
+    end
+  end
+end

data/lib/trello_tool/version.rb

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

data/lib/trello_tool.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "trello_tool/version"
+
+module TrelloTool
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/trello_tool_thor.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "thor"
+require "trello_tool/configuration"
+require "trello_tool/health"
+require "trello_tool/trello_client"
+require "trello_tool/util"
+
+# The thor class
+# rubocop:disable Metrics/ClassLength
+class TrelloToolThor < Thor
+  include TrelloTool::Util
+
+  def self.configuration
+    @configuration ||= TrelloTool::Configuration.new
+  end
+
+  no_commands do
+    delegate :configuration, to: :class
+  end
+
+  namespace :trello_tool
+
+  desc "config", "generates default config file unless already present"
+
+  def config
+    if configuration.config_file_exists?
+      say("Configuration already exists at #{configuration.config_file}")
+    else
+      configuration.generate
+      say("Generated configuration at #{configuration.config_file}. You will need to specify trello urls")
+    end
+  end
+
+  desc "archive_last (N)",
+       "archives the last N lists from the end of #{configuration.main_board_url} to the beginning of #{configuration.archive_board_url}"
+
+  def archive_last(to_archive = "1")
+    number_to_archive = to_archive.to_i
+    say "archiving #{number_to_archive} lists:"
+    lists_reversed = client.main_board.lists.reverse
+    0.upto(number_to_archive - 1).each do |index|
+      say(format("\r%<count>2s / %<total>s", count: index + 1, total: number_to_archive), Thor::Shell::Color::GREEN,
+          false)
+      list = lists_reversed[index]
+      break unless list
+
+      list.move_to_board(client.archive_board)
+      say "\r * #{list.name.inspect}#{' ' * 20}\n"
+    end
+    say
+  end
+
+  desc "archive", "archives one month's worth"
+
+  def archive
+    client.archiveable_list_names_with_index.each do |list, index|
+      say "* #{list.inspect} @##{index + 1}"
+    end
+    archive_last(client.archiveable_list_names_with_index.length) if yes?("archive them?")
+  end
+
+  desc "health", "checks whether main board is 'healthy'"
+
+  def health
+    health = TrelloTool::Health.new(client.main_board, configuration)
+    health.symbols_and_colours.each do |symbol, colour|
+      say(symbol, colour, false)
+    end
+    say
+    health.each_issue_with_severity do |issue, severity|
+      say(format("%-20s", "#{severity}:"), Thor::Shell::Color::RED, false)
+      say(issue)
+    end
+    health.each_expected_list_with_length do |list_name, length|
+      say(" * #{list_name} (#{length})")
+    end
+  end
+
+  desc "lists (BOARD_URL)", "prints out lists in a board (defaults to main board)"
+
+  def lists(url = configuration.main_board_url)
+    board = client.find(:boards, extract_id_from_url(url))
+    say board.name
+    say url
+    say
+    board.lists.each do |list|
+      say "* #{list.name}"
+    end
+  end
+
+  desc "release (VERSION)",
+       "rename next_version to VERSION and create next_version. If VERSION isn't specified use whatever is in ./.RELEASE_NEW_VERSION"
+
+  def release(version = nil)
+    version ||= File.exist?(".RELEASE_NEW_VERSION") && File.read(".RELEASE_NEW_VERSION").strip
+    unless version
+      say("Usage: release VERSION # or put version number in .RELEASE_NEW_VERSION")
+      return
+    end
+
+    next_version_list = client.next_version_list
+    next_version_list.name = version
+    next_version_list.save
+    client.authorized do
+      Trello::List.create(name: configuration.next_version_list_name, board_id: client.main_board.id,
+                          pos: find_pos_before_list(client.main_board, next_version_list))
+    end
+  end
+
+  desc "summarize_as_md (LIST_NAME (BOARD_URL))",
+       "prints out markdown summarizing all cards in a list in a board (defaults to 'to do' list of main board)"
+
+  def summarize_as_md(list_name = configuration.todo_list_name, url = configuration.main_board_url)
+    board = client.find(:boards, extract_id_from_url(url))
+    list = find_list_by_list_name(board, list_name)
+    return unless list
+
+    cards = list.cards
+    say "\n# #{list.name} (#{cards.length} cards)\n\n"
+    list.cards.each do |card|
+      say "* [#{card.name}](#{card.url})"
+    end
+    say "\n"
+  end
+
+  desc "summarize_as_md_long (LIST_NAME (BOARD_URL))",
+       "prints out markdown summarizing all cards in a list in a board" \
+       "(defaults to 'to do' list of main board) -- includes attachment urls"
+
+  def summarize_as_md_long(list_name = configuration.todo_list_name, url = configuration.main_board_url)
+    board = client.find(:boards, extract_id_from_url(url))
+    list = find_list_by_list_name(board, list_name)
+    return unless list
+
+    cards = list.cards
+    say "\n# #{list.name} (#{cards.length} cards)\n\n"
+    list.cards.each do |card|
+      labels = card.labels.map { |label| "[#{label.name}]" }.join(" ")
+      say "* #{card.name} #{labels}\n  #{card.url}"
+      card.attachments.each do |attachment|
+        next unless (url = attachment.url)
+        next if %w[pdf png jpg].include?(url.split(".").last&.downcase)
+
+        say "  - #{url}"
+      end
+    end
+    say "\n"
+  end
+  desc "summarize_as_urls (LIST_NAME (BOARD_URL))",
+       "prints out urls summarizing all cards in a list in a board (defaults to 'to do' list of main board)"
+  def summarize_as_urls(list_name = configuration.todo_list_name, url = configuration.main_board_url)
+    board = client.find(:boards, extract_id_from_url(url))
+    list = find_list_by_list_name(board, list_name)
+    return unless list
+
+    cards = list.cards
+    say "\n#{list.name} (#{cards.length} cards)\n\n"
+    list.cards.each do |card|
+      say card.url
+    end
+    say "\n"
+  end
+
+  private
+
+  def client
+    TrelloTool::TrelloClient.new(configuration)
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/trello_tool.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/trello_tool/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "trello_tool"
+  spec.version = TrelloTool::VERSION
+  spec.authors = ["Tim Diggins"]
+  spec.email = ["tim@red56.uk"]
+
+  spec.summary = "Tool for doing basic things to a dev trello using the api."
+  spec.homepage = "https://github.com/timdiggins/trello_tool"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/timdiggins/trello_tool/blob/main/CHANGELOG.md"
+
+  # 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(File.expand_path(__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"]
+
+  spec.add_dependency "ruby-trello"
+  spec.add_dependency "thor"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: trello_tool
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tim Diggins
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- tim@red56.uk
+executables:
+- trello_tool
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/githooks/pre-commit
+- exe/trello_tool
+- lib/trello_tool.rb
+- lib/trello_tool/configuration.rb
+- lib/trello_tool/health.rb
+- lib/trello_tool/trello_client.rb
+- lib/trello_tool/util.rb
+- lib/trello_tool/version.rb
+- lib/trello_tool_thor.rb
+- trello_tool.gemspec
+homepage: https://github.com/timdiggins/trello_tool
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/timdiggins/trello_tool
+  source_code_uri: https://github.com/timdiggins/trello_tool
+  changelog_uri: https://github.com/timdiggins/trello_tool/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: Tool for doing basic things to a dev trello using the api.
+test_files: []