taql 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c79d6f21fce22d45f9e3565a7c6f809b503ac534586115c33c02c291b171b7c
-  data.tar.gz: 159b78b65cf3292a321696a5557874a82a091b37b9d9274cb56e7b43346c3d2d
+  metadata.gz: 9eab3ab0fca8b6a61702ba40f696b7df8f0405bd76d8352620e9d6aa23d78aa1
+  data.tar.gz: 1b5568b7ff3cfcc0ee2f8fb847ed3217c67b3163d8a9ea4e476485793e2c6bfe
 SHA512:
-  metadata.gz: 491fbdb6dfa1cfc2074d0cca5c10f06ac43525ddd696380f5255f287364272b0a01e326fe8712bdfe616fcb614b373dd6dc2defe89c0fc76d68ea0c753a40633
-  data.tar.gz: 54db2ec859a48662429297d83e8d81c5ebd59517f329c53690214716306a7ffa2303fa98097b1507950cc54954df85a19b4826222fad6d7ccff7166aeb31e196
+  metadata.gz: ac7fd1fd09179d0e1b367aee9330b54b0b4f0f0f54d3e83460314d99c88a3afa2390621525681e567255511964d556e757dc5f3ce79daf409d17cf5cde5991e2
+  data.tar.gz: 828d90c486a79da04be7acddabd360a3d08f433415bc4da379978d134909c93ab226331fb9f985d6f00c1728d2bef7f63773295340596238b34532941c446e8c

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [0.2.1] - 2024-08-24
+
+- Fixed release
+
+## [0.2.0] - 2024-08-24
+
+- Added CLI
+
 ## [0.1.0] - 2024-08-23
 
 - Added SQL query table formatting

data/README.md

@@ -18,24 +18,59 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+```sh
+~/Developer/writebook % taql "select id, title, author, slug from books"
++----+----------------------+-----------+----------------------+
+| ID | TITLE                | AUTHOR    | SLUG                 |
++----+----------------------+-----------+----------------------+
+| 1  | The Writebook Manual | 37signals | the-writebook-manual |
++----+----------------------+-----------+----------------------+
+```
+
+```sh
+~/Developer/check-in (main) % taql "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 |
++----+------------+------------+-------------------------+-------------------------+
+```
+
+```sh
+~/Developer/check-in (main|!|+) % taql "select count(id) as guest_count from guests"
++-------------+
+| GUEST_COUNT |
++-------------+
+| 3721        |
++-------------+
+```
+
+```ruby
+>> 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               |
++----+---------------------+
+| 1  | alice@example.com   |
+| 2  | bob@example.com     |
+| 3  | charlie@example.com |
++----+---------------------+
+=> ["alice@example.com", "bob@example.com", "charlie@example.com"]
+```
+
 ```ruby
->> Taql.execute("select * from schema_migrations limit 10")
-   (0.7ms)  select * from schema_migrations limit 10
+>> Taql.execute("select * from schema_migrations limit 3")
+   (0.7ms)  select * from schema_migrations limit 3
 +----------------+
 | VERSION        |
 +----------------+
 | 20240819175830 |
 | 20240815131806 |
 | 20240815131747 |
-| 20240814161544 |
-| 20240814161045 |
-| 20240813193038 |
-| 20240806190918 |
-| 20240729170920 |
-| 20240724221738 |
-| 20240724220458 |
 +----------------+
-=> #<PG::Result:0x000000012ebf6a38 status=PGRES_TUPLES_OK ntuples=10 nfields=1 cmd_tuples=10>
+=> #<PG::Result:0x000000012ebf6a38 status=PGRES_TUPLES_OK ntuples=3 nfields=1 cmd_tuples=3>
 ```
 
 ## Development

data/exe/taql

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "taql"
+
+Taql::Cli.new(ARGV).run

data/lib/taql/cli.rb

@@ -0,0 +1,28 @@
+module Taql
+  class Cli
+    attr_reader :argv
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      silence { require environment_path }
+      Taql.execute(*argv)
+    end
+
+    private
+
+    def environment_path
+      File.expand_path("config/environment", Dir.pwd)
+    end
+
+    def silence
+      original_stdout = $stdout.dup
+      $stdout.reopen(IO::NULL)
+      yield
+    ensure
+      $stdout.reopen(original_stdout)
+    end
+  end
+end

data/lib/taql/table.rb

@@ -1,22 +1,23 @@
 module Taql
   class Table
-    attr_reader :entries, :io
+    attr_reader :entries
 
-    def initialize(entries, io: $stdout)
+    def initialize(entries)
       @entries = entries
-      @io = io
     end
 
     def print
-      [
-        separator,
-        formatted_headers,
-        separator,
-        formatted_entries,
-        separator
-      ].each do |output|
-        io.puts output
-      end
+      <<~OUTPUT
+        #{separator}
+        #{formatted_headers}
+        #{separator}
+        #{formatted_entries.join("\n")}
+        #{separator}
+      OUTPUT
+    end
+
+    def to_s
+      print
     end
 
     def formatted_entries

data/lib/taql/version.rb

@@ -1,3 +1,3 @@
 module Taql
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/taql.rb

@@ -1,3 +1,4 @@
+require_relative "taql/cli"
 require_relative "taql/table"
 require_relative "taql/version"
 
@@ -6,7 +7,7 @@ module Taql
 
   def self.execute(query)
     ActiveRecord::Base.connection.execute(query).tap do |result|
-      Table.new(result.entries).print
+      $stdout.puts Table.new(result.entries)
     end
   end
 end

data/taql.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Ariel Rzezak"]
   spec.email = ["arzezak@gmail.com"]
 
-  spec.summary = "Tableize SQL queries on your Rails console"
-  spec.description = "Taql allows you to pretty print SQL on your Rails console."
+  spec.summary = "Tableize Rails SQL queries"
+  spec.description = "Taql allows you to pretty print SQL table queries in Rails."
   spec.homepage = "https://github.com/arzezak/taql"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
 
-  spec.files = Dir["*.gemspec", "*.{md,txt}", "Rakefile", "{bin,lib}/**/*"]
+  spec.files = Dir["*.gemspec", "*.{md,txt}", "Rakefile", "{bin,exe,lib}/**/*"]
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: taql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ariel Rzezak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-08-24 00:00:00.000000000 Z
 dependencies: []
-description: Taql allows you to pretty print SQL on your Rails console.
+description: Taql allows you to pretty print SQL table queries in Rails.
 email:
 - arzezak@gmail.com
-executables: []
+executables:
+- taql
 extensions: []
 extra_rdoc_files: []
 files:
@@ -24,7 +25,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/taql
 - lib/taql.rb
+- lib/taql/cli.rb
 - lib/taql/table.rb
 - lib/taql/version.rb
 - taql.gemspec
@@ -53,5 +56,5 @@ requirements: []
 rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
-summary: Tableize SQL queries on your Rails console
+summary: Tableize Rails SQL queries
 test_files: []