taql 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f24bc719d96fb2e39e7c563bff21d9faa0b571570fcc1c76014636f4e7ebd05a
-  data.tar.gz: 62abbf13a4fef7e0ab96324833e4a8f505c0e27103e95ddabcdcc3f23f3c2ee8
+  metadata.gz: 15ee79ff7f0dca8d5b599ca3ae84c95793acdfa1e8a46d66ac0fd57acbe98298
+  data.tar.gz: 926398c4f0c84677638bbc15602336efbd0b5d56a96c74c5964bd51ddb750187
 SHA512:
-  metadata.gz: b36295a5bcb1d37eb1c2c129447d13776ae6119b02bdefe22619da59176835e7dcfae8381abda207bffbf239da871c5790662b32085fb7135f5b913458d80ada
-  data.tar.gz: dd9a2b409e6f9bd4fbf8fa974dee215da841828f6c3fe4dccfe6ec9df04232e9efe3344b670b4c6fb3732d63929d614eba67d34cef8235833d1943f45f7087f5
+  metadata.gz: 438695540cf0922a1b95138a1eaee8d98a0e618f895915b935420353759279305327f88c513a366edb5d0df29dfbdb3bbb46a527c1f78dfee74f43091bf21bba
+  data.tar.gz: a60d55360eafafdc8f2ecdcded369c1287cc92cd032871af1ceb251162807631148b4ab4800c80d3c25a3f0a4fbf4cdf59e7f762614f716632e28a3037d73844

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## [Unreleased]
+## [0.2.5] - 2025-05-17
+
+- Added support for Markdown
+- Inject connection
+- Add irb to Gemfile
+- Update README
 
 ## [0.2.4] - 2025-04-17
 

data/README.md

@@ -27,19 +27,21 @@ If bundler is not being used to manage dependencies, install the gem by executin
 +----+----------------------+-----------+----------------------+
 ```
 
+Use the `--markdown` (or `-m`) flag to generate Markdown output:
+
 ```sh
-~/Developer/check-in (main) % taql "select id, first_name, last_name, created_at, updated_at from guests limit 3"
-+----+------------+------------+-------------------------+-------------------------+
+~/Developer/check-in % taql --markdown "select id, first_name, last_name, created_at, updated_at from guests limit 3"
 | ID | FIRST_NAME | LAST_NAME  | CREATED_AT              | UPDATED_AT              |
-+----+------------+------------+-------------------------+-------------------------+
+|----|------------|------------|-------------------------|-------------------------|
 | 1  | Alejandro  | Bustamante | 2023-07-26 16:26:21 UTC | 2023-07-26 16:26:21 UTC |
 | 2  | Reina      | Zelaya     | 2023-07-26 16:26:21 UTC | 2023-07-26 16:26:21 UTC |
 | 3  | Carla      | Barrios    | 2023-07-26 16:26:21 UTC | 2023-07-26 16:26:21 UTC |
-+----+------------+------------+-------------------------+-------------------------+
 ```
 
+Any valid SQL SELECT statement can be executed:
+
 ```sh
-~/Developer/check-in (main|!|+) % taql "select count(id) as guest_count from guests"
+~/Developer/check-in % taql "select count(id) as guest_count from guests"
 +-------------+
 | GUEST_COUNT |
 +-------------+
@@ -47,8 +49,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
 +-------------+
 ```
 
+Within a console:
+
 ```ruby
->> Taql.execute('select id, email from users order by created at limit 3').pluck("email")
+>> Taql.execute("select id, email from users order by created at limit 3").pluck("email")
    (1.2ms)  select id, email from users limit 3
 +----+---------------------+
 | ID | EMAIL               |
@@ -60,6 +64,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 => ["alice@example.com", "bob@example.com", "charlie@example.com"]
 ```
 
+The return value is a native PG::Result object, which supports mapping or extracting data as shown in the example above.
+
 ```ruby
 >> Taql.execute("select * from schema_migrations limit 3")
    (0.7ms)  select * from schema_migrations limit 3
@@ -70,7 +76,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 | 20240815131806 |
 | 20240815131747 |
 +----------------+
-=> #<PG::Result:0x000000012ebf6a38 status=PGRES_TUPLES_OK ntuples=3 nfields=1 cmd_tuples=3>
+=> \#<PG::Result:0x000000012ebf6a38 status=PGRES_TUPLES_OK ntuples=3 nfields=1 cmd_tuples=3>
 ```
 
 ## Development

data/lib/taql/cli.rb

@@ -1,14 +1,18 @@
+require "optparse"
+
 module Taql
   class Cli
-    attr_reader :argv
+    attr_reader :options, :query
 
     def initialize(argv)
-      @argv = argv
+      @options = {markdown: false}
+      @query = parse!
     end
 
     def run
       silence { require environment_path }
-      Taql.execute(*argv)
+
+      Taql.execute(*query, options)
     end
 
     private
@@ -17,6 +21,12 @@ module Taql
       File.expand_path("config/environment", Dir.pwd)
     end
 
+    def parse!
+      OptionParser.new do |parser|
+        parser.on("-m", "--markdown", TrueClass, "Output table in Markdown")
+      end.parse!(into: options)
+    end
+
     def silence
       original_stdout = $stdout.dup
       $stdout.reopen(IO::NULL)

data/lib/taql/table.rb

@@ -5,8 +5,11 @@ module Taql
     SPACE = " ".freeze
     VERTICAL_BAR = "|".freeze
 
-    def initialize(entries)
+    attr_accessor :markdown
+
+    def initialize(entries, markdown: false)
       @entries = entries.map { |entry| entry.transform_values(&:to_s) }
+      @markdown = markdown
     end
 
     def body
@@ -35,10 +38,18 @@ module Taql
 
     attr_reader :entries
 
+    def border
+      separator unless markdown
+    end
+
     def column_widths
       columns.map { |column| column.map(&:length).max }
     end
 
+    def edge
+      markdown ? VERTICAL_BAR : PLUS
+    end
+
     def formatted(segments)
       segments.map.with_index do |segment, index|
         [SPACE, segment.ljust(column_widths[index]), SPACE].join
@@ -48,20 +59,20 @@ module Taql
     end
 
     def output
-      <<~OUTPUT
-        #{separator}
-        #{formatted(headers.map(&:upcase))}
-        #{separator}
-        #{body.map(&method(:formatted)).join("\n")}
-        #{separator}
-      OUTPUT
+      [
+        border,
+        formatted(headers.map(&:upcase)),
+        separator,
+        body.map(&method(:formatted)).join("\n"),
+        border
+      ].compact.join("\n")
     end
 
     def separator
       columns.map.with_index do |column, index|
         Array.new(column_widths[index] + 2, DASH).join
       end.then do |columns|
-        [PLUS, columns.join(PLUS), PLUS].join
+        [edge, columns.join(edge), edge].join
       end
     end
 

data/lib/taql/version.rb

@@ -1,3 +1,3 @@
 module Taql
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/lib/taql.rb

@@ -5,10 +5,10 @@ require_relative "taql/version"
 module Taql
   class Error < StandardError; end
 
-  def self.execute(query)
-    ActiveRecord::Base.connection.execute(query).tap do |result|
+  def self.execute(query, options, connection: ActiveRecord::Base.connection)
+    connection.execute(query).tap do |result|
       if (results = result.entries).any?
-        $stdout.puts Table.new(results)
+        $stdout.puts Table.new(results, markdown: options[:markdown])
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: taql
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Ariel Rzezak
 bindir: exe
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Taql allows you to pretty print SQL table queries in Rails.
 email:
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Tableize Rails SQL queries
 test_files: []