discovery_v1 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 137199efc3b5f475875b508cf68d20c51ea82f2d29d3d70d2218866f67d765a0
-  data.tar.gz: 709788ca0001c121c94d5f95dfae6b794be0fa68f1c926e874c73a2e1aa028e1
+  metadata.gz: fde1c6614a635f843b6571f3aded90f26b1d1c5468b6aca77dbf593ce8ca9171
+  data.tar.gz: '0945b34e86bee4f36fb0a74caa6a60d65dac2e4dc0e77d4c5b68af80d2cc9338'
 SHA512:
-  metadata.gz: 42b2fa6f84a491d7366d11539a50ae71e059526ce6d9f883e6f40027c1f61efb3c17e4bf05137e6827b8829a7f3aa309700b22bdb9ba116f0f85eee5dc3e0214
-  data.tar.gz: 1f2e89c1dd89c67c22a1ff16ecf7c2f0ec03ff16e68d16292840b6b4d9bef0ef1db97fde783aabcf9411456072247cbffa10872feb4ef8ee57321a3f1c11a77f
+  metadata.gz: acec4cd8de56990b8b2ddb940c7f18d9e64f7dbd40d565083d6eabf8560101fe0852aa069427693de7db466d2448d8ba7181882150dd30b2a9e8471d138647c9
+  data.tar.gz: 7f86e5a69c105cf89627245428ea5f8a5317979e1c4a24e6505497ba45a2d08ed10a853e946f077b373359855b5fcaa9b1fbde444e066f4238bea1d4198395b8

data/.commitlintrc.yml

@@ -0,0 +1,16 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all rules.
+  #
+  body-leading-blank:    [2, 'always']
+  footer-leading-blank:  [2, 'always']

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.markdownlint.yml

@@ -0,0 +1,25 @@
+default: true
+
+# Unordered list indentation
+MD007: { indent: 2 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailing punctuation in a header
+MD026: { punctuation: '.,;:' }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: 'ordered' }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/.rubocop.yml

@@ -1,36 +1,7 @@
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
+
 AllCops:
-  NewCops: enable
-  # Output extra information for each offense to make it easier to diagnose:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
-  SuggestExtensions: false
-  # RuboCop enforces rules depending on the oldest version of Ruby which
-  # your project supports:
+  # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
+  # or later.
   TargetRubyVersion: 3.1
-
-Gemspec/DevelopmentDependencies:
-  EnforcedStyle: gemspec
-
-# The default max line length is 80 characters
-Layout/LineLength:
-  Max: 120
-
-# The DSL for RSpec and the gemspec file make it very hard to limit block length:
-Metrics/BlockLength:
-  Exclude:
-    - "spec/spec_helper.rb"
-    - "spec/**/*_spec.rb"
-    - "*.gemspec"
-
-Metrics/ModuleLength:
-  CountAsOne: ['hash']
-
-# When writing minitest tests, it is very hard to limit test class length:
-Metrics/ClassLength:
-  CountAsOne: ['hash']
-  Exclude:
-    - "test/**/*_test.rb"
-
-Style/AsciiComments:
-  Enabled: false

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--hide-void-return
+--markup-provider=redcarpet
+--markup markdown
+- CHANGELOG.md
+- CONTRIBUTING.md
+- RELEASING.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -4,6 +4,31 @@ Changes for each release are listed in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
 
