ruby-fizzbuzz 0.7.0 → 0.8.0

data/ext/fizzbuzz/extconf.rb

@@ -1,64 +1,48 @@
-# -*- encoding: utf-8 -*-
-
-# :enddoc:
-
-#
-# extconf.rb
-#
-# Copyright 2012-2014 Krzysztof Wilczynski
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
+# frozen_string_literal: true
 
 require 'mkmf'
 
 RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
 
-$CFLAGS << ' -std=c99 -g -Wall -Wextra -pedantic'
+$CFLAGS << ' -std=c99 -Wall -Wextra -pedantic'
 
-unless RbConfig::CONFIG['host_os'][/darwin/]
+if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc/
+  $CFLAGS << ' -O3' unless $CFLAGS =~ /-O\d/
+  $CFLAGS << ' -Wcast-qual -Wwrite-strings -Wconversion -Wmissing-noreturn -Winline'
+end
+
+unless RbConfig::CONFIG['host_os'] =~ /darwin/
   $LDFLAGS << ' -Wl,--as-needed'
 end
 
-$LDFLAGS << " %s" % ENV['LDFLAGS'] if ENV['LDFLAGS']
+$LDFLAGS << format(' %s', ENV['LDFLAGS']) if ENV['LDFLAGS']
 
 %w(CFLAGS CXXFLAGS CPPFLAGS).each do |variable|
-    $CFLAGS << " %s" % ENV[variable] if ENV[variable]
+  $CFLAGS << format(' %s', ENV[variable]) if ENV[variable]
 end
 
 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:
+  abort "\n" + (<<-EOS).gsub(/^[ ]{,3}/, '') + "\n"
+    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
+    - Debian / Ubuntu
 
-      apt-get install ruby-dev
+        apt-get install ruby-dev
 
-  - Red Hat / CentOS / Fedora
+    - Red Hat / CentOS / Fedora
 
-      yum install ruby-devel
+        yum install ruby-devel or dnf 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)
+    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)
+    - Change Ruby (for chruby, see https://github.com/postmodern/chruby)
   EOS
 end
 
@@ -66,6 +50,3 @@ dir_config('fizzbuzz')
 
 create_header
 create_makefile('fizzbuzz/fizzbuzz')
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

data/ext/fizzbuzz/fizzbuzz.c

@@ -1,23 +1,3 @@
-/* :stopdoc: */
-
-/*
- * fizzbuzz.c
- *
- * Copyright 2012-2014 Krzysztof Wilczynski
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 #if defined(__cplusplus)
 extern "C" {
 #endif
@@ -36,16 +16,14 @@ void Init_fizzbuzz(void);
 
 static VALUE fizzbuzz_evaluate(VALUE value);
 static VALUE fizzbuzz_values(VALUE object, fizzbuzz_return_t type,
-        fizzbuzz_direction_t direction);
+			     fizzbuzz_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: */
+				  const char *message);
 
 /*
  * call-seq:
@@ -59,16 +37,17 @@ static VALUE fizzbuzz_range_error(VALUE klass, VALUE start, VALUE stop,
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 100)     #=> #<FizzBuzz:0xb6fd3b38 @stop=100, @start=1>
- *    fb = FizzBuzz.new(-100,-1)    #=> #<FizzBuzz:0xb72d5700 @stop=-1, @start=-100>
- *    fb = FizzBuzz.new(-15, 15)    #=> #<FizzBuzz:0xb6fd0460 @stop=15, @start=-15>
+ *    fb = FizzBuzz.new(1, 100)    #=> #<FizzBuzz:0xb6fd3b38 @stop=100, @start=1>
+ *    fb = FizzBuzz.new(-100, -1)  #=> #<FizzBuzz:0xb72d5700 @stop=-1, @start=-100>
+ *    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 <i>FizzBuzz::RangeError</i>
  * exception.
  *
  * Will raise a <i>FizzBuzz::TypeError</i> exception if given value of either
- * +start+ or +stop+ is not an _Fixnum_ or _Bignum_ type.
+ * +start+ or +stop+ is not a _Fixnum_ or _Bignum_ type, or an _Integer_ type
+ * starting from Ruby version 2.4 onwards.
  *
  * See also: FizzBuzz::fizzbuzz and FizzBuzz::[]
  */
@@ -92,14 +71,14 @@ rb_fb_initialize(int argc, VALUE *argv, VALUE object)
 
 /*
  * call-seq:
- *    fizzfuzz.start -> integer
+ *    fizzbuzz.start -> integer
  *
  * Returns the current value for +start+.
  *
  * 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)
@@ -109,7 +88,7 @@ rb_fb_get_start(VALUE object)
 
 /*
  * call-seq:
- *    fizzfuzz.start= (integer) -> integer
+ *    fizzbuzz.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 <i>FizzBuzz::RangeError</i>
@@ -117,13 +96,14 @@ rb_fb_get_start(VALUE object)
  *
  * 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 <i>FizzBuzz::TypeError</i> exception if given value is not
- * an _Fixnum_ or _Bignum_ type.
+ * a _Fixnum_ or _Bignum_ type, or an _Integer_ type starting from Ruby
+ * version 2.4 onwards.
  */
 VALUE
 rb_fb_set_start(VALUE object, VALUE value)
@@ -138,14 +118,14 @@ rb_fb_set_start(VALUE object, VALUE value)
 
 /*
  * call-seq:
- *    fizzfuzz.stop -> integer
+ *    fizzbuzz.stop -> integer
  *
  * Returns the current value for +stop+.
  *
  * 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)
@@ -155,7 +135,7 @@ rb_fb_get_stop(VALUE object)
 
 /*
  * call-seq:
- *    fizzfuzz.stop= (integer) -> integer
+ *    fizzbuzz.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 <i>FizzBuzz::RangeError</i>
@@ -163,13 +143,14 @@ rb_fb_get_stop(VALUE object)
  *
  * 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 <i>FizzBuzz::TypeError</i> exception if given value is not
- * an _Fixnum_ or _Bignum_ type.
+ * a _Fixnum_ or _Bignum_ type, or an _Integer_ type starting from Ruby
+ * version 2.4 onwards.
  */
 VALUE
 rb_fb_set_stop(VALUE object, VALUE value)
@@ -191,8 +172,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
  */
@@ -205,7 +186,7 @@ rb_fb_array(VALUE object)
 /*
  * call-seq:
  *    fizzbuzz.each {|value| block } -> self
- *    fizzbuzz.each                  -> an Enumerator
+ *    fizzbuzz.each		     -> an Enumerator
  *
  * Calls the block _once_ for each subsequent value for a given range
  * from +start+ to +stop+, passing the value as a parameter to the block.
@@ -214,12 +195,12 @@ rb_fb_array(VALUE object)
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 15)   #=> #<FizzBuzz:0xf722f8ec @stop=15, @start=1>
- *    fb.each                    #=> #<Enumerator: #<FizzBuzz:0x007fc5139e5540 @start=1, @stop=15>:each>
+ *    fb = FizzBuzz.new(1, 15)	  #=> #<FizzBuzz:0xf722f8ec @stop=15, @start=1>
+ *    fb.each			  #=> #<Enumerator: #<FizzBuzz:0x007fc513 @start=1, @stop=15>:each>
  *
  * 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:
@@ -251,7 +232,7 @@ rb_fb_enumerator(VALUE object)
 /*
  * call-seq:
  *    fizzbuzz.reverse_each {|value| block } -> self
- *    fizzbuzz.reverse_each                  -> an Enumerator
+ *    fizzbuzz.reverse_each		     -> an Enumerator
  *
  * Calls the block _once_ for each subsequent value for a given range
  * from +start+ to +stop+ in an <i>reverse order</i>, passing the value
@@ -261,12 +242,12 @@ rb_fb_enumerator(VALUE object)
  *
  * Example:
  *
- *    fb = FizzBuzz.new(1, 15)   #=> #<FizzBuzz:0xf722f8ec @stop=15, @start=1>
- *    fb.each                    #=> #<Enumerator: #<FizzBuzz:0x007fc513a0de00 @start=1, @stop=15>:reverse_each>
+ *    fb = FizzBuzz.new(1, 15)	  #=> #<FizzBuzz:0xf722f8ec @stop=15, @start=1>
+ *    fb.each			  #=> #<Enumerator: #<FizzBuzz:0x007fc513 @start=1, @stop=15>:reverse_each>
  *
  * Example:
  *
- *    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:
@@ -309,16 +290,15 @@ rb_fb_reverse_enumerator(VALUE object)
  *    FizzBuzz.is_fizz?(15)   #=> false
  *
  * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
- * an _Fixnum_ or _Bignum_ type.
+ * a _Fixnum_ or _Bignum_ type, or an _Integer_ type starting from Ruby
+ * version 2.4 onwards.
  *
  * See also: FizzBuzz::[]
  */
 VALUE
-rb_fb_is_fizz(VALUE object, VALUE value)
+rb_fb_is_fizz(RB_UNUSED_VAR(VALUE object), VALUE value)
 {
-    UNUSED(object);
     CHECK_TYPE(value, error(E_INVALID_TYPE));
-
     return CBOOL2RVAL(IS_FIZZ(value));
 }
 
@@ -336,16 +316,15 @@ rb_fb_is_fizz(VALUE object, VALUE value)
  *    FizzBuzz.is_buzz?(15)   #=> false
  *
  * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
- * an _Fixnum_ or _Bignum_ type.
+ * a _Fixnum_ or _Bignum_ type, or an _Integer_ type starting from Ruby
+ * version 2.4 onwards.
  *
  * See also: FizzBuzz::[]
  */
 VALUE
-rb_fb_is_buzz(VALUE object, VALUE value)
+rb_fb_is_buzz(RB_UNUSED_VAR(VALUE object), VALUE value)
 {
-    UNUSED(object);
     CHECK_TYPE(value, error(E_INVALID_TYPE));
-
     return CBOOL2RVAL(IS_BUZZ(value));
 }
 
@@ -358,21 +337,20 @@ rb_fb_is_buzz(VALUE object, VALUE value)
  *
  * Example:
  *
- *    FizzBuzz.is_fizzbuzz?(3)    #=> false
- *    FizzBuzz.is_fizzbuzz?(5)    #=> false
+ *    FizzBuzz.is_fizzbuzz?(3)	  #=> false
+ *    FizzBuzz.is_fizzbuzz?(5)	  #=> false
  *    FizzBuzz.is_fizzbuzz?(15)   #=> true
  *
  * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
- * an _Fixnum_ or _Bignum_ type.
+ * a _Fixnum_ or _Bignum_ type, or an _Integer_ type starting from Ruby
+ * version 2.4 onwards.
  *
  * See also: FizzBuzz::[]
  */
 VALUE
-rb_fb_is_fizzbuzz(VALUE object, VALUE value)
+rb_fb_is_fizzbuzz(RB_UNUSED_VAR(VALUE object), VALUE value)
 {
-    UNUSED(object);
     CHECK_TYPE(value, error(E_INVALID_TYPE));
-
     return CBOOL2RVAL(IS_FIZZBUZZ(value));
 }
 
@@ -393,82 +371,71 @@ rb_fb_is_fizzbuzz(VALUE object, VALUE value)
  *    FizzBuzz[15]   #=> "FizzBuzz"
  *
  * Will raise a <i>FizzBuzz::TypeError</i> exception if given value is not
- * an _Fixnum_ or _Bignum_ type.
+ * a _Fixnum_ or _Bignum_ type, or an _Integer_ type starting from Ruby
+ * version 2.4 onwards.
  *
  * See also: FizzBuzz::is_fizz?, FizzBuzz::is_buzz? and FizzBuzz::is_fizzbuzz?
  */
 VALUE
-rb_fb_square(VALUE object, VALUE value)
+rb_fb_square(RB_UNUSED_VAR(VALUE object), VALUE value)
 {
-    UNUSED(object);
     CHECK_TYPE(value, error(E_INVALID_TYPE));
-
     return fizzbuzz_evaluate(value);
 }
 
-/* :enddoc: */
-
 static VALUE
 fizzbuzz_evaluate(VALUE value)
 {
-    int8_t score;
+    int score;
 
-    if (ZERO_P(value)) {
-        return value;
-    }
+    if (ZERO_P(value))
+	return value;
 
     score = SCORE_VALUE(value);
+
     assert((score >= 0 && score <= 3) && \
-            "Score value out of bounds, must be between 0 and 3 inclusive");
+	   "Score value out of bounds, must be between 0 and 3 inclusive");
 
-    /*
-     * The CSTR2RVAL macro uses rb_str_new2(const char *) which is
-     * rather slow due to all the heavy lifting done internally by
-     * str_new0(VALUE, const char *, long, int) to allocate space
-     * for the new String object, etc.
-     */
-    return score < 1 ? value : CSTR2RVAL(word(score));
+    return score < 1 ? value : word(score);
 }
 
 static VALUE
-fizzbuzz_values(VALUE object, fizzbuzz_return_t type, fizzbuzz_direction_t direction)
+fizzbuzz_values(VALUE object, fizzbuzz_return_t type,
+		fizzbuzz_direction_t direction)
 {
+    int forward = LOOP_FORWARD(direction);
+
     VALUE i = Qnil;
 
     VALUE array = Qnil;
     VALUE value = Qnil;
 
     VALUE start = rb_ivar_get(object, id_at_start);
-    VALUE stop  = rb_ivar_get(object, id_at_stop);
+    VALUE stop = rb_ivar_get(object, id_at_stop);
 
-    if (WANT_ARRAY(type)) {
-        array = rb_ary_new();
-    }
-    else {
-        RETURN_ENUMERATOR(object, 0, 0);
-    }
+    if (WANT_ARRAY(type))
+	array = rb_ary_new();
+    else
+	RETURN_ENUMERATOR(object, 0, 0);
 
-    if (LOOP_FORWARD(direction)) {
-        for (i = start; LESS_EQUAL(i, stop); i = INCREASE(i)) {
-            value = fizzbuzz_evaluate(i);
-            WANT_ARRAY(type) ? rb_ary_push(array, value) : rb_yield(value);
-        }
-    }
-    else {
-        for (i = stop; GREATER_EQUAL(i, start); i = DECREASE(i)) {
-            value = fizzbuzz_evaluate(i);
-            WANT_ARRAY(type) ? rb_ary_push(array, value) : rb_yield(value);
-        }
+    i = forward ? start : stop;
+
+    while (RB_LIKELY(forward ? LESS_EQUAL(i, stop) : GREATER_EQUAL(i, start))) {
+	value = fizzbuzz_evaluate(i);
+	WANT_ARRAY(type) ? rb_ary_push(array, value) : rb_yield(value);
+	i = forward ? INCREASE(i) : DECREASE(i);
     }
 
+    RB_GC_GUARD(array);
+    RB_GC_GUARD(value);
+
     return WANT_ARRAY(type) ? array : object;
 }
 
 static VALUE
 fizzbuzz_exception_wrapper(VALUE value)
 {
-    fizzbuzz_exception_t *e = (struct fizzbuzz_exception *)value;
-
+    fizzbuzz_exception_t *e = (fizzbuzz_exception_t *)value;
     return rb_exc_new2(e->klass, e->message);
 }
 
@@ -479,13 +446,14 @@ fizzbuzz_exception(void *data)
     VALUE object = Qnil;
 
     fizzbuzz_exception_t *e = data;
-    assert(e != NULL && "Must be a valid pointer to `fizzbuzz_exception_t' type");
+
+    assert(e != NULL && \
+	   "Must be a valid pointer to `fizzbuzz_exception_t' type");
 
     object = rb_protect(fizzbuzz_exception_wrapper, (VALUE)e, &exception);
 
-    if (exception) {
-        rb_jump_tag(exception);
-    }
+    if (exception)
+	rb_jump_tag(exception);
 
     rb_iv_set(object, "@start", e->start);
     rb_iv_set(object, "@stop", e->stop);
@@ -507,7 +475,8 @@ fizzbuzz_type_error(VALUE klass, const char *message)
 }
 
 static VALUE
-fizzbuzz_range_error(VALUE klass, VALUE start, VALUE stop, const char *message)
+fizzbuzz_range_error(VALUE klass, VALUE start, VALUE stop,
+		     const char *message)
 {
     fizzbuzz_exception_t e;
 
@@ -523,11 +492,27 @@ void
 Init_fizzbuzz(void)
 {
     id_at_start = rb_intern("@start");
-    id_at_stop  = rb_intern("@stop");
+    id_at_stop	= rb_intern("@stop");
 
     rb_cFizzBuzz = rb_define_class("FizzBuzz", rb_cObject);
     rb_include_module(rb_cFizzBuzz, rb_mEnumerable);
 
+    /*
+     * The CSTR2RVAL macro uses rb_str_new2(const char *) which is
+     * rather slow due to all the heavy lifting done internally by
+     * str_new0(VALUE, const char *, long, int) to allocate space
+     * for the new String object, etc.
+     */
+    rb_define_const(rb_cFizzBuzz, "WORD_FIZZ", CSTR2RVAL("Fizz"));
+    rb_define_const(rb_cFizzBuzz, "WORD_BUZZ", CSTR2RVAL("Buzz"));
+    rb_define_const(rb_cFizzBuzz, "WORD_FIZZBUZZ", CSTR2RVAL("FizzBuzz"));
+
+    if (NIL_P(words[0])) {
+	words[0] = rb_str_freeze(rb_const_get(rb_cFizzBuzz, rb_intern("WORD_FIZZ")));
+	words[1] = rb_str_freeze(rb_const_get(rb_cFizzBuzz, rb_intern("WORD_BUZZ")));
+	words[2] = rb_str_freeze(rb_const_get(rb_cFizzBuzz, rb_intern("WORD_FIZZBUZZ")));
+    }
+
     /*
      * Raised when _FizzBuzz_ encounters an error.
      */
@@ -577,5 +562,3 @@ Init_fizzbuzz(void)
 #if defined(__cplusplus)
 }
 #endif
-
-/* vim: set ts=8 sw=4 sts=2 et : */