gitlab-to-doap 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b916d52f8ed0599d9977fdbcf7aad1f1be6bf980e9f92ea8736dd66a2941881
-  data.tar.gz: b280683eb6ef78bf39d350d3942e8e8eed38af1df7c48dc4a186095fcc63fa7e
+  metadata.gz: 3d511ef2c2347429973b6b2adb6ff5a61aa600f589818914e0f36f917616733c
+  data.tar.gz: 953eb005fad056c2285ab0995f41e29bf64c2003bea2a7fc7af2451595e2f188
 SHA512:
-  metadata.gz: bdf8256ba7f0342575984ae0bd7315d628fc7cbc92209aa6f269d7d78493644b9da484b63c6bb164292f15d6a9eddf8122bcb58778e09400bc6e8bbd87c5b8cb
-  data.tar.gz: c9de9ed8391285c8eab9a6bbab95732f65673f8a72c6a498997c345a45cbfe921771f92403296c28bbaea99b15334e4535ce1aedb1dd0e62e129350299bc6ae0
+  metadata.gz: faa24d18862f9a5c9770377ab9b0f373c90f8b4224ebcb5fee960d7785c9906abde7b3269abb8295b203d5ff6d23ef5b5aebfccc0845f4dcf0353cf1a2a3398c
+  data.tar.gz: d2ce63059c54761066d1d0a23cc52ce09ea9b18f9e4e0c2b69607ba875b02edf9bf4b188f764e554d49457aef4b2196e1cc03c7cb904ad8a9aa88730e1f293ca

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /man/man1/*.1
+DESCRIPTION

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-to-doap (0.1.0)
+    gitlab-to-doap (0.1.1)
       builder (~> 3.0)
       gitlab (~> 4.0)
       redcarpet (~> 3.5)

data/README.md

@@ -20,8 +20,8 @@ Pass the name of the project you want to produce a DOAP XML file for. It will be
 
 This requires two environment variables to be already defined:
 
-* **FOO**: 
-* **FOO**: 
+* **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.
 
 ## Development
 

data/Rakefile

@@ -20,4 +20,23 @@ file "man/man1/gitlab-to-doap.1" => ["man/man1/gitlab-to-doap.1.md"] do
   end
 end
 
+CLOBBER << "DESCRIPTION"
+file "DESCRIPTION" => ["README.md"] do
+  # Pull the lines between the first H1 and first H2 out of the readme as
+  # the project description
+  require_relative "lib/gitlab-to-doap"
+  readme_lines = File.readlines("README.md")
+  first = readme_lines.index(readme_lines.grep(/^# /)[0]) + 1
+  last = readme_lines.index(readme_lines.grep(/^## /)[0])
+  description_lines = readme_lines[first...last]
+  m = GitlabToDoap::Utilities.instance_method(:strip_markdown).bind(binding)
+  description = m.call(description_lines.join.strip)
+  description = description.split("\n").join(" ")
+
+  File.open("DESCRIPTION", "w") do |file|
+    file.puts description
+  end
+end
+
 task build: "man/man1/gitlab-to-doap.1"
+task build: "DESCRIPTION"

data/gitlab-to-doap.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/gitlab-to-doap/version"
+require_relative "lib/gitlab-to-doap"
 
 Gem::Specification.new do |spec|
   spec.name          = "gitlab-to-doap"
@@ -8,8 +8,14 @@ Gem::Specification.new do |spec|
   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")
+  begin
+    description = File.read("DESCRIPTION")
+  rescue Errno::ENOENT
+    description = nil
+  end
+
+  spec.summary       = description
+  spec.description   = description
   spec.homepage      = "https://code.aether.earth/nogweii/gitlab-to-doap"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
@@ -21,7 +27,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/**/*.?")
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|man/.*\.md)/}) } + Dir.glob("man/**/*.?") + ["DESCRIPTION"]
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-to-doap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nogweii
@@ -94,21 +94,11 @@ dependencies:
     - - ">="
       - !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"
+description: 'Given a gitlab personal token (https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html)
+  and a gitlab project, produce a DOAP (https://github.com/ewilderj/doap/wiki) XML
+  file.
+
+  '
 email:
 - me@nogweii.net
 executables:
@@ -121,6 +111,7 @@ files:
 - ".solargraph.yml"
 - ".standard.yml"
 - CHANGELOG.md
+- DESCRIPTION
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -161,5 +152,7 @@ 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.
+summary: Given a gitlab personal token (https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html)
+  and a gitlab project, produce a DOAP (https://github.com/ewilderj/doap/wiki) XML
+  file.
 test_files: []