gitlab_awesome_release 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32a74edd513b56c2d44c1f4fecfb69315e50b0bb
+  data.tar.gz: ffbae339ca9892a904b05195920e61c4253d4b2d
+SHA512:
+  metadata.gz: bfd686bead0a770cd8f9924d5470b4e4ed855d33cccfb7cf1f583a40ae631659a1591f9fa6f15eeaa65a31ba7a35d5249a06d254ce0c60f5b031031dbe5eabeb
+  data.tar.gz: 1abccd5eabe6d1ec3d3d2105cb5b4bb99bb5254bdd94f80ecbbe5cdd782c53469849c1a4899965edacc84aeb227922609e67eee993fe0022ee095cd7545598b6

data/.env.example

@@ -0,0 +1,3 @@
+GITLAB_API_ENDPOINT=http://example.com/api/v3
+GITLAB_API_PRIVATE_TOKEN=XXXXXXXXXXXXXXXXXXX
+GITLAB_PROJECT_NAME=group/name

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+stages:
+  - test
+
+job1:
+  stage: test
+  script:
+    - ./script/build.sh
+  tags:
+    - ruby

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitlab_awesome_release.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sue445
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# GitlabAwesomeRelease
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gitlab_awesome_release`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+[![build status](https://gitlab.com/ci/projects/9759/status.png?ref=master)](https://gitlab.com/ci/projects/9759?ref=master)
+[![Dependency Status](https://gemnasium.com/c2e0c69e2a02b4bb66481fb32f368e0e.svg)](https://gemnasium.com/a2f4eb18c1920eb39d8e9f1f807dd830)
+
+## Requirements
+
+* Ruby 2.1+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlab_awesome_release'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitlab_awesome_release
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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. Run `bundle exec gitlab_awesome_release` to use the gem in this directory, ignoring other installed copies of this gem.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/sue445/gitlab_awesome_release.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gitlab_awesome_release"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here
+cp .env.example .env
+
+echo ""
+echo "edit .env"

data/exe/gitlab_awesome_release

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "gitlab_awesome_release/cli"
+GitlabAwesomeRelease::CLI.start(ARGV)

data/gitlab_awesome_release.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab_awesome_release/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab_awesome_release"
+  spec.version       = GitlabAwesomeRelease::VERSION
+  spec.authors       = ["sue445"]
+  spec.email         = ["sue445@sue445.net"]
+
+  spec.summary       = %q{Generate changelog from tags and MergeRequests on GitLab}
+  spec.description   = %q{Generate changelog from tags and MergeRequests on GitLab}
+  spec.homepage      = "https://gitlab.com/sue445/gitlab_awesome_release"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "gitlab"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
+end

data/lib/gitlab_awesome_release.rb

@@ -0,0 +1,9 @@
+require "active_support/all"
+require "gitlab_awesome_release/version"
+require "gitlab_awesome_release/project"
+require "gitlab_awesome_release/array_within_ext"
+require "gitlab"
+
+module GitlabAwesomeRelease
+  # Your code goes here...
+end

data/lib/gitlab_awesome_release/array_within_ext.rb

@@ -0,0 +1,15 @@
+module GitlabAwesomeRelease
+  module ArrayWithinExt
+    refine Array do
+      def within(from_value, to_value)
+        from_index = find_index(from_value)
+        to_index   = find_index(to_value)
+
+        raise ArgumentError, "#{from_value} is not included in #{inspect}" unless from_index
+        raise ArgumentError, "#{to_value} is not included in #{inspect}"   unless to_index
+
+        self[from_index..to_index]
+      end
+    end
+  end
+end

data/lib/gitlab_awesome_release/cli.rb

@@ -0,0 +1,68 @@
+require "thor"
+require "gitlab_awesome_release"
+require "dotenv"
+
+module GitlabAwesomeRelease
+  class CLI < Thor
+    desc "version", "Show gitlab_awesome_release version"
+    def version
+      puts GitlabAwesomeRelease::VERSION
+    end
+
+    desc "create_note", "generate changelog"
+    option :filename
+    option :from
+    option :to
+    option :gitlab_api_endpoint
+    option :gitlab_api_private_token
+    option :gitlab_project_name
+    def create_note
+      Dotenv.load
+
+      gitlab_api_endpoint      = option_or_env!(:gitlab_api_endpoint)
+      gitlab_api_private_token = option_or_env!(:gitlab_api_private_token)
+      gitlab_project_name      = option_or_env!(:gitlab_project_name)
+
+      project = GitlabAwesomeRelease::Project.new(
+        api_endpoint:  gitlab_api_endpoint,
+        private_token: gitlab_api_private_token,
+        project_name:  gitlab_project_name,
+      )
+
+      tag_names = project.all_tag_names
+      oldest_tag = option_or_env(:from) || tag_names.first
+      newest_tag = option_or_env(:to)   || tag_names.last
+
+      changelog = project.generate_change_log(oldest_tag, newest_tag)
+
+      write_changelog(changelog)
+    end
+
+    private
+
+    def option_or_env(name)
+      upper_name = name.to_s.upcase
+      options[name].presence || ENV[upper_name].presence
+    end
+
+    def option_or_env!(name)
+      value = option_or_env(name)
+      return value if value
+
+      puts "--#{name.to_s.gsub("_", "-")} or #{name.to_s.upcase} is either required!"
+      exit!
+    end
+
+    def write_changelog(changelog)
+      filename = option_or_env(:filename)
+      if filename
+        File.open(filename, "wb") do |f|
+          f.write(changelog)
+        end
+        puts "Write #{filename}"
+      else
+        puts changelog
+      end
+    end
+  end
+end

data/lib/gitlab_awesome_release/project.rb

@@ -0,0 +1,119 @@
+module GitlabAwesomeRelease
+  require "cgi"
+
+  class Project
+    using GitlabAwesomeRelease::ArrayWithinExt
+
+    PER_PAGE = 100
+
+    # @param api_endpoint  [String]
+    # @param private_token [String]
+    # @param project_name  [String]
+    def initialize(api_endpoint:, private_token:, project_name:)
+      Gitlab.configure do |config|
+        config.endpoint      = api_endpoint
+        config.private_token = private_token
+      end
+      @project_name = project_name
+    end
+
+    def web_url
+      @web_url ||= Gitlab.project(escaped_project_name).web_url
+    end
+
+    # all tag name order by author date
+    # @return [Array<String>]
+    def all_tag_names
+      return @all_tag_names if @all_tag_names
+
+      repo_tags =
+        with_paging do |params|
+          Gitlab.repo_tags(escaped_project_name, params)
+        end
+      @all_tag_names = repo_tags.sort_by{ |tag| tag.commit.authored_date }.map(&:name)
+    end
+
+    # @param oldest_tag [String]
+    # @param newest_tag [String]
+    # @return [String]
+    def generate_change_log(oldest_tag, newest_tag)
+      release_notes = []
+      all_tag_names.within(oldest_tag, newest_tag).each_cons(2) do |from, to|
+        release_notes << generate_release_note(from, to)
+      end
+      release_notes << generate_release_note(newest_tag, "HEAD", title: "Unreleased") if newest_tag == all_tag_names.last
+
+      release_notes.reverse.each_with_object("") do |release_note, str|
+        str << release_note
+        str << "\n"
+      end
+    end
+
+    # generate release note between from...to
+    # @param from  [String]
+    # @param to    [String]
+    # @param title [String]
+    # @return [String]
+    def generate_release_note(from, to, title: nil)
+      title ||= to
+      summary = merge_requests_summary_between(from, to)
+
+      header = <<-MARKDOWN.strip_heredoc
+        ## #{title}
+        [full changelog](#{web_url}/compare/#{from}...#{to})
+
+      MARKDOWN
+
+      header + summary
+    end
+
+    # find merge requests between from...to
+    # @param from [String]
+    # @param to   [String]
+    # @return [Array<Integer>] MergeRequest iids
+    def merge_request_iids_between(from, to)
+      commits = Gitlab.repo_compare(escaped_project_name, from, to).commits
+      commits.map do |commit|
+        commit["message"] =~ /^Merge branch .*See merge request \!(\d+)$/m
+        $1
+      end.compact.map(&:to_i)
+    end
+
+    # @param iid [Integer] MergeRequest iid
+    # @return [String] markdown text
+    def merge_request_summary(iid)
+      mr = Gitlab.merge_requests(escaped_project_name, iid: iid).first
+      return nil unless mr
+
+      mr_url = "#{web_url}/merge_requests/#{iid}"
+      "* #{mr.title} [!#{iid}](#{mr_url}) *@#{mr.author.username}*"
+    end
+
+    private
+
+    def escaped_project_name
+      CGI.escape(@project_name)
+    end
+
+    # @yield [params] paging block
+    # @yieldparam params [Hash] paging params for GitLab API (page: current page, per_page)
+    # @yieldreturn response in all pages
+    def with_paging
+      all_response = []
+      page = 1
+      loop do
+        response = yield(page: page, per_page: PER_PAGE)
+        all_response += response
+        return all_response if response.size < PER_PAGE
+        page += 1
+      end
+    end
+
+    def merge_requests_summary_between(from, to)
+      mr_iids = merge_request_iids_between(from, to)
+      mr_iids.each_with_object("") do |iid, str|
+        str << merge_request_summary(iid) + "\n"
+      end
+    end
+  end
+end

data/lib/gitlab_awesome_release/version.rb

@@ -0,0 +1,3 @@
+module GitlabAwesomeRelease
+  VERSION = "0.1.0.beta1"
+end

data/script/build.sh

@@ -0,0 +1,7 @@
+#!/bin/bash -xe
+
+export CI=true
+
+bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=2 --retry=3
+
+bundle exec rspec

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: gitlab_awesome_release
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- sue445
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: dotenv
+  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: gitlab
+  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: thor
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Generate changelog from tags and MergeRequests on GitLab
+email:
+- sue445@sue445.net
+executables:
+- gitlab_awesome_release
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlab_awesome_release
+- gitlab_awesome_release.gemspec
+- lib/gitlab_awesome_release.rb
+- lib/gitlab_awesome_release/array_within_ext.rb
+- lib/gitlab_awesome_release/cli.rb
+- lib/gitlab_awesome_release/project.rb
+- lib/gitlab_awesome_release/version.rb
+- script/build.sh
+homepage: https://gitlab.com/sue445/gitlab_awesome_release
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Generate changelog from tags and MergeRequests on GitLab
+test_files: []
+has_rdoc: