phpcop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 743c6a613d5bf326b3021c4945eced461400280c
+  data.tar.gz: fc484f73e15bf03bc577e2f8ca05370b1be2e832
+SHA512:
+  metadata.gz: 08044f4b9cd57894a303c7e79695f401365b0ae80836bdcfc2ffe34e422242026aa869ece3776da04edb2f5f0e5c2e49e7929b3010e0e20ebfff65606ecdee0c
+  data.tar.gz: 1cc847c3f46e232c3bd439d88ed2d3af62f2e21637e5cd4c81141feff6cd1f26d0a4bce73db80d203fb7e6fbbade9dbdce64bd1329b9792c3de00405680f0309

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phpcop.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vaillant Jeremy
+
+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,23 @@
+# Phpcop
+
+Tools for detect error (PSRs)[http://www.php-fig.org/].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phpcop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phpcop
+
+## Usage
+
+Go to project and execute command `phpcop`.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/phpcop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'phpcop'
+require 'benchmark'
+
+cli = PhpCop::CLI.new
+result = 0
+
+puts format('Scan project : %s', Dir.pwd)
+
+time = Benchmark.realtime do
+  result = cli.run
+end
+
+puts "Finished in #{time} seconds"
+exit 0

data/config/default.yml

@@ -0,0 +1,17 @@
+# Configuration for application
+php:
+  # Precise PHP version
+  version: 7
+  # Precise convention used
+  rules:
+    - PSR-2
+  # Precise framework used
+  framework: zf-2
+
+AllCops:
+  # Exclude:
+  #    - '**/'
+  phpTags:
+    enabled: true
+    description: 'PHP Tags'
+    see: 'http://www.php-fig.org/psr/psr-1/#2-1-php-tags'

data/lib/phpcop/cli.rb

@@ -0,0 +1,51 @@
+module PhpCop
+  # The CLI is a class responsible of handling all the command line interface
+  # logic
+  class CLI
+    EXT = %w(.php .phtml .php.dist).freeze
+    EXCLUDE_FOLDER = %w(. .. .git .gitignore vendor).freeze
+
+    attr_reader :options, :config_store, :count_files
+
+    def initialize
+      @options = {}
+      @config_store = ConfigStore.new
+      @count_files = 0
+      @count_errors = 0
+    end
+
+    # Run all files
+    def run(_args = ARGV)
+      Dir.foreach(Dir.pwd) do |file|
+        run_folder(file, Dir.pwd)
+      end
+
+      puts format('%s fichier traité. %s erreurs.', @count_files, @count_errors)
+    end
+
+    private
+
+    def foreach_folder(path)
+      Dir.foreach(path) do |file|
+        run_folder(file, path)
+      end
+    end
+
+    def run_folder(file, path)
+      unless EXCLUDE_FOLDER.include?(file)
+        f = path + '/' + file
+        if File.directory?(f)
+          foreach_folder(f)
+        elsif EXT.include?(File.extname(file))
+          execute_tests_in_file(file, path)
+        end
+      end
+    end
+
+    def execute_tests_in_file(file, path)
+      @count_files += 1
+      test = PhpCop::Cop::Files::PhpTags.new(format('%s/%s', path, file))
+      @count_errors += test.errors
+    end
+  end
+end

data/lib/phpcop/configloader.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module Phpcop
+  # This class load a files configuration to gem. So config file default and
+  # customize config file in project scan
+  class ConfigLoader
+    # Config file in gem
+    DEFAULT_CONF = 'config/default.yml'.freeze
+    # Config file in project PHP
+    CUSTOMIZE_CONF = '.phpcop.yml'.freeze
+
+    def initialize
+      load_configuration(DEFAULT_CONF)
+      load_configuration(CUSTOMIZE_CONF)
+    end
+
+    private
+
+    def load_configuration(file)
+      File.exist?(file) ? YAML.load(file) : false
+    end
+  end
+end

data/lib/phpcop/configstore.rb

@@ -0,0 +1,7 @@
+module PhpCop
+  # Store configuration of gems
+  class ConfigStore
+    def initialize
+    end
+  end
+end

data/lib/phpcop/cop/files/phptags.rb

@@ -0,0 +1,61 @@
+module PhpCop
+  module Cop
+    module Files
+      # This class test file php use correctly tags PHP '<?php ?>' or '<?= ?>'
+      class PhpTags
+        MSG_ALERT = '%s, dont use correctly PHP Tags.'.freeze
+        TAG_OPEN = ['\<\?php', '\<\?='].freeze
+        TAG_CLOSE = ['\?\>'].freeze
+
+        attr_reader :errors
+
+        def initialize(file)
+          @count_open = 0
+          @count_close = 0
+          @errors = 0
+
+          # Open file and parse
+          f = File.open(file, 'r')
+          while (line = f.gets)
+            parse_line(line)
+          end
+
+          # Test counters if there are equal
+          test_counters(file)
+        end
+
+        private
+
+        def parse_line(line)
+          # Parse file and search tags exists
+          parse_and_search_open_tag(line)
+          # If file contains tag <?php or <?= search close tags
+          parse_and_search_close_tag(line)
+        end
+
+        # Parse file and search tags
+        def parse_and_search_open_tag(line)
+          TAG_OPEN.each do |rule|
+            @count_open += 1 if Regexp.new(rule).match line
+          end
+        end
+
+        def parse_and_search_close_tag(line)
+          TAG_CLOSE.each do |rule|
+            @count_close += 1 if Regexp.new(rule).match line
+          end
+        end
+
+        def test_counters(file)
+          return_an_error(file) unless @count_open == @count_close
+        end
+
+        # Return a text error with file name
+        def return_an_error(file)
+          puts format(MSG_ALERT, file)
+          @errors += 1
+        end
+      end
+    end
+  end
+end

data/lib/phpcop/runner.rb

@@ -0,0 +1,5 @@
+module PhpCop
+  # This class runner
+  class Runner
+  end
+end

data/lib/phpcop/version.rb

@@ -0,0 +1,4 @@
+# Module PHP Cop
+module Phpcop
+  VERSION = '0.1.0'.freeze
+end

data/lib/phpcop.rb

@@ -0,0 +1,8 @@
+require 'phpcop/version'
+
+require 'phpcop/configloader'
+require 'phpcop/configstore'
+require 'phpcop/cli'
+require 'phpcop/runner'
+
+require 'phpcop/cop/files/phptags.rb'

data/phpcop.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phpcop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'phpcop'
+  spec.version       = Phpcop::VERSION
+  spec.authors       = ['Jeremy VAILLANT']
+  spec.email         = ['vaillant.jeremy@dev-crea.com']
+
+  spec.summary       = 'Parse PHP code and analyser.'
+  spec.description   = 'Parser php files and gives non-respected guidelines.'
+  spec.homepage      = 'https://github.com/Dev-Crea/phpcop'
+
+  r = %r{^(test|spec|features)/}
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(r) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'overcommit', '~> 0.32.0'
+  spec.add_development_dependency 'rubocop', '~> 0.38.0'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: phpcop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy VAILLANT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+description: Parser php files and gives non-respected guidelines.
+email:
+- vaillant.jeremy@dev-crea.com
+executables:
+- phpcop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/phpcop
+- config/default.yml
+- lib/phpcop.rb
+- lib/phpcop/cli.rb
+- lib/phpcop/configloader.rb
+- lib/phpcop/configstore.rb
+- lib/phpcop/cop/files/phptags.rb
+- lib/phpcop/runner.rb
+- lib/phpcop/version.rb
+- phpcop.gemspec
+homepage: https://github.com/Dev-Crea/phpcop
+licenses: []
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Parse PHP code and analyser.
+test_files: []
+has_rdoc: