learn-xcpretty 0.1.11

data/lib/xcpretty/printer.rb

@@ -0,0 +1,20 @@
+require "xcpretty/ansi"
+
+module XCPretty
+
+  class Printer
+
+    attr_reader :formatter
+
+    def initialize(params)
+      klass = params[:formatter]
+      @formatter = klass.new(params[:unicode], params[:colorize])
+    end
+
+    def pretty_print(text)
+      formatted_text = formatter.pretty_format(text)
+      STDOUT.print(formatted_text + formatter.optional_newline) unless formatted_text.empty?
+    end
+
+  end
+end

data/lib/xcpretty/reporters/html.rb

@@ -0,0 +1,73 @@
+module XCPretty
+  class HTML
+
+    include XCPretty::FormatMethods
+    FILEPATH = 'build/reports/tests.html'
+    TEMPLATE = File.expand_path('../../../../assets/report.html.erb', __FILE__)
+
+    def load_dependencies
+      unless @@loaded ||= false
+        require 'fileutils'
+        require 'pathname'
+        require 'erb'
+        @@loaded = true
+      end
+    end
+
+    def initialize(options)
+      load_dependencies
+      @test_suites = {}
+      @filepath    = options[:path] || FILEPATH
+      @parser      = Parser.new(self)
+      @test_count  = 0
+      @fail_count  = 0
+    end
+
+    def handle(line)
+      @parser.parse(line)
+    end
+
+    def format_failing_test(suite, test_case, reason, file)
+      add_test(suite, {:name => test_case, :failing => true,
+        :reason => reason, :file => file, :snippet => formatted_snippet(file)})
+    end
+
+    def format_passing_test(suite, test_case, time)
+      add_test(suite, {:name => test_case, :time => time})
+    end
+
+    def finish
+      FileUtils.mkdir_p(File.dirname(@filepath))
+      write_report
+    end
+
+    private
+
+    def formatted_snippet(filepath)
+      snippet = Snippet.from_filepath(filepath)
+      Syntax.highlight(snippet, "-f html -O style=colorful -O noclasses")
+    end
+
+
+    def add_test(suite_name, data)
+      @test_count += 1
+      @test_suites[suite_name] ||= {:tests => []}
+      @test_suites[suite_name][:tests] << data
+      if data[:failing]
+        @test_suites[suite_name][:failing] = true
+        @fail_count += 1
+      end
+    end
+
+    def write_report
+      File.open(@filepath, 'w') do |f|
+        # WAT: get rid of these locals. BTW Cucumber fails if you remove them
+        test_suites = @test_suites
+        fail_count  = @fail_count
+        test_count  = @test_count
+        erb = ERB.new(File.open(TEMPLATE, 'r').read)
+        f.write erb.result(binding)
+      end
+    end
+  end
+end

data/lib/xcpretty/reporters/json_compilation_database.rb

@@ -0,0 +1,58 @@
+module XCPretty
+  class JSONCompilationDatabase
+
+    include XCPretty::FormatMethods
+    FILEPATH = 'build/reports/compilation_db.json'
+
+    def load_dependencies
+      unless @@loaded ||= false
+        require 'fileutils'
+        require 'pathname'
+        unless Object.const_defined?(:JSON)
+          begin
+            require 'json'
+          rescue LoadError
+            require File.expand_path(File.join(File.dirname(__FILE__),'../../../vendor/json_pure/generator'))
+          end
+        end
+        @@loaded = true
+      end
+    end
+
+    def initialize(options)
+      load_dependencies
+      @filepath           = options[:path] || FILEPATH
+      @parser             = Parser.new(self)
+      @compilation_units  = []
+      @current_file       = nil
+      @current_path       = nil
+    end
+
+    def handle(line)
+      @parser.parse(line)
+    end
+
+    def format_compile(file_name, file_path)
+      @current_file = file_name
+      @current_path = File.dirname(file_path)
+    end
+
+    def format_compile_command(compiler_command)
+      @compilation_units << { :command => compiler_command, 
+        :file => @current_file, :directory => @current_path }
+    end
+
+    def finish
+      FileUtils.mkdir_p(File.dirname(@filepath))
+      write_report
+    end
+
+    private
+
+    def write_report
+      File.open(@filepath, 'w') do |f|
+        f.write(@compilation_units.to_json)
+      end
+    end
+  end
+end

