release-notes 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbac7369224dec75b2c286581ef8292dab0c608fe18a1308203990c254a01d0d
-  data.tar.gz: 1273166258cd46d3587612dfa6ac91a9263948227d661db6948a41490d7a9cd6
+  metadata.gz: 1f57251370fff06c63ccbbb0719638cf769a0f93e689670797ec7a9bbce6cecc
+  data.tar.gz: 59ea08dcca6b490195ba032e4786a4acc4062ab6883e291388975cf9681ef7c6
 SHA512:
-  metadata.gz: f2e17ed469381e6bea528251bd1e89380ef670f52a7284a228cac6277bfd147d41f3683491295b6ade8c577066fecfcb26fe8b0bff82312069070bd9fa60badb
-  data.tar.gz: 303d0e8cee409f45fdc93ac1dad4c59bc3f36325c78b58ea2dc898eb7fb11d28e0911dbb91ae75eaa917b4d91d252e5196a2b95be0a6dbd5194dab1604f7ad95
+  metadata.gz: faca9e5eda060af2c513130e711c178ef8a698b7bd91285730c4913eb0467657011ad39419d947de68341f7b7b2bdd3869a6314ffe86844b25dff028177c2e81
+  data.tar.gz: b72a541e60752ec2ece0badabcacc18014feebd9d20bea2dd3db4a31f50f73f5d7453c14e9d3de0a3fae0f2a96bf5a8efd3c6fc3e33d7e13ea37b4bf7cd17287

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
     - "Gemfile"
     - "Rakefile"
     - "vendor/**/*"
+    - "exe/*"
 
 Metrics/LineLength:
   Max: 120

data/.travis.yml

@@ -2,9 +2,7 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.1
-  - 2.4.2
   - 2.4.5
-  - 2.5.0
   - 2.5.3
 cache: bundler
 before_install: gem install bundler -v 1.12.5
@@ -15,3 +13,7 @@ script:
   - bundle exec rubocop
 after_success:
   - bundle exec codeclimate-test-reporter
+
+branches:
+  only:
+  - master

data/Gemfile

@@ -4,7 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'aruba', '~> 0.14.2'
   gem 'codeclimate-test-reporter', require: false
   gem 'rspec', '~> 3.6.0'
   gem 'simplecov', require: false

data/README.md

@@ -43,15 +43,15 @@ Or install it yourself as:
 $ gem install release-notes
 ```
 
-After you install Release::Notes, if you're using with rails, you can run the generator:
+After you install Release::Notes, generate the intializer file:
 
 ```sh
+# rails
 $ rails generate release:notes:install
-```
-
-This Release::Notes generator creates an initializer file to allow further configuration.
 
-If you're not in a rails project you can create the file yourself.
+# non-rails
+$ bundle exec release:notes:install
+```
 
 ## Configure
 
@@ -89,16 +89,22 @@ For more information about each individual setting checkout Release::Notes's
 
 ### TL;DR
 
-#### Rails
+Install the binstub
+
+```sh
+$ bundle binstubs release-notes
+```
+
+and run
 
 ```sh
-bin/rails update_release_notes:run
+$ bin/release-notes
 ```
 
-#### Non-Rails
+OR, just use the rake task
 
 ```sh
-bundle exec rake update_release_notes:run
+$ bundle exec rake update_release_notes:run
 ```
 
 ### Git Worklow
@@ -125,7 +131,7 @@ If using Rails, a rake task is included and would be best utilized within your d
 If not on rails, but using rake, you can easily craft your own rake task. At the very least calling
 
 ```ruby
-Release::Notes::Update.new.run
+Release::Notes.generate
 ```
 
 is the only instance that needs to be instantiated and invoked.
@@ -144,7 +150,8 @@ namespace :deploy do
   before :starting, :update_release_notes
 
   task :update_release_notes do
-    sh 'bin/rake "update_release_notes:run"'
+    # use the binstub
+    sh 'bin/release-notes"'
     # run a second task that generates an auto commit
     # this would be created by you
     sh 'bin/rake "release_notes:commit"'

