xcop 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f4832fd6dcc3f17bec30dd2dd469779f6f99fe
-  data.tar.gz: 41882ead0d1b7481f9e1e9491122fccdaf8d9c4e
+  metadata.gz: fa06bb31a6307eaf1ce56b0795be9724317f602a
+  data.tar.gz: 626fd201fd723fd081fc112cb40e282f3d972a95
 SHA512:
-  metadata.gz: 263c4b3643109e9dec1a7323661d3bc68793a1a893b4f95a673f90d191b2d29a676f694d67d504d805f276d2f9217d1cb03349d2fb157c4404ff9df049616fdb
-  data.tar.gz: '0845a146315f17aa769ac8db5cdfd2a39b95f9dd7f5bc90b943bb4ce88487b8973f4867d038f9c3c0cd2650571f138cdc62276ceeb40c31e4ce5f80f514ec3cd'
+  metadata.gz: 8329081d4b7977c9be2afcca650704e5dc77370af182772538dc27bf1c8568e1bd9e29a26a85c5d1ea52af1eb0feeedbb62ebf6ae4bd592b93f8143c11b2637f
+  data.tar.gz: 1702c751578d7ff9ca5c6ad4b8353d9f21b7c907627d74d0d68980a535527c6481e35ab91333d163660c77c49958d77891dee22dbe24975af179bd82b79ba933

data/.rubocop.yml

@@ -4,6 +4,8 @@ AllCops:
     - 'assets/**/*'
   DisplayCopNames: true
 
+Metrics/CyclomaticComplexity:
+  Max: 10
 Metrics/MethodLength:
   Enabled: false
 Style/MultilineMethodCallIndentation:

data/README.md

@@ -51,7 +51,7 @@ $ xcop --fix broken-file.xml
 To fix all files in the directory you can do:
 
 ```bash
-$ xcop $(find . -name '*.xml')
+$ xcop --fix $(find . -name '*.xml')
 ```
 
 ## How to use in `Rakefile`?
@@ -62,9 +62,10 @@ This is what you need there:
 require 'xcop/rake_task'
 desc 'Run XCop on all XML/XSL files in all directories'
 Xcop::RakeTask.new(:xcop) do |task|
-  task.license = 'LICENSE.txt'
-  task.includes = ['**/*.xml', '**/*.xsl']
-  task.excludes = ['target/**/*']
+  task.license = 'LICENSE.txt' # no license by default
+  task.quiet = true # FALSE by default
+  task.includes = ['**/*.xml', '**/*.xsl'] # xml|xsd|xhtml|xsl|html by default
+  task.excludes = ['target/**/*'] # empty by default
 end
 ```
 
@@ -89,6 +90,8 @@ You can integrate it with the help of
             <configuration>
               <target>
                 <apply executable="xcop" failonerror="true">
+                  <arg value="--license"/>
+                  <arg value="LICENSE.txt"/>
                   <fileset dir=".">
                     <include name="**/*.xml"/>
                     <include name="**/*.xsd"/>
@@ -109,6 +112,28 @@ You can integrate it with the help of
 </project>
 ```
 
+## How to use in Ant `project.xml`?
+
+Something like this should work:
+
+```xml
+<project>
+  [...]
+  <target name="xcop">
+    <apply executable="xcop" failonerror="true">
+      <arg value="--license"/>
+      <arg value="LICENSE.txt"/>
+      <fileset dir=".">
+        <include name="**/*.xml"/>
+        <include name="**/*.xsd"/>
+        <exclude name="target/**/*"/>
+        <exclude name=".idea/**/*"/>
+      </fileset>
+    </apply>
+  </target>
+</project>
+```
+
 ## How to contribute?
 
 Just submit a pull request. Make sure `rake` passes.

data/bin/xcop

@@ -31,6 +31,7 @@ require_relative '../lib/xcop/version'
 opts = Slop.parse(ARGV, strict: true, help: true) do |o|
   o.banner = "Usage (#{Xcop::VERSION}): xcop [options] [files...]"
   o.bool '-h', '--help', 'Show these instructions'
+  o.bool '-q', '--quiet', 'Don\'t print anything if there are no errors'
   o.bool '--version', 'Show current version'
   o.bool '--fix', 'Fix all files instead of reporting their problems'
   o.string '--license', 'File name of the boilerplate head license'
@@ -52,10 +53,14 @@ Encoding.default_internal = Encoding::UTF_8
 license = opts.license? ? File.read(opts[:license]) : ''
 
 if opts.fix?
-  Xcop::CLI.new(opts.arguments, license).fix
+  Xcop::CLI.new(opts.arguments, license).fix do |f|
+    puts "#{f} fixed" unless opts.quiet?
+  end
 else
   begin
-    Xcop::CLI.new(opts.arguments, license).run
+    Xcop::CLI.new(opts.arguments, license).run do |f|
+      puts "#{f} looks good" unless opts.quiet?
+    end
   rescue StandardError => e
     puts e.message
     exit -1

data/features/cli.feature

