xcop 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 224e5335c950bd78ecfdef602bfb503ca1c42b2d
-  data.tar.gz: f5f46f16fdc922a08c4676cd00e036e7925f8434
+  metadata.gz: 5aa1f93ebccfdcec5e65a77c4d9a563ccbedb824
+  data.tar.gz: bfee771919d61c8fc4ca3adaf1c1031a992344c3
 SHA512:
-  metadata.gz: dda353bb1dd435d438304047cc7f904bad2dcd28a575ab5fb58a111a742b9067deb93fe3aa069f389d5c2e8b4cdd9afbc3c2ffd9092c6eba733fa3558b4e7a4c
-  data.tar.gz: dce36b9a1a547ebaafcb768ac0b0710d89441285c29fa7cc8592195f2ebf18ca6c90ca2d26055e88e74f370550692e693f0e3731fbbbb7a088e41108473f482f
+  metadata.gz: d6cb86b7d2a422f86d71c2729d20d179dac70e8e17a9e9eb577842bdfb416396293013ba49d1ec17bc92b4efe458e8e45c8e7cb3be57f32fe161a8207d0b4a94
+  data.tar.gz: 2d2b8245efe0a331ee2daf9e18fb454af68fb554d8497a5c2ca32d1e2deeb80a9ebdb288e72ae675bff52f8e76d5f8bfd78ed6247b97959bb713ca7251d5b3eb

data/.simplecov

@@ -29,9 +29,9 @@ if Gem.win_platform? then
     add_filter "/features/"
   end
 else
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-  ]
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter]
+  )
   SimpleCov.start do
     add_filter "/test/"
     add_filter "/features/"

data/README.md

@@ -10,7 +10,7 @@
 [![Code Climate](http://img.shields.io/codeclimate/github/yegor256/xcop.svg)](https://codeclimate.com/github/yegor256/xcop)
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/xcop.svg)](https://codecov.io/github/yegor256/xcop?branch=master)
 
-## What This is for?
+## What this is for?
 
 This command line tool validates your XML files for proper formatting.
 If they are not formatted correctly, it prints the difference and
@@ -18,7 +18,7 @@ returns with an error. You can use it two ways: 1) to fail your build
 if any X-like files (XML, XSD, XSL, XHTML) are not formatted correctly,
 and 2) to format them correctly.
 
-## How to Install?
+## How to install?
 
 Install it first:
 
@@ -26,7 +26,7 @@ Install it first:
 $ gem install xcop
 ```
 
-## How to Run?
+## How to run?
 
 Run it locally and read its output:
 
@@ -34,6 +34,20 @@ Run it locally and read its output:
 $ xcop --help
 ```
 
+## How to use in Rakefile?
+
+This is what you need there:
+
+```ruby
+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/**/*']
+end
+```
+
 ## How to contribute?
 
 Just submit a pull request. Make sure `rake` passes.

data/bin/xcop

@@ -50,22 +50,9 @@ Encoding.default_internal = Encoding::UTF_8
 
 license = opts.license? ? File.read(opts[:license]) : ''
 
-opts.arguments.each do |f|
-  print "Validating #{f}... "
-  doc = Xcop::Document.new(f)
-  diff = doc.diff
-  unless diff.empty?
-    print "Error\n"
-    puts diff
-    exit -1
-  end
-  unless license.empty?
-    ldiff = doc.ldiff(license)
-    unless ldiff.empty?
-      print "Broken license\n"
-      puts ldiff
-      exit -1
-    end
-  end
-  print "OK\n"
+begin
+  Xcop::CLI.new(opts.arguments, license).run
+rescue StandardError => e
+  puts e.message
+  exit -1
 end

data/features/gem_package.feature

@@ -13,7 +13,7 @@ Feature: Gem Package
       fail 'no executables: ' + File.read('./spec.rb')
     end
     """
-    When I run bash with
+    When I run bash with:
     """
     cd xcop
     gem build xcop.gemspec

data/features/rake.feature

@@ -0,0 +1,21 @@
+Feature: Rake tasks
+  As a source code writer I want to be able to
+  run Xcop from Rakefile
+
+  Scenario: Xcop can be used in Rakefile
+    Given It is Unix
+    And I have a "Rakefile" file with content:
+    """
+    require 'xcop/rake_task'
+    Xcop::RakeTask.new(:xcop) do |task|
+      task.includes = ['**/*.xml']
+    end
+    """
+    And I have a "good.xml" file with content:
+    """
+    <?xml version="1.0"?>
+    <hello>Hello, world!</hello>
+
+    """
+    When I run bash with "rake xcop"
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -73,7 +73,13 @@ Then(/^Exit code is not zero$/) do
   raise 'Zero exit code' if @exitstatus == 0
 end
 
