pass-station 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b9ea9f62eaff1a5166ac66df8b994d5928173eb1d23fb997f02ca3cbdc5f712
-  data.tar.gz: 1cb19d830a7b18b49e6317911c5a6ca8411e0641921d2471749bc2f81c64cb12
+  metadata.gz: 12c331db3e7fcee2924f24bb97d63319642414e8bd7b0c04005b48e8dc4f111c
+  data.tar.gz: b8b8f2a92526afc046b5ae6a011aa3967475d8d6a57cbdceee6670a9bf0c585f
 SHA512:
-  metadata.gz: 89a6526c063b14e47d3316b6bb544396a03fd95e98fe488d366061e4837bb0e3b3994e2d402381d11fb5a2831479d2efa3ce252f168b85a5bb200939ff1ddb98
-  data.tar.gz: bec11f0af9253d0d54c05192aa6544e335d502b0d8cf00296c6a3a7b4473bb3e9352ac942a102e5c6d2d3b4380132fb50fb6fe1340b2a9129df5d93cc7ee47f9
+  metadata.gz: e20f71eee6eccc0eab06c0485eba0d358ed1053926333aab03e1e240f35775c2e5cdef2b69b3335353be101a983f142d5964d5564fae0627ada21ed6d4a29ab7
+  data.tar.gz: 670188256f1790be404edad7b3214d53ef26afb0920d710e9cfd1f3afdb8f6810603853b3f314a1566a258dc485587d3f3b2fbb599d661a236bb426096b60280

data/bin/pass-station_console

@@ -4,4 +4,4 @@
 require 'pass_station'
 require 'irb'
 
-IRB.start(__FILE__)
+IRB.start(__FILE__)

data/lib/pass_station.rb

@@ -15,8 +15,6 @@ module PassStation
   class DB
     # Get / set storage location, where will be stored the password database.
     # @return [String] database storage location. Default to +data/+.
-    # @example
-    #   PassStation.storage_location = '/srv/downloads/'
     attr_accessor :storage_location
 
     # Get / set the password database name
@@ -24,8 +22,8 @@ module PassStation
     #   +DefaultCreds-Cheat-Sheet.csv+.
     attr_accessor :database_name
 
-    # Get the password database in +CSV::Table+ format
-    # @return [CSV::Table] pasword database
+    # Get the password database in +Array<CSV::Row>+ format
+    # @return [Array<CSV::Row>] pasword database
     attr_reader :data
 
     # A new instance of Pass Station

data/lib/pass_station/output.rb

@@ -13,7 +13,7 @@ module PassStation
   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 data [CSV::Table]
+    # @param data [Array<CSV::Row>]
     # @return [Array<String>] formatted output
     def output(formatter, data)
       # Convert string to class
@@ -68,8 +68,8 @@ module PassStation
     # Simple table formatter
     class Table
       class << self
-        # Format the +CSV::Table+ into a simple table with justified columns
-        # @param table [CSV::Table] a +CSV::Table+
+        # 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 = []
@@ -82,7 +82,7 @@ module PassStation
         end
 
         # Calculate column size (max item size)
-        # @param table [CSV::Table]
+        # @param table [Array<CSV::Row>]
         # @param column [Symbol] the symbol of the column
         # @return [Integer] the column size
         def colsize_count(table, column)
@@ -90,7 +90,7 @@ module PassStation
         end
 
         # Calculate the size of all columns (max item size)
-        # @param table [CSV::Table]
+        # @param table [Array<CSV::Row>]
         # @return [Hash] keys are columns name, values are columns size
         def colsizes_count(table)
           colsizes = table.first.to_h.keys.each_with_object({}) do |c, h|
@@ -147,8 +147,8 @@ module PassStation
     # Pretty table with ASCII borders formatter
     class PrettyTable < Table
       class << self
-        # Format the +CSV::Table+ into a simple table with justified columns
-        # @param table [CSV::Table] a +CSV::Table+
+        # 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 = []
@@ -200,5 +200,45 @@ module PassStation
         protected :dividers, :headers, :justify_row, :justify
       end
     end
+
+    # CSV formatter
+    class Csv
+      class << self
+        # 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")
+        end
+      end
+    end
+
+    # JSON formatter
+    class Json
+      class << self
+        # 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
+        #   {highlight_found} and homogeneity with other formatters)
+        def format(table)
+          [table.map(&:to_h).to_json]
+        end
+      end
+    end
+
+    # YAML formatter
+    class Yaml
+      class << self
+        # 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
+        #   {highlight_found} and homogeneity with other formatters)
+        def format(table)
+          [table.map(&:to_h).to_yaml]
+        end
+      end
+    end
   end
 end

data/lib/pass_station/parse.rb

@@ -23,10 +23,10 @@ module PassStation
 
     # Parse, sort and sanitize the password database
     # @param sort [Symbol] column name to sort by: +:productvendor+, +:username+, +:password+
-    # @return [CSV::Table] table of +CSV::Row+, each row contains three
+    # @return [Array<CSV::Row>] table of +CSV::Row+, each row contains three
     #   attributes: :productvendor, :username, :password
     def parse(sort = :productvendor)
-      @data = CSV.table(@database_path, @config).sort_by do |s|
+      @data = CSV.table(@database_path, **@config).sort_by do |s|
         s[sort].downcase
       end
     end

data/lib/pass_station/search.rb

@@ -8,7 +8,7 @@ module PassStation
     # @param term [String] the searched term
     # @param col [Symbol] the column to search in: :productvendor | :username | :password | :all (all columns)
     # @see build_regexp for +opts+ param description
-    # @return [CSV::Table] table of +CSV::Row+, each row contains three
+    # @return [Array<CSV::Row>] table of +CSV::Row+, each row contains three
     #   attributes: :productvendor, :username, :password
     def search(term, col, opts = {})
       r1 = prepare_search(term, opts)

data/lib/pass_station/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pass-station
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexandre ZANNI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -193,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
   - - "<"
     - !ruby/object:Gem::Version
       version: '3.0'