nazar 0.0.5 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c111b062edbb87fb756c39dcdf5628c7a71459a0f5cc98b9ae69f41894271e4
-  data.tar.gz: 7979ca6f048af4bd2d52ad55b62c630bbdffe570ec127bd761243c9ce88c6770
+  metadata.gz: f3ea71c523b3f82b6882bdcb11b842e53b4f2283bc95d1ab5e8c0e17e2b1c9b6
+  data.tar.gz: 97017a09da4032dd35b90e34cd49cf92e96473f7c1f001a8f9ffab1c93ae6d2f
 SHA512:
-  metadata.gz: 37cb2ef5920b6ee84296494e7f2c6e1f13fb0f3b6736ada3eb983933d9fc7384521c4fecf9328978fd6f94a778218541b7a21e35b45df6e426374bdb7be03d6a
-  data.tar.gz: 85047535269ef0c782451c7c3d1c04a63f99ee4a412a1f34e557c6b951f72d54088191a7cf324eac82866c0c327f2fdb3277a8f7d2921dd43f31fb25206f63a1
+  metadata.gz: cb511b109dc83d28057e6454a5d438e799cfbb0a6eb64d2f0c55ae53dd8e92c19f0c78b4a361452307e41999738972260e2b5b4b6dc347c05ddaf81e49b452bd
+  data.tar.gz: 5c0f4e67fea1a380606dd75bac52de072ac9851f70b844ee8ba1464c73592e49cde3f0449fcb208cdb912b938e067fce4a8af0a7d5f7076e244e6b78d2cfa336

data/.github/workflows/main.yml

@@ -35,4 +35,8 @@ jobs:
           ruby-version: 2.7
           bundler-cache: true
       - name: Specs
-        run: bundle exec rspec
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        with:
+          coverageCommand: bundle exec rspec

data/README.md

@@ -1,10 +1,154 @@
-# Nazar [![Build Status](https://github.com/krzyzak/nazar/actions/workflows/main.yml/badge.svg)](https://github.com/krzyzak/nazar/actions) [![Code Climate](https://codeclimate.com/github/krzyzak/nazar/badges/gpa.svg)](https://codeclimate.com/github/krzyzak/nazar)
+# Nazar [![Build Status](https://github.com/krzyzak/nazar/actions/workflows/main.yml/badge.svg)](https://github.com/krzyzak/nazar/actions) [![Gem Version](https://badge.fury.io/rb/nazar.svg)](https://badge.fury.io/rb/nazar) [![Code Climate](https://codeclimate.com/github/krzyzak/nazar/badges/gpa.svg)](https://codeclimate.com/github/krzyzak/nazar) [![Test Coverage](https://api.codeclimate.com/v1/badges/f89b8bfdf557900e1f9f/test_coverage)](https://codeclimate.com/github/krzyzak/nazar/test_coverage)
 
-Nazar improves defvault inspect output for console applications (supports IRB and Pry).
+Turn this:
+```ruby
+>> User.all
+  User Load (0.4ms)  SELECT "users".* FROM "users" /* loading for inspect */ LIMIT ?  [["LIMIT", 11]]
+=> #<ActiveRecord::Relation [#<User id: 1, email: "delma@goldner.co", name: "Mrs. Charis Brown", description: "Quasi atque ea. Beatae corporis quia. Eveniet veli...", created_at: "2021-09-01 05:42:24.341344000 +0000", updated_at: "2021-09-20 09:36:29.289078000 +0000", active: false, last_login_at: nil>, #<User id: 2, email: "markpfeffer@wunschbraun.info", name: "Ms. Sherice Champlin", description: "Omnis ut illum. Non velit mollitia. Expedita facil...", created_at: "2021-09-10 07:27:00.182298000 +0000", updated_at: "2021-09-20 09:36:29.292065000 +0000", active: true, last_login_at: "2021-09-19 16:25:32.094418000 +0000">, #<User id: 3, email: "nathansimonis@kunde.org", name: "Florentino Gleason", description: "Non recusandae eos. Et voluptates iusto. Commodi e...", created_at: "2021-09-07 18:24:45.608164000 +0000", updated_at: "2021-09-20 09:36:29.293572000 +0000", active: false, last_login_at: nil>, #<User id: 4, email: "edwardowilkinson@walkerschiller.info", name: "Judie Boehm", description: "Ut ea eum. Tempore voluptates praesentium. Animi s...", created_at: "2021-09-05 02:11:36.564693000 +0000", updated_at: "2021-09-20 09:36:29.295763000 +0000", active: true, last_login_at: "2021-09-19 20:17:24.074515000 +0000">, #<User id: 5, email: "isaiahebert@brauncarroll.net", name: "Mari Ullrich", description: "Aperiam quas voluptas. Autem alias quia. Aut persp...", created_at: "2021-09-09 05:23:03.229860000 +0000", updated_at: "2021-09-20 09:36:29.296928000 +0000", active: nil, last_login_at: nil>, #<User id: 6, email: "alexander@anderson.io", name: "Sam Larson DDS", description: "Sed velit consectetur. Quas cupiditate enim. Neque...", created_at: "2021-09-03 02:52:14.055696000 +0000", updated_at: "2021-09-20 09:36:29.299157000 +0000", active: true, last_login_at: "2021-09-20 05:01:39.019563000 +0000">, #<User id: 7, email: "chirunolfon@keler.io", name: "Ying Kub I", description: "Cupiditate ut consequatur. Eos ab laboriosam. Ipsa...", created_at: "2021-09-10 05:52:32.005877000 +0000", updated_at: "2021-09-20 09:36:29.301469000 +0000", active: true, last_login_at: "2021-09-19 21:30:48.854010000 +0000">, #<User id: 8, email: "johnny@anderson.net", name: "Johnie Corwin II", description: "Suscipit itaque adipisci. Assumenda ad error. Quas...", created_at: "2021-09-12 13:05:49.845361000 +0000", updated_at: "2021-09-20 09:36:29.302657000 +0000", active: nil, last_login_at: nil>, #<User id: 9, email: "yahairakuhn@schneider.com", name: "Sharie Weber", description: "Sapiente voluptatum mollitia. Dolores voluptatum a...", created_at: "2021-09-19 03:03:39.360526000 +0000", updated_at: "2021-09-20 09:36:29.304929000 +0000", active: true, last_login_at: "2021-09-20 06:46:05.846685000 +0000">, #<User id: 10, email: "tommye@schuppe.biz", name: "Yoshiko Mohr", description: "Similique laborum totam. Non cum atque. Placeat qu...", created_at: "2021-09-08 05:41:36.588541000 +0000", updated_at: "2021-09-20 09:36:29.306120000 +0000", active: nil, last_login_at: nil>, ...]>
+```
+Into this:
 
