gitlab-to-doap 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d511ef2c2347429973b6b2adb6ff5a61aa600f589818914e0f36f917616733c
-  data.tar.gz: 953eb005fad056c2285ab0995f41e29bf64c2003bea2a7fc7af2451595e2f188
+  metadata.gz: 556c9c1081cc2409d32078294f44e7bfcd5f641c5022b8af765cd69dc5136db3
+  data.tar.gz: a45042f597067127c366a6c285d94b380e5776b68607fb635c03909116ced4a4
 SHA512:
-  metadata.gz: faa24d18862f9a5c9770377ab9b0f373c90f8b4224ebcb5fee960d7785c9906abde7b3269abb8295b203d5ff6d23ef5b5aebfccc0845f4dcf0353cf1a2a3398c
-  data.tar.gz: d2ce63059c54761066d1d0a23cc52ce09ea9b18f9e4e0c2b69607ba875b02edf9bf4b188f764e554d49457aef4b2196e1cc03c7cb904ad8a9aa88730e1f293ca
+  metadata.gz: f174b73d82765c73a309c998ace18077bee261b2d124ed9600374c3046775a74921efd914bd2372013885bf5ebe7fced4a8dac254a0dbaa3a8087194c0ca3c8e
+  data.tar.gz: e316ad6b9448922b3d5c9089e109c910a2182925caf35768e800f74b6763a16a1f7e64b421bd477399c4acc4c39f3dc37515fafca9860199f8eac61645b8ab95

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /man/man1/*.1
 DESCRIPTION
+test/reports

data/.gitlab-ci.yml

@@ -6,16 +6,20 @@ image: ruby:2.7.2
 stages:
   - test
 
-# Cache gems in between builds
-cache:
-  paths:
-    - vendor/ruby
-
-before_script:
-  - gem install bundler -v 2.2.0
-  - bundle install -j $(nproc) --path vendor
-
 rake:
   stage: test
+  cache:
+    paths:
+      - vendor/ruby
   script:
+    - gem install bundler -v 2.2.0
+    - bundle install -j $(nproc) --path vendor
     - bundle exec rake
+    - bundle exec rake build
+  artifacts:
+    paths:
+      - pkg/*.gem
+    reports:
+      cobertura: coverage/coverage.xml
+      junit: test/reports/*.xml
+  coverage: '/LOC\s\(\d+\.\d+%\)\scovered/'

data/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2020-12-30
+### Changed
+* Remade the man page to be actually useful.
+* Moved primary/default branch from 'master' to 'main'
+
+### Added
+* License declared to be Apache 2.0.
+* Gitlab CI now gets reports for code coverage and test results
+
+## [0.1.1] - 2020-12-30
+### Changed
+* Fixes the gem description
+
 ## [0.1.0] - 2020-12-30
 ### Added
 * Initial commit with basic functionality.

data/Gemfile

@@ -10,6 +10,9 @@ gem "rake", "~> 13.0"
 group :test do
   gem "minitest", "~> 5.0"
   gem "standard", "~> 0.10"
+  gem "simplecov", "~> 0.20"
+  gem "simplecov-cobertura"
+  gem "minitest-ci"
 end
 
 group :development do

data/Gemfile.lock

@@ -14,6 +14,7 @@ GEM
     ast (2.4.1)
     builder (3.2.4)
     coderay (1.1.3)
+    docile (1.3.4)
     gitlab (4.17.0)
       httparty (~> 0.18)
       terminal-table (~> 1.5, >= 1.5.1)
@@ -25,6 +26,8 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.1104)
     minitest (5.14.2)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
     multi_xml (0.6.0)
     parallel (1.20.1)
     parser (3.0.0.0)
@@ -52,6 +55,14 @@ GEM
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.20.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (1.4.2)
+      simplecov (~> 0.8)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     standard (0.10.2)
       rubocop (= 1.4.2)
       rubocop-performance (= 1.9.1)
@@ -68,8 +79,11 @@ PLATFORMS
 DEPENDENCIES
   gitlab-to-doap!
   minitest (~> 5.0)
+  minitest-ci
   pry
   rake (~> 13.0)
+  simplecov (~> 0.20)
+  simplecov-cobertura
   standard (~> 0.10)
 
 BUNDLED WITH

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: Apache-2.0
+
 require "standard/rake"
 require "bundler/gem_tasks"
 require "rake/testtask"
@@ -14,9 +16,11 @@ task default: %i[test standard]
 
 CLOBBER << "man/man1/gitlab-to-doap.1"
 file "man/man1/gitlab-to-doap.1" => ["man/man1/gitlab-to-doap.1.md"] do
-  require "kramdown"
+  require "redcarpet"
+  require "redcarpet/render_man"
   File.open("man/man1/gitlab-to-doap.1", "w") do |file|
-    file.write(Kramdown::Document.new(File.read("man/man1/gitlab-to-doap.1.md")).to_man)
+    markdown = Redcarpet::Markdown.new(Redcarpet::Render::ManPage, no_intra_emphasis: true)
+    file.puts(markdown.render(File.read("man/man1/gitlab-to-doap.1.md")))
   end
 end
 
@@ -40,3 +44,4 @@ end
 
 task build: "man/man1/gitlab-to-doap.1"
 task build: "DESCRIPTION"
+task build: :test

data/exe/gitlab-to-doap

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# SPDX-License-Identifier: Apache-2.0
+
 require "gitlab-to-doap"
 require "gitlab-to-doap/command"
 require "tty-screen"

data/gitlab-to-doap.gemspec

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "lib/gitlab-to-doap"
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative "lib/gitlab-to-doap/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "gitlab-to-doap"
   spec.version       = GitlabToDoap::VERSION
   spec.authors       = ["Nogweii"]
   spec.email         = ["me@nogweii.net"]
+  spec.license       = "Apache-2.0"
 
   begin
     description = File.read("DESCRIPTION")
@@ -27,7 +30,7 @@ Gem::Specification.new do |spec|
   # 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 { |f| f.match(%r{\A(?:test|spec|features|man/.*\.md)/}) } + Dir.glob("man/**/*.?") + ["DESCRIPTION"]
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|bin)/}) } + Dir.glob("man/**/*.?") + ["DESCRIPTION"]
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }

data/lib/gitlab-to-doap.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: Apache-2.0
+
 require_relative "gitlab-to-doap/version"
 require_relative "gitlab-to-doap/utilities"
 require_relative "gitlab-to-doap/xml"

data/lib/gitlab-to-doap/command.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: Apache-2.0
+
 require "tty/option"
 require "gitlab-to-doap"
 

data/lib/gitlab-to-doap/utilities.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: Apache-2.0
+
 require "gitlab"
 require "redcarpet"
 require "redcarpet/render_strip"

data/lib/gitlab-to-doap/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: Apache-2.0
+
 class GitlabToDoap
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/gitlab-to-doap/xml.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: Apache-2.0
+
 require "builder"
 
 # This is the real meat and potatoes of the project.
 module GitlabToDoap::XML
   def doap_xml(project)
-    project_releases = gitlab.project_releases project["id"]
+    # TODO: add a version tag for the latest release
+    # project_releases = gitlab.project_releases project["id"]
+    # latest_release = project_releases[0]
+    # TODO: or failing that, the latest git tag?
 
-    latest_release = project_releases[0]
     languages = gitlab.get("/projects/#{project["id"]}/languages")
     users = gitlab.get("/projects/#{gitlab.url_encode project["id"]}/users")
 

data/man/man1/gitlab-to-doap.1.md

@@ -1,23 +1,26 @@
-gitlab-to-doap(1) -- short description of command
+# GITLAB-TO-DOAP 1
 
 ## SYNOPSIS
 
-`name` [`OPTIONS`] [*ARGUMENT*...]
+    gitlab-to-doap [OPTIONS] user/project
 
 ## DESCRIPTION
 
-All block elements like paragraphs, blockquotes, lists, ... work as they
-do with normal kramdown documents.
-
-Use code spans for `code`, `--options` and `user input`, emphasis for
-*variables*, *argument names* and *file names*, and **strong emphasis**
-for things that should stand out.
+Given a Gitlab personal token and a Gitlab project, produce a DOAP XML file.
 
 ## OPTIONS
 
-`-o`
-`--option`
-: Description of option
+* *-h*, *--help*: Show a summary of usage
+* *-v*, *--version*: Print the version to stdout and immediately quit
+* *-f*, *--file*: Instead of printing the XML to stdout, write it to this file. Will clobber any existing file without prompting.
+
+## ENVIRONMENT VARIABLES
+
+Two environment variables are needed to authenticate gitlab-to-doap with a given Gitlab instance.
+
+* *GITLAB_API_ENDPOINT*: Full URL to the Gitlab instance. Must end with /api/v4.
+* *GITLAB_API_PRIVATE_TOKEN*: Your personal access token to the Gitlab instance.
+
+## BUGS AND OTHER REQUESTS
 
-`--key`=*value*
-: Another option with a *value*
+If you find any bugs send me an email at bugs@aether.earth. I'll try to respond quickly. I also look forward to any features or other requests!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-to-doap
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nogweii
@@ -114,10 +114,9 @@ files:
 - DESCRIPTION
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - exe/gitlab-to-doap
 - gitlab-to-doap.gemspec
 - lib/gitlab-to-doap.rb
@@ -128,7 +127,8 @@ files:
 - man/man1/gitlab-to-doap.1
 - man/man1/gitlab-to-doap.1.md
 homepage: https://code.aether.earth/nogweii/gitlab-to-doap
-licenses: []
+licenses:
+- Apache-2.0
 metadata:
   homepage_uri: https://code.aether.earth/nogweii/gitlab-to-doap
   source_code_uri: https://code.aether.earth/nogweii/gitlab-to-doap

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "gitlab-to-doap"
-require "gitlab-to-doap/command"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-cmd = GitlabToDoap::Command.new
-g2d = GitlabToDoap.new(ENV['GITLAB_API_ENDPOINT'], ENV['GITLAB_API_PRIVATE_TOKEN'])
-
-require "pry"
-binding.pry

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here