adjutant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0472258513e3c3369e494a58541bf0a188bfdaaa
+  data.tar.gz: e243e326b12bda780a2a1e059da94e73c4431744
+SHA512:
+  metadata.gz: 164bc49749ec7d44ce8b509d9d9f78f7a511d7531a6a92d8ef6cdb5118e5922067de114020457cc44aabaf7603aa806a1e73cffe2a3ac83af57225223259ad2f
+  data.tar.gz: 81578b5de4adae18dfd822a7ac86b3b0f76d47295ccc2d09e043efb902a37732fd6ffbd66cdd7abe836cd6d3b65dbd82fa896259e8eb7e6737e6524fb6613b2a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.vimrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Baltazore
+
+MIT License
+
+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,29 @@
+# Adjutant
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'adjutant'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adjutant
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/adjutant/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/adjutant.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adjutant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adjutant"
+  spec.version       = Adjutant::VERSION
+  spec.authors       = ["Baltazore"]
+  spec.email         = ["baltazore92@gmail.com"]
+  spec.summary       = %q{Gem that help parse git patch data}
+  spec.description   = %q{Ruby Gem that parse patch data for comments and ToDo lists and paste them on GitHub PR.}
+  spec.homepage      = "http://baltazore.github.io/adjutant"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json",    "~> 1.7"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/adjutant/comment.rb

@@ -0,0 +1,30 @@
+module Adjutant
+  Comment = Struct.new(:text, :index) do
+    def initialize(*)
+      super
+      self.index ||= 0
+    end
+
+    def add(comment, index)
+      self.index = index + 1 if empty?
+      self.text =
+        if empty?
+          comment.to_s
+        else
+          self.text + "\\n" + comment
+        end
+    end
+
+    def empty?
+      self.text.nil? || self.text.empty?
+    end
+
+    def reset
+      self.text = nil
+    end
+
+    def print
+      [ self.text, self.index ]
+    end
+  end
+end

data/lib/adjutant/file_parser.rb

@@ -0,0 +1,50 @@
+module Adjutant
+  class FileParser
+
+    attr_reader :comment
+
+    def initialize(file)
+      @text = file[:patch]
+      @comment = Comment.new("")
+      @comments = []
+    end
+
+    def detect_comments
+      usefull = false
+      lines_pushed.each_with_index do |line, index|
+        line = Line.new(line)
+
+        if line.usefull? || usefull
+          usefull = true
+          parse_line(line, index)
+        else
+          push_comment
+          usefull = false
+
+          next
+        end
+      end
+      push_comment if usefull
+      @comments
+    end
+
+    def push_comment
+      @comments << @comment.print
+      @comment.reset
+    end
+
+    def parse_line(line, index)
+      if line.end_of_comment?
+        push_comment
+      else
+        @comment.add line.usefull_text, index
+      end
+    end
+
+    def lines_pushed
+      @text
+        .split(/(\n)/)
+        .delete_if { |e| e[0] != "+" }
+    end
+  end
+end

data/lib/adjutant/line.rb

