ruby-fizzbuzz 0.0.2 → 0.0.3

data/CHANGES

@@ -1,3 +1,19 @@
+fizzbuzz (0.0.3)
+
+  * Added custom exceptions and improved error handling;
+  * Added more variety of Rubies on which tests are being run with Travis CI;
+  * Added project to Rubygems (http://rubygems.org) so it can be installed
+    with just "gem install ruby-fizzbuzz" command;
+  * Renamed project from "fizzbuzz" to "ruby-fizzbuzz" to avoid clashes with
+    other Ruby gems hosted on Rubygems web site;
+  * Made "mkmf" in extconf.rb more user-friendly (it now reports missing
+    build-time dependencies better);
+  * Split Ruby gem specification (or gemspec if you wish) away from Rakefile
+    into its own file (namely ruby-fizzbuzz.gemspec);
+  * Improved documentation and removed bunch of small code smells.
+
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Sat, 31 Aug 2013 17:54:54 +0000
+
 fizzbuzz (0.0.2)
 
   * Added is_fizz?, is_buzz? and is_fizzbuzz? singleton methods to FizzBuzz class;

data/CHANGES.rdoc

@@ -1,3 +1,19 @@
+fizzbuzz (0.0.3)
+
+  * Added custom exceptions and improved error handling;
+  * Added more variety of Rubies on which tests are being run with Travis CI;
+  * Added project to Rubygems (http://rubygems.org) so it can be installed
+    with just "gem install ruby-fizzbuzz" command;
+  * Renamed project from "fizzbuzz" to "ruby-fizzbuzz" to avoid clashes with
+    other Ruby gems hosted on Rubygems web site;
+  * Made "mkmf" in extconf.rb more user-friendly (it now reports missing
+    build-time dependencies better);
+  * Split Ruby gem specification (or gemspec if you wish) away from Rakefile
+    into its own file (namely ruby-fizzbuzz.gemspec);
+  * Improved documentation and removed bunch of small code smells.
+
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Sat, 31 Aug 2013 17:54:54 +0000
+
 fizzbuzz (0.0.2)
 
   * Added is_fizz?, is_buzz? and is_fizzbuzz? singleton methods to FizzBuzz class;

data/README.rdoc

@@ -4,4 +4,5 @@ to a popular FizzBuzz problem for Ruby.
 Written in C as an example of using Ruby's C API - with the support
 for arbitrary large numeric values via the Bignum class.
 
-{<img src="https://travis-ci.org/kwilczynski/ruby-fizzbuzz.png?branch=master"/>}[https://travis-ci.org/kwilczynski/ruby-fizzbuzz]
+{<img src="https://travis-ci.org/kwilczynski/ruby-fizzbuzz.png?branch=master" alt="Build Status"/>}[https://travis-ci.org/kwilczynski/ruby-fizzbuzz]
+{<img src="https://badge.fury.io/rb/ruby-fizzbuzz.png" alt="Gem Version" />}[http://badge.fury.io/rb/ruby-fizzbuzz]

data/TODO

@@ -4,19 +4,20 @@ fizzbuzz (1.0.0)
 
 -- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Mon, 01 Oct 2012 17:57:18 +0100
 
-fizzbuzz (0.0.4)
+fizzbuzz (0.0.5)
 
   * Improve github project page;
-  * Re-factor unit tests to make them more idiotmatic (maybe move to Rspec and BDD?).
+  * Re-factor unit tests to make them more idiomatic (maybe move to Rspec and BDD?).
 
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Mon, 08 Oct 2012 00:14:08 +0100
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Sun, 31 Aug 2013 17:50:06 +0000
 
-fizzbuzz (0.0.3)
+fizzbuzz (0.0.4)
 
+  * Move to YARD from RDoc (as RDoc is very bad, really);
   * Add pure-Ruby implementation;
   * Add benchmarks;
   * Add some examples;
   * Add Doxygen style comments for other functions in the source code;
   * Improve documentation i.e. source code commenting, README file, etc.
 
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Sat, 13 Oct 2012 16:08:26 +0100
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Sun, 31 Aug 2013 17:50:06 +0000

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/ext/fizzbuzz/extconf.rb

@@ -29,7 +29,31 @@ $LDFLAGS << " %s" % ENV['LDFLAGS'] if ENV['LDFLAGS']
 $CFLAGS << " %s" % ENV['CFLAGS'] if ENV['CFLAGS']
 $CFLAGS << ' -std=c99 -g -Wall -Wextra -pedantic'
 
-have_header('ruby.h') or missing('ruby.h')
+unless have_header('ruby.h')
+  abort <<-EOS
+
+  You appear to be missing Ruby development libraries and/or header
+  files. You can install missing compile-time dependencies in one of
+  the following ways:
+
+  - Debian / Ubuntu
+
+      apt-get install ruby-dev
+
+  - Red Hat / CentOS / Fedora
+
+      yum install ruby-devel
+
+
+  Alternatively, you can use either of the following Ruby version
+  managers in order to install Ruby locally (for your user only)
+  and/or system-wide:
+
+  - Ruby Version Manager (for RVM, see http://rvm.io/)
+  - Ruby Environment (for rbenv, see http://github.com/sstephenson/rbenv)
+
+  EOS
+end
 
 dir_config('fizzbuzz')
 

data/ext/fizzbuzz/fizzbuzz.c

@@ -18,19 +18,31 @@
  * limitations under the License.
  */
 
-/* :startdoc: */
-
 #include <fizzbuzz.h>
 
 ID id_at_start, id_at_stop;
+
 VALUE rb_cFizzBuzz = Qnil;
 
+VALUE rb_fb_eError = Qnil;
+VALUE rb_fb_eTypeError = Qnil;
+VALUE rb_fb_eRangeError = Qnil;
+
 void Init_fizzbuzz(void);
 
 static VALUE fizzbuzz_evaluate(VALUE value);
 static VALUE fizzbuzz_values(VALUE object, return_type_t type,
         direction_t direction);
 
+static VALUE fizzbuzz_exception_wrapper(VALUE value);
+static VALUE fizzbuzz_exception(void *data);
+
+static VALUE fizzbuzz_type_error(VALUE klass, const char *message);
+static VALUE fizzbuzz_range_error(VALUE klass, VALUE start, VALUE stop,
+        const char *message);
+
+/* :startdoc: */
+
 /*
  * call-seq:
  *    FizzBuzz.new( start, stop ) -> self
@@ -48,14 +60,13 @@ static VALUE fizzbuzz_values(VALUE object, return_type_t type,
  *    fb = FizzBuzz.new(-15, 15)    #=> #<FizzBuzz:0xb6fd0460 @stop=15, @start=-15>
  *
  * The given value of +stop+ must always be greater than or equal to the
- * given value of +start+, otherwise raises an +ArgumentError+ exception.
- *
- * Will raise a +TypeError+ exception if given value of either +start+
- * or +stop+ is not an integer type.
+ * given value of +start+, otherwise raises an <i>FizzBuzz::RangeError</i>
+ * exception.
  *
- * See also:
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value of either
+ * +start+ or +stop+ is not an _Integer_ or _Bignum_ type.
  *
- *    FizzBuzz::fizzbuzz
+ * See also: FizzBuzz::fizzbuzz
  */
 VALUE
 rb_fb_initialize(int argc, VALUE *argv, VALUE object)
@@ -64,10 +75,10 @@ rb_fb_initialize(int argc, VALUE *argv, VALUE object)
 
     rb_scan_args(argc, argv, "20", &start, &stop);
 
-    CHECK_TYPE(start, errors[E_INVALID_START_TYPE]);
-    CHECK_TYPE(stop, errors[E_INVALID_STOP_TYPE]);
+    CHECK_TYPE(start, error(E_INVALID_START_TYPE));
+    CHECK_TYPE(stop, error(E_INVALID_STOP_TYPE));
 
-    CHECK_BOUNDARY(start, stop, errors[E_BAD_VALUE_START]);
+    CHECK_RANGE(start, stop, error(E_BAD_VALUE_START));
 
     rb_ivar_set(object, id_at_start, start);
     rb_ivar_set(object, id_at_stop, stop);
@@ -83,8 +94,8 @@ rb_fb_initialize(int argc, VALUE *argv, VALUE object)
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 100) #=> #<FizzBuzz:0xf726b48c @stop=100, @start=1>
- *    fb.start                  #=> 1
+ *    fb = FizzBuzz.new(1, 100)   #=> #<FizzBuzz:0xf726b48c @stop=100, @start=1>
+ *    fb.start                    #=> 1
  */
 VALUE
 rb_fb_get_start(VALUE object)
@@ -97,25 +108,26 @@ rb_fb_get_start(VALUE object)
  *    fizzfuzz.start= (integer) -> integer
  *
  * Sets the current value of +start+ if given new value is lower or equal
- * to the current value of +stop+, or raises an +ArgumentError+ exception
- * otherwise.
+ * to the current value of +stop+, or raises an <i>FizzBuzz::RangeError</i>
+ * exception otherwise.
  *
  * Examples:
  *
- *    fb = FizzBuzz.new(1, 100) #=> #<FizzBuzz:0xf726f03c @stop=100, @start=1>
- *    fb.start                  #=> 1
- *    fb.start = 15             #=> 15
- *    fb.start                  #=> 15
+ *    fb = FizzBuzz.new(1, 100)   #=> #<FizzBuzz:0xf726f03c @stop=100, @start=1>
+ *    fb.start                    #=> 1
+ *    fb.start = 15               #=> 15
+ *    fb.start                    #=> 15
  *
- * Will raise a +TypeError+ exception if given value is not an integer type.
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
+ * an _Integer_ or _Bignum_ type.
  */
 VALUE
 rb_fb_set_start(VALUE object, VALUE value)
 {
     VALUE stop = rb_ivar_get(object, id_at_stop);
 
-    CHECK_TYPE(value, errors[E_INVALID_START_TYPE]);
-    CHECK_BOUNDARY(value, stop, errors[E_BAD_VALUE_START]);
+    CHECK_TYPE(value, error(E_INVALID_START_TYPE));
+    CHECK_RANGE(value, stop, error(E_BAD_VALUE_START));
 
     return rb_ivar_set(object, id_at_start, value);
 }
@@ -128,8 +140,8 @@ rb_fb_set_start(VALUE object, VALUE value)
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 100) #=> #<FizzBuzz:0xf7272bec @stop=100, @start=1>
- *    fb.stop                   #=> 100
+ *    fb = FizzBuzz.new(1, 100)   #=> #<FizzBuzz:0xf7272bec @stop=100, @start=1>
+ *    fb.stop                     #=> 100
  */
 VALUE
 rb_fb_get_stop(VALUE object)
@@ -139,28 +151,29 @@ rb_fb_get_stop(VALUE object)
 
 /*
  * call-seq:
- *    fizzfuzz.start= (integer) -> integer
+ *    fizzfuzz.stop= (integer) -> integer
  *
  * Sets the current value of +stop+ if given new value is greater or equal
- * to the current value of +start+, or raises an +ArgumentError+ exception
- * otherwise.
+ * to the current value of +start+, or raises an <i>FizzBuzz::RangeError</i>
+ * exception otherwise.
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 100) #=> #<FizzBuzz:0xf727679c @stop=100, @start=1>
- *    fb.stop                   #=> 100
- *    fb.stop = 15              #=> 15
- *    fb.stop                   #=> 15
+ *    fb = FizzBuzz.new(1, 100)   #=> #<FizzBuzz:0xf727679c @stop=100, @start=1>
+ *    fb.stop                     #=> 100
+ *    fb.stop = 15                #=> 15
+ *    fb.stop                     #=> 15
  *
- * Will raise a +TypeError+ exception if given value is not an integer type.
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
+ * an _Integer_ or _Bignum_ type.
  */
 VALUE
 rb_fb_set_stop(VALUE object, VALUE value)
 {
     VALUE start = rb_ivar_get(object, id_at_start);
 
-    CHECK_TYPE(value, errors[E_INVALID_STOP_TYPE]);
-    CHECK_BOUNDARY(start, value, errors[E_BAD_VALUE_STOP]);
+    CHECK_TYPE(value, error(E_INVALID_STOP_TYPE));
+    CHECK_RANGE(start, value, error(E_BAD_VALUE_STOP));
 
     return rb_ivar_set(object, id_at_stop, value);
 }
@@ -174,8 +187,8 @@ rb_fb_set_stop(VALUE object, VALUE value)
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 15) #=> #<FizzBuzz:0xf727fd60 @stop=15, @start=1>
- *    fb.to_a                  #=> [1, 2, "Fizz", 4, "Buzz", "Fizz", 7, 8, "Fizz", "Buzz", 11, "Fizz", 13, 14, "FizzBuzz"]
+ *    fb = FizzBuzz.new(1, 15)   #=> #<FizzBuzz:0xf727fd60 @stop=15, @start=1>
+ *    fb.to_a                    #=> [1, 2, "Fizz", 4, "Buzz", "Fizz", 7, 8, "Fizz", "Buzz", 11, "Fizz", 13, 14, "FizzBuzz"]
  *
  * See also: FizzBuzz::fizzbuzz
  */
@@ -197,7 +210,7 @@ rb_fb_array(VALUE object)
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 15) #=> #<FizzBuzz:0xf722f8ec @stop=15, @start=1>
+ *    fb = FizzBuzz.new(1, 15)   #=> #<FizzBuzz:0xf722f8ec @stop=15, @start=1>
  *    fb.each {|value| puts "Got #{value}" }
  *
  * Produces:
@@ -239,7 +252,7 @@ rb_fb_enumerator(VALUE object)
  *
  * If no block is given, an +Enumerator+ is returned instead.
  *
- *    fb = FizzBuzz.new(1, 15) #=> #<FizzBuzz:0xb7308664 @stop=15, @start=1>
+ *    fb = FizzBuzz.new(1, 15)   #=> #<FizzBuzz:0xb7308664 @stop=15, @start=1>
  *    fb.reverse_each {|value| puts "Got #{value}" }
  *
  * Produces:
@@ -281,7 +294,8 @@ rb_fb_reverse_enumerator(VALUE object)
  *    FizzBuzz.is_fizz?(5)    #=> false
  *    FizzBuzz.is_fizz?(15)   #=> false
  *
- * Will raise a +TypeError+ exception if given value is not an integer type.
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
+ * an _Integer_ or _Bignum_ type.
  *
  * See also: FizzBuzz::[]
  */
@@ -289,7 +303,7 @@ VALUE
 rb_fb_is_fizz(VALUE object, VALUE value)
 {
     UNUSED(object);
-    CHECK_TYPE(value, errors[E_INVALID_TYPE]);
+    CHECK_TYPE(value, error(E_INVALID_TYPE));
 
     return CBOOL2RVAL(IS_FIZZ(value));
 }
@@ -307,7 +321,8 @@ rb_fb_is_fizz(VALUE object, VALUE value)
  *    FizzBuzz.is_buzz?(5)    #=> true
  *    FizzBuzz.is_buzz?(15)   #=> false
  *
- * Will raise a +TypeError+ exception if given value is not an integer type.
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
+ * an _Integer_ or _Bignum_ type.
  *
  * See also: FizzBuzz::[]
  */
@@ -315,7 +330,7 @@ VALUE
 rb_fb_is_buzz(VALUE object, VALUE value)
 {
     UNUSED(object);
-    CHECK_TYPE(value, errors[E_INVALID_TYPE]);
+    CHECK_TYPE(value, error(E_INVALID_TYPE));
 
     return CBOOL2RVAL(IS_BUZZ(value));
 }
@@ -333,7 +348,8 @@ rb_fb_is_buzz(VALUE object, VALUE value)
  *    FizzBuzz.is_fizzbuzz?(5)    #=> false
  *    FizzBuzz.is_fizzbuzz?(15)   #=> true
  *
- * Will raise a +TypeError+ exception if given value is not an integer type.
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
+ * an _Integer_ or _Bignum_ type.
  *
  * See also: FizzBuzz::[]
  */
@@ -341,7 +357,7 @@ VALUE
 rb_fb_is_fizzbuzz(VALUE object, VALUE value)
 {
     UNUSED(object);
-    CHECK_TYPE(value, errors[E_INVALID_TYPE]);
+    CHECK_TYPE(value, error(E_INVALID_TYPE));
 
     return CBOOL2RVAL(IS_FIZZBUZZ(value));
 }
@@ -362,7 +378,8 @@ rb_fb_is_fizzbuzz(VALUE object, VALUE value)
  *    FizzBuzz[5]    #=> "Buzz"
  *    FizzBuzz[15]   #=> "FizzBuzz"
  *
- * Will raise a +TypeError+ exception if given value is not an integer type.
+ * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
+ * an _Integer_ or _Bignum_ type.
  *
  * See also: FizzBuzz::is_fizz?, FizzBuzz::is_buzz? and FizzBuzz::is_fizzbuzz?
  */
@@ -370,7 +387,7 @@ VALUE
 rb_fb_square(VALUE object, VALUE value)
 {
     UNUSED(object);
-    CHECK_TYPE(value, errors[E_INVALID_TYPE]);
+    CHECK_TYPE(value, error(E_INVALID_TYPE));
 
     return fizzbuzz_evaluate(value);
 }
@@ -442,6 +459,60 @@ fizzbuzz_values(VALUE object, return_type_t type, direction_t direction)
     return WANT_ARRAY(type) ? array : object;
 }
 
+VALUE
+fizzbuzz_exception_wrapper(VALUE value)
+{
+    exception_t *e = (struct exception *)value;
+
+    return rb_exc_new2(e->klass, e->message);
+}
+
+VALUE
+fizzbuzz_exception(void *data)
+{
+    int exception = 0;
+    VALUE object = Qnil;
+
+    exception_t *e = data;
+
+    object = rb_protect(fizzbuzz_exception_wrapper, (VALUE)e, &exception);
+
+    if (exception != 0) {
+        rb_jump_tag(exception);
+    }
+
+    rb_iv_set(object, "@start", e->start);
+    rb_iv_set(object, "@stop", e->stop);
+
+    return object;
+}
+
+VALUE
+fizzbuzz_type_error(VALUE klass, const char *message)
+{
+    exception_t e;
+
+    e.start = Qnil;
+    e.stop = Qnil;
+    e.message = message;
+    e.klass = klass;
+
+    return fizzbuzz_exception(&e);
+}
+
+VALUE
+fizzbuzz_range_error(VALUE klass, VALUE start, VALUE stop, const char *message)
+{
+    exception_t e;
+
+    e.start = start;
+    e.stop = stop;
+    e.message = message;
+    e.klass = klass;
+
+    return fizzbuzz_exception(&e);
+}
+
 void
 Init_fizzbuzz(void)
 {
@@ -449,9 +520,36 @@ Init_fizzbuzz(void)
     id_at_stop  = rb_intern("@stop");
 
     rb_cFizzBuzz = rb_define_class("FizzBuzz", rb_cObject);
-
     rb_include_module(rb_cFizzBuzz, rb_mEnumerable);
 
+    /*
+     * Raised when _FizzBuzz_ encounters an error.
+     */
+    rb_fb_eError = rb_define_class_under(rb_cFizzBuzz, "Error", rb_eStandardError);
+
+    /*
+     * Stores current value of +start+ for which the exception might have been
+     * raised, or +nil+ otherwise.
+     */
+    rb_define_attr(rb_fb_eError, "start", 1, 0);
+
+    /*
+     * Stores current value of +stop+ for which the exception might have been
+     * raised, or +nil+ otherwise.
+     */
+    rb_define_attr(rb_fb_eError, "stop", 1, 0);
+
+    /*
+     * Raised when the arguments are wrong or of an incompatible type.
+     */
+    rb_fb_eTypeError = rb_define_class_under(rb_cFizzBuzz, "TypeError", rb_fb_eError);
+
+    /*
+     * Raised when the arguments are wrong or given range from +start+ to +stop+
+     * is incorrect.
+     */
+    rb_fb_eRangeError = rb_define_class_under(rb_cFizzBuzz, "RangeError", rb_fb_eError);
+
     rb_define_method(rb_cFizzBuzz, "initialize", RUBY_METHOD_FUNC(rb_fb_initialize), -1);
 
     rb_define_method(rb_cFizzBuzz, "start", RUBY_METHOD_FUNC(rb_fb_get_start), 0);

data/ext/fizzbuzz/fizzbuzz.h

@@ -66,18 +66,24 @@ extern "C" {
 #define LOOP_FORWARD(x) ((x) == D_LOOP_FORWARD)
 #define LOOP_REVERSE(x) ((x) == D_LOOP_REVERSE)
 
-#define CHECK_TYPE(x, m)                        \
-    do {                                        \
-        if (!INTEGER_P(x))                      \
-            rb_raise(rb_eTypeError, "%s", (m)); \
+#define CHECK_TYPE(x, m)                                                    \
+    do {                                                                    \
+        if (!INTEGER_P(x)) {                                                \
+            VALUE __e_type = fizzbuzz_type_error(rb_fb_eTypeError, (m));    \
+            rb_exc_raise(__e_type);                                         \
+        }                                                                   \
     } while (0)
 
-#define CHECK_BOUNDARY(a, b, m)                 \
-    do {                                        \
-        if (GREATER((a), (b)))                  \
-            rb_raise(rb_eArgError, "%s", (m));  \
+#define CHECK_RANGE(x, y, m)                                                            \
+    do {                                                                                \
+        if (GREATER(x, y)) {                                                            \
+            VALUE __e_range = fizzbuzz_range_error(rb_fb_eRangeError, (x), (y), (m));   \
+            rb_exc_raise(__e_range);                                                    \
+        }                                                                               \
     } while (0)
 
+#define error(t) errors[(t)]
+
 enum error {
     E_INVALID_TYPE = 0,
     E_INVALID_START_TYPE,
@@ -96,14 +102,21 @@ enum direction {
     D_LOOP_REVERSE
 };
 
-typedef enum error error_t;
+struct exception {
+    VALUE start;
+    VALUE stop;
+    const char *message;
+    VALUE klass;
+};
+
 typedef enum return_type return_type_t;
 typedef enum direction direction_t;
+typedef struct exception exception_t;
 
 static const char *errors[] = {
-    "must be an integer value",
-    "must be an integer value for start",
-    "must be an integer value for stop",
+    "must be an Integer or Bignum type",
+    "must be an Integer or Bignum type for start",
+    "must be an Integer or Bignum type for stop",
     "start value is higher than stop value",
     "stop value is lower than start value",
     NULL
@@ -205,8 +218,13 @@ fizzbuzz_less_equal(VALUE a, VALUE b)
 }
 
 RUBY_EXTERN ID id_at_start, id_at_stop;
+
 RUBY_EXTERN VALUE rb_cFizzBuzz;
 
+RUBY_EXTERN VALUE rb_fb_eError;
+RUBY_EXTERN VALUE rb_fb_eTypeError;
+RUBY_EXTERN VALUE rb_fb_eRangeError;
+
 RUBY_EXTERN VALUE rb_fb_initialize(int argc, VALUE *argv, VALUE object);
 
 RUBY_EXTERN VALUE rb_fb_get_start(VALUE object);

data/lib/fizzbuzz.rb

@@ -35,8 +35,8 @@ require 'fizzbuzz/bignum'
 class FizzBuzz
   #
   # call-seq:
-  #   FizzBuzz.fizzbuzz( start, stop, reverse )                  -> array
-  #   FizzBuzz.fizzbuzz( start, stop, reverse ) {|value| block } -> self
+  #    FizzBuzz.fizzbuzz( start, stop, reverse )                  -> array
+  #    FizzBuzz.fizzbuzz( start, stop, reverse ) {|value| block } -> self
   #
   # Returns either an array or accepts a block if such is given. When a block is given
   # then it will call the block once for each subsequent value for a given range from
@@ -48,30 +48,30 @@ class FizzBuzz
   #
   # Example:
   #
-  #   FizzBuzz.fizzbuzz(1, 15)          #=> [1, 2, "Fizz", 4, "Buzz", "Fizz", 7, 8, "Fizz", "Buzz", 11, "Fizz", 13, 14, "FizzBuzz"]
-  #   FizzBuzz.fizzbuzz(1, 15, true)    #=> ["FizzBuzz", 14, 13, "Fizz", 11, "Buzz", "Fizz", 8, 7, "Fizz", "Buzz", 4, "Fizz", 2, 1]
+  #    FizzBuzz.fizzbuzz(1, 15)         #=> [1, 2, "Fizz", 4, "Buzz", "Fizz", 7, 8, "Fizz", "Buzz", 11, "Fizz", 13, 14, "FizzBuzz"]
+  #    FizzBuzz.fizzbuzz(1, 15, true)   #=> ["FizzBuzz", 14, 13, "Fizz", 11, "Buzz", "Fizz", 8, 7, "Fizz", "Buzz", 4, "Fizz", 2, 1]
   #
   # Example:
   #
-  #   FizzBuzz.fizzbuzz(1, 15) {|value| puts "Got #{value}" }
+  #    FizzBuzz.fizzbuzz(1, 15) {|value| puts "Got #{value}" }
   #
   # Produces:
   #
-  #   Got 1
-  #   Got 2
-  #   Got Fizz
-  #   Got 4
-  #   Got Buzz
-  #   Got Fizz
-  #   Got 7
-  #   Got 8
-  #   Got Fizz
-  #   Got Buzz
-  #   Got 11
-  #   Got Fizz
-  #   Got 13
-  #   Got 14
-  #   Got FizzBuzz
+  #    Got 1
+  #    Got 2
+  #    Got Fizz
+  #    Got 4
+  #    Got Buzz
+  #    Got Fizz
+  #    Got 7
+  #    Got 8
+  #    Got Fizz
+  #    Got Buzz
+  #    Got 11
+  #    Got Fizz
+  #    Got 13
+  #    Got 14
+  #    Got FizzBuzz
   #
   # See also: FizzBuzz::[], FizzBuzz::new, FizzBuzz#to_a, FizzBuzz#each and FizzBuzz#reverse_each
   #

data/lib/fizzbuzz/bignum.rb

@@ -28,16 +28,16 @@
 class Bignum
   #
   # call-seq:
-  #   Bignum.fizz? -> true or false
+  #    Bignum.fizz? -> true or false
   #
   # Returns +true+ if a given integer value is divisible by *three* (given
   # value is a _Fizz_), or +false+ otherwise.
   #
   # Example:
   #
-  #   1000000000000.fizz?    #=> false
-  #   1000000000002.fizz?    #=> true
-  #   1000000000005.fizz?    #=> false
+  #    1000000000000.fizz?   #=> false
+  #    1000000000002.fizz?   #=> true
+  #    1000000000005.fizz?   #=> false
   #
   # See also: FizzBuzz::[] and FizzBuzz::is_fizz?
   #
@@ -47,16 +47,16 @@ class Bignum
 
   #
   # call-seq:
-  #   Bignum.buzz? -> true or false
+  #    Bignum.buzz? -> true or false
   #
   # Returns +true+ if a given integer value is divisible by *five* (given
   # value is a _Buzz_), or +false+ otherwise.
   #
   # Example:
   #
-  #   1000000000000.buzz?    #=> true
-  #   1000000000002.buzz?    #=> false
-  #   1000000000005.buzz?    #=> false
+  #    1000000000000.buzz?   #=> true
+  #    1000000000002.buzz?   #=> false
+  #    1000000000005.buzz?   #=> false
   #
   # See also: FizzBuzz::[] and FizzBuzz::is_buzz?
   #
@@ -66,16 +66,16 @@ class Bignum
 
   #
   # call-seq:
-  #   Bignum.fizzbuzz? -> true or false
+  #    Bignum.fizzbuzz? -> true or false
   #
   # Returns +true+ if a given integer value is divisible by both *three*
   # and *five* (given value is a _FizzBuzz_), or +false+ otherwise.
   #
   # Example:
   #
-  #   1000000000000.fizzbuzz?    #=> false
-  #   1000000000002.fizzbuzz?    #=> false
-  #   1000000000005.fizzbuzz?    #=> true
+  #    1000000000000.fizzbuzz?   #=> false
+  #    1000000000002.fizzbuzz?   #=> false
+  #    1000000000005.fizzbuzz?   #=> true
   #
   # See also: FizzBuzz::[] and FizzBuzz::is_fizzbuzz?
   #

data/lib/fizzbuzz/integer.rb

@@ -28,16 +28,16 @@
 class Integer
   #
   # call-seq:
-  #   Integer.fizz? -> true or false
+  #    Integer.fizz? -> true or false
   #
   # Returns +true+ if a given integer value is divisible by *three* (given
   # value is a _Fizz_), or +false+ otherwise.
   #
   # Example:
   #
-  #    3.fizz?    #=> true
-  #    5.fizz?    #=> false
-  #   15.fizz?    #=> false
+  #     3.fizz?   #=> true
+  #     5.fizz?   #=> false
+  #    15.fizz?   #=> false
   #
   # See also: FizzBuzz::[] and FizzBuzz::is_fizz?
   #
@@ -47,16 +47,16 @@ class Integer
 
   #
   # call-seq:
-  #   Integer.buzz? -> true or false
+  #    Integer.buzz? -> true or false
   #
   # Returns +true+ if a given integer value is divisible by *five* (given
   # value is a _Buzz_), or +false+ otherwise.
   #
   # Example:
   #
-  #    3.buzz?    #=> false
-  #    5.buzz?    #=> true
-  #   15.buzz?    #=> false
+  #     3.buzz?   #=> false
+  #     5.buzz?   #=> true
+  #    15.buzz?   #=> false
   #
   # See also: FizzBuzz::[] and FizzBuzz::is_buzz?
   #
@@ -73,9 +73,9 @@ class Integer
   #
   # Example:
   #
-  #    3.fizzbuzz?    #=> false
-  #    5.fizzbuzz?    #=> false
-  #   15.fizzbuzz?    #=> true
+  #     3.fizzbuzz?   #=> false
+  #     5.fizzbuzz?   #=> false
+  #    15.fizzbuzz?   #=> true
   #
   # See also: FizzBuzz::[] and FizzBuzz::is_fizzbuzz?
   #

data/lib/fizzbuzz/version.rb

@@ -26,7 +26,7 @@ class FizzBuzz
   #
   # Current version of _FizzBuzz_.
   #
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end
 
 # :enddoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-fizzbuzz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,7 +75,17 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
-description: Yet another FizzBuzz in Ruby
+description: ! 'Yet another FizzBuzz in Ruby
+
+
+  Provides simple and fast solution to a popular FizzBuzz problem for Ruby.
+
+
+  Written in C as an example of using Ruby''s C API - with the support for
+
+  arbitrary large numeric values via the Bignum class.
+
+'
 email: krzysztof.wilczynski@linux.com
 executables:
 - fizzbuzz
@@ -84,8 +94,8 @@ extensions:
 extra_rdoc_files: []
 files:
 - ext/fizzbuzz/fizzbuzz.c
-- ext/fizzbuzz/fizzbuzz.h
 - ext/fizzbuzz/common.h
+- ext/fizzbuzz/fizzbuzz.h
 - ext/fizzbuzz/extconf.rb
 - lib/fizzbuzz/bignum.rb
 - lib/fizzbuzz/integer.rb
@@ -127,7 +137,5 @@ rubyforge_project: ruby-fizzbuzz
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Provides simple and fast solution to a popular FizzBuzz problem for Ruby.  Written
-  in C as an example of using Ruby's C API - with the support for arbitrary large
-  numeric values via the Bignum class.
+summary: Yet another FizzBuzz in Ruby
 test_files: []