Merge pull request #11 from SimpleAstronomy/develop

Fix bug with finding a full moon

.gitignore

@@ -1,3 +1,6 @@
 /target/
 /bin/
 .DS_Store
+.classpath
+.settings/
+>>>>>>> master

README.md

@@ -1,5 +1,5 @@
 # simple-astronomy-lib
-A simple and free astronomy library for calculating moon phase.
+A simple and free astronomy library for calculating moon phases.
 
 A simple (and free) astronomy library for calculating moon phase, solar eclipses, etc. This is intended to be used as a library within other projects, thus the list of dependencies will remain as small as possible.
 
@@ -8,7 +8,11 @@ Initial code based on the book [_Practical Astronomy with your Calculator_](http
 NOTE: additional collaborators welcome
 
 ### Current Functionality
-* Moon Phase - find date for next phase of the moon (full or new)
+Find dates for Moon Phases
+ * full moon
+ * new moon
+ * first quarter
+ * last quarter 
 
 ### Getting Started / Example
 For a brief page on how to use this library, read the [Getting Started page](https://github.com/dustmachine/simple-astronomy-lib/blob/wiki/GettingStartedExample.md)

pom.xml

@@ -6,13 +6,13 @@
 
     <groupId>com.bradsbrain</groupId>
     <artifactId>SimpleAstronomyLib</artifactId>
-    <version>0.2.0</version>
+    <version>0.3.0</version>
 
     <dependencies>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
-            <version>4.0</version>
+            <version>4.4</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -45,8 +45,6 @@
 				</execution>
 				</executions>
 		    </plugin>
-		    <!-- FIXME: Damon, fix javadoc errors in the source. -->
-		    <!--
 		    <plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
@@ -59,7 +57,6 @@
 					</execution>
 				</executions>
 		    </plugin>
-		    -->
         </plugins>
     </build>
 

src/main/java/com/bradsbrain/simpleastronomy/BaseUtils.java

@@ -15,34 +15,20 @@
  */
 package com.bradsbrain.simpleastronomy;
 
-import java.text.DateFormat;
-import static java.text.DateFormat.SHORT;
-import java.text.SimpleDateFormat;
-import java.util.Calendar;
-import java.util.Date;
-import java.util.TimeZone;
+import java.time.ZoneId;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 
 public final class BaseUtils {
 
-    public static double exactDaysSince(Calendar myCal, double epoch) {
+    public static double exactDaysSince(ZonedDateTime myCal, double epoch) {
         return JulianDate.makeJulianDateUsingMyModified(myCal) - epoch;
     }
 
-
-
-
-    public static Calendar getSafeLocalCopy(long millis) {
-        // safe local copy
-        Calendar myCal = Calendar.getInstance(TimeZone.getTimeZone("GMT"));
-        myCal.clear();
-        myCal.setTimeInMillis(millis);
-        return myCal;
-    }
-
     public static double adjustTo360Range(double valToAdjust) {
         double howMany = Math.floor(valToAdjust / 360);
-        double adjustedValue = valToAdjust - (howMany * 360);
-        return adjustedValue;
+        return valToAdjust - (howMany * 360);
     }
 
     public static double sinDegrees(double angleInDegrees) {
@@ -61,29 +47,23 @@ public static double useLessPrecision(double d, int precision) {
     /**
      * Useful date-to-string formatting which I found myself using a lot
      *
-     * @param moonDate
+     * @param moonDate the date to format
      * @return the date in GMT timezone
      */
-    public static String formatDateForGMT(Date moonDate) {
-        DateFormat sdf = SimpleDateFormat.getDateInstance(SHORT);
-        ((SimpleDateFormat) sdf).applyPattern("yyyy-MM-dd");
-        ((SimpleDateFormat) sdf).setTimeZone(TimeZone.getTimeZone("GMT"));
-        return sdf.format(moonDate);
+    public static String formatDateForGMT(ZonedDateTime moonDate) {
+        DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd");
+        return moonDate.withZoneSameInstant(ZoneOffset.UTC).format(df);
     }
 
     /**
      * Useful date-to-string formatting which I found myself using a lot
      *
-     * @param moonDate
+     * @param moonDate date to format
      * @param tz the timezone with which to format the date
      * @return the date in whatever timezone is default
      */
-    public static String formatDateAsShortDateLocalTime(Date moonDate, TimeZone tz) {
-        DateFormat sdf = SimpleDateFormat.getDateInstance(SHORT);
-        sdf.setTimeZone(tz);
-        ((SimpleDateFormat) sdf).applyPattern("yyyy-MM-dd");
-        return sdf.format(moonDate);
+    public static String formatDateAsShortDateLocalTime(ZonedDateTime moonDate, ZoneId tz) {
+        return moonDate.withZoneSameInstant(tz).format(DateTimeFormatter.ofPattern("yyyy-MM-dd"));
     }
-
-
+
 }

src/main/java/com/bradsbrain/simpleastronomy/FullMoonFinder.java

@@ -20,16 +20,20 @@
  */
 public class FullMoonFinder implements MoonFinder {
 
-	private static final int _360 = 360;
-
-	private static final double ROTATE_ANGLE = 179.9;
+    private static final double _360 = 360;
+
+    /**
+     * This value is close to 180, but the calculate yield more accurate results
+     * compared to observatories with this value than with a higher value.
+     */
+    private static final double ROTATE_ANGLE = 179.95;
+
+    private static final double FULL_MOON_HALF_ANGLE = _360/ 2;
+
+    /** {@inheritDoc} */
+    public boolean isMoonBefore(double angle, double unused) {
+        double usefulAngle = (angle + ROTATE_ANGLE) % _360;     
+        return usefulAngle < FULL_MOON_HALF_ANGLE;
+    }
 
-	private static final double FULL_MOON_HALF_ANGLE = _360/ 2;
-
-	/** {@inheritDoc} */
-	public boolean isMoonBefore(double angle, double unused) {
-		double usefulAngle = (angle + ROTATE_ANGLE) % _360;
-
-		return FULL_MOON_HALF_ANGLE > usefulAngle;
-	}
 }

src/main/java/com/bradsbrain/simpleastronomy/JulianDate.java

@@ -15,7 +15,8 @@
  */
 package com.bradsbrain.simpleastronomy;
 
-import java.util.Calendar;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
 
 /**
  * Heavily based on procedures as documented in the
@@ -30,19 +31,19 @@ public class JulianDate {
      * This method is a simplification of formula in Section 3 of PAwyC3.
      * We'll assume we're only talking about Gregorian Calendar dates because
      * really, we don't care a whole lot about past dates.
-     *
-     * @param cal
-     * @return
+     * 
+     * @param cal the input date
+     * @return the julian date
      */
-    public static Double makeJulianDateUsingMyModified(Calendar cal) {
-        Calendar myCal = BaseUtils.getSafeLocalCopy(cal.getTimeInMillis());
+    public static Double makeJulianDateUsingMyModified(ZonedDateTime cal) {
+        cal = cal.withZoneSameInstant(ZoneOffset.UTC);
         // step 1
-        int year = myCal.get(Calendar.YEAR);
-        int month = myCal.get(Calendar.MONTH) + 1;    // fix the January=0
-        double day = myCal.get(Calendar.DAY_OF_MONTH);
-        double hour = myCal.get(Calendar.HOUR_OF_DAY) / 24.0;
-        double minute = myCal.get(Calendar.MINUTE) / 24.0 / 60.0;
-        double second = myCal.get(Calendar.SECOND) / 24.0 / 60.0 / 60.0;
+        int year = cal.getYear();
+        int month = cal.getMonthValue();
+        double day = cal.getDayOfMonth();
+        double hour = cal.getHour() / 24.0;
+        double minute = cal.getMinute() / 24.0 / 60.0;
+        double second = cal.getSecond() / 24.0 / 60.0 / 60.0;
 
         // step 2
         if (month <= 2) {

src/main/java/com/bradsbrain/simpleastronomy/MoonFinder.java

@@ -20,13 +20,13 @@
  */
 public interface MoonFinder {
 
-	/**
-	 * Determines if the desired moon type is earlier or later than the given information.
-	 * 
-	 * @param angle a moon angle
-	 * @param percent a moon visible percentage
-	 * @return true if the moon is earlier in time than the supplied information
-	 */
-	boolean isMoonBefore(double angle, double percent);
+    /**
+     * Determines if the desired moon type is earlier or later than the given information.
+     * 
+     * @param angle a moon angle
+     * @param percent a moon visible percentage
+     * @return true if the moon is earlier in time than the supplied information
+     */
+    boolean isMoonBefore(double angle, double percent);
 
 }