renogen 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 441ccac5869c9d78abc7c3d163a851c4341d29b2
-  data.tar.gz: 78e083dde9bba0f04c01c9ce4fe37ac6a3c862b6
+  metadata.gz: 9c597a603a1ff6629766e2fca60f6970a75bb1e3
+  data.tar.gz: 70ff70d1bcd0fe5fba73dcb6a7a04b3a70652630
 SHA512:
-  metadata.gz: c5851785f48aed5505e8b1506c9f5752b6c49c24dca5488110f9a28fdc0d02b33b90c399c3db571beb65d77d908892fdb30f6e8f335bd8b701ec9744f3eb7979
-  data.tar.gz: 96f6024f0e7decc226d44ce9b55d9f746aa3e2a272a0033b82d219558f1396e65207daae4330f40001b23484bc72a0182cdc48b77b237d92595798e8e9a03d25
+  metadata.gz: 22e630d7505723cf02a2c6c66853c74ae1f98633e0d102cde31061b7dcc8ab1d6bdca9cb22c438f6cb746a8b1ecc5cf295b4fabfa9dff1c49b43e0b7421014ea
+  data.tar.gz: c94d1ae2b66072bbfcdf8d4960fa3f29caf58a0aaabb76a32d4f164e6eae73bff06a0f6040f64aaaab99b685cc82a92909d11f8a40841e1ec642768f60539c72

data/README.md

@@ -79,6 +79,43 @@ TODO
 * How to set configuration with `.renogen` file
 * How to change formatted single line
 
+### Custom formatter
+
+You can use your own formatter quite easily.
+
+For example, put this in `lib/my_project/renogen_formatter.rb`:
+```ruby
+require 'renogen/formatters'
+
+class MyProject::RenogenFormatter < Renogen::Formatters::Base
+  register :xml
+
+  def write_header(header)
+    "<release><header>#{header}</header>"
+  end
+
+  def write_group(group)
+    "<group><title>#{group}</title>"
+  end
+
+  def write_group_end
+    "</group>"
+  end
+
+  def write_change(change)
+    "<change>#{change}</change>"
+  end
+
+  def write_footer(*)
+    "</release>"
+  end
+end
+```
+
+You have to include that file when running renogen:
+
+`$ renogen -I. -Rlib/my_project/renogen_formatter 1.2.3`
+
 ### Why does renogen not use renogen?
 The amount of activity and contributes for this project is small and so it is more practical to use a text file.
 

data/lib/renogen/change_log/model.rb

@@ -5,20 +5,14 @@ module Renogen
     # Object to represent a Changelog/release notes
     class Model
       attr_reader :items
-      attr_accessor :version
+      attr_accessor :version, :date
 
       def initialize(options={})
         @version = options[:version]
+        @date = options[:date] || Date.today
         @items = []
       end
 
-      # The title for the change log output
-      #
-      # @return [String]
-      def header
-        "#{version} (#{Date.today})"
-      end
-
       # @return [Hash<group_name: change>]
       def groups
         items.inject({}) do |hash, change|

data/lib/renogen/change_log/writer.rb

@@ -10,7 +10,7 @@ module Renogen
       #
       # @param changelog [ChangeLog::Model]
       def write!(changelog)
-        puts formatter.write_header(changelog.header)
+        puts formatter.write_header(formatter.header(changelog))
         output_groups(changelog.groups)
         puts formatter.write_footer(changelog)
       end

data/lib/renogen/cli.rb

@@ -20,6 +20,7 @@ module Renogen
       source = options['source'] || config_instance.input_source
       options['changelog_path'] ||= config_instance.changelog_path
       options['old_version'] ||= config_instance.changelog_path
+      options['release_date'] ||= Date.today
 
       begin
         generator = Renogen::Generator.new(version, source, format, options)

data/lib/renogen/cli/param_parser.rb

@@ -44,6 +44,18 @@ module Renogen
             args['legacy_version'] = n
           end
 
+          opts.on("-rDATE", "--release-date=DATE", "Release date") do |n|
+            args['release_date'] = n
+          end
+
+          opts.on("-IPATH", "--include=PATH", "Add a path to the load path") do |n|
+            $LOAD_PATH << n
+          end
+
+          opts.on("-RFILE", "--require=FILE", "Require a file from the load path") do |n|
+            require n
+          end
+
           opts.on_tail("-h", "--help", "Show this message") do
             puts opts
             exit

data/lib/renogen/formatters/base.rb

@@ -13,18 +13,31 @@ module Renogen
         Renogen::Formatters.add(identifier.to_sym, self)
       end
 
+      # Generate a header for a given changelog
+      #
+      # @param changelog [Renogen::ChangeLog::Model]
+      #
+      # return [String]
+      def header(changelog)
+        "#{changelog.version} (#{changelog.date})"
+      end
+
       # Outputs a line or block of text appearing at the top of the change log.
       #
+      # @abstract
+      #
       # @param header [String]
-      # @return [NotImplementedError]
+      # @raise NotImplementedError
       def write_header(header)
         raise NotImplementedError
       end
 
       # Outputs a line or block as a header for a group.
       #
+      # @abstract
+      #
       # @param group [String]
-      # @return [NotImplementedError]
+      # @raise NotImplementedError
       def write_group(group)
         raise NotImplementedError
       end
@@ -37,8 +50,10 @@ module Renogen
 
       # Outputs a line or block as the body for a change.
       #
+      # @abstract
+      #
       # @param change [String]
-      # @return [NotImplementedError]
+      # @raise NotImplementedError
       def write_change(change)
         raise NotImplementedError
       end

data/lib/renogen/generator.rb

@@ -14,6 +14,7 @@ module Renogen
     def generate!
       changelog = extraction_stratagy.extract
       changelog.version = version
+      changelog.date = options['release_date']
 
       writer.write!(changelog)
     end

data/lib/renogen/version.rb

@@ -1,3 +1,3 @@
 module Renogen
-  VERSION='1.1.1'.freeze # :nodoc:
+  VERSION='1.2.0'.freeze # :nodoc:
 end

data/spec/lib/renogen/change_log/model_spec.rb

@@ -14,13 +14,6 @@ describe Renogen::ChangeLog::Model do
     end
   end
 
-  describe '#header' do
-    it 'returns version and date' do
-      subject.version = '123'
-      expect(subject.header).to eql "123 (#{Date.today})"
-    end
-  end
-
   describe '#add_change' do
     it 'adds change to changes store' do
       subject.add_change(change_item)
@@ -33,4 +26,25 @@ describe Renogen::ChangeLog::Model do
     end
   end
 
+  describe '#date' do
+    it 'defaults to Date.today' do
+      expect(subject.date).to eql Date.today
+    end
+
+    it 'can be set using an option' do
+      date = Date.parse('2015-12-25')
+      model_instance = described_class.new(date: date)
+
+      expect(model_instance.date).to eql date
+    end
+
+    it 'has a setter' do
+      date = Date.parse('1981-03-20')
+
+      subject.date = date
+
+      expect(subject.date).to eql date
+    end
+  end
+
 end

data/spec/lib/renogen/formatters/base_spec.rb

@@ -1,6 +1,16 @@
 require 'spec_helper'
 
 describe Renogen::Formatters::Base do
+  describe '#header' do
+    subject { described_class.new.header(changelog) }
+
+    let(:version) { '1.2.34' }
+    let(:date) { Date.today }
+    let(:changelog) { double(Renogen::ChangeLog::Model, version: version, date: date) }
+
+    it { is_expected.to eql "#{version} (#{date})" }
+  end
+
   describe '#write_header' do
     it 'raises an NotImplementedError' do
       expect{subject.write_header('header')}.to raise_error NotImplementedError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renogen
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Dave Elliott
@@ -98,9 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Release Notes/changelog Generator
 test_files: []
-has_rdoc: