renegade 0.0.1 → 0.1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c09d76b3772341edb686aa03d38a52e19238dea
-  data.tar.gz: 9e0de2e4875e0fe195b221d93f29cff4f5d627ac
+  metadata.gz: ade5a344f1baff35eaaaadd7d0c7145d69eae41a
+  data.tar.gz: a9a9d80519950b55b9ba777ea6ca8cdf50e40bee
 SHA512:
-  metadata.gz: c46c989263eea8273c6575f74e6ae49186ecfd71ba0319a03b96807d064ac30b8aa7cf468707fd6610517ef309b4cee69a18d750fbf05cf46a3d42849ad790f6
-  data.tar.gz: 03353292c31d715db1aed2430756c1d780ceeeed6ee4b8257ef0f2fd6c711fce6c8b3b0a0b1a4f826291b96536eb8ed9c35e016f75c6de96d1610743ba5d89d1
+  metadata.gz: 5ecd738fff4c3c4641e8b7247ab94abf4b03381c7a044a8b31eb362a10b34134b147f74fd766f30fc01ad8dded1e6432dfa9724536a949267e5e78f4af97be86
+  data.tar.gz: b85a93764724822c908c8eda2842f7840b725536541a7e9decc26b90887a8a272dc169cb366a9e1b4e8bba73ffaf9a3c026b47f0dae360f8481519d621dc0395

data/lib/renegade.rb

@@ -1,7 +1,8 @@
-##
-# Renegade module to run commit hooks
+require 'renegade/version'
+
+# Renegade module
 module Renegade
-  def self.hello_world
-    puts 'hello world'
-  end
 end
+
+
+puts 'renegade'

data/lib/renegade/branch_name.rb

@@ -0,0 +1,40 @@
+require 'renegade/status'
+
+module Renegade
+  ##
+  # Verify branch name
+  class BranchName
+    attr_reader :errors, :warnings
+
+    REGEX_STORY_BRANCH = /^(?:story)-(\d{4,6})-?(.*)?$/
+    REGEX_BUG_BRANCH = /^(?:bug)-(\d{4,6})-?(.*)?$/
+
+    def initialize(label)
+      # Instance variables
+      @label = label
+      @warnings = []
+      @errors = []
+    end
+
+    def run
+      branch_name = `git name-rev --name-only HEAD`
+
+      Status.report(@label, check_branch_name(branch_name))
+    end
+
+    def check_branch_name(branch_name)
+      if REGEX_STORY_BRANCH.match(branch_name)
+        # placeholder
+        return true
+      elsif REGEX_BUG_BRANCH.match(branch_name)
+        # placeholder
+        return true
+      else
+        @warnings.push('Branches must start with bug-##### or story-#####.')
+        @warnings.push('You may continue to develop in this branch, but you'\
+          ' will not be allowed to merge unless you rename it.')
+        return false
+      end
+    end
+  end
+end

data/lib/renegade/commit_message.rb

@@ -1,22 +1,74 @@
-# require_relative 'status'
-#
-# module Renegade
-#   ##
-#   # Ensure commit messages meet certain requirements
-#   class CommitMessage
-#     def self.message_length(message)
-#       min_length = 10
-#       max_length = 50
-#
-#       puts 'Renegade::CommitMessage.message_length'
-#
-#       if message.length > min_length && message.length <= max_length
-#         Renegade::Status.new.add_error('Commit messages should be between \
-#           #{min_length} and #{max_length}')
-#         false
-#       else
-#         true
-#       end
-#     end
-#   end
-# end
+require 'renegade/status'
+
+module Renegade
+  # Check commit messages meet certain criteria
+  class CommitMessage
+    attr_reader :errors, :warnings
+
+    COMMIT_FORMAT = /^(?:(?:BugId: |Story: B+-|Epic: E-0)[1-9]\d* \| )(.*)/
+
+    def initialize(label)
+      # Instance variables
+      @label = label
+      @warnings = []
+      @errors = []
+
+      @min_length = 7
+      @max_length = 50
+    end
+
+    def run(message)
+      check_commit_message_format(message)
+      check_commit_message_non_ascii(message)
+    end
+
+    # Check message length
+    def check_commit_message_length(message)
+      check_label = 'Commit message length'
+
+      if message.length >= @min_length && message.length <= @max_length
+        Status.report(check_label, true)
+      else
+        @errors.push "Commit messages should be between #{@min_length} "\
+          "and #{@max_length} characters."
+        Status.report(check_label, false)
+      end
+    end
+
+    # Check commit message contains no non-ASCII characters
+    def check_commit_message_non_ascii(message)
+      check_label = 'Only ASCII characters'
+
+      if message.ascii_only?
+        Status.report(check_label, true)
+      else
+        Status.report(check_label, false)
+        @errors.push('Commit messages may not contain non-ASCII characters')
+      end
+    end
+
+    def check_commit_message_format_error
+      'You must include a valid BugId, Story or Epic number.' + "\n"\
+      '  Examples:' + "\n"\
+      '  - BugId: 12345 | Helpful comment describing bug fix' + "\n"\
+      '  - Story: B-12345 | Helpful comment describing story' + "\n"\
+      '  - Epic: E-12345 | Epic comment'
+    end
+
+    # Check commit message contains no non-ASCII characters
+    def check_commit_message_format(message)
+      check_label = 'Includes a valid BugId, Story or Epic number'
+
+      matches = COMMIT_FORMAT.match(message)
+
+      if matches
+        Status.report(check_label, true)
+        check_commit_message_length(matches[1])
+      else
+        Status.report(check_label, false)
+        check_commit_message_length(message)
+        @errors.push(check_commit_message_format_error)
+      end
+    end
+  end
+end

