nazar 0.0.9 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7204b0e6f3c925d89b8d8ac8806b938fa88d73c21a8c9d7cd71236578968960a
-  data.tar.gz: 40f2762c75425f5b0be957b60ba0812f65dcb4e2fce1fbb05e4d9f4c8314c12f
+  metadata.gz: f3ea71c523b3f82b6882bdcb11b842e53b4f2283bc95d1ab5e8c0e17e2b1c9b6
+  data.tar.gz: 97017a09da4032dd35b90e34cd49cf92e96473f7c1f001a8f9ffab1c93ae6d2f
 SHA512:
-  metadata.gz: 040ab5047820966aef1db0f65478ffc581849d1d83a9f54ae39c463908c71d016f847391378b259f3098ffddc87c14ab673f1d40e5b3b5b887e162685798eff1
-  data.tar.gz: 163d9c68f8f6f0c27d2a6d4eff9f9f89924d706a69e6d2acf37285afe1599f30d35151e0728b43dbec4253b8aaab8dba5d5de716de18d62b56c032f53da90212
+  metadata.gz: cb511b109dc83d28057e6454a5d438e799cfbb0a6eb64d2f0c55ae53dd8e92c19f0c78b4a361452307e41999738972260e2b5b4b6dc347c05ddaf81e49b452bd
+  data.tar.gz: 5c0f4e67fea1a380606dd75bac52de072ac9851f70b844ee8ba1464c73592e49cde3f0449fcb208cdb912b938e067fce4a8af0a7d5f7076e244e6b78d2cfa336

data/README.md

@@ -1,9 +1,5 @@
 # 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).
-
-**Nazar is under heavy development now. Expect bumpy ride or wait until the API will stabilise a bit ;)**
-
 Turn this:
 ```ruby
 >> User.all
@@ -67,7 +63,8 @@ Then, you have to call `Nazar.enable!`. If you're using Rails, you might want to
 console do
   require 'nazar'
 
-  Nazar.enable! # see configuration section for more options
+  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.
@@ -104,11 +101,45 @@ 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 outout for <a href="https://github.com/jeremyevans/sequel/">Sequel</a> as well.
+`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:
 
@@ -117,7 +148,8 @@ You can also configure behaviour of Nazar:
 | `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
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/krzyzak/nazar.

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

@@ -18,7 +18,7 @@ module Nazar
       def self.valid?(data)
         data.is_a?(ActiveRecord::Associations::CollectionProxy) ||
           data.is_a?(ActiveRecord::Relation) ||
-          (data.is_a?(Array) && data.first.is_a?(ActiveRecord::Base))
+          (data.is_a?(Enumerable) && data.first.is_a?(ActiveRecord::Base))
       end
 
       def summary

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

@@ -13,7 +13,7 @@ module Nazar
       end
 
       def self.valid?(data)
-        data.is_a?(Array) && data.first.is_a?(Sequel::Model)
+        (data.is_a?(Enumerable) && data.first.is_a?(Sequel::Model)) || data.is_a?(Sequel::Dataset)
       end
 
       def summary

data/lib/nazar/renderer.rb

@@ -2,8 +2,9 @@
 
 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
@@ -24,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.9'
+  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,10 +25,16 @@ module Nazar
 
     private
 
-    attr_reader :data
+    attr_reader :data, :use_generic_formatter
+
+    def formatters
+      @formatters ||= Nazar.formatters.tap do |formatters|
+        formatters << Nazar::Formatter::Generic if use_generic_formatter
+      end
+    end
 
     def formatter_klass
-      @formatter_klass ||= Nazar.formatters.find { |klass| klass.valid?(data) }
+      @formatter_klass ||= formatters.find { |klass| klass.valid?(data) }
     end
 
     def formatter

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,6 +25,8 @@ 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 formatters
       @formatters ||= Set.new
@@ -32,16 +35,21 @@ module Nazar
     def enable!(extensions: [:active_record, :csv])
       return if @enabled
 
-      load_active_record! if extensions.include?(:active_record)
-      load_csv! if extensions.include?(:csv)
-      load_sequel! if extensions.include?(:sequel)
+      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!(extensions: [:active_record, :csv])
+      load_extensions!(extensions)
+      enable_shorthand_method! if Nazar.config.enable_shorthand_method
+
+      true
+    end
+
     def load_csv!
       require 'csv'
 
@@ -78,6 +86,8 @@ module Nazar
     end
 
     def disable!
+      disable_shorthand_method! if @defined_shorthand_method
+
       return unless @enabled
 
       disable_for_irb! if defined?(IRB)
@@ -88,6 +98,17 @@ module Nazar
 
     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
@@ -108,6 +129,28 @@ module Nazar
       end
     end
 
+    def enable_shorthand_method!
+      if Object.respond_to?(:__)
+        return warn Pastel.new.red("Already defined Object#__() method, Nazar won't redefine it.")
+      end
+
+      @defined_shorthand_method = true
+
+      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!
       ::IRB::Irb.send(:alias_method, :output_value, :__original_output_value__)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nazar
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.1
 platform: ruby
 authors:
 - Michał Krzyżanowski
@@ -36,7 +36,7 @@ cert_chain:
   FlwFUDGjWAe8lcsjyGp1dox0FK91TAHdZW1op8LYnOcO2DM8Mgzu4Gp7mibATEnx
   ooN2pwmH
   -----END CERTIFICATE-----
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -195,6 +195,7 @@ 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