phpcs 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 546837ec1fca4e9addd0f89f9cd14f1547014fcc
+  data.tar.gz: 7e0e3b4d4dca2c818699a9dc9486ddea3dff2b86
+SHA512:
+  metadata.gz: 1277e55e91dedf79d29109fc151c8e30cdbc45afbd4e769a5d3e3511bd9242a9568f84d19780b1fd9f0d3fafa9b35f242cda9a3f76c7ebae5ee653b1e3f165ca
+  data.tar.gz: 1981bc2df470826dd38ede08da22b3b8d4e35de22afc7d8d09ae78376871f5688a467b710a621620d168eba821fb34046fdb92ac3f5bfecc54e3a0362d7818c3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,17 @@
+language: php
+
+php:
+  - 5.4
+  - 5.5
+
+before_install:
+  - pyrus install pear/PHP_CodeSniffer
+  - phpenv rehash
+
+script:
+  - gem update bundler
+  - bundle install
+  - bundle exec rake
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Craftsmen
+
+MIT License
+
+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
+NONINFRINGEMENT. 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.

data/README.md

@@ -0,0 +1,35 @@
+[![Build Status](https://magnum.travis-ci.com/craftsmen/phpcs-rb.svg?token=CdVCrysG3xdFiGU8XWq1&branch=0.0.1)](https://magnum.travis-ci.com/craftsmen/phpcs-rb)
+
+# Phpcs
+
+Phpcs is a ruby wrapper for Php_CodeSniffer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phpcs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phpcs
+
+## Usage
+
+Take a look to `test/phpcs_test.rb` to understand how to use it.
+
+You can choose one of the follwing coding standards: `PEAR, PHPCS, PSR1, PSR2 (default), Squiz, Zend`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/foo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/lib/phpcs.rb

@@ -0,0 +1,52 @@
+require 'tempfile'
+require 'base64'
+require 'open3'
+require 'json'
+
+module Phpcs
+  class Match < Struct.new(:line, :comment)
+  end
+
+  class Phpcs
+    STANDARDS = [
+      'PEAR',
+      'PHPCS',
+      'PSR1',
+      'PSR2',
+      'Squiz',
+      'Zend'
+    ]
+
+    def initialize(standard = nil)
+      @standard = (STANDARDS.include? standard) ? standard : 'PSR2'
+    end
+
+    def lint(content)
+      code = Base64.encode64(content).strip[0..16]
+      file = Tempfile.new(code)
+      file.write(content)
+      file.close
+
+      stdin, stdout, stderr, wait_thr = Open3.popen3('phpcs', file.path, "--standard=#{@standard}", '--report=json')
+
+      out = JSON.load(stdout.read)
+
+      if out['totals']['errors'] > 0
+        parse_matches(out)
+      else
+        []
+      end
+    end
+
+    def parse_matches(body)
+      path = body['files'].keys.first
+      errors = body['files'][path]
+      matches = []
+
+      errors['messages'].each do |error|
+        matches << Match.new(error['line'], error['message'])
+      end
+      matches
+    end
+  end
+end

data/lib/phpcs/version.rb

@@ -0,0 +1,3 @@
+module Phpcs
+  VERSION = "0.0.3"
+end

data/phpcs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phpcs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'phpcs'
+  spec.version       = Phpcs::VERSION
+  spec.authors       = ['Kevin Chavanne']
+  spec.email         = ['kevin@craftsmen.io']
+  spec.summary       = %q{Ruby wrapper for phpcs}
+  spec.description   = %q{Ruby wrapper for phpcs}
+  spec.homepage      = 'https://github.com/craftsmen/phpcs-rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_dependency 'json', '~> 1.8'
+end

data/test/fixtures/foo.php

@@ -0,0 +1,11 @@
+<?php
+
+class Foo {
+
+	public function bar() {
+	  return 'hello';
+	}
+
+}
+
+?>

data/test/phpcs_test.rb

@@ -0,0 +1,84 @@
+require 'minitest/autorun'
+require 'phpcs'
+require 'minitest/pride'
+
+class PhpcsTest < Minitest::Test
+  def test_defaut_standard
+    file = File.open('test/fixtures/foo.php')
+    phpcs = Phpcs::Phpcs.new
+    results = phpcs.lint(file.read)
+
+    assert_equal results[0].line, 3
+    assert_equal results[0].comment, 'Each class must be in a namespace of at least one level (a top-level vendor name)'
+    assert_equal results[1].line, 3
+    assert_equal results[1].comment, 'Opening brace of a class must be on the line after the definition'
+    assert_equal results[2].line, 5
+    assert_equal results[2].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[3].line, 5
+    assert_equal results[3].comment, 'Line indented incorrectly; expected at least 4 spaces, found 1'
+    assert_equal results[4].line, 5
+    assert_equal results[4].comment, 'Line indented incorrectly; expected 4 spaces, found 1'
+    assert_equal results[5].line, 5
+    assert_equal results[5].comment, 'Opening brace should be on a new line'
+    assert_equal results[6].line, 6
+    assert_equal results[6].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[7].line, 6
+    assert_equal results[7].comment, 'Line indented incorrectly; expected at least 8 spaces, found 3'
+    assert_equal results[8].line, 7
+    assert_equal results[8].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[9].line, 9
+    assert_equal results[9].comment, 'The closing brace for the class must go on the next line after the body'
+    assert_equal results[10].line, 11
+    assert_equal results[10].comment, 'A closing tag is not permitted at the end of a PHP file'
+  end
+
+  def test_pear_standard
+    file = File.open('test/fixtures/foo.php')
+    phpcs = Phpcs::Phpcs.new('PEAR')
+    results = phpcs.lint(file.read)
+
+    assert_equal results[0].line, 2
+    assert_equal results[0].comment, 'Missing file doc comment'
+    assert_equal results[1].line, 3
+    assert_equal results[1].comment, 'Missing class doc comment'
+    assert_equal results[2].line, 3
+    assert_equal results[2].comment, 'Opening brace of a class must be on the line after the definition'
+    assert_equal results[3].line, 5
+    assert_equal results[3].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[4].line, 5
+    assert_equal results[4].comment, 'Line indented incorrectly; expected at least 4 spaces, found 1'
+    assert_equal results[5].line, 5
+    assert_equal results[5].comment, 'Missing function doc comment'
+    assert_equal results[6].line, 5
+    assert_equal results[6].comment, 'Line indented incorrectly; expected 4 spaces, found 1'
+    assert_equal results[7].line, 5
+    assert_equal results[7].comment, 'Opening brace should be on a new line'
+    assert_equal results[8].line, 6
+    assert_equal results[8].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[9].line, 6
+    assert_equal results[9].comment, 'Line indented incorrectly; expected at least 8 spaces, found 3'
+    assert_equal results[10].line, 7
+    assert_equal results[10].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+  end
+
+  def test_zend_standard
+    file = File.open('test/fixtures/foo.php')
+    phpcs = Phpcs::Phpcs.new('Zend')
+    results = phpcs.lint(file.read)
+
+    assert_equal results[0].line, 3
+    assert_equal results[0].comment, 'Opening brace of a class must be on the line after the definition'
+    assert_equal results[1].line, 5
+    assert_equal results[1].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[2].line, 5
+    assert_equal results[2].comment, 'Opening brace should be on a new line'
+    assert_equal results[3].line, 6
+    assert_equal results[3].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[4].line, 7
+    assert_equal results[4].comment, 'Spaces must be used to indent lines; tabs are not allowed'
+    assert_equal results[5].line, 11
+    assert_equal results[5].comment, 'A closing tag is not permitted at the end of a PHP file'
+  end
+
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: phpcs
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Kevin Chavanne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Ruby wrapper for phpcs
+email:
+- kevin@craftsmen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/phpcs.rb
+- lib/phpcs/version.rb
+- phpcs.gemspec
+- test/fixtures/foo.php
+- test/phpcs_test.rb
+homepage: https://github.com/craftsmen/phpcs-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for phpcs
+test_files:
+- test/fixtures/foo.php
+- test/phpcs_test.rb