codelog 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdc0db61aa88a54e953d1bc0abcb652f776fa596db6fc21f17008ee96e65f00d
-  data.tar.gz: f426e53e20594ff0729d50172882e0233d30e7e89338e84d692a1ef73d2d3014
+  metadata.gz: 9fd159ca76edb63f2a839baec37d89232d902edff3bc6ccdd7b4d57d97679090
+  data.tar.gz: d8bb75225596663caa438ec42293222de1555305186022e96b2a22bf024411e7
 SHA512:
-  metadata.gz: 658c2a502793683766b34f184a244a6c8e75bdef77675e483c2e7b36cf3b8c922cb95ccc715102780a5ed5f26bca97688da3428708167a0c674be0463af262fa
-  data.tar.gz: 730574b14e06985604734ad65248b9580ac404f4a515428ebb66e7d3131a63ef2099e2133e04400c39dc7f4699513d9c4c007e30bf087fa2be2ccf3d17ded93d
+  metadata.gz: d42fca0648b5eb83c9cb6d52c38ba692bc253afaa50e964561e967b87db5c0f47a2dbb90f07c94f4f3de356f57c66366bcf27451d872093547d9f17c5e045714
+  data.tar.gz: '079daac82645810755408249ebc81ebe2feaef4ccbdddec7bdabfc0cd14b2569f20ea5b7e8eea2db3abdb59e1d61ee360fc5093ccb5034ed09ad809a93085ddd'

data/CHANGELOG.md

@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.8.0
+### Added
+- Preview option for changelogs on the `release` and `bump` command
+
+### Fixed
+- Test file (`version_spec`), previously, this test would fail if you run it alone
+
+---
 ## 0.7.0
 ### Added
 - Command `codelog bump [major|minor|patch]` that automatically sets the next version

data/README.md

@@ -76,9 +76,9 @@ After the initial setup every time a change is made, the developer should run th
 $ codelog new <NAME>
 ```
 
-This will generate a change file, in `YAML` format, on `changelogs/unreleased/` from the `template.yml`, named with a timestamp value followed by the the given `NAME`, converted to snake case, or the default name(`change`).
+This will generate a change file, in `YAML` format, on `changelogs/unreleased/` from the `template.yml`, named with a timestamp value followed by the given `NAME`, converted to snake case, or the default name(`change`).
 
-The new change file should be filled with informations about the implemented change, all unused topics should be erased and the file committed.
+The new change file should be filled with information about the implemented change, all unused topics should be erased and the file committed.
 
 Additionally, you can pass some extra options to the `new` command. Type `codelog help new` in your console for more information.
 
@@ -95,7 +95,7 @@ No conflicts to resolve. All changes documented.
 
 It will execute 3 steps:
 
-- Generate a new release file at `changelogs/releases/` by merging all change files at `changelogs/unreleased/`
+- Generates a new release file at `changelogs/releases/` by merging all change files at `changelogs/unreleased/`
 - Deletes the change files at `changelogs/unreleased/` because they now compose the new release. If it was not deleted, the change would appear repeated in the next release.
 - Updates the `CHANGELOG.md` file by merging all the releases at `changelogs/releases/`.
 
@@ -105,6 +105,15 @@ $ codelog bump [major|minor|patch] <RELEASE_DATE>
 ```
 Where the first mandatory parameter is the desired release type, i.e: If you don't have any release, `codelog bump patch` will release the 0.0.1 version.
 
+### Preview a Release
+
+Sometimes, you just want to check the developed changes or preview how the next release will look like. To do so, you can pass the `[-p|--preview]` option on the `release` and `bump` commands. For instance, the following:
+
+``` bash
+$ codelog release 1.0.0 --preview
+```
+Will display a preview of your changes on your console as if the version **1.0.0** has been released.
+
 ## Configuring
 
 Since version 0.3.0, there are a few configurations that are possible. You can choose:

data/lib/codelog.rb

@@ -2,9 +2,12 @@ require 'codelog/cli'
 require 'codelog/config'
 require 'codelog/message'
 require 'codelog/version'
