erdb 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0307e8ec28a91d13810f3c57b8a2d018fdc9a150288cc52873bd6e0aa0c2bb30
-  data.tar.gz: 4b4334a4317eb3fe8ccfd7342ebbccd958bd4232e3182797ffe68ea46f0d4d34
+  metadata.gz: fb43b27d324884db21ead2653426adbeba09a183733ee33bb4675b601d49d40c
+  data.tar.gz: 32e01870dabcc268910d912afa9d4b5341afd5a3f3b7afed38fc1aea3c1b6bb9
 SHA512:
-  metadata.gz: f7eeb962417fab2407479ec254feaea25945f01f07eb20ae5bd5293d2a952ec73b676646b3721879808f65a7a4c8c4765438f85dbb8ed0777e413cb67252fe24
-  data.tar.gz: 81b3d88b749591513dcae160d0e62bf9eeb4d7e8d1cc4eccbf674a298b242f4b92b19b4797cc7ee80cae364c3bd9256a20029440d28b543b197f81338e9cd468
+  metadata.gz: a220a81b743ff5c8ccc3bdec373d788ef6ef64fac8f8db2eebfb0ab95b96d13be351e74340f91534165e9a1d1fa3a8f9b5d5730f34073e8353ec929fb7ab13cb
+  data.tar.gz: a445779b1ac54a74c5acc673f5bf3905868a880200843e413df643091da05ac8eb407ae2faaef421b131dce349eaeb5c5e969cb11e1aedd68ca79932c60de114

data/CHANGES.md

@@ -1,3 +1,26 @@
+### 1.1.0
+
+- Use `Thor` to make cli.
+- Support `firefox` for automation.
+- Fix incorrect syntax for many-to-many relation in Azimutt.
+- Add path completion in cli.
+- Rename `join_table` to `junction_table`.
+- Add new commands in cli.
+  - `erdb help` to show help.
+  - `erdb version` to show version.
+- Add new options in cli.
+  - `--browser=BROWSER` to specify browser.
+  - `--junction-table` to show junction table.
+  - `--no-junction-table` to hide junction table.
+
+### 1.0.1
+
+- Prioritize Interruption over Error cuz ActiveRecord is lazy load.
+
+### 1.0.1
+
+- Catch database error at runtime
+
 ### 1.0.0
 
 - Initial release

data/lib/erdb/adapters/db.rb

@@ -33,7 +33,7 @@ module ERDB
     # [
     #   {
     #     name: "table_name",
-    #     is_join_table: false,
+    #     is_junction_table: false,
     #     columns: [{ name: "column_name", type: "column_type" }, ...],
     #     relations: [
     #       {

data/lib/erdb/adapters/sql.rb

@@ -53,7 +53,7 @@ module ERDB
         end
 
         hash = { name: table, columns: columns, relations: relations }
-        hash[:is_join_table] = join_table?(hash)
+        hash[:is_junction_table] = junction_table?(hash)
         hash
       end
     end
@@ -69,12 +69,12 @@ module ERDB
     private
 
     #
-    # Check current table is a join table or not.
+    # Check current table is a junction table or not.
     #
     # @param table [Hash] The table to check.
-    # @return [Boolean] True if the table is a join table, false otherwise.
+    # @return [Boolean] True if the table is a junction table, false otherwise.
     #
-    def join_table?(table)
+    def junction_table?(table)
       relations = table[:relations]
 
       # remove data like id, created_at, updated_at

data/lib/erdb/cli.rb

@@ -1,186 +1,218 @@
+require "thor"
 require "json"
 
 module ERDB
-  class Cli
-    class << self
-      #
-      # Start the CLI.
-      # @param [Array] args
-      # @return [void]
-      #
-      def start(_args)
-        ARGV.clear
+  class Cli < Thor
+    class_option :browser, type: :string, default: :chrome, enum: %w[chrome firefox], desc: "Browser to generate ERD"
+    class_option :junction_table, type: :boolean, default: true, desc: "Display junction table in the diagram"
 
-        welcome
+    desc "create", "Create ERD from database", hide: true
+    def create
+      ERDB.default_browser = options[:browser].to_sym
+      ERDB.show_junction_table = options[:junction_table]
 
-        db = select_database
+      ARGV.clear
 
-        erd_builder = select_diagram_builder
+      say Messages.welcome
 
-        ERDB.show_join_table = ask_yes_no("\nDo you want to display join tables? (Y/n)", true)
+      db = select_database
 
-        db.connect
+      erd_builder = select_diagram_builder
 