data/exe/release-notes

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "release/notes"
+config_file = "./config/initializers/release_notes.rb"
+
+begin
+  require config_file
+  warn "=> Generating release notes..."
+  Release::Notes.generate
+  warn "=> Done!"
+rescue LoadError
+  warn "=> Missing config/initializers/release_notes.rb"
+rescue SignalException => e
+  # We might receive SIGTERM before our signal handler is installed.
+  if Signal.signame(e.signo) == "TERM"
+    exit(0)
+  else
+    raise
+  end
+rescue
+  exit(1)
+else
+  exit(0)
+end

data/lib/release/notes.rb

@@ -11,30 +11,27 @@ require "release/notes/version"
 require "release/notes/configuration"
 require "release/notes/git"
 require "release/notes/system"
-require "release/notes/with_configuration"
 
 require "release/notes/write"
 require "release/notes/log"
 
 require "release/notes/railtie" if defined?(Rails)
+require "release/notes/install" unless defined?(Rails)
 
 module Release
   module Notes
-    class Update
-      attr_reader :logger
-
-      def initialize
-        @options = Release::Notes.configuration
-        @logger = Release::Notes::Log.new @options
+    class << self
+      def generate
+        log.perform
       end
 
-      def run
-        logger.perform
+      def log
+        Release::Notes::Log.new
       end
-    end
 
-    def self.root
-      File.expand_path("..", __dir__)
+      def root
+        File.expand_path("..", __dir__)
+      end
     end
   end
 end

data/lib/release/notes/date_format.rb

@@ -3,18 +3,15 @@
 module Release
   module Notes
     class DateFormat
-      attr_reader :config, :time_now
-      delegate :timezone, to: :config
+      attr_reader :time_now
+      delegate :timezone, to: :"Release::Notes.configuration"
 
-      def initialize(config)
-        @config               = config
-        Time.zone             = timezone
-
-        @time_now             = Time.zone.now
+      def initialize
+        Time.zone = timezone
       end
 
       def date_humanized(date: nil)
-        date = date.present? ? Time.zone.parse(date) : time_now
+        date = date.present? ? Time.zone.parse(date) : Time.zone.now
         date.strftime("%B %d, %Y %r %Z")
       end
     end

data/lib/release/notes/git.rb

@@ -8,18 +8,18 @@ module Release
       extend ActiveSupport::Concern
 
       included do
-        delegate :all_labels, :log_format, :grep_insensitive?, :regex_type, :include_merges?, to: :config
+        delegate :all_labels, :log_format, :grep_insensitive?,
+                 :regex_type, :include_merges?, to: :"Release::Notes.configuration"
 
         def log(**opts)
-          "git log '#{opts[:tag_from]}'..'#{opts[:tag_to]}' --grep='#{opts[:label]}'" \
+          "git log '#{opts[:tag_from]}'..'#{opts[:tag_to]}'" \
+            " --grep='#{opts[:label]}'" \
             " #{regex_type} #{grep_insensitive?}" \
             " #{include_merges?} --format='#{log_format}'"
         end
 
         def invert_log(**opts)
-          "git log '#{opts[:tag_from]}'..'#{opts[:tag_to]}' --grep='#{all_labels}'" \
-            " #{regex_type} #{grep_insensitive?} --invert-grep" \
-            " #{include_merges?} --format='#{log_format}'"
+          log(opts) + " --invert-grep"
         end
       end
 

data/lib/release/notes/install.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rake"
+
+load File.expand_path(File.join(File.dirname(__FILE__), "tasks/install.rake"))

data/lib/release/notes/link.rb

@@ -6,7 +6,7 @@ module Release
       extend ActiveSupport::Concern
 
       included do
-        delegate :link_to_labels, :link_to_sites, :link_to_humanize, to: :config
+        delegate :link_to_labels, :link_to_sites, :link_to_humanize, to: :"Release::Notes.configuration"
 
         def link_lines(lines:)
           @new_lines = ""

data/lib/release/notes/log.rb

@@ -4,21 +4,21 @@ module Release
   module Notes
     class Log
       include System
-      include WithConfiguration
 
-      attr_reader :config, :writer, :date_formatter
+      attr_reader :writer, :date_formatter
       attr_reader :all_tags
 
-      delegate :force_rewrite, :all_labels, :log_all, :features, :bugs, :misc, :feature_title,
-               :bug_title, :misc_title, :log_all_title, :release_notes_exist?, to: :config
+      delegate :force_rewrite, :all_labels, :log_all, :features,
+               :bugs, :misc, :feature_title,
+               :bug_title, :misc_title, :log_all_title,
+               :release_notes_exist?, to: :"Release::Notes.configuration"
+
       delegate :date_humanized, :format_tag_date, to: :date_formatter
       delegate :digest_date, :digest_title, to: :writer
 
-      def initialize(config)
-        @config = config
-
-        setup_writer
-        setup_date_formatter
+      def initialize
+        @writer = Release::Notes::Write.new
+        @date_formatter = Release::Notes::DateFormat.new
       end
 
       def perform
@@ -43,57 +43,49 @@ module Release
       end
 
       # @api private
-      def copy_single_tag_of_activity(tag_from:, tag_to: "HEAD")
+      def copy_single_tag_of_activity(tag_from:, tag_to: "HEAD") # rubocop:disable Metrics/MethodLength
         [features, bugs, misc].each_with_index do |regex, i|
-          log = system_call(tag_from: tag_from, tag_to: tag_to, label: regex, log_all: false)
+          log = system_log(
+            tag_from: tag_from,
+            tag_to: tag_to,
+            label: regex,
+            log_all: false,
+          )
           digest_title(title: titles[i], log_message: log) if log.present?
         end
 
         return unless log_all
 
-        log = system_call(tag_from: tag_from, tag_to: tag_to, log_all: true)
+        log = system_log(
+          tag_from: tag_from,
+          tag_to: tag_to,
+          log_all: true,
+        )
         digest_title(title: log_all_title, log_message: log) if log.present?
       end
 
       # @api private
       def find_last_tag_and_log
         last_tag = system_last_tag.delete!("\n")
-        return false unless system_call(tag_from: last_tag, label: all_labels).present?
+        return false unless system_log(tag_from: last_tag, label: all_labels).present?
 
         # output the date right now
         digest_date date: date_humanized
         copy_single_tag_of_activity(tag_from: last_tag)
       end
 
-      # @api private
-      def setup_writer
-        @writer = Release::Notes::Write.new config
-      end
-
-      # @api private
-      def setup_date_formatter
-        @date_formatter = Release::Notes::DateFormat.new config
-      end
-
       # @api private
       def find_all_tags_and_log_all
         all_tags.each_with_index do |ta, i|
           previous_tag = all_tags[i + 1]
           next unless previous_tag.present? &&
-                      system_call(tag_from: previous_tag, tag_to: ta, label: all_labels).present?
+                      system_log(tag_from: previous_tag, tag_to: ta, label: all_labels).present?
 
           digest_date date: date_humanized(date: System.tag_date(tag: ta))
           copy_single_tag_of_activity(tag_from: previous_tag, tag_to: ta)
         end
       end
 
-      # @api private
-      def system_call(**opts)
-        with_config(config: config) do
-          system_log(opts)
-        end
-      end
-
       def titles
         [feature_title, bug_title, misc_title]
       end

data/lib/release/notes/pretty_print.rb

@@ -6,7 +6,7 @@ module Release
       extend ActiveSupport::Concern
 
       included do
-        delegate :all_labels, to: :config
+        delegate :all_labels, to: :"Release::Notes.configuration"
 
         def prettify(line:)
           line.gsub(labels_regex, "").strip

data/lib/release/notes/system.rb

@@ -10,11 +10,9 @@ module Release
 
       included do
         def system_log(**opts)
-          if opts[:log_all] == true
-            `#{invert_log(opts)}`
-          else
-            `#{log(opts)}`
-          end
+          return `#{invert_log(opts)}` if opts[:log_all] == true
+
+          `#{log(opts)}`
         end
       end
 

data/lib/release/notes/tasks/install.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :"release:notes" do
+  desc "Install release notes in a non Rails environment"
+  task :install do
+    config_file = File.expand_path("../../../generators/release/notes/install/templates/release_notes.rb", __dir__)
+
+    if File.exist?("./config/release_notes.rb")
+      warn "=> [ skipping ] config/release_notes.rb already exists"
+    else
+      FileUtils.cp(config_file, "./config/release_notes.rb")
+      warn "=> config/release_notes.rb created"
+    end
+  end
+end

data/lib/release/notes/version.rb

@@ -2,6 +2,6 @@
 
 module Release
   module Notes
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/lib/release/notes/write.rb

@@ -5,15 +5,12 @@ module Release
     class Write
       include Link
       include PrettyPrint
-      include WithConfiguration
-
-      attr_accessor :config
 
       delegate :output_file, :temp_file, :link_commits?, :all_labels,
-               :prettify_messages?, :release_notes_exist?, :force_rewrite, to: :config
+               :prettify_messages?, :release_notes_exist?,
+               :force_rewrite, to: :"Release::Notes.configuration"
 
-      def initialize(config)
-        @config = config
+      def initialize
         # create a new temp file regardless if it exists
         new_temp_file_template
       end
@@ -63,7 +60,7 @@ module Release
 
       # @api private
       def remove_tags
-        with_config(config: config) { prettify(line: link_messages) } if prettify_messages?
+        prettify(line: link_messages) if prettify_messages?
       end
 
       # @api private
@@ -83,15 +80,12 @@ module Release
       def link_message(log_message)
         return log_message unless link_commits?
 
-        with_config(config: config) do
-          link_lines(lines: log_message)
-        end
+        link_lines(lines: log_message)
       end
 
       # @api private
       def new_temp_file_template
-        File.new(temp_file, "w")
-        File.open(temp_file, "a") do |fi|
+        File.open(temp_file, "w") do |fi|
           fi << "# Release Notes\n"
         end
       end

data/lib/tasks/update_release_notes.rake

@@ -2,8 +2,8 @@
 
 namespace :update_release_notes do
   task :run do
-    puts "generating release notes..."
-    Release::Notes::Update.new.run
-    puts "done!"
+    puts "=> Generating release notes..."
+    Release::Notes.generate
+    puts "=> Done!"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Drew Monroe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -83,7 +83,8 @@ dependencies:
 description: Generate automated release notes for any project
 email:
 - dvmonroe6@gmail.com
-executables: []
+executables:
+- release-notes
 extensions: []
 extra_rdoc_files: []
 files:
@@ -103,6 +104,7 @@ files:
 - bin/console
 - bin/setup
 - bin/test
+- exe/release-notes
 - lib/generators/release/notes/install/install_generator.rb
 - lib/generators/release/notes/install/templates/README
 - lib/generators/release/notes/install/templates/release_notes.rb
@@ -110,13 +112,14 @@ files:
 - lib/release/notes/configuration.rb
 - lib/release/notes/date_format.rb
 - lib/release/notes/git.rb
+- lib/release/notes/install.rb
 - lib/release/notes/link.rb
 - lib/release/notes/log.rb
 - lib/release/notes/pretty_print.rb
 - lib/release/notes/railtie.rb
 - lib/release/notes/system.rb
+- lib/release/notes/tasks/install.rake
 - lib/release/notes/version.rb
-- lib/release/notes/with_configuration.rb
 - lib/release/notes/write.rb
 - lib/tasks/update_release_notes.rake
 - release-notes.gemspec

data/lib/release/notes/with_configuration.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Release
-  module Notes
-    module WithConfiguration
-      extend ActiveSupport::Concern
-
-      included do
-        attr_reader :config, :date_formatter
-
-        def with_config(**opts, &_block)
-          @confg = opts.fetch(:config, {})
-          yield
-        end
-      end
-    end
-  end
-end