Refactoring.

Author: drupol

.php_cs.dist

@@ -1,6 +1,9 @@
 build:
-    environment:
-        php: '5.6'
+    nodes:
+        analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run
 
 filter:
     paths:
@@ -9,52 +12,6 @@ filter:
 tools:
     external_code_coverage:
         timeout: 600
-    php_mess_detector:
-        config:
-            code_size_rules: { cyclomatic_complexity: true, npath_complexity: true, excessive_method_length: true, excessive_class_length: true, excessive_parameter_list: true, excessive_public_count: true, too_many_fields: true, too_many_methods: true, excessive_class_complexity: true }
-            design_rules: { number_of_class_children: true, depth_of_inheritance: true, coupling_between_objects: true }
-            unused_code_rules: { unused_local_variable: true, unused_private_method: true, unused_formal_parameter: true }
-            naming_rules: { short_variable: true, long_variable: true, short_method: true, boolean_method_name: true }
-            controversial_rules: { camel_case_class_name: true, camel_case_property_name: true, camel_case_method_name: true, camel_case_parameter_name: true, camel_case_variable_name: true }
-    php_cs_fixer:
-        config:
-            level: all
-            fixers: { unused_use: true, phpdoc_params: true, braces: true, php_closing_tag: true }
-    php_analyzer:
-        config:
-            suspicious_code: { enabled: true, overriding_parameter: true, overriding_closure_use: true, parameter_closure_use_conflict: true, parameter_multiple_times: true, non_existent_class_in_instanceof_check: true, non_existent_class_in_catch_clause: true, assignment_of_null_return: true, non_commented_switch_fallthrough: true, non_commented_empty_catch_block: true, overriding_private_members: true, use_statement_alias_conflict: true, precedence_in_condition_assignment: true }
-            verify_php_doc_comments: { enabled: true, parameters: true, return: true, suggest_more_specific_types: true, ask_for_return_if_not_inferrable: true, ask_for_param_type_annotation: true }
-            loops_must_use_braces: { enabled: true }
-            simplify_boolean_return: { enabled: true }
-            phpunit_checks: { enabled: true }
-            reflection_fixes: { enabled: true }
-            use_statement_fixes: { enabled: true, order_alphabetically: true, remove_unused: true, preserve_multiple: false, preserve_blanklines: false }
-            parameter_reference_check: { enabled: false }
-            checkstyle: { enabled: false, no_trailing_whitespace: true, naming: { enabled: true, local_variable: '^[a-z][a-zA-Z0-9]*$', abstract_class_name: ^Abstract|Factory$, utility_class_name: 'Utils?$', constant_name: '^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$', property_name: '^[a-z][a-zA-Z0-9]*$', method_name: '^(?:[a-z]|__)[a-zA-Z0-9]*$', parameter_name: '^[a-z][a-zA-Z0-9]*$', interface_name: '^[A-Z][a-zA-Z0-9]*Interface$', type_name: '^[A-Z][a-zA-Z0-9]*$', exception_name: '^[A-Z][a-zA-Z0-9]*Exception$', isser_method_name: '^(?:is|has|should|may|supports)' } }
-            unreachable_code: { enabled: false }
-            check_access_control: { enabled: false }
-            typo_checks: { enabled: false }
-            check_variables: { enabled: false }
-            check_calls: { enabled: true, too_many_arguments: true, missing_argument: true, argument_type_checks: lenient }
-            dead_assignments: { enabled: false }
-            check_usage_context: { enabled: true, foreach: { value_as_reference: true, traversable: true } }
-            reflection_checks: { enabled: false }
-            precedence_checks: { enabled: true, assignment_in_condition: true, comparison_of_bit_result: true }
-            basic_semantic_checks: { enabled: false }
-            unused_code: { enabled: false }
-            deprecation_checks: { enabled: false }
-            useless_function_calls: { enabled: false }
-            metrics_lack_of_cohesion_methods: { enabled: false }
-            metrics_coupling: { enabled: true, stable_code: { namespace_prefixes: {  }, classes: {  } } }
-            doctrine_parameter_binding: { enabled: false }
-            doctrine_entity_manager_injection: { enabled: false }
-            symfony_request_injection: { enabled: false }
-            doc_comment_fixes: { enabled: false }
-    php_code_sniffer:
-        config:
-            standard: PSR2
-            sniffs: { psr2: { classes: { property_declaration_sniff: true }, methods: { method_declaration_sniff: true } } }
-    sensiolabs_security_checker: true
     php_loc: true
     php_pdepend: true
     php_sim: true

.scrutinizer.yml

@@ -12,12 +12,12 @@ php:
   - 5.6
   - 7.1
   - 7.2
+  - 7.3
 
 install:
   - composer install
 
 script:
-  - composer phpunit
   - composer grumphp
 
 after_success:

.travis.yml

@@ -34,7 +34,6 @@ objects), the library will still continue to work without any trouble.
 ## Requirements
 
 * PHP >= 5.6,
-* (optional) [PHPUnit](https://phpunit.de/) to run tests.
 
 ## How to use
 

README.md

@@ -1,6 +1,6 @@
 {
     "name": "drupol/phpermutations",
-    "description": "Generate iterators for array permutations in an efficient way.",
+    "description": "Generators and iterators, permutations and combinations.",
     "type": "library",
     "homepage": "https://github.com/drupol/phpermutations",
     "keywords": ["math", "numbers", "permutations", "combinations", "iterators", "fibonacci", "prime numbers", "product"],
@@ -9,7 +9,6 @@
         "issues": "https://github.com/drupol/phpermutations/issues",
         "source": "https://github.com/drupol/phpermutations"
     },
-    "minimum-stability": "stable",
     "authors": [
         {
             "name": "Pol Dellaiera",
@@ -20,20 +19,10 @@
         "php": ">= 5.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7",
-        "mockery/mockery": "^0.9",
-        "squizlabs/php_codesniffer": "^2.0",
-        "satooshi/php-coveralls": "^1.0",
-        "phpunit/php-code-coverage": "^4.0",
-        "scrutinizer/ocular": "^1.3",
-        "phpro/grumphp": "^0.13",
-        "jakub-onderka/php-parallel-lint": "^0.9.2",
-        "nikic/php-parser": "~2.1",
-        "sensiolabs/security-checker": "^4.1",
-        "phpmd/phpmd": "^2.6",
-        "sebastian/phpcpd": "^3.0",
-        "friendsofphp/php-cs-fixer": "^2.10"
-
+        "drupol/php-conventions": "^1.3",
+        "phpunit/phpunit": "^6",
+        "phpunit/php-code-coverage": "^5.0",
+        "scrutinizer/ocular": "^1.3"
     },
     "scripts": {
         "phpunit": "./vendor/bin/phpunit --coverage-clover build/logs/clover.xml -c tests/phpunit.xml tests",
@@ -45,5 +34,8 @@
             "drupol\\phpermutations\\": "src/",
             "drupol\\phpermutations\\Tests\\": "tests/src/"
         }
+    },
+    "config": {
+        "sort-packages": true
     }
 }

composer.json

@@ -21,8 +21,8 @@
  */
 include './vendor/autoload.php';
 
-for ($i = 2; $i < 15; ++$i) {
-    $input = range(1, $i);
+for ($i = 2; 15 > $i; ++$i) {
+    $input = \range(1, $i);
     $size = $i;
 
     echo '**********************************************************' . "\n";
@@ -32,7 +32,7 @@
 
     $j = 0;
     foreach ($Permutations->generator() as $permutation) {
-        if (!($array3 = array_intersect_assoc($input, $permutation))) {
+        if (!($array3 = \array_intersect_assoc($input, $permutation))) {
             ++$j;
         }
     }

examples/e.php

@@ -32,7 +32,7 @@
 
 $Fibonacci = new \drupol\phpermutations\Generators\Fibonacci();
 
-for ($i = 2; $i <= 50; $i = $i + 2) {
+for ($i = 2; 50 >= $i; $i = $i + 2) {
     $gen = $Fibonacci->generator();
 
     $input = [];
@@ -41,9 +41,9 @@
         $gen->next();
     }
 
-    $input = array_sum(array_filter(array_map(function ($item) {
-        return 4 * atan(1 / $item);
-    }, array_slice($input, 3)), function ($key) {
+    $input = \array_sum(\array_filter(\array_map(function ($item) {
+        return 4 * \atan(1 / $item);
+    }, \array_slice($input, 3)), function ($key) {
         return !($key % 2);
     }, ARRAY_FILTER_USE_KEY));
 

examples/pi.php

@@ -1,30 +1,14 @@
+imports:
+  - { resource: vendor/drupol/php-conventions/config/php56/grumphp.yml }
+
 parameters:
   git_dir: .
   bin_dir: bin
-  tasks:
-    phpcsfixer2:
-      allow_risky: false
-      cache_file: ~
-      config: .php_cs.dist
-      rules: []
-      using_cache: true
-      config_contains_finder: true
-      verbose: true
-      diff: true
-      triggered_by: ['php']
-    git_commit_message:
-      matchers:
-        - '/^(([A-Z]+\-\d+)|(#\d+)): [A-Z].+\./'
-      case_insensitive: false
-      multiline: false
+  extensions:
+    - drupol\PhpConventions\GrumphpTasksExtension
+  extra_tasks:
     phpunit:
       config_file: ./tests/phpunit.xml
       testsuite: ~
       group: []
       always_execute: false
-    securitychecker:
-      lockfile: ./composer.lock
-      format: ~
-      end_point: ~
-      timeout: ~
-      run_always: false

grumphp.yml.dist

@@ -5,7 +5,7 @@
 /**
  * Class Combinatorics.
  */
-abstract class Combinatorics implements \Countable
+abstract class Combinatorics
 {
     /**
      * The dataset.
@@ -33,30 +33,36 @@ abstract class Combinatorics implements \Countable
      *
      * @param array    $dataset
      *                          The dataset
-     * @param int|null $length
+     * @param null|int $length
      *                          The length
      */
     public function __construct(array $dataset = [], $length = null)
     {
         $this->setDataset($dataset);
-        $this->datasetCount = count($this->dataset);
+        $this->datasetCount = \count($this->dataset);
         $this->setLength($length);
     }
 
     /**
-     * Set the length.
-     *
-     * @param int $length
-     *                    The length
+     * Count elements of an object.
      *
-     * @return $this
+     * @return int
+     *             The number of element
      */
-    public function setLength($length = null)
+    public function count()
     {
-        $length = (null === $length) ? $this->datasetCount : $length;
-        $this->length = ($length > $this->datasetCount) ? $this->datasetCount : $length;
+        return \count($this->toArray());
+    }
 
-        return $this;
+    /**
+     * Get the dataset.
+     *
+     * @return mixed[]
+     *                 The dataset
+     */
+    public function getDataset()
+    {
+        return $this->dataset;
     }
 
     /**
@@ -86,50 +92,27 @@ public function setDataset(array $dataset = [])
     }
 
     /**
-     * Get the dataset.
+     * Set the length.
      *
-     * @return mixed[]
-     *                 The dataset
-     */
-    public function getDataset()
-    {
-        return $this->dataset;
-    }
-
-    /**
-     * Count elements of an object.
+     * @param null|int $length
+     *                    The length
      *
-     * @return int
-     *             The number of element
+     * @return $this
      */
-    public function count()
+    public function setLength($length = null)
     {
-        return count($this->toArray());
+        $length = (null === $length) ? $this->datasetCount : $length;
+        $this->length = (\abs($length) > $this->datasetCount) ? $this->datasetCount : $length;
+
+        return $this;
     }
 
     /**
-     * Convert the iterator into an array.
-     *
      * @return array
-     *               The elements
      */
     public function toArray()
     {
-        $data = [];
-
-        for ($this->rewind(); $this->valid(); $this->next()) {
-            $data[] = $this->current();
-        }
-
-        return $data;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function key()
-    {
-        return $this->key;
+        return [];
     }
 
     /**
@@ -145,6 +128,6 @@ public function key()
      */
     protected function fact($n, $total = 1)
     {
-        return ($n < 2) ? $total : $this->fact($n - 1, $total * $n);
+        return (2 > $n) ? $total : $this->fact($n - 1, $total * $n);
     }
 }