@@ -0,0 +1,26 @@
+module Adjutant
+  Line = Struct.new(:line) do
+    COMMENT_SIGN = "#"
+    USERNAME_SIGN = "@"
+    TODO_LINE = "TODO:"
+
+    def usefull?() contain_comment? && point_of_interes? && new_added?  end
+
+    def contain_comment?()  line.scan(/\+\s*#{COMMENT_SIGN}/).any?  end
+
+    def point_of_interes?() contain_username? || contain_todo?      end
+    def contain_username?() line.scan(/(#{USERNAME_SIGN}\w+)/).any? end
+    def contain_todo?()     line.scan(/#{TODO_LINE}/).any?          end
+
+    def new_added?() line[0] == '+' end
+
+    def end_of_comment?() contain_comment?() ? empty_comment? : true        end
+    def empty_comment?()  line.scan(/\+\s*#{COMMENT_SIGN}\s*(\S+)/).empty?  end
+
+    def usefull_text
+      matched = line.scan(/\+\s*#\s*/).first
+      line[matched.size .. -1] unless matched.nil?
+    end
+
+  end
+end

data/lib/adjutant/version.rb

@@ -0,0 +1,3 @@
+module Adjutant
+  VERSION = "0.1.0"
+end

data/lib/adjutant.rb

@@ -0,0 +1,8 @@
+require 'adjutant/version'
+require 'adjutant/comment'
+require 'adjutant/line'
+require 'adjutant/file_parser'
+
+module Adjutant
+
+end

data/spec/adjutant/comment_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+RSpec.describe Adjutant::Comment do
+  let(:message) { "Hey there!" }
+  let(:index)   { 42 }
+
+  it 'creates an comment with given text' do
+    comment = Adjutant::Comment.new(message)
+    expect(comment.text).to eq(message)
+  end
+
+  describe '#empty?' do
+    it 'return false if text is present' do
+      comment = Adjutant::Comment.new(message)
+      expect(comment.empty?).to eq(false)
+    end
+
+    it 'return true if text is nil' do
+      comment = Adjutant::Comment.new
+      expect(comment.empty?).to eq(true)
+    end
+
+    it 'return true if text is empty' do
+      comment = Adjutant::Comment.new("")
+      expect(comment.empty?).to eq(true)
+    end
+  end
+
+  describe '#add' do
+    let(:part1)   { "Hello" }
+    let(:part2)   { "world!" }
+    let(:text)    { "Hello\\nworld!" }
+
+    it 'adds new text to empty comment' do
+      comment = Adjutant::Comment.new
+      comment.add(part1, 0)
+      expect(comment.text).to eq(part1)
+    end
+
+    it 'adds new text to comment with adding new line' do
+      comment = Adjutant::Comment.new(part1)
+      comment.add(part2, 0)
+      expect(comment.text).to eq(text)
+    end
+  end
+
+  describe '#reset' do
+    it 'is able to reset text for comment' do
+      comment = Adjutant::Comment.new(message)
+      expect(comment.text).to eq(message)
+      comment.reset
+      expect(comment.text).to eq(nil)
+    end
+  end
+
+  describe '#print' do
+    let(:message2) { "I'm here" }
+    it 'returns comemnt with default index to push as comment' do
+      comment = Adjutant::Comment.new(message)
+      expect(comment.print).to eq([message, 0])
+    end
+
+    it 'returns comemnt with first index to push as comment' do
+      comment = Adjutant::Comment.new
+      comment.add(message, index)
+      comment.add(message2, index+1)
+      expect(comment.print).to eq([message+"\\n"+message2, index+1])
+    end
+  end
+
+end

data/spec/adjutant/file_parser_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+RSpec.describe Adjutant::FileParser do
+
+  let(:file) do
+    { :patch => "@@ -0,0 +1,14 @@\n+# @Baltazore is trying to check first line comment\n+def super_method(such_args)\n \"Doge tutorial\"\nend\n# doing some stuff\n\"hello world\"\n+# @baltazore, Let's check multiline comments,\n+# them really rocks\n#\n+\n+# TODO:\n+# - [ ] This Github flavoured markdown\n+# - [ ] such nice\n+# - [ ] very exciting" }
+  end
+
+  let(:lines) do
+    [
+      "+# @Baltazore is trying to check first line comment",
+      "+def super_method(such_args)",
+      "+# @baltazore, Let's check multiline comments,",
+      "+# them really rocks",
+      "+",
+      "+# TODO:",
+      "+# - [ ] This Github flavoured markdown",
+      "+# - [ ] such nice",
+      "+# - [ ] very exciting",
+    ]
+  end
+
+  let(:comments) do
+    [
+      [ "@Baltazore is trying to check first line comment", 1 ],
+      [ "@baltazore, Let's check multiline comments,\\nthem really rocks", 3],
+      [ "TODO:\\n- [ ] This Github flavoured markdown\\n- [ ] such nice\\n- [ ] very exciting", 6 ]
+    ]
+  end
+  let(:file_parser) { Adjutant::FileParser.new(file) }
+
+  describe '#detect_comments' do
+    context '#lines_pushed' do
+      it 'returns all lines that has been pushed in commit' do
+        file_parser.lines_pushed.each_with_index do |line, index|
+          expect(line).to eq(lines[index])
+        end
+      end
+    end
+
+    context '#parse_line' do
+      it 'should create a comment from pushed lines' do
+        line = Adjutant::Line.new(lines[0])
+        file_parser.parse_line(line, 0)
+        expect(file_parser.comment.text).to eq(comments[0][0])
+      end
+    end
+
+    it 'returns all comment, that catch up' do
+      file_parser.detect_comments.each_with_index do |comment, index|
+        expect(comment).to eq(comments[index])
+      end
+    end
+  end
+
+end

data/spec/adjutant/line_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+RSpec.describe Adjutant::Line do
+  let(:comment) { "+# @baltazore don't forget to write specs!" }
+  let(:todo)    { "+    # TODO: write moar specs!" }
+  let(:empty)   { "+    #" }
+  let(:useless) { "class Line" }
+
+  describe '#usefull?' do
+
+    context '#contain_comment?' do
+      it 'return true if line contain comment' do
+        expect(Adjutant::Line.new(comment).contain_comment?).to eq(true)
+        expect(Adjutant::Line.new(todo).contain_comment?).to eq(true)
+        expect(Adjutant::Line.new(empty).contain_comment?).to eq(true)
+      end
+
+      it 'return false in other cases' do
+        expect(Adjutant::Line.new(useless).contain_comment?).to eq(false)
+      end
+    end
+
+    describe '#point_of_interes?' do
+
+      context '#contain_username' do
+        it 'return true if line contain username' do
+          expect(Adjutant::Line.new(comment).contain_username?).to eq(true)
+        end
+
+        it 'return false in other cases' do
+          expect(Adjutant::Line.new(todo).contain_username?).to eq(false)
+          expect(Adjutant::Line.new(empty).contain_username?).to eq(false)
+          expect(Adjutant::Line.new(useless).contain_username?).to eq(false)
+        end
+      end
+
+      context '#contain_todo' do
+        it 'return true if line contain todo' do
+          expect(Adjutant::Line.new(todo).contain_todo?).to eq(true)
+        end
+
+        it 'return false in other cases' do
+          expect(Adjutant::Line.new(comment).contain_todo?).to eq(false)
+          expect(Adjutant::Line.new(empty).contain_todo?).to eq(false)
+          expect(Adjutant::Line.new(useless).contain_todo?).to eq(false)
+        end
+      end
+
+      it 'returns true if line is comment line and interesting for us' do
+        expect(Adjutant::Line.new(comment).point_of_interes?).to eq(true)
+        expect(Adjutant::Line.new(todo).point_of_interes?).to eq(true)
+      end
+
+      it 'returns false in other cases' do
+        expect(Adjutant::Line.new(empty).point_of_interes?).to eq(false)
+        expect(Adjutant::Line.new(useless).point_of_interes?).to eq(false)
+      end
+    end
+
+    context '#new_added?' do
+      it 'returns true if line is new added' do
+        expect(Adjutant::Line.new(comment).new_added?).to eq(true)
+        expect(Adjutant::Line.new(todo).new_added?).to eq(true)
+        expect(Adjutant::Line.new(empty).new_added?).to eq(true)
+      end
+
+      it 'returns false in other cases' do
+        expect(Adjutant::Line.new(useless).new_added?).to eq(false)
+      end
+    end
+  end
+
+  describe '#usefull_text' do
+    it 'returns usefull text from line' do
+      comment_text = "@baltazore don't forget to write specs!"
+      todo_text    = "TODO: write moar specs!"
+      expect(Adjutant::Line.new(comment).usefull_text).to eq(comment_text)
+      expect(Adjutant::Line.new(todo).usefull_text).to eq(todo_text)
+      expect(Adjutant::Line.new(empty).usefull_text).to eq("")
+      expect(Adjutant::Line.new(useless).usefull_text).to eq(nil)
+    end
+  end
+
+  describe '#end_of_comment?' do
+    context '#empty_comment?' do
+      it 'returns true if comment is empty' do
+        expect(Adjutant::Line.new(empty).empty_comment?).to eq(true)
+      end
+
+      it 'returns false in other cases' do
+        expect(Adjutant::Line.new(comment).empty_comment?).to eq(false)
+        expect(Adjutant::Line.new(todo).empty_comment?).to eq(false)
+      end
+    end
+
+    it 'returns true if comment is ended' do
+      expect(Adjutant::Line.new(empty).end_of_comment?).to eq(true)
+      expect(Adjutant::Line.new(useless).end_of_comment?).to eq(true)
+    end
+
+    it 'returns false in other cases' do
+      expect(Adjutant::Line.new(comment).end_of_comment?).to eq(false)
+      expect(Adjutant::Line.new(todo).end_of_comment?).to eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'adjutant'
+
+RSpec.configure do |config|
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: adjutant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Baltazore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Gem that parse patch data for comments and ToDo lists and paste
+  them on GitHub PR.
+email:
+- baltazore92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adjutant.gemspec
+- lib/adjutant.rb
+- lib/adjutant/comment.rb
+- lib/adjutant/file_parser.rb
+- lib/adjutant/line.rb
+- lib/adjutant/version.rb
+- spec/adjutant/comment_spec.rb
+- spec/adjutant/file_parser_spec.rb
+- spec/adjutant/line_spec.rb
+- spec/spec_helper.rb
+homepage: http://baltazore.github.io/adjutant
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Gem that help parse git patch data
+test_files:
+- spec/adjutant/comment_spec.rb
+- spec/adjutant/file_parser_spec.rb
+- spec/adjutant/line_spec.rb
+- spec/spec_helper.rb
+has_rdoc: