meta_commit 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a91401c347971a081402085e903f5f38e481dec2
+  data.tar.gz: e3baa26014b744d0f3a0f3bf65bef1096588d6ff
+SHA512:
+  metadata.gz: e4853da029ca727831f4c6e12ce8b3daaa637ae9aed11d3a6e76f25348682a9776c15d33cade68fa3e5771ba4f08ed6199f997fdd12834825cdc5051a298a786
+  data.tar.gz: d7321d80c6bf1377633f889d829ca7379039b019948c0931c24cf1f901b84f8402ea0a5df72e30bb7539182f3c86f6b57d8b2fefb1095de6501ba0f6dd03cd13

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in meta_commit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stanislav Dobrovolskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# meta commit
+
+>   Enrich commit diffs with programing language insights
+
+
+## Description
+
+[![v0.1 demonstration](https://asciinema.org/a/6nlvujsgeoa1xtp9l9qhx8lry.png)](https://asciinema.org/a/6nlvujsgeoa1xtp9l9qhx8lry?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.
+
+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. 
+
+
+## Installing meta_commit
+
+You can install gem with the following command in a terminal:
+
+    $ gem install meta_commit
+
+
+## Usage
+
+### Message
+
+``` meta_commit message [--repo=$(pwd)] ```
+
+Prints description of current changes in repository index
+
+### Index
+
+``` meta_commit index [--branch=master] [--repo=$(pwd)] ```
+
+Walks over repository commits and writes meta information to git notes
+
+### Changelog (NOT IMPLEMENTED)
+
+``` meta_commit changelog [--from] [--to] [--repo=$(pwd)] ```
+
+Walks over commits between tags ``` from ``` and ``` to ``` and writes main changes to changelog.md

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "meta_commit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/meta_commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -wU -W0
+
+require 'meta_commit'
+
+MetaCommit::ApplicationInterface.start( ARGV )

data/lib/meta_commit/adapters/dump.rb

@@ -0,0 +1,31 @@
+module MetaCommit::Adapters
+  class Dump
+    attr_accessor :repository, :commit, :file
+
+    def initialize
+
+    end
+
+    def write_repository_change_chunk(repository_change)
+      puts '---'
+      puts "repo id: #{repository_change.repo_id}"
+      puts '---'
+    end
+
+    def write_commit_change_chunk(commit_change)
+      puts "> commit : #{commit_change.commit_id}"
+    end
+
+    def write_file_change_chunk(file_change)
+      puts "file : #{file_change.file_path}"
+    end
+
+    def write_diff(diff)
+      puts " - #{diff}"
+    end
+
+    def write_lines
+
+    end
+  end
+end

data/lib/meta_commit/adapters/git_notes.rb

@@ -0,0 +1,28 @@
+module MetaCommit::Adapters
+  class GitNotes
+    attr_accessor :repository, :commit, :file
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def write_repository_change_chunk(repository, repository_changes)
+      repository_changes.each do |commit_changes|
+        diffs=[]
+        commit_changes.each do |file_changes|
+          uniques_file_changes = file_changes.changes.uniq { |diff| diff.to_s }
+          uniques_file_changes.each do |diff|
+            diffs.push(" - #{diff.string_representation}")
+          end
+        end
+        write_to_notes(repository.path, commit_changes.new_commit_id, diffs.join("\n"))
+      end
+    end
+
+    def write_to_notes(repo_path, commit_id, message)
+      # @TODO escape command
+      # @TODO add --ref=meta_commit
+      system("git --git-dir '#{repo_path}' notes add -f -m '#{message}' #{commit_id}")
+    end
+  end
+end

data/lib/meta_commit/cli.rb

@@ -0,0 +1,32 @@
+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
+      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)
+    end
+
+    desc 'changelog', 'IS NOT IMPLEMENTED'
+    def changelog(path=nil)
+      raise('IS NOT IMPLEMENTED')
+    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
+      repository = MetaCommit::Git::Repo.new(repository_path)
+      examiner = MetaCommit::Services::DiffExaminer.new(repository)
+      meta = examiner.meta
+      change_saver = MetaCommit::Services::ChangeSaver.new(repository)
+      change_saver.store_meta(meta)
+      say('repository successfully indexed')
+    end
+  end
+end

data/lib/meta_commit/git/repo.rb

@@ -0,0 +1,60 @@
+require 'rugged'
+
+module MetaCommit::Git
+  class Repo
+    attr_accessor :repo
+
+    def initialize(repo_path)
+      @repo = Rugged::Repository.new(repo_path)
+    end
+
+    def walker
+      walker = Rugged::Walker.new(@repo)
+      walker.sorting(Rugged::SORT_REVERSE)
+      walker.push(@repo.last_commit.oid)
+      walker
+    end
+
+    def walk_by_commits
+      walker = Rugged::Walker.new(@repo)
+      walker.sorting(Rugged::SORT_REVERSE)
+      walker.push(@repo.last_commit.oid)
+      previous_commit = nil
+      walker.each do |current_commit|
+        # skip first commit
+        previous_commit = current_commit if previous_commit.nil?
+        next if previous_commit == current_commit
+        yield(previous_commit, current_commit)
+        previous_commit = current_commit
+      end
+    end
+
+    def diff(left, right, options)
+      @repo.diff(left, right, options)
+    end
+
+    def index_diff(options)
+      @repo.index.diff(@repo.head.target.tree, options)
+    end
+
+    def get_blob_at(revision, path, default = nil)
+      blob = @repo.blob_at(revision, path)
+      return blob.content unless blob.nil?
+      default
+    end
+
+    def get_content_of(rel_repo_file_path, default = nil)
+      absolute_file_path = @repo.path.reverse.sub('/.git'.reverse, '').reverse + rel_repo_file_path
+      begin
+        content = open(absolute_file_path).read
+      rescue Errno::ENOENT
+        content = default
+      end
+      content
+    end
+
+    def path
+      @repo.path
+    end
+  end
+end

data/lib/meta_commit/models/ast_path.rb

@@ -0,0 +1,111 @@
+module MetaCommit::Models
+  class AstPath
+    attr_accessor :ast, :path
+
+    # region helpers
+    def is_module_definition?(node)
+      node.type == :module
+    end
+
+    def is_class_definition?(node)
+      node.type == :class
+    end
+
+    def is_method_definition?(node)
+      node.type == :def
+    end
+
+    def extract_module_name(node)
+      node.children.first.children.last.to_s
+    end
+
+    def extract_class_name(node)
+      node.children.first.children.last.to_s
+    end
+
+    def extract_method_name(node)
+      node.children.first.to_s
+    end
+
+    def empty_ast?
+      @ast.nil?
+    end
+
+    # endregion
+
+    # region external helpers
+    def is_module?
+      @ast.type == :module
+    end
+
+    def is_class?
+      @ast.type == :class
+    end
+
+    def is_method?
+      @ast.type == :def
+    end
+
+    # on created class only first line goes to diff
+    def is_name_of_class?
+      (@ast.type == :const) and (@path.length > 1) and (@path[@path.length - 1 - 1].type == :class)
+    end
+
+    # on created module only first line goes to diff
+    def is_name_of_module?
+      (@ast.type == :const) and (@path.length > 1) and (@path[@path.length - 1 - 1].type == :module)
+    end
+
+    def module_name
+      @ast.children.first.children.last.to_s
+    end
+
+    def class_name
+      @ast.children.first.children.last.to_s
+    end
+
+    def method_name
+      @ast.children.first.to_s
+    end
+
+    def name_of_context_module
+      @path.reverse.each do |parent|
+        return extract_module_name(parent) if is_module_definition?(parent)
+      end
+    end
+
+    def name_of_context_class
+      @path.reverse.each do |parent|
+        return extract_class_name(parent) if is_class_definition?(parent)
+      end
+    end
+
+    def name_of_context_method
+      @path.reverse.each do |parent|
+        return extract_method_name(parent) if is_method_definition?(parent)
+      end
+    end
+
+    def is_in_context_of_module?
+      @path.each do |parent|
+        return true if is_module_definition?(parent)
+      end
+      false
+    end
+
+    def is_in_context_of_class?
+      @path.each do |parent|
+        return true if is_class_definition?(parent)
+      end
+      false
+    end
+
+    def is_in_context_of_method?
+      @path.each do |parent|
+        return true if is_method_definition?(parent)
+      end
+      false
+    end
+    # endregion
+  end
+end

data/lib/meta_commit/models/changes/commit.rb

@@ -0,0 +1,27 @@
+module MetaCommit::Models::Changes
+  class Commit
+    attr_accessor :old_commit_id, :new_commit_id, :file_changes
+
+    def initialize(old_commit_id, new_commit_id)
+      @old_commit_id = old_commit_id
+      @new_commit_id = new_commit_id
+      @file_changes = []
+    end
+
+    def push(file_change)
+      @file_changes.push(file_change)
+    end
+
+    def commit_id
+      if @old_commit_id == @new_commit_id
+        @new_commit_id
+      else
+        "#{@old_commit_id} -> #{@new_commit_id}"
+      end
+    end
+
+    def each(&block)
+      @file_changes.each(&block)
+    end
+  end
+end

data/lib/meta_commit/models/changes/file.rb

@@ -0,0 +1,27 @@
+module MetaCommit::Models::Changes
+  class File
+    attr_accessor :old_file_path, :new_file_path, :changes
+
+    def initialize(old_file_path, new_file_path)
+      @old_file_path = old_file_path
+      @new_file_path = new_file_path
+      @changes = []
+    end
+
+    def push(change)
+      @changes.push(change)
+    end
+
+    def file_path
+      if @new_file_path == @new_file_path
+        @new_file_path
+      else
+        "#{@old_file_path} -> #{@new_file_path}"
+      end
+    end
+
+    def each(&block)
+      @changes.each(&block)
+    end
+  end
+end

data/lib/meta_commit/models/changes/repository.rb

@@ -0,0 +1,18 @@
+module MetaCommit::Models::Changes
+  class Repository
+    attr_accessor :repo_id, :commit_changes
+
+    def initialize(repo_id)
+      @repo_id = repo_id
+      @commit_changes = []
+    end
+
+    def push(commit_change)
+      @commit_changes.push(commit_change)
+    end
+
+    def each(&block)
+      @commit_changes.each(&block)
+    end
+  end
+end

data/lib/meta_commit/models/diffs/addition.rb

@@ -0,0 +1,34 @@
+module MetaCommit::Models::Diffs
+  class Addition < Diff
+    def string_representation
+      action = 'created'
+      if @new_ast_path.is_class?
+        if @new_ast_path.is_in_context_of_module?
+          return "#{action} #{new_ast_path.name_of_context_module}::#{new_ast_path.class_name}"
+        end
+        return "#{action} class #{new_ast_path.class_name}"
+      end
+      if @new_ast_path.is_name_of_class?
+        if @new_ast_path.is_in_context_of_module?
+          return "#{action} #{new_ast_path.name_of_context_module}::#{new_ast_path.name_of_context_class}"
+        end
+        return "#{action} class #{new_ast_path.name_of_context_class}"
+      end
+      if @new_ast_path.is_method?
+        if @new_ast_path.is_in_context_of_class?
+          return "#{action} #{new_ast_path.name_of_context_class}##{new_ast_path.method_name}"
+        end
+        if @new_ast_path.is_in_context_of_module?
+          if @new_ast_path.is_in_context_of_class?
+            return "#{action} #{new_ast_path.name_of_context_module}::#{new_ast_path.name_of_context_class}##{new_ast_path.method_name}"
+          end
+          return "#{action} #{new_ast_path.name_of_context_module}##{new_ast_path.method_name}"
+        end
+      end
+      if @new_ast_path.is_in_context_of_method?
+        return "changes in method #{@new_ast_path.name_of_context_method}"
+      end
+      'addition was performed'
+    end
+  end
+end

data/lib/meta_commit/models/diffs/changes_in_method.rb

@@ -0,0 +1,14 @@
+module MetaCommit::Models::Diffs
+  class ChangesInMethod < Diff
+    def supports_change(type, old_file_name, new_file_name, old_ast_path, new_ast_path)
+      type == MetaCommit::Models::Diffs::Diff::TYPE_REPLACE && !old_ast_path.empty_ast? && !new_ast_path.empty_ast? && old_ast_path.is_in_context_of_method? && new_ast_path.is_in_context_of_method?
+    end
+
+    def string_representation
+      if @new_ast_path.is_in_context_of_class?
+        return "changes in #{new_ast_path.name_of_context_class}##{new_ast_path.name_of_context_method}"
+      end
+      "changes in ##{new_ast_path.name_of_context_method}"
+    end
+  end
+end

data/lib/meta_commit/models/diffs/class_creation.rb

@@ -0,0 +1,20 @@
+module MetaCommit::Models::Diffs
+  class ClassCreation < Diff
+    def supports_change(type, old_file_name, new_file_name, old_ast_path, new_ast_path)
+      type == MetaCommit::Models::Diffs::Diff::TYPE_ADDITION && !new_ast_path.empty_ast? && (new_ast_path.is_class? || new_ast_path.is_name_of_class?)
+    end
+
+    def string_representation
+      if @new_ast_path.is_class?
+        if @new_ast_path.is_in_context_of_module?
+          return "created #{new_ast_path.name_of_context_module}::#{new_ast_path.class_name}"
+        end
+        return "created class #{new_ast_path.class_name}"
+      end
+      if @new_ast_path.is_in_context_of_module?
+        return "created #{new_ast_path.name_of_context_module}::#{new_ast_path.name_of_context_class}"
+      end
+      "created class #{new_ast_path.name_of_context_class}"
+    end
+  end
+end

data/lib/meta_commit/models/diffs/class_deletion.rb

@@ -0,0 +1,16 @@
+module MetaCommit::Models::Diffs
+  class ClassDeletion < Diff
+    def supports_change(type, old_file_name, new_file_name, old_ast_path, new_ast_path)
+      type == MetaCommit::Models::Diffs::Diff::TYPE_DELETION && !old_ast_path.empty_ast? && (old_ast_path.is_class? || old_ast_path.is_name_of_class?)
+    end
+
+    def string_representation
+      if @old_ast_path.is_class?
+        if @old_ast_path.is_in_context_of_module?
+          return "removed class #{old_ast_path.class_name} from module #{old_ast_path.name_of_context_module}"
+        end
+      end
+      "removed class #{old_ast_path.name_of_context_class}"
+    end
+  end
+end

data/lib/meta_commit/models/diffs/class_rename.rb

@@ -0,0 +1,11 @@
+module MetaCommit::Models::Diffs
+  class ClassRename < Diff
+    def supports_change(type, old_file_name, new_file_name, old_ast_path, new_ast_path)
+      type == MetaCommit::Models::Diffs::Diff::TYPE_REPLACE && !old_ast_path.nil? && !new_ast_path.nil? && old_ast_path.is_name_of_class? && new_ast_path.is_name_of_class?
+    end
+
+    def string_representation
+      "renamed class #{old_ast_path.name_of_context_class} to #{new_ast_path.name_of_context_class}"
+    end
+  end
+end

data/lib/meta_commit/models/diffs/deletion.rb

@@ -0,0 +1,37 @@
+module MetaCommit::Models::Diffs
+  class Deletion < Diff
+    def string_representation
+      action = 'removed'
+      if @old_ast_path.is_module?
+        return "#{action} module #{old_ast_path.module_name}"
+      end
+      if @old_ast_path.is_name_of_module?
+        return "#{action} module #{old_ast_path.name_of_context_module}"
+      end
+      if @old_ast_path.is_class?
+        if @_ast_path.is_in_context_of_module?
+          return "#{action} #{name_of_context_module}::#{new_ast_path.class_name}"
+        end
+        return "#{action} class #{old_ast_path.class_name}"
+      end
+      if @old_ast_path.is_name_of_class?
+        return "#{action} class #{old_ast_path.name_of_context_class}"
+      end
+      if @old_ast_path.is_method?
+        if @old_ast_path.is_in_context_of_class?
+          return "#{action} #{old_ast_path.name_of_context_class}##{old_ast_path.method_name}"
+        end
+        if @old_ast_path.is_in_context_of_module?
+          if @old_ast_path.is_in_context_of_class?
+            return "#{action} #{old_ast_path.name_of_context_module}::#{old_ast_path.name_of_context_class}##{old_ast_path.method_name}"
+          end
+          return "#{action} method #{old_ast_path.method_name} from module #{old_ast_path.name_of_context_module}"
+        end
+      end
+      if @old_ast_path.is_in_context_of_method?
+        return "changes in method #{@old_ast_path.name_of_context_method}"
+      end
+      'deletion was performed'
+    end
+  end
+end

data/lib/meta_commit/models/diffs/diff.rb

@@ -0,0 +1,34 @@
+module MetaCommit::Models::Diffs
+  class Diff
+
+    TYPE_ADDITION = :addition
+    TYPE_DELETION = :deletion
+    TYPE_REPLACE = :replace
+
+    attr_accessor :diff_type
+    attr_accessor :commit_old, :commit_new
+    attr_accessor :old_file, :new_file
+    attr_accessor :old_lineno, :new_lineno
+    attr_accessor :old_ast_path, :new_ast_path
+
+    def inspect
+      string_representation
+    end
+
+    def to_s
+      string_representation
+    end
+
+    def string_representation
+      "#{diff_type} was performed"
+    end
+
+    def supports_change_of_type(type)
+      true
+    end
+
+    def supports_change(type, old_file_name, new_file_name, old_ast_path, new_ast_path)
+      true
+    end
+  end
+end