logchange 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3639284d0fbc24f5c248a7f623e0e65f02ac5a4
-  data.tar.gz: 2634fa773942e93ef1f6ce199b75ca27e67455aa
+  metadata.gz: a3505d84792e31b47a707c42510c1e7a578e0606
+  data.tar.gz: 6cf762f74375bdc467cd1e37421747653f223f86
 SHA512:
-  metadata.gz: '0823e3b1882608189638c26b018097f28fd106c93d0cacc6d3a496ad43846ac4c66741dbca55e82ccfccad1fd1663f16a71797c896fd63372cc5fcff08e24bec'
-  data.tar.gz: 89d644f3e5d5d5dea27e65c5b1b0dc978dcd93a4fe3604c890156f9a31c6d3112dedbeafdce8f3a59cee6e47e729dbf84012120d8f96bf916aeda7c95431b52c
+  metadata.gz: 7598192ca0df05fad8438df4cb7798f08bf9b584dddfe5ac7efb511ed692712b19002c77ec27289d86bff6dc25c58ec753c979af2126c1c5b8fd1ccc9a57f9be
+  data.tar.gz: cc428dd302ac30725dfb2b8b07e54f3b9cb9e3bc50f70e12f6641320b924abd388b22fa6c1ae09a19572afb73c7d578b688c85ab9452bc36620dea922430a52a

data/README.md

@@ -36,6 +36,17 @@ Or install the gem with:
 
 ## Usage
 
+    $ logchange
+    Usage: logchange COMMAND
+
+    Available commands:
+      init          - Initialize logchange at this location - creates
+                      the changelog directory.
+      new [MESSAGE] - Log a change. Skip the message to trigger
+                      interative mode.
+      release [TAG] - Releases changes in changelog/unreleased.
+                      Optionally, tag the release with a string.
+
 If you've just completed work on a feature, log it with:
 
     $ logchange new "A cool new feature has been added"

data/changelog/2017.yaml

@@ -1,5 +1,12 @@
 ---
 changelog:
+- timestamp: '2017-05-30T14:38:40Z'
+  tag: v1.0.0
+  changes:
+  - timestamp: '2017-05-30T14:27:25Z'
+    title: Print help if no command, or invalid command is supplied.
+  - timestamp: '2017-05-30T14:25:34Z'
+    title: Exclude empty keys from changelog if skipped during interactive mode.
 - timestamp: '2017-05-24T05:44:58Z'
   tag: v0.0.4
   changes:

data/lib/logchange/dispatch.rb

@@ -16,7 +16,7 @@ module Logchange
         when :release
           Logchange::Release.new(ARGV[1]).execute
         else
-          raise "Unhandled command #{command}"
+          print_help
       end
     end
 
@@ -29,13 +29,22 @@ module Logchange
     end
 
     def command
-      return ARGV[0].to_sym if %w[init new release preview].include?(ARGV[0])
-      print_help
+      return ARGV[0].to_sym if %w[init new release].include?(ARGV[0])
+      :unknown
     end
 
     def print_help
-      # TODO: Write actual help response.
-      raise 'Unknown command encountered.'
+      puts <<~HELP
+        Usage: logchange COMMAND
+
+        Available commands:
+          init          - Initialize logchange at this location - creates
+                          the changelog directory.
+          new [MESSAGE] - Log a change. Skip the message to trigger
+                          interative mode.
+          release [TAG] - Releases changes in changelog/unreleased.
+                          Optionally, tag the release with a string.
+      HELP
     end
   end
 end

data/lib/logchange/interactive_logger.rb

@@ -1,6 +1,7 @@
 require_relative 'template'
 
 module Logchange
+  # Accept change information from the user via command line prompts.
   class InteractiveLogger
     def initialize
       @title = nil
@@ -37,12 +38,15 @@ module Logchange
       puts "#{key}: #{value}"
       user_input = STDIN.gets.chomp
 
-      # Preserve booleans.
-      if %w[true false].include?(user_input)
-        user_input = (user_input == 'true')
+      if user_input.length.positive?
+        # Preserve booleans.
+        if %w[true false].include?(user_input)
+          user_input = (user_input == 'true')
+        end
+
+        @template[key] = user_input
       end
 
-      @template[key] = user_input
       puts "\n"
     end
   end

data/lib/logchange/template.rb

@@ -1,4 +1,5 @@
 module Logchange
+  # Properties of the template used to customize changelogs.
   class Template
     def self.load
       template_path = File.join(Logchange.configuration.changelog_directory_path, 'template.yaml')

data/lib/logchange/version.rb

@@ -1,3 +1,4 @@
 module Logchange
-  VERSION = -'0.0.4'
+  # Semantic Versioning. http://semver.org
+  VERSION = -'1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logchange
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Hari Gopal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler