renogen 0.0.1 → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ef84185ab75ecceb4964734171fed296586caa
-  data.tar.gz: 5447620ffba6edc1c577890701139dda06a8ff28
+  metadata.gz: 0601d545b81d975fb00732f998a904c07abf2604
+  data.tar.gz: d635d1c62edc949f38db2b03a42a48098d48fc8d
 SHA512:
-  metadata.gz: da0ae862b3579bdc075a6eb8e1ffc6f7096bd9590e796fda0f43ec2af3b43f6d96b0cc05438177d974cae115083f40ba42565e1c92fa42c341c69c7aa688fde8
-  data.tar.gz: 804100ae3da88c1f9df7824bbda68504c137ae8da62eef498b172e6c5b592d3300ee427511554f6dcb3c99ce01185bffbafe639683ab442772ae8eff5a6bb998
+  metadata.gz: d0c5ece883782914cdb6bc731cfcc368d63bab3c250396cfa36bbbee7e65b774ef253199579e90fe126fb2fe9e3e669d746281f0e4e0e0b2f6423857d2dd8c0f
+  data.tar.gz: 8c2f2eb12331c3dd664066202aafe1e60545b37945e7a2ba7130a30109ad0832246f206ebebc3445f194858089e7dc1fecb8c8e27ce4386bf5f52cbf340923d5

data/README.md

@@ -1,12 +1,71 @@
-# ReNoGen
+# Renogen
 
-Re(lease) No(tes) Gen(ortor) is a tool designed to compile RELEASE_NOTES or
-a CHANGELOG from a chosen source into a chosen format
+Renogen or Re(lease) No(tes) Gen(erator) is a tool to separate feature notes from product versions.
 
 ### Installation
 
+To install Renogen, use the following command:
+
+`$ gem install renogen`
+
+or add the following to your Gemfile
+
+`gem 'renogen', :require => false, :group => :development`
+
+`$ renogen init # optional  creates directory for notes`
+`$ renogen --help # list available command options
+
 ### Usage
 
+To generate your notes run the following command
+
+`$ renogen <VERSION> # e.g v1.2.1`
+
+Unfortunatly renogen cant write documentation for your change.
+By default renogen uses the yaml file stratagy to extract your notes
+
+#### Adding YAML feature notes
+
+Create a file within the next version folder(default:'change_log/next/')
+
+Example feature note
+```
+# change_log/next/example.yml
+MyFormattedSingleLine:
+  identifier: bug_1
+  link: example.com/bug_1
+  summary: fixes all issues
+
+MyMultiLineNote: |
+  Title
+
+  description
+
+  Example of usage
+    $ foo bar baz
+MyList:
+  - e.g. run this command
+  - e.g. run this as well
+```
+
+#### Examples
+
+Prepend your notes to a changelog file(TODO make command simple)
+`$ renogen --format markdown v1.2.1 > CHANGELOG.md | cat - CHANGELOG > CHANGELOG.tmp && mv CHANGELOG.tmp CHANGELOG`
+
+Writes notes to html file
+`$ renogen --format html v1.2.1 > v1_2_1.html
+
+Print all notes since v1.0.0 as text
+`$ renogen --format text -l v1.0.0 v1.2.1
+
+### Configuration
+
+TODO 
+`.renogen` file
+single line format
+change log directory
+
 ### License
 
 Renogen is a programming tool to generate a log of source code changes

data/bin/renogen

@@ -1,61 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'renogen'
-require 'optparse'
+require 'renogen/cli'
 
-class Parser
-  def self.parse(options)
-    args = Hash.new
-
-    opt_parser = OptionParser.new do |opts|
-
-      opts.banner = "Usage: renogen [options] VERSION"
-
-      opts.separator ""
-      opts.separator "Required:"
-      opts.separator "  VERSION  this is the version that is currently being required:"
-
-      opts.separator ""
-      opts.separator "Optional:"
-
-      opts.on("-fFORMAT", "--format=FORMAT", "Output format to be generated") do |n|
-        args['format'] = n
-      end
-
-      opts.on("-sSOURCE", "--source=SOURCE", "Type of source that changes will be extracted from") do |n|
-        args['source'] = n
-      end
-
-      opts.on_tail("-h", "--help", "Show this message") do
-        puts opts
-        exit
-      end
-
-      opts.on_tail("--version", "Show renogen version") do
-        puts Renogen::VERSION
-        exit
-      end
-    end
-
-    opt_parser.parse!(options)
-
-    args['new_version'] = options.shift
-    if args['new_version'].nil?
-      puts "Missing argument: VERSION"
-      puts
-      puts opt_parser
-      exit 1
-    elsif options.count > 0
-      puts "Unknown arguments: #{options}"
-      puts
-      puts opt_parser
-      exit 1
-    end
-
-    return args
-  end
-end
-
-options = Parser.parse(ARGV)
-
-Renogen.generate(options)
+Renogen::Cli.run(ARGV)