+require 'codelog/output/release_file'
+require 'codelog/output/log'
 require 'codelog/command/setup'
 require 'codelog/command/new'
 require 'codelog/command/release'
+require 'codelog/command/preview'
 require 'codelog/command/bump'
 require 'codelog/command/step/changelog'
 require 'codelog/command/step/delete'

data/lib/codelog/cli.rb

@@ -19,16 +19,24 @@ module Codelog
     end
 
     desc 'release [VERSION] <RELEASE_DATE>', 'Generate new release updating changelog'
-    def release(version_number, release_date =
-                Date.today.strftime(Codelog::Config.date_input_format))
-      Codelog::Command::Release.run version_number, release_date
+    method_option :preview, desc: 'Prints the preview of the specified version release',
+                            aliases: ['-p', '--preview'], type: :boolean
+    def release(version_number,
+                release_date = Date.today.strftime(Codelog::Config.date_input_format))
+      if options[:preview]
+        Codelog::Command::Preview.run version_number, release_date
+      else
+        Codelog::Command::Release.run version_number, release_date
+      end
     end
 
     desc 'bump [VERSION_TYPE] <RELEASE_DATE>', 'Bumps the next version,
      being it major, minor or patch'
+    method_option :preview, desc: 'Prints the preview of the next version',
+                            aliases: ['-p', '--preview'], type: :boolean
     def bump(version_type, release_date =
                 Date.today.strftime(Codelog::Config.date_input_format))
-      Codelog::Command::Bump.run version_type, release_date
+      Codelog::Command::Bump.run version_type, release_date, options
     end
   end
 end

data/lib/codelog/command/bump.rb

@@ -6,16 +6,20 @@ module Codelog
       VALID_VERSION_TYPES = ['major', 'minor', 'patch'].freeze
       INITIAL_RELEASE_VERSION = '0.0.0'.freeze
 
-      def self.run(version_type, release_date)
-        Codelog::Command::Bump.new.run version_type, release_date
+      def self.run(version_type, release_date, options)
+        Codelog::Command::Bump.new.run version_type, release_date, options
       end
 
-      def run(version_type, release_date)
+      def run(version_type, release_date, options)
         unless VALID_VERSION_TYPES.include?(version_type.downcase)
           abort(Codelog::Message::Error.invalid_version_type(version_type))
         end
 
-        Codelog::Command::Release.run(next_version(version_type), release_date)
+        if options[:preview]
+          Codelog::Command::Preview.run(next_version(version_type), release_date)
+        else
+          Codelog::Command::Release.run(next_version(version_type), release_date)
+        end
       end
 
       private

data/lib/codelog/command/preview.rb

@@ -0,0 +1,14 @@
+module Codelog
+  module Command
+    class Preview
+      def self.run(version_number, release_date)
+        Codelog::Command::Preview.new.run version_number, release_date
+      end
+
+      def run(version_number, release_date)
+        outputter = Codelog::Output::Log.new
+        Codelog::Command::Step::Version.run version_number, release_date, outputter
+      end
+    end
+  end
+end

data/lib/codelog/command/release.rb

@@ -1,12 +1,15 @@
 module Codelog
   module Command
     class Release
+      RELEASES_PATH = 'changelogs/releases'.freeze
+
       def self.run(version_number, release_date)
         Codelog::Command::Release.new.run version_number, release_date
       end
 
       def run(version_number, release_date)
-        Codelog::Command::Step::Version.run version_number, release_date
+        outputter = Codelog::Output::ReleaseFile.new("#{RELEASES_PATH}/#{version_number}.md")
+        Codelog::Command::Step::Version.run version_number, release_date, outputter
         Codelog::Command::Step::Delete.run
         Codelog::Command::Step::Changelog.run
         puts "\n== Changelog updated to version #{version_number} =="

data/lib/codelog/command/step/version.rb

@@ -7,34 +7,45 @@ module Codelog
     module Step
       class Version
         include FileUtils
-
-        RELEASES_PATH = 'changelogs/releases'.freeze
         UNRELEASED_LOGS_PATH = 'changelogs/unreleased'.freeze
         CONFIG_FILE_PATH = 'changelogs/codelog.yml'.freeze