data/lib/xcpretty/reporters/junit.rb

@@ -0,0 +1,99 @@
+module XCPretty
+  class JUnit
+
+    include XCPretty::FormatMethods
+    FILEPATH = 'build/reports/junit.xml'
+
+    def load_dependencies
+      unless @@loaded ||= false
+        require 'fileutils'
+        require 'pathname'
+        require 'rexml/document'
+        require 'rexml/formatters/pretty'
+        @@loaded = true
+      end
+    end
+
+    def initialize(options)
+      load_dependencies
+      @filepath  = options[:path] || FILEPATH
+      @directory = `pwd`.strip
+      @document  = REXML::Document.new
+      @document << REXML::XMLDecl.new('1.0','UTF-8')
+      @document.add_element('testsuites')
+      @parser    = Parser.new(self)
+      @total_tests = 0
+      @total_fails = 0
+    end
+
+    def handle(line)
+      @parser.parse(line)
+    end
+
+    def format_passing_test(classname, test_case, time)
+      test_node = suite(classname).add_element('testcase')
+      test_node.attributes['classname'] = classname
+      test_node.attributes['name']      = test_case
+      test_node.attributes['time']      = time
+      @test_count += 1
+    end
+
+    def format_pending_test(classname, test_case)
+      test_node = suite(classname).add_element('testcase')
+      test_node.attributes['classname'] = classname
+      test_node.attributes['name']      = test_case
+      test_node.add_element('skipped')
+      @test_count += 1
+    end
+
+    def format_failing_test(classname, test_case, reason, file)
+      test_node = suite(classname).add_element('testcase')
+      test_node.attributes['classname'] = classname
+      test_node.attributes['name']      = test_case
+      fail_node = test_node.add_element('failure')
+      fail_node.attributes['message'] = reason
+      fail_node.text = file.sub(@directory + '/', '')
+      @test_count += 1
+      @fail_count += 1
+    end
+
+    def finish
+      set_test_counters
+      @document.root.attributes['tests'] = @total_tests
+      @document.root.attributes['failures'] = @total_fails
+      write_report_file
+    end
+
+    private
+
+    def write_report_file
+      FileUtils.mkdir_p(File.dirname(@filepath))
+      formatter = REXML::Formatters::Pretty.new(2)
+      formatter.compact = true
+      output_file = File.open(@filepath, 'w+')
+      result = formatter.write(@document, output_file)
+      output_file.close
+      result
+    end
+
+    def suite(classname)
+      return @last_suite if @last_suite && @last_suite.attributes['name'] == classname
+
+      set_test_counters
+      @last_suite = @document.root.add_element('testsuite')
+      @last_suite.attributes['name'] = classname
+      @last_suite
+    end
+
+    def set_test_counters
+      if @last_suite
+        @last_suite.attributes['tests'] = @test_count
+        @last_suite.attributes['failures'] = @fail_count
+      end
+      @total_fails += @fail_count || 0
+      @total_tests += @test_count || 0
+      @test_count = 0
+      @fail_count = 0
+    end
+  end
+end

data/lib/xcpretty/reporters/learn.rb

