logchange 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbb503711f7f99daa59a349a06ab5cff1181d8b0
-  data.tar.gz: cd98aaf7e2dec7877bcb0319f44f3012faebe9aa
+  metadata.gz: 597a7cbd6d976eb5570297e794b945a45335cd7c
+  data.tar.gz: a2ba139b4f28bc53c3605359a11b945709dae056
 SHA512:
-  metadata.gz: 8cbf29f028730e470c8cca827ab6c0b06230e0670e200fda7943f6f42b4014d22339d69d8ec0a52d81c949e9c466af3b0434441b9cff13b8a33636acc3956b17
-  data.tar.gz: 1e2df6b2c579cd13e7972e74b4009cb4c24eab6c530e4a2af2f96bac808fedf23ffd168c18279b07163a82199f55d02978cc4755bc80a93a503221101cf5670e
+  metadata.gz: dc2d8ced37426c7d2a3934b83086f8e3ccd276aaf1af4873f7ce7934d3c91c2aeecec5c91136fec89f353b68540f743b31259b77b45b7b25306d21d37c8c22c1
+  data.tar.gz: b818cd56ed32b2b68c94550fcebbc42edaa5e7ac8d24ac28c3b0b4b410765b92721438012a711e2bc5570d6090eae80d7b77d39cd82ab9c4b3e26f972bd8a404

data/README.md

@@ -11,7 +11,7 @@ timed releases, depending on what your project needs. New entries are kept in `c
 command is used to append it to `changelog/YEAR.yaml` file.
 
 This repository's _changelog_ is maintained using _logchange_. See the automatically generated `changelog/2017.yaml`.
-Unreleased changes go to `changelog/unreleased`.
+Unreleased changes (if any) go to `changelog/unreleased`.
 
 ## Why?
 
@@ -39,7 +39,7 @@ Or install the gem with:
 If you've just completed work on a feature, log it with:
 
     $ logchange new "A cool new feature has been added"
-    Created [..]/changelog/unreleased/20170521-a-cool-new-feature-has-been-added.yml`
+    Created [..]/changelog/unreleased/20170521-a-cool-new-feature-has-been-added.yml
 
 This will create a new timestamped `.yaml` file in the `changelog/unreleased` folder.
 
@@ -48,7 +48,7 @@ timestamp: 2017-05-21T06:45:08Z
 title: The title for your change goes here.
 ```
 
-To extend the default template used, create a `changelog/template.yaml` file. See customization instructions below.
+To extend the default template used, create `changelog/template.yaml`. See customization instructions below.
 
 To _release_ all new _public_ changes to the flat file, run:
 
@@ -61,7 +61,7 @@ and the time of release will be recorded. You can optionally specify a _tag_ suc
 
 This will group current set of changes and add a `tag` key along with the release `timestamp`.
 
-## Customize the template
+### Customize the template
 
 Create a `changelog/template.yaml` file to add additional keys for information that you'd like to track in your project.
 
@@ -70,14 +70,27 @@ Create a `changelog/template.yaml` file to add additional keys for information t
 # You can add any number of additional keys - this depends on your workflow.
 # A few examples are below.
 
-description: >
-  Add more detailed information
-  that spans multiple lines.
-
+description: Add more detailed information about the change?
 github_issue_link: Add link to related Github issue.
-private: Hide this change from the public?
+private: Hide this change from the public? Set to true or false.
 ```
 
+### Interactive mode
+
+If the template is customized, you can use Logchange's interactive mode to supply required data, instead of passing it
+directly via the command:
+
+    $ logchange new
+    title: A cool new feature has been added.
+
+    github_issue_link: Add link to related Github issue.
+    https://github.com/harigopal/logchange/issues/1
+
+    private: Hide this change from the public? Set to true or false.
+    false
+
+    Created [..]/changelog/unreleased/20170521-a-cool-new-feature-has-been-added.yml
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/changelog/2017.yaml

