ruby-fizzbuzz 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 15be72f9c77aaa84d7fa6f92403623aa38d62add
-  data.tar.gz: a7b92647afb2cf83ded7bd442829964b09a6a5e5
+SHA256:
+  metadata.gz: fbc46615ef6b3f04b5ee9d784eaaf26db82ea1fc3e2c6d4def2f87c4ff6d9295
+  data.tar.gz: 937d7c799e0cd43ff6bf703014428530f41b108ad56d08b8dcb4cb29d92d736c
 SHA512:
-  metadata.gz: ca579ce7e2c92319421613c3f9aaaddff506a222682760d52c03701d53da730d0da195eb9d30c4adbc2b4f45e7ee2ab600f9c64a12060244fe069e3595c31550
-  data.tar.gz: ae2ba4d86ac6ba15ee7245535f5b797485aef4cee26f713fe3309db983002c0ad85e543b5589518cc2bfeabc2d3b0576f13580861abf3c28eb4d6bc1be275504
+  metadata.gz: 3c8d66d61187180addad7e50f4f7ef2e99b9e4b8a9ed1644923e15b3fe7613c1c8004c7cbd0c316455cb69388ffe0fea62160dcbfbf96b82c4c37280929fdffe
+  data.tar.gz: fc0e431a4ff78c4dd0454f065025a5fff077bdfc42004ef9e194f2d63f4f1bfb4cc0f000432f9199775ec1cd65fb82d07e728745a3a1484b4d18c574fb0732ab

checksums.yaml.gz.sig

@@ -0,0 +1,5 @@
+��Mdn�fvNaIhqWv���������&�.���X+"7#;5q%��Lb��WXn�1i��8�~�
c���оf���*�D3�9>�D���O�Xl�0��MW��6�:�(��Ck�&4z�k�����@�m�i�@+�\A�M���a���a�ts��/�{��Ќ:,
+J����
�����C��P�^cQO�׏"�zdN_1!Y�g��0A�>i��s�˴��ډ|�ܙ&]w����AD^�0%1
+������ƭ�y�� ^��O������a=�I6���
+��u9�֊�@s딞+3����[֭�]�@�
+�9f�B1�$�<��1�g�����y0���H�LT"h�����p�g_����W���"o3���(.�(�W�

data/AUTHORS

@@ -1 +1 @@
-Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>
+Krzysztof Wilczyński <kw@linux.com> (@kwilczynski)

data/CHANGELOG.md

@@ -0,0 +1,175 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.8.0] - 2020-02-05
+### Added
+
+- Added new `step` singleton method to the _FizzBuzz_ class.
+- Added **Code of Conduct** to the project.
+- Added new `--line` command line switch to the `fizzbuzz` script, which allows for printing values in a single line.
+- Added support for the _Integer Unification_ in Ruby version **2.4** onwards.
+- Added few optimisations e.g., `LIKELY` and `UNLIKELY` macros, and improved the `INTEGER_P` macro.
+- Added support for installing and building on _Windows_ has been confirmed with an environment set by _Ruby Installer_
+and _DevKit_ (which is _MinGW_ under the hood).
+- Added more `CFLAGS` to `extconf.rb` file.
+- Added definition of `_DEFAULT_SOURCE` since `_BSD_SOURCE` and `_SVID_SOURCE` are deprecated.
+- Added friendly error message when the `ruby-fizzbuzz` Ruby gem is missing.
+- Added `.editorconfig` file for Ruby.
+- Added very basic `.gitattributes` file.
+- Added `.mailmap` file to be used by Git.
+- Added NOTICE file to the project.
+
+### Changed
+
+- Moved to _Ubuntu Xenial_ on _Travis CI_.
+- Re-factored _Array_ class integration.
+- Re-factored custom `typedef` types and some other small changes.
+- Replaced `File.exists?` with `File.exist?`.
+- Replaced usage of the `volatile` keyword with the `RB_GC_GUARD` macro.
+- Moved to using module constants for the _FizzBuzz_ specific strings values e.g., _Fizz_, _Buzz_ and _FizzBuzz_ to
+improve performance since constants are allocated only once.
+- Updated public GPG key.
+- Updated public signing key.
+- Updated Ruby gem dependencies.
+- Removed surplus `for`-loop replacing it with a simpler `while`-loop.
+- Removed surplus license headers from each file.
+- Removed deprecated `Gem::Specification#has_rdoc=`.
+- Removed integration with services like _Coveralls_, _Code Climate_ and _Gemnasium_.
+- Addressed some of the _GCC_ compiler warnings.
+
+### Fixed
+
+- Resolved Bundler issues by updating its version prior to installing Ruby gems when on _Travis CI_.
+- Fixed pattern for test files in `Guardfile`.
+- Addressed `RuntimeError` caused by modification of a frozen string.
+
+### Deprecated
+
+- Retired support and testing with Ruby _1.9.x_, _2.0.x_, _2.1.x_, _2.2.x_ and _2.3.x_ on _Travis CI_.
+- Retired support and testing for _Rubinius_ on _Travis CI_.
+- Retried testing with Ruby _head_ on _Travis CI_.
+
+## [0.7.0] - 2014-12-15
+### Added
+
+- Added `to_hash`, `as_json`, `to_json` and `from_json` (_singleton_) to the _FizzBuzz_ class.
+- Added rudimentary `Vagrantfile` that can be used to build a development environment.
+- Added the `Guard` Ruby gem for convenience, with an appropriate `Guardfile`.
+- Added _LLVM_ (`clang`) compiler to build with to _Travis CI_.
+
+### Changed
+
+- Re-factored `fizzbuzz` (_singleton_) from the _FizzBuzz_ class to speed it up.
+- Re-factored tests to utilise modern version of the `test-unit` Ruby gem.
+- Re-factored and cleaned up small portions of code and documentation.
+- Updated `Rakefile` to no longer run `test` before `benchmark`.
+
+### Fixed
+
+- Correctly return `Enumerator` when integrating with the _Range_ class.
+- Fixed benchmarks concerning _Array_ and _Range_ integration.
+- Fixed _Travis CI_ build against _Rubinius_.
+- Fixed build to make it work with _C++_ compilers.
+- Fixed version number to comply with [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+### Deprecated
+
+- No longer use of `Enumerable#entries` in the _Array_ integration, achieving
+better performance.
+- Retired testing with Ruby _1.9.2_ and _2.1.0_, and added _2.1.5_ on _Travis CI_.
+- Removed _BitDeli_ badge.
+
+## [0.6.0] - 2014-02-23
+### Added
+
+- Added Ruby _2.1.0_ to _Travis CI_.
+- Added _BitDeli_ and _Gemnasium_ integration.
+
+### Changed
+
+- Updated development dependencies.
+- Re-factored and cleaned up small portions of code.
+- Made _Rake_ `test` task to be the default tasks.
+- Updated the `.gitignore` file to cover _Bundler_, _rbenv_, etc.
+
+### Fixed
+
+- Fixed issue reported by _LLVM_ (`clang`).
+
+## [0.5.0] - 2013-11-26
+### Added
+
+- Added integration with Array and Range types.
+- Added simple benchmark.
+
+## [0.4.0] - 2013-11-18
+### Added
+
+- Added _Coveralls_ and _Code Climate_ integration (and hence improved code test coverage).
+
+### Changed
+
+- Improved error handling and made code more resilient to errors.
+
+### Fixed
+
+- Fixed formatting and white spaces.
+
+### Deprecated
+
+- Retired support for Ruby 1.8.x (no support for _MRI_, _Ruby Enterprise Edition_ and _Rubinius_).
+
+## [0.3.0] - 2013-08-31
+### Added
+
+- 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.
+
+### Changed
+
+- 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.
+
+## [0.2.0] - 2012-09-29
+### Added
+
+- Added `is_fizz?`, `is_buzz?` and `is_fizzbuzz?` singleton methods to _FizzBuzz_ class.
+- Added `fizz?`, `buzz?` and `fizzbuzz?` methods to the _Integer_ class via a monkey-patch
+for convenience. ([#2](https://github.com/kwilczynski/ruby-fizzbuzz/issues/2))
+
+### Changed
+
+- Changed behaviour of the `FizzBuzz#[]` singleton method, so it will yield a _FizzBuzz_
+result for a given arbitrary Integer value. ([#1](https://github.com/kwilczynski/ruby-fizzbuzz/issues/1))
+- Re-factored code to make it cleaner, and added more tests and improved coverage.
+- Re-factored `FizzBuzz` so it now does not assume that we always want to calculate
+results from `1` to `n` -- it is now possible to calculate _FizzBuzz_ results for
+given `n`, `m` values, where `n` denotes start and `m` denotes stop value.
+
+## [0.1.0] - 2012-09-27
+### Added
+
+- First version of FizzBuzz.
+
+[Unreleased]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.9.0...HEAD
+[0.8.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.8.0...v0.9.0
+[0.7.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.7.0...v0.8.0
+[0.6.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.6.0...v0.7.0
+[0.5.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/kwilczynski/ruby-fizzbuzz/compare/0a6b1ba...v0.1.0

data/COPYRIGHT

@@ -1 +1 @@
-Copyright 2012-2014 Krzysztof Wilczynski
+Copyright 2012-2020 Krzysztof Wilczyński

data/README.md

@@ -0,0 +1,46 @@
+# Yet another FizzBuzz in Ruby!
+
+[![Build Status](https://travis-ci.org/kwilczynski/ruby-fizzbuzz.svg)](https://travis-ci.org/kwilczynski/ruby-fizzbuzz)
+[![Documentation Status](https://inch-ci.org/github/kwilczynski/ruby-fizzbuzz.svg)](https://inch-ci.org/github/kwilczynski/ruby-fizzbuzz)
+[![Gem Version](https://badge.fury.io/rb/ruby-fizzbuzz.svg)](http://badge.fury.io/rb/ruby-fizzbuzz)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+## Introduction
+
+Provides simple and fast solution to a popular [FizzBuzz](https://en.wikipedia.org/wiki/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, or the Integer class
+starting from Ruby version 2.4 onwards.
+
+## Table of Contents
+
+1. [Contributing](#contributing)
+2. [Versioning](#versioning)
+3. [Author](#author)
+4. [Copyright](#copyright)
+5. [License](#license)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for best practices and instructions on
+setting up your development environment.
+
+## Versioning
+
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+For the versions available, see the tags on this repository.
+
+## Author
+
+Krzysztof Wilczyński (<kw@linux.com>)
+
+## Copyright
+
+Copyright 2012-2020 Krzysztof Wilczyński
+
+## License
+
+This project is licensed under the terms of the Apache License, Version 2.0 license.
+To view the full license see the included [LICENSE](LICENSE) file.

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/bin/fizzbuzz

@@ -1,106 +1,78 @@
 #!/usr/bin/env ruby
 
-# -*- encoding: utf-8 -*-
-
-# :enddoc:
-
-#
-# fizzbuzz
-#
-# 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.
-#
-
 require 'optparse'
 
 begin
   require 'fizzbuzz'
 rescue LoadError
-  require 'rubygems'
-  require 'fizzbuzz'
+  abort "\n" + (<<-EOS).gsub(/^[ ]+/, '') + "\n"
+    You appear to be missing the ruby-fizzbuzz Ruby gem. Try
+    installing this missing dependency before you can run
+    this executable. To install the ruby-fizzbuzz Ruby gem,
+    try the following:
+
+      gem install ruby-fizzbuzz
+  EOS
 end
 
-script_name = File.basename($0)
+script_name = File.basename($PROGRAM_NAME)
 
 start = 1
 stop  = 100
 
+line    = false
 reverse = false
 
-parser = OptionParser.new do |option|
-  option.banner = <<-EOS
+OptionParser.new do |option|
+  option.banner = (<<-EOS).gsub(/^[ ]{,4}/, '')
+    Yet another FizzBuzz in Ruby.
 
-Yet another FizzBuzz in Ruby.
+    Usage:
 
-Usage:
-
-#{option.summary_indent}#{script_name} [--start <NUMBER>] [--stop <NUMBER>] [--reverse]
-#{option.summary_indent}#{script_name} [--version] [--help]
+    #{option.summary_indent}#{script_name} [--start <NUMBER>] [--stop <NUMBER>] [--reverse]
+    #{option.summary_indent}#{script_name} [--version] [--help]
   EOS
 
   option.separator "\nOptions:\n\n"
 
-  option.on('--start <NUMBER>',
-    "Specify the start value (default: #{start})."
-  ) do | value|
+  option.on('--start <NUMBER>', "Specify the start value (default: #{start}).") do |value|
     start = value.to_i if value
   end
 
-  option.on('--stop <NUMBER>',
-    "Specify the stop value (default: #{stop})."
-  ) do |value|
+  option.on('--stop <NUMBER>', "Specify the stop value (default: #{stop}).") do |value|
     stop = value.to_i if value
   end
 
-  option.on('--reverse',
-    "Print results in a reverse order."
-  ) do
+  option.on('--line', 'Print results in a single line.') do
+    line = true
+  end
+
+  option.on('--reverse', 'Print results in a reverse order.') do
     reverse = true
   end
 
-  option.on('-v', '--version',
-    'Show version number.'
-  ) do
+  option.on('-v', '--version', 'Show version number.') do
     puts FizzBuzz::VERSION
     exit
   end
 
-  option.on('-h', '--help',
-    'Display this help message.'
-  ) do
+  option.on('-h', '--help', 'Display this help message.') do
     puts option.help
     exit
   end
 
-  option.separator <<-EOS
+  option.separator "\n" + (<<-EOS).gsub(/^[ ]{,4}/, '')
+    Note:
 
-Note:
-
-  By default, the results from #{start} to #{stop} will be shown in a descending order.
+      By default, the results from #{start} to #{stop} will be shown in a descending order.
   EOS
-
-  option.separator "\n"
-end
-
-parser.parse!
+end.parse!
 
 begin
-  FizzBuzz.fizzbuzz(start, stop, reverse) {|i| puts i }
+  FizzBuzz.fizzbuzz(start, stop, reverse) do |i|
+    print format('%s%s', i, line ? ' ' : "\n")
+  end
 rescue => e
-  puts "An error occurred: #{e.to_s}"
+  puts "An error occurred: #{e}"
   exit 1
 end
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

data/ext/fizzbuzz/common.h

@@ -1,26 +1,18 @@
-/* :enddoc: */
-
-/*
- * common.h
- *
- * 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(_COMMON_H)
 #define _COMMON_H 1
 
+#if !defined(_GNU_SOURCE)
+# define _GNU_SOURCE 1
+#endif
+
+#if !defined(_BSD_SOURCE)
+# define _BSD_SOURCE 1
+#endif
+
+#if !defined(_DEFAULT_SOURCE)
+# define _DEFAULT_SOURCE 1
+#endif
+
 #if defined(__cplusplus)
 extern "C" {
 #endif
@@ -29,19 +21,39 @@ extern "C" {
 #include <assert.h>
 #include <ruby.h>
 
-#if !(defined(INT8_MIN) || defined(INT8_MAX))
-typedef signed char int8_t;
+#if !defined(ANYARGS)
+# if defined(__cplusplus)
+#  define ANYARGS ...
+# else
+#  define ANYARGS
+# endif
 #endif
 
-#if !(defined(UINT8_MIN) || defined(UINT8_MAX))
-typedef unsigned char uint8_t;
+#if !defined(RB_UNUSED_VAR)
+# if defined(__GNUC__)
+#  define RB_UNUSED_VAR(x) (x) __attribute__ ((unused))
+# else
+#  define RB_UNUSED_VAR(x) (x)
+# endif
 #endif
 
-#if defined(UNUSED)
-# undef(UNUSED)
+#if !(defined(RB_LIKELY) || defined(RB_UNLIKELY))
+# if defined(__GNUC__) && __GNUC__ >= 3
+#  define RB_LIKELY(x)	 (__builtin_expect(!!(x), 1))
+#  define RB_UNLIKELY(x) (__builtin_expect(!!(x), 0))
+# else
+#  define RB_LIKELY(x)	 (x)
+#  define RB_UNLIKELY(x) (x)
+# endif
 #endif
 
-#define UNUSED(x) (void)(x)
+#if !defined(RUBY_METHOD_FUNC)
+# define RUBY_METHOD_FUNC(f) ((VALUE (*)(ANYARGS))(f))
+#endif
+
+#if defined(RUBY_INTEGER_UNIFICATION) || RUBY_API_VERSION_CODE >= 20400
+# define HAVE_INTEGER_UNIFICATION 1
+#endif
 
 #if !defined(CSTR2RVAL)
 # define CSTR2RVAL(x) ((x) == NULL ? Qnil : rb_str_new2(x))
@@ -68,5 +80,3 @@ typedef unsigned char uint8_t;
 #endif
 
 #endif /* _COMMON_H */
-
-/* vim: set ts=8 sw=4 sts=2 et : */