checkoff 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca8acc9a67554659cd34a8a9a60f539e834088bc896ef6e3bb7761e75183ac8a
-  data.tar.gz: ff10088e95968a73ccb5590b316a4b6e3f9ff49572ab87271f710bc9a02f25b3
+  metadata.gz: '084d67648e9668ace7b8d103e4e1f9ec1d8d66bb0048cc1f8c7d652dd115397c'
+  data.tar.gz: e1cf9b3f5639841462290ac1a5228fa5ca3dba3d4e70c62d84644184e63e6b89
 SHA512:
-  metadata.gz: a80da7607358f742d06fec48be66df5b53d41832ecbc16bdaae3a023c9a929d3cfff0a983ccbbdb381d1079187589c0e3c367ade5b8f7b92fe36fcd5025bfc65
-  data.tar.gz: dc9126b9a3366626c81f1eef2f32c517f9b978e5ec07052cc2194bf718e2e9c778da2fe2b09b6a1d07213437b7bf3265d636dcd071bb7ca01d822819883d1087
+  metadata.gz: f49cd3bded68cdcc502b26ac03fe6b7e073aaa93294c4104b36c7bfb014fbbc9e3a792fb85d712e39251ec13ce1e7430e067c06a3075120bb37bcf23de457672
+  data.tar.gz: a4886b2dabc6332688434e0bce0009c1bf1db10b97588f857dc729320b5f840e4f8368afaf03ea78bdbf2e1025c1f4fa9d23839d19d0df8fa2650839226915f0

data/.gitignore

@@ -57,8 +57,7 @@ requirements_dev.txt.installed
 /pkg/
 /spec/reports/
 /tmp/
-/coverage/.resultset.json
-/coverage/.resultset.json.lock
-/coverage/assets/
-/coverage/index.html
-/coverage/lcov/
+/coverage/
+
+# direnv
+/.envrc

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.20.0)
+    checkoff (0.22.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -27,6 +27,8 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
     ast (2.4.2)
     builder (3.2.4)
@@ -39,7 +41,9 @@ GEM
     childprocess (4.0.0)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
-    dalli (3.2.2)
+    crack (0.4.5)
+      rexml
+    dalli (3.2.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
     fakeweb (1.3.0)
@@ -66,6 +70,7 @@ GEM
       faraday_middleware
       multi_json
     gli (2.21.0)
+    hashdiff (1.0.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     imagen (0.1.8)
@@ -116,6 +121,7 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (5.0.0)
     rack (2.2.4)
     rainbow (3.1.1)
     rake (13.0.3)
@@ -168,11 +174,16 @@ GEM
       rainbow (>= 2.1, < 4.0)
       rugged (>= 0.27, < 1.6)
     unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
   x86_64-darwin-19
   x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -195,6 +206,7 @@ DEPENDENCIES
   simplecov (>= 0.18.0)
   simplecov-lcov
   undercover
+  webmock
 
 BUNDLED WITH
-   2.3.23
+   2.3.26

data/Makefile

@@ -15,7 +15,17 @@ export PRINT_HELP_PYSCRIPT
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-default: clean-coverage test coverage quality ## run default typechecking, tests and quality
+default: clean-coverage test coverage clean-typecoverage typecheck typecoverage quality ## run default typechecking, tests and quality
+
+typecheck: ## validate types in code and configuration
+
+citypecheck: typecheck ## Run type check from CircleCI
+
+typecoverage: typecheck ## Run type checking and then ratchet coverage in metrics/
+
+clean-typecoverage: ## Clean out type-related coverage previous results to avoid flaky results
+
+citypecoverage: typecoverage ## Run type checking, ratchet coverage, and then complain if ratchet needs to be committed
 
 requirements_dev.txt.installed: requirements_dev.txt
 	pip install -q --disable-pip-version-check -r requirements_dev.txt
@@ -42,8 +52,6 @@ clean: clear_metrics ## remove all built artifacts
 
 citest: test ## Run unit tests from CircleCI
 
-typecheck: ## validate types in code and configuration
-
 overcommit: ## run precommit quality checks
 	bundle exec overcommit --run
 
@@ -66,17 +74,7 @@ coverage: test report-coverage ## check code coverage
 
 report-coverage: test ## Report summary of coverage to stdout, and generate HTML, XML coverage report
 
-report-coverage-to-codecov: report-coverage ## use codecov.io for PR-scoped code coverage reports
-	@curl -Os https://uploader.codecov.io/latest/linux/codecov
-	@chmod +x codecov
-	@./codecov --file coverage/lcov/checkoff.lcov --nonZero
-
-# https://github.com/bluelabsio/records-mover/blob/master/Makefile#L25
-cicoverage: report-coverage-to-codecov ## check code coverage, then report to codecov
-	@echo "Looking for un-checked-in unit test coverage metrics..."
-	@git status --porcelain coverage/.last_run.json
-	@git diff coverage/.last_run.json
-	@test -z "$(git status --porcelain coverage/.last_run.json)"
+cicoverage: coverage ## check code coverage
 
 update_from_cookiecutter: ## Bring in changes from template project used to create this repo
 	bundle exec overcommit --uninstall

data/checkoff.gemspec

@@ -51,6 +51,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', ['>=0.18.0']
   spec.add_development_dependency 'simplecov-lcov'
   spec.add_development_dependency 'undercover'
+  spec.add_development_dependency 'webmock'
   spec.metadata = {
     'rubygems_mfa_required' => 'true',
   }

data/fix.sh

@@ -188,7 +188,7 @@ ensure_bundle() {
   #
   # This affects nokogiri, which will try to reinstall itself in
   # Docker builds where it's already installed if this is not run.
-  for platform in x86_64-darwin-20 x86_64-linux
+  for platform in x86_64-darwin-21 x86_64-linux
   do
     grep "${platform:?}" Gemfile.lock >/dev/null 2>&1 || bundle lock --add-platform "${platform:?}"
   done

data/lib/checkoff/internal/config_loader.rb

@@ -18,7 +18,7 @@ module Checkoff
         config_value = @config[key]
         return config_value unless config_value.nil?
 
-        ENV[envvar_name(key)]
+        ENV.fetch(envvar_name(key), nil)
       end
 
       def fetch(key)

data/lib/checkoff/internal/search_url/parser.rb

@@ -11,7 +11,9 @@ module Checkoff
       # Parse Asana search URLs into parameters suitable to pass into
       # the /workspaces/{workspace_gid}/tasks/search endpoint
       class Parser
-        def initialize(_deps = {}); end
+        def initialize(_deps = {})
+          # allow dependencies to be passed in by tests
+        end
 
         def convert_params(url)
           url_params = CGI.parse(URI.parse(url).query)

data/lib/checkoff/internal/search_url/simple_param_converter.rb

@@ -5,32 +5,69 @@ require_relative 'custom_field_param_converter'
 module Checkoff
   module Internal
     module SearchUrl
+      # See
+      # https://developers.asana.com/docs/search-tasks-in-a-workspace
+      # for the return value of 'convert' here:
       module SimpleParam
         # base class for handling different types of search url params
         class SimpleParam
-          def initialize(values:)
+          def initialize(key:, values:)
+            @key = key
             @values = values
           end
 
           private
 
-          attr_reader :values
+          def single_value
+            @single_value ||= begin
+              raise "Teach me how to handle #{key} = #{values}" if values.length != 1
+
+              values.fetch(0)
+            end
+          end
+
+          attr_reader :key, :values
         end
 
         # Handle 'any_projects.ids' search url param
         class AnyProjectsIds < SimpleParam
+          def projects
+            @projects ||= []
+          end
+
+          def sections
+            @sections ||= []
+          end
+
+          def parse!
+            # Inputs:
+            #   123_column_456 means "abc" project, "def" section
+            #   123 means "abc" project
+            #   123~456 means "abc" and "def" projects
+            project_section_pairs = single_value.split('~')
+            project_section_pairs.each do |project_section_pair|
+              project, section = project_section_pair.split('_column_')
+              if section.nil?
+                projects << project
+              else
+                sections << section
+              end
+            end
+          end
+
           def convert
-            ['projects.any', values.join(',')]
+            parse!
+            out = {}
+            out['projects.any'] = projects.join(',') unless projects.empty?
+            out['sections.any'] = sections.join(',') unless sections.empty?
+            out.to_a.flatten
           end
         end
 
         # Handle 'completion' search url param
         class Completion < SimpleParam
           def convert
-            raise "Teach me how to handle #{key} = #{values}" if values.length != 1
-
-            value = values.fetch(0)
-            raise "Teach me how to handle #{key} = #{values}" if value != 'incomplete'
+            raise "Teach me how to handle #{key} = #{values}" if single_value != 'incomplete'
 
             ['completed', false]
           end
@@ -39,13 +76,27 @@ module Checkoff
         # Handle 'not_tags.ids' search url param
         class NotTagsIds < SimpleParam
           def convert
-            raise "Teach me how to handle #{key} = #{values}" if values.length != 1
-
-            value = values.fetch(0)
-            tag_ids = value.split('~')
+            tag_ids = single_value.split('~')
             ['tags.not', tag_ids.join(',')]
           end
         end
+
+        # handle 'subtask' search url param
+        class Subtask < SimpleParam
+          def convert
+            return ['is_subtask', false] if single_value == 'is_not_subtask'
+
+            raise "Teach me how to handle #{key} = #{values}"
+          end
+        end
+
+        # Handle 'any_tags.ids' search url param
+        class AnyTagsIds < SimpleParam
+          def convert
+            tag_ids = single_value.split('~')
+            ['tags.any', tag_ids.join(',')]
+          end
+        end
       end
 
       # Convert simple parameters - ones where the param name itself
@@ -56,9 +107,9 @@ module Checkoff
         end
 
         def convert
-          simple_url_params.to_a.to_h do |key, values|
-            convert_arg(key, values)
-          end
+          simple_url_params.to_a.flat_map do |key, values|
+            convert_arg(key, values).each_slice(2).to_a
+          end.to_h
         end
 
         private
@@ -67,12 +118,14 @@ module Checkoff
           'any_projects.ids' => SimpleParam::AnyProjectsIds,
           'completion' => SimpleParam::Completion,
           'not_tags.ids' => SimpleParam::NotTagsIds,
+          'any_tags.ids' => SimpleParam::AnyTagsIds,
+          'subtask' => SimpleParam::Subtask,
         }.freeze
 
         # https://developers.asana.com/docs/search-tasks-in-a-workspace
         def convert_arg(key, values)
           clazz = ARGS.fetch(key)
-          clazz.new(values: values).convert
+          clazz.new(key: key, values: values).convert
         end
 
         attr_reader :simple_url_params

data/lib/checkoff/sections.rb

@@ -110,7 +110,8 @@ module Checkoff
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
 
       current_section = membership['section']['name']
-      current_section = nil if ['(no section)', 'Untitled section'].include?(current_section)
+      inbox_section_names = ['(no section)', 'Untitled section', 'Inbox']
+      current_section = nil if inbox_section_names.include?(current_section)
       by_section[current_section] ||= []
       by_section[current_section] << task
     end

data/lib/checkoff/version.rb

@@ -3,5 +3,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.20.0'
+  VERSION = '0.22.0'
 end

data/rakelib/clear_metrics.rake

@@ -3,15 +3,7 @@
 desc 'Ensure that any locally ratcheted coverage metrics are cleared back ' \
      'to git baseline'
 task :clear_metrics do |_t|
-  ret =
-    system('git checkout coverage/.last_run.json')
-  raise unless ret
-
   # Without this old lines which are removed are still counted,
   # leading to inconsistent coverage percentages between runs.
-  #
-  # need to save coverage/.last_run.json
-  ret =
-    system('rm -fr coverage/assets coverage/.*.json.lock coverage/lcov/* coverage/index.html coverage/.resultset.json')
-  raise unless ret
+  raise unless system('rm -fr coverage/')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -318,6 +318,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - vince@broz.cc
@@ -327,7 +341,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
-- ".envrc"
 - ".git-hooks/pre_commit/circle_ci.rb"
 - ".gitattributes"
 - ".gitignore"
@@ -352,7 +365,6 @@ files:
 - bin/rake
 - bin/setup
 - checkoff.gemspec
-- coverage/.last_run.json
 - docs/cookiecutter_input.json
 - docs/example_project.png
 - exe/checkoff
@@ -429,7 +441,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Command-line and gem client for Asana (unofficial)

data/.envrc

@@ -1,4 +0,0 @@
-# shellcheck shell=bash
-PATH_add bin
-export ASANA__PERSONAL_ACCESS_TOKEN="op://Private/Asana access token - VLD read-write/token" ASANA__DEFAULT_ASSIGNEE_GID="op://Private/Asana access token - VLD read-write/default_workspace_gid" ASANA__DEFAULT_WORKSPACE_GID="op://Private/Asana access token - VLD read-write/default_workspace_gid"
-direnv_load with-op op run --cache -- direnv dump

data/coverage/.last_run.json

@@ -1,6 +0,0 @@
-{
-  "result": {
-    "line": 99.62,
-    "branch": 86.42
-  }
-}