pr_log 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 219e0119cbee6cea394f2acad2aaff4bb31d74b6
-  data.tar.gz: bf6b1f5ea714216c73f0bfee3967e9f77052b44b
+SHA256:
+  metadata.gz: 6817152eeb14c769cf1b30b0c8954b809d432c73a53070bc157a0e1184f18173
+  data.tar.gz: 7d39cc008614b0cb8dedf721420787836cea8bfd79c19fcdc570f718ac872895
 SHA512:
-  metadata.gz: a6d06a0f16cb8fd248d4557dd2047a8f0971115206968e12566bac5332b9ce54579364721754d5141e119cccd6b36ab3c5ef471bd75929470be6f1918665e5c3
-  data.tar.gz: 1541586d7a72ebf774c41160e9589147ff8fa64db79139ad83228754346436435e9797dd27cc6e84f85f7129552ed9693e76a855db885d5fa9a1a90a41118bdf
+  metadata.gz: ccb169322a27f7d49fd256a58dd5cad950a425acc93dca6cb24d4232d1be3be86dbba865abd37ae125b6a45d98a609160e8fb08cda169a8b200eedf52cd63dde
+  data.tar.gz: c041b94a06bc647be425506a0bd74a81d7e1bd1b91ef3559d8c919c130033649114f10e67b2812168c00d1c7e6774203cf0f314c41acfdce60bd5164084bfc08

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,29 @@
+# Use double quotes only for interpolation.
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+# Place dots at the beginning of multiline method calls.
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Use brackets for symbol array
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Allow using {} when chaining methods
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+# Allow %{} tokens in format strings
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# Longs tests and gemspecs are ok
+Metrics/BlockLength:
+  ExcludedMethods: ['describe']
+  Exclude:
+    - 'pr_log.gemspec'
+
+# Ignore Rubcop directives at end of line
+Metrics/LineLength:
+  IgnoreCopDirectives: true

data/.travis.yml

@@ -1,20 +1,21 @@
 language: ruby
 rvm:
-- 1.9.3
 - 2.1.1
+- 2.5.0
 
 # User container based travis infrastructure which allows caching
 # features for open source projects.
 sudo: false
 cache: bundler
 
-before_install: gem install bundler -v 1.10.5
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
 env:
   global:
     - PR_LOG_FIXTURE_OAUTH_TOKEN=8909728af9171b43308994050f0c6f57994ace5f
-
-addons:
-  code_climate:
-    repo_token:
-      secure: "aQtvo+k13pyGi4Hi/7/Hx/wIv5lAlZ0AXrMNy0A4mPF4en6y2jW9yiO0pSMNBAPRmiFrDstarW4IcdtHVQ4vT6XBvcmu4DmYBdfcutrhBBXFXx2IOMtqKpGAib42HQW7lgSwVh2nPTqyVh2fw8TnEYk7Mr1cFK9zQXasFll/yCYtRHquDJxanwYyISw6q8YN7Z9e5M8Sv2Mc7Bu2qtx6QXkEEd8JvxtvXT2vQBdGrzH3Y+gC9hKr2BgJnV9of2Ofu0oFY958nlqxj3dSj9m64wt8xHt4W2fU4FNv4lPCHHotQdWTY2ugzdOA6GhSf76hOO5t/0lQ44eJySgmIzTIWWFUCAzvWpOv7Wj4jrMeoF+MxzQmEu7rUfuu/hFR+dEliQouiMAhBGy6cP8PtzHrUcf3cYaW5GcE57RU/FBb0cyM6QG2vDK0C12bjzpuLrv9dkfizlxPZnwdiuOQWG45sbZgKWv212Dj34jT2rDpfCfovbpse72Pi0FSN4Q04CvHkB/ITP6LGKF5NCmLAewJKOsjUbciPgX7PxnY9ieFLgadenfFQARpRCZaw5Gp7ZEJq+8LAFokW9lDu2HdByRGLDXvv+6yve+Rt5bCT5T+ALboGr0FXaZJ/YCAdL4mUudY/5rW36ZyPQrPpQnnxSe62GzHKCdJhtbhpaEIOubcScQ="

data/CHANGELOG.md

@@ -1,7 +1,16 @@
 # CHANGELOG
 
-## Version 0.1.0
+### Version 0.3.0
 
-2015-07-28
+2023-07-10
 
