meta_commit 0.1.0.alpha → 0.2.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a91401c347971a081402085e903f5f38e481dec2
-  data.tar.gz: e3baa26014b744d0f3a0f3bf65bef1096588d6ff
+  metadata.gz: 2fcc0c263c146decf38b057cba6b6afb68307237
+  data.tar.gz: 065807ac6a1848a434c586893173a4edf3e97ab8
 SHA512:
-  metadata.gz: e4853da029ca727831f4c6e12ce8b3daaa637ae9aed11d3a6e76f25348682a9776c15d33cade68fa3e5771ba4f08ed6199f997fdd12834825cdc5051a298a786
-  data.tar.gz: d7321d80c6bf1377633f889d829ca7379039b019948c0931c24cf1f901b84f8402ea0a5df72e30bb7539182f3c86f6b57d8b2fefb1095de6501ba0f6dd03cd13
+  metadata.gz: fb11ea9ca1c203df6a264bf2e8343c003521017c0a22cc5b93a811d1f7d0515b95a2cc5134a88b9fe735359d8c9b4a16861eeab5e3fc7d02243dd8fa0a8fe81f
+  data.tar.gz: 4b53eb6e6a3c3d2ac0be8e556035e6e0103591692ea8e515b72c70e49a007fdac4a4ffd88fb0d92218c9f5eb8ad75ad79ae4724288d7ace91809827456099f3f

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 2.2.3
 before_install: gem install bundler -v 1.10.6
+script:
+  - rake spec
+  - rake features

data/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+## How to contribute to meta commit project
+
+### Development environment
+
+Fork, then clone the repo:
+
+    git clone git@github.com:your-username/meta_commit.git
+
+Set up your machine:
+
+    ./bin/setup
+
+Make sure the tests pass:
+
+    rake
+
+Create your feature branch 
+
+    git checkout -b my-new-feature
+
+Make your change. Add tests for your change. Make the tests pass:
+
+    rake
+
+Push to the branch
+
+    git push origin my-new-feature
+
+Create a new Pull Request
+
+
+### How it works
+
+Task of meta_commit gem is to :
+
+1. Walk over changes presented in commit
+2. Parse content of changes using parsers from extensions
+3. Find matching diffs for parsed changes
+4. Handle diffs (print as string, save to storage or return)
+
+
+### Creating new extension
+
+Extension is a gem that adds new parsers or diffs to core meta commit gem.
+
+To be autoloaded by meta commit core it must follow agreements :
+
+-   Gem name matches `/^meta_commit_/` regex
+-   Gem has class with name `MetaCommit::Extension::#{ExtensionName}::Locator` (`ExtensionName` without `meta_commit_` prefix)
+    -   Which returns array of parser classes on `MetaCommit::Extension::#{ExtensionName}::Locator#parsers`
+    -   Which returns array of diff classes on `MetaCommit::Extension::#{ExtensionName}::Locator#diffs`
+
+Meta commit uses contracts to interact with extensions, you can check this contracts [here](https://github.com/meta-commit/contracts).
+
+To understand better how to build extension you can check [extension that adds ruby language support](https://github.com/meta-commit/ruby_support).
+
+
+---
+
+
+By participating in this project, you agree to abide by the [code of conduct](https://github.com/usernam3/meta_commit/blob/master/CODE_OF_CONDUCT.md).

data/README.md

@@ -1,4 +1,8 @@
 # meta commit
+[![Gem Version](https://badge.fury.io/rb/meta_commit.svg)](https://badge.fury.io/rb/meta_commit)
+![Travis](https://api.travis-ci.org/usernam3/meta_commit.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/usernam3/meta_commit/badge.svg?branch=master)](https://coveralls.io/github/usernam3/meta_commit?branch=master)
+[![Inline docs](http://inch-ci.org/github/usernam3/meta_commit.svg?branch=master)](http://inch-ci.org/github/usernam3/meta_commit)
 
 >   Enrich commit diffs with programing language insights
 
@@ -19,22 +23,49 @@ You can install gem with the following command in a terminal:
     $ gem install meta_commit
 
 
+## Setup
+
+To setup ```meta_commit``` gem for your repository you need to add configuration file to root of repo.
+Currently meta commit expects configuration file with name `.meta_commit.yml` of this format : 
+
+```YAML
+commands :
+  changelog:
+    adapter: file
+    formatter: keep_a_changelog
+  index:
+    adapter: git_notes
+  message:
+    formatter: commit_message
+
+extensions:
+  - ruby_support
+  - extension2
+  - extension3
+  - extension4
+```
+
+This config can be used to change gem behavior, currently it supports only `extensions` key.
+Elements of `extensions` list are gem names (without `meta_commit_` prefix) that will be loaded.
+[Here](https://github.com/usernam3/meta_commit/blob/master/CONTRIBUTING.md) you can get more information about how to create new extension. 
+
+
 ## Usage
 
 ### Message
 
-``` meta_commit message [--repo=$(pwd)] ```
+    meta_commit message [--repo=$(pwd)]
 
 Prints description of current changes in repository index
 
 ### Index
 
-``` meta_commit index [--branch=master] [--repo=$(pwd)] ```
+    meta_commit index [--repo=$(pwd)]
 
 Walks over repository commits and writes meta information to git notes
 
-### Changelog (NOT IMPLEMENTED)
+### Changelog
 
-``` meta_commit changelog [--from] [--to] [--repo=$(pwd)] ```
+    meta_commit changelog [--from-tag] [--to-tag] [--directory=$(pwd)] [--filename='CHANGELOG.md'] 
 
-Walks over commits between tags ``` from ``` and ``` to ``` and writes main changes to changelog.md
+Walks over commits between tags ``` from ``` and ``` to ``` and writes changes to changelog file

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubygems"
+require "cucumber"
+require "cucumber/rake/task"
 
 RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
 
-task :default => :spec
+task :default => [:spec, :features]

data/config/default.yml

@@ -0,0 +1,11 @@
+commands :
+  changelog:
+    adapter: file
+    formatter: keep_a_changelog
+  index:
+    adapter: git_notes
+  message:
+    formatter: commit_message
+
+extensions:
+  - builtin

data/exe/meta_commit

@@ -2,4 +2,8 @@
 
 require 'meta_commit'
 
-MetaCommit::ApplicationInterface.start( ARGV )
+begin
+    MetaCommit::ApplicationInterface.start( ARGV )
+rescue MetaCommit::Errors::MissingRepoError => e
+    Thor.new.say(e.message)
+end

data/lib/meta_commit/changelog/adapters/changelog.rb

@@ -0,0 +1,94 @@
+module MetaCommit::Changelog
+  module Adapters
+    # Adapter class to write repository changes to changelog file
+    class Changelog
+      VERSION_DELIMITER="\n\n\n"
+      VERSION_HEADER_REGEX = /(## \[.*?\] - \d{4}-\d{2}-\d{2})/m
+
+      attr_accessor :path, :filename, :tag, :date
+
+      # @param [String] path
+      # @param [String] filename
+      # @param [String] tag version
+      # @param [String] date of version release
+      def initialize(path, filename, tag, date)
+        @path=path
+        @filename=filename
+        @tag=tag
+        @date=date
+      end
+
+      # Builds changelog message and adds it after description text and before latest version
+      # @param repo
+      # @param [Array<MetaCommit::Models::Diffs::Diff>] diffs
+      # @return [String]
+      def write_repository_change_chunk(repo, diffs)
+        message_builder = changelog_message_builder(@tag, @date)
+        diffs.each do |diff|
+          message_builder.add_to_added(diff.string_representation) if diff.type_addition?
+          message_builder.add_to_removed(diff.string_representation) if diff.type_deletion?
+          message_builder.add_to_changed(diff.string_representation) if diff.type_replace?
+        end
+        prepend_to_changelog(message_builder.build)
+      end
+
+      # @return [String] path to changelog file
+      def changelog_path
+        File.join(@path, @filename)
+      end
+
+      private :changelog_path
+
+      # @param [String] version
+      # @param [String] date
+      # @return [MetaCommit::Services::KeepAChangelogVerReportBuilder]
+      def changelog_message_builder(version, date)
+        MetaCommit::Changelog::Formatters::KeepAChangelogVerReportBuilder.new(version, date)
+      end
+
+      private :changelog_message_builder
+
+      # @param [String] text
+      # @return [String]
+      def prepend_to_changelog(text)
+        current_changelog_content = read_from_changelog
+        current_changelog_parts = current_changelog_content.split(VERSION_HEADER_REGEX)
+
+        if starts_with_description(current_changelog_parts)
+          new_changelog_parts = [current_changelog_parts[0]] + [text, "#{VERSION_DELIMITER}"] + current_changelog_parts[1..-1]
+        else
+          new_changelog_parts = [text, "#{VERSION_DELIMITER}"] + current_changelog_parts
+        end
+
+        write_to_changelog(new_changelog_parts.join)
+      end
+
+      private :prepend_to_changelog
+
+      # @return [String] changelog file content
+      def read_from_changelog
+        File.read(changelog_path)
+      end
+
+      private :read_from_changelog
+
+      # @param [String] text content to write to changelog file
+      # @return [String]
+      def write_to_changelog(text)
+        File.open(changelog_path, 'w').write(text)
+        text
+      end
+
+      private :write_to_changelog
+
+      # @param [Array<String>] changelog_parts content sections from changelog
+      # @return [Boolean]
+      def starts_with_description(changelog_parts)
+        return false if changelog_parts.empty?
+        changelog_parts[0].match(VERSION_HEADER_REGEX).nil?
+      end
+
+      private :starts_with_description
+    end
+  end
+end

data/lib/meta_commit/changelog/commands/commit_diff_examiner.rb

@@ -0,0 +1,50 @@
+module MetaCommit::Changelog
+  module Commands
+    class CommitDiffExaminer
+      # @param [MetaCommit::Services::Parse] parse_command
+      # @param [MetaCommit::Factories::ContextualAstNodeFactory] ast_path_factory
+      # @param [MetaCommit::Factories::DiffFactory] diff_factory
+      def initialize(parse_command, ast_path_factory, diff_factory)
+        @parse_command = parse_command
+        @ast_path_factory = ast_path_factory
+        @diff_factory = diff_factory
+      end
+
+
+      # Creates diff objects with meta information of changes between left and right commit
+      # @param [MetaCommit::Git::Repo] repo
+      # @param [String] left_commit commit id
+      # @param [String] right_commit commit id
+      # @return [Array<MetaCommit::Models::Diffs::Diff>]
+      def meta(repo, left_commit, right_commit)
+        diffs = []
+        commit_id_old = left_commit.oid
+        commit_id_new = right_commit.oid
+        repo.diff_with_optimized_lines(left_commit, right_commit) do |old_file_path, new_file_path, patch, line|
+          old_file_content = repo.get_blob_at(commit_id_old, old_file_path, '')
+          new_file_content = repo.get_blob_at(commit_id_new, new_file_path, '')
+
+          old_file_ast = @parse_command.execute(old_file_path, old_file_content)
+          next if old_file_ast.nil?
+          new_file_ast = @parse_command.execute(new_file_path, new_file_content)
+          next if new_file_ast.nil?
+
+          old_ast_path = @ast_path_factory.create_ast_path(old_file_ast, line.old_lineno)
+          new_ast_path = @ast_path_factory.create_ast_path(new_file_ast, line.new_lineno)
+
+          created_diff = @diff_factory.create_diff_of_type(line.line_origin, {
+              :line => line,
+              :commit_id_old => commit_id_old,
+              :commit_id_new => commit_id_new,
+              :old_ast_path => old_ast_path,
+              :new_ast_path => new_ast_path,
+              :old_file_path => old_file_path,
+              :new_file_path => new_file_path,
+          })
+          diffs.push(created_diff) unless created_diff.nil?
+        end
+        diffs
+      end
+    end
+  end
+end

data/lib/meta_commit/changelog/formatters/keep_a_changelog_ver_report_builder.rb

@@ -0,0 +1,123 @@
+module MetaCommit::Changelog
+  module Formatters
+    # Class builds messages with release changes according to [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) specification
+    # @attr [String] version
+    # @attr [String] date
+    # @attr [Array<String>] added_changes Changes from "Added" section
+    # @attr [Array<String>] changed_changes Changes from "Changed" section
+    # @attr [Array<String>] deprecated_changes Changes from "Deprecated" section
+    # @attr [Array<String>] removed_changes Changes from "Removed" section
+    # @attr [Array<String>] fixed_changes Changes from "Fixed" section
+    # @attr [Array<String>] security_changes Changes from "Security" section
+    class KeepAChangelogVerReportBuilder
+      # attr_reader :version, :date
+      attr_reader :added_changes, :changed_changes, :deprecated_changes, :removed_changes, :fixed_changes, :security_changes
+
+      def initialize(version, date)
+        @version=version
+        @date=date
+        @added_changes, @changed_changes, @deprecated_changes, @removed_changes, @fixed_changes, @security_changes = [], [], [], [], [], []
+      end
+
+      # @param [String] change
+      def add_to_added(change)
+        @added_changes.push(change)
+      end
+
+      # @param [String] change
+      def add_to_changed(change)
+        @changed_changes.push(change)
+      end
+
+      # @param [String] change
+      def add_to_deprecated(change)
+        @deprecated_changes.push(change)
+      end
+
+      # @param [String] change
+      def add_to_removed(change)
+        @removed_changes.push(change)
+      end
+
+      # @param [String] change
+      def add_to_fixed(change)
+        @fixed_changes.push(change)
+      end
+
+      # @param [String] change
+      def add_to_security(change)
+        @security_changes.push(change)
+      end
+
+      # @return [String] Version header
+      def version_entry
+        "## [#{@version}] - #{@date}"
+      end
+
+      private :version_entry
+
+      # @return [String] List of changes with type header
+      def changes_group_entry(type, changes)
+        header = ["### #{type}"]
+        list = changes.map { |change| "- #{change}" }
+        ([header] + list).join("\n")
+      end
+
+      private :changes_group_entry
+
+      # @return [String] List of added changes with header
+      def added_changes_group_entry
+        changes_group_entry('Added', @added_changes)
+      end
+
+      private :added_changes_group_entry
+
+      # @return [String] List of changed changes with header
+      def changed_changes_group_entry
+        changes_group_entry('Changed', @changed_changes)
+      end
+
+      private :changed_changes_group_entry
+
+      # @return [String] List of deprecated changes with header
+      def deprecated_changes_group_entry
+        changes_group_entry('Deprecated', @deprecated_changes)
+      end
+
+      private :deprecated_changes_group_entry
+
+      # @return [String] List of removed changes with header
+      def removed_changes_group_entry
+        changes_group_entry('Removed', @removed_changes)
+      end
+
+      private :removed_changes_group_entry
+
+      # @return [String] List of fixed changes with header
+      def fixed_changes_group_entry
+        changes_group_entry('Fixed', @fixed_changes)
+      end
+
+      private :fixed_changes_group_entry
+
+      # @return [String] List of security changes with header
+      def security_changes_group_entry
+        changes_group_entry('Security', @security_changes)
+      end
+
+      private :security_changes_group_entry
+
+      # @return [String] Report with version changes
+      def build
+        result = [version_entry]
+        result += [added_changes_group_entry] unless @added_changes.empty?
+        result += [changed_changes_group_entry] unless @changed_changes.empty?
+        result += [deprecated_changes_group_entry] unless @deprecated_changes.empty?
+        result += [removed_changes_group_entry] unless @removed_changes.empty?
+        result += [fixed_changes_group_entry] unless @fixed_changes.empty?
+        result += [security_changes_group_entry] unless @security_changes.empty?
+        result.join("\n")
+      end
+    end
+  end
+end

data/lib/meta_commit/cli.rb

@@ -2,31 +2,85 @@ require 'thor'
 
 module MetaCommit
   class ApplicationInterface < Thor
-    desc 'message [DIRECTORY]', 'generate message with summary of changes in repo located at DIRECTORY (or current directory if argument not passed)'
-    def message(repository_path=nil)
-      repository_path ||= Dir.pwd
+
+    desc 'message', 'generate message with summary of changes in repo located at DIRECTORY (or current directory if argument not passed)'
+    option :directory, :type => :string, :default => Dir.pwd
+
+    def message
+      repository_path = options[:directory]
       repository = MetaCommit::Git::Repo.new(repository_path)
-      examiner = MetaCommit::Services::DiffIndexExaminer.new(repository)
-      meta = examiner.index_meta
-      message_builder = MetaCommit::Services::CommitMessageBuilder.new(repository)
-      message = message_builder.build(meta)
-      say(message)
+      container = boot_container_with_config(File.join(repository_path, MetaCommit::ConfigurationStore::META_COMMIT_CONFIG_FILENAME))
+
+      examiner = MetaCommit::Message::Commands::DiffIndexExaminer.new(
+          container.resolve(:parse_command),
+          container.resolve(:contextual_ast_node_factory),
+          container.resolve(:diff_factory)
+      )
+
+      meta = examiner.index_meta(repository)
+
+      say(MetaCommit::Message::Formatters::CommitMessageBuilder.new.build(meta))
     end
 
-    desc 'changelog', 'IS NOT IMPLEMENTED'
-    def changelog(path=nil)
-      raise('IS NOT IMPLEMENTED')
+    desc 'changelog [FROM_TAG] [TO_TAG]', 'writes all changes between git tags to changelog file'
+    option :directory, :type => :string, :default => Dir.pwd
+    option :filename, :type => :string, :default => 'CHANGELOG.md', :desc => 'Filename of changelog'
+
+    def changelog(from_tag=nil, to_tag=nil)
+      repository_path = options[:directory]
+      filename = options[:filename]
+      repository = MetaCommit::Git::Repo.new(repository_path)
+      from_tag_commit = repository.commit_of_tag(from_tag)
+      to_tag_commit = repository.commit_of_tag(to_tag)
+      container = boot_container_with_config(File.join(repository_path, MetaCommit::ConfigurationStore::META_COMMIT_CONFIG_FILENAME))
+
+      examiner = MetaCommit::Changelog::Commands::CommitDiffExaminer.new(
+          container.resolve(:parse_command),
+          container.resolve(:contextual_ast_node_factory),
+          container.resolve(:diff_factory)
+      )
+
+      meta = examiner.meta(repository, from_tag_commit, to_tag_commit)
+
+      adapter = MetaCommit::Changelog::Adapters::Changelog.new(repository.dir, filename, to_tag, to_tag_commit.time.strftime('%Y-%m-%d'))
+      change_saver = MetaCommit::Services::ChangeSaver.new(repository, adapter)
+      change_saver.store_meta(meta)
+      say("added version [#{to_tag}] to #{filename}")
     end
 
-    desc 'index [DIRECTORY]', 'indexing repository located at DIRECTORY (or current directory if argument not passed)'
-    def index(repository_path=nil)
-      repository_path ||= Dir.pwd
+    desc 'index', 'indexing repository'
+    option :directory, :type => :string, :default => Dir.pwd
+
+    def index
+      repository_path = options[:directory]
       repository = MetaCommit::Git::Repo.new(repository_path)
-      examiner = MetaCommit::Services::DiffExaminer.new(repository)
-      meta = examiner.meta
-      change_saver = MetaCommit::Services::ChangeSaver.new(repository)
+      container = boot_container_with_config(File.join(repository_path, MetaCommit::ConfigurationStore::META_COMMIT_CONFIG_FILENAME))
+
+      examiner = MetaCommit::Index::Commands::DiffExaminer.new(
+          container.resolve(:parse_command),
+          container.resolve(:contextual_ast_node_factory),
+          container.resolve(:diff_factory)
+      )
+
+      meta = examiner.meta(repository)
+
+      adapter = MetaCommit::Index::Adapters::GitNotes.new(repository.path)
+      change_saver = MetaCommit::Services::ChangeSaver.new(repository, adapter)
       change_saver.store_meta(meta)
       say('repository successfully indexed')
     end
+
+    no_commands do
+      # @param [String] configuration_path
+      # @return [MetaCommit::Container]
+      def boot_container_with_config(configuration_path)
+        default_configuration = MetaCommit::Configuration.new.fill_from_yaml_file(MetaCommit::ConfigurationStore::DEFAULT_FILE)
+        configuration_store = MetaCommit::ConfigurationStore.new(default_configuration)
+        configuration_store.merge(MetaCommit::Configuration.new.fill_from_yaml_file(configuration_path)) if File.exist?(configuration_path)
+
+        container = MetaCommit::Container.new
+        container.boot(configuration_store)
+      end
+    end
   end
 end

data/lib/meta_commit/configuration.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+module MetaCommit
+  class Configuration < Hash
+    # Set the configuration key
+    # @param key [Symbol] configuration key
+    # @param value [Object] configuration value
+    def set(key, value)
+      self[key] = value
+    end
+
+    # Get the configuration value by key
+    # @param key [Symbol] configuration key
+    # @return [Object] configuration value
+    def get(key)
+      self[key]
+    end
+
+    # Fill config values from yaml file
+    # @param [Hash] hash
+    # @return [MetaCommit::Configuration]
+    def fill_from_hash(hash)
+      hash.each {|key, value| set(key.to_sym, value)}
+      self
+    end
+
+    # Fill config values from yaml file
+    # @param [String] path
+    # @return [MetaCommit::Configuration]
+    def fill_from_yaml_file(path)
+      fill_from_hash read_from_yaml(path)
+    end
+
+    # @param [String] path
+    # @return [Hash]
+    def read_from_yaml(path)
+      begin
+        YAML::load_file(path)
+      rescue Errno::ENOENT => e
+        raise MetaCommit::Errors::MissingConfigError
+      end
+    end
+
+    protected :read_from_yaml
+  end
+end

data/lib/meta_commit/configuration_store.rb

@@ -0,0 +1,27 @@
+module MetaCommit
+  #
+  # @attr [MetaCommit::Configuration] configuration
+  class ConfigurationStore
+    META_COMMIT_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
+    DEFAULT_FILE = File.join(META_COMMIT_HOME, 'config', 'default.yml')
+    META_COMMIT_CONFIG_FILENAME = '.meta_commit.yml'
+
+    # @param [MetaCommit::Configuration] configuration
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    # Merges passed configuration with @configuration
+    # @param [MetaCommit::Configuration] configuration
+    # @return [MetaCommit::ConfigurationStore]
+    def merge(configuration)
+      @configuration.merge!(configuration)
+    end
+
+    # @param [Symbol] key
+    # @return [Object]
+    def get(key)
+      @configuration.get(key)
+    end
+  end
+end