renogen 0.0.1 → 0.1.0.pre

data/lib/renogen/config.rb

@@ -0,0 +1,35 @@
+require 'singleton'
+require 'yaml'
+
+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
+
+
+    def initialize
+      config_file = load_yaml_config
+      self.single_line_format = config_file['single_line_format'] || 'summary (see link)'.freeze
+      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']
+    end
+
+    def self.configure
+      yield instance
+    end
+
+    private
+
+    def load_yaml_config(config_file_path='.renogen')
+      begin
+        YAML.load_file(config_file_path)
+      rescue
+        {}
+      end
+    end
+  end
+end
+

data/lib/renogen/exceptions.rb

@@ -0,0 +1,8 @@
+module Renogen
+  # Custom exceptions
+  module Exceptions
+    require 'renogen/exceptions/base'
+    require 'renogen/exceptions/extraction_stratagy_not_found'
+    require 'renogen/exceptions/formatter_not_found'
+  end
+end

data/lib/renogen/exceptions/base.rb

@@ -0,0 +1,7 @@
+module Renogen
+  module Exceptions
+    # super class for shared functionality of all rengeon exceptions
+    class Base < StandardError
+    end
+  end
+end

data/lib/renogen/exceptions/extraction_stratagy_not_found.rb

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

data/lib/renogen/exceptions/formatter_not_found.rb

@@ -0,0 +1,20 @@
+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

data/lib/renogen/extraction_stratagies.rb

@@ -0,0 +1,42 @@
+module Renogen
+  # Contains methods for extracting release notes
+  module ExtractionStratagies
+
+    class << self
+
+      # Retrieves a stratagy from a given key
+      #
+      # @param stratagy_type [String] identifier for stratagy
+      # @param options [Hash] any options required for stratagy
+      # @return [ExtractionStratagies::Base]
+      def obtain(stratagy_type, options={})
+        stratagy = stratagies[stratagy_type.to_s]
+        if stratagy
+          stratagy.new(options)
+        else
+          raise Renogen::Exceptions::ExtractionStratagyNotFound.new(stratagy_type)
+        end
+      end
+
+      # Adds a new stratagy class to store
+      #
+      # @param identifier [Symbol]
+      # @param klass [Symbol]
+      def add(identifier, klass)
+        # raise 'name taken' unless stratagies[name].nil?
+        stratagies[identifier.to_s]=klass
+      end
+
+      private
+
+      def stratagies
+        @stratagies ||= {}
+      end
+    end
+
+    require'renogen/extraction_stratagies/base'
+    require'renogen/extraction_stratagies/yaml_file'
+    # require_relative 'extraction_stratagies/github'
+    # require_relative 'extraction_stratagies/gitlog'
+  end
+end

data/lib/renogen/extraction_stratagies/base.rb

@@ -0,0 +1,29 @@
+module Renogen
+  module ExtractionStratagies
+    # Template for all extraction stratagies
+    class Base
+
+      # Adds class with identifier to extraction stratagies
+      #
+      # @param identifier [String]
+      def self.register(identifier)
+        Renogen::ExtractionStratagies.add(identifier.to_sym, self)
+      end
+
+      def initialize(options={})
+        @changelog ||= ChangeLog::Model.new
+      end
+
+      # Parse changes from source
+      #
+      # @return [NotImplementedError]
+      def extract
+        raise NotImplementedError
+      end
+
+      protected
+
+      attr_reader :changelog
+    end
+  end
+end

data/lib/renogen/extraction_stratagies/yaml_file.rb

@@ -0,0 +1,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'
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Renogen
+  module ExtractionStratagies
+    module YamlFile
+
+      # Reads change data from files in configured directory
+      class Parser
+        attr_reader :changelog
+
+        def initialize(options={})
+          @changelog = options[:changelog] || ChangeLog::Model.new
+          @yaml_file_reader = Reader.new(options['changelog_path'], options)
+        end
+
+        # @return [ChangeLog::Model]
+        def parse!
+          yaml_file_reader.each_yaml_file do |file|
+            parse_file(file)
+          end
+          changelog
+        end
+
+        protected
+
+        attr_reader :yaml_file_reader
+
+        def parse_file(file)
+          file.each do |group_name, content|
+            changelog.add_change(ChangeLog::Item.new(group_name, content))
+          end
+        end
+
+        def config
+          Renogen::Config.instance
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Renogen
+  module ExtractionStratagies
+    module YamlFile
+
+      # Reads change data from files in configured directory
+      class Provider < Base
+        register :yaml_file
+        register :yaml
+
+        def initialize(options={})
+          super
+          @yaml_parser = Parser.new(options)
+        end
+
+        # Parse changes from source
+        #
+        # @return [ChangeLog::Model]
+        def extract
+          @yaml_parser.parse!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'yaml'
+
+module Renogen
+  module ExtractionStratagies
+    module YamlFile
+      # Reads the relevant yaml files
+      class Reader
+        attr_accessor :directory_path, :legacy_version
+
+        def initialize(directory_path, options={})
+          @legacy_version = options['legacy_version']
+          @directory_path = directory_path
+          @directory_path ||= './change_log/'
+        end
+
+        # @yield [Hash] yaml_file
+        def each_yaml_file
+          change_directories.each do |file_path|
+            yield ::YAML.load_file(file_path)
+          end
+        end
+
+        private
+
+        # @return [Array]
+        def change_directories
+          upgrade_versions = legacy_versions.map do |path|
+            File.join(path, "*.yml")
+          end
+          upgrade_versions << File.join(directory_path, 'next', "*.yml")
+
+          Dir.glob(upgrade_versions)
+        end
+
+        # @return [Array] 
+        def legacy_versions
+          return [] unless legacy_version
+          legacy_version.gsub!('v','')
+          Dir.glob(File.join(directory_path, '*')).select do |dir|
+            dir = dir.split('/').last.gsub('v','').gsub('_','.')
+            next if dir == 'next'
+            Gem::Version.new(dir) > Gem::Version.new(legacy_version)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/renogen/formatters.rb

@@ -0,0 +1,43 @@
+module Renogen
+  # Formatters are used to manipulate how the change is output
+  #
+  # Also has methods to retrive and add a formatters
+  module Formatters
+
+    class << self
+      # Retrieves a formatter from a given key
+      #
+      # @param format_type [String] identifier for formatter
+      # @param options [Hash] any options required for formatter
+      # @return [Formatter::Base]
+      def obtain(format_type, options={})
+        formatter = formatters[format_type.to_sym]
+        if formatter
+          formatter.new(options)
+        else
+          raise Renogen::Exceptions::FormatterNotFound.new(format_type)
+        end
+      end
+
+      # Adds a new formatter class to store
+      #
+      # @param identifier [Symbol]
+      # @param klass [Symbol]
+      def add(identifier, klass)
+        # TODO raise 'name taken' unless formatters[name].nil?
+        formatters[identifier]=klass
+      end
+
+      private
+
+      def formatters
+        @formatters ||= {}
+      end
+    end
+  end
+
+  require 'renogen/formatters/base'
+  require 'renogen/formatters/plain_text'
+  require 'renogen/formatters/markdown'
+  require 'renogen/formatters/html'
+end

data/lib/renogen/formatters/base.rb

@@ -0,0 +1,54 @@
+module Renogen
+  module Formatters
+    # Implements a template pattern that forces the implemention of required 
+    # methods in sub classes
+    class Base
+      def initialize(options={})
+      end
+
+      # Adds class with identifier to formatters
+      #
+      # @param identifier [String]
+      def self.register(identifier)
+        Renogen::Formatters.add(identifier.to_sym, self)
+      end
+
+      # Outputs a line or block of text appearing at the top of the change log.
+      #
+      # @param header [String]
+      # @return [NotImplementedError]
+      def write_header(header)
+        raise NotImplementedError
+      end
+
+      # Outputs a line or block as a header for a group.
+      #
+      # @param group [String]
+      # @return [NotImplementedError]
+      def write_group(group)
+        raise NotImplementedError
+      end
+
+      # Outputs a line or block of text appearing after a group.
+      #
+      # @return [nil]
+      def write_group_end
+      end
+
+      # Outputs a line or block as the body for a change.
+      #
+      # @param change [String]
+      # @return [NotImplementedError]
+      def write_change(change)
+        raise NotImplementedError
+      end
+
+      # Outputs a line or block of text appearing at the bottom of the change log.
+      #
+      # @param changelog [ChangeLog]
+      # @return [nil]
+      def write_footer(changelog)
+      end
+    end
+  end
+end

data/lib/renogen/formatters/html.rb

@@ -0,0 +1,47 @@
+module Renogen
+  module Formatters
+    # For formatting a change into html format
+    class Html < Base
+      register :html
+
+      # Outputs a line or block of text appearing at the top of the change log.
+      #
+      # @param header [String]
+      # @return [String]
+      def write_header(header)
+        "<html>\n<h1>#{header}</h1>"
+      end
+
+      # Outputs a line or block as a header for a group.
+      #
+      # @param group [String]
+      # @return [String]
+      def write_group(group)
+        "<h2>#{group}</h2>\n<ul>"
+      end
+
+      # Outputs a line or block of text appearing after a group.
+      #
+      # @return [String]
+      def write_group_end
+        "</ul>"
+      end
+
+      # Outputs a line or block as the body for a change.
+      #
+      # @param change [String]
+      # @return [String]
+      def write_change(change)
+        "  <li>#{change}</li>"
+      end
+
+      # Outputs a line or block of text appearing at the bottom of the change log.
+      #
+      # @param changelog [ChangeLog]
+      # @return [String]
+      def write_footer(changelog)
+        '</html>'
+      end
+    end
+  end
+end