Simplify the way shims are created

CHANGELOG.md

@@ -1,9 +1,12 @@
 CHANGE LOG
 ==========
 
+## 1.0.3 (2014-09-12)
+ - Simplify the way shims are created.
+
 ## 1.0.2 (2014-09-11)
- - Wrong encoding of Hebrew dates
- - Emulate PHP bug 54254 in Hebrew dates
+ - Wrong encoding of Hebrew dates.
+ - Emulate PHP bug 54254 in Hebrew dates.
 
 ## 1.0.1 (2014-09-11)
  - Improve coverage of unit tests.

README.md

@@ -45,25 +45,31 @@ Add the package as a dependency in your `composer.json` file:
         "fisharebest/ext-calendar": "1.*"
     }
 
-Bootstrap the package:
+If you want to create the “shim” functions, you must tell the package to create them.
 
-    // bootstrap.php
-    require 'vendor/autoload.php';
-    \Fisharebest\ExtCalendar\Bootstrap::init();
+    // Put this in your bootstrap.php or similar.
+    \Fisharebest\ExtCalendar\Shim::create();
 
-Use the PHP functions, whether the extension is loaded or not:
+Now you can use the PHP functions, whether the ext/calendar is installed or not:
 
     print_r(cal_info(CAL_GREGORIAN));
 
-Use the calendar classes directly:
+Alternatively, just use the calendar classes directly.
 
+    // Create a calendar
+    $cal = new FrenchCalendar;
+    $cal = new GregorianCalendar;
     $cal = new JewishCalendar;
+    $cal = new JulianCalendar;
+
+    // Date conversions
     $jd = $cal->ymdToJd($year, $month, $day);
     list($year, $month, $day) = $cal->jdToYmd($jd);
+
+    // Information functions (see the source for more)
     $is_leap_year = $cal->leapYear($year);
     $day_of_week = $cal->dayOfWeek($jd);
     $month_length = $cal->daysInMonth($year, $month);
-    // See the source for more…
 
 Known restrictions and limitations
 ==================================

src/Shim.php

@@ -22,6 +22,17 @@
  *            along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class Shim {
+	/**
+	 * Create the necessary shims to emulate the ext/calendar packate.
+	 *
+	 * @return void
+	 */
+	public static function create() {
+		if (!function_exists('cal_info')) {
+			require __DIR__ . '/shims.php';
+		}
+	}
+
 	/**
 	 * Do we need to emulate PHP bug #54254?
 	 *

test/ShimTest.php

@@ -32,6 +32,16 @@ class ShimTest extends TestCase {
 	 */
 	const LARGE_PRIME = 235741;
 
+	/**
+	 * Test that after we call create(), we have the necessary functions/constants.
+	 *
+	 * @return void
+	 */
+	public function testCreate() {
+		Shim::create();
+		$this->assertTrue(defined('CAL_JEWISH'));
+	}
+
 	/**
 	 * Test the implementation of Shim::calDaysInMonth() against \cal_days_in_month()
 	 *