-**Nazar is under heavy development now. Expect bumpy ride or wait until the API will stabilise a bit ;)**
+```ruby
+>> User.all
+   (0.6ms)  SELECT sqlite_version(*)
+  User Load (0.8ms)  SELECT "users".* FROM "users"
+┏━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ id    │ email                                │ name                  │ description                                                                             │ created_at              │ updated_at              │ active │ last_login_at           ┃
+┣═══════╪══════════════════════════════════════╪═══════════════════════╪═════════════════════════════════════════════════════════════════════════════════════════╪═════════════════════════╪═════════════════════════╪════════╪═════════════════════════┫
+┃ 1     │ delma@goldner.co                     │ Mrs. Charis Brown     │ Quasi atque ea. Beatae corporis quia. Eveniet velit ad.                                 │ 2021-09-01 05:42:24 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 2     │ markpfeffer@wunschbraun.info         │ Ms. Sherice Champlin  │ Omnis ut illum. Non velit mollitia. Expedita facilis dignissimos.                       │ 2021-09-10 07:27:00 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-19 16:25:32 UTC ┃
+┃ 3     │ nathansimonis@kunde.org              │ Florentino Gleason    │ Non recusandae eos. Et voluptates iusto. Commodi est in.                                │ 2021-09-07 18:24:45 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 4     │ edwardowilkinson@walkerschiller.info │ Judie Boehm           │ Ut ea eum. Tempore voluptates praesentium. Animi sapiente distinctio.                   │ 2021-09-05 02:11:36 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-19 20:17:24 UTC ┃
+┃ 5     │ isaiahebert@brauncarroll.net         │ Mari Ullrich          │ Aperiam quas voluptas. Autem alias quia. Aut perspiciatis eos.                          │ 2021-09-09 05:23:03 UTC │ 2021-09-20 09:36:29 UTC │ ∅      │ ∅                       ┃
+┃ 6     │ alexander@anderson.io                │ Sam Larson DDS        │ Sed velit consectetur. Quas cupiditate enim. Neque facere harum.                        │ 2021-09-03 02:52:14 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-20 05:01:39 UTC ┃
+┃ 7     │ chirunolfon@keler.io                 │ Ying Kub I            │ Cupiditate ut consequatur. Eos ab laboriosam. Ipsam ut veritatis.                       │ 2021-09-10 05:52:32 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-19 21:30:48 UTC ┃
+┃ 8     │ johnny@anderson.net                  │ Johnie Corwin II      │ Suscipit itaque adipisci. Assumenda ad error. Quas enim beatae.                         │ 2021-09-12 13:05:49 UTC │ 2021-09-20 09:36:29 UTC │ ∅      │ ∅                       ┃
+┃ 9     │ yahairakuhn@schneider.com            │ Sharie Weber          │ Sapiente voluptatum mollitia. Dolores voluptatum accusamus. Veniam voluptatem deserunt. │ 2021-09-19 03:03:39 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-20 06:46:05 UTC ┃
+┃ 10    │ tommye@schuppe.biz                   │ Yoshiko Mohr          │ Similique laborum totam. Non cum atque. Placeat quia velit.                             │ 2021-09-08 05:41:36 UTC │ 2021-09-20 09:36:29 UTC │ ∅      │ ∅                       ┃
+┃ 11    │ derekbeier@hermankuhlman.co          │ Lavern Feil           │ Itaque molestias et. Iure tempora minus. Dolore autem omnis.                            │ 2021-09-05 04:04:51 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 12    │ lavernwillms@runolfsdottirbogan.org  │ Marcy Gottlieb Sr.    │ Mollitia quia dolor. Libero laborum aperiam. Velit est eum.                             │ 2021-09-08 19:22:49 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 13    │ earlhills@mclaughlingreenholt.info   │ Adina Luettgen        │ In qui rem. Illum itaque dignissimos. Enim vitae tenetur.                               │ 2021-09-08 10:16:12 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 14    │ larry@rice.com                       │ Carolina Kuhlman II   │ Ipsum ut fuga. Sunt id a. Rerum nulla sint.                                             │ 2021-09-03 23:11:42 UTC │ 2021-09-20 09:36:29 UTC │ ∅      │ ∅                       ┃
+┃ 15    │ randy@kuhicfritsch.name              │ Harvey Runolfsdottir  │ Dolorum officiis sed. Ut recusandae culpa. Odit aut nostrum.                            │ 2021-09-08 04:28:38 UTC │ 2021-09-20 09:36:29 UTC │ ∅      │ ∅                       ┃
+┃ 16    │ lashaun@mooreleannon.co              │ Lucio Raynor          │ Et expedita rerum. Autem nesciunt labore. Suscipit aut eum.                             │ 2021-09-06 20:47:51 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 17    │ omeryost@becker.com                  │ Rocky Hettinger       │ Ut deleniti voluptas. Explicabo voluptas rerum. Illum sapiente quo.                     │ 2021-09-14 23:05:33 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-20 09:35:14 UTC ┃
+┃ 18    │ nilsa@corwinkub.name                 │ Serena Brakus         │ Qui non provident. Omnis excepturi quasi. Ratione suscipit dolor.                       │ 2021-09-14 01:06:02 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 19    │ berniebednar@spinkamiller.co         │ Merlin Predovic       │ Omnis et minus. Tempore in laboriosam. Molestiae aut eveniet.                           │ 2021-09-16 18:34:20 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-19 12:01:59 UTC ┃
+┃ 20    │ claude@smithamhaley.io               │ Claudette Thompson MD │ Aut consectetur soluta. Laborum quia qui. Vel incidunt minima.                          │ 2021-09-10 03:53:24 UTC │ 2021-09-20 09:36:29 UTC │ ∅      │ ∅                       ┃
+┃ 21    │ matilde@cormierstroman.name          │ Dalton Witting        │ Voluptatum provident earum. Ad esse odit. Quasi non ut.                                 │ 2021-09-10 04:51:53 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 22    │ randistrosin@littel.io               │ Miss Lucio Kub        │ Ea quia sapiente. Reprehenderit esse ut. Veritatis magnam quia.                         │ 2021-08-31 18:33:02 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 23    │ noah@kuphal.co                       │ Alonzo Stroman        │ Officia fugit eos. Qui quo et. Ducimus harum dignissimos.                               │ 2021-09-13 14:36:31 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┃ 24    │ cristinaschneider@cole.biz           │ Dr. Newton Ritchie    │ Corporis suscipit recusandae. Voluptas voluptas quo. Non perferendis fugiat.            │ 2021-09-02 20:54:38 UTC │ 2021-09-20 09:36:29 UTC │ ✓      │ 2021-09-20 02:35:39 UTC ┃
+┃ 25    │ mirtha@spinkabayer.co                │ Kory Cummings         │ Aut ut aut. Quis voluptas sit. Consequatur quia voluptatibus.                           │ 2021-09-17 08:45:02 UTC │ 2021-09-20 09:36:29 UTC │ ✗      │ ∅                       ┃
+┠───────┼──────────────────────────────────────┴───────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────┴─────────────────────────┴─────────────────────────┴────────┴─────────────────────────┨
+┃ Total │ 25                                                                                                                                                                                                                                            ┃
+┗━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
 
-[![asciicast](https://asciinema.org/a/436814.png)](https://asciinema.org/a/436814)
+## Installation
+
+### Per-project installation
+
+While nothing stops you from adding Nazar to each project separately, I find it cumbersome to add it to every project I'm working on - it also alters REPL behaviour for other teammates, which is another reason why personally I don't recommend that approach. Anyway, here's quick how-to:
+
+Add `nazar` to Gemfile:
+```ruby
+group :development, :test do
+  gem 'nazar', require: false
+end
+```
+Then, you have to call `Nazar.enable!`. If you're using Rails, you might want to add this snippet to `config/application.rb`: 
+
+```ruby
+console do
+  require 'nazar'
+
+  Nazar.enable! # See configuration section for more options and 
+                # Opt-in setup section if you don't want to enable it for every item
+end
+```
+Otherwise, call it in `bin/console` or any other script that launches your REPL.
+
+### Global installation
+
+This is my recommended way to install this gem - that way it works automatically in all your projects, even in standalone `irb` or `pry` sessions.
+
+- **Create global gems path** 
+  
+  `mkdir -p ~/.gem/ruby/global` - You're welcome to use any other path for your global gemset
+- **Install nazar in your global gemset**
+  
+  `gem install nazar -i ~/.gem/ruby/global`
+- **Load Nazar in your REPL rc file**
+  Add following snippet to your `.irbrc` or `.pryrc`:
+  
+```ruby
+global_gemset_path = File.expand_path('~/.gem/ruby/global/gems')
+
+if Dir.exist?(global_gemset_path)
+  global_gems_path = Dir.glob("#{global_gemset_path}/*/lib")
+
+  $LOAD_PATH.unshift(*global_gems_path)
+end
+
+%w[nazar].each do |gem|
+  begin
+    require gem
+  rescue LoadError
+  end
+end
+
+Nazar.enable! if defined?(Nazar)
+```
+
+## Shorthand method
+
+Nazar defines top level `__(data)` method, that can be useful for two things:
+
+### Inspecting (array of) Hashes/Structs
+
+Nazar by design won't enhance output for any collection that does not consist of supported (eg. ActiveRecord/Sequel) items. If you have a data that is structurally compatible (ie: all items consists of the same keys), and want to enahance the output, you can simply use `#__` method:
+
+```ruby
+__ [{foo: :bar, test: 123},{foo: :baz, test: 456}]
+┏━━━━━━━┯━━━━━━┓
+┃ foo   │ test ┃
+┣═══════╪══════┫
+┃ :bar  │ 123  ┃
+┃ :baz  │ 456  ┃
+┠───────┼──────┨
+┃ Total │ 2    ┃
+┗━━━━━━━┷━━━━━━┛
+```
+
+It works with Structs and Hashes (or, more specifically - with any object that reponds to `#keys` and `#values`)
+
+### Opt-in setup
+
+If you use `Nazar.load!` instead of `Nazar.enable!`, it would not enhance output for every element in the console. Instead, you have to call `#__` for each item that you want to enhance output
+
+```ruby
+
+Nazar.load!
+User.all # Returns default output
+__ User.all # Returns output enhanced by Nazar
+```
+
+
+## Configuration
+
+By default, Nazar improves output for ActiveRecord (both collections and a single item) and for CSV Tables. You can configure that by calling `#enable!` with optional argument:
+
+`Nazar.enable!(extensions: [:active_record, :csv, :sequel])` will enhance output for <a href="https://github.com/jeremyevans/sequel/">Sequel</a> as well.
+
+You can also configure behaviour of Nazar:
+
+| Config | Default | Description |
+| ------ | ------- | ----------- |
+| `Nazar.config.colors.enabled` | true | Determines whether the output should be colorised or not |
+| `Nazar.config.formatter.nil` | `∅` | Sets character printed if the value was nil | 
+| `Nazar.config.formatter.boolean` | ['✓', '✗'] | First item in array is a character for `true`, second for `false` |
+| `Nazar.config.enable_shorthand_method` | true | Determines if shorthand method should be defined. See <a href="#opt-in-setup">Opt-in setup</a> for more details |
 
 ## Contributing
 

data/lib/nazar/cell_formatter.rb

@@ -10,11 +10,11 @@ module Nazar
     def format
       case type
       when :boolean
-        format_boolean(value)
+        format_boolean
       when :integer
-        Pastel.new(enabled: Nazar.config.colors.enabled).bright_blue(value)
+        format_number
       else
-        value.nil? ? format_nil : value.to_s
+        value.nil? ? format_nil : inteligent_format
       end
     end
 
@@ -22,7 +22,7 @@ module Nazar
 
     attr_reader :value, :type
 
-    def format_boolean(value)
+    def format_boolean
       return format_nil if value.nil?
 
       true_value, false_value = Nazar.config.formatter.boolean
@@ -30,7 +30,26 @@ module Nazar
     end
 
     def format_nil
-      Pastel.new(enabled: Nazar.config.colors.enabled).dim(Nazar.config.formatter.nil)
+      pastel.dim(Nazar.config.formatter.nil)
+    end
+
+    def format_number
+      pastel.bright_blue(value)
+    end
+
+    def inteligent_format
+      case value
+      when Symbol
+        pastel.magenta(":#{value}")
+      when Numeric
+        format_number
+      else
+        value.to_s
+      end
+    end
+
+    def pastel
+      @pastel ||= Pastel.new(enabled: Nazar.config.colors.enabled)
     end
   end
 end

data/lib/nazar/formatter/active_record_collection.rb

@@ -15,6 +15,12 @@ module Nazar
         @klass = collection.first&.class
       end
 
+      def self.valid?(data)
+        data.is_a?(ActiveRecord::Associations::CollectionProxy) ||
+          data.is_a?(ActiveRecord::Relation) ||
+          (data.is_a?(Enumerable) && data.first.is_a?(ActiveRecord::Base))
+      end
+
       def summary
         collection.size
       end

data/lib/nazar/formatter/active_record_item.rb

@@ -13,6 +13,10 @@ module Nazar
         @klass = item.class
       end
 
+      def self.valid?(data)
+        data.is_a?(ActiveRecord::Base)
+      end
+
       def summary
         false
       end

data/lib/nazar/formatter/csv_table.rb

@@ -9,6 +9,10 @@ module Nazar
         @collection = collection
       end
 
+      def self.valid?(data)
+        data.is_a?(CSV::Table)
+      end
+
       def valid?
         !!collection && !collection.empty?
       end

data/lib/nazar/formatter/generic.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Nazar
+  module Formatter
+    class Generic
+      attr_reader :collection
+
+      def initialize(collection)
+        @collection = Array(collection)
+        @item = collection.first
+      end
+
+      def headers
+        HeadersFormatter.new(raw_headers).format
+      end
+
+      def cells
+        @cells ||= collection.map do |item|
+          item.values.map do |value|
+            CellFormatter.new(value).format
+          end
+        end
+      end
+
+      def summary
+        collection.size
+      end
+
+      def self.valid?(data)
+        item = data.first
+        compatible = item.respond_to?(:keys) && item.respond_to?(:values)
+
+        data.is_a?(Enumerable) && (item.is_a?(Struct) || compatible)
+      end
+
+      def valid?
+        !!item && !raw_headers.empty?
+      end
+
+      private
+
+      attr_reader :item
+
+      def raw_headers
+        @raw_headers ||= if item.is_a?(Struct)
+          item.members
+        elsif item.respond_to?(:keys)
+          item.keys
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/nazar/formatter/sequel_collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'nazar/formatter/sequel_interface'
+
+module Nazar
+  module Formatter
+    class SequelCollection
+      include SequelInterface
+
+      def initialize(collection)
+        @collection = collection
+        @attributes = collection.first&.values
+      end
+
+      def self.valid?(data)
+        (data.is_a?(Enumerable) && data.first.is_a?(Sequel::Model)) || data.is_a?(Sequel::Dataset)
+      end
+
+      def summary
+        collection.size
+      end
+    end
+  end
+end

data/lib/nazar/formatter/sequel_interface.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Nazar
+  module Formatter
+    module SequelInterface
+      attr_reader :collection, :klass, :attributes
+
+      def valid?
+        !!attributes
+      end
+
+      def headers
+        HeadersFormatter.new(attributes.keys).format
+      end
+
+      def cells
+        @cells ||= begin
+          schema = collection.first.db_schema
+
+          collection.map do |item|
+            item.values.map do |column, value|
+              CellFormatter.new(value, type: schema.dig(column, :type)).format
+            end
+          end
+        end
+      end
+
+      def summary
+        collection.size
+      end
+    end
+  end
+end

data/lib/nazar/formatter/sequel_item.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'nazar/formatter/sequel_interface'
+
+module Nazar
+  module Formatter
+    class SequelItem
+      include SequelInterface
+
+      def initialize(item)
+        @collection = [item]
+        @attributes = item.values
+        @klass = item.class
+      end
+
+      def self.valid?(data)
+        data.is_a?(Sequel::Model)
+      end
+
+      def summary
+        false
+      end
+    end
+  end
+end

data/lib/nazar/renderer.rb

@@ -2,12 +2,18 @@
 
 module Nazar
   class Renderer
-    def initialize(data)
+    def initialize(data, use_generic_formatter: false)
       @data = data
+      @use_generic_formatter = use_generic_formatter
     end
 
     def render
-      pager.page(view.render) if view.supported_data?
+      pager.page(view.render)
+      nil
+    end
+
+    def valid?
+      view.supported_data?
     end
 
     def pager
@@ -19,7 +25,7 @@ module Nazar
     attr_reader :data
 
     def view
-      @view ||= View.new(data)
+      @view ||= View.new(data, use_generic_formatter: @use_generic_formatter)
     end
   end
 end

data/lib/nazar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nazar
-  VERSION = '0.0.5'
+  VERSION = '0.1.1'
 end

data/lib/nazar/view.rb

@@ -6,8 +6,9 @@ module Nazar
 
     def_delegators :formatter, :headers, :cells, :summary
 
-    def initialize(data)
+    def initialize(data, use_generic_formatter: false)
       @data = data
+      @use_generic_formatter = use_generic_formatter
     end
 
     def render
@@ -24,49 +25,20 @@ module Nazar
 
     private
 
-    attr_reader :data
+    attr_reader :data, :use_generic_formatter
 
-    def formatter_klass
-      @formatter_klass ||= case data
-      when boolean?
-        nil
-      when acttive_record_collection?
-        Formatter::ActiveRecordCollection
-      when active_record_item?
-        Formatter::ActiveRecordItem
-      when csv_table?
-        Formatter::CSVTable
-      end
-    end
-
-    def formatter
-      @formatter ||= formatter_klass.new(data)
-    end
-
-    def boolean?
-      proc { data === true || data === false } # rubocop:disable Style/CaseEquality
-    end
-
-    def acttive_record_collection?
-      return false unless Nazar.extensions.include?(:active_record)
-
-      proc do
-        data.is_a?(ActiveRecord::Associations::CollectionProxy) ||
-          data.is_a?(ActiveRecord::Relation) ||
-          (data.is_a?(Array) && data.first.is_a?(ActiveRecord::Base))
+    def formatters
+      @formatters ||= Nazar.formatters.tap do |formatters|
+        formatters << Nazar::Formatter::Generic if use_generic_formatter
       end
     end
 
-    def active_record_item?
-      return false unless Nazar.extensions.include?(:active_record)
-
-      proc { data.is_a?(ActiveRecord::Base) }
+    def formatter_klass
+      @formatter_klass ||= formatters.find { |klass| klass.valid?(data) }
     end
 
-    def csv_table?
-      return false unless Nazar.extensions.include?(:csv)
-
-      proc { data.is_a?(CSV::Table) }
+    def formatter
+      @formatter ||= formatter_klass.new(data)
     end
 
     def add_summary

data/lib/nazar.rb

@@ -10,9 +10,10 @@ require 'nazar/cell_formatter'
 require 'nazar/headers_formatter'
 require 'nazar/renderer'
 require 'nazar/formatter'
+require 'nazar/formatter/generic'
 require 'nazar/view'
 
-module Nazar
+module Nazar # rubocop:disable Metrics/ModuleLength
   extend Dry::Configurable
 
   setting :formatter do
@@ -24,60 +25,130 @@ module Nazar
     setting :enabled, default: ENV.fetch('ENABLE_TTY_COLORS') { TTY::Color.color? ? 'true' : 'false' } == 'true'
   end
 
+  setting :enable_shorthand_method, default: true
+
   class << self
-    def extensions
-      @extensions ||= Set.new
+    def formatters
+      @formatters ||= Set.new
     end
 
     def enable!(extensions: [:active_record, :csv])
       return if @enabled
 
-      load_active_record! if extensions.include?(:active_record)
-      load_csv! if extensions.include?(:csv)
+      load_extensions!(extensions)
+      enable_repl!
 
-      enable_for_irb! if defined?(IRB)
-      enable_for_pry! if defined?(Pry)
+      enable_shorthand_method! if Nazar.config.enable_shorthand_method
 
       @enabled = true
     end
 
-    def load_csv!
-      extensions << :csv
+    def load!(extensions: [:active_record, :csv])
+      load_extensions!(extensions)
+      enable_shorthand_method! if Nazar.config.enable_shorthand_method
 
+      true
+    end
+
+    def load_csv!
       require 'csv'
-      load 'nazar/formatter/csv_table.rb'
+
+      register_formatter!('CSVTable', 'nazar/formatter/csv_table')
     end
 
     def load_active_record!
-      extensions << :active_record
-
       require 'active_record'
-      load 'nazar/formatter/active_record_collection.rb'
-      load 'nazar/formatter/active_record_item.rb'
+
+      register_formatter!('ActiveRecordCollection', 'nazar/formatter/active_record_collection')
+      register_formatter!('ActiveRecordItem', 'nazar/formatter/active_record_item')
+    end
+
+    def load_sequel!
+      require 'sequel'
+
+      register_formatter!('SequelCollection', 'nazar/formatter/sequel_collection')
+      register_formatter!('SequelItem', 'nazar/formatter/sequel_item')
+    end
+
+    def register_formatter!(klass_name, path)
+      require path
+
+      formatters << Nazar::Formatter.const_get(klass_name)
+    end
+
+    def pry_proc
+      return unless defined?(Pry)
+
+      proc do |output, value, instance|
+        renderer = Nazar::Renderer.new(value)
+        renderer.valid? ? renderer.render : @__original_pry_print.call(output, value, instance)
+      end
+    end
+
+    def disable!
+      disable_shorthand_method! if @defined_shorthand_method
+
+      return unless @enabled
+
+      disable_for_irb! if defined?(IRB)
+      disable_for_pry! if defined?(Pry)
+
+      @enabled = false
+    end
+
+    private
+
+    def load_extensions!(extensions)
+      load_active_record! if extensions.include?(:active_record)
+      load_csv! if extensions.include?(:csv)
+      load_sequel! if extensions.include?(:sequel)
+    end
+
+    def enable_repl!
+      enable_for_irb! if defined?(IRB)
+      enable_for_pry! if defined?(Pry)
     end
 
     def enable_for_irb!
       ::IRB::Irb.class_eval do
         alias_method :__original_output_value__, :output_value
         def output_value(omit = false) # rubocop:disable Style/OptionalBooleanParameter
