xcop 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0587f8d49aed88e6e268948e67eea7c8ec6557e
-  data.tar.gz: 834e3b41d80ecdaa50d0b1a4357d69009eaeee5a
+  metadata.gz: 65f4832fd6dcc3f17bec30dd2dd469779f6f99fe
+  data.tar.gz: 41882ead0d1b7481f9e1e9491122fccdaf8d9c4e
 SHA512:
-  metadata.gz: d906e4dee068262203da8a251e7d4f1c225a53793f88f306efe671edc0a142351dc4a5c9d4f6601e994dd60c1064ff7cce9cd6980da857a54e6ecd07304dbee4
-  data.tar.gz: 8b8f1c85855c25586c2d0d41a10e7941f551e560bc987bbb895597f3acdc7cc7c30d7912cc7e29570c344a5366845281faad99fa177e104f99fa5274550b0719
+  metadata.gz: 263c4b3643109e9dec1a7323661d3bc68793a1a893b4f95a673f90d191b2d29a676f694d67d504d805f276d2f9217d1cb03349d2fb157c4404ff9df049616fdb
+  data.tar.gz: '0845a146315f17aa769ac8db5cdfd2a39b95f9dd7f5bc90b943bb4ce88487b8973f4867d038f9c3c0cd2650571f138cdc62276ceeb40c31e4ce5f80f514ec3cd'

data/.rubocop.yml

@@ -8,3 +8,5 @@ Metrics/MethodLength:
   Enabled: false
 Style/MultilineMethodCallIndentation:
   Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/README.md

@@ -34,7 +34,27 @@ Run it locally and read its output:
 $ xcop --help
 ```
 
-## How to use in Rakefile?
+To validate formatting of your XML files just pass their names
+as arguments:
+
+```bash
+$ xcop file1.xml file2.xml
+```
+
+If your files are not formatted correctly and `xcop` complains, you
+can ask it to "beautify" them, using `--fix` option:
+
+```bash
+$ xcop --fix broken-file.xml
+```
+
+To fix all files in the directory you can do:
+
+```bash
+$ xcop $(find . -name '*.xml')
+```
+
+## How to use in `Rakefile`?
 
 This is what you need there:
 
@@ -48,6 +68,47 @@ Xcop::RakeTask.new(:xcop) do |task|
 end
 ```
 
+## How to use in Maven `pom.xml`?
+
+You can integrate it with the help of
+[maven-antrun-plugin](http://maven.apache.org/plugins/maven-antrun-plugin/):
+
+```xml
+<project>
+  [...]
+  <build>
+    [...]
+    <plugins>
+      [...]
+      <plugin>
+        <artifactId>maven-antrun-plugin</artifactId>
+        <version>1.8</version>
+        <executions>
+          <execution>
+            <phase>verify</phase>
+            <configuration>
+              <target>
+                <apply executable="xcop" failonerror="true">
+                  <fileset dir=".">
+                    <include name="**/*.xml"/>
+                    <include name="**/*.xsd"/>
+                    <exclude name="target/**/*"/>
+                    <exclude name=".idea/**/*"/>
+                  </fileset>
+                </apply>
+              </target>
+            </configuration>
+            <goals>
+              <goal>run</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+```
+
 ## How to contribute?
 
 Just submit a pull request. Make sure `rake` passes.

data/features/cli.feature

@@ -19,9 +19,8 @@ Feature: Command Line Processing
 
     """
     When I run bin/xcop with "test.xml"
-    Then Stdout contains "OK"
+    Then Stdout contains "pretty"
     And Exit code is zero
-    And Stdout contains "Validating test.xml..."
 
   Scenario: Validating correct XML file with license
     Given I have a "licensed.xml" file with content:
@@ -40,9 +39,8 @@ Feature: Command Line Processing
     which is very very strict!
     """
     When I run bin/xcop with "--license LICENSE licensed.xml"
-    Then Stdout contains "OK"
+    Then Stdout contains "pretty"
     And Exit code is zero
-    And Stdout contains "Validating licensed.xml..."
 
   Scenario: Validating incorrect XML file
     Given I have a "abc.xml" file with content:

data/lib/xcop.rb

@@ -22,6 +22,7 @@
 
 require 'nokogiri'
 require 'differ'
+require 'rainbow'
 require_relative 'xcop/version'
 
 # Xcop main module.
@@ -37,8 +38,9 @@ module Xcop
     end
 
     def run
+      puts 'Running xcop...'
+      puts "Inspecting #{pluralize(@files.length, 'file')}..."
       @files.each do |f|
-        print "Validating #{f}... "
         doc = Document.new(f)
         diff = doc.diff
         unless diff.empty?
@@ -52,8 +54,11 @@ module Xcop
             raise "Broken license in #{f}"
           end
         end
-        print "OK\n"
+        print Rainbow('.').green
       end
+      print "\n"
+      puts "#{pluralize(@files.length, 'file')} checked, \
+everything looks #{Rainbow('pretty').green}"
     end
 
     # Fix them all.
@@ -64,6 +69,12 @@ module Xcop
         print "done\n"
       end
     end
+
+    private
+
+    def pluralize(num, text)
+      "#{num} #{num == 1 ? text : text + 's'}"
+    end
   end
 
   # One document.

data/lib/xcop/version.rb

@@ -25,5 +25,5 @@
 # Copyright:: Copyright (c) 2017 Yegor Bugayenko
 # License:: MIT
 module Xcop
-  VERSION = '0.5.3'.freeze
+  VERSION = '0.5.4'.freeze
 end

data/xcop.gemspec

@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'nokogiri', '~>1.8'
   s.add_runtime_dependency 'differ', '~>0.1.2'
   s.add_runtime_dependency 'slop', '~>4.4'
+  s.add_runtime_dependency 'rainbow', '~>2.2'
   s.add_development_dependency 'rake', '12.0.0'
   s.add_development_dependency 'codecov', '0.1.10'
   s.add_development_dependency 'rdoc', '4.2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement