phpcop 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de28dc7778c7b42e3b3c0c0607435ace13e54125
-  data.tar.gz: 8e330895bc41a6ece84839874dafa19335f25b61
+  metadata.gz: 7ef9b83034da7e194fb6d2ed9f9d98ebd1c4b2ba
+  data.tar.gz: 2707957b3b3b80b58e03babe2acf2eec19808805
 SHA512:
-  metadata.gz: c789c1f471f5c10fde1dfcd03ca18b92c3d8364fd004dc704d941dceadf2c038941190c3dc6d854c1bd1218aa59282c3780032394560a223fb812fae2107a8e9
-  data.tar.gz: 3c9283b591b42e5f976f698e60fd20caeca3a64d88559e170ca373155be20e153727dc4502c0da40598a7385363fe9a4dc459d1abd7f3e60d0ddf0f5c09fc5f3
+  metadata.gz: 84d475a58cecdcf05d00ea15c36241af52ca3a4704ec8dc3e52947ce15a7e07d86af26b5d43865456bd0f86340609ebd7d842f3005aeb59d294c8c23ee22d06d
+  data.tar.gz: 0833da19a707ac122d95aedd14fcfd86642db1a5a66a5a3e23569e64c7593619d5b21aa6bb9c1849877e2b111dc226e49a1eff77772cf8d1eca5b369e3bbc860

data/bin/phpcop

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
 
 require 'phpcop'
 require 'benchmark'

data/config/default.yml

@@ -22,3 +22,8 @@ AllCops:
     description: >
       PHP code MUST use only UTF-8 without BOM.
     see: 'http://www.php-fig.org/psr/psr-1/#2-2-character-encoding'
+  ccpm/methods:
+    enabled: true
+    description: >
+      http://www.php-fig.org/psr/psr-1/#4-3-methods
+    see: 'http://www.php-fig.org/psr/psr-1/#4-3-methods'

data/lib/phpcop/cli.rb

@@ -1,10 +1,13 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module PhpCop
   # The CLI is a class responsible of handling all the command line interface
   # logic
   class CLI
     attr_reader :config_store
 
-    MSG_END = '%s fichier traité. %s erreurs.'.freeze
+    MSG_END = '%s fichier traité. %s erreurs.'
 
     def initialize
       @config_store = ConfigStore.new

data/lib/phpcop/configloader.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'yaml'
 
 module PhpCop
@@ -9,9 +12,9 @@ module PhpCop
     # Path to gem
     DEFAULT_PATH = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
     # Config file in gem
-    DEFAULT_CONF = File.join(DEFAULT_PATH, 'config', 'default.yml').freeze
+    DEFAULT_CONF = File.join(DEFAULT_PATH, 'config', 'default.yml')
     # Config file in project PHP
-    CUSTOMIZE_CONF = '.phpcop.yml'.freeze
+    CUSTOMIZE_CONF = '.phpcop.yml'
 
     def initialize
       @options = load_configuration(DEFAULT_CONF)

data/lib/phpcop/configstore.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module PhpCop
   # Store configuration of gems.
   # Parse config file and test if option is enabled

