logchange 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e6678b4bc69a5cdc2cab8bbc71ad0b43a33854a
-  data.tar.gz: 96c1905246dd6b04c4c99f576dea036514988e45
+  metadata.gz: fbb503711f7f99daa59a349a06ab5cff1181d8b0
+  data.tar.gz: cd98aaf7e2dec7877bcb0319f44f3012faebe9aa
 SHA512:
-  metadata.gz: dca400cee181c2967a63099d8da0a86bcecc94612a4e40f28511e4a9ba24acf83c5a6eeaa4cce5e8f3404498c0a37d054ebc69928a7f1e896650704555fd7394
-  data.tar.gz: 5b45666ee97abb97ff566cb53da6f11b099f1bec94d8da8377ac8b321ee2c2647e7d54973217c6903d2defa30cd7af9c67e3f7a2ac127916676a7d485f3f6e80
+  metadata.gz: 8cbf29f028730e470c8cca827ab6c0b06230e0670e200fda7943f6f42b4014d22339d69d8ec0a52d81c949e9c466af3b0434441b9cff13b8a33636acc3956b17
+  data.tar.gz: 1e2df6b2c579cd13e7972e74b4009cb4c24eab6c530e4a2af2f96bac808fedf23ffd168c18279b07163a82199f55d02978cc4755bc80a93a503221101cf5670e

data/README.md

@@ -1,20 +1,24 @@
 # Logchange
 
+[![Build Status](https://travis-ci.org/harigopal/logchange.svg?branch=master)](https://travis-ci.org/harigopal/logchange)
+
 Logchange is an alternative approach to managing a _changelog_. Instead of writing to a flat `CHANGELOG(.md)`, it logs
-changes to `.yaml` files containing a `timestamp`, the `title`, and a boolean `public`.
+changes to `.yaml` files containing a `timestamp` and a `title`. You can extend this format by adding any number of
+additional fields by specifying a template - allowing customization of the changelog to suit your needs.
 
-Logchange allows for two _release_ changelogs to be maintained - an exhaustive one for internal use, and a public one
- to display to your users. It can _release_ a public and a private changelog with one command, assuming that `public`
- boolean is correctly set (see _Usage_ section).
+Logchange allows you to _release_ changes; this allows you to group changes into versioned releases, or
+timed releases, depending on what your project needs. New entries are kept in `changelog/unreleased` until the `release`
+command is used to append it to `changelog/YEAR.yaml` file.
 
-This repository's _changelog_ is maintained using _logchange_. Since this is a public repository, there are only public
-changes. See the automatically generated `changelog/2017-public.yaml`. Unreleased changes go to `changelog/unreleased`.
+This repository's _changelog_ is maintained using _logchange_. See the automatically generated `changelog/2017.yaml`.
+Unreleased changes go to `changelog/unreleased`.
 
 ## Why?
 
-It's good to let your users know what you're up to, and it's good to keep track of what changed over time. However, you
-don't need to tell your users about every single change - hence the `public` flag. The _YAML_ format just makes it
-easier to parse and _present_ the data on the front-end, while being readable and editable.
+It's good to let your users know what you're up to, and it's good to keep track of what changed over time. If your
+project's code isn't public, it might make sense to include a `private` flag in your template and use that to show only
+a select list of changes to your users and the public. The _YAML_ format allows the changelog to be extended to fit your
+specific requirements. It also makes it easy to parse and _present_ the data on the front-end.
 
 ## Installation
 
@@ -37,29 +41,42 @@ 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`
 
-This will create a new timestamped `.yaml` file in the `changelog` folder. By default, the `public` flag for all changes
-will be set to `true`. You can change this if you want to prevent it from appearing in the release log.
+This will create a new timestamped `.yaml` file in the `changelog/unreleased` folder.
+
+```yaml
+timestamp: 2017-05-21T06:45:08Z
+title: The title for your change goes here.
+```
 
-To alter the default template used, create a `changelog/template.yaml` file, and set custom keys in it:
+To extend the default template used, create a `changelog/template.yaml` file. See customization instructions below.
 
-    # changelog/template.yaml
+To _release_ all new _public_ changes to the flat file, run:
 
-    public: false
-    github_issue: Add a link to related Github issue, or delete this key.
+    $ logchange release [TAG]
 
-If present, this template will be merged into the output.
+This will add all _unreleased_ changes to `changelog/YEAR.yaml`. The current set of changes will be grouped together,
+and the time of release will be recorded. You can optionally specify a _tag_ such as a version number. For example:
 
-To _release_ all new _public_ changes to the flat file, run:
+    $ logchange release v0.1.1
+
+This will group current set of changes and add a `tag` key along with the release `timestamp`.
+
+## Customize the template
+
+Create a `changelog/template.yaml` file to add additional keys for information that you'd like to track in your project.
 
-    $ logchange release [VERSION]
+```yaml
+# There will two keys by default - timestamp and title.
+# You can add any number of additional keys - this depends on your workflow.
+# A few examples are below.
 
-## Change template
+description: >
+  Add more detailed information
+  that spans multiple lines.
 
-    ---
-    timestamp: 2017-05-21T06:45:08Z
-    title: The title for your change goes here. This string gets added to CHANGELOG.md upon release.
-    public: Defaults to 'true'. This means that the release command will add this change to CHANGELOG.md. Set to 'false' to prevent that.
-    additional_key_1: You can add any number of additional keys. Logchange will ignore these when writing CHANGELOG.md. Parsing / using these is up to you.
+github_issue_link: Add link to related Github issue.
+private: Hide this change from the public?
+```
 
 ## Development
 

data/changelog/2017.yaml

@@ -0,0 +1,15 @@
+---
+changelog:
+- timestamp: '2017-05-22T17:26:09Z'
+  tag: v0.0.2
+  changes:
+  - timestamp: '2017-05-22T17:26:00Z'
+    title: Make the release command functional.
+  - timestamp: '2017-05-22T14:51:26Z'
+    title: Remove the public flag from default set of keys.
+  - timestamp: '2017-05-22T14:46:57Z'
+    title: Alpha release of logchange.
+    public: true
+  - timestamp: '2017-05-22T14:46:09Z'
+    title: Added logchange to project.
+    public: false

data/lib/logchange.rb

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

data/lib/logchange/dispatch.rb

@@ -10,7 +10,7 @@ module Logchange
         when :new
           Logchange::Logger.new(ARGV[1]).execute
         when :release
-          Logchange::Release.new.execute
+          Logchange::Release.new(ARGV[1]).execute
         else
           raise "Unhandled command #{command}"
       end

data/lib/logchange/initialize.rb

@@ -10,7 +10,7 @@ module Logchange
         puts 'The changelog directory already exists. Cancelling.'
       else
         FileUtils.mkdir_p(path)
-        Logchange::Logger.new('Added logchange to project.', public: false).execute
+        Logchange::Logger.new('Added logchange to project.').execute
       end
     end
   end

data/lib/logchange/logger.rb

@@ -4,9 +4,8 @@ require 'time'
 module Logchange
   # Logs a new change.
   class Logger
-    def initialize(title, public: true)
+    def initialize(title)
       @title = title
-      @public = public
     end
 
     def execute
@@ -20,14 +19,13 @@ module Logchange
     def log_contents
       YAML.dump({
         'timestamp' => Time.now.utc.iso8601,
-        'title' => @title,
-        'public' => @public
+        'title' => @title
       }.merge(template))
     end
 
     def template
       template_path = File.join(Logchange.configuration.changelog_directory_path, 'template.yaml')
-      return {} unless File.exists?(template_path)
+      return {} unless File.exist?(template_path)
       YAML.load(File.read(template_path))
     end
 

data/lib/logchange/release.rb

@@ -1,12 +1,65 @@
-require 'fileutils'
 require 'yaml'
-require 'time'
+require 'fileutils'
 
 module Logchange
   # Releases new changes to a markdown log.
   class Release
+    def initialize(tag)
+      @tag = tag
+    end
+
     def execute
-      raise 'This is a TODO!'
+      return if no_unreleased_changes?
+
+      release_list = { 'timestamp' => Time.now.utc.iso8601 }
+      release_list['tag'] = @tag unless @tag.nil?
+
+      release_list['changes'] = unreleased_changelogs.map do |changelog_path|
+        YAML.safe_load(File.read(changelog_path))
+      end
+
+      # Sort the list of changes by timestamp, in reverse.
+      release_list['changes'] = release_list['changes'].sort_by do |changelog|
+        Time.parse(changelog['timestamp'])
+      end.reverse
+
+      update_release_file(release_list)
+
+      # Delete changelogs from unreleased directory.
+      unreleased_changelogs.each { |changelog_path| FileUtils.rm(changelog_path) }
+    end
+
+    private
+
+    def update_release_file(release)
+      existing_release = if File.exist?(release_path)
+        YAML.safe_load(File.read(release_path))
+      else
+        { 'changelog' => [] }
+      end
+
+      # Add latest release to the top of existing release's changelog.
+      existing_release['changelog'] = [release] + existing_release['changelog']
+
+      # Now write updated release back.
+      File.write(release_path, YAML.dump(existing_release))
+
+      puts "Released changes to #{release_path}."
+    end
+
+    def release_path
+      filename = "#{Time.now.utc.year}.yaml"
+      File.join(Logchange.configuration.changelog_directory_path, filename)
+    end
+
+    def no_unreleased_changes?
+      return false if unreleased_changelogs.any?
+      puts 'There are no unreleased changes.'
+      true
+    end
+
+    def unreleased_changelogs
+      @unreleased_changelogs ||= Dir[File.join(Logchange.configuration.changelog_directory_path, 'unreleased', '*.yaml')]
     end
   end
 end

data/lib/logchange/version.rb

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

data/logchange.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   end
 
   spec.required_ruby_version = '>= 2.2.0'
-  spec.bindir                = 'exe'
-  spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths         = ['lib']
 
+  spec.executables << 'logchange'
+
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logchange
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Hari Gopal
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,7 +69,8 @@ dependencies:
 description: Logs changes to individual YAML files and offers a release mechanism.
 email:
 - mail@harigopal.in
-executables: []
+executables:
+- logchange
 extensions: []
 extra_rdoc_files: []
 files:
@@ -82,6 +83,7 @@ files:
 - Rakefile
 - bin/console
 - bin/logchange
+- changelog/2017.yaml
 - lib/logchange.rb
 - lib/logchange/configuration.rb
 - lib/logchange/dispatch.rb