renogen 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f7b33f25cc233f9fe0edee5b01bba4c6cdfb360
-  data.tar.gz: fead7889665a401452166990a0901346992d118d
+  metadata.gz: 441ccac5869c9d78abc7c3d163a851c4341d29b2
+  data.tar.gz: 78e083dde9bba0f04c01c9ce4fe37ac6a3c862b6
 SHA512:
-  metadata.gz: 612f38e5e1eae5cccf380394a9c5903883c04b7b7dc557296a145fb9eed530faa1c869263e91a7024ec2e75cbc0288ed2973b78859d5aec9c3bca3f14fcfbe49
-  data.tar.gz: 70ee850b2a5ca272d256daf6feef1c24960aaf49a24680f3239a1e6823f2369c36f261b39aa73310dbe8df1d3034cc71641f13682d5a6da6bc67c91fe28a8281
+  metadata.gz: c5851785f48aed5505e8b1506c9f5752b6c49c24dca5488110f9a28fdc0d02b33b90c399c3db571beb65d77d908892fdb30f6e8f335bd8b701ec9744f3eb7979
+  data.tar.gz: 96f6024f0e7decc226d44ce9b55d9f746aa3e2a272a0033b82d219558f1396e65207daae4330f40001b23484bc72a0182cdc48b77b237d92595798e8e9a03d25

data/README.md

@@ -2,6 +2,12 @@
 
 Renogen or Re(lease) No(tes) Gen(erator) is a development tool to separate feature notes from product versions.
 
+
+This renogen can not do and will have to be reviewed manually
+- Order the notes in the orrect order (e.g. if a task has to be run before/after something else)
+- Remove Duplicate notes that might be added (e.g. 2 tickets might want to run the same task)
+
+
 ### Installation
 
 To install Renogen, use the following command:
@@ -13,7 +19,8 @@ or add the following to your Gemfile
 `gem 'renogen', :require => false, :group => :development`
 
 `$ renogen init # optional  Creates directory for notes`
-`$ renogen --help # List available options
+
+`$ renogen --help # List available options`
 
 ### Usage
 
@@ -72,6 +79,9 @@ TODO
 * How to set configuration with `.renogen` file
 * How to change formatted single line
 
+### 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.
+
 ### License
 
 Renogen is a programming tool to generate a log of source code changes

data/lib/renogen/cli.rb

@@ -10,13 +10,16 @@ module Renogen
     # @param args [Array]
     def self.run(args)
       return init if args.first == 'init'
+      return new_ticket(args[1]) if args.first == 'new'
+
       param_parser = ParamParser.new(args)
       version, options = param_parser.parse
+      config_instance = Config.instance
 
-      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
+      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)
@@ -29,6 +32,7 @@ module Renogen
 
     # Initialize the current working directory with an example change
     def self.init
+      # TODO Refactor to use Config.instance.changelog_path
       Dir.mkdir('./change_log')
       puts "Created './change_log/'"
 
@@ -57,5 +61,18 @@ module Renogen
       end
       puts "Created '.renogen'"
     end
+
+    # Creates a new template file
+    #
+    # @param ticket_name [String]
+    def self.new_ticket(ticket_name)
+      file_path = File.join(Config.instance.changelog_path, 'next', "#{ticket_name}.yml")
+      File.open(file_path, 'w') do |f|
+        Config.instance.default_headings.each do |h|
+          f.write("#{h}:\n")
+        end
+      end
+      puts "Created '#{file_path}'"
+    end
   end
 end

data/lib/renogen/cli/param_parser.rb

@@ -17,10 +17,14 @@ module Renogen
         args = Hash.new
 
         opt_parser = OptionParser.new do |opts|
-          opts.banner = "Usage: renogen [options] VERSION"
+          opts.banner =  "Usage:"
+          opts.separator "    renogen [options] VERSION"
+          opts.separator "    renogen new TICKET_NAME"
+          opts.separator "    renogen init"
           opts.separator ""
           opts.separator "Required:"
-          opts.separator "  VERSION  this is the version that is currently being required:"
+          opts.separator "  VERSION      this is the version that is currently being required:"
+          opts.separator "  TICKET_NAME  this is the name of the new ticket to be created:"
           opts.separator ""
           opts.separator "Options:"
 
@@ -55,7 +59,7 @@ module Renogen
 
         new_version = options.shift
         if new_version.nil?
-          puts "Error: Missing argument 'VERSION'"
+          puts "Error: Missing argument"
           puts
           puts opt_parser
           exit 1

data/lib/renogen/config.rb

@@ -5,7 +5,7 @@ module Renogen
   # Stores configuratin values to be used by the libary
   class Config
     include Singleton
-    attr_accessor :single_line_format, :input_source, :output_format, :supported_keys, :changelog_path
+    attr_accessor :single_line_format, :input_source, :output_format, :supported_keys, :changelog_path, :default_headings
 
     def initialize
       config_file = load_yaml_config
@@ -13,7 +13,8 @@ module Renogen
       self.supported_keys = config_file['supported_keys'] || ['identifier', 'link', 'summary'].freeze
       self.input_source = config_file['input_source'] || 'yaml'.freeze
       self.output_format = config_file['output_format'] || 'markdown'.freeze
-      self.changelog_path = config_file['changelog_path']
+      self.changelog_path = config_file['changelog_path'] || './change_log'.freeze
+      self.default_headings = config_file['default_headings'] || %w(Summary Detailed Tasks).freeze
     end
 
 

data/lib/renogen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renogen
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Dave Elliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,7 +80,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/DDAZZA/renogen
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Release Notes/changelog Generator