-          ::Nazar::Renderer.new(@context.last_value).render || __original_output_value__(omit)
+          renderer = Nazar::Renderer.new(@context.last_value)
+          renderer.valid? ? renderer.render : __original_output_value__(omit)
         end
       end
     end
 
     def enable_for_pry!
-      @__original_pry_print = Pry.config.print
-      Pry.config.print = proc do |output, value, instance|
-        output.puts Nazar::Renderer.new(value).render || @__original_pry_print.call(output, value, instance)
+      @__original_pry_print ||= Pry.config.print
+
+      if Pry.toplevel_binding.local_variable_defined?(:pry_instance)
+        Pry.toplevel_binding.eval('pry_instance.config.print = Nazar.pry_proc', __FILE__, __LINE__)
+      else
+        Pry.config.print = Nazar.pry_proc
       end
     end
 
-    def disable!
-      return unless @enabled
+    def enable_shorthand_method!
+      if Object.respond_to?(:__)
+        return warn Pastel.new.red("Already defined Object#__() method, Nazar won't redefine it.")
+      end
 
-      disable_for_irb! if defined?(IRB)
+      @defined_shorthand_method = true
 
-      @enabled = false
+      Object.class_eval do
+        def __(item)
+          Nazar::Renderer.new(item, use_generic_formatter: true).render
+        end
+      end
+    end
+
+    def disable_shorthand_method!
+      @defined_shorthand_method = nil
+
+      Object.class_eval do
+        undef_method :__
+      end
     end
 
     def disable_for_irb!
@@ -85,7 +156,11 @@ module Nazar
     end
 
     def disable_for_pry!
-      nil
+      Pry.toplevel_binding.eval(
+        'pry_instance.config.print = Nazar.instance_variable_get(:@__original_pry_print)',
+        __FILE__,
+        __LINE__
+      )
     end
   end
 end

data/nazar.gemspec

@@ -28,7 +28,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'activerecord', '>= 3.0', '< 6.2'
   spec.add_development_dependency 'rubocop', '~> 1.21'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sequel', '~> 5.0'
+  spec.add_development_dependency 'simplecov', '~> 0.20'
+  spec.add_development_dependency 'sqlite3', '~> 1.0'
 
   spec.add_runtime_dependency 'dry-configurable', '~> 0.12'
   spec.add_runtime_dependency 'pastel', '~> 0.8'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nazar
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
 platform: ruby
 authors:
 - Michał Krzyżanowski
@@ -36,7 +36,7 @@ cert_chain:
   FlwFUDGjWAe8lcsjyGp1dox0FK91TAHdZW1op8LYnOcO2DM8Mgzu4Gp7mibATEnx
   ooN2pwmH
   -----END CERTIFICATE-----
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,20 +72,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +195,10 @@ files:
 - lib/nazar/formatter/active_record_interface.rb
 - lib/nazar/formatter/active_record_item.rb
 - lib/nazar/formatter/csv_table.rb
+- lib/nazar/formatter/generic.rb
+- lib/nazar/formatter/sequel_collection.rb
+- lib/nazar/formatter/sequel_interface.rb
+- lib/nazar/formatter/sequel_item.rb
 - lib/nazar/headers_formatter.rb
 - lib/nazar/renderer.rb
 - lib/nazar/version.rb