-- Initial release.
+[Compare changes](https://github.com/tf/pr_log/compare/0-2-stable...v0.3.0)
+
+- Add support for nested fields in `entry_template`
+  ([#11](https://github.com/tf/pr_log/pull/11))
+- Allow Bundler 2 as development dependency
+  ([#9](https://github.com/tf/pr_log/pull/9))
+
+See
+[0-2-stable branch](https://github.com/tf/pr_log/blob/0-2-stable/CHANGELOG.md)
+for previous changes.

data/README.md

@@ -93,6 +93,7 @@ The following configuration options are available:
   entries. All fields from the
   [issue search response](https://developer.github.com/v3/search/#search-issues)
   can be used as interpolations.
+  Default value: `- %{title} ([#%{number}](%{html_url}))`. Use `.` for nested fields (e.g. `%{user.login}`).
 
 - `github_repository`: Name of the GitHub repository of the form
   `user/repository`.
@@ -125,6 +126,7 @@ with the label `bug`, add the following lines to your configuration file:
 After checking out the repo, run `bin/setup` to install
 dependencies. You can also run `bin/console` for an interactive prompt
 that will allow you to experiment.
+You can then use `rake install` to install the gem locally.
 
 ### Running the Test Suite
 

data/Rakefile

@@ -1,6 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'semmy'
+Semmy::Tasks.install
+
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "pr_log"
+require 'bundler/setup'
+require 'pr_log'
 
 # 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.
@@ -10,5 +10,5 @@ require "pr_log"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/rspec

@@ -7,8 +7,8 @@
 #
 
 require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
 require 'rubygems'
 require 'bundler/setup'

data/lib/pr_log/cli.rb

@@ -24,19 +24,28 @@ module PrLog
     def fetch
       FetchCommand.perform(options) do |command|
         command.on(:fetching) do |milestone, github_repository_name|
-          say_status(:fetching,
-                     "pull requests for milestone #{milestone} " \
-                     "from #{github_repository_name}")
+          say_fetching(milestone, github_repository_name)
         end
 
         command.on(:inserting) do |pull_requests, changelog_file|
-          say_status(:inserting,
-                     "#{pull_requests.size} entries " \
-                     "into #{changelog_file}")
+          say_inserting(pull_requests, changelog_file)
         end
       end
     rescue Error => e
       say_status(:error, e.message, :red)
     end
+
+    private
+
+    def say_fetching(milestone, github_repository_name)
+      say_status(:fetching,
+                 "pull requests for milestone #{milestone} " \
+                 "from #{github_repository_name}")
+    end
+
+    def say_inserting(pull_requests, changelog_file)
+      say_status(:inserting,
+                 "#{pull_requests.size} entries into #{changelog_file}")
+    end
   end
 end

data/lib/pr_log/command.rb

@@ -2,9 +2,11 @@ require 'events'
 
 module PrLog
   # Event emitting command base class
-  class Command < Struct.new(:config)
+  class Command
     include Events::Emitter
 
+    pattr_initialize :config
+
     def self.perform(options)
       command = new(Configuration.setup(options))
       yield(command) if block_given?
@@ -12,7 +14,7 @@ module PrLog
     end
 
     def perform
-      fail(NotImplementedError)
+      raise(NotImplementedError)
     end
 
     private

data/lib/pr_log/configuration.rb

@@ -49,6 +49,6 @@ module PrLog
     CONFIG_FILE_NAMES = [
       "#{ENV['HOME']}/.pr_log.yml",
       '.pr_log.yml'
-    ]
+    ].freeze
   end
 end

data/lib/pr_log/errors.rb

@@ -22,4 +22,7 @@ module PrLog
 
   class GithubRepositoryNotFound < Error
   end
+
+  class InvalidInterpolation < Error
+  end
 end

data/lib/pr_log/formatter.rb

@@ -1,19 +1,33 @@
 module PrLog
   # Format new pull requests from github search response
-  class Formatter < Struct.new(:pull_requests,
-                               :entry_template,
-                               :label_prefixes)
+  class Formatter
+    pattr_initialize :pull_requests, :entry_template, :label_prefixes
 
     def entries
       return '' if pull_requests.empty?
 
-      pull_requests.map do |pull_request|
-        entry_template % entry_template_data(pull_request)
-      end.join.prepend("\n")
+      pull_requests.map { |pull_request|
+        apply_template(entry_template, entry_template_data(pull_request))
+      }.join.prepend("\n")
     end
 
     private
 
+    def apply_template(template, template_data)
+      template.scan(/(?<=%{)[^}]*(?=})/).inject(template) do |result, match|
+        keys = match.split('.').map(&:to_sym)
+
+        begin
+          value = template_data.dig(*keys)
+        rescue StandardError
+          raise(InvalidInterpolation,
+                "%{#{match}} is not a valid interpolation pattern")
+        end
+
+        result.sub(/%{[^}]*}/, value.to_s)
+      end
+    end
+
     def entry_template_data(pull_request)
       pull_request.merge(title: prefixed_title(pull_request))
     end
@@ -24,13 +38,13 @@ module PrLog
     end
 
     def label_prefix(pull_request)
-      pull_request.fetch(:labels, []).map do |label|
+      pull_request.fetch(:labels, []).map { |label|
         label_prefixes[label[:name].to_s]
-      end.compact.first
+      }.compact.first
     end
 
     def format_title(pull_request)
-      pull_request[:title].capitalize
+      pull_request[:title]
     end
   end
 end

data/lib/pr_log/gemspec.rb

@@ -1,10 +1,12 @@
 module PrLog
   # Extract default configuration from a gem specification
-  class Gemspec < Struct.new(:specification, :milestone_format)
+  class Gemspec
+    pattr_initialize :specification, :milestone_format
+
     def github_repository
       unless specification.homepage =~ %r{https?://github.com/}
-        fail(NonGithubHomepage,
-             'Gemspec does not have GitHub hompage URL.')
+        raise(NonGithubHomepage,
+              'Gemspec does not have GitHub hompage URL.')
       end
 
       specification.homepage.split('github.com/').last
@@ -22,7 +24,6 @@ module PrLog
       [:major, :minor, :patch]
         .each_with_index
         .each_with_object({}) do |(name, index), result|
-
         result[name] = components[index]
       end
     end

data/lib/pr_log/github_repository.rb

@@ -21,8 +21,8 @@ module PrLog
     def fail_if_empty(result)
       return result if result.any?
 
-      fail(NoPullRequestsForMilestone,
-           'No pull requests for milestone')
+      raise(NoPullRequestsForMilestone,
+            'No pull requests for milestone')
     end
 
     def get_issues(query)

data/lib/pr_log/injector.rb

@@ -1,9 +1,12 @@
 module PrLog
   # Injects text into a file
-  class Injector < Struct.new(:destination_file)
+  class Injector
+    pattr_initialize :destination_file
+
     def insert_after(line, text)
       unless replace!(/#{line}/, '\0' + text)
-        fail(InsertPointNotFound, "Insert point not found in #{destination_file}.")
+        raise(InsertPointNotFound,
+              "Insert point not found in #{destination_file}.")
       end
     end
 

data/lib/pr_log/project.rb

@@ -1,6 +1,8 @@
 module PrLog
   # Parse files from the local project directory
-  class Project < Struct.new(:config)
+  class Project
+    pattr_initialize :config
+
     def issue_numbers_mentioned_in_changelog
       parsed_changelog.mentioned_issue_numbers
     end
@@ -11,7 +13,6 @@ module PrLog
 
     def github_repository_name
       config.github_repository || gemspec.github_repository
-
     rescue GemspecNotFound
       raise(GithubRepositoryRequired,
             'Could not derive github repository from gemspec.')
@@ -46,7 +47,7 @@ module PrLog
 
     def gemspec_path
       Dir.glob('*.gemspec').first ||
-        fail(GemspecNotFound, 'Gemspec not found.')
+        raise(GemspecNotFound, 'Gemspec not found.')
     end
   end
 end

data/lib/pr_log/version.rb

@@ -1,3 +1,3 @@
 module PrLog
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'.freeze
 end

data/lib/pr_log.rb

@@ -1,3 +1,6 @@
+require 'attr_extras'
+require 'yaml'
+
 require 'pr_log/cli'
 require 'pr_log/configuration'
 require 'pr_log/errors'
@@ -10,7 +13,6 @@ require 'pr_log/parsed_changelog'
 require 'pr_log/project'
 require 'pr_log/version'
 
-require 'yaml'
-
+# Turn GitHub pull requests into changelog entries.
 module PrLog
 end

data/pr_log.gemspec

@@ -1,35 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pr_log/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'pr_log'
-  spec.version       = PrLog::VERSION
-  spec.authors       = ['Tim Fischbach']
-  spec.email         = ['mail@timfischbach.de']
+  spec.name = 'pr_log'
+  spec.version = PrLog::VERSION
+  spec.authors = ['Tim Fischbach']
+  spec.email = ['mail@timfischbach.de']
 
-  spec.summary       = 'Turn GitHub pull requests into changelog entries'
-  spec.homepage      = 'https://github.com/tf/pr_log'
-  spec.license       = 'MIT'
+  spec.summary = 'Turn GitHub pull requests into changelog entries'
+  spec.homepage = 'https://github.com/tf/pr_log'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^spec/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'attr_extras', '~> 4.4'
+  spec.add_dependency 'events', '~> 0.9.8'
   spec.add_dependency 'octokit', '~> 4.0'
+  spec.add_dependency 'thor', '~> 0.19'
   spec.add_dependency 'virtus', '~> 1.0'
-  spec.add_dependency 'events'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler', ['>= 1.10', '< 3']
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 1.21'
-  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'rubocop', '~> 0.53.0'
+  spec.add_development_dependency 'semmy', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.13.0'
   spec.add_development_dependency 'unindent', '~> 1.0'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 1.21'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pr_log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tim Fischbach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: attr_extras
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: events
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -39,47 +53,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: virtus
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: events
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,33 +129,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: semmy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: unindent
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +185,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 description: 
 email:
 - mail@timfischbach.de
@@ -173,7 +221,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -218,8 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Turn GitHub pull requests into changelog entries