Merge pull request #152 from photodude/patch-7

[PHPCS2] add example XML files showing selectively applying the standard

Joomla/ExampleRulesets/Joomla-CMS/ruleset.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<ruleset name="Joomla-CMS">
+
+    <arg name="report" value="full"/>
+    <arg name="tab-width" value="4"/>
+    <arg name="encoding" value="utf-8"/>
+    <arg value="sp"/>
+    <arg name="colors" />
+
+    <!-- Exclude folders not containing production code -->
+    <exclude-pattern>*/build/*</exclude-pattern>
+    <exclude-pattern>*/tests/*</exclude-pattern>
+    <exclude-pattern>*/lib/*</exclude-pattern>
+    <exclude-pattern>*/tmpl/*</exclude-pattern>
+    <exclude-pattern>*/layouts/*</exclude-pattern>
+
+    <!-- Exclude 3rd party libraries. -->
+    <exclude-pattern>*/libraries/*</exclude-pattern>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/editors/*</exclude-pattern>
+
+    <rule ref="Joomla">
+        <exclude name="Joomla.NamingConventions.ValidVariableName.ClassVarHasUnderscore"/>
+        <exclude name="Joomla.NamingConventions.ValidFunctionName.FunctionNoCapital"/>
+        <exclude name="Joomla.NamingConventions.ValidVariableName.MemberNotCamelCaps"/>
+        <exclude name="Joomla.NamingConventions.ValidFunctionName.MethodUnderscore"/>
+        <exclude name="Joomla.NamingConventions.ValidVariableName.NotCamelCaps"/>
+        <exclude name="Joomla.NamingConventions.ValidFunctionName.ScopeNotCamelCaps"/>
+        <exclude name="Generic.Files.LineEndings.InvalidEOLChar"/>
+    </rule>
+</ruleset>

Joomla/ExampleRulesets/Joomla-Stats/ruleset.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<ruleset name="Joomla-Stats">
+
+    <arg name="report" value="full"/>
+    <arg name="tab-width" value="4"/>
+    <arg name="encoding" value="utf-8"/>
+    <arg value="sp"/>
+    <arg name="colors" />
+
+    <!-- Exclude folders not containing production code -->
+    <exclude-pattern>*/build/*</exclude-pattern>
+    <exclude-pattern>*/tests/*</exclude-pattern>
+    <exclude-pattern>*/lib/*</exclude-pattern>
+    <exclude-pattern>*/tmpl/*</exclude-pattern>
+    <exclude-pattern>*/layouts/*</exclude-pattern>
+
+    <!-- Exclude 3rd party libraries. -->
+    <exclude-pattern>*/libraries/*</exclude-pattern>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/editors/*</exclude-pattern>
+
+    <rule ref="Joomla">
+        <exclude name="Joomla.NamingConventions.ValidVariableName.MemberNotCamelCaps"/>
+        <exclude name="Joomla.NamingConventions.ValidVariableName.NotCamelCaps"/>
+        <exclude name="Joomla.NamingConventions.ValidFunctionName.ScopeNotCamelCaps"/>
+        <exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
+    </rule>
+
+    <rule ref="Joomla.Classes.InstantiateNewClasses">
+        <properties>
+            <property name="shortArraySyntax" value="true"/>
+        </properties>
+    </rule>
+</ruleset>

Joomla/ExampleRulesets/README.md

@@ -0,0 +1,55 @@
+### Selectively Applying Rules
+
+#### NOTE: this is an exact copy of the "Selectively Applying Rules" section of the main README and is here only for reference
+
+For consuming packages there are some items that will typically result in creating their own project ruleset.xml, rather than just directly using the Joomla ruleset.xml. A project ruleset.xml allows the coding standard to be selectivly applied for excluding 3rd party libraries, for consideration of backwards compatability in existing projects, or for adjustments necessary for projects that do not need php 5.3 compatability (which will be removed in a future version of the Joomla Coding Standard in connection of the end of php 5.3 support in all active Joomla Projects). 
+
+For information on [selectivly applying rules read details in the PHP CodeSniffer wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml#selectively-applying-rules)
+
+#### Common Rule Set Adjustments
+
+The most common adjustment is to exclude folders with 3rd party libraries, or where the code has yet to have coding standards applied.
+
+```xml
+<!-- Exclude folders not containing production code -->
+	<exclude-pattern type="relative">build/*</exclude-pattern>
+	<exclude-pattern type="relative">tests/*</exclude-pattern>
+
+	<!-- Exclude 3rd party libraries. -->
+	<exclude-pattern type="relative">libraries/*</exclude-pattern>
+	<exclude-pattern type="relative">vendor/*</exclude-pattern>
+```
+
+Another common adjustment is to exclude the [camelCase format requirement](http://joomla.github.io/coding-standards/?coding-standards/chapters/php.md) for "Classes, Functions, Methods, Regular Variables and Class Properties" the essentially allows for B/C with snake_case variables which were only allowed in the context of interacting with the database.
+
+```xml
+ <rule ref="Joomla">
+  <exclude name="Joomla.NamingConventions.ValidFunctionName.ScopeNotCamelCaps"/>
+  <exclude name="Joomla.NamingConventions.ValidVariableName.NotCamelCaps"/>
+  <exclude name="Joomla.NamingConventions.ValidVariableName.MemberNotCamelCaps"/>
+  <exclude name="Joomla.NamingConventions.ValidFunctionName.FunctionNoCapital"/>
+ </rule>
+```
+
+Old Protected method names were at one time prefixed with an underscore. These Protected method names with underscores are depreceated in Joomla projects but for B\C reasons are still in the projects. As such excluding the MethodUnderscore sniff is a common ruleset adjustment
+
+```xml
+ <rule ref="Joomla">
+  <exclude name="Joomla.NamingConventions.ValidFunctionName.MethodUnderscore"/>
+  <exclude name="Joomla.NamingConventions.ValidVariableName.ClassVarHasUnderscore"/>
+ </rule>
+```
+
+The last most common adjustment is removing PHP 5.3 specific rules which prevent short array syntax, and allowing short array syntax for method parameters.
+
+```xml
+ <rule ref="Generic">
+  <exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
+ </rule>
+ <rule ref="Joomla.Classes.InstantiateNewClasses">
+   <properties>
+     <property name="shortArraySyntax" value="true"/>
+   </properties>
+ </rule>
+
+```