counter_container 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e8da16107e69aea7c94d2cb23c0e7b54361e85af8b980ff270837d82291c3bb
+  data.tar.gz: 024e38f8c86e2e8743f781ff5efc5a647ececc4608fc6a2fd1579dd606bb7281
+SHA512:
+  metadata.gz: c8a071ff4588f9adfb5963fcb1ad7cf61447ca9727d5a9a7baf5e2d56140a5e930cf315b38ae24634268332a3f0a532f8827cfa3bd75349b4aef1d16938651bd
+  data.tar.gz: 6bcf7fca6e04883efa7c4517f67d8250f871924d0ad2d39b07f9a08ecaa947a8bff234a41be8918a898c1bca89ceaf65505c6865adbf7e88b314ccbbe78b4be1

data/lib/counter_container.rb

@@ -0,0 +1,64 @@
+# Provides counting functionality for @counter. Affords
+# incrementation, decrementation and resetting the count
+# via convenient methods.
+#
+# For this module to work, @counter and @start_val are
+# assumed to be of type Integer.
+module CounterContainer
+  COUNTING_INSTANCE_OBJECT_IS_NIL = 'The counting instance attribute @counter was nil.'
+  COUNTING_INSTANCE_OBJECT_IS_NON_INTEGER = 'The counting instance attribute @counter is not an Integer even though it should be.'
+
+  START_VAL_INSTANCE_OBJECT_IS_NIL = 'The starting value attribute @start_val was nil.'
+  START_VAL_INSTANCE_OBJECT_IS_NON_INTEGER = 'The starting value attribute @start_val is not an Integer even though it should be.'
+
+  # sets @start_val, the default value of the counter
+  attr_writer :start_val
+
+  # sets @counter, the object holding the value of
+  # the current count
+  attr_writer :counter
+
+  # Increments @counter by Integer value of 1
+  def increment!
+    raise COUNTING_INSTANCE_OBJECT_IS_NIL if @counter.nil?
+    raise COUNTING_INSTANCE_OBJECT_IS_NON_INTEGER if @counter.class != Integer
+
+    @counter += 1
+  end
+
+  # Synonymous method for CounterContainer#increment!
+  def inc!
+    increment!
+  end
+
+  # Decrements @counter by Integer value of 1
+  def decrement!
+    @counter -= 1
+  end
+
+  # Synonymous method for CounterContainer#increment!
+  def dec!
+    raise COUNTING_INSTANCE_OBJECT_IS_NIL if @counter.nil?
+    raise COUNTING_INSTANCE_OBJECT_IS_NON_INTEGER if @counter.class != Integer
+
+    decrement!
+  end
+
+  # Gets the current count.
+  # @return [Integer] a duplicate of @counter
+  def count
+    raise COUNTING_INSTANCE_OBJECT_IS_NIL if @counter.nil?
+    raise COUNTING_INSTANCE_OBJECT_IS_NON_INTEGER if @counter.class != Integer
+    @counter
+  end
+
+  # Resets the value of @counter to @basis
+  def reset!
+    raise COUNTING_INSTANCE_OBJECT_IS_NIL if @counter.nil?
+    raise COUNTING_INSTANCE_OBJECT_IS_NON_INTEGER if @counter.class != Integer
+    raise START_VAL_INSTANCE_OBJECT_IS_NIL if @start_val.nil?
+    raise START_VAL_INSTANCE_OBJECT_IS_NON_INTEGER if @start_val.class != Integer
+
+    @counter = @start_val.dup
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: counter_container
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jacob Barnard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-04 00:00:00.000000000 Z
+dependencies: []
+description: Provides access to the module CounterContainer. Including CounterContainer
+  allows classes with an Integer attribute (@counter) to gain incrementing, decrementing,
+  and other functionality.
+email: jmbarnardg1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/counter_container.rb
+homepage: https://github.com/jmbarnardgh/counter_container/tree/master
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Provides the CounterContainer module, allowing classes to manipulate a counting
+  object.
+test_files: []