Merge pull request #23 from cs50/develop

Kareem Zidane · web-flow · commit 7630597704cc · 2017-06-14T04:34:50.000+03:00
v2.0.1
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 !.travis.yml
 build/
 docs/
+debian/changelog
+debian/*.log
diff --git a/.travis.yml b/.travis.yml
@@ -1,8 +1,24 @@
 language: java
-script: make build
+dist: trusty
+sudo: required
+before_install: sudo apt-get install build-essential debhelper devscripts dh-make lintian
+install: true
+before_script: echo -e $GPG_SECRET | gpg --import
+script: make deb
 before_deploy: make docs
 deploy:
-  provider: pages
+- provider: script
+  script: 'curl --fail --data "{ \"tag_name\": \"v$(make version)\",
+    \"target_commitish\": \"$TRAVIS_COMMIT\", \"name\": \"v$(make version)\"
+  }" --user bot50:$GITHUB_TOKEN https://api.github.com/repos/$TRAVIS_REPO_SLUG/releases'
+  on:
+    branch: master
+- provider: script
+  script: dput ppa:cs50/ppa build/deb/*.changes
+  skip_cleanup: true
+  on:
+    branch: master
+- provider: pages
   local_dir: docs
   name: bot50
   email: bot@cs50.harvard.edu
diff --git a/Makefile b/Makefile
@@ -1,85 +1,41 @@
-DESCRIPTION = CS50 Library for Java
-MAINTAINER = CS50 <sysadmins@cs50.harvard.edu>
-OLD_NAME = lib50-java
-NAME = libcs50-java
-VERSION = 2.0.0
-
-BUILD_DIR = build
-DEB_DIR = $(BUILD_DIR)/deb
-DOCS_DIR = docs
-JAR_DIR = $(BUILD_DIR)/usr/java/packages/lib/ext
-PACMAN_DIR = $(BUILD_DIR)/pacman
-RPM_DIR = $(BUILD_DIR)/rpm
-
-.PHONY: all
-all: clean deb pacman rpm
-
-.PHONY: bash
-bash:
-	docker run -i --rm -t -v "$(PWD):/root" cs50/cli
+DESTDIR ?= /usr/local/share/java
+VERSION = 2.0.1
 
 .PHONY: build
 build: clean Makefile src/edu/harvard/CS50.java
-	mkdir -p "$(JAR_DIR)"
-	javac -d "$(BUILD_DIR)" src/edu/harvard/CS50.java
-	jar cvf "$(JAR_DIR)/cs50.jar" -C "$(BUILD_DIR)" .
-	find "$(BUILD_DIR)" -type d -exec chmod 0755 {} +
-	find "$(BUILD_DIR)" -type f -exec chmod 0644 {} +
+	mkdir -p build/usr/share/java
+	javac -d build src/edu/harvard/CS50.java
+	cp src/edu/harvard/CS50.java build/edu/harvard
+	jar cvf build/usr/share/java/cs50.jar -C build .
 
 .PHONY: clean
 clean:
-	rm -rf "$(BUILD_DIR)"
+	rm -rf build libcs50-java* libcs50-java_*
 
 .PHONY: deb
 deb: build
-	mkdir -p "$(DEB_DIR)"
-	fpm \
-	-C "$(BUILD_DIR)" \
-	-m "$(MAINTAINER)" \
-	-n "$(NAME)" \
-	-p "$(DEB_DIR)" \
-	-s dir \
-	-t deb \
-	-v "$(VERSION)" \
-	--conflicts $(OLD_NAME) \
-	--provides $(OLD_NAME) \
-	--replaces $(OLD_NAME) \
-	--deb-no-default-config-files \
-	--depends java7-runtime \
-	--description "$(DESCRIPTION)" \
-	usr
+	@echo "libcs50-java ($(VERSION)-0ubuntu1) trusty; urgency=low" > debian/changelog
+	@echo "  * v$(VERSION)" >> debian/changelog
+	@echo " -- CS50 Sysadmins <sysadmins@cs50.harvard.edu>  $$(date --rfc-2822)" >> debian/changelog
+	mkdir -p libcs50-java-$(VERSION)
+	rsync -a build/usr libcs50-java-$(VERSION)
+	tar -cvzf libcs50-java_$(VERSION).orig.tar.gz libcs50-java-$(VERSION)
+	cp -r debian libcs50-java-$(VERSION)
+	cd libcs50-java-$(VERSION) && debuild -S -sa --lintian-opts --display-info --info --show-overrides
+	mkdir -p build/deb
+	mv libcs50-java* build/deb
 
 .PHONY: docs
 docs:
-	rm -rf $(DOCS_DIR)
-	javadoc -d "$(DOCS_DIR)" -linkoffline https://docs.oracle.com/javase/8/docs/api/ https://docs.oracle.com/javase/8/docs/api/ -sourcepath src edu.harvard
-
-# TODO: add dependencies
-.PHONY: pacman
-pacman: build
-	mkdir -p "$(PACMAN_DIR)"
-	fpm \
-	-C "$(BUILD_DIR)" \
-	-m "$(MAINTAINER)" \
-	-n "$(NAME)" \
-	-p "$(PACMAN_DIR)" \
-	-s dir \
-	-t pacman \
-	-v "$(VERSION)" \
-	--description "$(DESCRIPTION)" \
-	usr
-
-# TODO: add dependencies
-.PHONY: rpm
-rpm: build
-	mkdir -p "$(RPM_DIR)"
-	fpm \
-	-C "$(BUILD_DIR)" \
-	-m "$(MAINTAINER)" \
-	-n "$(NAME)" \
-	-p "$(RPM_DIR)" \
-	-s dir \
-	-t rpm \
-	-v "$(VERSION)" \
-	--description "$(DESCRIPTION)" \
-	usr
+	rm -rf docs
+	javadoc -d docs  -linkoffline https://docs.oracle.com/javase/8/docs/api/ \
+		https://docs.oracle.com/javase/8/docs/api/ -sourcepath src edu.harvard
+
+.PHONY: install
+install: build
+	mkdir -p $(DESTDIR)
+	cp -r build/usr/share/java/cs50.jar $(DESTDIR)
+
+.PHONY: version
+version:
+	@echo $(VERSION)
diff --git a/README.md b/README.md
@@ -6,15 +6,11 @@ http://cs50.github.io/libcs50-java/edu/harvard/CS50.html
 
 ## Development
 
-Requires [Docker Toolbox](https://www.docker.com/products/docker-toolbox).
-
-    make bash # runs CS50 CLI
-    make all # builds all
-    make build # builds class and JAR file in build/edu/harvard/ and build/usr/java/packages/lib/ext
-    make docs # builds documentation in build/docs/
-    make deb # builds deb package in build/deb/
-    make pacman # builds pacman package in build/pacman/
-    make rpm # builds rpm package in build/rpm/
+```
+    make build # builds class and JAR file
+    make docs # builds documentation
+    make deb # builds source deb package
+```
 
 ## Usage
 
diff --git a/debian/compat b/debian/compat
@@ -0,0 +1 @@
+9
diff --git a/debian/control b/debian/control
@@ -0,0 +1,16 @@
+Source: libcs50-java
+Priority: optional
+Maintainer: CS50 Sysadmins <sysadmins@cs50.harvard.edu>
+Build-Depends: debhelper (>= 9)
+Standards-Version: 3.9.5
+Section: java
+Vcs-Git: https://github.com/cs50/libcs50-java.git
+
+Package: libcs50-java
+Architecture: any
+Conflicts: lib50-java
+Depends: ${shlibs:Depends}, ${misc:Depends}
+Provides: lib50-java, libcs50-java
+Replaces: lib50-java, libcs50-java
+Description: CS50 library for Java
+ makes it easier to write programs that prompt the users for input
diff --git a/debian/copyright b/debian/copyright
@@ -0,0 +1,37 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: libcs50-java
+Source: http://github.com/cs50/libcs50-java/releases
+
+Files: *
+Copyright: 2017 David J. Malan <malan@harvard.edu>
+           2017 Kareem Zidane <kzidane@cs50.harvard.edu>
+License: BSD-3-Clause
+
+Files: debian/*
+Copyright: 2017 CS50 Sysadmins <sysadmins@cs50.harvard.edu>
+License: BSD-3-Clause
+
+License: BSD-3-Clause
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+ 3. Neither the name of the University nor the names of its contributors
+    may be used to endorse or promote products derived from this software
+    without specific prior written permission.
+ .
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE HOLDERS OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/debian/libcs50-java.dirs b/debian/libcs50-java.dirs
@@ -0,0 +1 @@
+/usr/share/java
diff --git a/debian/libcs50-java.install b/debian/libcs50-java.install
@@ -0,0 +1 @@
+/usr/share/java/*
diff --git a/debian/rules b/debian/rules
@@ -0,0 +1,8 @@
+#!/usr/bin/make -f
+# -*- makefile -*-
+
+# Uncomment this to turn on verbose mode.
+#export DH_VERBOSE=1
+
+%:
+	dh $@
diff --git a/debian/source/format b/debian/source/format
@@ -0,0 +1 @@
+3.0 (quilt)
diff --git a/debian/watch b/debian/watch
diff --git a/src/edu/harvard/CS50.java b/src/edu/harvard/CS50.java
@@ -6,7 +6,7 @@
  *
  * Copyright (c) 2017,
  * David J. Malan <malan@harvard.edu>
- * Kareem Zidane <kzidane@cs50harvard.edu>
+ * Kareem Zidane <kzidane@cs50.harvard.edu>
  * All rights reserved.
  *
  * BSD 3-Clause License
@@ -44,8 +44,6 @@
 import java.io.FileDescriptor;
 import java.io.FileOutputStream;
 import java.io.PrintStream;
-import java.math.BigDecimal;
-import java.math.BigInteger;
 import java.util.Scanner;
 
 public class CS50
@@ -75,6 +73,18 @@ private CS50()
      * Prints an error message, formatted like {@link java.io.PrintStream#printf},
      * to standard error, prefixing it with program's name as well as the file and
      * line number from which method was called.
+     *
+     * @param format A format string as described in
+     *               <a href="https://docs.oracle.com/javase/8/docs/api/java.util.Formatter.html#syntax">Format string syntax</a>
+     *
+     * @param  args Arguments referenced by the format specifiers in the format
+     *         string. If there are more arguments than format specifiers, the
+     *         extra arguments are ignored. The number of arguments is variable
+     *         and may be zero.  The maximum number of arguments is limited by
+     *         the maximum dimension of a Java array as defined by
+     *         <cite>The Java&trade; Virtual Machine Specification</cite>. The
+     *         behaviour on a <tt>null</tt> argument depends on the
+     *         <a href="https://docs.oracle.com/javase/8/docs/api/java.util.Formatter.html#syntax">conversion</a>.
      */
     public static void eprintf(String format, Object... args)
     {
@@ -88,6 +98,7 @@ public static void eprintf(String format, Object... args)
      * {@code char}; if text does not represent a {@code char}, user is prompted
      * to retry. If line can't be read, returns {@link Character#MAX_VALUE}.
      *
+     * @param prompt A string that prompts the user to provide input.
      * @return char
      */
     public static char getChar(String prompt)
@@ -116,6 +127,7 @@ public static char getChar(String prompt)
      * {@code double} or if value would cause underflow or overflow, user is
      * prompted to retry. If line can't be read, returns {@link Double#MAX_VALUE}.
      *
+     * @param prompt A string that prompts the user to provide input.
      * @return double
      */
     public static double getDouble(String prompt)
@@ -153,6 +165,7 @@ public static double getDouble(String prompt)
      * {@code float} or if value would cause underflow or overflow, user is
      * prompted to retry. If line can't be read, returns {@link Float#MAX_VALUE}.
      *
+     * @param prompt A string that prompts the user to provide input.
      * @return float
      */
     public static float getFloat(String prompt)
@@ -191,6 +204,7 @@ public static float getFloat(String prompt)
      * cause underflow or overflow, user is prompted to retry. If line
      * can't be read, returns {@link Integer#MAX_VALUE}.
      *
+     * @param prompt A string that prompts the user to provide input.
      * @return int
      */
     public static int getInt(String prompt)
@@ -225,6 +239,7 @@ public static int getInt(String prompt)
      * cause underflow or overflow, user is prompted to retry. If line
      * can't be read, returns {@link Long#MAX_VALUE}.
      *
+     * @param prompt A string that prompts the user to provide input.
      * @return long
      */
     public static long getLong(String prompt)
@@ -259,6 +274,7 @@ public static long getLong(String prompt)
      * if user inputs only CR, LF, or CRLF. Returns "" upon no input
      * whatsoever (i.e., EOF). Returns {@code null} upon error.
      *
+     * @param prompt A string that prompts the user to provide input.
      * @return String
      */
     public static String getString(String prompt)