@@ -0,0 +1,154 @@
+module XCPretty
+  class Learn
+    SERVICE_URL = 'http://ironbroker.flatironschool.com'
+    SERVICE_ENDPOINT = '/e/flatiron_xcpretty/build'
+
+    include XCPretty::FormatMethods
+
+    def load_dependencies
+      unless @@loaded ||= false
+        require 'fileutils'
+        require 'pathname'
+        require 'json'
+        require 'faraday'
+        require 'netrc'
+        require 'git'
+        require 'oj'
+        @@loaded = true
+      end
+    end
+
+    def initialize(options)
+      load_dependencies
+      @formatted_output = {
+        username: UsernameParser.get_username,
+        github_user_id: UserIdParser.get_user_id,
+        repo_name: RepoParser.get_repo,
+        build: {
+          test_suite: [{
+            framework: 'xcpretty',
+            formatted_output: [],
+            duration: 0.0,
+            build_output: [],
+          }]
+        },
+        total_count: 0,
+        passing_count: 0,
+        failure_count: 0
+      }
+
+      @parser = Parser.new(self)
+
+      @connection = Faraday.new(url: SERVICE_URL) do |faraday|
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def handle(line)
+      @parser.parse(line)
+    end
+
+    def format_passing_test(classname, test_case, time)
+      pass = {classname: classname, name: test_case, time: time}
+      @formatted_output[:build][:test_suite][0][:formatted_output] << pass
+      @formatted_output[:total_count] += 1
+      @formatted_output[:passing_count] += 1
+    end
+
+    def format_failing_test(classname, test_case, reason, file)
+      failure = {classname: classname, name: test_case, file: file, reason: reason}
+      @formatted_output[:build][:test_suite][0][:formatted_output] << failure
+      @formatted_output[:total_count] += 1
+      @formatted_output[:failure_count] += 1
+    end
+
+    def finish
+      write_report_file
+    end
+
+    private
+
+    def write_report_file
+      @connection.post do |req|
+        req.url SERVICE_ENDPOINT
+        req.headers['Content-Type'] = 'application/json'
+        req.body = @formatted_output.to_json
+      end
+    end
+  end
+
+  class UsernameParser
+    def self.get_username
+      parser = NetrcInteractor.new
+      username = parser.username
+
+      if !username
+        print "Enter your github username: "
+        username = gets.strip
+        user_id = GitHubInteractor.get_user_id_for(username)
+        parser.write(username, user_id)
+      end
+
+      username
+    end
+  end
+
+  class UserIdParser
+    def self.get_user_id
+      parser = NetrcInteractor.new
+      user_id = parser.user_id
+    end
+  end
+
+  class GitHubInteractor
+    attr_reader :username, :user_id
+
+    def self.get_user_id_for(username)
+      new(username).get_user_id
+    end
+
+    def initialize(username)
+      @username = username
+    end
+
+    def get_user_id
+      @user_id ||= Oj.load(
+        open("https://api.github.com/users/#{username}").read,
+        symbol_keys: true
+      )[:id]
+    end
+  end
+
+  class NetrcInteractor
+    attr_reader :username, :user_id, :netrc
+
+    def initialize
+      @netrc = Netrc.read
+      @username, @user_id = netrc["flatiron-push"]
+    end
+
+    def write(username, user_id)
+      netrc["flatiron-push"] = username, user_id
+      netrc.save
+    end
+  end
+
+  class RepoParser
+    def self.get_repo
+      begin
+        repo = Git.open(File.expand_path(".", Dir.pwd))
+      rescue
+        puts "Not a valid Git repository"
+        die
+      end
+
+      url = repo.remote.url
+
+      repo_name = url.match(/(?:https:\/\/|git@).*\/(.+)(?:\.git)/)[1]
+    end
+
+    def self.die
+      exit
+    end
+  end
+end

data/lib/xcpretty/snippet.rb

@@ -0,0 +1,34 @@
+module XCPretty
+  class Snippet
+
+    def self.from_filepath(filepath)
+      path, line = filepath.split(':')
+      file = File.open(path)
+
+      text = read_snippet(file, line)
+
+      file.close
+      text
+    rescue
+      ''
+    end
+
+
+    private
+
+    def self.read_snippet(file, around_line)
+      text = ""
+      starting_position = around_line.to_i - 2
+      starting_position.times { file.gets }
+      3.times { text += readline(file) }
+      text
+    end
+
+    def self.readline(file)
+      file.gets
+      $_ || ''
+    end
+
+  end
+end
+

data/lib/xcpretty/syntax.rb

@@ -0,0 +1,20 @@
+module XCPretty
+  class Syntax
+
+    def self.highlight(code, options="")
+      pygments_available? ? pygmentize(code, options) : code
+    end
+
+
+    private
+
+    def self.pygments_available?
+      @available = system('which pygmentize > /dev/null') if @available.nil?
+      @available
+    end
+
+    def self.pygmentize(code, options)
+      `echo "#{code}" | pygmentize -l objc #{options}`
+    end
+  end
+end