+## v0.2.0 (2024-10-11)
+
+[Full Changelog](https://github.com/main-branch/discovery_v1/compare/v0.1.0..v0.2.0)
+
+Changes since v0.1.0:
+
+* fbd2c75 build: remove semver pr label check
+* 9234cb0 build: enforce conventional commit message formatting
+* 70c72f9 Use shared Rubocop config (#16)
+* 101cb6c Update copyright notice in this project (#15)
+* 32986c4 Update links in gemspec (#14)
+* ee4305f Add Slack badge for this project in README (#13)
+* 1e05724 Use standard badges at the top of the README (#12)
+* 02ec62a Update yardopts with new standard options (#11)
+* 8b65f81 Standardize YARD and Markdown Lint configurations (#10)
+* d105374 Update CODEOWNERS file (#9)
+* 870934e Set JRuby --debug option when running tests in GitHub Actions workflows (#8)
+* 351659c Integrate simplecov-rspec into the project (#7)
+* 3ca83ee Update continuous integration and experimental ruby builds (#6)
+* cb454b8 Enforce the use of semver tags on PRs (#5)
+* 68d0136 Auto correct rubocop Gemspec/AddRuntimeDependency offense (#4)
+* 5c4115a Add links to other gems in the Google API helpers series (#3)
+* 2aa6534 Merge pull request #2 from main-branch/document_extensions
+* 92d158c Document extensions to Google::Apis::DiscoveryV1 classes
+
 ## v0.1.0 (2023-11-21)
 
 [Full Changelog](https://github.com/main-branch/discovery_v1/compare/6e9fb12..v0.1.0)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 James Couball
+Copyright (c) 2024 James Couball
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,12 +3,24 @@
 [![Gem Version](https://badge.fury.io/rb/discovery_v1.svg)](https://badge.fury.io/rb/discovery_v1)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/discovery_v1/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/discovery_v1/file/CHANGELOG.md)
-[![Build Status](https://github.com/main-branch/discovery_v1/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/discovery_v1/actions?query=workflow%3ACI%20Build)
+[![Build Status](https://github.com/main-branch/discovery_v1/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/discovery_v1/actions/workflows/continuous_integration.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/aeebc016487c5cad881e/maintainability)](https://codeclimate.com/github/main-branch/discovery_v1/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/aeebc016487c5cad881e/test_coverage)](https://codeclimate.com/github/main-branch/discovery_v1/test_coverage)
+[![Conventional
+Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Slack](https://img.shields.io/badge/slack-main--branch/discovery__v1-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07MT5MG7V1)
 
 Unofficial helpers and extensions for the Google Discovery V1 API
 
+Gems in the Google API helper, extensions, and examples series:
+
+* [discovery_v1](https://github.com/main-branch/discovery_v1)
+* [drive_v3](https://github.com/main-branch/drive_v3)
+* [sheets_v4](https://github.com/main-branch/sheets_v4)
+
+## Contents
+
+* [Contents](#contents)
 * [Installation](#installation)
 * [Examples](#examples)
 * [Important links](#important-links)
@@ -19,8 +31,12 @@ Unofficial helpers and extensions for the Google Discovery V1 API
   * [Obtaining a DiscoveryService](#obtaining-a-discoveryservice)
   * [Downloading an API discovery document](#downloading-an-api-discovery-document)
   * [Validating API objects](#validating-api-objects)
+  * [Google Extensions](#google-extensions)
+    * [RestDescription Extensions](#restdescription-extensions)
 * [Development](#development)
 * [Contributing](#contributing)
+  * [Commit message guidelines](#commit-message-guidelines)
+  * [Pull request guidelines](#pull-request-guidelines)
 * [License](#license)
 * [Code of Conduct](#code-of-conduct)
 
@@ -159,6 +175,26 @@ will raise a RuntimeError noting where the object structure did not conform to
 the schema. `RuntimeError#message` will give details about where the structure did
 not conform.
 
+### Google Extensions
+
+The `DiscoveryV1::GoogleExtensions` module provides extensions to the `Google::Apis::DiscoveryV1`
+modules and classes to simplify use of the SheetsV4 API.
+
+These extensions are not loaded by default and are not required to use other parts
+of this Gem. To enable these extension, you must:
+
+```Ruby
+require 'discovery_v1/google_extensions'
+```
+
+#### RestDescription Extensions
+
+Convenience methods are been added to `Google::Apis::DiscoveryV1::RestDescription`:
+* [RestDescription#object_schema_names](https://rubydoc.info/gems/discovery_v1/Google/Apis/DiscoveryV1/RestDescription#object_schema_names-instance_method):
+  The names of the schemas defined by this `RestDescription`.
+* [RestDescription#validate_object](https://rubydoc.info/gems/discovery_v1/Google/Apis/DiscoveryV1/RestDescription#validate_object-instance_method):
+  Raises an error if the given object does not conform to the named schema.
+
 ## 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.
@@ -169,6 +205,31 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/discovery_v1. 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/[USERNAME]/discovery_v1/blob/main/CODE_OF_CONDUCT.md).
 
+### Commit message guidelines
+
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
+
+To ensure compliance, this project includes:
+
+* A git commit-msg hook that validates your commit messages before they are accepted.
+
+  To activate the hook, you must have node installed and run `npm install`.
+
+* A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
+
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
+
+### Pull request guidelines
+
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -48,17 +48,9 @@ CLEAN << 'rspec-report.xml'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --display-cop-names
-    --display-style-guide
-    --extra-details
-    --format progress
-    --format json --out rubocop-report.json
-  ]
-end
+RuboCop::RakeTask.new
 
-CLEAN << 'rubocop-report.json'
+# YARD
 
 unless RUBY_PLATFORM == 'java'
   # yard:build

data/lib/discovery_v1/version.rb

@@ -2,5 +2,5 @@
 
 module DiscoveryV1
   # The version of this gem
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "husky": "^9.1.0"
+  },
+  "scripts": {
+    "postinstall": "husky",
+    "prepare": "husky"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discovery_v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -30,56 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: main_branch_shared_rubocop_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.57'
+        version: '1.66'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.57'
+        version: '1.66'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -190,28 +218,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 description: Unofficial helpers and extensions for the Google Discovery V1 API
 email:
 - jcouball@yahoo.com
@@ -219,8 +247,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
+- ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -237,6 +269,7 @@ files:
 - lib/discovery_v1/validation/traverse_object_tree.rb
 - lib/discovery_v1/validation/validate_object.rb
 - lib/discovery_v1/version.rb
+- package.json
 - sig/discovery_v1.rbs
 homepage: https://github.com/main-branch/discovery_v1
 licenses:
@@ -245,7 +278,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/discovery_v1
   source_code_uri: https://github.com/main-branch/discovery_v1
-  changelog_uri: https://rubydoc.info/gems/discovery_v1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/discovery_v1/0.2.0
+  changelog_uri: https://rubydoc.info/gems/discovery_v1/0.2.0/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -262,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Unofficial helpers and extensions for the Google Discovery V1 API