renogen 0.1.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0601d545b81d975fb00732f998a904c07abf2604
-  data.tar.gz: d635d1c62edc949f38db2b03a42a48098d48fc8d
+  metadata.gz: 169e26c4cd97a2fb31a22eada063fca3a25a57cf
+  data.tar.gz: 5200eff043775217ae1cc7d5e91ec704570346a7
 SHA512:
-  metadata.gz: d0c5ece883782914cdb6bc731cfcc368d63bab3c250396cfa36bbbee7e65b774ef253199579e90fe126fb2fe9e3e669d746281f0e4e0e0b2f6423857d2dd8c0f
-  data.tar.gz: 8c2f2eb12331c3dd664066202aafe1e60545b37945e7a2ba7130a30109ad0832246f206ebebc3445f194858089e7dc1fecb8c8e27ce4386bf5f52cbf340923d5
+  metadata.gz: 3b52c38810a2b055fa83fe9ece7203b3ba9fd9360c0fefd49ca4e7fdd89d7691b899a7bb652367368ff6086974dc0e4b2038405923878a736c9e5b448519c87e
+  data.tar.gz: a5e624d7fffa82c23fd4413ae76a1053133034e2c0b837664b71f2c5e3d0ce0972865ada62346885be4c23183050c12fd923d0f5d1228ed3c7a482c56d79037d

data/README.md

@@ -1,6 +1,6 @@
 # Renogen
 
-Renogen or Re(lease) No(tes) Gen(erator) is a tool to separate feature notes from product versions.
+Renogen or Re(lease) No(tes) Gen(erator) is a development tool to separate feature notes from product versions.
 
 ### Installation
 
@@ -12,8 +12,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 command options
+`$ renogen init # optional  Creates directory for notes`
+`$ renogen --help # List available options
 
 ### Usage
 
@@ -24,51 +24,58 @@ To generate your notes run the following command
 Unfortunatly renogen cant write documentation for your change.
 By default renogen uses the yaml file stratagy to extract your notes
 
+`$ renogen --help # list available command options`
+
 #### Adding YAML feature notes
 
-Create a file within the next version folder(default:'change_log/next/')
+Create a new file within the 'next' version folder(default:'change_log/next/')
 
 Example feature note
-```
+```yaml
 # change_log/next/example.yml
-MyFormattedSingleLine:
+my_formatted_single_line:
   identifier: bug_1
   link: example.com/bug_1
   summary: fixes all issues
 
-MyMultiLineNote: |
+unformatted_single_line: "This is an unformatted single line"
+
+my_multiline_note: |
   Title
 
   description
 
   Example of usage
     $ foo bar baz
-MyList:
+my_list:
   - e.g. run this command
   - e.g. run this as well
 ```
 
-#### Examples
+#### Usage 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
+
+`$ 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
+
+`$ renogen --format text -l v1.0.0 v1.2.1`
 
 ### Configuration
 
-TODO 
-`.renogen` file
-single line format
-change log directory
+TODO
+* How to set configuration with `.renogen` file
+* How to change formatted single line
 
 ### License
 
 Renogen is a programming tool to generate a log of source code changes
+
 Copyright (C) 2015 David Elliott
 
 This program is free software; you can redistribute it and/or modify

data/lib/renogen.rb

@@ -1,3 +1,6 @@
+# Renogen is a development tool.
+# It makes it easier and faster to produce changelogs and release notes
+# It works by stopping merge confics and decouping the change notes from releaes versions
 module Renogen
   require 'renogen/version'
   require 'renogen/exceptions'

data/lib/renogen/change_log.rb

@@ -1,9 +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'
+    require_relative 'change_log/item'
+    require_relative 'change_log/group'
+    require_relative 'change_log/writer'
+    require_relative 'change_log/model'
   end
 end

data/lib/renogen/change_log/item.rb

@@ -10,6 +10,8 @@ module Renogen
         @change = change
       end
 
+      # Coverts the item into its string representation
+      #
       # @return [String]
       def to_s
         case change.class.to_s
@@ -18,8 +20,7 @@ module Renogen
         when Hash.to_s
           format_oneline(change)
         when Array.to_s
-          # TODO should return a string
-          change
+          format_array(change)
         else
           raise TypeError
         end
@@ -30,6 +31,7 @@ module Renogen
         change.is_a? Array
       end
 
+      # Iterater for each item within the change
       def each
         change.each do |item|
           yield item.to_s
@@ -42,6 +44,11 @@ module Renogen
         change.gsub('\n', '\n \n ') + "\n"
       end
 
+      def format_array(change)
+        # TODO should return a string
+        change
+      end
+
       def format_oneline(change)
         # TODO Refactor
         string = config.single_line_format.downcase.gsub('\n', '\n  ')

data/lib/renogen/cli.rb

@@ -23,10 +23,11 @@ module Renogen
         generator.generate!
       rescue Renogen::Exceptions::Base => e
         puts e.message
+        exit -1
       end
     end
 
-    # Initialize the current working directory with example change
+    # Initialize the current working directory with an example change
     def self.init
       Dir.mkdir('./change_log')
       puts "Created './change_log/'"

data/lib/renogen/cli/param_parser.rb

@@ -55,12 +55,12 @@ module Renogen
 
         new_version = options.shift
         if new_version.nil?
-          puts "Missing argument: VERSION"
+          puts "Error: Missing argument 'VERSION'"
           puts
           puts opt_parser
           exit 1
         elsif options.count > 0
-          puts "Unknown arguments: #{options}"
+          puts "Error: Unknown arguments: #{options}"
           puts
           puts opt_parser
           exit 1

data/lib/renogen/config.rb

@@ -7,7 +7,6 @@ module Renogen
     include Singleton
     attr_accessor :single_line_format, :input_source, :output_format, :supported_keys, :changelog_path
 
-
     def initialize
       config_file = load_yaml_config
       self.single_line_format = config_file['single_line_format'] || 'summary (see link)'.freeze
@@ -17,6 +16,9 @@ module Renogen
       self.changelog_path = config_file['changelog_path']
     end
 
+
+    # Renogen configuration extension
+    # a block can be provided to programatily setup configuration values
     def self.configure
       yield instance
     end

data/lib/renogen/exceptions.rb

@@ -1,8 +1,7 @@
 module Renogen
-  # Custom exceptions
+  # Custom exceptions throw by the libary
   module Exceptions
-    require 'renogen/exceptions/base'
-    require 'renogen/exceptions/extraction_stratagy_not_found'
-    require 'renogen/exceptions/formatter_not_found'
+    require_relative 'exceptions/base'
+    require_relative 'exceptions/stratagy_not_found'
   end
 end

data/lib/renogen/exceptions/{extraction_stratagy_not_found.rb → stratagy_not_found.rb}

@@ -1,7 +1,7 @@
 module Renogen
   module Exceptions
     # Raised when an extraction stratagy for a given key can not be found
-    class ExtractionStratagyNotFound < Base
+    class StratagyNotFound < Base
       attr_reader :missing_stratagy
 
       def initialize(type)
@@ -13,7 +13,7 @@ module Renogen
       #
       # @return [String]
       def message
-        "Error: Unsupported source type '#{missing_stratagy}'"
+        "Error: Stratagy type '#{missing_stratagy}' not found"
       end
     end
   end

data/lib/renogen/extraction_stratagies.rb

@@ -1,5 +1,5 @@
 module Renogen
-  # Contains methods for extracting release notes
+  # Methods for extracting release notes
   module ExtractionStratagies
 
     class << self
@@ -14,7 +14,7 @@ module Renogen
         if stratagy
           stratagy.new(options)
         else
-          raise Renogen::Exceptions::ExtractionStratagyNotFound.new(stratagy_type)
+          raise Renogen::Exceptions::StratagyNotFound.new(stratagy_type)
         end
       end
 
@@ -34,8 +34,8 @@ module Renogen
       end
     end
 
-    require'renogen/extraction_stratagies/base'
-    require'renogen/extraction_stratagies/yaml_file'
+    require_relative 'extraction_stratagies/base'
+    require_relative 'extraction_stratagies/yaml_file'
     # require_relative 'extraction_stratagies/github'
     # require_relative 'extraction_stratagies/gitlog'
   end

data/lib/renogen/extraction_stratagies/yaml_file.rb

@@ -2,9 +2,10 @@ module Renogen
   module ExtractionStratagies
     # module for extracting changes from YAML files
     module YamlFile
-      require 'renogen/extraction_stratagies/yaml_file/reader'
-      require 'renogen/extraction_stratagies/yaml_file/parser'
-      require 'renogen/extraction_stratagies/yaml_file/provider'
+      require_relative 'yaml_file/reader'
+      require_relative 'yaml_file/parser'
+      require_relative 'yaml_file/provider'
+      require_relative 'yaml_file/exceptions'
     end
   end
 end

data/lib/renogen/extraction_stratagies/yaml_file/exceptions.rb

@@ -0,0 +1,12 @@
+
+module Renogen
+  module ExtractionStratagies
+    module YamlFile
+      # Exceptions thrown by YAML file extraction stratagy
+      module Exceptions
+        require_relative 'exceptions/yaml_file_blank'
+      end
+    end
+  end
+end
+

data/lib/renogen/extraction_stratagies/yaml_file/exceptions/yaml_file_blank.rb

@@ -0,0 +1,25 @@
+module Renogen
+  module ExtractionStratagies
+    module YamlFile
+      module Exceptions
+        # This is raised when a yaml file change is found but has not contents
+        class YamlFileBlank < Renogen::Exceptions::Base
+          attr_reader :file_path
+
+          def initialize(file_path)
+            @file_path = file_path
+            super
+          end
+
+          # Friendly error message
+          #
+          # @return [String]
+          def message
+            "Error: File contents blank '#{file_path}'"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/renogen/extraction_stratagies/yaml_file/reader.rb

@@ -13,10 +13,16 @@ module Renogen
           @directory_path ||= './change_log/'
         end
 
+        # Iterates thorugh each change file and yields the contents.
+        # 
+        # an exception is thrown if the contents are blank
+        #
         # @yield [Hash] yaml_file
         def each_yaml_file
           change_directories.each do |file_path|
-            yield ::YAML.load_file(file_path)
+            content = ::YAML.load_file(file_path)
+            raise Exceptions::YamlFileBlank.new(file_path) unless content
+            yield content
           end
         end
 

data/lib/renogen/formatters.rb

@@ -1,5 +1,5 @@
 module Renogen
-  # Formatters are used to manipulate how the change is output
+  # Formatters to manipulate how the change is output
   #
   # Also has methods to retrive and add a formatters
   module Formatters
@@ -15,7 +15,7 @@ module Renogen
         if formatter
           formatter.new(options)
         else
-          raise Renogen::Exceptions::FormatterNotFound.new(format_type)
+          raise Renogen::Exceptions::StratagyNotFound.new(format_type)
         end
       end
 
@@ -24,7 +24,7 @@ module Renogen
       # @param identifier [Symbol]
       # @param klass [Symbol]
       def add(identifier, klass)
-        # TODO raise 'name taken' unless formatters[name].nil?
+        # raise 'name taken' unless formatters[name].nil?
         formatters[identifier]=klass
       end
 
@@ -36,8 +36,8 @@ module Renogen
     end
   end
 
-  require 'renogen/formatters/base'
-  require 'renogen/formatters/plain_text'
-  require 'renogen/formatters/markdown'
-  require 'renogen/formatters/html'
+  require_relative 'formatters/base'
+  require_relative 'formatters/plain_text'
+  require_relative 'formatters/markdown'
+  require_relative 'formatters/html'
 end

data/lib/renogen/generator.rb

@@ -1,4 +1,5 @@
 module Renogen
+  # This is the conductor of the application
   class Generator
     attr_accessor :source, :version, :output_format, :options
 

data/lib/renogen/version.rb

@@ -1,3 +1,3 @@
 module Renogen
-  VERSION='0.1.0.pre'.freeze # :nodoc:
+  VERSION='1.0.0'.freeze # :nodoc:
 end

data/spec/lib/renogen/exceptions/{formatter_not_found_spec.rb → stratagy_not_found_spec.rb}

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe Renogen::Exceptions::FormatterNotFound do
+describe Renogen::Exceptions::StratagyNotFound do
   let(:name) { 'foobar' }
   subject { described_class.new(name) }
 
   describe '#message' do
     it 'returns friendly error message' do
-      expect(subject.message).to eql "Error: Unsupported format type '#{name}'"
+      expect(subject.message).to eql "Error: Stratagy type '#{name}' not found"
     end
 
   end

data/spec/lib/renogen/{exceptions/extraction_stratagy_not_found_spec.rb → extraction_stratagies/yaml_file/exceptions/yaml_file_blank_spec.rb}

@@ -1,13 +1,12 @@
 require 'spec_helper'
 
-describe Renogen::Exceptions::ExtractionStratagyNotFound do
+describe Renogen::ExtractionStratagies::YamlFile::Exceptions::YamlFileBlank do
   let(:name) { 'foobar' }
   subject { described_class.new(name) }
 
   describe '#message' do
     it 'returns friendly error message' do
-      expect(subject.message).to eql "Error: Unsupported source type '#{name}'"
+      expect(subject.message).to eql "Error: File contents blank 'foobar'"
     end
-
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
 require 'renogen'
 
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
     # This option will default to `true` in RSpec 4. It makes the `description`
     # and `failure_message` of custom matchers include text for helper methods
@@ -24,25 +21,6 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  # config.filter_run :focus
-  # config.run_all_when_everything_filtered = true
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  # config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  # config.disable_monkey_patching!
-
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
   config.warnings = true
@@ -57,20 +35,9 @@ RSpec.configure do |config|
     config.default_formatter = 'doc'
   end
 
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  # config.profile_examples = 1
-
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  # Kernel.srand config.seed
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renogen
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Dave Elliott
@@ -45,11 +45,12 @@ files:
 - lib/renogen/config.rb
 - lib/renogen/exceptions.rb
 - lib/renogen/exceptions/base.rb
-- lib/renogen/exceptions/extraction_stratagy_not_found.rb
-- lib/renogen/exceptions/formatter_not_found.rb
+- lib/renogen/exceptions/stratagy_not_found.rb
 - lib/renogen/extraction_stratagies.rb
 - lib/renogen/extraction_stratagies/base.rb
 - lib/renogen/extraction_stratagies/yaml_file.rb
+- lib/renogen/extraction_stratagies/yaml_file/exceptions.rb
+- lib/renogen/extraction_stratagies/yaml_file/exceptions/yaml_file_blank.rb
 - lib/renogen/extraction_stratagies/yaml_file/parser.rb
 - lib/renogen/extraction_stratagies/yaml_file/provider.rb
 - lib/renogen/extraction_stratagies/yaml_file/reader.rb
@@ -65,9 +66,9 @@ files:
 - spec/lib/renogen/change_log/model_spec.rb
 - spec/lib/renogen/change_log/writer_spec.rb
 - spec/lib/renogen/config_spec.rb
-- spec/lib/renogen/exceptions/extraction_stratagy_not_found_spec.rb
-- spec/lib/renogen/exceptions/formatter_not_found_spec.rb
+- spec/lib/renogen/exceptions/stratagy_not_found_spec.rb
 - spec/lib/renogen/extraction_stratagies/base_spec.rb
+- spec/lib/renogen/extraction_stratagies/yaml_file/exceptions/yaml_file_blank_spec.rb
 - spec/lib/renogen/extraction_stratagies/yaml_file/parser_spec.rb
 - spec/lib/renogen/extraction_stratagies/yaml_file/provider_spec.rb
 - spec/lib/renogen/extraction_stratagies/yaml_file/reader_spec.rb
@@ -92,14 +93,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Release Notes/changelog Generator
 test_files: []
-has_rdoc: 

data/lib/renogen/exceptions/formatter_not_found.rb

@@ -1,20 +0,0 @@
-module Renogen
-  module Exceptions
-    # Raised when an extraction stratagy for a given key can not be found
-    class FormatterNotFound < Base
-      attr_reader :name
-
-      def initialize(name)
-        @name = name
-        super
-      end
-
-      # Friendly error message
-      #
-      # @return [String]
-      def message
-        "Error: Unsupported format type '#{name}'"
-      end
-    end
-  end
-end