data/lib/phpcop/cop/ccpm/methods.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string'
+
+module PhpCop
+  module Cop
+    # Acronym to Class Constants, Properties and Methods
+    module CCPM
+      # Test method in php class
+      class Methods < Cop
+        MSG_ALERT_DESCRIB = 'Name method is not in camelCase().'
+
+        def initialize(file, line, line_number)
+          super(file, line.to_s, line_number)
+          test_line
+        end
+
+        private
+
+        def test_line
+          test_camel_case_method if @line.include?(' function ')
+        end
+
+        def test_camel_case_method
+          name = @line.slice!(/function.*()/).gsub('function ', '')
+          name = name.gsub(/\(.*/, '')
+          unless name.include?('__')
+            name_camel = name.camelize(:lower)
+            return_an_error(@file, @line_number, 0) unless name_camel.eql? name
+          end
+        end
+
+        def return_an_error(file, line, column)
+          @errors += 1
+          line += 1
+          puts format(MSG_ALERT_FILE, file, line, column)
+          puts MSG_ALERT_DESCRIB
+          puts ''
+        end
+      end
+    end
+  end
+end

data/lib/phpcop/cop/cop.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module PhpCop
+  module Cop
+    # Generic class for all rules
+    class Cop
+      attr_reader :errors
+      # Display an error 'fichier.ext:line:column'
+      MSG_ALERT_FILE = '%s:%s:%s'
+
+      def initialize(file, line, line_number)
+        @count_open = 0
+        @count_close = 0
+        @errors = 0
+        @file = file
+        @line = line
+        @line_number = line_number
+      end
+
+      private
+
+      def return_an_error(file, line, column)
+        @errors += 1
+        line += 1
+        puts format(MSG_ALERT_FILE, file, line, column)
+      end
+    end
+  end
+end

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

@@ -1,9 +1,41 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module PhpCop
   module Cop
     module Files
       # This class test file php use correctly encoding type
-      class PhpEncoding
-        MSG_ALERT = '%s, is not encoding in UTF-8 without BOM.'.freeze
+      class PhpEncoding < Cop
+        MSG_ALERT_DESCRIB = 'Is not encoding in UTF-8 without BOM.'
+
+        def initialize(file, line, line_number)
+          super(file, line.to_s, line_number)
+          test_line
+        end
+
+        private
+
+        # Parse line and test if line is correctly enconding
+        def test_line
+          line_encoding = @line
+          unless line_encoding.ascii_only?
+            return_an_error(@file, @line_number, 0)
+          end
+        end
+
+        # TODO : Return position column to char non ASCII
+        def column_number
+          array = @line.split(/./)
+          array.each_with_index { |c, index| index unless c.ascii_only? }
+        end
+
+        def return_an_error(file, line, column)
+          @errors += 1
+          line += 1
+          puts format(MSG_ALERT_FILE, file, line, column)
+          puts MSG_ALERT_DESCRIB
+          puts ''
+        end
       end
     end
   end

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

@@ -1,59 +1,65 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 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
+      class PhpTags < Cop
+        attr_reader :count_open, :count_close
+
+        MSG_ALERT_DESCRIB = 'Dont use correctly PHP Tags.'
         TAG_OPEN = ['\<\?php', '\<\?='].freeze
         TAG_CLOSE = ['\?\>'].freeze
 
-        attr_reader :errors
-
-        def initialize(file)
-          @count_open = 0
-          @count_close = 0
-          @errors = 0
+        def initialize(file, line = nil, line_number = nil)
+          super(file, line, line_number)
+        end
 
-          # Open file and parse
-          f = File.open(file, 'r')
-          while (line = f.gets)
-            parse_line(line)
+        def test_counters
+          # Test if tags open is equal to tags close
+          unless @count_open == @count_close
+            return_an_error(@file, @line_number, 0)
           end
-
-          # Test counters if there are equal
-          test_counters(file)
         end
 
-        private
-
-        def parse_line(line)
+        # Parse line and test if line use correctly tags PHP
+        def test_line(line, line_number)
+          @line = line
+          @line_number = line_number
           # Parse file and search tags exists
-          parse_and_search_open_tag(line)
+          parse_and_search_open_tag
           # If file contains tag <?php or <?= search close tags
-          parse_and_search_close_tag(line)
+          parse_and_search_close_tag
         end
 
+        private
+
         # Parse file and search tags
-        def parse_and_search_open_tag(line)
+        def parse_and_search_open_tag
           TAG_OPEN.each do |rule|
-            @count_open += 1 if Regexp.new(rule).match line
+            @count_open += 1 if match_line(rule)
           end
         end
 
-        def parse_and_search_close_tag(line)
+        def parse_and_search_close_tag
           TAG_CLOSE.each do |rule|
-            @count_close += 1 if Regexp.new(rule).match line
+            @count_close += 1 if match_line(rule)
           end
         end
 
-        def test_counters(file)
-          return_an_error(file) unless @count_open == @count_close
+        def match_line(rule)
+          Regexp.new(rule).match @line.encode('UTF-16be',
+                                              invalid: :replace,
+                                              replace: '?').encode('UTF-8')
         end
 
-        # Return a text error with file name
-        def return_an_error(file)
-          puts format(MSG_ALERT, file)
+        def return_an_error(file, line, column)
           @errors += 1
+          line += 1
+          puts format(MSG_ALERT_FILE, file, line, column)
+          puts MSG_ALERT_DESCRIB
+          puts ''
         end
       end
     end

data/lib/phpcop/rule.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module PhpCop
   # Object represent a rule in yaml configuration file
   class Rule

data/lib/phpcop/runner.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module PhpCop
   # This class runner
   class Runner
@@ -40,39 +43,47 @@ module PhpCop
     # Test each rules
     def execute_tests_in_file(file, path)
       @count_files += 1
-      file_with_path = format('%s/%s', path, file)
-      types_default
+      line_number = 0
+      # Execute all test in file
+      f = File.open(format('%s/%s', path, file), 'r')
+      @php_tag = PhpCop::Cop::Files::PhpTags.new(file)
+      while (line = f.gets)
+        parse_file(file, line, line_number)
+        line_number += 1
+      end
+      @php_tag.test_counters
+      @count_errors += @php_tag.errors
+    end
+
+    def parse_file(file, line, line_number)
       @rules.each do |value|
-        case value.type
-        when 'files'
-          test_file(file_with_path, value.type) unless @types['files']
-        end
+        parse_rule(value, file, line, line_number) if value.enabled
       end
     end
 
-    def test_file(file, type)
-      @conf.rules_by_type(type).each do |value|
-        case value.name
-        when 'phpTags'
-          test_file_php_tags(file) if value.enabled
-        when 'phpEncoding'
-          test_file_php_encoding if value.enabled
-        end
+    def parse_rule(rule, file, line, line_number)
+      case rule.name
+      when 'phpTags'
+        test_file_php_tags(line, line_number)
+      when 'phpEncoding'
+        test_file_php_encoding(file, line, line_number)
+      when 'methods'
+        test_ccpm_methods(file, line, line_number)
       end
-      @types['files'] = true
     end
 
-    def test_file_php_tags(file)
-      test = PhpCop::Cop::Files::PhpTags.new(file)
-      @count_errors += test.errors
+    def test_file_php_tags(line, line_number)
+      @php_tag.test_line(line, line_number)
     end
 
-    def test_file_php_encoding
-      true
+    def test_file_php_encoding(file, line, line_number)
+      test = PhpCop::Cop::Files::PhpEncoding.new(file, line, line_number)
+      @count_errors += test.errors
     end
 
-    def types_default
-      @types.map { |k, _| @types[k] = false }
+    def test_ccpm_methods(file, line, line_number)
+      test = PhpCop::Cop::CCPM::Methods.new(file, line, line_number)
+      @count_errors += test.errors
     end
   end
 end

data/lib/phpcop/version.rb

@@ -1,4 +1,6 @@
-# Module PHP Cop
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Phpcop
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.1'
 end

data/lib/phpcop.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'phpcop/version'
 
 require 'phpcop/configloader'
@@ -6,5 +9,7 @@ require 'phpcop/cli'
 require 'phpcop/runner'
 require 'phpcop/rule'
 
+require 'phpcop/cop/cop.rb'
 require 'phpcop/cop/files/phptags.rb'
 require 'phpcop/cop/files/phpencoding.rb'
+require 'phpcop/cop/ccpm/methods.rb'

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: phpcop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jeremy VAILLANT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,23 +94,21 @@ executables:
 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/ccpm/methods.rb
+- lib/phpcop/cop/cop.rb
 - lib/phpcop/cop/files/phpencoding.rb
 - lib/phpcop/cop/files/phptags.rb
 - lib/phpcop/rule.rb
 - lib/phpcop/runner.rb
 - lib/phpcop/version.rb
-- phpcop.gemspec
 homepage: https://github.com/Dev-Crea/phpcop
 licenses: []
 metadata: {}

data/.gitignore

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

data/Gemfile

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

data/Rakefile

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

data/phpcop.gemspec

@@ -1,26 +0,0 @@
-# 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