mysqlexport 0.1.0 → 0.2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4066422b1ed4c327bd6f6e145a533caee962e9af743e72f0fc646c6d60f348d2
-  data.tar.gz: 51a70e58bcbf27975018789571f3b2154966b84ed5058d21a8a383c1642d3612
+  metadata.gz: a608240d3dbd6a64d7cb6fb70ace1587da291af6097e6a49d3255b723e1e02fc
+  data.tar.gz: ce57658a089cc83c46a9f965b3de8c5d4c6d7877c094e8f5fecfdb89612328c1
 SHA512:
-  metadata.gz: 62032c894ba2052a2b369f6056a0b4ee0663b69896727e7bc08171f828bb230ce075fc4447a23fa1eb50e22c30b4119b59ab56cb67af68ef9015e751ee4f88e2
-  data.tar.gz: effd9497b52f606fe72963a32a29e02cdd713d179644e1f48c933ae242db370301e13f897ab7a78200c9ff8c66fd7728c4390c01f16460c39053626b3657c07a
+  metadata.gz: 23cbb97fedb5a0473f5796fe59471712b840bab6ebbdd015d794f9c556c6d1bedfd53af34ea17c3f1ec927d4984ddd5630ab5d2194d578c2ad254de6e33a4218
+  data.tar.gz: ea151bbc5c228f7d72eaf3af6e963de69af0f146f68409ed7a554d17e506a1ec04c025e7644788837d403d4040e1b0f847704a645c11cbc0154f077b5389cf3c

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: Rubocop
+
+on: [push,pull_request]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest    
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Rubocop 
+      run: |
+        bundle install
+        bundle exec rake rubocop

data/.github/workflows/unit-tests.yml

@@ -0,0 +1,45 @@
+name: Unit Tests
+
+on: [push,pull_request]
+
+jobs:
+  unit-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-20.04
+            mysql-version: 8.0
+          - os: ubuntu-18.04
+            mysql-version: 8.0
+          - os: ubuntu-18.04
+            mysql-version: 5.7
+          - os: ubuntu-16.04
+            mysql-version: 8.0
+          - os: ubuntu-16.04
+            mysql-version: 5.7
+          - os: macos-10.15
+            mysql-version: 8.0
+          - os: macos-10.15
+            mysql-version: 5.7
+          - os: macos-10.15
+            mysql-version: 5.6    
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Set up MySQL
+      uses: ankane/setup-mysql@v1
+      with:
+        mysql-version: ${{ matrix.mysql-version }}
+    - name: mysql config
+      run: |
+        mysqladmin -u root password root
+        bundle config --local build.mysql2 "--with-ldflags=-L/usr/local/opt/openssl/lib --with-cppflags=-I/usr/local/opt/openssl/include"
+    - name: Run Tests
+      run: |
+        bundle install
+        bundle exec rake unit_tests

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
 
 
@@ -24,4 +24,13 @@ Metrics/BlockLength:
   Enabled: false
 
 Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/LineLength:
   Enabled: false

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    mysqlexport (0.1.0)
-      activerecord (~> 6.1)
+    mysqlexport (0.2.0.1)
+      activerecord (>= 6.1.2.1)
       mixlib-cli (~> 2.1.8)
+      multi_json (~> 1.0)
       mysql2 (~> 0.5.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activerecord (6.1.1)
-      activemodel (= 6.1.1)
-      activesupport (= 6.1.1)
-    activesupport (6.1.1)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -22,20 +23,29 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     benchmark (0.1.1)
+    coderay (1.1.3)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    i18n (1.8.8)
+    fakefs (1.3.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.3)
+    method_source (0.9.2)
+    minitest (5.14.4)
     mixlib-cli (2.1.8)
+    multi_json (1.15.0)
     mysql2 (0.5.3)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -49,22 +59,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.9.1)
+    rubocop (1.14.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    yaml (0.1.0)
+    yaml (0.1.1)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -72,7 +82,9 @@ PLATFORMS
 
 DEPENDENCIES
   benchmark (~> 0.1)
+  fakefs (~> 1.3)
   mysqlexport!
+  pry-nav (~> 0.3)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)

data/LICENSE.txt

@@ -1,5 +1,7 @@
 The MIT License (MIT)
 
+Copyright (c) 2013 Seamus Abshere
+
 Copyright (c) 2021 Iqbal Singh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -1,9 +1,7 @@
 # Mysqlexport
-
-Gives you binary `mysqlexport` and ruby class `Mysqlexport::Csv` to export mysql tables into csv file.
+Gives you binary `mysqlexport` and ruby classes `Mysqlexport::Csv` and `Mysqlexport::Json` to export mysql tables into csv or json file respectively.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,48 +18,68 @@ Or install it yourself as:
 $ gem install mysqlexport
 ```
 
-
 ## Usage
-
 #### Binaries
 ```
-$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=csv
 ```
 
 #### options
 ```
-    $ mysqlexport --help
+$ mysqlexport --help
     
-    -c, --col-sep=,                  column separtor for csv, default is ","
-    -d, --database=DATABASE          Set MySQL database
-    -e, --execute=EXECUTE            The SQL statement to execute
-    -f, --force-quotes=true          force quotes to csv, default is false
-    -h, --host=HOST                  Set MySQL host
-    -o, --out=PATH                   output path, default is current directory
+    -u, --username=USERNAME          Set MySQL username
     -p, --password=PASSWORD          Set MySQL password
+    -h, --host=HOST                  Set MySQL host
     -P, --port=PORT                  Set MySQL port
-    -r, --row-sep=\n                 row separator for csv, default is "\n"
+    -d, --database=DATABASE          Set MySQL database
     -s, --socket=SOCKET              Set MySQL socket
+    -T, --to=CSV                     Export Mysql table to CSV/JSON
+    -e, --execute=EXECUTE            The SQL statement to execute
+    -o, --out=PATH                   output path, default is current directory
     -t, --table=TABLE                MySQL table you want to export
-    -u, --username=USERNAME          Set MySQL username
-        --help                       Show help
 
+CSV Options
+    -f, --force-quotes=false         force quotes to csv, default is false
+    -c, --col-sep=,                  column separtor for csv, default is ","
+    -r, --row-sep=\n                 row separator for csv, default is "\n"
+    -H, --csv-heading=true           show csv heading, default is true
+
+JSON Options
+    -y, --pretty=false               display json pretty, default is false
+    -j, --json-engine=oj             choose json engine
+```
+
+## Use in Ruby
+#### Ruby classes
+```ruby
+Mysqlexport::Csv.new(options) # create csv object
+Mysqlexport::Json.new(options) # create json object
 ```
-#### Ruby Class
+#### Methods Suported
 ```ruby
+to_stdout  # write it directly to $stdout
+to_path(String)  # write it to a file at this path
+to_file(File)  # write it to a file handle
+```
+#### Usage
+```ruby
+require 'mysqlexport'
 options = {
   username: "root",
   password: "root",
   database: "mysqlexport_test",
   execute: "select * from employees"
 }
-Mysqlexport::Csv.new(options).to_stdout  # write it directly to $stdout
-Mysqlexport::Csv.new(options).to_path('/tmp/table.csv')  # write it to a file at this path
-Mysqlexport::Csv.new(options).to_file(File.open('/tmp/table.csv', 'w'))  # write it to a file handle
+Mysqlexport::Csv.new(options).to_stdout
+Mysqlexport::Csv.new(options).to_path('/tmp/table.csv')
+Mysqlexport::Json.new(options).to_file(File.open('/tmp/table.json', 'w')) 
 ```
+
 #### All available options
-```ruby
-Mysqlexport::Csv.new(
+##### General options
+ 
+```py
   host: "127.0.0.1", # optional, default is 127.0.0.1
   port: "3306", # optional, default is 3306
   username: "root", # optional if using Active record
@@ -69,24 +87,121 @@ Mysqlexport::Csv.new(
   database: "mysqlexport_test", # optional if using Active record
   socket: "/path/to/mysql.sock", # optional
   execute: "select * from employees", # not required if table is given
-  table: "employees", # not required if execute query is given
+  table: "employees" # not required if execute query is given
+```
+
+##### csv options (only works with `Mysqlexport::Csv` class)
+```py
   force_quotes: true, # optional, default is false
-  col_sep: ",", # optional, default is ","
-  row_sep: "", # optional, default is "\n"
+  col_sep: ",", # optional, default is ','
+  row_sep: "", # optional, default is '\n'
   output_path: "/tmp/employees.csv" # optional, default is current directory
-)
 ```
 
+##### json options (only works with `Mysqlexport::Json` class)
+```py
+  pretty: false # display json pretty, default is false
+```
 
-If you're running it inside a Rails application, it will default to the ActiveRecord connection config.
+## More Uses
+#### ActiveRecord Support
+If you're running it inside a Rails application, it will default to the `ActiveRecord` connection configurations.
 
 ```ruby
-csv = Mysqlexport::Csv.new execute: "select * from employees" # no need to specify username, password
-csv.to_stdout  
+csv = Mysqlexport::Csv.new execute: "select * from employees" # no need to specify username, password or database
+csv.to_stdout
+
+json = Mysqlexport::Json.new table: "employees" # no need to specify username, password or database
+json.to_stdout 
 ```
 
+#### to_path method/out option 
+Supports both relative and absolute path
+##### ruby
+```ruby
+Mysqlexport::Csv.new(options).to_path('/tmp/table.csv') # this will create a file with name table.csv at given path
+Mysqlexport::Csv.new(options).to_path('table.csv') # this will create file with name table.csv at current directory
+```
+
+##### binary
+create a file with name table.csv at given path
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=csv --out=/tmp/table.csv
+```
+create file with name table.csv at current directory
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=csv --out=table.csv
+```
+When directory is given in path. It will create a file inside the directory.
+##### ruby
+```ruby
+Mysqlexport::Csv.new(options).to_path('/tmp/mydir') # this will create a file inside mydir
+Mysqlexport::Csv.new(options).to_path # this will create a file in the current directory
+```
+
+##### binary
+create a file inside a directory
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=csv --out=/tmp/mydir
+```
+create a file in current directory
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=csv
+```
+
+What would be the file name in above cases? It takes file name from table option. If table option is not provided it will generate a file with current timestamp.
+##### ruby
+```ruby
+Mysqlexport::Json.new({ table: "employees" }).to_path('/tmp/mydir') # this will create a file with name employees.json
+Mysqlexport::Json.new({ execute: "select * from employees" }).to_path('/tmp/mydir') # this will create a file with current timestamp.
+Mysqlexport::Json.new({
+    table: "employees",
+    execute: "select * from employees limit 2"
+}).to_path('/tmp/mydir') # this will create a file with name employees.json
+```
+##### binary
+Create a file with name employees.json
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=json --out=/tmp/mydir
+```
+This will create a file with current timestamp
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --execute="select * from employees" --to=json --out=/tmp/mydir
+```
+This will create a file with name employees.json
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=emplyees --execute="select * from employees" --to=json --out=/tmp/mydir
+```
+
+#### Json Engine
+It uses [multi_json][multi_json] to convert to json.
+
+#### Supported JSON Engines
+* [Oj][oj] Optimized JSON by Peter Ohler
+* [Yajl][yajl] Yet Another JSON Library by Brian Lopez
+* [JSON][json-gem] The default JSON gem with C-extensions (ships with Ruby 1.9+)
+* [JSON Pure][json-gem] A Ruby variant of the JSON gem
+* [NSJSONSerialization][nsjson] Wrapper for Apple's NSJSONSerialization in the Cocoa Framework (MacRuby only)
+* [gson.rb][gson] A Ruby wrapper for google-gson library (JRuby only)
+* [JrJackson][jrjackson] JRuby wrapper for Jackson (JRuby only)
+* [OkJson][okjson] A simple, vendorable JSON parser
+
+#### Usecase
+##### ruby
+In case of ruby classes to use a json engine, it should be already loaded.
+```ruby
+require 'mysqlexport'
+require 'oj'
+Mysqlexport::Json.new(options).to_stdout
+```
+##### binary
+In case of the binary, it will try to load the specified json engine in the option `json_engine`. Make sure you have the json engine already installed in order to use it. If it is unable to load json engine it will default to OkJson.
+```
+$ mysqlexport --user=root --password=root --database=mysqlexport_test --table=employees --to=json --json-engine=oj
+```
 
 ## Development
+#### Configurations
 Go to `spec/configuration.yml`, then set the mysql configurations and test database. see example configuration below.
 ```
 host: localhost
@@ -94,24 +209,26 @@ username: root
 password: 
 database: mysqlexport_test
 ```
-Use `bundle install` to install the necessary development & testing gems and `bundle exec rake` for running the tests.
+
+#### Unit Tests and Rubocop
+Use `bundle install` to install the necessary development & testing then `bundle exec rake`  for running both unit_tests and rubocop. Database named `mysqlexport_test` and table named `unit_tests` with some data will automatically be created.
 ```
 $ bundle install
 $ bundle exec rake
 ```
-Database named `mysqlexport_test` will automatically be created.
 
+##### Other rake tasks
+`bundle exec rake unit_tests` to run only unit tests
+`bundle exec rake rubocop` to run only rubocop
 
-## Benchmarks
-
-#### Running benchmarks
+#### Benchmarks
+##### Running benchmarks
 ```
-$ bundle exec rake benchmark:run
+$ bundle exec rake benchmark:all:run
 ```
-It will insert 1 million rows in mysql and run the tests on it.
-
+It will insert 1 million rows in mysql and runs the benchmark on it. Database named `mysqlexport_test` and table named `employees` will automatically be created.
 
-#### Latest Benchmark Results
+##### Latest Benchmark Results
 ```
                            user     system      total        real
 1000    rows:          0.043286   0.003848   0.047134 (  0.047876)
@@ -123,11 +240,25 @@ It will insert 1 million rows in mysql and run the tests on it.
 1000000 rows:         27.928350   0.183935  28.112285 ( 29.992699)
 ```
 
-If you want to skip loading data into mysql
-```
-$ bundle exec rake benchmark:skip_data_load
+##### All available rake tasks for benchmark
+```ruby
+benchmark:all:run # load data into mysql, run benchmarks for csv and json
+benchmark:all:skip_data_load # do not load data into mysql, run benchmarks for csv and json
+benchmark:csv:run # load data into mysql, run benchmarks for csv
+benchmark:csv:skip_data_load # do not load data into mysql, run benchmarks for csv
+benchmark:json:run # load data into mysql, run benchmarks for only json
+benchmark:json:skip_data_load # do not load data into mysql, run benchmarks for only json
 ```
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[gson]: https://github.com/avsej/gson.rb
+[jrjackson]: https://github.com/guyboertje/jrjackson
+[json-gem]: https://github.com/flori/json
+[json-pure]: https://github.com/flori/json
+[oj]: https://github.com/ohler55/oj
+[okjson]: https://github.com/kr/okjson
+[yajl]: https://github.com/brianmario/yajl-ruby
+[multi_json]: https://github.com/intridea/multi_json
+[nsjson]: https://developer.apple.com/documentation/foundation/jsonserialization

data/Rakefile

@@ -15,12 +15,30 @@ task :unit_tests do
 end
 
 namespace :benchmark do
-  task run: ["benchmark:load_data", "benchmark:skip_data_load"]
   task :load_data do
     Benchmark::RunBenchmark.new.load_data
   end
-  task :skip_data_load do
-    Benchmark::RunBenchmark.new.run
+
+  namespace :all do
+    task run: ["benchmark:load_data", "benchmark:all:skip_data_load"]
+    task :skip_data_load do
+      Benchmark::RunBenchmark.new.run_csv
+      Benchmark::RunBenchmark.new.run_json
+    end
+  end
+
+  namespace :csv do
+    task run: ["benchmark:load_data", "benchmark:csv:skip_data_load"]
+    task :skip_data_load do
+      Benchmark::RunBenchmark.new.run_csv
+    end
+  end
+
+  namespace :json do
+    task run: ["benchmark:load_data", "benchmark:json:skip_data_load"]
+    task :skip_data_load do
+      Benchmark::RunBenchmark.new.run_json
+    end
   end
 end
 

data/exe/mysqlexport

@@ -1,11 +1,30 @@
 #!/usr/bin/env ruby
 
 require "mysqlexport"
-require "mysqlexport/cli"
+require "mysqlexport/cli/cli"
+require "mysqlexport/cli/help_parser"
 
 cli = Mysqlexport::Cli.new
-cli.parse_options
 
+cli.parse_options
 options = cli.config
 
-Mysqlexport::Csv.new(options).to_path
+Mysqlexport::HelpParser.new.parse(cli.options) if options[:help] == true
+Mysqlexport::HelpParser.new.info if options == {}
+
+to = options[:to] || "csv"
+to = to.to_s.downcase
+case to
+when "csv"
+  Mysqlexport::Csv.new(options).to_path
+when "json"
+  begin
+    json_engine = options[:json_engine] || ""
+    require json_engine
+  rescue LoadError
+    puts "[WARNING]: Invalid or no json engine provided using default json engine"
+  end
+  Mysqlexport::Json.new(options).to_path
+else
+  raise Mysqlexport::Error, "invalid option [--to] only csv/json is allowed"
+end

data/lib/mysqlexport.rb

@@ -8,8 +8,14 @@ require "mysql2"
 
 require "mysqlexport/version"
 require "mysqlexport/config"
-require "mysqlexport/csv"
+require "mysqlexport/writer"
+require "mysqlexport/writer/csv"
+require "mysqlexport/writer/json"
 
 module Mysqlexport
-  class Error < StandardError; end
+  class Error < StandardError
+    def initialize(msg = "Mysqlexport::Error")
+      super(msg)
+    end
+  end
 end

data/lib/mysqlexport/{cli.rb → cli/cli.rb}

@@ -8,17 +8,23 @@ module Mysqlexport
                                   long: "--#{o.downcase}=#{o.upcase}",
                                   description: "Set MySQL #{o.downcase}" }
     end
+    option :to, {  short: "-T TO",
+                   long: "--to=CSV",
+                   description: "Export Mysql table to CSV/JSON" }
     option :execute, {  short: "-e EXECUTE",
                         long: "--execute=EXECUTE",
                         description: "The SQL statement to execute" }
     option :force_quotes, { short: "-f false",
-                            long: "--force-quotes=true",
+                            long: "--force-quotes=false",
+                            type: "csv",
                             description: "force quotes to csv, default is false" }
     option :col_sep, {  short: "-c ,",
                         long: "--col-sep=,",
+                        type: "csv",
                         description: "column separtor for csv, default is \",\"" }
     option :row_sep, {  short: "-r \\n",
                         long: "--row-sep=\\n",
+                        type: "csv",
                         description: "row separator for csv, default is \"\\n\"" }
     option :output_path, {  short: "-o n",
                             long: "--out=PATH",
@@ -26,11 +32,21 @@ module Mysqlexport
     option :table, {  short: "-t TABLE",
                       long: "--table=TABLE",
                       description: "MySQL table you want to export" }
+    option :pretty, { short: "-y false",
+                      long: "--pretty=false",
+                      type: "json",
+                      description: "display json pretty, default is false" }
+    option :json_engine, { short: "-j oj",
+                           long: "--json-engine=oj",
+                           type: "json",
+                           description: "choose json engine" }
+    option :csv_heading, { short: "-H true",
+                           long: "--csv-heading=true",
+                           type: "csv",
+                           description: "show csv heading, default is true" }
     option :help, { long: "--help",
                     description: "Show help",
                     on: :tail,
-                    boolean: true,
-                    show_options: true,
-                    exit: 0 }
+                    boolean: true }
   end
 end

data/lib/mysqlexport/cli/help_parser.rb

@@ -0,0 +1,41 @@
+require "optparse"
+module Mysqlexport
+  class HelpParser
+    def parse(hsh)
+      # this only works if ARGV contains "--help"
+      OptionParser.new do |opts|
+        opts.banner = "Usage: mysqlexport [options]"
+        hsh.tap { |h| h.delete(:help) }
+        all = []
+        all.append([[], nil])
+        all.append([[], "\nCSV Options"])
+        all.append([[], "\nJSON Options"])
+        hsh.each do |o|
+          case o[1][:type]
+          when "csv"
+            all[1][0].append(o[1])
+          when "json"
+            all[2][0].append(o[1])
+          else
+            all[0][0].append(o[1])
+          end
+        end
+        all.map do |category|
+          opts.on category[1] unless category[1].nil?
+          category[0].each do |o|
+            short = o[:short].slice(0, 2)
+            long = o[:long]
+            desc = o[:description]
+            opts.on(short, long, desc)
+          end
+        end
+      end.parse!
+    end
+
+    def info
+      puts "[Mysqlexport v#{Mysqlexport::VERSION}]"
+      puts "run mysqlexport --help for options"
+      exit 0
+    end
+  end
+end

data/lib/mysqlexport/config.rb

@@ -6,6 +6,7 @@ module Mysqlexport
       @user_specified_options = user_specified_options.symbolize_keys
     end
 
+    # database options
     def host
       user_specified_options[:host] || active_record_config.try(:[], :host)
     end
@@ -38,6 +39,11 @@ module Mysqlexport
       user_specified_options[:table]
     end
 
+    def output_path
+      user_specified_options[:output_path]
+    end
+
+    # csv options
     def force_quotes
       user_specified_options[:force_quotes].to_s.downcase == "true" || nil
     end
@@ -50,10 +56,16 @@ module Mysqlexport
       user_specified_options[:row_sep]
     end
 
-    def output_path
-      user_specified_options[:output_path]
+    def csv_heading
+      user_specified_options[:csv_heading].to_s.downcase != "false"
+    end
+
+    # json options
+    def pretty
+      user_specified_options[:pretty].to_s.downcase == "true" || nil
     end
 
+    # client options
     def client
       return @client if @client.is_a? ::Mysql2::Client
 

data/lib/mysqlexport/version.rb

@@ -1,3 +1,3 @@
 module Mysqlexport
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0.1".freeze
 end

data/lib/mysqlexport/writer.rb

@@ -1,21 +1,53 @@
-module Writer
-  def to_stdout
-    to_file $stdout
-    nil
-  end
+module Mysqlexport
+  class Writer
+    attr_reader :client, :sql, :config
 
-  def filter_path(path)
-    path = ::Dir.pwd.to_s unless path.instance_of? ::String
-    file_name = "/#{::Time.now.to_i}_mysqlexport.csv" if ::File.directory?(path)
-    file_name = "/#{config.table}.csv" if ::File.directory?(path) && !config.table.nil?
-    path += file_name.to_s
-    path
-  end
+    def initialize(options = {})
+      validate!(options)
+      @config = Mysqlexport::Config.new options
+      @client = @config.client
+    end
+
+    def to_stdout
+      to_file $stdout
+      nil
+    end
+
+    def filter_path(path)
+      path = ::Dir.pwd.to_s unless path.instance_of? ::String
+      file_name = "/#{::Time.now.to_i}_mysqlexport.#{extension}" if ::File.directory?(path)
+      file_name = "/#{config.table}.#{extension}" if ::File.directory?(path) && !config.table.nil?
+      path += file_name.to_s
+      path
+    end
+
+    def to_path(path = config.output_path)
+      f = ::File.open(filter_path(path), "w")
+      to_file f
+      f.close
+      nil
+    end
+
+    def to_s
+      s = ::StringIO.new
+      to_file s
+      s.rewind
+      s.read
+    end
+
+    private
+
+    def validate!(options)
+      raise Error, "[required option missing] execute or table required in options" if options[:table].nil? && options[:execute].nil?
+
+      true
+    end
+
+    def extension
+      # default extension is csv
+      return "json" if instance_of? Mysqlexport::Json
 
-  def to_path(path = config.output_path)
-    f = ::File.open(filter_path(path), "w")
-    to_file f
-    f.close
-    nil
+      "csv"
+    end
   end
 end

data/lib/mysqlexport/{csv.rb → writer/csv.rb}

@@ -3,22 +3,18 @@ if RUBY_VERSION >= "1.9"
 else
   require "fastercsv"
 end
-require "mysqlexport/writer"
 module Mysqlexport
-  class Csv
-    include Writer
-    attr_reader :client, :sql, :config
-
+  class Csv < Writer
     def initialize(options = {})
-      @config = Mysqlexport::Config.new options
-      @client = @config.client
+      super(**options)
     end
 
     def to_file(file)
       result = client.query(config.execute, stream: true, cache_rows: false, as: :array)
-      file.write result.fields.to_csv(**csv_options)
+      csv_o = csv_options
+      file.write result.fields.to_csv(**csv_o) if config.csv_heading
       result.each do |row|
