fibonaccia 1.0.2

data/lib/fibonaccia/classmethods.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# @internal_comment
+#
+#   Copyright © 2015 Ken Coar
+#
+#   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('fibonaccia/module-doc')
+
+# @private
+module Fibonaccia::ClassMethods
+
+  class << self
+
+    #
+    # @!parse extend ClassMethods
+    #
+    def included(klass)
+      klass.extend(::Fibonaccia::ClassMethods)
+    end                         # def included
+
+  end                           # module Fibonaccia::ClassMethods eigenclass
+
+end                             # module Fibonaccia::ClassMethods

data/lib/fibonaccia/exceptions.rb

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+# @internal_comment
+#
+#   Copyright © 2015 Ken Coar
+#
+#   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('fibonaccia/module-doc')
+
+module Fibonaccia
+
+  #
+  # Define a 'parent' exception class for the module.  All
+  # module-specific exceptions should inherit from this.
+  #
+  class ::Fibonaccia::Exception < ::StandardError
+
+    #
+    # We cannot access the <tt>mesg</tt> 'instance variable' of the
+    # inherited class hierarchy, do we needs must fake it as part of
+    # our constructor.
+    #
+    # If the first element of the argument list is a string, we set
+    # our message to it.  Otherwise, we follow the practice of using
+    # the name of the class as the message.
+    #
+    # @param [Array] args
+    #   <tt>::StandardError.method(:new).arity => -1</tt>, so we allow
+    #   an undefined number of arguments here, as well.  We only look
+    #   at the first one, though.  If it's a string, we use it --
+    #   otherwise we set the message to <tt>nil</tt> and let
+    #   #to_s/#to_str apply the default at need.
+    #
+    def initialize(*args)
+      @mesg		= (args[0].respond_to?(:to_str)) ? args[0] : nil
+      return super
+    end                         # def initialize
+
+    #
+    # We cannot access the standard <tt>Exception</tt> hierarchical
+    # message mechanism because it store the message in a
+    # non-<tt>@</tt> prefixed 'instance variable.'  So we need to work
+    # around it with our own instance variable, set by the
+    # constructor.
+    #
+    # @return [String]
+    #   whatever the constructor stored in the <tt>@mesg</tt> instance
+    #   variable, or the class name if <tt>@mesg</tt> is <tt>nil</tt>.
+    #
+    def to_s
+      return (@mesg || self.class.name)
+    end                         # def to_s
+
+    #
+    # Having a <tt>#to_str</tt> method tells Ruby 'you can treat me as a String.'
+    # This just returns the same value as #to_s.
+    #
+    # @return [String]
+    #   value returned by #to_s method.
+    #
+    def to_str
+      return self.to_s
+    end                         # def to_str
+
+  end                           # class Exception
+
+  class NotPositiveInteger < ::Fibonaccia::Exception
+
+  end                           # class NotPositiveInteger
+
+end                             # module Fibonaccia

data/lib/fibonaccia/module-doc.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+# @internal_comment
+#
+#   Copyright © 2015 Ken Coar
+#
+#   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.
+#
+
+# @internal_comment
+#
+# This file exists solely to ensure that Yard picks up the module documentation properly.
+#
+
+#
+# The *Fibonaccia* module simply provides three things to Ruby code:
+#
+# 1. Access to a constant, <tt>Fibonaccia.PHI</tt> (φ), which is the
+#    value of the Golden Ratio (see the
+#    {https://en.wikipedia.org/wiki/Golden_ratio Wikipedia article})
+#    either to whatever precision Ruby is using, or to an arbitrarily
+#    great precision using <tt>BigDecimal</tt> semantics;
+# 2. The Fibonacci sequence, to however many terms you desire (and your resources
+#    can support);
+# 3. Coördinates to construct a {https://en.wikipedia.org/wiki/Golden_spiral golden spiral}
+#    (<b>not</b> the Fibonacci spiral, which is an <i>approximation</i> of
+#    the golden spiral).  <b><i>Not yet implemented.</i></b>
+#
+module Fibonaccia
+end                             # module Fibonaccia

data/lib/fibonaccia/version.rb

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# @internal_comment
+#
+#   Copyright © 2015 Ken Coar
+#
+#   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('fibonaccia/module-doc')
+require('versionomy')
+
+module Fibonaccia
+
+  #
+  # Minimum version of Ruby we support.
+  #
+  MINIMUM_RUBY_VERSION	= Versionomy.parse('1.9.3')
+  #
+  # Enforce our minimum requirement.
+  #
+  if (Versionomy.ruby_version < MINIMUM_RUBY_VERSION)
+    raise(RuntimeError,
+          "minimum Ruby version required is #{MINIMUM_RUBY_VERSION.to_s}, " +
+          "running #{Versionomy.ruby_version.to_s}")
+  end
+
+  #
+  # Initial starting point.
+  #
+  @version		= Versionomy.parse('0.0.1')
+
+  #
+  # First actual release: 1.0.0!
+  #
+  @version		= @version.change(:major	=> 1,
+	               	                  :tiny		=> 0)
+
+  #
+  # How to advance the version number.
+  #
+  #@version		= @version.bump(:minor)
+
+  #
+  # Stupid build problems..
+  #
+  @version		= @version.bump(:tiny)
+  @version		= @version.bump(:tiny)
+
+  @version.freeze
+
+  #
+  # Frozen string representation of the module version number.
+  #
+  VERSION		= @version.to_s.freeze
+
+  #
+  # Returns the {http://rubygems.org/gems/versionomy Versionomy}
+  # representation of the package version number.
+  #
+  # @return [Versionomy]
+  #
+  def self.version
+    return @version
+  end                           # def self.version
+
+  #
+  # Returns the package version number as a string.
+  #
+  # @return [String]
+  #   Package version number.
+  #
+  def self.VERSION
+    return self.const_get('VERSION')
+  end                           # def self.VERSION
+
+end                             # module Fibonaccia

data/rubygem-fibonaccia.spec

@@ -0,0 +1,118 @@
+%global	gem_name	fibonaccia
+%global gem_version	%(ruby -rubygems -Ilib -r%{gem_name} -e 'puts(Fibonaccia::VERSION)')
+#%global gems_dir	%(ruby -rubygems -e 'begin ; puts(Gem::RUBYGEMS_DIR) ; rescue ; puts(Gem::dir) ; end' 2> /dev/null)
+#%global gem_instdir	%{gem_dir}/gems/%{gem_name}-%{version}
+%global	rubyabi		1.8
+
+Name:		rubygem-%{gem_name}
+Version:	%{gem_version}
+Release:	2%{?dist}
+BuildArch:	noarch
+
+Summary:	Fibonacci series and golden relationships.
+
+Group:		Development/Languages
+
+License:	Apache 2.0
+URL:		https://github.com/RoUS/rubygem-fibonaccia
+Source0:	https://rubygems.org/downloads/%{gem_name}-%{version}.gem
+
+BuildRequires:	rubygems-devel
+BuildRequires:	ruby(rubygems) >= 1.3.6
+BuildRequires:	rubygem-bundler >= 1.0.7
+
+Requires:	rubygem-bigdecimal
+Requires:	rubygem-bundler >= 1.0.7
+Requires:	rubygem-versionomy >= 0.4.3
+
+%description
+This provides a simple module for dealing with the Fibonacci
+series and things that relate to it.
+
+
+%package doc
+Summary:	Documentation for %{name}
+Group:		Documentation
+Requires:	%{name} = %{version}-%{release}
+BuildArch:	noarch
+
+
+%description doc
+Documentation for %{name}
+
+
+%prep
+gem unpack %{SOURCE0}
+%setup -q -D -T -n %{gem_name}-%{version}
+gem spec %{SOURCE0} -l --ruby > %{gem_name}.gemspec
+
+
+%build
+gem build %{gem_name}.gemspec
+#
+# %%gem_install compiles any C extensions and installs the gem into
+# ./%%gem_dir by default, so that we can move it into the buildroot in
+# %%install
+#
+%gem_install
+
+
+%install
+mkdir -p %{buildroot}%{gem_dir}
+cp -a ./%{gem_dir}/* %{buildroot}%{gem_dir}
+
+#
+# Comment these out until we know how to handle them.
+#
+#chmod    0644 $RPM_BUILD_ROOT%{gem_instdir}/tests/*.rb
+#chmod -R 0655 $RPM_BUILD_ROOT%{gem_instdir}/features
+
+#
+# We don't need these files anymore, and they shouldn't be in the RPM.
+#
+rm -rf $RPM_BUILD_ROOT%{gem_instdir}/{.require_paths,.travis.yml}
+rm -rf $RPM_BUILD_ROOT%{gem_instdir}/{test*,features*,rel-eng,Gemfile*}
+rm -rf $RPM_BUILD_ROOT%{gem_instdir}/{Rakefile*,tasks*}
+rm -rf $RPM_BUILD_ROOT%{gem_instdir}/%{name}.spec
+rm -rf $RPM_BUILD_ROOT%{gem_instdir}/%{gem_name}.gemspec
+rm -rf $RPM_BUILD_ROOT%{gem_cache}
+
+
+#%check
+#pushd .%{gem_instdir}
+#ruby -S testrb -Ilib:ext/%{gem_name}/ext $(ls -1 tests/test_*.rb | sort)
+#popd
+
+
+%post
+#
+# If Yard is installed on the system, build the yri docco for the gem.
+#
+if which yard 2>&1 > /dev/null ; then
+   yard gems %{gem_name} 2>&1 > /dev/null
+fi
+
+
+%files
+%defattr(-,root,root,-)
+%doc		%{gem_instdir}/Change[Ll]og
+%doc		%{gem_instdir}/CONTRIBUTORS.md
+%doc		%{gem_instdir}/LICEN[SC]E.md
+%doc		%{gem_instdir}/README.md
+%dir		%{gem_instdir}
+%dir		%{gem_libdir}
+%dir		%{gem_libdir}/%{gem_name}
+%{gem_libdir}/*.rb
+%{gem_libdir}/%{gem_name}/*.rb
+%{gem_spec}
+
+
+%files doc
+%doc		%{gem_docdir}
+%doc		%{gem_instdir}/[A-Z]*.html
+
+
+%changelog
+* Thu Jul 23 2015 Ken Coar <kcoar@redhat.com> 1.0.0-2
+- new package built with tito
+

data/tasks/markdown-to-html.rake

@@ -0,0 +1,9 @@
+desc('Convert markdown files to HTML')
+task(:markdown) do
+  Dir['*.md'].each do |mdname|
+    muname	= mdname.sub(%r!\.md$!, '.html')
+    $stdout.print("Converting #{File.basename(mdname)}:")
+    system("rdiscount < \"#{mdname}\" > \"#{muname}\"")
+    $stdout.puts(' done.')
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: fibonaccia
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Ken Coar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: |
+  Non-mixin module providing access to terms in the Fibonacci series.
+  Fetch specific terms, slice the series, check to see if an arbitrary
+  value is a Fibonacci number, etc.
+email:
+- kcoar@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- Details.md
+files:
+- ".tito/custom/gemtagger.py"
+- ".tito/custom/gemtagger.pyc"
+- ".tito/packages/.readme"
+- ".tito/packages/rubygem-fibonaccia"
+- ".tito/tito.props"
+- ".travis.yml"
+- CONTRIBUTORS.md
+- Changelog
+- Details.md
+- Gemfile
+- LICENCE.md
+- LICENCE.txt
+- README.md
+- Rakefile
+- features/constants.feature
+- features/enumeration.feature
+- features/exceptions.feature
+- features/is_fibonacci.feature
+- features/sizing.feature
+- features/slicing-growth.feature
+- features/slicing-sequence.feature
+- features/slicing.feature
+- features/step_definitions/exceptions.rb
+- features/step_definitions/fibonaccia-specific.rb
+- features/step_definitions/streams.rb
+- features/step_definitions/utility.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- fibonaccia.gemspec
+- lib/fibonaccia.rb
+- lib/fibonaccia/classmethods.rb
+- lib/fibonaccia/exceptions.rb
+- lib/fibonaccia/module-doc.rb
+- lib/fibonaccia/version.rb
+- rubygem-fibonaccia.spec
+- tasks/markdown-to-html.rake
+homepage: https://github.com/RoUS/rubygem-fibonaccia
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main=README.md"
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 3
+summary: fibonaccia-1.0.2 - Easy access to Fibonacci series and related things.
+test_files:
+- features/constants.feature
+- features/enumeration.feature
+- features/exceptions.feature
+- features/is_fibonacci.feature
+- features/sizing.feature
+- features/slicing-growth.feature
+- features/slicing-sequence.feature
+- features/slicing.feature
+- features/step_definitions/exceptions.rb
+- features/step_definitions/fibonaccia-specific.rb
+- features/step_definitions/streams.rb
+- features/step_definitions/utility.rb
+- features/support/env.rb
+- features/support/hooks.rb
+has_rdoc: true