zold-score 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f144b35f41f572b478b56aa45dfb771f6df83f9ffbfbe725287a39dd51eb7329
-  data.tar.gz: 8de2e35edc58105204a30479352af5283178b69b006e849b581c7492ac65197c
+  metadata.gz: fea20008b46e776779c40cc80438e7a95446cd3348ed819a447c2dfe9896b2f8
+  data.tar.gz: e077d65ccd21ffc3a331c04d45eed5e18f4af4b11cdec0c26b4ed9b27c6141bf
 SHA512:
-  metadata.gz: 157659238d2e181462a65694ae60801ac49fae88e6656e709b521a6f4df172a33afbdbc759e1a81ac81ee77928cf3d552331c0fced3481d9e9d3d06fb1407f7a
-  data.tar.gz: 202d378faeba0c50d0d357436e3bf844c0770c12173d47a32b331369f835298d79cc759ca5c9f20938ab7929a96678ee42d0e7f570656e80268069740be5c079
+  metadata.gz: beebaa5ce22becb6404f983d4b1214c64dc227da9a6868715c46e5f36c81fc8334c334c5996b5ecec1dc89d63ff257b6300ef1835b8ae5e0fd2f1ce6b2ad4a9e
+  data.tar.gz: a1ee92aee0494c7c6dd74f423ac83d3bc9d5a220340d4340e45bb09c142ef1d948c658a037c81df79eebbd0a156d901276478480e7a2f85a80fe9f183f7cc23c

data/.rubocop.yml

@@ -7,14 +7,18 @@ Layout/EmptyLineAfterGuardClause:
 Layout/EndOfLine:
   EnforcedStyle: lf
 Metrics/AbcSize:
-  Max: 25
+  Max: 45
 Metrics/BlockLength:
   Max: 30
 Metrics/MethodLength:
-  Max: 25
+  Max: 40
 Metrics/ClassLength:
   Max: 180
 Metrics/ParameterLists:
   Max: 7
 Layout/AlignParameters:
   Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 20
+Metrics/PerceivedComplexity:
+  Max: 20

data/lib/zold/score.rb

@@ -48,17 +48,53 @@ module Zold
     # increase. The number is set empirically.
     STRENGTH = 8
 
+    # The maximum amount of hours a score can stay "fresh." After that it
+    # will be considered expired.
+    BEST_BEFORE = 24
+
     attr_reader :time, :host, :port, :invoice, :suffixes, :strength, :created
 
     # Makes a new object of the class.
     def initialize(time: Time.now, host:, port: 4096, invoice:, suffixes: [],
       strength: Score::STRENGTH, created: Time.now)
+      raise 'Time can\'t be nil' if time.nil?
+      unless time.is_a?(Time)
+        raise "Time must be Time, while #{time.class.name} is provided"
+      end
       @time = time
+      raise 'Host can\'t be nil' if host.nil?
+      unless host =~ /^[0-9a-z\.\-]+$/
+        raise "Host \"#{host}\" is in a wrong format"
+      end
       @host = host
+      raise 'Port can\'t be nil' if port.nil?
+      unless port.is_a?(Integer)
+        raise "Port must be Integer, while #{port.class.name} is provided"
+      end
+      if port > 65_535
+        raise "Port must be less than 65535, while #{port} is provided"
+      end
+      unless port.positive?
+        raise "Port must be positive integer, while #{port} is provided"
+      end
       @port = port
+      raise 'Invoice can\'t be nil' if invoice.nil?
+      unless invoice =~ /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
+        raise "Invoice \"#{invoice}\" is wrong"
+      end
       @invoice = invoice
+      raise 'Suffixes can\'t be nil' if suffixes.nil?
+      raise 'Suffixes are not an array' unless suffixes.is_a?(Array)
       @suffixes = suffixes
+      raise 'Strength can\'t be nil' if strength.nil?
+      unless strength.positive?
+        raise "Strength must be positive integer, while #{strength} is provided"
+      end
       @strength = strength
+      raise 'Created can\'t be nil' if created.nil?
+      unless created.is_a?(Time)
+        raise "Created must be Time, while #{created.class.name} is provided"
+      end
       @created = created
     end
 
@@ -70,23 +106,41 @@ module Zold
 
     # Parses it back from the JSON.
     def self.parse_json(json)
-      unless json['time'] =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/
-        raise "Time in JSON is broken: #{json}"
-      end
-      raise "Host is wrong: #{json}" unless json['host'] =~ /^[0-9a-z\.\-]+$/
-      raise "Port is wrong: #{json}" unless json['port'].is_a?(Integer)
-      unless json['invoice'] =~ /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
-        raise "Invoice is wrong: #{json}"
-      end
-      raise "Suffixes not array: #{json}" unless json['suffixes'].is_a?(Array)
+      raise 'JSON can\'t be nil' if json.nil?
       Score.new(
-        time: Time.parse(json['time']), host: json['host'],
-        port: json['port'], invoice: json['invoice'],
+        time: Time.parse(json['time']),
+        host: json['host'],
+        port: json['port'],
+        invoice: json['invoice'],
         suffixes: json['suffixes'],
         strength: json['strength']
       )
     end
 
+    # Compare with another Score, by text.
+    def ==(other)
+      raise 'Can\'t compare with nil' if other.nil?
+      to_s == other.to_s
+    end
+
+    # Compare with another Score, by value.
+    def <(other)
+      raise 'Can\'t compare with nil' if other.nil?
+      value < other.value
+    end
+
+    # Compare with another Score, by value.
+    def >(other)
+      raise 'Can\'t compare with nil' if other.nil?
+      value > other.value
+    end
+
+    # Compare with another Score, by value.
+    def <=>(other)
+      raise 'Can\'t compare with nil' if other.nil?
+      value <=> other.value
+    end
+
     # Converts it to a string. You can parse it back
     # using <tt>parse()</tt>.
     def to_s
@@ -104,6 +158,7 @@ module Zold
 
     # Parses it back from the text generated by <tt>to_s</tt>.
     def self.parse(text)
+      raise 'Can\'t parse nil' if text.nil?
       parts = text.split(' ', 7)
       raise "Invalid score, not enough parts in \"#{text}\"" if parts.length < 6
       Score.new(
@@ -151,6 +206,7 @@ module Zold
     # Returns a new score, which is a copy of the current one, but the amount
     # of hash suffixes is reduced to the <tt>max</tt> provided.
     def reduced(max = 4)
+      raise 'Max can\'t be nil' if max.nil?
       raise "Max can't be negative: #{max}" if max.negative?
       Score.new(
         time: @time, host: @host, port: @port, invoice: @invoice,
@@ -183,7 +239,8 @@ module Zold
     end
 
     # Returns TRUE if the age of the score is over 24 hours.
-    def expired?(hours = 24)
+    def expired?(hours = BEST_BEFORE)
+      raise 'Hours can\'t be nil' if hours.nil?
       age > hours * 60 * 60
     end
 

data/test/zold/test_score.rb

@@ -54,9 +54,18 @@ class TestScore < Minitest::Test
     assert_equal(64, score.hash.length)
   end
 
+  def test_compares
+    score = Zold::Score.new(
+      time: Time.parse('2017-07-19T21:24:51Z'),
+      host: 'localhost', port: 443, invoice: 'NOPREFIX@ffffffffffffffff',
+      suffixes: %w[A B C D E F G]
+    )
+    assert(score == score.reduced(10))
+  end
+
   def test_drops_to_zero_when_expired
     score = Zold::Score.new(
-      time: Time.now - 24 * 60 * 60,
+      time: Time.now - Zold::Score::BEST_BEFORE * 60 * 60,
       host: 'some-host', port: 9999, invoice: 'NOPREFIX@ffffffffffffffff',
       strength: 50
     ).next

data/zold-score.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2'
   s.required_ruby_version = '>=2.3'
   s.name = 'zold-score'
-  s.version = '0.4.3'
+  s.version = '0.4.4'
   s.license = 'MIT'
   s.summary = 'Zold score'
   s.description = 'Score calculating Ruby Gem for Zold'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zold-score
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2018-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov