pass-station 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae09b43b764e460c230fd29723ef4293c7624808a7d4cd7511789b3a0a087a0c
-  data.tar.gz: 02b004b539741d6d678579b480cfedf314c7ede04886bf956c111ba1ab69a21c
+  metadata.gz: e5b31b81d976f3ffc9c63384b5bdcf829af5fca16bf28a955f5610c9b827125b
+  data.tar.gz: a498b1e9f6708cc4525135edadca428b5021c0832b38e6f8ae66ca873efb3157
 SHA512:
-  metadata.gz: ef336e447a6dbf9267f1aa3f249e6928b533b414833f925ca834fee7407369284e9ef94ad6c32347241af0e6dac31cae6ed6724a4dcdb3b83577574f99266a9b
-  data.tar.gz: a4d82db3a4db21bdbb29661a1ae4bbf44ad9586dd744548875d17ad528ff3ba4d4e7eb38cf1c9f294ae05af27ef1252c84f34d76d59c503619490642a35db704
+  metadata.gz: 46e3622f6afecdcf0125438a13ef399a11847aa08a3b45e1b4f1d98353926336b0bac82f5b76cd67a3f79265de927a569808f903e8ed68d19c4c9f202ab68d86
+  data.tar.gz: 6551999d9d796f61c9941fe8a120d53b0fcf4e6a59e5bb838c205f1fdc703871bcfaf53ccd9854072c408a7158322a2fed67fb8886d61d82d87d8028c9b970c8

data/lib/pass_station/output.rb

@@ -12,7 +12,7 @@ module PassStation
   # Password database handling
   class DB
     # Output the data in the chosen format
-    # @param formatter [String] Engine to use to format the data: +table+, +'pretty-table'+, +JSON+, +CSV+, +YAML+
+    # @param formatter [String] Engine to use to format the data: `table`, `'pretty-table'`, `JSON`, `CSV`, `YAML`
     # @param data [Array<CSV::Row>]
     # @return [Array<String>] formatted output
     def output(formatter, data)
@@ -21,7 +21,7 @@ module PassStation
     end
 
     # Output the data in the chosen format (list command)
-    # @param formatter [String] Engine to use to format the data: +table+, +'pretty-table'+, +JSON+, +CSV+, +YAML+
+    # @param formatter [String] Engine to use to format the data: `table`, `'pretty-table'`, `JSON`, `CSV`, `YAML`
     # @return [Array<String>] formatted output
     def output_list(formatter)
       data_nil?
@@ -29,7 +29,7 @@ module PassStation
     end
 
     # Output the data in the chosen format (search command)
-    # @param formatter [String] Engine to use to format the data: +table+, +'pretty-table'+, +JSON+, +CSV+, +YAML+
+    # @param formatter [String] Engine to use to format the data: `table`, `'pretty-table'`, `JSON`, `CSV`, `YAML`
     # @return [Array<String>] formatted output
     def output_search(formatter)
       return [] if @search_result.empty?
@@ -68,8 +68,8 @@ module PassStation
     # Simple table formatter
     class Table
       class << self
-        # Format the +Array<CSV::Row>+ into a simple table with justified columns
-        # @param table [Array<CSV::Row>] an +Array<CSV::Row>+
+        # Format the `Array<CSV::Row>` into a simple table with justified columns
+        # @param table [Array<CSV::Row>] an `Array<CSV::Row>`
         # @return [Array<String>] the formatted table ready to be printed
         def format(table)
           out = []
@@ -112,7 +112,7 @@ module PassStation
         end
 
         # Left justify an element of the column
-        # @param row [CSV::Row] +CSV::Row+
+        # @param row [CSV::Row] `CSV::Row`
         # @param column [Symbol] the symbol of the column
         # @param colsizes [Hash] hash containing the column size for each column as returned by {colsizes_count}
         # @return [String] the justified element
@@ -121,7 +121,7 @@ module PassStation
         end
 
         # Left justify all elements of the column
-        # @param row [CSV::Row] +CSV::Row+
+        # @param row [CSV::Row] `CSV::Row`
         # @param colsizes [Hash] hash containing the column size for each column as returned by {colsizes_count}
         # @return [String] the justified row
         def justify_row(row, colsizes)
@@ -146,8 +146,8 @@ module PassStation
     # Pretty table with ASCII borders formatter
     class PrettyTable < Table
       class << self
-        # Format the +Array<CSV::Row>+ into a simple table with justified columns
-        # @param table [Array<CSV::Row>] an +Array<CSV::Row>+
+        # Format the `Array<CSV::Row>` into a simple table with justified columns
+        # @param table [Array<CSV::Row>] an `Array<CSV::Row>`
         # @return [Array<String>] the formatted table ready to be printed
         def format(table)
           out = []
@@ -162,7 +162,7 @@ module PassStation
         end
 
         # Left justify an element of the column
-        # @param row [CSV::Row] +CSV::Row+
+        # @param row [CSV::Row] `CSV::Row`
         # @param column [Symbol] the symbol of the column
         # @param colsizes [Hash] hash containing the column size for each column as returned by {colsizes_count}
         # @return [String] the justified element
@@ -171,7 +171,7 @@ module PassStation
         end
 
         # Left justify all elements of the column
-        # @param row [CSV::Row] +CSV::Row+
+        # @param row [CSV::Row] `CSV::Row`
         # @param colsizes [Hash] hash containing the column size for each column as returned by {colsizes_count}
         # @return [String] the justified row
         def justify_row(row, colsizes)
@@ -203,8 +203,8 @@ module PassStation
     # CSV formatter
     class Csv
       class << self
-        # Format the +Array<CSV::Row>+ into a CSV
-        # @param table [Array<CSV::Row>] an +Array<CSV::Row>+
+        # Format the `Array<CSV::Row>` into a CSV
+        # @param table [Array<CSV::Row>] an `Array<CSV::Row>`
         # @return [Array<String>] the formatted CSV ready to be printed
         def format(table)
           CSV::Table.new(table).to_csv.split("\n")
@@ -215,8 +215,8 @@ module PassStation
     # JSON formatter
     class Json
       class << self
-        # Format the +Array<CSV::Row>+ into JSON
-        # @param table [Array<CSV::Row>] an +Array<CSV::Row>+
+        # Format the `Array<CSV::Row>` into JSON
+        # @param table [Array<CSV::Row>] an `Array<CSV::Row>`
         # @return [Array<String>] the formatted JSON ready to be printed (only
         #   one element on the array, keep an array for compatibility with
         #   {DB.highlight_found} and homogeneity with other formatters)
@@ -229,8 +229,8 @@ module PassStation
     # YAML formatter
     class Yaml
       class << self
-        # Format the +Array<CSV::Row>+ into YAML
-        # @param table [Array<CSV::Row>] an +Array<CSV::Row>+
+        # Format the `Array<CSV::Row>` into YAML
+        # @param table [Array<CSV::Row>] an `Array<CSV::Row>`
         # @return [Array<String>] the formatted YAML ready to be printed (only
         #   one element on the array, keep an array for compatibility with
         #   {DB.highlight_found} and homogeneity with other formatters)

data/lib/pass_station/parse.rb

@@ -23,7 +23,7 @@ module PassStation
 
     # Parse, sort and sanitize the password database
     # @param sort [Symbol] column name to sort by (columns depends on the database source, see {UPSTREAM_DATABASE})
-    # @return [Array<CSV::Row>] table of +CSV::Row+, each row contains multiple
+    # @return [Array<CSV::Row>] table of `CSV::Row`, each row contains multiple
     #   attributes (columns depends on the database source, see {UPSTREAM_DATABASE})
     def parse(sort = nil)
       sort ||= UPSTREAM_DATABASE[@database_type][:COLUMNS].first[0]

data/lib/pass_station/search.rb

@@ -8,8 +8,8 @@ module PassStation
     # @param term [String] the searched term
     # @param col [Symbol] the column to search in: column name (columns depends on the database source, see
     #   {UPSTREAM_DATABASE}) or :all (all columns)
-    # @see build_regexp for +opts+ param description
-    # @return [Array<CSV::Row>] table of +CSV::Row+, each row contains multiple
+    # @see build_regexp for `opts` param description
+    # @return [Array<CSV::Row>] table of `CSV::Row`, each row contains multiple
     #   attributes (columns depends on the database source, see {UPSTREAM_DATABASE})
     def search(term, col, opts = {})
       col ||= UPSTREAM_DATABASE[@database_type][:COLUMNS].first[0]

data/lib/pass_station/source.rb

@@ -58,7 +58,7 @@ module PassStation
       end
 
       # Check if an update is available
-      # @return [Boolean] +true+ if there is, +false+ else.
+      # @return [Boolean] `true` if there is, `false` else.
       def check_for_update
         ret_vals = []
         UPSTREAM_DATABASE[:MAPPING].each do |_k, v|
@@ -93,8 +93,8 @@ module PassStation
       # Check if a file match a SHA256 hash
       # @param file [String] the path of the file.
       # @param hash [String] tha SHA256 hash to check against.
-      # @return [Boolean] if the hash of the file matched the one provided (+true+)
-      #   or not (+false+).
+      # @return [Boolean] if the hash of the file matched the one provided (`true`)
+      #   or not (`false`).
       def check_hash(file, hash)
         if !hash.nil? && File.file?(file)
           computed_h = Digest::SHA256.file(file)
@@ -120,9 +120,7 @@ module PassStation
       # @param file_content [String] the content to write in the file
       # @return [String] destination file path
       def write_file(destination_file, file_content)
-        File.open(destination_file, 'wb') do |file|
-          file.write(file_content)
-        end
+        File.binwrite(destination_file, file_content)
         destination_file
       end
 

data/lib/pass_station/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Version
-  VERSION = '1.2.3'
+  VERSION = '1.3.0'
 end

data/lib/pass_station.rb

@@ -16,15 +16,15 @@ module PassStation
   # Password database handling
   class DB
     # Get / set storage location, where will be stored the password database.
-    # @return [String] database storage location. Default to +data/+.
+    # @return [String] database storage location. Default to `data/`.
     attr_accessor :storage_location
 
     # Get / set the password database name
     # @return [String] password database filename. Default to
-    #   +DefaultCreds-Cheat-Sheet.csv+.
+    #   `DefaultCreds-Cheat-Sheet.csv`.
     attr_accessor :database_name
 
-    # Get the password database in +Array<CSV::Row>+ format
+    # Get the password database in `Array<CSV::Row>` format
     # @return [Array<CSV::Row>] password database
     attr_reader :data
 
@@ -52,7 +52,7 @@ module PassStation
     end
 
     # Check if the password database exists
-    # @return [Boolean] +true+ if the file exists
+    # @return [Boolean] `true` if the file exists
     def database_exists?
       exists = File.file?(@database_path)
       raise "Database does not exist: #{@database_path}" unless exists

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pass-station
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Alexandre ZANNI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -38,138 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: commonmarker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: github-markup
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: CLI & library to search for default credentials among thousands of Products
   / Vendors
 email: alexandre.zanni@engineer.com
@@ -200,6 +68,7 @@ metadata:
   documentation_uri: https://noraj.github.io/pass-station/yard/
   homepage_uri: https://noraj.github.io/pass-station/
   source_code_uri: https://github.com/noraj/pass-station/
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -211,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: CLI & library to search for default credentials among thousands of Products