rack-queries 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7278f7eac12f1013fe34eb2b1e84e75b7114d71d0f646c275a374c6615e56a82
-  data.tar.gz: a3c052ba9ced08c46d895b1197a63cfc65132df7e5f8ac6f64b5a16c3c0fa64b
+  metadata.gz: fd2c4945a82772005af76b00f2c441471d2a4812b3956e7a5067feca800bccfb
+  data.tar.gz: 21465b906c268333878acf0f316450f4059ae03d9bebc25f2ce4617bd0864087
 SHA512:
-  metadata.gz: 36ef6a95c554444c3e7d18e2027da7050b3e58390b9a3a707461d17abbdbe480195f8594eb49c71d1c1ad8b5ce51d6f6f54911480a94acb0971227c12f26ad3e
-  data.tar.gz: 87bcb39c6ab1e19e1ff38342a42ddb0d48311d922bee2439de15ab9b95af5f58e1a90ad7472d97f4b85c2fd1cbabbd4e417c07f17d74e0059e2f250c19f198e0
+  metadata.gz: ee6edba69e2e20b7f1ae999e949c500c3bfd911aca0e7b5368081858843a73baea086551280dd25d1b4acfc1461263f5d3f2b38de218ddd0db646dd853908974
+  data.tar.gz: ccf5d3b63d88e31b4537bf1e2b4caf8205080bba51d2cd9bd079d24b2bfca2ce4cc6fe62fc2246ac02df4f5a56ccd18c2eb34b7b50c35a5660dd369803aef5a3

data/.babelrc

@@ -1,7 +1,8 @@
 {
   "presets": [
     "@babel/preset-env",
-    "@babel/preset-react"
+    "@babel/preset-react",
+    "@babel/preset-typescript"
   ],
   "env": {
     "test": {

data/.github/workflows/main.yml

@@ -0,0 +1,47 @@
+name: Main
+on: push
+jobs:
+  ci-ruby:
+    name: CI Ruby
+    runs-on: ubuntu-latest
+    steps:
+    - run: sudo apt-get update
+    - run: sudo apt-get install libsqlite3-dev
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - run: bundle config path vendor/bundle
+    - run: bundle install --jobs 4 --retry 3
+    - run: bundle exec bundle audit --update
+    - run: bundle exec rubocop --parallel
+    - run: bundle exec rake test
+      env:
+        CI: true
+  ci-ts:
+    name: CI TypeScript
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-node@v1
+      with:
+        node-version: 11.x
+    - id: yarn-cache
+      run: echo "::set-output name=directory::$(yarn cache dir)"
+    - uses: actions/cache@v1
+      with:
+        path: ${{ steps.yarn-cache.outputs.directory }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
+    - run: yarn install --frozen-lockfile
+    - run: yarn lint
+    - run: yarn test
+      env:
+        CI: true

data/.mergify.yml

@@ -0,0 +1,11 @@
+pull_request_rules:
+  - name: Automatically merge dependencies
+    conditions:
+      - base=master
+      - label=dependencies
+      - status-success=CI Ruby
+      - status-success=CI TypeScript
+    actions:
+      merge:
+        strict: true
+      delete_head_branch: {}

data/.rubocop.yml

@@ -1,5 +1,3 @@
-require: rubocop-performance
-
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
@@ -13,3 +11,23 @@ Style/Documentation:
 
 Style/PerlBackrefs:
   Enabled: false
+
+Style/StructInheritance:
+  Enabled: false
+
+##############################
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.3.0] - 2020-04-13
+
+### Added
+
+- The ability to specify client-side provided options of type `string` and type `text`.
+
+### Changed
+
+- Switch the frontend over to TypeScript.
+
 ## [0.2.1] - 2019-08-09
 
 ### Changed
@@ -48,7 +58,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/CultureHQ/rack-queries/compare/v0.2.1...HEAD
+[unreleased]: https://github.com/CultureHQ/rack-queries/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/CultureHQ/rack-queries/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/CultureHQ/rack-queries/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/CultureHQ/rack-queries/compare/v0.1.3...v0.2.0
 [0.1.3]: https://github.com/CultureHQ/rack-queries/compare/v0.1.2...v0.1.3

data/Gemfile.lock

@@ -1,56 +1,58 @@
 PATH
   remote: .
   specs:
-    rack-queries (0.2.1)
+    rack-queries (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
     docile (1.3.2)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
-    rack (2.0.7)
+    rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rubocop (0.74.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
-      rubocop (>= 0.71.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.0)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sqlite3 (1.4.1)
-    unicode-display_width (1.6.0)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.1)
+    sqlite3 (1.4.2)
+    thor (0.20.3)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  bundler-audit (~> 0.6)
   minitest (~> 5.0)
   rack (~> 2.0)
   rack-queries!
   rack-test (~> 1.1)
-  rake (~> 12.0)
-  rubocop (~> 0.72)
-  rubocop-performance (~> 1.3)
+  rake (~> 13.0)
+  rubocop (~> 0.78)
   simplecov (~> 0.16)
   sqlite3 (~> 1.4)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,6 +1,6 @@
 # Rack::Queries
 
-[![Build Status](https://travis-ci.com/CultureHQ/rack-queries.svg?branch=master)](https://travis-ci.com/CultureHQ/rack-queries)
+[![Build Status](https://github.com/CultureHQ/rack-queries/workflows/Main/badge.svg)](https://github.com/CultureHQ/rack-queries/actions)
 [![Gem Version](https://img.shields.io/gem/v/rack-queries.svg)](https://github.com/CultureHQ/rack-queries)
 
 This gem provides a page in your rack-based (e.g., `Rails`, `Sinatra`) application that allows quick execution of pre-built queries. The goal is to allow quick insights into the state of your application without needing to update the main UI. Consider it a backdoor admin page that you can use before you decide to truly expose query results.
@@ -79,6 +79,27 @@ Rack::Queries.create do
 end
 ```
 
+With the DSL, you can additionally provide a `type` for your options that allows them to be specified on the client side. By default, the type is `select`, which will perform a query to the server to get the list of options. However, if you specify one of the other types (`string` or `text`), it will instead allow the user to provide input. For example, to allow a text area field, you would:
+
+```ruby
+Rack::Queries.create do
+  name 'Some CSV parsing'
+  desc 'Parse some CSV input!'
+
+  opt :csv, type: :text
+
+  run do |opts|
+    require 'csv'
+
+    CSV.foreach(opts['csv']) do
+      ...
+    end
+
+    ...
+  end
+end
+```
+
 ### Middleware
 
 Since `Rack::Queries` is a rack application, you can add whatever middleware you like into its stack before the request hits the application. For instance, to integrate HTTP basic auth around it to protect the query results, you can use the `Rack::Queries::App::use` method as in:

data/bin/example

@@ -44,7 +44,7 @@ class Database
   end
 
   def rows_from(query, binds = [])
-    execute(query, binds)
+    execute(query, binds).to_a
   end
 
   class << self
@@ -124,6 +124,24 @@ module Rack
         Database.value_from(query, opts)
       end
     end
+
+    create do
+      name 'Name search'
+      desc 'Search for a user by name'
+
+      opt(:org_name) { Database.values_from('SELECT name FROM orgs') }
+      opt(:user_name, type: :text)
+
+      run do |opts|
+        query = <<~SQL
+          SELECT id, org_id, active, name FROM users
+          WHERE org_id = (SELECT id FROM orgs WHERE name = :org_name)
+            AND name LIKE :user_name || '%'
+        SQL
+
+        [%w[id org_id active name]] + Database.rows_from(query, opts)
+      end
+    end
   end
 end
 

data/lib/rack/queries/app.rb

@@ -7,7 +7,8 @@ module Rack
         # Thought about refactoring this to split it out into multiple objects,
         # but then thought better of it. If we end up adding more API endpoints
         # then we can do something smart about it, but for now it's fine.
-        # rubocop:disable AbcSize, CyclomaticComplexity, MethodLength
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/MethodLength
         def call(env)
           return not_found unless env[REQUEST_METHOD]
 
@@ -27,7 +28,8 @@ module Rack
             not_found
           end
         end
-        # rubocop:enable AbcSize, CyclomaticComplexity, MethodLength
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/MethodLength
 
         private
 

data/lib/rack/queries/cache.rb

@@ -3,29 +3,56 @@
 module Rack
   module Queries
     class Cache
+      class Option < Struct.new(:name, :type)
+        def as_json
+          { name: name, type: type }
+        end
+      end
+
+      class SelectOption < Struct.new(:name)
+        def as_json
+          { name: name, type: 'select' }
+        end
+      end
+
       class CreateQuery
-        def self.name(name = :get)
-          if name == :get
-            @name
-          else
-            @name = name
+        class << self
+          def name(name = :get)
+            if name == :get
+              @name
+            else
+              @name = name
+            end
           end
-        end
 
-        def self.desc(desc = :get)
-          if desc == :get
-            @desc
-          else
-            @desc = desc
+          def desc(desc = :get)
+            if desc == :get
+              @desc
+            else
+              @desc = desc
+            end
           end
-        end
 
-        def self.opt(name, &block)
-          define_method(name, &block)
-        end
+          def opts
+            @opts ||= {}
+          end
 
-        def self.run(&block)
-          define_method(:run, &block)
+          def opt(name, type: :select, &block)
+            if type != :select && block
+              raise ArgumentError, 'Can only specify a block if it is a select'
+            end
+
+            if type == :select
+              define_method(name, &block)
+              opts[name.to_s] = SelectOption.new(name)
+            else
+              opts[name.to_s] = Option.new(name, type)
+            end
+          end
+
+          def run(&block)
+            define_method(:run, &block)
+          end
         end
       end
 
@@ -36,6 +63,16 @@ module Rack
       end
 
       def add(*queries)
+        queries.each do |query|
+          opts = {}
+
+          (query.public_instance_methods(false) - %i[run]).each do |name|
+            opts[name] = SelectOption.new(name)
+          end
+
+          query.define_singleton_method(:opts) { opts }
+        end
+
         @cache = (cache + queries).sort_by(&:name)
       end
 
@@ -46,16 +83,14 @@ module Rack
 
       def opts_for(name, opt)
         query = query_for(name)
-        return unless query
-
-        instance = query.new
-        instance.public_send(opt) if instance.respond_to?(opt)
+        query.new.public_send(opt) if query
       end
 
       def queries
         cache.map do |query|
           desc = query.respond_to?(:desc) ? query.desc : ''
-          opts = query.public_instance_methods(false) - %i[run]
+          opts =
+            query.respond_to?(:opts) ? query.opts.values.map(&:as_json) : []
 
           { name: query.name, desc: desc, opts: opts }
         end

data/lib/rack/queries/static/app.css

@@ -75,16 +75,16 @@ nav {
   z-index: 1
 }
 
-.query-active {
+.query[aria-current='true'] {
   background-color: #8b3333;
   color: #fff;
 }
 
-.query-active p {
+.query[aria-current='true'] p {
   color: #fff;
 }
 
-.query-active:before {
+.query[aria-current='true']:before {
   border-bottom: 12px solid transparent;
   border-right: 12px solid #8b3333;
   border-top: 12px solid transparent;
@@ -93,7 +93,7 @@ nav {
   position: absolute;
 }
 
-.query-active:hover {
+.query[aria-current='true']:hover {
   background-color: #8b3333;
 }
 
@@ -108,6 +108,11 @@ nav {
   vertical-align: middle;
 }
 
+.opt textarea {
+  height: 20em;
+  width: 50em;
+}
+
 .run {
   border-radius: 4px;
   background: #8b3333;