trusted-number 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de7c65f813fed797bf85b4cf8ea88ff2dda8b46fee5c80d3dc5805fbf3bddf0c
-  data.tar.gz: 32db486cbc0acf549e41f72c690b25f47f0d586a0b29eb62ce0756251e7f7c59
+  metadata.gz: f83f617f7f38adb5933a47ffa20bab82ca3c607f9fc23e47adbf6b9d72c9d2fe
+  data.tar.gz: 8c4723d5651ce2060abacf790649e5e3e9acc804887dff4f08cfd672b86aa8bb
 SHA512:
-  metadata.gz: bda7066152658490ff0293b2da171f1f95e7a81f4061e2c172a0edfd7ae026cf295a707ede6c89ada9c1a4ca28884159cfc7ca45c781ee75dc3e9eb458e26d4c
-  data.tar.gz: f9c4be735a77a14073674059e289ce9410301f5cb2f86d61d4789e5901642f41af97018d7cc5b493da0762f975b32a261adc28324bf5ad85ba677a5bbf141efe
+  metadata.gz: 06af918dc5031bbdd61aae17e644c80fdac2c608fba850c69a6145526251f7acc9eca015e151ac0c485f82bb33a1ac10b9fb9b6eb5b9c99eb2497580dc31aed8
+  data.tar.gz: 4e4f4c8dac3fdadb1dac65ade3a2db49ba8bae1c21eb68e355131d01b54e908dfc06bc37c4cf4081aded70d502eb03c65dd14e0a14e81897445fbfb53e46c444

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.3.0] - 2026-04-02
+
+- Add `TNumber` as alias of `TrustedNumber` class
+- Add factory `TrustedNumber.factory(base)`
+- Add more tests
+- Add documentation
+
 ## [0.1.1] - 2026-03-31
 
 - Add MPL 2.0 license

data/README.md

@@ -2,6 +2,8 @@
 
 A trusted number is a number whose value will not change secretly.
 
+For example (with base 10 numbers): `0.1 + 0.2 == 0.3`.
+
 ## Installation
 
 ```bash
@@ -10,17 +12,38 @@ gem install trusted-number
 
 ## Usage
 
-TODO: Write usage instructions here
+Example (base 10):
+
+```ruby
+require "trusted-number"
+
+dec1 = TrustedNumber.new("0.1")
+dec2 = TrustedNumber.new("0.2")
+
+print " Base 10: 0.1 + 0.2 == "
+puts dec1 + dec2 #=> 0.3
+```
+
+Example (base 2):
+
+```ruby
+bin1 = TrustedNumber.new("101.1", base: 2)
+bin2 = TrustedNumber.new("0.1", base: 2)
+
+print " Base 2: 101.1 + 0.1 == "
+puts bin1 + bin2 #=> 110(b2)
+```
 
-## Development
+> More [examples](./examples/)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Contents
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* [Create numbers](./docs/create.md)
+* [Use numbers](./docs/use.md)
+* [Available operations](./docs/operations.md)
+* [Development](./docs/development.md)
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dvarrui/trusted-number.
 
----
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/trusted/number`. To experiment with that code, run `bin/console` for an interactive prompt.

data/Rakefile

@@ -12,3 +12,15 @@ end
 require "standard/rake"
 
 task default: %i[test standard]
+
+# Custom tasks
+
+desc "Help"
+task :help do
+  system("rake -T")
+end
+
+desc "Run standard:fix"
+task :sf do
+  system("rake standard:fix")
+end

data/docs/create.md

@@ -0,0 +1,46 @@
+[<< back](../README.md)
+
+# Create
+
+## 1. Create TrustedNumber numbers
+
+1. Load `trusted-number` library.
+2. Create `TrustedNumber` number objects. Base 10 by default.
+3. Operate with numbers.
+
+```ruby
+require "trusted-number"
+
+num1 = TrustedNumber.new("0.1")
+num2 = TrustedNumber.new("0.2")
+
+puts num1 + num2
+```
+
+## 2. TrustedNumber constructor options
+
+> **NOTE**: For now, it is only possible to perform operations between numbers with the same base.
+
+```ruby
+require_relative "trusted-number"
+
+dec1 = TrustedNumber.new("3.14")
+bin2 = TrustedNumber.new("101", base: 2)
+hex3 = TrustedNumber.new("FF", base: 16)
+```
+
+## 3. Alias TNumber
+
+The alias is a shorthand way of referring to the main class.
+
+```ruby
+require "trusted-number"
+
+num1 = TNumber.new("0.1")
+num2 = TNumber.new("0.2")
+
+puts num1 + num2
+```
+
+## 4. Factory
+

data/docs/development.md

@@ -0,0 +1,10 @@
+[<< back](../README.md)
+
+## Development
+
+In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Ruby code in the file `lib/trusted-number`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+

data/docs/operations.md

@@ -0,0 +1,9 @@
+[<< back](../README.md)
+
+# Operations
+
+> **NOTE**: For now, it is only possible to perform operations between numbers with the same base.
+
+* Create number object using bases from 2 to 23.
+* Compare (`==`, `<`, `>`)
+* Add (`+`)

data/docs/use.md

@@ -0,0 +1,29 @@
+[<< back](../README.md)
+
+# Use numbers
+
+1. Load `trusted-number` library.
+2. Create `TrustedNumber` number. Base 10 by default.
+3. Operate with numbers.
+
+## Sum numbers
+
+```ruby
+require "trusted-number"
+
+num1 = TrustedNumber.new("0.1")
+num2 = TrustedNumber.new("0.2")
+
+puts num1 + num2
+```
+
+## Compare numbers
+
+```ruby
+num1 = TrustedNumber.new("-1,5")
+num2 = TrustedNumber.new("2")
+
+puts (num1 == num2) #=> false 
+puts (num1 < num2)  #=> true
+puts (num1 > num2)  #=> false
+```

data/examples/add.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require_relative "../lib/trusted-number"
+require_relative "line"
+
+line
+puts "Example : 101.1 + 0.1 (base 2)"
+
+bin1 = TrustedNumber.new("101.1", base: 2)
+bin2 = TrustedNumber.new("0.1", base: 2)
+
+res = bin1 + bin2
+puts "Result  : #{res.value}"
+puts res.about
+
+line
+puts "Example : 0.1 + 0.2 (base 10)"
+dec1 = TrustedNumber.new("0.1")
+dec2 = TrustedNumber.new("0.2")
+
+res = dec1 + dec2
+puts "Result  : #{res.value}"
+puts res.about

data/examples/compare.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require_relative "../lib/trusted-number"
+
+def line
+  puts "\n" + "-" * 40
+end
+
+num1 = TrustedNumber.new("0")
+num2 = TrustedNumber.new("-0.2")
+num3 = TrustedNumber.new("-3.0")
+num4 = TrustedNumber.new("4.5")
+
+line
+puts "Example:"
+puts "-  #{num1.value} == #{num2.value} => #{num1 == num2}"
+puts "-  #{num1.value} >  #{num2.value} => #{num1 > num2}"
+puts "-  #{num1.value} <  #{num2.value} => #{num1 < num2}"
+
+line
+puts "Example:"
+puts "-  #{num2.value} == #{num3.value} => #{num2 == num3}"
+puts "-  #{num2.value} >  #{num3.value} => #{num2 > num3}"
+puts "-  #{num2.value} <  #{num3.value} => #{num2 < num3}"
+
+line
+puts "Example:"
+puts "-  #{num4.value} == #{num3.value} => #{num4 == num3}"
+puts "-  #{num4.value} >  #{num3.value} => #{num4 > num3}"
+puts "-  #{num4.value} <  #{num3.value} => #{num4 < num3}"

data/examples/line.rb

@@ -0,0 +1,3 @@
+def line
+  puts "\n" + "-" * 40
+end

data/examples/new.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require_relative "../lib/trusted-number"
+require "debug"
+
+def line
+  puts "\n" + "-" * 40
+end
+
+num = TrustedNumber.new("123.456")
+
+line
+puts "Example: 123.456"
+puts "- base    : #{num.base}"
+puts "- sign    : #{num.sign}"
+puts "- predot  : #{num.predot}"
+puts "- postdot : #{num.postdot}"
+puts "- value   : #{num.value}"
+puts "- about   : #{num.about}"

data/examples/use.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require_relative "../lib/trusted-number"
+require_relative "line"
+
+line
+num1 = TrustedNumber.new("0.1")
+num2 = TrustedNumber.new("0.2")
+print "Example (base #{num1.base}): #{num1.value} + #{num2.value} == "
+puts num1 + num2
+
+line
+num1 = TrustedNumber.new("101.1", base: 2)
+num2 = TrustedNumber.new("0.1", base: 2)
+print "Example (base #{num1.base}): #{num1.value} + #{num2.value} == "
+puts num1 + num2
+
+line
+num1 = TNumber.new(3.1415)
+num2 = TNumber.new(10)
+print "Example (base #{num1.base}): #{num1.value} + #{num2.value} == "
+puts num1 + num2
+
+line
+num1 = TNumber.new("af", base: 16)
+num2 = TNumber.new(2, base: 16)
+print "Example (base #{num1.base}): #{num1.value} + #{num2.value} == "
+puts num1 + num2

data/lib/trusted-number/add.rb

@@ -5,15 +5,15 @@ class TrustedNumber
     p1 = @postdot.ljust(max_post, "0")
     p2 = other.postdot.ljust(max_post, "0")
 
-    # Sum postdot
     res_post, carry = add_strings(p1, p2, @base)
 
     # Sum predot + carry
     res_pre, final_carry = add_strings(@predot, other.predot, @base, carry)
     res_pre = DIGITS[final_carry] + res_pre if final_carry > 0
 
-    build_result(res_pre, res_post)
+    create_new_tnumber(res_pre, res_post)
   end
+  alias_method :add, :+
 
   private
 

data/lib/trusted-number/compare.rb

@@ -0,0 +1,39 @@
+class TrustedNumber
+  include Comparable
+
+  def ==(other)
+    cond = (@base == other.base)
+    cond &&= (@predot == other.predot)
+    cond &&= (@postdot == other.postdot)
+
+    cond
+  end
+  alias_method :equal?, :==
+  alias_method :eq?, :==
+
+  def <=>(other)
+    return nil unless other.is_a?(TrustedNumber)
+    return 0 if about == other.about
+
+    # compare sign
+    return 1 if positive? && other.negative?
+    return -1 if negative? && other.positive?
+
+    # compare predot
+    max_pre = [@predot.length, other.predot.length].max
+    s1_pre = @predot.rjust(max_pre, "0")
+    s2_pre = other.predot.rjust(max_pre, "0")
+
+    return s1_pre <=> s2_pre if s1_pre != s2_pre
+
+    # compare postdot
+    max_post = [@postdot.length, other.postdot.length].max
+    s1_post = @postdot.ljust(max_post, "0")
+    s2_post = other.postdot.ljust(max_post, "0")
+
+    s1_post <=> s2_post
+  end
+
+  alias_method :lt?, :<
+  alias_method :gt?, :>
+end

data/lib/trusted-number/mul.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class TrustedNumber
   def *(other)
     # Algoritmo: Multiplicar como si no hubiera puntos, luego posicionar punto

data/lib/trusted-number/{sub.rb → subtract.rb}

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
 class TrustedNumber
   def -(other)
-    # 1. Alinear decimales
-    max_post = [@postnumber.length, other.postnumber.length].max
-    p1 = @postnumber.ljust(max_post, "0")
-    p2 = other.postnumber.ljust(max_post, "0")
+    # align post
+    max_post = [@postdot.length, other.postdot.length].max
+    p1 = @postdot.ljust(max_post, ZERO)
+    p2 = other.postdot.ljust(max_post, ZERO)
 
-    # 2. Restar postnumbers (manejando el "pedir prestado" o borrow)
-    res_post, borrow = sub_strings(p1, p2, @base)
+    res_post, borrow = subtract_strings(p1, p2, @base)
 
     # 3. Restar prenumbers - borrow
     res_pre, _ = sub_strings(@prenumber, other.prenumber, @base, borrow)
 
-    build_result(res_pre, res_post)
+    create_new_tnumber(res_pre, res_post)
   end
+  alias_method :subtract, :-
 
   private
 
-  def sub_strings(s1, s2, base, borrow = 0)
+  def subtract_strings(s1, s2, base, borrow = 0)
     res = ""
     i, j = s1.length - 1, s2.length - 1
     while i >= 0 || j >= 0
       v1 = (i >= 0) ? DIGITS.index(s1[i]) : 0
       v2 = ((j >= 0) ? DIGITS.index(s2[j]) : 0) + borrow
       if v1 < v2
-        v1 += base
+        v1 += @base
         borrow = 1
       else
         borrow = 0

data/lib/trusted-number/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TrustedNumber
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/trusted-number.rb

@@ -1,57 +1,113 @@
 # frozen_string_literal: true
 
-require_relative "trusted-number/version"
 require_relative "trusted-number/add"
-require_relative "trusted-number/equal"
-require_relative "trusted-number/sub"
+require_relative "trusted-number/compare"
 require_relative "trusted-number/mul"
+require_relative "trusted-number/subtract"
+require_relative "trusted-number/version"
 
 class TrustedNumber
-  attr_reader :base
-  attr_reader :predot, :postdot
+  attr_reader :base, :sign, :predot, :postdot
 
   DIGITS = "0123456789abcdefghijklmnopqrstuvwxyz"
   ZERO = "0"
   DOT = "."
+  POSITIVE = "+"
+  NEGATIVE = "-"
+
+  def self.factory(base)
+    unless base == base.to_i || base < 1
+      raise ArgumentError, "Invalid base (Natural number > 1)"
+    end
+
+    ->(number) { new(number, base: base) }
+  end
 
   def initialize(number, base: 10)
