codelog 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f1e5ce48ce1d8a919fc4c121090b8f5efdb908e
-  data.tar.gz: efb600d1427eb7b60773cd1c186035fd972dbf3d
+SHA256:
+  metadata.gz: b871029a453ff73c21adb12c5656b9be50049096a852e9c6e31ba7599023ddbf
+  data.tar.gz: 2aa614de8b36eddbeae04dd34efc1e7716f7a24aa3cbee1ded0d171f768aacf8
 SHA512:
-  metadata.gz: 86a05331db80325f448a3a09c59a8d43a15c9d83bed1d8026038ae26e901b3687738141fd419a6066a903f1e8fd4c09b9a1e526794375d1d493f74706343f543
-  data.tar.gz: fb3404f11c69905bb8e5639d8c9c80bef154ca01ddff8eeea0a768f0bf9886f9ff1575a6dd081aa4bd5ce233440b9ddb6ce39e3e954e6c21e39907aa3b1a986a
+  metadata.gz: cffe89ed35c63814b810949a3ba02bc48d4228e1cff2e941e214e54cf5c6a48c8e01059abadfed11917c0a1dff4fc838ad712bd37f90aba911e780860b36b0ed
+  data.tar.gz: db61fc1fa5114692bf10f9998211d66c91b02975ffc10489369412f4e60a17e8c617e0c0045044d620234555bed29d97015e7f565d74c1ca8ff40dd22611e98d

data/CHANGELOG.md

@@ -3,6 +3,17 @@ 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.6.0
+### Added
+- The `new` command receives a `NAME` parameter that will be converted to the unreleased file name
+- Tests to verify if changes subcategories are properly tabulated on markdown file
+- Tests to verify if `release` command is properly aborted if no `codelog.yml` file is found
+- Interactive creation of the change files
+
+### Fixed
+- When an unreleased file is not parseable to yml, the user will get a friendly message, saying both file and line that are wrong.
+
+---
 ## 0.5.0
 ### Added
 - Ability to edit the created changefile by running `codelog new <-e|--edit>`

data/README.md

@@ -68,21 +68,29 @@ The template can be as the following example:
 
 ## Usage
 
+### Creating a new change file
+
 After the initial setup every time a change is made, the developer should run the following command in the project root path:
 
 ``` bash
-$ codelog new
+$ codelog new <NAME>
 ```
 
-This will generate a change file on `changelogs/unreleased/` from the `template.yml` named with a timestamp value followed by `_change.yml`.
+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`).
 
 The new change file should be filled with informations 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.
+
+### Releasing a version
+
 Once all changes were merged and the release is ready to be packed, all that must be done is to run the following command:
 
 ``` bash
-$ codelog release {x.y.z}
+$ codelog release [VERSION] <RELEASE_DATE>
 ```
+Where the `VERSION` is mandatory and represents the number of the next version of the system. An additional parameter `RELEASE_DATE` can be used, and if so, the release date of the version will be that value. You can configure the format of this parameter in the configuration file, under `changelogs/codelog.yml`.
+
 No conflicts to resolve. All changes documented.
 
 It will execute 3 steps:

data/lib/codelog.rb

@@ -8,3 +8,4 @@ require 'codelog/command/release'
 require 'codelog/command/step/changelog'
 require 'codelog/command/step/delete'
 require 'codelog/command/step/version'
+require 'codelog/clis/interactive'

data/lib/codelog/cli.rb

@@ -9,11 +9,13 @@ module Codelog
       Codelog::Command::Setup.run
     end
 
-    desc 'new', 'Generate a file from the template for the unreleased changes'
+    desc 'new <NAME>', 'Generate a file from the template for the unreleased changes'
     method_option :edit, desc: 'Opens the default system editor after creating a changefile',
                          aliases: '-e', type: :boolean
-    def new
-      Codelog::Command::New.run options
+    method_option :interactive, desc: 'Add contents interactively to change file',
+                                aliases: '-i', type: :boolean
+    def new(name = 'change')
+      Codelog::Command::New.run name, options
     end
 
     desc 'release [VERSION] <RELEASE_DATE>', 'Generate new release updating changelog'

data/lib/codelog/clis/interactive.rb

@@ -0,0 +1,51 @@
+require 'thor'
+
+module Codelog
+  module CLIs
+    class Interactive < Thor
+      include Thor::Actions
+
+      no_commands do
+        def initialize
+          @sections = YAML.load_file('changelogs/template.yml').keys
+        end
+
+        def run
+          changes_hash = Hash.new([])
+          loop do
+            change_category = ask_for_type
+            say "\nType the entries for #{set_color(change_category, :yellow)}(ENTER to stop):"
+            changes_hash[change_category] += ask_for_changes
+            break if no? "\nWould you like to add a new log(Y|N)?"
+          end
+
+          changes_hash
+        end
+
+        private
+
+        def ask_for_type
+          say 'Enter a change type number:'
+          @sections.each_with_index do |section, index|
+            say "#{index + 1}. #{section}"
+          end
+          @sections[ask('>').to_i - 1]
+        end
+
+        def ask_for_changes(changes = [], level = 1)
+          change = ask('>' * level)
+
+          return changes if change.empty?
+
+          change = { change.chomp(':') => ask_for_changes([], level + 1) } if subcategory?(change)
+
+          ask_for_changes(changes.push(change), level)
+        end
+
+        def subcategory?(change)
+          change.end_with?(':')
+        end
+      end
+    end
+  end
+end

data/lib/codelog/command/new.rb

@@ -5,24 +5,43 @@ module Codelog
     class New
       include FileUtils
 
-      def self.run(options)
-        Codelog::Command::New.new.run options
+      def initialize(name, options)
+        @name = name
+        @options = options
       end
 
-      def run(options)
+      def self.run(name, options)
+        new(name, options).run
+      end
+
+      def run
         chdir Dir.pwd do
           # This script create a change file for the changelog documentation.
 
-          full_file_name = "changelogs/unreleased/#{Time.now.strftime('%Y%m%d%H%M%S%L')}_change.yml"
-
-          puts "== Creating #{full_file_name} change file based on example =="
-          system! "cp changelogs/template.yml #{full_file_name}"
-          system! "#{default_editor} #{full_file_name}" if options[:edit]
+          @file_name = "changelogs/unreleased/#{change_file_timestamp}_#{change_file_name}.yml"
+          if @options[:interactive]
+            build_from_hash Codelog::CLIs::Interactive.new.run
+          else
+            build_from_template
+          end
+          system! "#{default_editor} #{@file_name}" if @options[:edit]
         end
       end
 
       private
 
+      def build_from_template
+        puts "== Creating #{@file_name} change file based on example =="
+        system! "cp changelogs/template.yml #{@file_name}"
+      end
+
+      def build_from_hash(changes_hash)
+        puts "== Creating #{@file_name} change file from the provided changes =="
+        File.open(@file_name, 'a') do |file|
+          file.puts changes_hash.to_yaml
+        end
+      end
+
       def default_editor
         # Looks for the default editor in VISUAL and EDITOR system variables
         # if no variable is set it defaults to nano
@@ -30,6 +49,16 @@ module Codelog
         '${VISUAL:-${EDITOR:-nano}}'
       end
 
+      def change_file_timestamp
+        Time.now.strftime('%Y%m%d%H%M%S%L')
+      end
+
+      def change_file_name
+        # Converts the name to snake case
+
+        @name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+      end
+
       def system!(*args)
         system(*args) || abort("\n== Command #{args} failed ==")
       end

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

@@ -43,6 +43,8 @@ module Codelog
               changes | changes_to_be_added
             end
           end
+        rescue Psych::SyntaxError => error
+          abort(Codelog::Message::Error.could_not_parse_yaml(error))
         end
 
         def add_entry(line, changes, level = 0)

data/lib/codelog/message.rb

@@ -32,6 +32,10 @@ module Codelog
           "Run the following command to create the missing file:\n\n" \
           'codelog setup'
         end
+
+        def could_not_parse_yaml(error)
+          "#{prefix}: #{error.problem.capitalize} in #{error.file}:#{error.line}"
+        end
       end
     end
 

data/lib/codelog/version.rb

@@ -1,3 +1,3 @@
 module Codelog
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codelog
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Luís Bevilacqua
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -117,6 +117,7 @@ files:
 - bin/setup
 - lib/codelog.rb
 - lib/codelog/cli.rb
+- lib/codelog/clis/interactive.rb
 - lib/codelog/command/new.rb
 - lib/codelog/command/release.rb
 - lib/codelog/command/setup.rb
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A gem to help with changelog management