@@ -1,5 +1,10 @@
 ---
 changelog:
+- timestamp: '2017-05-23T15:42:28Z'
+  tag: v0.0.3
+  changes:
+  - timestamp: '2017-05-23T15:42:04Z'
+    title: Add the ability to interactively accept user input to form changelog.
 - timestamp: '2017-05-22T17:26:09Z'
   tag: v0.0.2
   changes:

data/lib/logchange.rb

@@ -3,6 +3,7 @@ require 'logchange/configuration'
 require 'logchange/dispatch'
 require 'logchange/initialize'
 require 'logchange/logger'
+require 'logchange/interactive_logger'
 require 'logchange/release'
 
 module Logchange

data/lib/logchange/dispatch.rb

@@ -8,7 +8,11 @@ module Logchange
         when :init
           Logchange::Initialize.new.execute
         when :new
-          Logchange::Logger.new(ARGV[1]).execute
+          if ARGV[1].nil?
+            Logchange::InteractiveLogger.new.execute
+          else
+            Logchange::Logger.new(ARGV[1]).execute
+          end
         when :release
           Logchange::Release.new(ARGV[1]).execute
         else

data/lib/logchange/interactive_logger.rb

@@ -0,0 +1,49 @@
+require_relative 'template'
+
+module Logchange
+  class InteractiveLogger
+    def initialize
+      @title = nil
+      @template = {}
+    end
+
+    def execute
+      input_title
+
+      template = Logchange::Template.load
+
+      template.each do |key, value|
+        input(key, value)
+      end
+
+      Logchange::Logger.new(@title, template: @template).execute
+    end
+
+    private
+
+    def input_title
+      while @title.nil?
+        print 'title: '
+        @title = STDIN.gets.chomp
+
+        if @title.length.zero?
+          puts "Title cannot be blank.\n\n"
+          @title = nil
+        end
+      end
+    end
+
+    def input(key, value)
+      puts "#{key}: #{value}"
+      user_input = STDIN.gets.chomp
+
+      # Preserve booleans.
+      if %w[true false].include?(user_input)
+        user_input = (user_input == 'true')
+      end
+
+      @template[key] = user_input
+      puts "\n"
+    end
+  end
+end

data/lib/logchange/logger.rb

@@ -1,11 +1,14 @@
 require 'yaml'
 require 'time'
 
+require_relative 'template'
+
 module Logchange
   # Logs a new change.
   class Logger
-    def initialize(title)
+    def initialize(title, template: Logchange::Template.load)
       @title = title
+      @template = template
     end
 
     def execute
@@ -20,13 +23,7 @@ module Logchange
       YAML.dump({
         'timestamp' => Time.now.utc.iso8601,
         'title' => @title
-      }.merge(template))
-    end
-
-    def template
-      template_path = File.join(Logchange.configuration.changelog_directory_path, 'template.yaml')
-      return {} unless File.exist?(template_path)
-      YAML.load(File.read(template_path))
+      }.merge(@template))
     end
 
     def filename

data/lib/logchange/template.rb

@@ -0,0 +1,9 @@
+module Logchange
+  class Template
+    def self.load
+      template_path = File.join(Logchange.configuration.changelog_directory_path, 'template.yaml')
+      return {} unless File.exist?(template_path)
+      YAML.load(File.read(template_path))
+    end
+  end
+end

data/lib/logchange/version.rb

@@ -1,3 +1,3 @@
 module Logchange
-  VERSION = -'0.0.2'
+  VERSION = -'0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logchange
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Hari Gopal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,8 +88,10 @@ files:
 - lib/logchange/configuration.rb
 - lib/logchange/dispatch.rb
 - lib/logchange/initialize.rb
+- lib/logchange/interactive_logger.rb
 - lib/logchange/logger.rb
 - lib/logchange/release.rb
+- lib/logchange/template.rb
 - lib/logchange/version.rb
 - logchange.gemspec
 homepage: https://github.com/harigopal/logchange