data/lib/renegade/conflict_markers.rb

@@ -0,0 +1,33 @@
+require 'open3'
+require 'renegade/status'
+
+module Renegade
+  ##
+  # Prevent merge artifacts from getting committed
+  class ConflictMarkers
+    attr_reader :errors, :warnings
+
+    def initialize(label)
+      # Instance variables
+      @label = label
+      @errors = []
+    end
+
+    def run
+      markers = `git diff-index --check --cached HEAD --`
+
+      check_markers(markers.chomp.strip)
+    end
+
+    def check_markers(markers)
+      check_label = 'No merge artifacts'
+
+      if markers == ''
+        Status.report(check_label, true)
+      else
+        Status.report(check_label, false)
+        @errors.push('Merge artifacts were found!' + "\n" + markers)
+      end
+    end
+  end
+end

data/lib/renegade/handle_errors.rb

@@ -0,0 +1,39 @@
+module Renegade
+  ##
+  # Handle errors
+  class HandleErrors
+    # Handle errors if they exist
+    def self.handle_errors(errors)
+      if errors.size > 0
+        print_errors(errors)
+        exit 1
+      else
+        exit 0
+      end
+    end
+
+    def self.handle_warnings(warnings)
+      print_warnings(warnings) if warnings.size > 0
+    end
+
+    def self.print_errors(errors)
+      puts "\nErrors:"
+
+      errors.each do |error|
+        puts "- #{error}"
+      end
+
+      puts "\n"
+    end
+
+    def self.print_warnings(warnings)
+      puts "\nWarnings:"
+
+      warnings.each do |warning|
+        puts "- #{warning}"
+      end
+
+      puts "\n"
+    end
+  end
+end

data/lib/renegade/linters.rb

@@ -0,0 +1,69 @@
+require 'open3'
+require 'renegade/status'
+
+module Renegade
+  # Run linters
+  class Linters
+    attr_reader :errors
+
+    def initialize(label, extension, exec_command)
+      # Instance variables
+      @label = label
+      @extension = extension
+      @exec_command = exec_command
+      @errors = []
+    end
+
+    def run(files)
+      files = filter_files(files)
+      append_file_count(files)
+
+      # Only run check if there are relevant files being committed
+      if files.size == 0
+        Status.report(@label, true)
+      else
+        Status.report(@label, exec(files))
+      end
+    end
+
+    # Add the file count to the end of the label
+    def append_file_count(files)
+      file_size = files.size
+
+      if file_size == 0 || file_size > 1
+        @label = "#{@label} (#{file_size} files)"
+      else
+        @label = "#{@label} (1 file)"
+      end
+    end
+
+    def exec(files)
+      # http://stackoverflow.com/questions/690151/getting-output-of-system-calls-in-ruby
+      _stdin, stdout, stderr,
+        wait_thread = Open3.popen3(@exec_command, files.join(' '))
+
+      if wait_thread.value.exitstatus == 1
+        @errors.push(stdout.read)
+      end
+
+      stdout.gets(nil)
+      stdout.close
+      stderr.gets(nil)
+      stderr.close
+
+      wait_thread.value.exitstatus == 0
+    end
+
+    def filter_files(file_list)
+      filtered_files = []
+
+      file_list.each do |file|
+        if File.extname(file) == @extension
+          filtered_files.push(file)
+        end
+      end
+
+      filtered_files
+    end
+  end
+end

data/lib/renegade/pre_commit.rb