-        file.write row.to_csv(**csv_options)
+        file.write row.to_csv(**csv_o)
       end
     end
 

data/lib/mysqlexport/writer/json.rb

@@ -0,0 +1,35 @@
+require "multi_json"
+
+module Mysqlexport
+  class Json < Writer
+    def initialize(options = {})
+      super(**options)
+    end
+
+    def to_file(file)
+      first = true
+      json_o = json_options
+      file.write "["
+      client.query(config.execute, stream: true, cache_rows: false).each do |h|
+        next if h.nil?
+
+        if first
+          first = false
+        else
+          file.write ","
+        end
+        file.write ::MultiJson.dump(h, **json_o)
+      end
+      file.write "]"
+      nil
+    end
+
+    private
+
+    def json_options
+      options = {}
+      options[:pretty] = config.pretty unless config.pretty.nil?
+      options
+    end
+  end
+end

data/mysqlexport.gemspec

@@ -5,11 +5,11 @@ Gem::Specification.new do |spec|
   spec.version       = Mysqlexport::VERSION
   spec.authors       = ["Iqbal Singh"]
   spec.email         = ["singhiqbal1007@gmail.com"]
-  spec.summary       = "Export mysql table to csv files"
-  spec.description   = "Gives you binary mysqlexport and Ruby classes to export mysql tables into csv files"
+  spec.summary       = "Export mysql table to csv and json files"
+  spec.description   = "Gives you binary mysqlexport and Ruby classes to export mysql tables into csv and json files"
   spec.homepage      = "https://github.com/singhiqbal1007/mysqlexport"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
@@ -21,12 +21,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "benchmark", "~> 0.1"
+  spec.add_development_dependency "fakefs", "~> 1.3"
+  spec.add_development_dependency "pry-nav", "~> 0.3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 1.7"
   spec.add_development_dependency "yaml", "~> 0.1"
 
-  spec.add_dependency "activerecord", "~> 6.1"
+  spec.add_dependency "activerecord", ">= 6.1.2.1"
   spec.add_dependency "mixlib-cli", "~> 2.1.8"
+  spec.add_dependency "multi_json", "~> 1.0"
   spec.add_dependency "mysql2", "~> 0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysqlexport
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.1
 platform: ruby
 authors:
 - Iqbal Singh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +112,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 6.1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 6.1.2.1
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.8
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.3
 description: Gives you binary mysqlexport and Ruby classes to export mysql tables
-  into csv files
+  into csv and json files
 email:
 - singhiqbal1007@gmail.com
 executables:
@@ -131,7 +173,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/unit-tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -145,11 +188,13 @@ files:
 - bin/setup
 - exe/mysqlexport
 - lib/mysqlexport.rb
-- lib/mysqlexport/cli.rb
+- lib/mysqlexport/cli/cli.rb
+- lib/mysqlexport/cli/help_parser.rb
 - lib/mysqlexport/config.rb
-- lib/mysqlexport/csv.rb
 - lib/mysqlexport/version.rb
 - lib/mysqlexport/writer.rb
+- lib/mysqlexport/writer/csv.rb
+- lib/mysqlexport/writer/json.rb
 - mysqlexport.gemspec
 homepage: https://github.com/singhiqbal1007/mysqlexport
 licenses:
@@ -165,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -175,5 +220,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Export mysql table to csv files
+summary: Export mysql table to csv and json files
 test_files: []

data/.github/workflows/main.yml

@@ -1,32 +0,0 @@
-name: Unit Tests
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    services:
-      mysql:
-        image: mysql:8.0
-        env:
-          MYSQL_ROOT_PASSWORD: root
-        ports:
-        - 3306
-        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3    
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7.1
-    - name: Set up MySQL
-      run: |
-        sudo apt-get install -y mysql-server mysql-client libmysqlclient-dev
-        mysql --host 127.0.0.1 --port ${{ job.services.mysql.ports[3306] }} -uroot -proot -e "SHOW GRANTS FOR 'root'@'localhost'"
-        mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql --host 127.0.0.1 --port ${{ job.services.mysql.ports[3306] }} -uroot -proot mysql
-        sudo service mysql start
-    - name: Run tests
-      run: |
-        bundle install
-        bundle exec rake
-