gitlab-to-doap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b916d52f8ed0599d9977fdbcf7aad1f1be6bf980e9f92ea8736dd66a2941881
+  data.tar.gz: b280683eb6ef78bf39d350d3942e8e8eed38af1df7c48dc4a186095fcc63fa7e
+SHA512:
+  metadata.gz: bdf8256ba7f0342575984ae0bd7315d628fc7cbc92209aa6f269d7d78493644b9da484b63c6bb164292f15d6a9eddf8122bcb58778e09400bc6e8bbd87c5b8cb
+  data.tar.gz: c9de9ed8391285c8eab9a6bbab95732f65673f8a72c6a498997c345a45cbfe921771f92403296c28bbaea99b15334e4535ce1aedb1dd0e62e129350299bc6ae0

data/.gitignore

@@ -0,0 +1,10 @@
+*.doap.xml
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/man/man1/*.1

data/.gitlab-ci.yml

@@ -0,0 +1,21 @@
+include:
+  - template: Code-Quality.gitlab-ci.yml
+
+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
+  script:
+    - bundle exec rake

data/.solargraph.yml

@@ -0,0 +1,4 @@
+plugins:
+- solargraph-standardrb
+reporters:
+- standardrb

data/.standard.yml

@@ -0,0 +1,7 @@
+---
+parallel: true
+format: progress
+ignore:
+  - gitlab-to-doap.gemspec:
+    - Layout/ExtraSpacing
+  - gitlab-to-doap.rb

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2020-12-30
+### Added
+* Initial commit with basic functionality.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitlab-to-doap.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "standard", "~> 0.10"
+end
+
+group :development do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    gitlab-to-doap (0.1.0)
+      builder (~> 3.0)
+      gitlab (~> 4.0)
+      redcarpet (~> 3.5)
+      tty-option (~> 0.1)
+      tty-screen
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    builder (3.2.4)
+    coderay (1.1.3)
+    gitlab (4.17.0)
+      httparty (~> 0.18)
+      terminal-table (~> 1.5, >= 1.5.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.2)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    redcarpet (3.5.1)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.4.2)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (0.10.2)
+      rubocop (= 1.4.2)
+      rubocop-performance (= 1.9.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tty-option (0.1.0)
+    tty-screen (0.7.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  gitlab-to-doap!
+  minitest (~> 5.0)
+  pry
+  rake (~> 13.0)
+  standard (~> 0.10)
+
+BUNDLED WITH
+   2.2.0

data/README.md

@@ -0,0 +1,34 @@
+# gitlab-to-doap
+
+Given a [gitlab personal token][] and a gitlab project, produce a [DOAP][] XML
+file.
+
+[gitlab personal token]: https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html
+[DOAP]: https://github.com/ewilderj/doap/wiki
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install gitlab-to-doap
+
+## Usage
+
+Pass the name of the project you want to produce a DOAP XML file for. It will be sent to `stdout`.
+
+    $ gitlab-to-doap nogweii/dotfiles
+
+This requires two environment variables to be already defined:
+
+* **FOO**: 
+* **FOO**: 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome! Email me or other contact methods at [my website](https://evaryont.me).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "standard/rake"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+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"
+  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)
+  end
+end
+
+task build: "man/man1/gitlab-to-doap.1"

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/exe/gitlab-to-doap

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "gitlab-to-doap"
+require "gitlab-to-doap/command"
+require "tty-screen"
+
+cmd = GitlabToDoap::Command.new
+cmd.parse
+
+if cmd.params[:help]
+  puts cmd.help(width: TTY::Screen.width)
+  exit 0
+elsif cmd.params[:version]
+  puts GitlabToDoap::VERSION
+  exit 0
+end
+
+unless cmd.params.errors.empty?
+  puts cmd.params.errors.summary(width: TTY::Screen.width)
+  exit 1
+end
+
+cmd.run

data/gitlab-to-doap.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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.summary       = "Given a gitlab personal token and a gitlab project, produce a DOAP XML file."
+  spec.description   = File.read("README.md")
+  spec.homepage      = "https://code.aether.earth/nogweii/gitlab-to-doap"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = "https://code.aether.earth/nogweii/gitlab-to-doap"
+  spec.metadata["changelog_uri"]     = "https://code.aether.earth/nogweii/gitlab-to-doap/TODO"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  # 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/**/*.?")
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "builder", "~> 3.0"
+  spec.add_dependency "gitlab", "~> 4.0"
+  spec.add_dependency "redcarpet", "~> 3.5"
+  spec.add_dependency "tty-option", "~> 0.1"
+  spec.add_dependency "tty-screen"
+  # spec.add_dependency "spdx", "~> 3.0"
+
+  spec.add_development_dependency "minitest"
+end

