dr_light 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 288117834749641c8f72f5992cbaa22268342014b919bae7b8305af38c139dcb
-  data.tar.gz: 923ee123b123b4222c0f4ccc35e7f370256519ab0cd6df6ae1a5589c031eab31
+  metadata.gz: 03cdec01261b9d5b682f4b85d71009abd4216912aaece529ada333ff4ab910e7
+  data.tar.gz: a2e6c4d8013f389e5872de461e637bc6209365a2561b6cace450fd7d4b1ca367
 SHA512:
-  metadata.gz: e8222dea48e0d17380267b9e5ce7a9d316580212a88213f04fd1ef625998f8d25996d9c6ec88e2143a507d628bbbb26068f9517833f49ffc158de41de9203d87
-  data.tar.gz: 51fec29e95479c2a3bfbe61787dcc438726b2563d56ea80d43a9a8d45d701f391995902a92abe53724985dfee0395455248ab37ac633db40e99c8067687cb5c5
+  metadata.gz: 92a816d6c71135d96fbb5f8435aaf27316f3b44fb946c44592129ffeb8892eeac3a16c715293b978cec43490bc8e9a03587fc6ee476da1a3d0e41771fa13f914
+  data.tar.gz: b4871424ed66e10973c2ef2e24c5197c024c5c2afbbf8d3c88ff1a2c57a3e011e466adb0334ee221f94e7618491d8f261a7918afbebea4876547c5b710167d22

data/README.md

@@ -4,11 +4,12 @@ DrLight
 [![Test Coverage](https://codeclimate.com/github/darthjee/dr_light/badges/coverage.svg)](https://codeclimate.com/github/darthjee/dr_light/coverage)
 [![Issue Count](https://codeclimate.com/github/darthjee/dr_light/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/dr_light)
 [![Gem Version](https://badge.fury.io/rb/dr_light.svg)](https://badge.fury.io/rb/dr_light)
+[![Inline docs](http://inch-ci.org/github/darthjee/dr_light.svg?branch=master)](http://inch-ci.org/github/darthjee/dr_light)
 
 
 ![dr_light](https://raw.githubusercontent.com/darthjee/dr_light/master/dr_light.jpg)
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/dr_light/0.0.1
+https://www.rubydoc.info/gems/dr_light/0.0.2
 

data/config/check_specs.yml

@@ -1 +1,3 @@
-ignore: []
+ignore:
+  - lib/dr_light.rb
+  - lib/dr_light/version.rb

data/config/yardstick.yml

@@ -15,13 +15,21 @@ rules:
     exclude: []
   ExampleTag:
     enabled: true
-    exclude: []
+    exclude:
+      - DrLight::ScientificNumber#value
+      - DrLight::ScientificNumber#deviance
+      - DrLight::ScientificNumber#initialize
+      - DrLight::ScientificNumber::Formatter#initialize
+      - DrLight::ScientificNumber::Normalizer#initialize
   ReturnTag:
     enabled: true
     exclude: []
   Summary::Presence:
     enabled: true
-    exclude: []
+    exclude:
+      - DrLight::ScientificNumber#initialize
+      - DrLight::ScientificNumber::Formatter#initialize
+      - DrLight::ScientificNumber::Normalizer#initialize
   Summary::Length:
     enabled: true
     exclude: []

data/lib/dr_light.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 # @author darthjee
-# @ai public
+# @api public
 #
 # Pack of science usefull classes
 module DrLight
   autoload :ScientificNumber, 'dr_light/scientific_number'
+  autoload :Utils,            'dr_light/utils'
 end

data/lib/dr_light/scientific_number.rb

@@ -6,8 +6,23 @@ module DrLight
   #
   # Number to be exibed in scientific number
   class ScientificNumber
-    autoload :Formatter, 'dr_light/scientific_number/formatter'
+    autoload :Formatter,  'dr_light/scientific_number/formatter'
+    autoload :Normalizer, 'dr_light/scientific_number/normalizer'
+
     attr_reader :value, :deviance
+    # @!method value
+    # @api public
+    #
+    # The number value (average)
+    #
+    # @return [Numeric]
+
+    # @!method deviance
+    # @api public
+    #
+    # The deviance from the average (imprecision)
+    #
+    # @return [Numeric]
 
     # @param value [Nuber] number to be exibed
     # @param deviance [Number] deviance of number
@@ -17,19 +32,41 @@ module DrLight
     end
 
     # string representation of number
+    #
+    # @example
+    #   number = DrLight::ScientificNumber.new(0.42, 0.01)
+    #   number.to_s # returns '4.20(10)e-1'
+    #
+    # @return [String]
     def to_s
       format(
         formatter.format_string,
-        value: formatter.value,
-        exponential: formatter.exponential,
-        deviance: formatter.deviance
+        value: normalizer.value,
+        exponential: normalizer.exponential,
+        deviance: normalizer.deviance
       )
     end
 
     private
 
+    # @private
+    # @api private
+    #
+    # String formatter
+    #
+    # @return [Formatter]
     def formatter
-      @formatter ||= Formatter.new(
+      @formatter ||= Formatter.new(normalizer)
+    end
+
+    # @private
+    # @api private
+    #
+    # Values normalizer
+    #
+    # @return [Normalizer]
+    def normalizer
+      @normalizer ||= Normalizer.new(
         value: value,
         deviance: deviance
       )

data/lib/dr_light/scientific_number/formatter.rb

@@ -3,70 +3,58 @@
 module DrLight
   class ScientificNumber
     # @author darthjee
-    # @api public
+    # @api private
     #
     # Class responsible for formatting the values of
     # {ScientificNumber}
     class Formatter
-      attr_reader :exponential, :significant,
-                  :value, :deviance
-
-      # @param value [Nuber] number to be exibed
-      # @param deviance [Number] deviance of number
-      def initialize(value:, deviance:)
-        @value = value
-        @deviance = deviance
-        @significant = 1
-        @exponential = 0
-        format_value
+      # @param value [Numeric] number to be exibed
+      # @param deviance [Numeric] deviance of number
+      def initialize(normalizer)
+        @normalizer = normalizer
       end
 
-      # Returns the string of the format expected for
-      # {ScientificNumber#to_s}
+      # Returns the string of the format expected
+      #
+      # @see ScientificNumber#to_s
       #
       # @return [String]
       def format_string
-        ["%<value>.#{significant}f"].tap do |values|
-          values << '(%<deviance>d)' unless deviance.zero?
-          values << 'e%<exponential>d' unless exponential.zero?
+        ["%<value>.#{normalizer.significant}f"].tap do |values|
+          values << '(%<deviance>d)' if deviance?
+          values << 'e%<exponential>d' if exponential?
         end.join
       end
 
       private
 
-      def format_value
-        normalize_value
-        normalize_deviance
-      end
-
-      def normalize_value
-        order = order_from(@value)
-        @exponential += order
-        @value /= (10.0**order)
-        @deviance /= (10.0**order)
-      end
-
-      def normalize_deviance
-        return if @deviance.zero?
-
-        if order_difference.negative?
-          @value *= (10.0**order_difference)
-          @exponential -= order_difference
-        else
-          @significant += order_difference
-        end
-
-        @deviance *= 10 * (10.0**order_difference)
-        @deviance += 0.5
-      end
+      attr_reader :normalizer
+      # @method normalizer
+      # @private
+      # @api private
+      #
+      # Number normalizer
+      #
+      # @return [Normalizer]
 
-      def order_from(number)
-        format('%<number>e', number: number).gsub(/.*e/, '').to_i
+      # @private
+      # @api private
+      #
+      # Checks if deviance should be present on the output
+      #
+      # @return [TrueClass,FalseClass]
+      def deviance?
+        !normalizer.deviance.zero?
       end
 
-      def order_difference
-        @order_difference ||=
-          order_from(@value) - order_from(@deviance)
+      # @private
+      # @api private
+      #
+      # Checks if exponential should be present on the output
+      #
+      # @return [TrueClass,FalseClass]
+      def exponential?
+        !normalizer.exponential.zero?
       end
     end
   end

data/lib/dr_light/scientific_number/normalizer.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module DrLight
+  class ScientificNumber
+    # @author darthjee
+    # @api private
+    #
+    # Class responsible for normalizing the scientific number
+    class Normalizer
+      attr_reader :exponential, :significant, :value, :deviance
+      # @method exponential
+      # @api private
+      #
+      # Exponential factor of number
+      #
+      # Any number can be represented by the exponencial
+      # format.
+      #
+      # ex: +12.4+ can be represented +1.24e1+
+      #
+      # @return [Numeric]
+
+      # @method significant
+      # @api private
+      #
+      # Significant decimals to be shown from the value
+      #
+      # The smaller the {#deviance}, more significant
+      # digits need to be shown
+      #
+      # @return [Numeric]
+
+      # @method value
+      # @api private
+      #
+      # The value after normalization
+      #
+      # Value will be returned always being a value
+      # between -10 and 10
+      #
+      # @return [Numeric]
+
+      # @method deviance
+      # @api private
+      #
+      # Deviance representation
+      #
+      # Deviance will always be a number
+      # between 10 and and 100
+      #
+      # @return [Integer]
+
+      # @param value [Numeric] number to be normalized
+      # @param deviance [Numeric] deviance of number
+      def initialize(value:, deviance:)
+        @value = value
+        @deviance = deviance
+        @significant = 1
+        normalize_value
+        normalize_deviance
+      end
+
+      private
+
+      # @private
+      #
+      # Normalize the value to use scientific notation
+      #
+      # 612 becomes 6.13
+      #
+      # 0.613 becomes 6.13
+      #
+      # The difference is recorded on exponential
+      #
+      # @return [Numeric] the exponential
+      def normalize_value
+        @value /= value_order_multiplier
+        @deviance /= value_order_multiplier
+        @exponential = value_order
+      end
+
+      # @private
+      #
+      # Normalize the values based on the order difference
+      #
+      # @return [Numeric]
+      def normalize_difference
+        if order_difference.negative?
+          @value *= order_difference_multiplier
+          @exponential -= order_difference
+        else
+          @significant += order_difference
+        end
+      end
+
+      # @private
+      #
+      # Normalize the deviance to have 12 digits
+      #
+      # @return [Numeric]
+      def normalize_deviance
+        return if @deviance.zero?
+
+        normalize_difference
+        @deviance *= 10 * order_difference_multiplier
+        @deviance += 0.5
+      end
+
+      # @private
+      #
+      # Order difference  between value and deviance
+      #
+      # @return [Numeric]
+      def order_difference
+        @order_difference ||= Utils.order_difference(@value, @deviance)
+      end
+
+      # @private
+      #
+      # potency of 10^order_difference
+      #
+      # @return [Numeric]
+      def order_difference_multiplier
+        @order_difference_multiplier ||= 10.0**order_difference
+      end
+
+      # @private
+      #
+      # Order of the value
+      #
+      # @return [Numeric]
+      def value_order
+        @value_order ||= Utils.order(@value)
+      end
+
+      # @private
+      #
+      # potency of 10^value_order
+      #
+      # @return [Numeric]
+      def value_order_multiplier
+        @value_order_multiplier ||= 10.0**value_order
+      end
+    end
+  end
+end

data/lib/dr_light/utils.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DrLight
+  # @author darthjee
+  # @api public
+  #
+  # Module with utility functions
+  module Utils
+    # Return the order of the number
+    #
+    # Number 63 can be rewriten as 6.3*10^1 where
+    # 1 is the order
+    #
+    # @param number [Numeric] number to be analyzed
+    #
+    # @return [Integer]
+    #
+    # @example Negative big number
+    #   DrLight::Utils.order(-100) # returns 2
+    # @example Positive small number
+    #   DrLight::Utils.order(0.01) # returns -2
+    # @example Zero
+    #   DrLight::Utils.order(0) # returns 0
+    def self.order(number)
+      format('%<number>e', number: number).gsub(/.*e/, '').to_i
+    end
+
+    # Returns the order difference between 2 numbers
+    #
+    # @param first_number [Numeric] number to be analiyzed
+    # @param second_number [Numeric] number to be analiyzed
+    #
+    # @return [Integer]
+    #
+    # @example
+    #   DrLight::Utils.order_difference(-10, 0.1) # returns 2
+    def self.order_difference(first_number, second_number)
+      order(first_number) - order(second_number)
+    end
+  end
+end

data/lib/dr_light/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DrLight
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/integration/yard/dr_light/scientific_number_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DrLight::ScientificNumber do
+  describe '#to_s' do
+    describe 'yard' do
+      subject(:number) { described_class.new(value, deviance) }
+
+      let(:value)    { 0.42 }
+      let(:deviance) { 0.01 }
+
+      it do
+        expect(number.to_s).to eq('4.20(10)e-1')
+      end
+    end
+  end
+end