data/lib/renogen.rb

@@ -0,0 +1,9 @@
+module Renogen
+  require 'renogen/version'
+  require 'renogen/exceptions'
+  require 'renogen/formatters'
+  require 'renogen/extraction_stratagies'
+  require 'renogen/change_log'
+  require 'renogen/generator'
+  require 'renogen/config'
+end

data/lib/renogen/change_log.rb

@@ -0,0 +1,9 @@
+module Renogen
+  # Components to represent a change log
+  module ChangeLog
+    require 'renogen/change_log/item'
+    require 'renogen/change_log/group'
+    require 'renogen/change_log/writer'
+    require 'renogen/change_log/model'
+  end
+end

data/lib/renogen/change_log/group.rb

@@ -0,0 +1,21 @@
+module Renogen
+  module ChangeLog
+    # Object to represent a group of changes
+    class Group
+      attr_reader :name, :changes
+
+      def initialize(group_name, options={})
+        @name = group_name
+        @changes ||= []
+      end
+
+      # Add change to the groups change list
+      #
+      # @param new_change [ChangeLog::Item]
+      def add(new_change)
+        @changes << new_change
+      end
+
+    end
+  end
+end

data/lib/renogen/change_log/item.rb

@@ -0,0 +1,60 @@
+module Renogen
+  module ChangeLog
+    # Object to represent single change item
+    class Item
+      attr_accessor :change
+      attr_reader :group_name
+
+      def initialize(group_name, change, options={})
+        @group_name = group_name
+        @change = change
+      end
+
+      # @return [String]
+      def to_s
+        case change.class.to_s
+        when String.to_s
+          format_multiline(change)
+        when Hash.to_s
+          format_oneline(change)
+        when Array.to_s
+          # TODO should return a string
+          change
+        else
+          raise TypeError
+        end
+      end
+
+      # @return [Boolean] true if change is of type array
+      def list?
+        change.is_a? Array
+      end
+
+      def each
+        change.each do |item|
+          yield item.to_s
+        end
+      end
+
+      private
+
+      def format_multiline(change)
+        change.gsub('\n', '\n \n ') + "\n"
+      end
+
+      def format_oneline(change)
+        # TODO Refactor
+        string = config.single_line_format.downcase.gsub('\n', '\n  ')
+        config.supported_keys.each do |key|
+          string = string.gsub(key, '#{change[\'' + key + '\']}')
+        end
+        ss = "\"#{string}\""
+        eval(ss)
+      end
+
+      def config
+        Config.instance
+      end
+    end
+  end
+end

data/lib/renogen/change_log/model.rb

@@ -0,0 +1,41 @@
+require 'date'
+
+module Renogen
+  module ChangeLog
+    # Object to represent a Changelog/release notes
+    class Model
+      attr_reader :items
+      attr_accessor :version
+
+      def initialize(options={})
+        @version = options[:version]
+        @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|
+          hash[change.group_name] ||= []
+          hash[change.group_name] << change
+          hash
+        end
+      end
+
+      # Adds a change to the changelog
+      #
+      # @param change [Renogen::ChangeLog::Item]
+      # @return [Array] All changes
+      def add_change(change)
+        raise TypeError unless change.is_a?(Renogen::ChangeLog::Item)
+        items << change
+      end
+    end
+  end
+end

data/lib/renogen/change_log/writer.rb

@@ -0,0 +1,39 @@
+module Renogen
+  module ChangeLog
+    # Writes out the change log
+    class Writer
+      def initialize(formatter)
+        @formatter = formatter
+      end
+
+      # Writes out the change log
+      #
+      # @param changelog [ChangeLog::Model]
+      def write!(changelog)
+        puts formatter.write_header(changelog.header)
+        output_groups(changelog.groups)
+        puts formatter.write_footer(changelog)
+      end
+
+      protected
+
+      attr_reader :formatter
+
+      def output_change(change)
+        if change.list?
+          change.each { |item| puts formatter.write_change(item) }
+        else
+          puts formatter.write_change(change.to_s)
+        end
+      end
+
+      def output_groups(groups)
+        groups.each do |group, changes|
+          puts formatter.write_group(group)
+          changes.each { |change| output_change(change) }
+          puts formatter.write_group_end
+        end
+      end
+    end
+  end
+end

data/lib/renogen/cli.rb

@@ -0,0 +1,60 @@
+require 'renogen'
+
+module Renogen
+  # Command line interface helpers
+  module Cli
+    require 'renogen/cli/param_parser'
+
+    # Execute the program via command line
+    # Renogen exceptions will be rescued and printed
+    # @param args [Array]
+    def self.run(args)
+      return init if args.first == 'init'
+      param_parser = ParamParser.new(args)
+      version, options = param_parser.parse
+
+      format = options['format'] || Config.instance.output_format
+      source = options['source'] || Config.instance.input_source
+      options['changelog_path'] ||= Config.instance.changelog_path
+      options['old_version'] ||= Config.instance.changelog_path
+
+      begin
+        generator = Renogen::Generator.new(version, source, format, options)
+        generator.generate!
+      rescue Renogen::Exceptions::Base => e
+        puts e.message
+      end
+    end
+
+    # Initialize the current working directory with example change
+    def self.init
+      Dir.mkdir('./change_log')
+      puts "Created './change_log/'"
+
+      Dir.mkdir('./change_log/next')
+      puts "Created './change_log/next/'"
+
+      File.open("./change_log/next/added_renogen_gem.yml", 'w') do |f|
+        f.write("Summary:\n")
+        f.write("  identifier: renogen\n")
+        f.write("  link: https://github.com/DDAZZA/renogen\n")
+        f.write("  summary: Added ReNoGen gem\n")
+        f.write("\n")
+        f.write("Detailed: |\n")
+        f.write("  Added ReNoGen gem\n")
+        f.write("\n")
+        f.write("  Allows release notes to be generated\n")
+        f.write("\n")
+        f.write("Tasks:\n")
+        f.write("  - $ renogen vX.Y.Z > release_vX_Y_Z.md\n")
+      end
+
+      puts "Created './change_log/next/added_renogen_gem.yml'"
+
+      File.open(".renogen", 'w') do |f|
+        f.write("changelog_path: './change_log/'\n")
+      end
+      puts "Created '.renogen'"
+    end
+  end
+end

data/lib/renogen/cli/param_parser.rb

@@ -0,0 +1,73 @@
+require 'optparse'
+
+module Renogen
+  module Cli
+    # Extracts options and version from argument list
+    class ParamParser
+      attr_accessor :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      # Extracts options and version from argument list
+      #
+      # @return [Hash] options
+      def parse
+        args = Hash.new
+
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = "Usage: renogen [options] VERSION"
+          opts.separator ""
+          opts.separator "Required:"
+          opts.separator "  VERSION  this is the version that is currently being required:"
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on("-fFORMAT", "--format=FORMAT", "Output format to be generated") do |n|
+            args['format'] = n
+          end
+
+          opts.on("-sSOURCE", "--source=SOURCE", "Type of source that changes will be extracted from") do |n|
+            args['source'] = n
+          end
+
+          opts.on("-pPATH", "--path=PATH", "Path to changelog files") do |n|
+            args['changelog_path'] = n
+          end
+
+          opts.on("-lVERSION", "--legacy=VERSION", "Used to collate all changes since") do |n|
+            args['legacy_version'] = n
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+
+          opts.on_tail("--version", "Show renogen version") do
+            puts Renogen::VERSION
+            exit
+          end
+        end
+
+        opt_parser.parse!(options)
+
+        new_version = options.shift
+        if new_version.nil?
+          puts "Missing argument: VERSION"
+          puts
+          puts opt_parser
+          exit 1
+        elsif options.count > 0
+          puts "Unknown arguments: #{options}"
+          puts
+          puts opt_parser
+          exit 1
+        end
+
+        return new_version, args
+      end
+    end
+  end
+end