-    @number = number
+    @number = number.to_s.strip
     @base = base
 
-    num_str = @number.to_s.downcase.delete(" ")
-    pre, post = num_str.split(DOT)
-    @predot = pre || ZERO
-    @postdot = post || ZERO
+    fill_attibutes(@number)
+    validate_format
+  end
 
-    validate_format!
+  def about
+    "TrustedNumber: #{value}|base:#{@base}|sign:#{@sign}|pre:#{@predot}|post:#{@postdot}"
   end
 
-  def value
-    return @predot if @postdot == ZERO
+  def negative?
+    @sign == NEGATIVE
+  end
 
-    "#{@predot}#{DOT}#{@postdot}"
+  def positive?
+    !negative?
   end
 
   def to_s
-    "TrustedNumber: #{value} (base: #{@base})"
+    value
+  end
+
+  def value
+    sign = (@sign == POSITIVE) ? "" : @sign
+
+    number = if @postdot == ZERO
+      @predot
+    else
+      "#{@predot}#{DOT}#{@postdot}"
+    end
+    base = "(b#{@base})"
+    base = "" if @base == 10
+    "#{sign}#{number.upcase}#{base}"
   end
 
   private
 
-  def build_result(pre, post)
+  def create_new_tnumber(pre, post)
     pre_clean = pre.gsub(/^0+(?=\d)/, "")
     pre_clean = ZERO if pre_clean.empty?
 
     post_clean = post.gsub(/0+$/, "")
-    str = post_clean.empty? ? pre_clean : "#{pre_clean}.#{post_clean}"
-    TrustedNumber.new(str, base: @base)
+    str_number = post_clean.empty? ? pre_clean : "#{pre_clean}.#{post_clean}"
+    TrustedNumber.new(str_number, base: @base)
   end
 
-  def validate_format!
+  def fill_attibutes(number)
+    num_str = number.to_s.downcase.delete(" ")
+    num_str = fill_sign(num_str)
+
+    pre, post = num_str.split(DOT)
+
+    pre&.gsub!(/\A0+/, "")
+    @predot = if pre.nil? || pre == ""
+      ZERO
+    else
+      pre
+    end
+
+    post&.sub!(/0+\z/, "")
+    @postdot = if post.nil? || post == ""
+      ZERO
+    else
+      post
+    end
+  end
+
+  def fill_sign(number)
+    @sign = POSITIVE
+    if number.start_with?(NEGATIVE)
+      @sign = NEGATIVE
+      number = number[1..]
+    end
+    number
+  end
+
+  def validate_format
     allowed = DIGITS[0...@base]
     pattern = /\A[#{allowed}]*\z/
     unless @predot.match?(pattern) && @postdot.match?(pattern)
-      raise ArgumentError, "Caracteres inválidos para base #{@base}"
+      raise ArgumentError, "Invalid chars (base #{@base})"
     end
   end
 end
+
+TNumber = TrustedNumber

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trusted-number
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Vargas
@@ -20,12 +20,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- examples/01-add.rb
+- docs/create.md
+- docs/development.md
+- docs/operations.md
+- docs/use.md
+- examples/add.rb
+- examples/compare.rb
+- examples/line.rb
+- examples/new.rb
+- examples/use.rb
 - lib/trusted-number.rb
 - lib/trusted-number/add.rb
-- lib/trusted-number/equal.rb
+- lib/trusted-number/compare.rb
 - lib/trusted-number/mul.rb
-- lib/trusted-number/sub.rb
+- lib/trusted-number/subtract.rb
 - lib/trusted-number/version.rb
 - sig/trusted-number.rbs
 homepage: https://github.com/dvarrui/trusted-number

data/examples/01-add.rb

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-require_relative "../lib/trusted-number"
-
-# ------------
-puts "\n" + "=" * 10
-puts "Base 2:"
-
-bin1 = TrustedNumber.new("1.1", base: 2) # (1.5 decimal)
-bin2 = TrustedNumber.new("1.1", base: 2) # (1.5 decimal)
-
-res = bin1 + bin2
-puts res
-puts "Value: #{res.value}" # => "11" (3.0 en decimal)
-
-# ------------
-puts "\n" + "=" * 10
-puts "Base 10"
-dec1 = TrustedNumber.new("0.1")
-dec2 = TrustedNumber.new("0.2")
-
-res = dec1 + dec2
-puts res
-puts "Value: #{res.value}"

data/lib/trusted-number/equal.rb

@@ -1,9 +0,0 @@
-class TrustedNumber
-  def ==(other)
-    cond = (@base == other.base)
-    cond &&= (@predot = other.predot)
-    cond &&= (@posdot = other.postdot)
-
-    cond
-  end
-end