nazar 0.0.2 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f20eb7af67e1ef9f7acb2831217ce27b05f654b7f076b4c85f82910bfd1e67b7
-  data.tar.gz: 264bca42da833684146e1aeb1d711fffa7f8811055a7c785bb423e263c1a42b5
+  metadata.gz: ae9a224c9ae75c4e9b85ef48d22c97ea0c293b42aa859cc03dd4e0f31abed150
+  data.tar.gz: e2450f3e6a340c7bd6e1e239201c6bf7e7248c9e88d4e032d1e7e09be96d40aa
 SHA512:
-  metadata.gz: '0779267b1cb0b41686eda05457056b451353f54164faaa8fbd18a0dd24828fbaaf75d6ab03b7d4aa11da340abf9cc9fdfdc3eb38a2174b9e684649848cdc897a'
-  data.tar.gz: e3a44313685cb330e4ad47cdcdbeaa11e584060816ebdaa8020726be55b49be90dc04373c6d3f3c0c9d3e23d9aa3bb7b1feb8a2752de6a864a3f5634d20e51d2
+  metadata.gz: 39ed17bba483fde391edcafe72f942f7f38777f25d1baa152ddfc5121a1e2019c686f736af537e46a65e4fca6edd7a6acc02858a8d569f9bf7376b9d9e8824f3
+  data.tar.gz: 7318b8a9beb572d8a6732734b4847ea7bd2c856b32def45c91ee88034eef122026d5f340e88d40b983c106f793b1f5df0047d7d28526b192f3b916c311439f12

data/.github/workflows/main.yml

@@ -0,0 +1,42 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - name: Bundle
+        run: bundle
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle exec rubocop --format simple
+  specs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Specs
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        with:
+          coverageCommand: bundle exec rspec

data/.rubocop.yml

@@ -1,4 +1,15 @@
 AllCops:
   NewCops: enable
 Style/Documentation:
-  Enabled: false
+  Enabled: false
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/WordArray:
+  EnforcedStyle: brackets
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+Layout/CaseIndentation:
+  EnforcedStyle: end
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable

data/README.md

@@ -1,36 +1,12 @@
-# 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)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nazar`. To experiment with that code, run `bin/console` for an interactive prompt.
+Nazar improves defvault inspect output for console applications (supports IRB and Pry).
 
-TODO: Delete this and the text above, and describe your gem
+**Nazar is under heavy development now. Expect bumpy ride or wait until the API will stabilise a bit ;)**
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'nazar'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install nazar
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+[![asciicast](https://asciinema.org/a/436814.png)](https://asciinema.org/a/436814)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nazar.
+Bug reports and pull requests are welcome on GitHub at https://github.com/krzyzak/nazar.
 

data/lib/nazar/cell_formatter.rb

@@ -11,8 +11,8 @@ module Nazar
       case type
       when :boolean
         format_boolean(value)
-      when :numeric
-        Pastel.new.bright_blue(value)
+      when :integer
+        Pastel.new(enabled: Nazar.config.colors.enabled).bright_blue(value)
       else
         value.nil? ? format_nil : value.to_s
       end
@@ -26,11 +26,11 @@ module Nazar
       return format_nil if value.nil?
 
       true_value, false_value = Nazar.config.formatter.boolean
-      Formatter::TRUTHY_VALUES.include?(value) ? true_value : false_value
+      Formatter::TRUTHY_VALUES.include?(value.to_s.downcase) ? true_value : false_value
     end
 
     def format_nil
-      Pastel.new.dim(Nazar.config.formatter.nil)
+      Pastel.new(enabled: Nazar.config.colors.enabled).dim(Nazar.config.formatter.nil)
     end
   end
 end

data/lib/nazar/formatter/active_record_collection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'nazar/formatter/active_record_interface'
 
 module Nazar
@@ -8,8 +9,16 @@ module Nazar
 
       def initialize(collection)
         @collection = collection
-        @attributes = collection.first.attributes
-        @klass = collection.first.class
+        @collection.load if @collection.respond_to?(:loaded?) && !@collection.loaded?
+
+        @attributes = collection.first&.attributes
+        @klass = collection.first&.class
+      end
+
+      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))
       end
 
       def summary

data/lib/nazar/formatter/active_record_interface.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 module Nazar
   module Formatter
     module ActiveRecordInterface
       attr_reader :collection, :klass, :attributes
 
+      def valid?
+        !!(attributes && klass)
+      end
+
       def headers
         HeadersFormatter.new(attributes.keys).format
       end
@@ -16,4 +22,4 @@ module Nazar
       end
     end
   end
-end
+end

data/lib/nazar/formatter/active_record_item.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'nazar/formatter/active_record_interface'
 
 module Nazar
@@ -12,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,14 @@ module Nazar
         @collection = collection
       end
 
+      def self.valid?(data)
+        data.is_a?(CSV::Table)
+      end
+
+      def valid?
+        !!collection && !collection.empty?
+      end
+
       def headers
         HeadersFormatter.new(collection.headers).format
       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?(Array) && data.first.is_a?(Sequel::Model)
+      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/formatter.rb

@@ -2,7 +2,7 @@
 
 module Nazar
   module Formatter
-    TRUTHY_VALUES = ['true', 'yes', true].freeze
-    FALSY_VALUES = ['false', 'no', false].freeze
+    TRUTHY_VALUES = ['true', 'yes'].freeze
+    FALSY_VALUES = ['false', 'no'].freeze
   end
 end

data/lib/nazar/headers_formatter.rb

@@ -15,7 +15,7 @@ module Nazar
     attr_reader :headers
 
     def pastel
-      @pastel ||= Pastel.new
+      @pastel ||= Pastel.new(enabled: Nazar.config.colors.enabled)
     end
   end
 end

data/lib/nazar/renderer.rb

@@ -7,7 +7,12 @@ module Nazar
     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
@@ -18,10 +23,6 @@ module Nazar
 
     attr_reader :data
 
-    def render_table?
-      view.enabled?
-    end
-
     def view
       @view ||= View.new(data)
     end

data/lib/nazar/version.rb

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

data/lib/nazar/view.rb

@@ -13,13 +13,13 @@ module Nazar
     def render
       return unless supported_data?
 
-      add_summary if summary
-
-      table
+      table.tap do
+        add_summary if summary
+      end
     end
 
     def supported_data?
-      !!formatter_klass
+      !!formatter_klass && formatter.valid?
     end
 
     private
@@ -27,35 +27,16 @@ module Nazar
     attr_reader :data
 
     def formatter_klass
-      case data
-      when acttive_record_collection?
-        Formatter::ActiveRecordCollection
-      when active_record_item?
-        Formatter::ActiveRecordItem
-      when CSV::Table
-        Formatter::CSVTable
-      end
+      @formatter_klass ||= Nazar.formatters.find { |klass| klass.valid?(data) }
     end
 
     def formatter
-      formatter_klass.new(data)
-    end
-
-    def acttive_record_collection?
-      proc do
-        data.is_a?(ActiveRecord::Associations::CollectionProxy) ||
-          data.is_a?(ActiveRecord::Relation) ||
-          (data.is_a?(Array) && data.first.is_a?(ActiveRecord::Base))
-      end
-    end
-
-    def active_record_item?
-      proc { data.is_a?(ActiveRecord::Base) }
+      @formatter ||= formatter_klass.new(data)
     end
 
     def add_summary
       table.add_separator
-      table.add_row [Pastel.new.bold('Total'), { value: summary, colspan: headers.size - 1 }]
+      table.add_row [pastel.bold('Total'), { value: summary, colspan: headers.size - 1 }]
     end
 
     def table
@@ -65,5 +46,9 @@ module Nazar
         style: { border: :unicode_thick_edge }
       )
     end
+
+    def pastel
+      @pastel ||= Pastel.new(enabled: Nazar.config.colors.enabled)
+    end
   end
 end

data/lib/nazar.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_record'
-require 'csv'
 require 'dry-configurable'
 require 'terminal-table'
 require 'pastel'
@@ -12,9 +10,6 @@ require 'nazar/cell_formatter'
 require 'nazar/headers_formatter'
 require 'nazar/renderer'
 require 'nazar/formatter'
-require 'nazar/formatter/csv_table'
-require 'nazar/formatter/active_record_collection'
-require 'nazar/formatter/active_record_item'
 require 'nazar/view'
 
 module Nazar
@@ -25,44 +20,86 @@ module Nazar
     setting :boolean, default: ['✓', '✗']
   end
 
-  def self.enable!
-    return if @enabled
+  setting :colors do
+    setting :enabled, default: ENV.fetch('ENABLE_TTY_COLORS') { TTY::Color.color? ? 'true' : 'false' } == 'true'
+  end
+
+  class << self
+    def formatters
+      @formatters ||= Set.new
+    end
 
-    enable_for_irb! if defined?(IRB)
-    enable_for_pry! if defined?(Pry)
+    def enable!(extensions: [:active_record, :csv])
+      return if @enabled
 
-    @enabled = true
-  end
+      load_active_record! if extensions.include?(:active_record)
+      load_csv! if extensions.include?(:csv)
+      load_sequel! if extensions.include?(:sequel)
+
+      enable_for_irb! if defined?(IRB)
+      enable_for_pry! if defined?(Pry)
+
+      @enabled = true
+    end
+
+    def load_csv!
+      require 'csv'
+
+      register_formatter!('CSVTable', 'nazar/formatter/csv_table')
+    end
+
+    def load_active_record!
+      require 'active_record'
+
+      register_formatter!('ActiveRecordCollection', 'nazar/formatter/active_record_collection')
+      register_formatter!('ActiveRecordItem', 'nazar/formatter/active_record_item')
+    end
+
+    def load_sequel!
+      require 'sequel'
 
-  def self.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)
+      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 enable_for_irb!
+      ::IRB::Irb.class_eval do
+        alias_method :__original_output_value__, :output_value
+        def output_value(omit = false) # rubocop:disable Style/OptionalBooleanParameter
+          renderer = Nazar::Renderer.new(@context.last_value)
+          renderer.valid? ? renderer.render : __original_output_value__(omit)
+        end
       end
     end
-  end
 
-  def self.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)
+    def enable_for_pry!
+      @__original_pry_print = Pry.config.print
+      Pry.config.print = proc do |output, value, instance|
+        renderer = Nazar::Renderer.new(value)
+        renderer.valid? ? renderer.render : @__original_pry_print.call(output, value, instance)
+      end
     end
-  end
 
-  def self.disable!
-    return unless @enabled
+    def disable!
+      return unless @enabled
 
-    disable_for_irb! if defined?(IRB)
+      disable_for_irb! if defined?(IRB)
 
-    @enabled = false
-  end
+      @enabled = false
+    end
 
-  def self.disable_for_irb!
-    ::IRB::Irb.send(:alias_method, :output_value, :__original_output_value__)
-  end
+    def disable_for_irb!
+      ::IRB::Irb.send(:alias_method, :output_value, :__original_output_value__)
+    end
 
-  def self.disable_for_pry!
-    nil
+    def disable_for_pry!
+      nil
+    end
   end
 end

data/nazar.gemspec

@@ -24,11 +24,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.cert_chain  = ['certs/krzyzak.pem']
-  spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME =~ /gem\z/
 
+  spec.add_development_dependency 'activerecord', '>= 3.0', '< 6.2'
   spec.add_development_dependency 'rubocop', '~> 1.21'
+  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 'activerecord', '>= 3.0', '< 6.2'
   spec.add_runtime_dependency 'dry-configurable', '~> 0.12'
   spec.add_runtime_dependency 'pastel', '~> 0.8'
   spec.add_runtime_dependency 'terminal-table', '~> 3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nazar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.8
 platform: ruby
 authors:
 - Michał Krzyżanowski
@@ -36,8 +36,28 @@ cert_chain:
   FlwFUDGjWAe8lcsjyGp1dox0FK91TAHdZW1op8LYnOcO2DM8Mgzu4Gp7mibATEnx
   ooN2pwmH
   -----END CERTIFICATE-----
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -53,25 +73,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
-  type: :runtime
+        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: '3.0'
-    - - "<"
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +177,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -152,6 +195,9 @@ files:
 - lib/nazar/formatter/active_record_interface.rb
 - lib/nazar/formatter/active_record_item.rb
 - lib/nazar/formatter/csv_table.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