meta_commit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 714f1ef542aa5c01085288e1d02eafb8e405a0bf
-  data.tar.gz: 40cd2dab04ce2a9c597411cbfc5c22d2c480870d
+  metadata.gz: 547ac3de1a9e93cebe5f8c4f1e3f9e41215db41c
+  data.tar.gz: cdb2293dccff5c93b383a3696b598cd44b451e5d
 SHA512:
-  metadata.gz: 91f560c202ff6675cd68a3f4375072928687201c8dd8733ae23371cd61a2c8e4a1df7fa935846bbedfe7f58da5fd94601be5e4b96b49aa9842db7b1bef080754
-  data.tar.gz: 8468bd6fea1b6732fa04269f4561b8bc8c354fd1a55856ad2c59032477f8b5e4f6a492c152917ab5107cca79a96225582e90a21a127162ffc90a0ad540dcb533
+  metadata.gz: 783844e38b51f0313fef67fdb7b8573d486f38125948a68569b3a072042a1393a9718bcf7ce16d442a55260c22eb55e2b87d039638860716bd2b50d15ad06787
+  data.tar.gz: 3276dc9544b290e958a45e509876b4d1e29686316a64ef1f60b23ad5b08b5e1fb96c052b6fa92c3df7d61e987d1cad248a2f80d1019e8e996f2aadbddb689221

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
   - 2.2.3
-before_install: gem install bundler -v 1.10.6
+  - 2.5.0
+before_install:
+  - gem install bundler -v 1.10.6
+  - export TZ=Europe/Berlin
 script:
   - rake spec
   - rake features

data/CHANGELOG.md

@@ -4,7 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-##  0.2.0 - 2017-10-25
+## [v0.3.0] - 2018-03-12
+### Added
+- `meta_commit init` command
+- `meta_commit version` command
+- Column where diff starts
+- `whole_file_changed` flag
+### Changed
+- Configuration file is required to run command
+- Diff now expects changes using `ChangeContext` DTO
+### Removed
+- Default config usage from `MetaCommit::ConfigurationStore`
+
+## [v0.2.0] - 2017-10-25
 ### Added
 - Code documentation
 - Contribution guide

data/README.md

@@ -1,32 +1,51 @@
 # 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)
