xlint 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c8890cd631461cfc6d3ee4a268eca59cd57d3f8
-  data.tar.gz: 59d0dda4b82d159634d5c26b9b23e7c3b34ab444
+  metadata.gz: bcfee8fd2980a89cb729e4d32a8e6983c38a2d56
+  data.tar.gz: 74967a5b0109001208b35cbeffe82165af6cda96
 SHA512:
-  metadata.gz: 4f44a10fa544cbd23b9d0266708adf574c896c0eb2a70f4b51369b3679b005ca7952d32bbed059d8ce356c2808836490cd6871582d1147a6e91b418c88d17054
-  data.tar.gz: ac0a4e6b98789935998946c9382c8203efae3762fe874a12af093d0f0e54a68f1229e492abdb6c55642f1a45f3e42fe0c8f50e0ce2952f2ae1f57f4d5de28250
+  metadata.gz: 69fbb304de54c93cecc8fcec72bc72b5c331e46077879711898e75d9bf959c5af137c9da3931ee36d65d4ec38162956f1840dbbc33c1a642ddd6aa9e673cb500
+  data.tar.gz: 6fe7769a80dead24dc1fdc4978ad6bf0c1c0800c3bc49dc6bfabb3dd147c883c6e0ccbdc5deeae26a217e7700dfc33fe57e83907fbe0bd4a1749ba6fa93413af

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: KfRZxSc6sE5FEHkKZuv6mkUh5bJsM2sUA

data/.travis.yml

@@ -2,7 +2,7 @@ sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.3.1
 before_install: gem update --remote bundler
 install:
   - bundle install --retry=3

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# https://coveralls.zendesk.com/hc/en-us/articles/201769485-Ruby-Rails
+gem 'coveralls', require: false

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright (C) 2016-present, Instructure, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,8 +1,10 @@
 # Xlint
 
-[![Build Status](https://travis-ci.org/mobile-qa/xlint.svg?branch=master)](https://travis-ci.org/mobile-qa/xlint)
-[![Coverage Status](https://coveralls.io/repos/github/mobile-qa/xlint/badge.svg?branch=master)](https://coveralls.io/github/mobile-qa/xlint?branch=master)
-[![Dependency Status](https://gemnasium.com/badges/github.com/mobile-qa/xlint.svg)](https://gemnasium.com/github.com/mobile-qa/xlint)
+[![Gem Version](https://badge.fury.io/rb/xlint.svg)](https://rubygems.org/gems/xlint)
+[![Build Status](https://travis-ci.org/instructure/xlint.svg?branch=master)](https://travis-ci.org/instructure/xlint)
+[![Code Climate](https://codeclimate.com/github/instructure/xlint/badges/gpa.svg)](https://codeclimate.com/github/instructure/xlint)
+[![Coverage Status](https://coveralls.io/repos/github/instructure/xlint/badge.svg?branch=master)](https://coveralls.io/github/instructure/xlint?branch=master)
+[![Dependency Status](https://gemnasium.com/badges/github.com/instructure/xlint.svg)](https://gemnasium.com/github.com/instructure/xlint)
 
 Xlint is command-line tool for linting XCode project files and posting
 comments on a [Gerrit](https://www.gerritcodereview.com/) review from a
@@ -25,10 +27,12 @@ Xcode .pbxproj files.
 
 ## Installation
 
-Gergich and Gerrit must be configured as defined in the Gergich gem. If
-Gergich works, then all you need to do is `gem install xlint` and Xlint
+[Gergich][gergich] and Gerrit must be configured as defined in the Gergich gem. If
+[Gergich][gergich] works, then all you need to do is `gem install xlint` and Xlint
 is ready for linting.
 
+[gergich]: https://github.com/instructure/gergich
+
 ## Usage
 
 Xlint requires patchset changes be saved to a file and the filepath

data/bin/xlint

@@ -2,18 +2,4 @@
 
 require_relative '../lib/xlint'
 
-# reads git diff from file, file name in ARGV[0]
-raise ArgumentError, 'usage: xlint path/to/some.diff' unless ARGV.size == 1
-
-comments = []
-diff = Xlint.parse_git(File.read(ARGV[0]))
-diff.files.each do |file|
-  patch = diff.find_patch_by_file(file)
-  changes = Xlint.patch_body_changes(patch.body, file)
-  comments.concat(Xlint.find_offenses(changes))
-end
-
-unless comments.empty?
-  `gergich comment #{Shellwords.escape(comments.to_json)}`
-  `gergich publish`
-end
+Xlint.publish

data/lib/xlint.rb

@@ -3,9 +3,60 @@ require_relative 'xlint/version'
 require 'git_diff_parser'
 require 'json'
 require 'shellwords'
+require 'gergich'
 
 class Xlint
   class << self
+    attr_accessor :diff_file, :comments
+
+    def clear
+      @diff_file = nil
+      @comments = []
+    end
+
+    def check_args
+      # reads git diff from file, file name in ARGV[0]
+      raise ArgumentError, 'usage: xlint path/to/some.diff' unless ARGV.size == 1
+      @diff_file = ARGV.first
+      raise "File does not exist: #{diff_file}" unless File.exist?(diff_file)
+    end
+
+    def check_env
+      raise 'ENV[GERGICH_KEY] not defined' unless ENV['GERGICH_KEY']
+      raise 'ENV[GERRIT_PROJECT] not defined' unless ENV['GERRIT_PROJECT']
+    end
+
+    def build_draft
+      @comments = []
+      diff = Xlint.parse_git(File.read(diff_file))
+      diff.files.each do |file|
+        patch = diff.find_patch_by_file(file)
+        changes = Xlint.patch_body_changes(patch.body, file)
+        @comments.concat(Xlint.find_offenses(changes))
+      end
+    end
+
+    def save_draft
+      return if comments.empty?
+      draft = Gergich::Draft.new
+      comments.each do |comment|
+        draft.add_comment(comment[:path], comment[:position], comment[:message], comment[:severity])
+      end
+    end
+
+    def publish_draft
+      return if comments.empty?
+      Gergich::Review.new.publish!
+    end
+
+    def publish
+      check_args
+      check_env
+      build_draft
+      save_draft
+      publish_draft
+    end
+
     def parse_git(diff)
       GitDiffParser::Patches.parse(diff)
     end

data/lib/xlint/version.rb

@@ -1,3 +1,3 @@
 class Xlint
-  VERSION = '0.0.2'.freeze unless defined? ::Xllint::VERSION
+  VERSION = '0.0.4'.freeze unless defined? ::Xlint::VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlint
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Taylor Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -258,6 +258,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -269,7 +271,6 @@ files:
 - lib/xlint.rb
 - lib/xlint/version.rb
 - xlint.gemspec
-- xlint/LICENSE
 homepage: https://github.com/mobile-qa/xlint
 licenses:
 - Apache-2.0

data/xlint/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.