valr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa865dd364c0adf88f274215c451e9555adde10f
+  data.tar.gz: ff22dbc0f83d3f67b9c4a5eb9f61d5500c24f0fa
+SHA512:
+  metadata.gz: 3d599ef8a64bf0925eab3085a2d93902e856fba959c0738f4bf9db93c07b6c7c6b0961a52b8ee79816140696f2f9d1f3019446701266132169b0b12b3b9968fa
+  data.tar.gz: 78eeb823d6fcef9152f8a698d134aaa394998e3a19bf0250ae278b844190aaa05b0573de3b6a91225ca4603e7ee8be143b4e1a031703d1e1d38186a7ff6c1fb1

data/bin/valr

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'valr'
+
+repo_path = ARGV[0] || Dir.pwd
+range = ARGV[1] || nil
+
+changelog = Valr::Repo.new(repo_path).full_changelog first_parent: true, range: range
+
+puts "Changelog for #{repo_path}"
+puts ""
+puts changelog

data/lib/valr.rb

@@ -0,0 +1 @@
+require 'valr/repo'

data/lib/valr/empty_repository_error.rb

@@ -0,0 +1,9 @@
+module Valr
+  class EmptyRepositoryError < RuntimeError
+    # Error raised when the repository is empty
+    # @param [String] repo_path Path in which to search a repository
+    def initialize(repo_path)
+      super("'#{repo_path}' is empty")
+    end
+  end
+end

data/lib/valr/not_valid_range_error.rb

@@ -0,0 +1,9 @@
+module Valr
+  class NotValidRangeError < RuntimeError
+    # Error raised when the specified range is not valid
+    # @param [String] range Range asked
+    def initialize(range)
+      super("'#{range}' is not a valid range")
+    end
+  end
+end

data/lib/valr/repo.rb

@@ -0,0 +1,114 @@
+require 'rugged'
+require 'valr/repository_error'
+require 'valr/empty_repository_error'
+require 'valr/not_valid_range_error'
+
+module Valr
+  class Repo
+    # Initialize new Valr for a git repository
+    # @param [String] repo_path Path of git repository
+    def initialize(repo_path)
+      @repo_path = repo_path
+      begin
+        @repo = Rugged::Repository.new @repo_path
+      rescue Rugged::RepositoryError => e
+        raise Valr::RepositoryError.new @repo_path
+      end
+      raise Valr::EmptyRepositoryError.new @repo_path if @repo.empty?
+    end
+
+    # Get the changelog based on commit messages.
+    # @param [Boolean] first_parent Optional, if true limits to first parent commits
+    # @param [String] range Optional, define a specific range of commits
+    # @return [String] changelog
+    def changelog(first_parent: false, range: nil)
+      to_list(first_lines(log_messages first_parent, range))
+    end
+
+    # Get the full changelog including metadata.
+    # @param [Boolean] first_parent Optional, if true limits to first parent commits
+    # @param [String] range Optional, define a specific range of commits
+    # @return [String] changelog
+    def full_changelog(first_parent: false, range: nil)
+      if range.nil?
+        full_changelog_no_range first_parent
+      else
+        full_changelog_range first_parent, range
+      end
+    end
+
+    private
+
+    # Array to markdown list
+    # @param [Array<String>] items
+    # @return [String] markdown list
+    def to_list(items)
+      (items.map {|item| "- #{item}"}).join("\n")
+    end
+
+    # Extract only first lines
+    # @param [Array<String>] strings
+    # @return [Array<String>] Array of first lines
+    def first_lines(strings)
+      strings.map {|string|
+        string.split("\n").first
+      }
+    end
+
+    # Get log messages for a repository
+    # @param [Boolean] first_parent Optional, if true limit to first parent commits
+    # @param [String] range Optional, define a specific range of commits
+    # @return [Array<String>] log messages
+    def log_messages(first_parent = false, range = nil)
+      walker = Rugged::Walker.new @repo
+      if range.nil?
+        walker.push @repo.head.target_id
+      else
+        begin
+          walker.push_range range
+        rescue Rugged::ReferenceError => e
+          raise Valr::NotValidRangeError.new range
+        end
+      end
+      walker.simplify_first_parent if first_parent
+      messages = walker.inject([]) { |messages, c| messages << c.message }
+      walker.reset
+      messages
+    end
+
+    # Get the full changelog including metadata.
+    # @param [Boolean] first_parent If true limits to first parent commits
+    # @return [String] changelog
+    def full_changelog_no_range(first_parent)
+      %{#{last_sha1}
+
+#{changelog(first_parent: first_parent)}}
+    end
+
+    # Get the full changelog including metadata.
+    # @param [Boolean] first_parent If true limits to first parent commits
+    # @param [String] range Define a specific range of commits
+    # @return [String] changelog
+    def full_changelog_range(first_parent, range)
+      changelog_list = changelog first_parent: first_parent, range: range
+      from, to = range.split '..'
+      from_commit, to_commit = [from, to].map { |ref| rev_parse ref }
+      %{    from: #{from} <#{from_commit.oid}>
+    to:   #{to} <#{to_commit.oid}>
+
+#{changelog_list}}
+    end
+
+    # Get the last sha1 of a git repository
+    def last_sha1
+      @repo.head.target_id
+    end
+
+    # Get the commit of a reference (tag or other)
+    # @param [String] ref Reference to get the commit
+    # @return the commit
+    def rev_parse(ref)
+      Rugged::Object.rev_parse @repo, ref
+    end
+  end
+end

data/lib/valr/repository_error.rb

@@ -0,0 +1,9 @@
+module Valr
+  class RepositoryError < RuntimeError
+    # Error raised when not in a repository
+    # @param [String] repo_path Path in which to search a repository
+    def initialize(repo_path)
+      super("'#{repo_path}' is not a git repository")
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: valr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yves Brissaud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.2
+description: A markdown powered CHANGELOG generator using git commit messages.
+email: yves.brissaud@gmail.com
+executables:
+- valr
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/valr
+- lib/.gitignore
+- lib/valr.rb
+- lib/valr/empty_repository_error.rb
+- lib/valr/not_valid_range_error.rb
+- lib/valr/repo.rb
+- lib/valr/repository_error.rb
+homepage: https://github.com/eunomie/valr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Changelog generator
+test_files: []