@@ -0,0 +1,36 @@
+require 'renegade/handle_errors'
+require 'renegade/status'
+require 'renegade/linters'
+require 'renegade/branch_name'
+require 'renegade/conflict_markers'
+
+module Renegade
+  # Run linters
+  class PreCommit
+    def initialize
+      Renegade::Status.hook_start('pre-commit')
+      # @scss_lint = Renegade::Linters.new('SCSS Lint', '.scss', 'scss-lint')
+      # @eslint = Renegade::Linters.new('ESLint', '.js', 'eslint')
+      @branch_name = Renegade::BranchName.new('Branch Name')
+      @conflict_markers = Renegade::ConflictMarkers.new('Conflict Markers')
+      # @protected_files = Renegade::ProtectedFiles.new('Protected Files')
+
+      run
+    end
+
+    def run
+      # @scss_lint.run
+      # @eslint.run
+      @branch_name.run
+      @conflict_markers.run
+      # @protected_files.run
+
+      Renegade::HandleErrors.handle_warnings(@branch_name.warnings)
+      Renegade::HandleErrors.handle_errors(@conflict_markers.errors)
+
+      # Renegade::HandleErrors.handle_errors(
+      #   @scss_lint.errors + @eslint.errors +
+      #   @branch_name.errors + @protected_files.errors)
+    end
+  end
+end

data/lib/renegade/prepare_commit_message.rb

@@ -0,0 +1,28 @@
+require 'renegade/handle_errors'
+require 'renegade/status'
+require 'renegade/commit_message'
+
+module Renegade
+  # Run linters
+  class PrepareCommitMessage
+    def initialize
+      Renegade::Status.hook_start('prepare-commit-msg')
+      run
+    end
+
+    def run
+      message_type = ARGV[1]
+
+      commit_message = Renegade::CommitMessage.new('Commit Message')
+
+      # Avoid checking merges
+      if message_type == 'message'
+        message_file = ARGV[0]
+        message = File.read(message_file)
+        commit_message.run(message)
+      end
+
+      Renegade::HandleErrors.handle_errors(commit_message.errors)
+    end
+  end
+end

data/lib/renegade/status.rb

@@ -1,19 +1,30 @@
-# module Renegade
-#   ##
-#   # Handle errors
-#   class Status
-#     def initialize
-#       @error_list = []
-#     end
-#
-#     def self.add_error(message)
-#       @error_list.push(message)
-#     end
-#
-#     def self.print_errors
-#       @error_list.each do |error|
-#         puts error
-#       end
-#     end
-#   end
-# end
+# Add color options
+class String
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+end
+
+# Define string colors
+module Renegade
+  ##
+  # Report statuses
+  class Status
+    # Report labels
+    def self.report(label, passed)
+      if passed
+        puts "  √ #{label}".green
+      else
+        puts "  × #{label}".red
+      end
+    end
+
+    def self.hook_start(hook)
+      puts "\nRunning #{hook} hooks…"
+    end
+  end
+end

data/lib/renegade/version.rb

@@ -0,0 +1,4 @@
+# Renegade version
+module Renegade
+  VERSION = '0.1.29'
+end

metadata

@@ -1,41 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: renegade
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.29
 platform: ruby
 authors:
-- Rather Blue
+- ratherblue
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
+        version: '10.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
 description: Gem description
-email: ratherblue@gmail.com
+email:
+- ratherblue@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/renegade.rb
-- lib/renegade/checks/branch_names.rb
-- lib/renegade/checks/lint.rb
+- lib/renegade/branch_name.rb
 - lib/renegade/commit_message.rb
+- lib/renegade/conflict_markers.rb
+- lib/renegade/handle_errors.rb
+- lib/renegade/linters.rb
+- lib/renegade/pre_commit.rb
+- lib/renegade/prepare_commit_message.rb
 - lib/renegade/status.rb
-homepage: http://github.com/ratherblue/renegade
+- lib/renegade/version.rb
+homepage: https://github.com/ratherblue/renegade
 licenses:
 - Apache 2.0
 metadata: {}

data/lib/renegade/checks/branch_names.rb

@@ -1,20 +0,0 @@
-# module Renegade
-#   ##
-#   # Validate class names
-#   class BranchNames
-#     REGEX_STORY_BRANCH = /^(?:story)-(\d{4,6})?-?(.*)?$/
-#     REGEX_BUG_BRANCH = /^(?:bug)-(\d{4,6})?-?(.*)?$/
-#
-#     def self.check_branch_name(branch_name)
-#       if REGEX_STORY_BRANCH.match(branch_name)
-#         # placeholder
-#         return true
-#       elsif REGEX_BUG_BRANCH.match(branch_name)
-#         # placeholder
-#         return true
-#       else
-#         return false
-#       end
-#     end
-#   end
-# end

data/lib/renegade/checks/lint.rb

@@ -1,15 +0,0 @@
-# module Renegade
-#   ##
-#   # This class handles running the various linters
-#   class Lint
-#     # run eslint
-#     def self.eslint
-#       true
-#     end
-#
-#     # run scss lint
-#     def self.scsslint
-#       true
-#     end
-#   end
-# end