-        erd_builder.create(db.to_erdb)
-      rescue ActiveRecord::NoDatabaseError
-        puts "\nError: Database not found."
-        puts "Please make sure the database exists."
-        exit 1
-      rescue RuntimeError => e
-        puts "Error: #{e.message}"
-        exit 1
-      rescue StandardError => e
-        puts "Error: #{e.message}"
-        exit 1
-      rescue Interrupt
-        puts "\n\nThank you for using ERDB!"
-        exit 0
-      end
+      db.connect
 
-      private
+      erd_builder.create(db.to_erdb)
+    rescue Interrupt
+      say "\n\nThank you for using ERDB!", :blue
+      exit 0
+    rescue ActiveRecord::NoDatabaseError
+      say "\nError: Database not found.", :red
+      say "Please make sure the database exists."
+      exit 1
+    rescue StandardError => e
+      say "Error: #{e.message}", :red
+      exit 1
+    end
 
-      #
-      # Ask user which database to use.
-      # @return [Db]
-      #
-      def select_database
-        data = {
-          sqlite3: { name: "SQLite", gem: "sqlite3" },
-          postgresql: { name: "PostgreSQL(Gem 'pg' must be installed)", gem: "pg" },
-          mysql2: { name: "MySQL(Gem 'mysql2' must be installed)", gem: "mysql2" }
-        }
+    default_task :create
 
-        puts "Select a database adapter:"
+    desc "-v --version", "Show version"
+    map %w[-v --version] => :version
+    def version
+      say "ERDB #{ERDB::VERSION}"
+    end
 
-        data.each_with_index do |v, i|
-          puts "#{i + 1}. #{v[1][:name]}"
-        end
+    desc "-h --help", "Show help"
+    map %w[-h --help] => :help
+    def help
+      say Messages.help
+      super
+    end
+
+    def self.exit_on_failure?
+      true
+    end
 
-        response = ask_number(1, data.size)
+    private
 
-        adapter = data.keys[response.to_i - 1].to_sym
+    #
+    # Ask user which database to use.
+    # @return [Db]
+    #
+    def select_database
+      data = {
+        sqlite3: { name: "SQLite", gem: "sqlite3" },
+        postgresql: { name: "PostgreSQL(Gem 'pg' must be installed)", gem: "pg" },
+        mysql2: { name: "MySQL(Gem 'mysql2' must be installed)", gem: "mysql2" }
+      }
 
-        # check if the gem is installed
-        # I don't want to include the gem in the gemspec file
-        # cuz it's dependencies are too big and depend on the native library
-        # I only include sqlite3 gem cuz it's small and doesn't have any dependencies
-        gem = data[adapter][:gem]
+      say "Select a database adapter:"
 
-        begin
-          require gem
-        rescue LoadError
-          puts "\nError: '#{gem}' gem is not installed."
-          puts "Please install the gem '#{gem}' first."
-          puts "Run 'gem install #{gem}' to install the gem."
-          exit 1
-        end
+      data.each_with_index do |v, i|
+        say "#{i + 1}. #{v[1][:name]}"
+      end
 
-        database = if adapter == :sqlite3
-                     ask_file "\nEnter the path to the database file:"
-                   else
-                     ask "\nEnter the database connection string:"
-                   end
+      response = ask_number(1, data.size, ">")
 
-        return SQL.new(adapter, database) if %i[sqlite3 mysql2 postgresql].include?(adapter)
+      adapter = data.keys[response.to_i - 1].to_sym
 
-        raise "Invalid database adapter"
+      # check if the gem is installed
+      # I don't want to include the gem in the gemspec file
+      # cuz it's dependencies are too big and depend on the native library
+      # I only include sqlite3 gem cuz it's small and doesn't have any dependencies
+      gem = data[adapter][:gem]
+
+      begin
+        require gem
+      rescue LoadError
+        say "\nError: '#{gem}' gem is not installed."
+        say "Please install the gem '#{gem}' first."
+        say "Run 'gem install #{gem}' to install the gem."
+        exit 1
       end
 
-      #
-      # Select a diagram builder.
-      # @return [ERDProvider]
-      #
-      def select_diagram_builder
-        data = [Azimutt, DBDiagram]
+      database = if adapter == :sqlite3
+                   say "\nEnter the path to the database file:"
+                   ask_file "> "
+                 else
+                   ask "\nEnter the database connection string:\n>"
+                 end
 
-        puts "\nSelect a diagram builder:"
+      return SQL.new(adapter, database) if %i[sqlite3 mysql2 postgresql].include?(adapter)
 
-        data.each_with_index do |v, i|
-          puts "#{i + 1}. #{v.name.split('::').last}"
-        end
+      raise "Invalid database adapter"
+    end
 
-        response = ask_number(1, data.size)
+    #
+    # Select a diagram builder.
+    # @return [ERDProvider]
+    #
+    def select_diagram_builder
+      data = [Azimutt, DBDiagram]
 
-        data[response.to_i - 1]
-      end
+      say "\nSelect a diagram builder:"
 
-      #
-      # Display welcome message.
-      #
-      def welcome
-        puts <<~WELCOME
-             .----------------.  .----------------.  .----------------.  .----------------.
-            | .--------------. || .--------------. || .--------------. || .--------------. |
-            | |  _________   | || |  _______     | || |  ________    | || |   ______     | |
-            | | |_   ___  |  | || | |_   __ \\    | || | |_   ___ `.  | || |  |_   _ \\    | |
-            | |   | |_  \\_|  | || |   | |__) |   | || |   | |   `. \\ | || |    | |_) |   | |
-            | |   |  _|  _   | || |   |  __ /    | || |   | |    | | | || |    |  __'.   | |
-            | |  _| |___/ |  | || |  _| |  \\ \\_  | || |  _| |___.' / | || |   _| |__) |  | |
-            | | |_________|  | || | |____| |___| | || | |________.'  | || |  |_______/   | |
-            | |              | || |              | || |              | || |              | |
-            | '--------------' || '--------------' || '--------------' || '--------------' |
-             '----------------'  '----------------'  '----------------'  '----------------'
-
-          ERDB is an automate tool to generate Entity-Relationship Diagrams from a database.
-          It use Azimutt and DBDiagram to generate the diagrams.
-
-        WELCOME
+      data.each_with_index do |v, i|
+        say "#{i + 1}. #{v.name.split('::').last}"
       end
 
-      #
-      # Ask a question to the user.
-      # @param [String] question
-      # @return [String]
-      #
-      def ask(question = nil)
-        puts question if question
-        print "> "
-        gets.chomp
-      end
+      response = ask_number(1, data.size, ">")
 
-      #
-      # Ask a number input to the user.
-      # @param [Integer] min
-      # @param [Integer] max
-      # @return [Integer]
-      #
-      def ask_number(min, max)
-        response = nil
-        until response.to_i.between?(min, max)
-          response = ask
-          unless response.match(/^\d+$/)
-            puts "Please enter a number"
-            response = nil
-          end
-
-          unless response.to_i.between?(min, max)
-            puts "Please enter a number between #{min} and #{max}"
-            response = nil
-          end
-        end
-        response
-      end
+      data[response.to_i - 1]
+    end
 
-      def ask_file(question)
-        loop do
-          file = ask question
-          return file if File.exist?(file)
+    #
+    # Ask a number input to the user.
+    # @param [Integer] min
+    # @param [Integer] max
+    # @param [String] question
+    # @return [Integer]
+    #
+    def ask_number(min, max, question)
+      response = nil
+      until response.to_i.between?(min, max)
+        response = ask question
+        unless response.match(/^\d+$/)
+          say "Please enter a number"
+          response = nil
+        end
 
-          puts "Invalid file path"
+        unless response.to_i.between?(min, max)
+          say "Please enter a number between #{min} and #{max}"
+          response = nil
         end
       end
+      response
+    end
 
-      #
-      # Ask a yes/no question to the user.
-      # @param [String] question
-      # @param [Boolean] default
-      # @return [Boolean]
-      #
-      def ask_yes_no(question, default = true)
-        result = ask question
-
-        result.empty? ? default : result.downcase == "y"
+    #
+    # Ask a file path to the user.
+    # @param [String] question
+    # @return [String]
+    #
+    def ask_file(question)
+      loop do
+        file = ask question
+        return file if File.exist?(file)
+
+        say "File not found", :red
       end
     end
+
+    #
+    # Ask a yes/no question to the user.
+    # @param [String] question
+    # @param [Boolean] default
+    # @return [Boolean]
+    #
+    def ask_yes_no(question, default = true)
+      result = ask question
+
+      result.empty? ? default : result.downcase == "y"
+    end
+  end
+
+  #
+  # All the messages used in the CLI
+  #
+  class Messages
+    def self.welcome
+      <<~WELCOME
+           .----------------.  .----------------.  .----------------.  .----------------.
+          | .--------------. || .--------------. || .--------------. || .--------------. |
+          | |  _________   | || |  _______     | || |  ________    | || |   ______     | |
+          | | |_   ___  |  | || | |_   __ \\    | || | |_   ___ `.  | || |  |_   _ \\    | |
+          | |   | |_  \\_|  | || |   | |__) |   | || |   | |   `. \\ | || |    | |_) |   | |
+          | |   |  _|  _   | || |   |  __ /    | || |   | |    | | | || |    |  __'.   | |
+          | |  _| |___/ |  | || |  _| |  \\ \\_  | || |  _| |___.' / | || |   _| |__) |  | |
+          | | |_________|  | || | |____| |___| | || | |________.'  | || |  |_______/   | |
+          | |              | || |              | || |              | || |              | |
+          | '--------------' || '--------------' || '--------------' || '--------------' |
+           '----------------'  '----------------'  '----------------'  '----------------'
+        #{about}
+        ERDB will use chrome as the default browser to automate the process.
+        Use 'erdb --help' to see the available options.
+
+      WELCOME
+    end
+
+    def self.help
+      <<~HELP
+        #{about}
+        Usage:
+          erdb [options]
+
+        Examples:
+          erdb --browser=firefox --no-junction-table
+
+      HELP
+    end
+
+    def self.about
+      <<~ABOUT
+        ERDB is an automate tool to generate Entity-Relationship Diagrams from a database.
+        It use Azimutt and DBDiagram to generate the diagrams.
+      ABOUT
+    end
   end
 end

data/lib/erdb/providers/azimutt.rb

@@ -24,8 +24,6 @@ module ERDB
       # @return [void]
       #
       def start_automation(data)
-        browser = Watir::Browser.new(ERDB.default_browser)
-
         browser.goto "https://azimutt.app/new"
 
         browser.span(text: "From scratch (db design)").click
@@ -55,14 +53,7 @@ module ERDB
 
         btn.click if btn.exists?
 
-        puts "Enter 'q' to exit."
-
-        loop do
-          v = gets.chomp
-          break if v == "q"
-        end
-
-        browser.close
+        wait_to_quit
       end
 
       #
@@ -74,7 +65,7 @@ module ERDB
       def to_aml(tables)
         str = ""
         tables.each_with_index do |table, i|
-          if table[:is_join_table] && !ERDB.show_join_table?
+          if table[:is_junction_table] && !ERDB.show_junction_table
             str += to_many_to_many_str(table)
             next
           end
@@ -123,7 +114,7 @@ module ERDB
           relations.each do |other|
             next if relation == other
 
-            str += "\nfk: #{relation} -> #{other}\n"
+            str += "\nfk #{relation} -> #{other}\n"
           end
         end
 

data/lib/erdb/providers/dbdiagram.rb

@@ -24,8 +24,6 @@ module ERDB
       # @return [void]
       #
       def start_automation(data)
-        browser = Watir::Browser.new(ERDB.default_browser)
-
         browser.goto "https://dbdiagram.io/d"
 
         editor = browser.div(class: "view-lines monaco-mouse-cursor-text")
@@ -45,14 +43,7 @@ module ERDB
 
         Clipboard.copy(old_clipboard)
 
-        puts "Enter 'q' to exit."
-
-        loop do
-          v = gets.chomp
-          break if v == "q"
-        end
-
-        browser.close
+        wait_to_quit
       end
 
       #
@@ -64,7 +55,7 @@ module ERDB
       def to_dbdiagram_format(tables)
         str = ""
         tables.each_with_index do |table, i|
-          if table[:is_join_table] && !ERDB.show_join_table?
+          if table[:is_junction_table] && !ERDB.show_junction_table
             str += to_many_to_many_str(table)
             next
           end

data/lib/erdb/providers/erd_provider.rb

@@ -1,11 +1,38 @@
+require "watir"
+
 module ERDB
   class ERDProvider
-    #
-    # Create a new ER Diagram.
-    # @param [Hash] tables
-    #
-    def create(tables)
-      raise NotImplementedError
+    class << self
+      #
+      # Create a new ER Diagram.
+      # @param [Hash] tables
+      #
+      def create(tables)
+        raise NotImplementedError
+      end
+
+      private
+
+      #
+      # @return [Watir::Browser]
+      #
+      def browser
+        @browser ||= Watir::Browser.new(ERDB.default_browser)
+      end
+
+      #
+      # Wait for user to enter 'q' to quit.
+      #
+      def wait_to_quit
+        puts "Enter 'q' to exit."
+
+        loop do
+          v = gets.chomp
+          break if v == "q"
+        end
+
+        browser.close
+      end
     end
   end
 end

data/lib/erdb/version.rb

@@ -1,3 +1,3 @@
 module ERDB
-  VERSION = "1.0.1".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/erdb.rb

@@ -9,7 +9,7 @@ module ERDB
   autoload :DBDiagram, File.expand_path("erdb/providers/dbdiagram", __dir__)
 
   class << self
-    attr_writer :default_timeout, :default_browser, :show_join_table
+    attr_writer :default_timeout, :default_browser, :show_junction_table
 
     #
     # Default wait time for wait methods.
@@ -28,11 +28,11 @@ module ERDB
     end
 
     #
-    # Show join table in the diagram.
+    # Show junction table in the diagram.
     # @return [Boolean]
     #
-    def show_join_table?
-      @show_join_table.nil? ? true : @show_join_table
+    def show_junction_table
+      @show_junction_table.nil? ? true : @show_junction_table
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erdb
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Wai Yan Phyo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement