vnstat-ruby 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1147fd1dc7aa2c9d3990b48e410a1a2f68e8ecd3e5dfc390116131f703050624
-  data.tar.gz: 5804a8055fc72e8f5dd9fefe888072524ebd8ee842fa26194b45130106dbc170
+SHA1:
+  metadata.gz: b6862e06e3145d26d76461b2bb6df4840ff73d52
+  data.tar.gz: d704f075ed406527a5ebb5dad12572422dc7b5a7
 SHA512:
-  metadata.gz: 9e2be0b328f5b8df0dea239b8c2554d812afc439c89798844fe80dc2edf4fb5f1841ffd1036c3470763fca10a2cc21d90a816043030e89bd250edf3151f3ccb6
-  data.tar.gz: b163535f90d28910ec626e7d3e997c426addb363dfa50b242f5d0a384b0e9b92ceeeadc000a3d4a1d3af52934125b0ecaab6b6409b7b088448c0f810713f1861
+  metadata.gz: 59e46295ad1b32dbd8862421e484869f508ab67c75f205eb4e5a3f23a9ba534c24e2e431188415d354250f5263a58e3deb18acf5c9b040b48c6a9f9839e6f7f7
+  data.tar.gz: 56ad2d5a85a170c35544c83248b1b6a552d04c00544b9806039eb34e96753eebfe2b9b23d10cdd2c1ca9c77bf0e7478833c15ce4f8524f5c95a391b898402e55

data/.rubocop.yml

@@ -1,3 +1,5 @@
+require: rubocop-performance
+
 AllCops:
   Include:
     - '**/*.rb'
@@ -7,11 +9,12 @@ AllCops:
     - '**/*.jbuilder'
     - Rakefile
     - spec/spec_helper.rb
+  TargetRubyVersion: '2.3'
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
-Style/FileName:
+Naming/FileName:
   Exclude:
-    - Gemfile
+    - 'lib/vnstat-ruby.rb'

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.3.8

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.3.8

data/.travis.yml

@@ -1,12 +1,11 @@
 sudo: false
 language: ruby
 rvm:
- - '2.1.10'
- - '2.2.8'
- - '2.3.6'
- - '2.4.3'
- - '2.5.0'
-before_install: gem install bundler -v 1.14.6
+ - '2.3.8'
+ - '2.4.5'
+ - '2.5.3'
+ - '2.6.1'
+before_install: gem install bundler -v 2.0.1
 script: bundle exec rspec
 addons:
   code_climate:

data/Gemfile.lock

@@ -1,21 +1,22 @@
 PATH
   remote: .
   specs:
-    vnstat-ruby (2.0.0)
-      nokogiri (~> 1.8)
+    vnstat-ruby (3.0.0)
+      nokogiri (~> 1.8.5)
+      systemcall (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     diff-lcs (1.2.5)
+    jaro_winkler (1.5.2)
     mini_portile2 (2.3.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
-    parallel (1.12.1)
-    parser (2.5.0.4)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.3.0)
@@ -31,27 +32,31 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    rubocop (0.53.0)
+    rubocop (0.68.0)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 2.5, != 2.5.1.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.3.0)
-    yard (0.9.12)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    systemcall (1.0.0)
+    unicode-display_width (1.5.0)
+    yard (0.9.19)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.14)
+  bundler (~> 2.0)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 0.53)
+  rubocop (~> 0.68.0)
+  rubocop-performance (~> 1.1.0)
   vnstat-ruby!
-  yard (~> 0.9.12)
+  yard (~> 0.9.19)
 
 BUNDLED WITH
-   1.16.1
+   2.0.1

data/README.md

@@ -13,7 +13,7 @@ maintained by Teemu Toivola.
 
 ### Prerequisites
 
-* Ruby 2.1.0 or greater
+* Ruby 2.3.0 or greater
 * Make sure you have `vnstat` CLI installed by running `which vnstat`.
 
 On Ubuntu you can get the vnstat package via `apt-get install vnstat`.
@@ -148,7 +148,7 @@ end
 ```ruby
 interface.tops.first
 interface.tops[2]
-# => #<Vnstat::Result::Minute time: #<DateTime: 2015-11-05T09:03:42+00:00>>
+# => #<Vnstat::Result::Minute time: 2015-11-05 09:03:42 +0000>
 ```
 
 ```ruby

data/lib/vnstat.rb

@@ -14,7 +14,6 @@ module Vnstat
   autoload :InterfaceCollection, 'vnstat/interface_collection'
   autoload :Parser, 'vnstat/parser'
   autoload :Result, 'vnstat/result'
-  autoload :SystemCall, 'vnstat/system_call'
   autoload :Traffic, 'vnstat/traffic'
   autoload :Utils, 'vnstat/utils'
 
@@ -59,17 +58,6 @@ module Vnstat
     InterfaceCollection.open
   end
 
-  ##
-  # Returns information for the currently installed version of vnstat.
-  #
-  # @deprecated Please use {#cli_version} instead.
-  # @return [String]
-  def version
-    warn '[DEPRECATION] `Vnstat.version` is deprecated. Please use ' \
-         '`Vnstat.cli_version` instead.'
-    cli_version
-  end
-
   ##
   # Returns information for the currently installed version of vnstat.
   #

data/lib/vnstat/document.rb

@@ -39,6 +39,7 @@ module Vnstat
     # @raise [ArgumentError] Raised if the specified data was nil.
     def data=(data)
       raise ArgumentError, 'No document data specified' if data.nil?
+
       @data = Nokogiri::XML.parse(data.to_s)
     end
 

data/lib/vnstat/interface.rb

@@ -35,6 +35,7 @@ module Vnstat
     # @return [true, false]
     def ==(other)
       return false unless other.respond_to?(:id)
+
       id == other.id
     end
 

data/lib/vnstat/interface_collection.rb

@@ -71,6 +71,7 @@ module Vnstat
     def create(id)
       success = Utils.call_executable_returning_status('--create', '-i', id)
       return nil unless success
+
       reload
       self[id]
     end

data/lib/vnstat/result.rb

@@ -52,6 +52,7 @@ module Vnstat
     # @return [Integer, nil]
     def <=>(other)
       return nil unless other.respond_to?(:bytes_transmitted)
+
       bytes_transmitted <=> other.bytes_transmitted
     end
   end

data/lib/vnstat/result/day.rb

@@ -41,6 +41,7 @@ module Vnstat
       def <=>(other)
         return nil unless other.respond_to?(:bytes_transmitted)
         return nil unless other.respond_to?(:date)
+
         [date, bytes_transmitted] <=> [other.date, other.bytes_transmitted]
       end
     end

data/lib/vnstat/result/hour.rb

@@ -49,6 +49,7 @@ module Vnstat
       def <=>(other)
         return nil unless other.respond_to?(:bytes_transmitted)
         return nil unless other.respond_to?(:time)
+
         [time, bytes_transmitted] <=> [other.time, other.bytes_transmitted]
       end
 

data/lib/vnstat/result/month.rb

@@ -43,6 +43,7 @@ module Vnstat
       def <=>(other)
         return nil unless other.respond_to?(:bytes_transmitted)
         return nil if !other.respond_to?(:year) || !other.respond_to?(:month)
+
         [year, month, bytes_transmitted] <=>
           [other.year, other.month, other.bytes_transmitted]
       end

data/lib/vnstat/result/time_comparable.rb

@@ -11,6 +11,7 @@ module Vnstat
       def <=>(other)
         return nil unless other.respond_to?(:bytes_transmitted)
         return nil unless other.respond_to?(:time)
+
         [time, bytes_transmitted] <=> [other.time, other.bytes_transmitted]
       end
     end

data/lib/vnstat/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'systemcall'
+
 module Vnstat
   ##
   # A module containing several utility methods.
@@ -9,7 +11,7 @@ module Vnstat
     ##
     # Initiates a system call with the given arguments.
     #
-    # @param [Array<String>] args The arguments for the system call.
+    # @param [Array] args The arguments for the system call.
     #
     # @overload system_call(*args)
     #   @return [String] The output of STDOUT or STDERR, depending of the exit
@@ -21,18 +23,19 @@ module Vnstat
     #   @yieldparam [String] error_result The STDERR output.
     #   @return [Object] The value the called block returns.
     def system_call(*args)
-      system_call = SystemCall.call(*args)
-      return system_call.success_result if system_call.success?
-      return yield(system_call.error_result) if block_given?
-      system_call.error_result
+      result = SystemCall.call(*args)
+      return result.success_result if result.success?
+      return yield(result.error_result) if block_given?
+
+      result.error_result
     end
 
     ##
     # Initiates a system call with the given arguments and returning whether the
     # command has been executed successfully.
     #
-    # @param [Array<String>] args The arguments for the system call.
-    # @return [true, false] Indicates whether the command has been executed
+    # @param [Array] args The arguments for the system call.
+    # @return [Boolean] Indicates whether the command has been executed
     #   successfully (true), or not (false).
     def system_call_returning_status(*args)
       SystemCall.call(*args).success?
@@ -41,7 +44,7 @@ module Vnstat
     ##
     # Calls the vnstat CLI with the given arguments.
     #
-    # @param [Array<String>] args The arguments for the system call.
+    # @param [Array] args The arguments for the system call.
     #
     # @overload call_executable(*args)
     #   @return [String] The output of STDOUT or STDERR, depending of the exit

data/lib/vnstat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vnstat
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/vnstat-ruby.gemspec

@@ -16,28 +16,21 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/tlux/vnstat-ruby'
   spec.license = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
-  # 'allowed_push_host' to allow pushing to a single host or delete this section
-  # to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'nokogiri', '~> 1.8.5'
+  spec.add_dependency 'systemcall', '~> 1.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.53'
-  spec.add_development_dependency 'yard', '~> 0.9.12'
+  spec.add_development_dependency 'rubocop', '~> 0.68.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.1.0'
+  spec.add_development_dependency 'yard', '~> 0.9.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vnstat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tobias Casper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.8.5
+- !ruby/object:Gem::Dependency
+  name: systemcall
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: 0.68.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: 0.68.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.9.19
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.9.19
 description: Utilizes the the vnstat CLI to track your network traffic.
 email:
 - tobias.casper@gmail.com
@@ -107,13 +135,13 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - lib/vnstat-ruby.rb
 - lib/vnstat.rb
 - lib/vnstat/configuration.rb
@@ -131,7 +159,6 @@ files:
 - lib/vnstat/result/minute.rb
 - lib/vnstat/result/month.rb
 - lib/vnstat/result/time_comparable.rb
-- lib/vnstat/system_call.rb
 - lib/vnstat/traffic.rb
 - lib/vnstat/traffic/base.rb
 - lib/vnstat/traffic/daily.rb
@@ -144,8 +171,7 @@ files:
 homepage: https://github.com/tlux/vnstat-ruby
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -154,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -162,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A library to track your network traffic using vnstat.

data/VERSION

@@ -1 +0,0 @@
-1.1.0

data/lib/vnstat/system_call.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-module Vnstat
-  ##
-  # A class responsible for communication with command line interfaces.
-  #
-  # @!attribute [r] args
-  #   @return [Array]
-  # @!attribute [r] success_result
-  #   @return [String, nil] The STDOUT output of the called command.
-  # @!attribute [r] error_result
-  #   @return [String, nil] The STDERR output of the called command.
-  # @!attribute [r] exit_status
-  #   @return [Process::Status, nil] The exit status of the called command.
-  class SystemCall
-    attr_reader :args, :success_result, :error_result, :exit_status
-
-    ##
-    # Initializes the {SystemCall}.
-    #
-    # @param [Array] args The command line arguments.
-    def initialize(*args)
-      @args = args.flatten
-    end
-
-    ##
-    # Initializes and calls the {SystemCall}.
-    #
-    # @param [Array] args The command line arguments.
-    # @return [SystemCall]
-    def self.call(*args)
-      new(*args).call
-    end
-
-    ##
-    # Calls the command.
-    #
-    # @return [SystemCall]
-    def call
-      Open3.popen3(*args) do |_, stdout, stderr, wait_thr|
-        @success_result = readlines(stdout)
-        @error_result = readlines(stderr)
-        @exit_status = wait_thr.value
-      end
-      self
-    end
-
-    ##
-    # Determines whether the command has been called.
-    #
-    # @return [true, false]
-    def called?
-      !exit_status.nil?
-    end
-
-    ##
-    # Returns the command result.
-    #
-    # @return [String] Returns result from {#success_result} when command exited
-    #   successfully. Otherwise returns result from {#error_result}.
-    # @raise [RuntimeError] Raises when the command has not yet been called.
-    def result
-      success? ? success_result : error_result
-    end
-
-    ##
-    # Indicates whether the command has been executed successfully.
-    #
-    # @raise [RuntimeError] Raises when the command has not yet been called.
-    # @return [true, false]
-    def success?
-      raise 'Command not invoked' unless called?
-      exit_status.success?
-    end
-
-    ##
-    # Indicates whether the command has not been executed successfully.
-    #
-    # @raise [RuntimeError] Raises when the command has not yet been called.
-    # @return [true, false]
-    def error?
-      !success?
-    end
-
-    private
-
-    def readlines(io)
-      io.readlines.join.chomp
-    end
-  end
-end