git-recommend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd37e6d5a0899d26e9477ae487f378b70e823f00
+  data.tar.gz: 2bf08d57c099aa33531424a8866f2a8506f78588
+SHA512:
+  metadata.gz: d73be1af4a07f28df93d165294d75b4a5099915b0b2145941beb43b137439006fd9429c2d8b147984f01a64599308ecaa003e00b813fd8d03be5d1dbcb4040da
+  data.tar.gz: b927bed5b8af7e4c8e67504ad92cfe4a2b530cdcc72b603b4a2e890efb3e48727581768bf89e48f2ebe62a9fd7da189b1fd6cfdf57fb83cd059dfa5d880e20ad

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mail@thomasrolfsnes.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thomas Rolfsnes
+
+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,41 @@
+# Git::Recommend
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/recommend`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git-recommend'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-recommend
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-recommend. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "git/recommend"
+
+# 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/git-recommend

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+require 'thor'
+require 'evoc'
+require 'vcs2json'
+require 'highline'
+
+class GitRecommend < Thor
+
+  DEFAULT_HISTORY = '.history'
+  @@in_git_repo = File.exist?('.git')
+
+  default_task :change
+  # history options
+  method_option :number, :aliases => '-n', type: :numeric, default: 10000, :desc => "The number of commits to dump"
+  # recommendation options
+  method_option :query, aliases: '-q', type: :array, required: false, desc: "Space separated list of query items"
+  method_option :query_from_file, aliases: '-f', type: :string, required: false, desc: "File with new-line separated list of query items"
+  method_option :staged, aliases: '-s', type: :boolean, required: false, desc: "Use staged files to generate recommendation"
+  method_option :unstaged, aliases: '-u', type: :boolean, required: false, desc: "Use unstaged files to generate recommendation"
+  method_option :history, :aliases => '-h', :type => :string, default: DEFAULT_HISTORY, :desc => "Path to change-history"
+  method_option :algorithm, :default => 'tarmaq0', :desc => "Which algorithm to use"
+  method_option :aggregator, :default => 'cg', :desc => "Which aggregator to use"
+  method_option :measures, aliases: '-m', type: :array, default: ['support','confidence'], desc: "Order rules on the given measures, presedence from left to right"
+  method_option :max_size, type: :numeric, default: 30, desc: "The maximum size of commits that should be considered when looking for patterns"
+  method_option :model_size, type: :numeric, default: 0, desc: "How many previous commits to consider when looking for patterns"
+  desc "change", ""
+  def change
+    # Initialize query
+    q = []
+    staged = (@@in_git_repo ? `git diff --cached --name-only`.split("\n") : [])
+    unstaged = (@@in_git_repo ? `git diff --name-only`.split("\n") : [])
+    from_command_line = (options[:query].nil? ? [] : options[:query])
+    from_file = if options[:query_from_file].nil?
+                  [] 
+                else
+                  if File.exist?(options[:query_from_file])
+                    File.read(options[:query_from_file]).split("\n")
+                  else
+                    $stderr.puts "No file found at #{options[:query_from_file]}"
+                    []
+                  end
+                end
+
+    # default to locally changed files
+    if [:staged,:unstaged,:query,:query_from_file].all? {|k| options[k].nil?}
+      if @@in_git_repo
+        q =  (staged | unstaged)
+        $stderr.puts "[default] Change recommendation based on the currently changed files\n"
+      end
+    else
+      staged = (options[:staged].nil? ? [] : staged)
+      unstaged = (options[:staged].nil? ? [] : unstaged)
+      q = (staged | unstaged | from_command_line | from_file)
+    end
+
+    # Initialize history
+    if !File.exists?(options[:history])
+      exit unless HighLine.new.agree("To recommend changes, a history cache needs to be generated, do you want to generate the default cache now? Run 'git recommend help update' for more options.")
+      GitRecommend.start(["update"])
+    end
+    # could do some validation here
+    h = Evoc::HistoryStore.initialize(path: options[:history])
+    if q.size > 0
+      $stderr.puts "Generating change recommendation for #{q.size} items"
+      q_tx = Evoc::Tx.new(id: 'query',date: Time.now, items: q)
+      h.base_history << q_tx
+
+      s = Evoc::Scenario.new({query: q_tx.items,
+                              tx_index: q_tx.index,
+                              tx_id: q_tx.id,
+                              model_size: options[:model_size],
+                              algorithm: options[:algorithm],
+                              aggregator: options[:aggregator],
+                              max_size: options[:max_size],
+                              measures: options[:measures]})
+      s.call
+      s.print
+    else
+      $stderr.puts "No changed files detected. Change some files or run with --help for more options."
+    end
+  end
+
+  method_option :after, :aliases => '-a', :desc => "Only include commits after this date"
+  method_option :before, :aliases => '-b', :desc => "Only include commits before this date"
+  method_option :number, :aliases => '-n', type: :numeric, default: 10000, :desc => "The number of commits to dump"
+  method_option :fine_grained, type: :boolean, default: true, desc: "Include fine grained change information in output"
+  method_option :ignore_comments, type: :boolean, default: false, desc: "Ignore comments when calculating diffs. Only in effect for fine grained changes."
+  method_option :ignore_whitespace, type: :boolean, default: false, desc: "Ignore whitespace when calculating diffs. Only in effect for fine grained changes."
+  method_option :residuals, type: :boolean, default: true, desc: "Consider changes that happen outside of methods"
+  desc "update", "Update/Create the history used for generating recommendations"
+  def update
+    if @@in_git_repo
+      if File.exists?(DEFAULT_HISTORY)
+        exit unless HighLine.new.agree("History already exists, do you want to replace it?")
+      end
+      $stderr.puts "Generating new history cache to #{DEFAULT_HISTORY}, this may take a while."
+      old_stdout = $stdout              # backup old stdout
+      $stdout.reopen(DEFAULT_HISTORY, 'w')   # redirect stdout to file
+      Vcs2Json::Git.new(options).parse  # write history
+      $stdout = STDOUT              # restore stdout
+    else
+      $stderr.puts "Need to be in a git repository to generate history cache."
+    end
+  end
+end
+
+GitRecommend.start(ARGV)
+

data/bin/setup

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

data/git-recommend.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git/recommend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-recommend"
+  spec.version       = Git::Recommend::VERSION
+  spec.authors       = ["Thomas Rolfsnes"]
+  spec.email         = ["mail@thomasrolfsnes.com"]
+
+  spec.summary       = %q{Generate change recommendations from your git change history}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["git-recommend"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "evoc"
+  spec.add_runtime_dependency "vcs2json"
+  spec.add_runtime_dependency "highline"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/git/recommend/version.rb

@@ -0,0 +1,5 @@
+module Git
+  module Recommend
+    VERSION = "0.1.0"
+  end
+end

data/lib/git/recommend.rb

@@ -0,0 +1,7 @@
+require "git/recommend/version"
+
+module Git
+  module Recommend
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: git-recommend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Rolfsnes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcs2json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mail@thomasrolfsnes.com
+executables:
+- git-recommend
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/git-recommend
+- bin/setup
+- git-recommend.gemspec
+- lib/git/recommend.rb
+- lib/git/recommend/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generate change recommendations from your git change history
+test_files: []