phpcop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 743c6a613d5bf326b3021c4945eced461400280c
-  data.tar.gz: fc484f73e15bf03bc577e2f8ca05370b1be2e832
+  metadata.gz: de28dc7778c7b42e3b3c0c0607435ace13e54125
+  data.tar.gz: 8e330895bc41a6ece84839874dafa19335f25b61
 SHA512:
-  metadata.gz: 08044f4b9cd57894a303c7e79695f401365b0ae80836bdcfc2ffe34e422242026aa869ece3776da04edb2f5f0e5c2e49e7929b3010e0e20ebfff65606ecdee0c
-  data.tar.gz: 1cc847c3f46e232c3bd439d88ed2d3af62f2e21637e5cd4c81141feff6cd1f26d0a4bce73db80d203fb7e6fbbade9dbdce64bd1329b9792c3de00405680f0309
+  metadata.gz: c789c1f471f5c10fde1dfcd03ca18b92c3d8364fd004dc704d941dceadf2c038941190c3dc6d854c1bd1218aa59282c3780032394560a223fb812fae2107a8e9
+  data.tar.gz: 3c9283b591b42e5f976f698e60fd20caeca3a64d88559e170ca373155be20e153727dc4502c0da40598a7385363fe9a4dc459d1abd7f3e60d0ddf0f5c09fc5f3

data/README.md

@@ -21,3 +21,6 @@ Or install it yourself as:
 ## Usage
 
 Go to project and execute command `phpcop`.
+
+Use default config or create a .phpcop.yml in root to project. Copy default file
+'config/phpcop.yml'.

data/config/default.yml

@@ -11,7 +11,14 @@ php:
 AllCops:
   # Exclude:
   #    - '**/'
-  phpTags:
+  files/phpTags:
     enabled: true
-    description: 'PHP Tags'
+    description: >
+      PHP code MUST use the long <?php ?> tags or the short-echo <?= ?> tags; it
+      MUST NOT use the other tag variations.
     see: 'http://www.php-fig.org/psr/psr-1/#2-1-php-tags'
+  files/phpEncoding:
+    enabled: true
+    description: >
+      PHP code MUST use only UTF-8 without BOM.
+    see: 'http://www.php-fig.org/psr/psr-1/#2-2-character-encoding'

data/lib/phpcop/cli.rb

@@ -2,50 +2,18 @@ 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 :config_store
 
-    attr_reader :options, :config_store, :count_files
+    MSG_END = '%s fichier traité. %s erreurs.'.freeze
 
     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
+      runner = PhpCop::Runner.new(@config_store)
+      puts format(MSG_END, runner.count_files, runner.count_errors)
     end
   end
 end

data/lib/phpcop/configloader.rb

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

data/lib/phpcop/configstore.rb

@@ -1,7 +1,21 @@
 module PhpCop
-  # Store configuration of gems
+  # Store configuration of gems.
+  # Parse config file and test if option is enabled
   class ConfigStore
+    attr_reader :options, :rules
+
     def initialize
+      opt = ConfigLoader.new
+      @options = opt.options
+      @rules = []
+
+      @options.fetch('AllCops').each do |val|
+        @rules.push PhpCop::Rule.new(val[0], val[1])
+      end
+    end
+
+    def rules_by_type(type)
+      @rules.select { |rule| rule.type.eql? type }
     end
   end
 end

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

@@ -0,0 +1,10 @@
+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
+      end
+    end
+  end
+end

data/lib/phpcop/rule.rb

@@ -0,0 +1,15 @@
+module PhpCop
+  # Object represent a rule in yaml configuration file
+  class Rule
+    attr_reader :name, :type, :enabled, :description, :see
+
+    def initialize(name, option = {})
+      nt = name.split('/')
+      @name = nt[1]
+      @type = nt[0]
+      @enabled = option['enabled']
+      @description = option['description']
+      @see = option['see']
+    end
+  end
+end

data/lib/phpcop/runner.rb

@@ -1,5 +1,78 @@
 module PhpCop
   # This class runner
   class Runner
+    EXT = %w(.php .phtml .php.dist).freeze
+    EXCLUDE_FOLDER = %w(. .. .git .gitignore vendor).freeze
+
+    attr_reader :count_files, :count_errors
+
+    def initialize(config_store)
+      @count_files = 0
+      @count_errors = 0
+      @conf = config_store
+      @rules = @conf.rules
+      @types = { files: false }
+
+      Dir.foreach(Dir.pwd) do |file|
+        run_folder(file, Dir.pwd)
+      end
+    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
+
+    # Test each rules
+    def execute_tests_in_file(file, path)
+      @count_files += 1
+      file_with_path = format('%s/%s', path, file)
+      types_default
+      @rules.each do |value|
+        case value.type
+        when 'files'
+          test_file(file_with_path, value.type) unless @types['files']
+        end
+      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
+      end
+      @types['files'] = true
+    end
+
+    def test_file_php_tags(file)
+      test = PhpCop::Cop::Files::PhpTags.new(file)
+      @count_errors += test.errors
+    end
+
+    def test_file_php_encoding
+      true
+    end
+
+    def types_default
+      @types.map { |k, _| @types[k] = false }
+    end
   end
 end

data/lib/phpcop/version.rb

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

data/lib/phpcop.rb

@@ -4,5 +4,7 @@ require 'phpcop/configloader'
 require 'phpcop/configstore'
 require 'phpcop/cli'
 require 'phpcop/runner'
+require 'phpcop/rule'
 
 require 'phpcop/cop/files/phptags.rb'
+require 'phpcop/cop/files/phpencoding.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phpcop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy VAILLANT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,9 @@ files:
 - lib/phpcop/cli.rb
 - lib/phpcop/configloader.rb
 - lib/phpcop/configstore.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