+[![Build Status](https://travis-ci.org/usernam3/meta_commit.svg?branch=master)](https://travis-ci.org/usernam3/meta_commit)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ff142cfbcd634e8ad8f1/maintainability)](https://codeclimate.com/github/usernam3/meta_commit/maintainability)
 [![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)
+[![Inline docs](https://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
 
 
 ## Description
 
-[![v0.2 demonstration](https://asciinema.org/a/svV2TBICPgp7pOWneRI30WDel.png)](https://asciinema.org/a/svV2TBICPgp7pOWneRI30WDel?autoplay=1)
+[![v0.3 demonstration](https://asciinema.org/a/P6kWCq2S4eOpMzEjOAKSHYmyv.png)](https://asciinema.org/a/P6kWCq2S4eOpMzEjOAKSHYmyv?autoplay=1)
 
-meta commit - is set of commands for git repository, which extracts useful information from commits and allows to get more insights from usual actions with repository.
+[meta commit](https://usernam3.github.io/meta_commit/) - is set of commands for git repository, which extracts useful information from commits and allows to get more insights from usual actions with repository.
 
-Git is universal distributed version control system and works with minimal common units which exist in any file - strings. Meta commit is utility which gives git information about content of files in repo and changes between commits on level of programming language. 
+Git is universal distributed version control system and works with minimal common units which exist in any file - strings. Meta commit is utility which gives git information about content of repository files and changes between commits on level of programming language. 
 
+## What does meta_commit do ?
 
-## Installing meta_commit
+After you read the 'Description section' you may still have question 'What does meta_commit do ?'
 
-You can install gem with the following command in a terminal:
+The answer is - it takes diff of each commit in the repository, parse diff content using programming language parser (taken from list of extensions) and try to understand what changes commit introduced on programming language level (not lines level as git does it).
+
+
+## Installation
+
+To install gem you need to run:
 
     $ gem install meta_commit
 
+> You may need to additionally install the cmake to install rugged (ruby bindings to libgit). It is [known issue](https://github.com/usernam3/meta_commit/issues/19).
+
 
 ## 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 : 
+To start using meta_commit, first need to add configuration file to the root of the repository.
+To add it, you need to run init command.
+
+    meta_commit init
+
+Or 
+
+    meta_commit init --extensions=ruby_support markdown_support
+
+(*If you want to use [ruby](https://github.com/meta-commit/ruby_support) and [markdown](https://github.com/meta-commit/markdown_support) extensions you will need also to install them by running `gem install meta_commit_ruby_support meta_commit_markdown_support`*)
+
+This command will add `.meta_commit.yml` configuration file with this contents to the repository
 
 ```YAML
 commands :
@@ -40,32 +59,195 @@ commands :
 
 extensions:
   - ruby_support
-  - extension2
-  - extension3
-  - extension4
+  - markdown_support
 ```
 
-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. 
+This config can be used to customize gem behavior, currently only `extensions` key is used.
+Items 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#creating-new-extension) you can get more information about how to create the new extension. 
 
 
 ## Usage
 
+Here you can see usage examples of main meta_commit commands 
+
 ### Message
 
     meta_commit message [--directory=$(pwd)]
 
-Prints description of current changes in repository index
+Message command prints description of repository working tree staged changes.
+Result of execution of this command is string, that is printed to the console and which represents summary of staged changes.
+
+Example :
+
+```zsh
+> /repository_folder git diff --cached
+
+diff --git a/lib/meta_commit/changelog/commands/commit_diff_examiner.rb b/lib/meta_commit/changelog/commands/commit_diff_examiner.rb
+index 49a8ae1..e8a2bc3 100644
+--- a/lib/meta_commit/changelog/commands/commit_diff_examiner.rb
++++ b/lib/meta_commit/changelog/commands/commit_diff_examiner.rb
+@@ -8,6 +8,7 @@ module MetaCommit::Changelog
+         @parse_command = parse_command
+         @ast_path_factory = ast_path_factory
+         @diff_factory = diff_factory
++        @some_property = 2 + 2
+       end
+ 
+ 
+@@ -16,7 +17,7 @@ module MetaCommit::Changelog
+       # @param [String] left_commit commit id
+       # @param [String] right_commit commit id
+       # @return [Array<MetaCommit::Contracts::Diff>]
+-      def meta(repo, left_commit, right_commit)
++      def examine_meta(repo, left_commit, right_commit)
+         diffs = []
+         commit_id_old = left_commit.oid
++      def examine_meta(repo, left_commit, right_commit)
+         diffs = []
+         commit_id_old = left_commit.oid
+         commit_id_new = right_commit.oid
+@@ -53,6 +54,10 @@ module MetaCommit::Changelog
+         end
+         diffs
+       end
++
++      def examine
++        'method to test'
++      end
+     end
+   end
+ end
+
+
+> dev/my_projects/meta_commit meta_commit message  
+- changes in method initialize 
+- changes in CommitDiffExaminer#examine_meta 
+- changes in method examine 
+```
 
 ### Index
 
     meta_commit index [--directory=$(pwd)]
 
-Walks over repository commits and writes meta information to git notes
+Index command walks over the repository commits and writes meta information to storage.
+Currently the only supported storage adapter is git notes.
+So after execution of index command the new git notes will be added to your repository, you will be able to see them using standard `git log` command. 
+
+Example :
+
+```zsh
+> /repository_folder git log
+
+commit 1a8ba80e79e7c96fc06d3daf35bbad31cdaab5a4
+Author: Stanislav Dobrovolskiy <stasdobrovolskiy@gmail.com>
+Date:   Sat Mar 3 02:44:12 2018 +0100
+
+    `init` command implementation #9
+    - remove default config usage #9
+
+commit 352b0b3734cc8a940f2133ac73720fc7728e59e7
+Author: Stanislav Dobrovolskiy <stasdobrovolskiy@gmail.com>
+Date:   Sun Feb 25 22:15:52 2018 +0100
+
+    replace double quotes from note body
+
+
+> /repository_folder meta_commit index
+repository successfully indexed
+> /repository_folder git log
+
+commit 1a8ba80e79e7c96fc06d3daf35bbad31cdaab5a4
+Author: Stanislav Dobrovolskiy <stasdobrovolskiy@gmail.com>
+Date:   Sat Mar 3 02:44:12 2018 +0100
+
+    `init` command implementation #9
+    - remove default config usage #9
+
+Notes:
+     - changes in method fixture_configuration_file
+     - changes in method init
+     - changes in method boot_container_with_config
+     - change initialization of Errors::MissingConfigError
+
+commit 352b0b3734cc8a940f2133ac73720fc7728e59e7
+Author: Stanislav Dobrovolskiy <stasdobrovolskiy@gmail.com>
+Date:   Sun Feb 25 22:15:52 2018 +0100
+
+    replace double quotes from note body
+
+Notes:
+     - changes in GitNotes#write_to_notes
+     - changes in method write_to_notes
+```
 
 ### Changelog
 
     meta_commit changelog [--from-tag] [--to-tag] [--directory=$(pwd)] [--filename='CHANGELOG.md'] 
 
-Walks over commits between tags ``` from ``` and ``` to ``` and writes changes to changelog file
+This command walks over commits between ``` from ``` tag and ``` to ``` tag, examine changes and write them to changelog file
+
+Example :
+
+```zsh
+
+> /repository_folder meta_commit changelog v0.2.0 v0.3.0
+added version [v0.3.0] to CHANGELOG.md
+
+> /repository_folder cat CHANGELOG.md
+...
+
+## [v0.3.0] - 2018-03-03
+### Added
+- add Maintainability
+- create class SomeServiceNEWNAME
+- Configuration,DataObject added to SomeModule
+- changes in method meta
+- changes in method init
+- changes in method version
+- changes in method boot_container_with_config
+- changes in method load_builtin_extension
+- changes in method create_contextual_node
+- changes in method collect_path_to_ast_at_line
+- changes in method lines?
+- changes in method covers_line?
+- changes in method create_diff
+- changes in method change_context
+- changes in method organize_lines
+- changes in method write_to_notes
+- changes in method examine_diff
+- changes in method index_meta
+- changes in method compute_column
+### Changed
+- change README.md
+- change Inline docs
+- changes in CommitDiffExaminer#meta
+- change initialization of Errors::MissingConfigError
+- changes in ContextualAstNodeFactory#create_contextual_node
+- changes in ContextualAstNodeFactory#covers_line?
+- changes in DiffFactory#create_diff
+- changes in GitNotes#write_to_notes
+- changes in DiffExaminer#examine_diff
+- changes in DiffIndexExaminer#index_meta
+### Removed
+- changes in method meta
+- changes in method boot_container_with_config
+- changes in method create_ast_path
+- changes in method get_ast_at_line
+- changes in method covers_line
+- changes in method examine_diff
+- changes in method index_meta
+- remove module Models
+
+...
+
+```
+
+
+##  Extensions
+
+Extensions are very important part of meta_commit utility, they are used to parse source files and see difference between commits.
+Idea is that each extension should add new capabilities and knowledge on how to work with the new file extensions.
+Without extensions the meta_commit is just a script which traverses git repository and read files.
+
+[Here](https://github.com/usernam3/meta_commit/blob/master/CONTRIBUTING.md#creating-new-extension) you can get more information about how to create new extension. 

data/config/default.yml

@@ -1,4 +1,4 @@
-commands :
+commands:
   changelog:
     adapter: file
     formatter: keep_a_changelog
@@ -8,4 +8,4 @@ commands :
     formatter: commit_message
 
 extensions:
-  - builtin
+#{extensions}

data/exe/meta_commit

@@ -6,4 +6,7 @@ begin
     MetaCommit::ApplicationInterface.start( ARGV )
 rescue MetaCommit::Errors::MissingRepoError => e
     Thor.new.say(e.message)
+rescue MetaCommit::Errors::MissingConfigError => e
+    Thor.new.say(e.message)
+    Thor.new.say('Please, run `meta_commit init` to create configuration file')
 end

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

@@ -29,15 +29,23 @@ module MetaCommit::Changelog
           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)
+          column_where_changes_start = line.compute_column(old_file_content, new_file_content)
 
-          created_diff = @diff_factory.create_diff_of_type(line.line_origin, {
+          old_file_deleted = (patch.delta.new_file[:oid] == MetaCommit::Git::Repo::FILE_NOT_EXISTS_OID)
+          old_line_number = (old_file_deleted) ? (MetaCommit::Factories::ContextualAstNodeFactory::WHOLE_FILE) : (line.old_lineno)
+          old_contextual_ast = @ast_path_factory.create_contextual_node(old_file_ast, old_line_number)
+
+          new_file_created = (patch.delta.old_file[:oid] == MetaCommit::Git::Repo::FILE_NOT_EXISTS_OID)
+          new_line_number = (new_file_created) ? (MetaCommit::Factories::ContextualAstNodeFactory::WHOLE_FILE) : (line.new_lineno)
+          new_contextual_ast = @ast_path_factory.create_contextual_node(new_file_ast, new_line_number)
+
+          created_diff = @diff_factory.create_diff({
               :line => line,
+              :column => column_where_changes_start,
               :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_contextual_ast => old_contextual_ast,
+              :new_contextual_ast => new_contextual_ast,
               :old_file_path => old_file_path,
               :new_file_path => new_file_path,
           })

data/lib/meta_commit/cli.rb

@@ -70,13 +70,40 @@ module MetaCommit
       say('repository successfully indexed')
     end
 
+    desc 'init', 'add configuration file to project'
+    option :directory, :type => :string, :default => Dir.pwd
+    option :extensions, :type => :array, :default => ['builtin']
+
+    def init
+      repository_path = options[:directory]
+      extensions = options[:extensions]
+
+      config_file = File.join(repository_path, MetaCommit::ConfigurationStore::META_COMMIT_CONFIG_FILENAME)
+
+      return say('Configuration file exists. You repository is already meta_commit compatible.') if File.exist?(config_file)
+
+      template = File.read(MetaCommit::ConfigurationStore::TEMPLATE_FILE)
+      configuration = template.gsub(/\#{extensions}/, extensions.map {|extension| "  - #{extension}"}.join("\n"))
+
+      out_file = File.new(config_file, 'w')
+      out_file.puts(configuration)
+      out_file.close
+
+      say("The configuration file #{MetaCommit::ConfigurationStore::META_COMMIT_CONFIG_FILENAME} added")
+    end
+
+    desc 'version', 'prints meta_commit gem version'
+
+    def version
+      say(MetaCommit::VERSION)
+    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)
+        project_configuration = MetaCommit::Configuration.new.fill_from_yaml_file(configuration_path)
+        configuration_store = MetaCommit::ConfigurationStore.new(project_configuration)
 
         container = MetaCommit::Container.new
         container.boot(configuration_store)

data/lib/meta_commit/configuration_store.rb

@@ -3,7 +3,7 @@ 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')
+    TEMPLATE_FILE = File.join(META_COMMIT_HOME, 'config', 'default.yml')
     META_COMMIT_CONFIG_FILENAME = '.meta_commit.yml'
 
     # @param [MetaCommit::Configuration] configuration

data/lib/meta_commit/container.rb

@@ -3,6 +3,8 @@ module MetaCommit
   class Container
     include Dry::Container::Mixin
 
+    BUILTIN_EXTENSION = 'builtin'
+
     def initialize
       super
       register :parser_classes, []
@@ -37,10 +39,22 @@ module MetaCommit
         self[:parser_classes].concat(extension.parsers)
         self[:diff_classes].concat(extension.diffs)
       end
+      load_builtin_extension if extensions_to_load.include?(BUILTIN_EXTENSION)
     end
 
     protected :load_packages
 
+    def load_builtin_extension
+      require 'meta_commit/extensions/builtin'
+
+      extension = extension_class(camelize(without_extension_prefix('builtin'))).new
+
+      self[:parser_classes].concat(extension.parsers)
+      self[:diff_classes].concat(extension.diffs)
+    end
+
+    protected :load_builtin_extension
+
     # @param [Array<String>] extensions_to_load
     # @return [Array<String>]
     def required_extensions(extensions_to_load)

data/lib/meta_commit/errors.rb

@@ -5,7 +5,7 @@ module MetaCommit::Errors
     end
   end
   class MissingConfigError < StandardError
-    def initialize(msg='Passed config file does not exist')
+    def initialize(msg='Config file can not be found')
       super(msg)
     end
   end

data/lib/meta_commit/extensions/builtin.rb

@@ -0,0 +1,80 @@
+require 'meta_commit_contracts'
+
+module MetaCommit::Extension::Builtin
+  class Locator < MetaCommit::Contracts::Locator
+    def parsers
+      [Parser]
+    end
+
+    def diffs
+      [Diff]
+    end
+  end
+
+  class Ast < MetaCommit::Contracts::Ast
+    attr_reader :first_line, :last_line, :lines
+
+    def initialize(first_lineno, last_lineno, lines)
+      @first_line =first_lineno
+      @last_line = last_lineno
+      @lines = lines
+    end
+
+    def children
+      return [Ast.new(@first_line, @last_line, [])] if @lines.empty?
+      [Ast.new(@first_line+1, @last_line, @lines)]
+    end
+  end
+
+  class Parser < MetaCommit::Contracts::Parser
+    def self.supported_file_extensions
+      %w(txt md rb)
+    end
+
+    # @return [Boolean]
+    def self.supports_syntax?(source_code)
+      true
+    end
+
+    def parse(source_code)
+      lines = source_code.split("\n")
+      Ast.new(0, lines.length-1, lines)
+    end
+  end
+
+  class Diff < MetaCommit::Contracts::Diff
+    def string_representation
+      prefix = 'all file ' if change_context.new_contextual_ast.whole_file_change
+      column = " (C#{change_context.column})" unless change_context.column.nil?
+
+      "#{prefix}#{change_context.type} | in files #{change_context.old_file_path}:#{change_context.old_lineno} #{change_context.new_file_path}:#{change_context.new_lineno}#{column} | between commits #{change_context.commit_id_old} and #{change_context.commit_id_new}"
+    end
+
+    def supports_change(context)
+      true
+    end
+
+    def supports_parser?(parser)
+      [Parser].include?(parser)
+    end
+
+    def to_s
+      string_representation
+    end
+
+    # @return [Boolean]
+    def type_addition?
+      change_context.type == MetaCommit::Contracts::Diff::TYPE_ADDITION
+    end
+
+    # @return [Boolean]
+    def type_deletion?
+      change_context.type == MetaCommit::Contracts::Diff::TYPE_DELETION
+    end
+
+    # @return [Boolean]
+    def type_replace?
+      change_context.type == MetaCommit::Contracts::Diff::TYPE_REPLACE
+    end
+  end
+end

data/lib/meta_commit/factories/contextual_ast_node_factory.rb

@@ -1,17 +1,19 @@
 module MetaCommit::Factories
   # Factory that builds ContextualAstNode from ast nodes
   class ContextualAstNodeFactory
+    WHOLE_FILE = :whole_file_change
 
     # @param [MetaCommit::Contracts::Ast] source_ast
     # @param [Integer] line_number
     # @return [MetaCommit::Models::ContextualAstNode]
-    def create_ast_path(source_ast, line_number)
+    def create_contextual_node(source_ast, line_number)
       visited_nodes = []
-      ast_path = MetaCommit::Models::ContextualAstNode.new
-      ast_path.parser_class = source_ast.parser_class
-      ast_path.target_node = collect_path_to_ast_at_line(source_ast, line_number, visited_nodes)
-      ast_path.context_nodes = visited_nodes
-      ast_path
+      contextual_node = MetaCommit::Models::ContextualAstNode.new
+      contextual_node.parser_class = source_ast.parser_class
+      contextual_node.target_node = collect_path_to_ast_at_line(source_ast, line_number, visited_nodes)
+      contextual_node.context_nodes = visited_nodes
+      contextual_node.whole_file_change = (line_number == WHOLE_FILE)
+      contextual_node
     end
 
     # @param [MetaCommit::Contracts::Ast] ast
@@ -19,7 +21,9 @@ module MetaCommit::Factories
     # @param [Array<MetaCommit::Contracts::Ast>] accumulator
     # @return [MetaCommit::Contracts::Ast]
     def collect_path_to_ast_at_line(ast, lineno, accumulator)
-      return nil if ast.nil? or not covers_line(ast, lineno)
+      return ast if lineno == WHOLE_FILE
+      return nil if ast.nil? || (lines?(ast) && !covers_line?(ast, lineno))
+
       closest_ast = ast
       accumulator.push(closest_ast)
       ast.children.each do |child|
@@ -33,29 +37,22 @@ module MetaCommit::Factories
 
 
     # @param [MetaCommit::Contracts::Ast] ast
-    # @param [Integer] lineno
-    # @return [MetaCommit::Contracts::Ast]
-    def get_ast_at_line(ast, lineno)
-      return nil unless covers_line(ast, lineno)
-      closest_ast = ast
-      ast.children.each do |child|
-        found_ast = get_ast_at_line(child, lineno)
-        closest_ast = found_ast unless found_ast.nil?
-      end
-      closest_ast
+    # @return [Boolean]
+    def lines?(ast)
+      !(ast.first_line.nil? && ast.last_line.nil?)
     end
 
-    protected :get_ast_at_line
+    protected :lines?
 
 
     # @param [MetaCommit::Contracts::Ast] ast
     # @param [Integer] line
     # @return [Boolean]
-    def covers_line(ast, line)
-      return false if ((ast.first_line.nil?) && (ast.last_line.nil?))
-      ((ast.first_line <= line) && (ast.last_line >= line))
+    def covers_line?(ast, line)
+      (ast.first_line <= line) && (ast.last_line >= line)
     end
 
-    protected :covers_line
+    protected :covers_line?
+
   end
 end

data/lib/meta_commit/factories/diff_factory.rb

@@ -4,34 +4,45 @@ module MetaCommit::Factories
   class DiffFactory
     attr_accessor :available_diff_classes
 
+    # @param [Array<Class>] diff_classes
     def initialize(diff_classes)
       @available_diff_classes = diff_classes
     end
 
     # Factory method
-    # @param [Symbol] type
     # @param [Hash] options
     # @return [Diff, nil] created diff or nil if matched diff not found
-    def create_diff_of_type(type, options)
+    def create_diff(options)
+      context = change_context(options)
       @available_diff_classes.each do |diff_class|
         diff = diff_class.new
-        if diff.supports_parser?(options[:old_ast_path].parser_class) &&
-            diff.supports_parser?(options[:new_ast_path].parser_class) &&
-            diff.supports_change(type, options[:old_file_path], options[:new_file_path], options[:old_ast_path], options[:new_ast_path])
-          line = options[:line]
-          diff.diff_type = line.line_origin
-          diff.commit_old = options[:commit_id_old]
-          diff.commit_new = options[:commit_id_new]
-          diff.old_file = options[:old_file_path]
-          diff.new_file = options[:new_file_path]
-          diff.old_lineno = line.old_lineno
-          diff.new_lineno = line.new_lineno
-          diff.old_ast_path = options[:old_ast_path]
-          diff.new_ast_path = options[:new_ast_path]
+        if diff.supports_parser?(context.old_contextual_ast.parser_class) &&
+            diff.supports_parser?(context.new_contextual_ast.parser_class) &&
+            diff.supports_change(context)
+          diff.change_context = context
           return diff
         end
       end
       nil
     end
+
+    private
+    # Convert hash to context object
+    # @param [Hash] options
+    # @return [MetaCommit::Contracts::ChangeContext]
+    def change_context(options)
+      context = MetaCommit::Contracts::ChangeContext.new
+      context.type = options[:line].line_origin
+      context.old_lineno = options[:line].old_lineno
+      context.new_lineno = options[:line].new_lineno
+      context.column = options[:column]
+      context.commit_id_old = options[:commit_id_old]
+      context.commit_id_new = options[:commit_id_new]
+      context.old_contextual_ast = options[:old_contextual_ast]
+      context.new_contextual_ast = options[:new_contextual_ast]
+      context.old_file_path = options[:old_file_path]
+      context.new_file_path = options[:new_file_path]
+      context
+    end
   end
 end

data/lib/meta_commit/git/repo.rb

@@ -159,13 +159,15 @@ module MetaCommit::Git
 
           line_to_walk = MetaCommit::Models::Line.new
           if is_replace_change
-            line_to_walk.line_origin=:replace
-            line_to_walk.old_lineno=line.old_lineno
-            line_to_walk.new_lineno=next_line.new_lineno
+            line_to_walk.line_origin = :replace
+            line_to_walk.old_lineno = line.old_lineno
+            line_to_walk.new_lineno = next_line.new_lineno
+            line_to_walk.content_offset = next_line.content_offset
           else
-            line_to_walk.line_origin=line.line_origin
-            line_to_walk.old_lineno=line.old_lineno
-            line_to_walk.new_lineno=line.new_lineno
+            line_to_walk.line_origin = line.line_origin
+            line_to_walk.old_lineno = line.old_lineno
+            line_to_walk.new_lineno = line.new_lineno
+            line_to_walk.content_offset = line.content_offset
           end
           if is_replace_change
             skip_next_line = true

data/lib/meta_commit/index/adapters/git_notes.rb

@@ -25,7 +25,9 @@ module MetaCommit::Index
       # @param [String] commit_id
       # @param [String] message
       def write_to_notes(commit_id, message)
-        system("git --git-dir '#{@git_folder_path}' notes add -f -m '#{message}' #{commit_id}")
+        msg = message.gsub('"', '')
+        return if msg.empty?
+        system("git --git-dir '#{@git_folder_path}' notes add -f -m \"#{msg}\" #{commit_id}")
       end
 
       protected :write_to_notes

data/lib/meta_commit/index/commands/diff_examiner.rb

@@ -12,6 +12,7 @@ module MetaCommit::Index
 
       # Creates diff objects with meta information of changes in repository commits
       # @param [MetaCommit::Git::Repo] repo
+      # @return [MetaCommit::Models::Changes::Repository]
       def meta(repo)
         repo_changes = MetaCommit::Models::Changes::Repository.new(repo.path)
         repo.walk_by_commits do |left_commit, right_commit|
@@ -35,15 +36,23 @@ module MetaCommit::Index
           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)
+          column_where_changes_start = line.compute_column(old_file_content, new_file_content)
 
-          created_diff = @diff_factory.create_diff_of_type(line.line_origin, {
+          old_file_deleted = (patch.delta.new_file[:oid] == MetaCommit::Git::Repo::FILE_NOT_EXISTS_OID)
+          old_line_number = (old_file_deleted) ? (MetaCommit::Factories::ContextualAstNodeFactory::WHOLE_FILE) : (line.old_lineno)
+          old_contextual_ast = @ast_path_factory.create_contextual_node(old_file_ast, old_line_number)
+
+          new_file_created = (patch.delta.old_file[:oid] == MetaCommit::Git::Repo::FILE_NOT_EXISTS_OID)
+          new_line_number = (new_file_created) ? (MetaCommit::Factories::ContextualAstNodeFactory::WHOLE_FILE) : (line.new_lineno)
+          new_contextual_ast = @ast_path_factory.create_contextual_node(new_file_ast, new_line_number)
+
+          created_diff = @diff_factory.create_diff({
               :line => line,
+              :column => column_where_changes_start,
               :commit_id_old => left_commit.oid,
               :commit_id_new => right_commit.oid,
-              :old_ast_path => old_ast_path,
-              :new_ast_path => new_ast_path,
+              :old_contextual_ast => old_contextual_ast,
+              :new_contextual_ast => new_contextual_ast,
               :old_file_path => old_file_path,
               :new_file_path => new_file_path,
           })

data/lib/meta_commit/message/commands/diff_index_examiner.rb

@@ -27,15 +27,23 @@ module MetaCommit::Message
           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)
+          column_where_changes_start = line.compute_column(old_file_content, new_file_content)
 
-          created_diff = @diff_factory.create_diff_of_type(line.line_origin, {
+          old_file_deleted = (patch.delta.new_file[:oid] == MetaCommit::Git::Repo::FILE_NOT_EXISTS_OID)
+          old_line_number = (old_file_deleted) ? (MetaCommit::Factories::ContextualAstNodeFactory::WHOLE_FILE) : (line.old_lineno)
+          old_contextual_ast = @ast_path_factory.create_contextual_node(old_file_ast, old_line_number)
+
+          new_file_created = (patch.delta.old_file[:oid] == MetaCommit::Git::Repo::FILE_NOT_EXISTS_OID)
+          new_line_number = (new_file_created) ? (MetaCommit::Factories::ContextualAstNodeFactory::WHOLE_FILE) : (line.new_lineno)
+          new_contextual_ast = @ast_path_factory.create_contextual_node(new_file_ast, new_line_number)
+
+          created_diff = @diff_factory.create_diff({
               :line => line,
+              :column => column_where_changes_start,
               :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_contextual_ast => old_contextual_ast,
+              :new_contextual_ast => new_contextual_ast,
               :old_file_path => old_file_path,
               :new_file_path => new_file_path,
           })

data/lib/meta_commit/models/contextual_ast_node.rb

@@ -1,9 +1,4 @@
 module MetaCommit::Models
-  # Stores specific node from ast and all nodes bypassed on the way to target node
-  # @attr [MetaCommit::Contracts::Ast] target_node Target node from AST
-  # @attr [Array<MetaCommit::Contracts::Ast>] context_nodes Nodes bypassed on the way to target node
-  # @attr [Class] parser_class
-  class ContextualAstNode
-    attr_accessor :target_node, :context_nodes, :parser_class
+  class ContextualAstNode < MetaCommit::Contracts::ContextualAst
   end
 end

data/lib/meta_commit/models/line.rb

@@ -1,5 +1,30 @@
 module MetaCommit::Models
   class Line
-    attr_accessor :line_origin, :old_lineno, :new_lineno
+    attr_accessor :line_origin, :old_lineno, :new_lineno, :content_offset
+
+    # Compares old_lineno line of old_file_content and new_lineno of new_file_content
+    # @param [String] old_file_content
+    # @param [String] new_file_content
+    # @return [Numeric, Nil] index of first different symbol in string
+    def compute_column(old_file_content, new_file_content)
+      return if old_file_content.empty? || new_file_content.empty?
+      return if old_lineno == -1 || new_lineno == -1
+
+      old_file_lines = old_file_content.lines.map(&:chomp)
+      old_file_lines = old_file_lines.push('') if old_file_content.end_with?("\n")
+      old_line = old_file_lines[old_lineno - 1]
+
+      new_file_lines = new_file_content.lines.map(&:chomp)
+      new_file_lines = new_file_lines.push('') if new_file_content.end_with?("\n")
+      new_line = new_file_lines[new_lineno - 1]
+
+      return if old_line.empty? || new_line.empty?
+
+      old_line.each_char.with_index do |char, index|
+        return index if (char != new_line[index])
+      end
+
+      old_line.length
+    end
   end
 end

data/lib/meta_commit/version.rb

@@ -1,3 +1,3 @@
 module MetaCommit
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/meta_commit.gemspec

@@ -18,16 +18,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "meta_commit_contracts", "~> 0.1.0"
+  spec.add_runtime_dependency "meta_commit_contracts", "~> 0.1"
   spec.add_runtime_dependency "rugged", "~> 0.25"
   spec.add_runtime_dependency "dry-container", "~> 0.6.0"
-  spec.add_runtime_dependency "parser", "~> 2.4"
   spec.add_runtime_dependency "thor", "~> 0.19"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "cucumber", "~> 2.4.0"
+  spec.add_development_dependency "cucumber", "~> 2.4"
   spec.add_development_dependency "aruba", "~> 0.14.2"
   spec.add_development_dependency "rspec-mocks", "~> 3.6"
   spec.add_development_dependency "byebug", "~> 9.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meta_commit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stanislav Dobrovolskiy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meta_commit_contracts
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +210,7 @@ files:
 - lib/meta_commit/configuration_store.rb
 - lib/meta_commit/container.rb
 - lib/meta_commit/errors.rb
+- lib/meta_commit/extensions/builtin.rb
 - lib/meta_commit/factories/contextual_ast_node_factory.rb
 - lib/meta_commit/factories/diff_factory.rb
 - lib/meta_commit/factories/parser_factory.rb
@@ -260,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Enrich commit diffs with programing language insights