renogen 0.0.1 → 0.1.0.pre

data/lib/renogen/formatters/markdown.rb

@@ -0,0 +1,33 @@
+module Renogen
+  module Formatters
+    # For formatting a change into markdown format
+    class Markdown < Base
+      register :markdown
+      register :md
+
+      # Outputs a line or block of text appearing at the top of the change log.
+      #
+      # @param header [String]
+      # @return [String]
+      def write_header(header)
+        "# #{header}"
+      end
+
+      # Outputs a line or block as a header for a group.
+      #
+      # @param group [String]
+      # @return [String]
+      def write_group(group)
+        "### #{group}"
+      end
+
+      # Outputs a line or block as the body for a change.
+      #
+      # @param change [String]
+      # @return [String]
+      def write_change(change)
+        "* #{change}"
+      end
+    end
+  end
+end

data/lib/renogen/formatters/plain_text.rb

@@ -0,0 +1,33 @@
+module Renogen
+  module Formatters
+    # For formatting a change as plain text
+    class PlainText < Base
+      register :plain_text
+      register :text
+
+      # Outputs a line or block of text appearing at the top of the change log.
+      #
+      # @param header [String]
+      # @return [String]
+      def write_header(header)
+        "#{header}\n "
+      end
+
+      # Outputs a line or block as a header for a group.
+      #
+      # @param group [String]
+      # @return [String]
+      def write_group(group)
+        "#{group}"
+      end
+
+      # Outputs a line or block as the body for a change.
+      #
+      # @param change [String]
+      # @return [String]
+      def write_change(change)
+        "- #{change}"
+      end
+    end
+  end
+end

data/lib/renogen/generator.rb

@@ -0,0 +1,34 @@
+module Renogen
+  class Generator
+    attr_accessor :source, :version, :output_format, :options
+
+    def initialize(version, source, output_format, options={})
+      @version = version
+      @source = source
+      @output_format = output_format
+      @options = options
+    end
+
+    # Create the change log
+    def generate!
+      changelog = extraction_stratagy.extract
+      changelog.version = version
+
+      writer.write!(changelog)
+    end
+
+    protected
+
+    def writer
+      Renogen::ChangeLog::Writer.new(formatter)
+    end
+
+    def extraction_stratagy
+      Renogen::ExtractionStratagies.obtain(source, options)
+    end
+
+    def formatter
+      Renogen::Formatters.obtain(output_format, options)
+    end
+  end
+end

data/lib/renogen/version.rb

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

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Renogen::ChangeLog::Group do
+  describe '#add' do
+    subject { described_class.new('my group') }
+
+    it 'adds change to group' do
+      subject.add('foo')
+      expect(subject.changes).to include('foo')
+    end
+
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Renogen::ChangeLog::Item do
+  let(:change) { Array.new }
+  subject { described_class.new('foo', change) }
+
+  describe '#to_s' do
+    context "when change type is a 'String'" do
+      let(:change) { "foo\nbar\n" }
+      it 'returns string with newline at end' do
+        expect(subject.to_s).to eql "foo\nbar\n\n"
+      end
+    end
+
+    context "when change type is a 'Hash'" do
+      let(:change) { Hash.new }
+      it 'returns single line string' do
+        config = Renogen::Config.instance
+        string = config.single_line_format.downcase.gsub('\n', '\n  ')
+        config.supported_keys.each do |key|
+          string = string.gsub(key, '')
+        end
+        expect(subject.to_s).to eql string
+      end
+    end
+
+    context "when change type is a 'Array'" do
+      let(:change) { Array.new }
+      it 'returns array' do
+        expect(subject.to_s).to eql change
+      end
+    end
+
+    context "when change type is unknown" do
+      let(:change) { described_class }
+      it 'raises a type error' do
+        expect{subject.to_s}.to raise_error TypeError
+      end
+    end
+  end
+
+  describe '#list?' do
+    it 'returns true when change is an array type' do
+      expect(subject.list?).to be_truthy
+    end
+  end
+
+  describe '#each' do
+  end
+end
+

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

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Renogen::ChangeLog::Model do
+  let(:change_item) { Renogen::ChangeLog::Item.new('foo', 'bar') }
+
+  describe '#groups' do
+    it 'returns an empty hash when no changes' do
+      expect(subject.groups).to eql Hash.new
+    end
+
+    it 'returns hash of changes by group_name' do
+      subject.add_change(change_item)
+      expect(subject.groups).to eql({change_item.group_name => [change_item]})
+    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)
+      expect(subject.items.first).to eql change_item
+      expect(subject.items.size).to eql 1
+    end
+
+    it 'raises error when non valid change is added' do
+      expect{subject.add_change('bar')}.to raise_error TypeError
+    end
+  end
+
+end

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

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Renogen::ChangeLog::Writer do
+
+  describe '#write!' do
+  end
+end
+

data/spec/lib/renogen/config_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Renogen::Config do
+
+  subject { described_class.instance }
+
+  describe '#configure' do
+    before :each do
+      described_class.configure do |config|
+        config.single_line_format = 'bar'
+      end
+    end
+
+    it 'can set value' do
+      expect(subject.single_line_format).to eql 'bar'
+    end
+  end
+
+end

data/spec/lib/renogen/exceptions/extraction_stratagy_not_found_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Renogen::Exceptions::ExtractionStratagyNotFound 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}'"
+    end
+
+  end
+end

data/spec/lib/renogen/exceptions/formatter_not_found_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Renogen::Exceptions::FormatterNotFound 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}'"
+    end
+
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Renogen::ExtractionStratagies::Base do
+  describe '#extract' do
+    it 'raises an NotImplementedError' do
+      expect{subject.extract}.to raise_error NotImplementedError
+    end
+
+  end
+end

data/spec/lib/renogen/extraction_stratagies/yaml_file/parser_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Renogen::ExtractionStratagies::YamlFile::Parser do
+  let(:file_contents) { { 'Foo' => 'Bar' }  }
+
+  describe '#parse!' do
+    before :each do
+      yaml_file_reader = double(Renogen::ExtractionStratagies::YamlFile::Reader)
+      allow(yaml_file_reader).to receive(:each_yaml_file).and_yield(file_contents)
+      allow(Renogen::ExtractionStratagies::YamlFile::Reader).to receive(:new).and_return(yaml_file_reader)
+    end
+
+    it 'extracts contents from file' do
+      changelog_item = Renogen::ChangeLog::Item.new('Foo', 'Bar')
+      allow(Renogen::ChangeLog::Item).to receive(:new).with('Foo', 'Bar').and_return changelog_item
+
+      changelog = subject.parse!
+
+      expect(changelog.items).to include changelog_item
+      expect(changelog.items.size).to eql 1
+    end
+  end
+
+end

data/spec/lib/renogen/extraction_stratagies/yaml_file/provider_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Renogen::ExtractionStratagies::YamlFile::Provider do
+  it "is returned for 'yaml_file'" do
+    expect(Renogen::ExtractionStratagies.obtain(:yaml_file)).to be_a described_class
+  end
+
+  it "is returned for 'yaml'" do
+    expect(Renogen::ExtractionStratagies.obtain(:yaml)).to be_a described_class
+  end
+
+end

data/spec/lib/renogen/extraction_stratagies/yaml_file/reader_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'json'
+
+describe Renogen::ExtractionStratagies::YamlFile::Reader do
+  let(:directory_path) { './my/directory/path' }
+  subject { described_class.new(directory_path) }
+
+  describe '#each_yaml_file' do
+    let(:file_contents) { { 'Foo' => 'Bar' }.to_json  }
+
+    before :each do
+      allow(Dir).to receive(:glob).with([File.join(directory_path, 'next', "*.yml")]).and_return(['foo_file'])
+      allow(YAML).to receive(:load_file).with('foo_file').and_return(file_contents)
+    end
+
+    it 'yields each yaml file within given directory' do
+      expect{ |b| subject.each_yaml_file(&b) }.to yield_with_args(file_contents)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Renogen::Formatters::Base do
+  describe '#write_header' do
+    it 'raises an NotImplementedError' do
+      expect{subject.write_header('header')}.to raise_error NotImplementedError
+    end
+  end
+
+  describe '#write_group' do
+    it 'raises an NotImplementedError' do
+      expect{subject.write_group('group_name')}.to raise_error NotImplementedError
+    end
+  end
+
+  describe '#write_change' do
+    it 'raises an NotImplementedError' do
+      expect{subject.write_change('change')}.to raise_error NotImplementedError
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Renogen::Formatters::Html do
+
+  it 'is registered' do
+    expect(Renogen::Formatters.obtain(:html)).to be_kind_of described_class
+  end
+
+  describe '#write_header' do
+    it 'returns header with newline' do
+      expect(subject.write_header('header')).to eql "<html>\n<h1>header</h1>"
+    end
+  end
+
+  describe '#write_group' do
+    it 'returns group' do
+      expect(subject.write_group('group')).to eql "<h2>group</h2>\n<ul>"
+    end
+  end
+
+  describe '#write_group_end' do
+    it 'returns closing list tag' do
+      expect(subject.write_group_end).to eql "</ul>"
+    end
+  end
+
+  describe '#write_change' do
+    it 'returns change with newline and hyphen' do
+      expect(subject.write_change('change')).to eql "  <li>change</li>"
+    end
+  end
+
+  describe '#write_footer' do
+    it 'returns closing html tag' do
+      expect(subject.write_footer('change')).to eql '</html>'
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Renogen::Formatters::Markdown do
+  it "is returned for 'markdown'" do
+    expect(Renogen::Formatters.obtain(:markdown)).to be_kind_of described_class
+  end
+
+  it "is returned for 'md'" do
+    expect(Renogen::Formatters.obtain(:md)).to be_kind_of described_class
+  end
+
+  describe '#write_header' do
+    it 'returns header with newline' do
+      expect(subject.write_header('header')).to eql "# header"
+    end
+  end
+
+  describe '#write_group' do
+    it 'returns group' do
+      expect(subject.write_group('group')).to eql "### group"
+    end
+  end
+
+  describe '#write_change' do
+    it 'returns change with newline and hyphen' do
+      expect(subject.write_change('change')).to eql "* change"
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Renogen::Formatters::PlainText do
+  it "is returned for 'plain_text'" do
+    expect(Renogen::Formatters.obtain(:plain_text)).to be_kind_of described_class
+  end
+
+  it "is returned for 'text'" do
+    expect(Renogen::Formatters.obtain(:text)).to be_kind_of described_class
+  end
+
+  describe '#write_header' do
+    it 'returns header with newline' do
+      expect(subject.write_header('header')).to eql "header\n "
+    end
+  end
+
+  describe '#write_group' do
+    it 'returns group' do
+      expect(subject.write_group('group')).to eql "group"
+    end
+  end
+
+  describe '#write_change' do
+    it 'returns change with newline and hyphen' do
+      expect(subject.write_change('change')).to eql "- change"
+    end
+  end
+end