@@ -19,7 +19,7 @@ Feature: Command Line Processing
 
     """
     When I run bin/xcop with "test.xml"
-    Then Stdout contains "pretty"
+    Then Stdout contains "test.xml looks good"
     And Exit code is zero
 
   Scenario: Validating correct XML file with license
@@ -38,8 +38,8 @@ Feature: Command Line Processing
     This is the license,
     which is very very strict!
     """
-    When I run bin/xcop with "--license LICENSE licensed.xml"
-    Then Stdout contains "pretty"
+    When I run bin/xcop with "--quiet --license LICENSE licensed.xml"
+    Then Stdout is empty
     And Exit code is zero
 
   Scenario: Validating incorrect XML file

data/lib/xcop.rb

@@ -38,8 +38,6 @@ module Xcop
     end
 
     def run
-      puts 'Running xcop...'
-      puts "Inspecting #{pluralize(@files.length, 'file')}..."
       @files.each do |f|
         doc = Document.new(f)
         diff = doc.diff
@@ -54,27 +52,17 @@ module Xcop
             raise "Broken license in #{f}"
           end
         end
-        print Rainbow('.').green
+        yield(f) if block_given?
       end
-      print "\n"
-      puts "#{pluralize(@files.length, 'file')} checked, \
-everything looks #{Rainbow('pretty').green}"
     end
 
     # Fix them all.
     def fix
       @files.each do |f|
-        print "Fixing #{f}... "
         Document.new(f).fix(@license)
-        print "done\n"
+        yield(f) if block_given?
       end
     end
-
-    private
-
-    def pluralize(num, text)
-      "#{num} #{num == 1 ? text : text + 's'}"
-    end
   end
 
   # One document.
@@ -98,7 +86,8 @@ everything looks #{Rainbow('pretty').green}"
     # Return the difference for the license.
     def ldiff(license)
       xml = Nokogiri::XML(File.open(@path), &:noblanks)
-      now = xml.xpath('/comment()')[0].text.to_s.strip
+      comment = xml.xpath('/comment()')[0]
+      now = comment.nil? ? '' : comment.text.to_s.strip
       ideal = license.strip
       Differ.format = :color
       return Differ.diff_by_line(ideal, now).to_s unless now == ideal

data/lib/xcop/rake_task.rb

@@ -36,12 +36,14 @@ module Xcop
     attr_accessor :excludes
     attr_accessor :includes
     attr_accessor :license
+    attr_accessor :quiet
 
     def initialize(*args, &task_block)
       @name = args.shift || :xcop
       @includes = %w(xml xsd xhtml xsl html).map { |e| "**/*.#{e}" }
       @excludes = []
       @license = nil
+      @quiet = false
       desc 'Run Xcop' unless ::Rake.application.last_description
       task(name, *args) do |_, task_args|
         RakeFileUtils.send(:verbose, true) do
@@ -55,13 +57,23 @@ module Xcop
 
     def run
       require 'xcop'
+      puts 'Running xcop...' unless @quiet
       bad = Dir.glob(@excludes)
       good = Dir.glob(@includes).reject { |f| bad.include?(f) }
+      puts "Inspecting #{pluralize(good.length, 'file')}..." unless @quiet
       begin
-        Xcop::CLI.new(good, @license.nil? ? '' : File.read(@license)).run
+        Xcop::CLI.new(good, @license.nil? ? '' : File.read(@license)).run do
+          print Rainbow('.').green unless @quiet
+        end
       rescue StandardError => e
         abort(e.message)
       end
+      puts "\n#{pluralize(good.length, 'file')} checked, \
+everything looks #{Rainbow('pretty').green}" unless @quiet
+    end
+
+    def pluralize(num, text)
+      "#{num} #{num == 1 ? text : text + 's'}"
     end
   end
 end

data/lib/xcop/version.rb

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

data/test/test_rake_task.rb

@@ -35,6 +35,7 @@ class TestRakeTask < Minitest::Test
       Dir.chdir(dir)
       File.write('a.xml', "<?xml version=\"1.0\"?>\n<x/>\n")
       Xcop::RakeTask.new(:xcop1) do |task|
+        task.quiet = true
         # task.license = 'LICENSE.txt'
       end
       Rake::Task['xcop1'].invoke

data/test/test_xcop.rb

@@ -59,6 +59,22 @@ class TestXcop < Minitest::Test
     end
   end
 
+  def test_license_absence
+    Dir.mktmpdir 'test3' do |dir|
+      f = File.join(dir, 'a.xml')
+      license = "Copyright (c) All Good People\nTouch me!\n\n"
+      File.write(
+        f,
+        [
+          '<?xml version="1.0"?>',
+          '<hello>My dear friend!</hello>',
+          ''
+        ].join("\n")
+      )
+      assert(Xcop::Document.new(f).ldiff(license) != '')
+    end
+  end
+
   def test_fixes_document
     Dir.mktmpdir 'test3' do |dir|
       f = File.join(dir, 'bad.xml')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri