codelog 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8ac42eba02c56c3f16d9726d8912bf96fdb8a0b
-  data.tar.gz: f5ad7ff1277ebd0e34e7dfcb31dda71675c8344e
+  metadata.gz: 67568d91a6f6e61135b6fc3da1aa52ba3c393d1b
+  data.tar.gz: b43bfaca90fe3fdaed293812190bb6bbd4dd2c1b
 SHA512:
-  metadata.gz: 281e98ad63b396e1ed291f8c276a2a9721359b817fee5ce3da115280dab3915eacb725f4736200c81ba6a041dac52638278fc6013962dd141e1656c555c31a9d
-  data.tar.gz: 83b6518cddb2cf1ea6d09d4149e68517907aed4cb5a5f22b85f5d08f18e25a4a69cf98d9e4507f1169323dfc86d05d78bc0a7efaa7df542e37488291bd30eb6e
+  metadata.gz: 95ea31468c7bb6b76132bff6283e14af7fb1b40b4b8f1990b088201e5e3c2f656c276f8477af07608c9fb07b2479cb3fd9ab9ae05c782f3d6d5e3d7dcab5bae4
+  data.tar.gz: be34ae8933a17d24be14d5a2adc07fe417018c7345135a7a1bf7fe5307f1bd2c5881badc0613f6e1808ccf1a17151be55de7bbae5b206f15adba3de0b17f5fe7

data/CHANGELOG.md

@@ -1,8 +1,27 @@
 # Changelog
-  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).
-            
+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.3.0
+### Changed
+- Human-readable timestamp for the change files
+- Altered setup to print message instead of aborting when creating files
+- Changelog header is now configurable through 'changelogs/header.txt'
+- Insulated abort messages within Codelog::Messages
+- Blocked attempt to release a changelog with no changes
+- Blocked attempt to release repeated versions from a changelog
+
+### Added
+- Configurable filename
+- Configurable input and output date formats
+- Enable/Disable 'datestamps' within version tag
+- Version prefix, version suffix and date prefix within version tag
+- Previous existing changelog can now be merged upon 'codelog setup'
+- Message after the release command
+- Datestamps along with version tag (synthax codelog release [x.y.z] <DATE>)
+
+---
 ## 0.2.3
 ### Changed
 - Setup command now creates a .gitkeep file on /changelogs/releases folder

data/README.md

@@ -1,10 +1,15 @@
 ![CodeLog logo](https://raw.githubusercontent.com/codus/codelog/master/codelog.png)
 
+[![Gem Version](https://badge.fury.io/rb/codelog.svg)](https://badge.fury.io/rb/codelog)
 [![Build Status](https://travis-ci.org/codus/codelog.svg?branch=master)](https://travis-ci.org/codus/codelog)
 [![Maintainability](https://api.codeclimate.com/v1/badges/6f5885536c6b5c82f304/maintainability)](https://codeclimate.com/github/codus/codelog/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/6f5885536c6b5c82f304/test_coverage)](https://codeclimate.com/github/codus/codelog/test_coverage)
 
-This gem provides a simple way to manage changelogs, avoiding conflicts and missplaced informations. Changes are handled as if they were "migrations" and built when releasing a version, allowing a more precise knowledge of what changes were made to what version.
+A gem to help big teams to manage their chagelogs.
+
+When many people are developing changes to compose one product release, there can be some conflicts on merging the changes added to the Changelog. These conflicts can be badly resolved by git, which could cause lost of important release notes.
+
+This gem provides a simple way to manage changelogs, avoiding these conflicts and missplaced informations. Changes are handled as if they were "migrations" and built when releasing a version, allowing a more precise knowledge of what changes were made to what version.
 
 ## Installation
 
@@ -63,7 +68,7 @@ The template can be as the following example:
 
 ## Usage
 
-After the initial setup every time a change is made, the user should run the following command in the project root path:
+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
@@ -73,11 +78,12 @@ This will generate a change file on `changelogs/unreleased/` from the `template.
 
 The new change file should be filled with informations about the implemented change, all unused topics should be erased and the file committed.
 
-When closing a version you should run the following command:
+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}
 ```
+No conflicts to resolve. All changes documented.
 
 It will execute 3 steps:
 
@@ -85,6 +91,21 @@ It will execute 3 steps:
 - 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/`.
 
+## Configuring
+
+Since version 0.3.0, there are a few configurations that are possible. You can choose:
+- The name of the Changelog file.
+- The header of the Changelog file.
+- The format of the version and date on the releases.
+- Whether to show the release date or not.
+- The enter format for the release date.
+
+In case you were using version 0.2.0, you will have to run:
+
+```bash
+$ codelog setup
+```
+
 ## Contributing
 
 Issue reports and pull requests are welcome on GitHub at https://github.com/codus/codelog. Read our [Contributing guide] for instructions on how to do it.

data/lib/codelog.rb

@@ -1,5 +1,7 @@
-require 'codelog/version'
 require 'codelog/cli'
+require 'codelog/config'
+require 'codelog/message'
+require 'codelog/version'
 require 'codelog/command/setup'
 require 'codelog/command/new'
 require 'codelog/command/release'

data/lib/codelog/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'date'
 
 module Codelog
   class CLI < Thor
@@ -8,14 +9,13 @@ module Codelog
     end
 
     desc 'new', 'Generate a file from the template for the unreleased changes'
-    method_option :change, aliases: '-c', default: true, desc: 'Create a change file'
     def new
       Codelog::Command::New.run
     end
 
-    desc 'release [VERSION]', 'Generate new release updating changelog'
-    def release(version_number)
-      Codelog::Command::Release.run version_number
+    desc 'release [VERSION] <RELEASE_DATE>', 'Generate new release updating changelog'
+    def release(version_number, release_date = Date.today.to_s)
+      Codelog::Command::Release.run version_number, release_date
     end
   end
 end

data/lib/codelog/command/new.rb

@@ -13,7 +13,7 @@ module Codelog
         chdir Dir.pwd do
           # This script create a change file for the changelog documentation.
 
-          full_file_name = "changelogs/unreleased/#{Time.now.to_i}_change.yml"
+          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}"

data/lib/codelog/command/release.rb

@@ -1,14 +1,15 @@
 module Codelog
   module Command
     class Release
-      def self.run(version_number)
-        Codelog::Command::Release.new.run version_number
+      def self.run(version_number, release_date)
+        Codelog::Command::Release.new.run version_number, release_date
       end
 
-      def run(version_number)
-        Codelog::Command::Step::Version.run version_number
+      def run(version_number, release_date)
+        Codelog::Command::Step::Version.run version_number, release_date
         Codelog::Command::Step::Delete.run
         Codelog::Command::Step::Changelog.run
+        puts "\n== Changelog updated to version #{version_number} =="
       end
     end
   end

data/lib/codelog/command/setup.rb

@@ -5,7 +5,12 @@ module Codelog
     class Setup
       include FileUtils
 
-      TEMPLATE_FILE_PATH = File.dirname(__FILE__) + '/../../fixtures/template.yml'
+      TEMPLATE_FILE_PATH = File.dirname(__FILE__).concat('/../../fixtures/template.yml')
+      CONFIG_FILE_PATH = File.dirname(__FILE__).concat('/../../fixtures/codelog.yml')
+      HEADER_FILE_PATH = File.dirname(__FILE__).concat('/../../fixtures/header.txt')
+
+      CHANGELOG_DEFAULT_PATH = 'CHANGELOG.md'.freeze
+      CHANGELOG_DESTINATION_PATH = 'changelogs/releases/0.0.0.md'.freeze
 
       def self.run
         Codelog::Command::Setup.new.run
@@ -14,21 +19,65 @@ module Codelog
       def run
         chdir Dir.pwd do
           # This script provides the initial setup for the gem usage.
-
           puts '== Creating folder structure and template =='
-          system! 'mkdir changelogs/'
-          system! 'mkdir changelogs/unreleased'
-          system! 'mkdir changelogs/releases'
-          system! "cp #{TEMPLATE_FILE_PATH} changelogs/template.yml"
-          system! 'touch changelogs/unreleased/.gitkeep'
-          system! 'touch changelogs/releases/.gitkeep'
+          create_folder_structure
+          puts '== Copying fixtures =='
+          copy_fixtures
+          handle_existing_changelog
         end
       end
 
       private
 
+      def create_folder_structure
+        system! 'mkdir changelogs/'
+        system! 'mkdir changelogs/unreleased'
+        system! 'mkdir changelogs/releases'
+        system! 'touch changelogs/unreleased/.gitkeep'
+        system! 'touch changelogs/releases/.gitkeep'
+      end
+
+      def copy_fixtures
+        system! "cp #{TEMPLATE_FILE_PATH} changelogs/template.yml"
+        system! "cp #{CONFIG_FILE_PATH} changelogs/codelog.yml"
+        system! "cp #{HEADER_FILE_PATH} changelogs/header.txt"
+      end
+
+      def handle_existing_changelog
+        return unless old_changelog_exists?
+        if yes? Codelog::Message::Warning.mantain_versioning_of_existing_changelog?
+          puts '== Copying existing changelog to releases folder =='
+          copy_and_mark_changelog
+        elsif yes? Codelog::Message::Warning.delete_existing_changelog?
+          puts '== Deleting existing changelog =='
+          system! "rm #{CHANGELOG_DEFAULT_PATH}"
+        end
+      end
+
+      def old_changelog_exists?
+        File.file?(CHANGELOG_DEFAULT_PATH)
+      end
+
+      def copy_and_mark_changelog
+        File.open(CHANGELOG_DEFAULT_PATH, 'rb') do |orig|
+          File.open(CHANGELOG_DESTINATION_PATH, 'wb') do |dest|
+            dest.write("<!-- Old changelog starts here -->\n\n")
+            dest.write(orig.read)
+          end
+        end
+      end
+
       def system!(*args)
-        system(*args) || abort("\n== Command #{args} failed ==")
+        system(*args) || puts("\n== Command #{args} was skipped ==")
+      end
+
+      def yes?(args)
+        puts(args)
+        receive
+      end
+
+      def receive(stdin: $stdin)
+        stdin.gets.chomp.casecmp('y').zero?
       end
     end
   end

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

@@ -30,12 +30,9 @@ module Codelog
         end
 
         def create_file_from(changes)
-          File.open('CHANGELOG.md', 'w+') do |f|
-            f.puts %(# Changelog
-  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).
-            )
+          File.open(Codelog::Config.filename, 'w+') do |f|
+            f.puts '# Changelog'
+            f.puts Codelog::Config.header
             f.puts(changes)
           end
         end

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

@@ -1,3 +1,4 @@
+require 'date'
 require 'yaml'
 require 'fileutils'
 
@@ -7,16 +8,26 @@ module Codelog
       class Version
         include FileUtils
 
-        def initialize(version)
+        RELEASES_PATH = 'changelogs/releases'.freeze
+        UNRELEASED_LOGS_PATH = 'changelogs/unreleased'.freeze
+        CONFIG_FILE_PATH = 'changelogs/codelog.yml'.freeze
+
+        def initialize(version, release_date)
+          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
+        rescue ArgumentError
+          abort(Codelog::Message::Error.invalid_date_format)
         end
 
-        def self.run(version)
-          Codelog::Command::Step::Version.new(version).run
+        def self.run(version, release_date)
+          Codelog::Command::Step::Version.new(version, release_date).run
         end
 
         def run
-          abort('ERROR: Please enter a version number') if @version.nil?
+          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
@@ -25,7 +36,7 @@ module Codelog
         private
 
         def changes_hash
-          change_files_paths = Dir['changelogs/unreleased/*.yml']
+          change_files_paths = Dir["#{UNRELEASED_LOGS_PATH}/*.yml"]
           change_files_paths.inject({}) do |all_changes, change_file|
             changes_per_category = YAML.load_file(change_file)
             all_changes.merge!(changes_per_category) do |category, changes, changes_to_be_added|
@@ -35,8 +46,8 @@ module Codelog
         end
 
         def create_version_changelog_from(changes_hash)
-          File.open("changelogs/releases/#{@version}.md", 'a') do |line|
-            line.puts "## #{@version}"
+          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}"
               changes.each { |change| line.puts "- #{change}" }
@@ -45,6 +56,18 @@ module Codelog
             line.puts "---\n"
           end
         end
+
+        def version_exists?
+          File.file?("#{RELEASES_PATH}/#{@version}.md")
+        end
+
+        def unreleased_changes?
+          Dir["#{UNRELEASED_LOGS_PATH}/*.yml"].any?
+        end
+
+        def config_file_exists?
+          File.file?(CONFIG_FILE_PATH)
+        end
       end
     end
   end

data/lib/codelog/config.rb

@@ -0,0 +1,58 @@
+require 'date'
+
+module Codelog
+  class Config
+    CONFIG_FILE_PATH = 'changelogs/codelog.yml'.freeze
+
+    class << self
+      def filename
+        settings['default_changelog_filename'] || 'CHANGELOG.md'
+      end
+
+      def header
+        File.open(settings['header_textfile'], 'r').read || ''
+      end
+
+      def date_input_format
+        settings['date_input_format'] || '%Y-%m-%d'
+      end
+
+      def version_tag(version, release_date)
+        date_suffix =
+          if show_date?
+            parsed_date = Date.strptime(release_date, '%Y-%m-%d').strftime(date_output_format)
+            " - #{date_prefix}#{parsed_date}"
+          else
+            ''
+          end
+        "#{version_prefix}#{version}#{version_suffix}#{date_suffix}"
+      end
+
+      private
+
+      def date_output_format
+        settings['date_output_format'] || '%Y-%m-%d'
+      end
+
+      def version_prefix
+        settings['version_prefix'] || ''
+      end
+
+      def version_suffix
+        settings['version_suffix'] || ''
+      end
+
+      def date_prefix
+        settings['date_prefix'] || ''
+      end
+
+      def show_date?
+        settings['show_date']
+      end
+
+      def settings
+        @settings ||= YAML.load_file(CONFIG_FILE_PATH)
+      end
+    end
+  end
+end

data/lib/codelog/message.rb

@@ -0,0 +1,56 @@
+module Codelog
+  class Message
+    class Error
+      class << self
+        def prefix
+          'ERROR'
+        end
+
+        def missing_version_number
+          "#{prefix}: Please enter a version number"
+        end
+
+        def invalid_date_format
+          "#{prefix}: Invalid date format. Check the input date format on:\n\n" \
+          'changelogs/codelog.yml'
+        end
+
+        def already_existing_version(version)
+          "#{prefix}: Could not create release #{version}. Release #{version} already exists"
+        end
+
+        def no_detected_changes(version)
+          "#{prefix}: Could not create release #{version}. You must create a change first.\n" \
+          "Run the following command to create a new change file:\n\n" \
+          "codelog new\n\n" \
+          "Then describe your changes on the file generated at:\n\n" \
+          'changelog/unreleased'
+        end
+
+        def missing_config_file
+          "#{prefix}: Could not find a config file.\n" \
+          "Run the following command to create the missing file:\n\n" \
+          'codelog setup'
+        end
+      end
+    end
+
+    class Warning
+      class << self
+        def prefix
+          'WARNING'
+        end
+
+        def mantain_versioning_of_existing_changelog?
+          "#{prefix}: There is already a file named CHANGELOG.md within " \
+          'your project. Do you wish to mantain its versioning? (Y/N)'
+        end
+
+        def delete_existing_changelog?
+          "#{prefix}: When generating a release for the first " \
+          'time, CHANGELOG.md will be erased. Do you wish to erase it now? (Y/N)'
+        end
+      end
+    end
+  end
+end

data/lib/codelog/version.rb

@@ -1,3 +1,3 @@
 module Codelog
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/fixtures/codelog.yml

@@ -0,0 +1,16 @@
+# Changelog Header  -------------------------------------------------
+
+header_textfile: changelogs/header.txt
+default_changelog_filename: CHANGELOG.md
+
+# Tag formatting  ---------------------------------------------------
+
+version_prefix: ""
+version_suffix: ""
+date_prefix: ""
+
+# Date formatting  --------------------------------------------------
+
+show_date: true
+date_input_format: "%Y-%m-%d"
+date_output_format: "%Y-%m-%d"

data/lib/fixtures/header.txt

@@ -0,0 +1,4 @@
+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).
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codelog
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Luís Bevilacqua
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -123,7 +123,11 @@ files:
 - lib/codelog/command/step/changelog.rb
 - lib/codelog/command/step/delete.rb
 - lib/codelog/command/step/version.rb
+- lib/codelog/config.rb
+- lib/codelog/message.rb
 - lib/codelog/version.rb
+- lib/fixtures/codelog.yml
+- lib/fixtures/header.txt
 - lib/fixtures/template.yml
 homepage: https://github.com/codus/codelog
 licenses:
@@ -138,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -146,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A gem to help with changelog management