-When(/^I run bash with$/) do |text|
+When(/^I run bash with "([^"]*)"$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'xcop'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+When(/^I run bash with:$/) do |text|
   FileUtils.copy_entry(@cwd, File.join(@dir, 'xcop'))
   @stdout = `#{text}`
   @exitstatus = $CHILD_STATUS.exitstatus

data/lib/xcop.rb

@@ -29,6 +29,34 @@ require_relative 'xcop/version'
 # Copyright:: Copyright (c) 2017 Yegor Bugayenko
 # License:: MIT
 module Xcop
+  # Command line interface.
+  class CLI
+    def initialize(files, license)
+      @files = files
+      @license = license
+    end
+
+    def run
+      @files.each do |f|
+        print "Validating #{f}... "
+        doc = Document.new(f)
+        diff = doc.diff
+        unless diff.empty?
+          puts diff
+          raise "Invalid XML formatting in #{f}"
+        end
+        unless @license.empty?
+          ldiff = doc.ldiff(@license)
+          unless ldiff.empty?
+            puts ldiff
+            raise "Broken license in #{f}"
+          end
+        end
+        print "OK\n"
+      end
+    end
+  end
+
   # One document.
   class Document
     # Ctor.

data/lib/xcop/rake_task.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+#
+# Copyright (c) 2017 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'rake'
+require 'rake/tasklib'
+require_relative '../xcop'
+
+# Xcop rake task.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2017 Yegor Bugayenko
+# License:: MIT
+module Xcop
+  # Rake task.
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name
+    attr_accessor :fail_on_error
+    attr_accessor :excludes
+    attr_accessor :includes
+    attr_accessor :license
+
+    def initialize(*args, &task_block)
+      @name = args.shift || :xcop
+      @includes = %w(xml xsd xhtml xsl html).map { |e| "**/*.#{e}" }
+      @excludes = []
+      @license = nil
+      desc 'Run Xcop' unless ::Rake.application.last_description
+      task(name, *args) do |_, task_args|
+        RakeFileUtils.send(:verbose, true) do
+          yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+          run
+        end
+      end
+    end
+
+    private
+
+    def run
+      require 'xcop'
+      bad = Dir.glob(@excludes)
+      good = Dir.glob(@includes).reject { |f| bad.include?(f) }
+      begin
+        Xcop::CLI.new(good, @license.nil? ? '' : File.read(@license)).run
+      rescue StandardError => e
+        abort(e.message)
+      end
+    end
+  end
+end

data/lib/xcop/version.rb

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

data/test/test_rake_task.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+#
+# Copyright (c) 2017 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require 'tmpdir'
+require 'rake'
+require_relative '../lib/xcop/rake_task'
+
+# Xcop rake task.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2017 Yegor Bugayenko
+# License:: MIT
+class TestRakeTask < Minitest::Test
+  def test_basic
+    Dir.mktmpdir 'test' do |dir|
+      Dir.chdir(dir)
+      File.write('a.xml', "<?xml version=\"1.0\"?>\n<x/>\n")
+      Xcop::RakeTask.new(:xcop1) do |task|
+        # task.license = 'LICENSE.txt'
+      end
+      Rake::Task['xcop1'].invoke
+    end
+  end
+
+  def test_with_broken_xml
+    Dir.mktmpdir 'test' do |dir|
+      Dir.chdir(dir)
+      File.write('broken.xml', "<z><a><b></b></a>\n\n</z>")
+      Xcop::RakeTask.new(:xcop2) do |task|
+        task.excludes = ['test/**/*']
+      end
+      assert_raises SystemExit do
+        Rake::Task['xcop2'].invoke
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -190,11 +190,14 @@ files:
 - cucumber.yml
 - features/cli.feature
 - features/gem_package.feature
+- features/rake.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - lib/xcop.rb
+- lib/xcop/rake_task.rb
 - lib/xcop/version.rb
 - test/test__helper.rb
+- test/test_rake_task.rb
 - test/test_xcop.rb
 - xcop.gemspec
 homepage: http://github.com/yegor256/xcop
@@ -225,7 +228,9 @@ summary: XML Formatting Static Validator
 test_files:
 - features/cli.feature
 - features/gem_package.feature
+- features/rake.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - test/test__helper.rb
+- test/test_rake_task.rb
 - test/test_xcop.rb