undrive_google 1.1.1 → 1.1.2

data/RUBOCOP.md

@@ -0,0 +1,71 @@
+# RuboCop Usage Guide
+
+## Overview
+
+A tale of two RuboCop plugin gems.
+
+### RuboCop Gradual
+
+This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
+
+### RuboCop LTS
+
+This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
+RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
+
+## Checking RuboCop Violations
+
+To check for RuboCop violations in this project, always use:
+
+```bash
+bundle exec rake rubocop_gradual:check
+```
+
+**Do not use** the standard RuboCop commands like:
+- `bundle exec rubocop`
+- `rubocop`
+
+## Understanding the Lock File
+
+The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
+
+1. Prevent new violations while gradually fixing existing ones
+2. Track progress on code style improvements
+3. Ensure CI builds don't fail due to pre-existing violations
+
+## Common Commands
+
+- **Check violations**
+    - `bundle exec rake rubocop_gradual`
+    - `bundle exec rake rubocop_gradual:check`
+- **(Safe) Autocorrect violations, and update lockfile if no new violations**
+  - `bundle exec rake rubocop_gradual:autocorrect`
+- **Force update the lock file (w/o autocorrect) to match violations present in code**
+  - `bundle exec rake rubocop_gradual:force_update`
+
+## Workflow
+
+1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
+   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
+2. If there are new violations, either:
+   - Fix them in your code
+   - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
+3. Commit the updated `.rubocop_gradual.lock` file along with your changes
+
+## Never add inline RuboCop disables
+
+Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
+
+- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
+- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
+  - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
+
+In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
+
+## Benefits of rubocop_gradual
+
+- Allows incremental adoption of code style rules
+- Prevents CI failures due to pre-existing violations
+- Provides a clear record of code style debt
+- Enables focused efforts on improving code quality over time

data/SECURITY.md

@@ -2,24 +2,20 @@
 
 ## Supported Versions
 
-| Version | Supported | EOL     | Post-EOL / Enterprise                 |
-|---------|-----------|---------|---------------------------------------|
-| 1.0.x   | ✅         | 04/2025 | [Tidelift Subscription][tidelift-ref] |
+| Version  | Supported |
+|----------|-----------|
+| 1.latest | ✅         |
 
-### EOL Policy
+## Security contact information
 
-Non-commercial support for the oldest version of Ruby (which itself is going EOL) will be dropped each year in April.
-
-## Reporting a Vulnerability
-
-To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
 Tidelift will coordinate the fix and disclosure.
 
-## UndriveGoogle for Enterprise
-
-Available as part of the Tidelift Subscription.
+## Additional Support
 
-The maintainers of undrive_google and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications
-Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.][tidelift-ref]
+If you are interested in support for versions older than the latest release,
+please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
+or find other sponsorship links in the [README].
 
-[tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-undrive_google?utm_source=rubygems-undrive_google&utm_medium=referral&utm_campaign=enterprise&utm_term=repo
+[README]: README.md

data/lib/undrive_google/actions/sweep.rb

@@ -16,7 +16,7 @@ module UndriveGoogle
         return if Dir.empty?(dir)
 
         puts "Sweeping directory clean #{dir}" if Options.instance.verbose
-        FileUtils.rm_rf Dir.glob("#{dir}/*")
+        FileUtils.rm_rf(Dir.glob("#{dir}/*"))
       end
     end
   end

data/lib/undrive_google/captive_file.rb

@@ -4,6 +4,7 @@ module UndriveGoogle
   # A file on Google Drive
   class CaptiveFile
     include Singleton
+
     attr_accessor :options, :exports
 
     # @return nil

data/lib/undrive_google/cli.rb

@@ -4,6 +4,7 @@ module UndriveGoogle
   # Defines the CLI behavior & provides the Google Drive Session
   class CLI
     include Singleton
+
     attr_reader :parser, :options, :session
 
     # Options specified on the command line are collected in *@options*.

data/lib/undrive_google/options.rb

@@ -5,9 +5,20 @@ module UndriveGoogle
   class Options
     include Singleton
 
-    attr_accessor :config_yaml, :key_file, :file_id, :file_by, :extensions, :unzip,
-                  :keep_zip, :rename, :rename_proc, :lang, :title,
-                  :dir, :sweep, :verbose
+    attr_accessor :config_yaml,
+      :key_file,
+      :file_id,
+      :file_by,
+      :extensions,
+      :unzip,
+      :keep_zip,
+      :rename,
+      :rename_proc,
+      :lang,
+      :title,
+      :dir,
+      :sweep,
+      :verbose
 
     def initialize
       load_yaml(true)
@@ -15,7 +26,7 @@ module UndriveGoogle
 
     def define_options(parser)
       parser.banner = "Usage: undrive_google [options]"
-      parser.separator ""
+      parser.separator("")
 
       # Handle YAML, as default overrides
       config_yaml_option(parser)
@@ -34,7 +45,7 @@ module UndriveGoogle
       sweep_option(parser)
       verbose_option(parser)
 
-      parser.separator ""
+      parser.separator("")
 
       # Print an options summary.
       parser.on_tail("-h", "--help", "Show this message") do
@@ -47,30 +58,46 @@ module UndriveGoogle
 
     # CLI options will take precedence over values in YAML
     def config_yaml_option(parser)
-      parser.on("-c", "--config-yaml PATH", String,
-                "Path to UndriveGoogle config YAML file") do |config_yaml|
+      parser.on(
+        "-c",
+        "--config-yaml PATH",
+        String,
+        "Path to UndriveGoogle config YAML file",
+      ) do |config_yaml|
         self.config_yaml = config_yaml
         load_yaml
       end
     end
 
     def key_file_option(parser)
-      parser.on("-k", "--key-file PATH", String,
-                "Path to Google Service Account Keys JSON file") do |key_file|
+      parser.on(
+        "-k",
+        "--key-file PATH",
+        String,
+        "Path to Google Service Account Keys JSON file",
+      ) do |key_file|
         self.key_file = key_file
       end
     end
 
     def file_id_option(parser)
-      parser.on("-i", "--file-id ID", String,
-                "ID used to find file (key or title)") do |file_id|
+      parser.on(
+        "-i",
+        "--file-id ID",
+        String,
+        "ID used to find file (key or title)",
+      ) do |file_id|
         self.file_id = file_id
       end
     end
 
     def by_option(parser)
-      parser.on("-b", "--file-by [TYPE]", %i[key title],
-                "Select type of ID used to find file (key, title)") do |file_by|
+      parser.on(
+        "-b",
+        "--file-by [TYPE]",
+        %i[key title],
+        "Select type of ID used to find file (key, title)",
+      ) do |file_by|
         self.file_by = file_by
       end
     end
@@ -108,8 +135,12 @@ module UndriveGoogle
     end
 
     def dir_option(parser)
-      parser.on("-d", "--dir PATH", String,
-                "Path to directory where liberated files will go") do |dir|
+      parser.on(
+        "-d",
+        "--dir PATH",
+        String,
+        "Path to directory where liberated files will go",
+      ) do |dir|
         self.dir = dir.strip
       end
     end
@@ -128,8 +159,11 @@ module UndriveGoogle
 
     def sweep_option(parser)
       # Boolean switch.
-      parser.on("-s", "--[no-]sweep",
-                "Delete all files from directory specified by -d or --dir prior to liberation") do |sweep|
+      parser.on(
+        "-s",
+        "--[no-]sweep",
+        "Delete all files from directory specified by -d or --dir prior to liberation",
+      ) do |sweep|
         self.sweep = sweep
       end
     end

data/lib/undrive_google/transformation.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module UndriveGoogle
-  Transformation = Struct.new(:download,
-                              :unzip,
-                              :fix_html,
-                              :rename_html,
-                              :delete_zip,
-                              keyword_init: true) do
+  Transformation = Struct.new(
+    :download,
+    :unzip,
+    :fix_html,
+    :rename_html,
+    :delete_zip,
+    keyword_init: true,
+  ) do
     def liberate!
       each(&:process)
     end

data/lib/undrive_google/version.rb

@@ -2,6 +2,6 @@
 
 module UndriveGoogle
   module Version
-    VERSION = "1.1.1"
+    VERSION = "1.1.2"
   end
 end

data/lib/undrive_google.rb

@@ -11,7 +11,7 @@ require "singleton" # The Ruby Singleton library
 begin
   require "zip"
 rescue LoadError
-  warn "[WARN] Failed to load gem rubyzip, so unzip (and thus html) options will not work."
+  warn("[WARN] Failed to load gem rubyzip, so unzip (and thus html) options will not work.")
 end
 require "version_gem"
 require "google_drive"
@@ -42,14 +42,14 @@ module UndriveGoogle
 
   FILE_BY = {
     title: :title,
-    key: :key
+    key: :key,
   }.freeze
   # epub is conditionally in DL_FILE_TYPES depending on the google_drive gem used.
   DL_FILE_TYPES = if HAS_EPUB
-                    %i[docx odt rtf pdf txt zip epub].freeze
-                  else
-                    %i[docx odt rtf pdf txt zip].freeze
-                  end
+    %i[docx odt rtf pdf txt zip epub].freeze
+  else
+    %i[docx odt rtf pdf txt zip].freeze
+  end
   # html is not in DL_FILE_TYPES because you can't download it directly.
   # html is downloaded as zip, and must then be unzipped.
   ALL_FILE_TYPES = DL_FILE_TYPES + %i[html].freeze

data/sig/undrive_google.rbs

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