data/lib/gitlab-to-doap.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "gitlab-to-doap/version"
+require_relative "gitlab-to-doap/utilities"
+require_relative "gitlab-to-doap/xml"
+
+class GitlabToDoap
+  class Error < StandardError; end
+  include GitlabToDoap::Utilities
+  include GitlabToDoap::XML
+
+  def initialize(gitlab_endpoint, gitlab_token)
+    @gitlab_endpoint = gitlab_endpoint
+    @gitlab_api_token = gitlab_token
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "tty/option"
+require "gitlab-to-doap"
+
+class GitlabToDoap::Command
+  include TTY::Option
+
+  usage do
+    program "gitlab-to-doap"
+    banner "Usage: #{program} [OPTIONS] user/project"
+
+    description "Print out a DOAP XML document of a given Gitlab project"
+  end
+
+  flag :help do
+    short "-h"
+    long "--help"
+    desc "Print usage"
+  end
+
+  flag :version do
+    short "-v"
+    long "--version"
+    desc "Print version"
+  end
+
+  argument :project
+
+  environment :gitlab_endpoint do
+    name "GITLAB_API_ENDPOINT"
+    # validate ->({ |v| URI.parse(v) && v.ends_with? "/api/v4" })
+    desc "Full URL to the Gitlab instance. Must end with /api/v4"
+  end
+
+  environment :gitlab_token do
+    name "GITLAB_API_PRIVATE_TOKEN"
+    desc "Your personal access token to the Gitlab instance."
+  end
+
+  option :file do
+    short "-f"
+    long "--file"
+    desc "Send the generated XML to a file, rather than STDOUT."
+    optional
+  end
+
+  def run
+    g2d = GitlabToDoap.new(params[:gitlab_endpoint], params[:gitlab_token])
+    project = g2d.gitlab_project(params[:project])
+    xml = g2d.doap_xml(project)
+
+    if params[:file]
+      # output_filename = project.path_with_namespace.gsub(/\W/, "-") + ".doap.xml"
+      File.open(params[:file], "w") do |f|
+        f.puts xml
+      end
+    else
+      puts xml
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "gitlab"
+require "redcarpet"
+require "redcarpet/render_strip"
+
+module GitlabToDoap::Utilities
+  attr_reader :gitlab_endpoint
+  attr_reader :gitlab_api_token
+
+  # Given some markdown formatted plain text, remove all of the formatting
+  def strip_markdown(text)
+    markdown = Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
+    markdown.render(text).strip
+  end
+
+  # Build a Gitlab API client, if one does not exist already
+  def gitlab
+    @gitlab ||= Gitlab.client(
+      endpoint: @gitlab_endpoint,
+      private_token: @gitlab_api_token
+    )
+  end
+
+  def gitlab_project(project_id)
+    gitlab.get("/projects/#{gitlab.url_encode project_id}?license=true&statistics=true")
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class GitlabToDoap
+  VERSION = "0.1.0"
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+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"]
+
+    latest_release = project_releases[0]
+    languages = gitlab.get("/projects/#{project["id"]}/languages")
+    users = gitlab.get("/projects/#{gitlab.url_encode project["id"]}/users")
+
+    builder = Builder::XmlMarkup.new(indent: 2)
+    builder.instruct!
+
+    builder.Project(xmlns: "http://usefulinc.com/ns/doap#",
+                    "xmlns:rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+                    "xmlns:foaf": "http://xmlns.com/foaf/0.1/") do |proj|
+      proj.name project.name
+      proj.shortdesc strip_markdown(project.description)
+      proj.homepage("rdf:resource": project.web_url)
+      proj.created DateTime.parse(project.created_at).strftime("%Y-%m-%d")
+
+      proj.repository do |repo|
+        repo.GitRepository do |git|
+          git.location("rdf:resource": project.http_url_to_repo)
+          git.browse("rdf:resource": project.web_url + "/-/tree/#{project.default_branch}")
+        end
+      end
+
+      proj.tag! :"download-page", "rdf:resource": project.web_url
+
+      if project.issues_enabled
+        proj.tag! :"bug-database", "rdf:resource": "#{project.web_url}/-/issues"
+      end
+
+      languages.to_hash.each do |language, _percentage|
+        # XXX: filter based on percentage, only showing languages >10%?
+        proj.tag! :"programming-language", language
+      end
+
+      if project.wiki_enabled
+        proj.wiki("rdf:resource": project.web_url + "/-/wikis/home")
+      end
+
+      project.tag_list.each do |tag|
+        url = URI.parse(project.web_url)
+        url.path = "/explore/projects"
+        url.query = "tag=#{tag}"
+        proj.category("rdf:resource": url.to_s)
+      end
+
+      if project.license
+        proj.license("rdf:resource": project.license.source_url)
+      end
+
+      users.each do |proj_user|
+        proj.maintainer do |maintainer|
+          maintainer.foaf :Person do |person|
+            user = gitlab.user(proj_user.id)
+            person.foaf :name, user.name
+            if user.public_email != ""
+              person.foaf :mbox, "rdf:resource": "mailto:#{user.public_email}"
+            end
+            if user.website_url != ""
+              person.foaf :homepage, "rdf:resource": user.website_url
+            end
+            person.foaf :homepage, "rdf:resource": user.web_url
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+gitlab-to-doap(1) -- short description of command
+
+## SYNOPSIS
+
+`name` [`OPTIONS`] [*ARGUMENT*...]
+
+## 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.
+
+## OPTIONS
+
+`-o`
+`--option`
+: Description of option
+
+`--key`=*value*
+: Another option with a *value*

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-to-doap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nogweii
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  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: minitest
+  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: "# gitlab-to-doap\n\nGiven a [gitlab personal token][] and a gitlab project,
+  produce a [DOAP][] XML\nfile.\n\n[gitlab personal token]: https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html\n[DOAP]:
+  https://github.com/ewilderj/doap/wiki\n\n## Installation\n\nInstall it yourself
+  as:\n\n    $ gem install gitlab-to-doap\n\n## Usage\n\nPass the name of the project
+  you want to produce a DOAP XML file for. It will be sent to `stdout`.\n\n    $ gitlab-to-doap
+  nogweii/dotfiles\n\nThis requires two environment variables to be already defined:\n\n*
+  **FOO**: \n* **FOO**: \n\n## Development\n\nAfter checking out the repo, run `bin/setup`
+  to install dependencies. Then, run `rake test` to run the tests. You can also run
+  `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo
+  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).\n\n##
+  Contributing\n\nBug reports and pull requests are welcome! Email me or other contact
+  methods at [my website](https://evaryont.me).\n"
+email:
+- me@nogweii.net
+executables:
+- gitlab-to-doap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".solargraph.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlab-to-doap
+- gitlab-to-doap.gemspec
+- lib/gitlab-to-doap.rb
+- lib/gitlab-to-doap/command.rb
+- lib/gitlab-to-doap/utilities.rb
+- lib/gitlab-to-doap/version.rb
+- lib/gitlab-to-doap/xml.rb
+- man/man1/gitlab-to-doap.1
+- man/man1/gitlab-to-doap.1.md
+homepage: https://code.aether.earth/nogweii/gitlab-to-doap
+licenses: []
+metadata:
+  homepage_uri: https://code.aether.earth/nogweii/gitlab-to-doap
+  source_code_uri: https://code.aether.earth/nogweii/gitlab-to-doap
+  changelog_uri: https://code.aether.earth/nogweii/gitlab-to-doap/TODO
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Given a gitlab personal token and a gitlab project, produce a DOAP XML file.
+test_files: []