RFX::getEndDate() - Code Metrics - Inspection of "RfX Analysis and RfX Vote Calculator, Round 1" - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#67)

by MusikAnimal

created 2017-08-22 22:53 UTC

RFX::getEndDate() A

↳ Parent: RFX

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * An RFX object contains the parsed information for an RFX
 */

namespace Xtools;

/**
 * This class contains information about a single RfX page.
 */
class RFX
{
    /**
     * @var array Data we parsed out of the page text
     */
    private $data;

    /**
     * @var array Duplicate voters
     */
    private $duplicates;

    /**
     * @var null|string Username of the user we're looking for.
     */
    private $userLookingFor;

    /**
     * @var string Section we found the user we're looking for
     */
    private $userSectionFound;

    /**
     * @var string Ending date of the RFX
     */
    private $endDate;

    /**
     * Attempts to find a signature in $input using the default regex.
     * Returns matches.
     *
     * @param string $input   The line we're looking for
     * @param array  $matches Pointer to an array where we stash results
     *
     * @TODO: Make this cleaner
     *
     * @return int
     */
    protected function findSig($input, &$matches)
    {
        //Supports User: and User talk: wikilinks, {{fullurl}},

        // unsubsted {{unsigned}}, unsubsted {{unsigned2}},

        // anything that looks like a custom sig template
        // TODO: Cross-wiki this sucker
        $regexp
            = //1: Normal [[User:XX]] and [[User talk:XX]]

            "/\[\[[Uu]ser(?:[\s_][Tt]alk)?\:([^\]\|\/]*)(?:\|[^\]]*)?\]\]"
            //2: {{fullurl}} and {{unsigned}} templates

            . "|\{\{(?:[Ff]ullurl\:[Uu]ser(?:[\s_][Tt]alk)?\:|"
            . "[Uu]nsigned\|)([^\}\|]*)(?:|[\|\}]*)?\}\}"
            //3: {{User:XX/sig}} templates

            . "|(?:\{\{)[Uu]ser(?:[\s_][Tt]alk)?\:([^\}\/\|]*)"
            //4: {{unsigned2|Date|XX}} templates

            . "|\{\{[Uu]nsigned2\|[^\|]*\|([^\}]*)\}\}"
            //5: [[User:XX/sig]] links (compromise measure)

            . "|(?:\[\[)[Uu]ser\:([^\]\/\|]*)\/[Ss]ig[\|\]]/";

        return preg_match_all(
            $regexp,
            $input,
            $matches,
            PREG_OFFSET_CAPTURE
        );
    }

    /**
     * This function parses the wikitext and stores it within this function.
     * It's been split out to make this class testable
     *
     * @param array  $sectionArray Section names that we're looking for
     * @param string $rawWikiText  The text of the page we're parsing
     * @param string $dateRegexp   Valid Regular Expression for the end date
     *
     * @return null
     */
    private function setUp($sectionArray, $rawWikiText, $dateRegexp)
    {
        $this->data = array();

        $lines = explode("\n", $rawWikiText);

        $keys = join("|", $sectionArray);

        $lastSection = "";

        foreach ($lines as $line) {
            if (preg_match("/={1,6}\s?($keys)\s?={1,6}/i", $line, $matches)) {
                $lastSection = strtolower($matches[1]);
            } elseif ($lastSection == ""
                && preg_match(
                    "/$dateRegexp/i",
                    $line,
                    $matches
                )
            ) {
                $this->endDate = $matches[1];
            } elseif ($lastSection != ""
                && preg_match("/^\s*#?:.*/i", $line) === 0
            ) {
                $this->findSig($line, $matches);
                if (!isset($matches[1][0])) {
                    continue;
                }
                $foundUser = trim($matches[1][0][0]);
                $this->data[$lastSection][] = $foundUser;
                if (strtolower($foundUser) == strtolower($this->userLookingFor)) {
                    $this->userSectionFound = $lastSection;
                }
            }
        }

        $final = [];    // initialize the final array
        $finalRaw = []; // Initialize the raw data array

        foreach ($this->data as $key => $value) {
            $finalRaw = array_merge($finalRaw, $this->data[$key]);
        }

        foreach ($finalRaw as $foundUsername) {
            $final[] = $foundUsername; // group all array's elements
        }

        $final = array_count_values($final); // find repetition and its count

        $final = array_diff($final, [1]);    // remove single occurrences

        $this->duplicates = array_keys($final);
    }

    /**
     * RFX constructor.
     *
     * @param string      $rawWikiText    The text of the page we're parsing
     * @param array       $sectionArray   Section names that we're looking for
     * @param string      $userNamespace  Plain text of the user namespace
     * @param string      $dateRegexp     Valid Regular Expression for the end date
     * @param string|null $userLookingFor User we're trying to find.
     */
    public function __construct(
        $rawWikiText,
        $sectionArray = ["Support", "Oppose", "Neutral"],
        $userNamespace = "User",

        $dateRegexp = "final .*end(?:ing|ed)?(?: no earlier than)? (.*?)? \(UTC\)",
        $userLookingFor = null
    ) {
        $this->userLookingFor = $userLookingFor;

        $this->setUp($sectionArray, $rawWikiText, $dateRegexp);
    }

    /**
     * Which section we found the user we're looking for.
     *
     * @return string
     */
    public function getUserSectionFound()
    {
        return $this->userSectionFound;
    }

    /**
     * Returns data on the given section name.
     *
     * @param string $sectionName The section we're looking at
     *
     * @return array
     */
    public function getSection($sectionName)
    {
        $sectionName = strtolower($sectionName);
        if (!isset($this->data[$sectionName])) {
            return [];
        } else {
            return $this->data[$sectionName];
        }
    }

    /**
     * Get an array of duplicate votes.
     *
     * @return array
     */
    public function getDuplicates()
    {
        return $this->duplicates;
    }

    /**
     * Get the End Date of the RFX
     *
     * @return string
     */
    public function getEndDate()
    {
        return $this->endDate;
    }
}


1			<?php
2			/**
3			* An RFX object contains the parsed information for an RFX
4			*/
5
6			namespace Xtools;
7
8			/**
9			* This class contains information about a single RfX page.
10			*/
11			class RFX
12			{
13			/**
14			* @var array Data we parsed out of the page text
15			*/
16			private $data;
17
18			/**
19			* @var array Duplicate voters
20			*/
21			private $duplicates;
22
23			/**
24			* @var null\|string Username of the user we're looking for.
25			*/
26			private $userLookingFor;
27
28			/**
29			* @var string Section we found the user we're looking for
30			*/
31			private $userSectionFound;
32
33			/**
34			* @var string Ending date of the RFX
35			*/
36			private $endDate;
37
38			/**
39			* Attempts to find a signature in $input using the default regex.
40			* Returns matches.
41			*
42			* @param string $input The line we're looking for
43			* @param array $matches Pointer to an array where we stash results
44			*
45			* @TODO: Make this cleaner
46			*
47			* @return int
48			*/
49			protected function findSig($input, &$matches)
50			{
51			//Supports User: and User talk: wikilinks, {{fullurl}},
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
52			// unsubsted {{unsigned}}, unsubsted {{unsigned2}},
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
53			// anything that looks like a custom sig template
54			// TODO: Cross-wiki this sucker
55			$regexp
56			= //1: Normal [[User:XX]] and [[User talk:XX]]
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
57			"/\[\[[Uu]ser(?:[\s_][Tt]alk)?\:([^\]\\|\/])(?:\\|[^\]])?\]\]"
58			//2: {{fullurl}} and {{unsigned}} templates
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
59			. "\|\{\{(?:[Ff]ullurl\:[Uu]ser(?:[\s_][Tt]alk)?\:\|"
60			. "[Uu]nsigned\\|)([^\}\\|])(?:\|[\\|\}])?\}\}"
61			//3: {{User:XX/sig}} templates
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `47%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
62			. "\|(?:\{\{)[Uu]ser(?:[\s_][Tt]alk)?\:([^\}\/\\|]*)"
63			//4: {{unsigned2\|Date\|XX}} templates
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
64			. "\|\{\{[Uu]nsigned2\\|[^\\|]\\|([^\}])\}\}"
65			//5: [[User:XX/sig]] links (compromise measure)
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-07-27 05:24 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
66			. "\|(?:\[\[)[Uu]ser\:([^\]\/\\|]*)\/[Ss]ig[\\|\]]/";
67
68			return preg_match_all(
69			$regexp,
70			$input,
71			$matches,
72			PREG_OFFSET_CAPTURE
73			);
74			}
75
76			/**
77			* This function parses the wikitext and stores it within this function.
78			* It's been split out to make this class testable
79			*
80			* @param array $sectionArray Section names that we're looking for
81			* @param string $rawWikiText The text of the page we're parsing
82			* @param string $dateRegexp Valid Regular Expression for the end date
83			*
84			* @return null
85			*/
86			private function setUp($sectionArray, $rawWikiText, $dateRegexp)
87			{
88			$this->data = array();
89
90			$lines = explode("\n", $rawWikiText);
91
92			$keys = join("\|", $sectionArray);
93
94			$lastSection = "";
95
96			foreach ($lines as $line) {
97			if (preg_match("/={1,6}\s?($keys)\s?={1,6}/i", $line, $matches)) {
98			$lastSection = strtolower($matches[1]);
99			} elseif ($lastSection == ""
100			&& preg_match(
101			"/$dateRegexp/i",
102			$line,
103			$matches
104			)
105			) {
106			$this->endDate = $matches[1];
107			} elseif ($lastSection != ""
108			&& preg_match("/^\s#?:./i", $line) === 0
109			) {
110			$this->findSig($line, $matches);
111			if (!isset($matches[1][0])) {
112			continue;
113			}
114			$foundUser = trim($matches[1][0][0]);
115			$this->data[$lastSection][] = $foundUser;
116			if (strtolower($foundUser) == strtolower($this->userLookingFor)) {
117			$this->userSectionFound = $lastSection;
118			}
119			}
120			}
121
122			$final = []; // initialize the final array
123			$finalRaw = []; // Initialize the raw data array
124
125			foreach ($this->data as $key => $value) {
126			$finalRaw = array_merge($finalRaw, $this->data[$key]);
127			}
128
129			foreach ($finalRaw as $foundUsername) {
130			$final[] = $foundUsername; // group all array's elements
131			}
132
133			$final = array_count_values($final); // find repetition and its count
134
135			$final = array_diff($final, [1]); // remove single occurrences
136
137			$this->duplicates = array_keys($final);
138			}
139
140			/**
141			* RFX constructor.
142			*
143			* @param string $rawWikiText The text of the page we're parsing
144			* @param array $sectionArray Section names that we're looking for
145			* @param string $userNamespace Plain text of the user namespace
146			* @param string $dateRegexp Valid Regular Expression for the end date
147			* @param string\|null $userLookingFor User we're trying to find.
148			*/
149			public function __construct(
150			$rawWikiText,
151			$sectionArray = ["Support", "Oppose", "Neutral"],
152			$userNamespace = "User",
			0 ignored issues – show Unused Code introduced 2017-08-22 17:36 UTC by Report Bug Copy Issue Report The parameter `$userNamespace` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
153			$dateRegexp = "final .end(?:ing\|ed)?(?: no earlier than)? (.?)? \(UTC\)",
154			$userLookingFor = null
155			) {
156			$this->userLookingFor = $userLookingFor;
157
158			$this->setUp($sectionArray, $rawWikiText, $dateRegexp);
159			}
160
161			/**
162			* Which section we found the user we're looking for.
163			*
164			* @return string
165			*/
166			public function getUserSectionFound()
167			{
168			return $this->userSectionFound;
169			}
170
171			/**
172			* Returns data on the given section name.
173			*
174			* @param string $sectionName The section we're looking at
175			*
176			* @return array
177			*/
178			public function getSection($sectionName)
179			{
180			$sectionName = strtolower($sectionName);
181			if (!isset($this->data[$sectionName])) {
182			return [];
183			} else {
184			return $this->data[$sectionName];
185			}
186			}
187
188			/**
189			* Get an array of duplicate votes.
190			*
191			* @return array
192			*/
193			public function getDuplicates()
194			{
195			return $this->duplicates;
196			}
197
198			/**
199			* Get the End Date of the RFX
200			*
201			* @return string
202			*/
203			public function getEndDate()
204			{
205			return $this->endDate;
206			}
207			}
208

x-tools / xtools

Pull Request — master (#67)

RFX::getEndDate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like