+        RELEASES_PATH = 'changelogs/releases'.freeze
 
-        def initialize(version, release_date)
+        def initialize(version, release_date, outputter)
           abort(Codelog::Message::Error.missing_config_file) unless config_file_exists?
           @version = version
           @release_date = Date.strptime(release_date, Codelog::Config.date_input_format).to_s
+          @outputter = outputter
         rescue ArgumentError
           abort(Codelog::Message::Error.invalid_date_format)
         end
 
-        def self.run(version, release_date)
-          Codelog::Command::Step::Version.new(version, release_date).run
+        def self.run(version, release_date, outputter)
+          Codelog::Command::Step::Version.new(version, release_date, outputter).run
         end
 
         def run
           abort(Codelog::Message::Error.missing_version_number) if @version.nil?
           abort(Codelog::Message::Error.already_existing_version(@version)) if version_exists?
           abort(Codelog::Message::Error.no_detected_changes(@version)) unless unreleased_changes?
-          chdir Dir.pwd do
-            create_version_changelog_from changes_hash
-          end
+
+          @outputter.print generate_changelog_content_from(changes_hash)
         end
 
         private
 
+        def generate_changelog_content_from(changes_hash)
+          file_content = StringIO.new
+          file_content.puts "## #{Codelog::Config.version_tag(@version, @release_date)}"
+          changes_hash.each do |category, changes|
+            file_content.puts "### #{category}"
+            add_entry(file_content, changes)
+            file_content.puts "\n"
+          end
+          file_content.puts "---\n"
+          file_content.string
+        end
+
         def changes_hash
           change_files_paths = Dir["#{UNRELEASED_LOGS_PATH}/*.yml"]
           change_files_paths.inject({}) do |all_changes, change_file|
@@ -60,18 +71,6 @@ module Codelog
           end
         end
 
-        def create_version_changelog_from(changes_hash)
-          File.open("#{RELEASES_PATH}/#{@version}.md", 'a') do |line|
-            line.puts "## #{Codelog::Config.version_tag(@version, @release_date)}"
-            changes_hash.each do |category, changes|
-              line.puts "### #{category}"
-              add_entry(line, changes)
-              line.puts "\n"
-            end
-            line.puts "---\n"
-          end
-        end
-
         def version_exists?
           File.file?("#{RELEASES_PATH}/#{@version}.md")
         end

data/lib/codelog/output/log.rb

@@ -0,0 +1,13 @@
+module Codelog
+  module Output
+    class Log
+      def self.print(content)
+        new.print(content)
+      end
+
+      def print(content)
+        IO.popen('less', 'w') { |output| output.puts content }
+      end
+    end
+  end
+end

data/lib/codelog/output/release_file.rb

@@ -0,0 +1,21 @@
+module Codelog
+  module Output
+    class ReleaseFile
+      def initialize(file_path)
+        @file_path = file_path
+      end
+
+      def self.print(content, file_path)
+        new(file_path).print(content)
+      end
+
+      def print(content)
+        Dir.chdir Dir.pwd do
+          File.open(@file_path, 'a') do |line|
+            line.puts content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codelog/version.rb

@@ -1,3 +1,3 @@
 module Codelog
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.8.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codelog
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Luís Bevilacqua
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -120,6 +120,7 @@ files:
 - lib/codelog/clis/interactive.rb
 - lib/codelog/command/bump.rb
 - lib/codelog/command/new.rb
+- lib/codelog/command/preview.rb
 - lib/codelog/command/release.rb
 - lib/codelog/command/setup.rb
 - lib/codelog/command/step/changelog.rb
@@ -127,6 +128,8 @@ files:
 - lib/codelog/command/step/version.rb
 - lib/codelog/config.rb
 - lib/codelog/message.rb
+- lib/codelog/output/log.rb
+- lib/codelog/output/release_file.rb
 - lib/codelog/version.rb
 - lib/fixtures/codelog.yml
 - lib/fixtures/header.txt