peeky 0.0.31 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb80ec928d5d4495d464467e28bbb6b16638a14773eca16891ddbea915335a5
-  data.tar.gz: febac36ff7fa54d618d0ef6f3ef20da522b5918904c76550b823f11e1eb6ffde
+  metadata.gz: 2f39a9477e701fff31e203e1d90fb479cd8898662499edf4c4722673e7c0da20
+  data.tar.gz: d7a743fc208c5dbfe640c687833e3cc69b663654630cad0d15a582033f3f39f8
 SHA512:
-  metadata.gz: 4c984b3df997d970c6da34e654495802f54ce67c18bf7a057e22b56ab6f0c7b9e68579834715b09288059ac389662d5c3504ebe1aa42eee7675978b8010cb1b3
-  data.tar.gz: c2e45fbfda42652aeec5334edc8a5d596948eba45ecaa91d3a3f8522e603c39284deff97a78abc519edc0be675e29811624b7c51a2e17d48a3fe501acd9ca669
+  metadata.gz: dd1a24d91ef1fef5b72fc90f2c041112462cc842009ed68f9499f9a94cc3218ff0e2a0bc46ba4b5564487891b54d2bff023cf4deaa8af64a607f207b4f6a8e6f
+  data.tar.gz: 8fe132fffb24332d7b28b92a288b799ed51dac71df7bcfb8887bec7c6433c3b58bda9a6af05cb81dc006322b5991b6b05735760756dcef4c8919575e16155bd8

data/.rubocop.yml

@@ -9,7 +9,9 @@ AllCops:
 # My Preferences - Start
 Naming/MemoizedInstanceVariableName:
   Enabled: false
-
+Naming/VariableNumber:
+  Exclude:
+    - "**/spec/**/*"
 Style/EmptyMethod:    
   Exclude:
     - "**/spec/**/*"

data/README.md

@@ -40,7 +40,7 @@ See all [stories](./STORIES.md)
 
 ## Usage
 
-See all [usages](./USAGE.md)
+See all [usage examples](./USAGE.md)
 
 ### Basic Example
 
@@ -104,6 +104,32 @@ class SimpleClass
 end
 ```
 
+#### Class debug
+Render debug information
+
+```ruby
+puts api.render_class(:class_debug, instance: Sample::SimpleClass.new)
+```
+
+
+
+```text
+----------------------------------------------------------------------
+class name                    : SimpleClass
+module name                   : Sample
+class full name               : Sample::SimpleClass
+
+-- Attributes --------------------------------------------------------
+attr_accessor                 : read_write
+
+-- Public Methods ----------------------------------------------------
+position_and_optional::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  bbb = nil            param_optional
+```
+
 
 
 
@@ -115,7 +141,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/peeky. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/peeky. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -123,7 +149,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Peeky project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/peeky/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Peeky project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/klueless-io/peeky/blob/master/CODE_OF_CONDUCT.md).
 
 ## Copyright
 

data/USAGE.md

@@ -320,3 +320,119 @@ end
 ```
 
 #### Debug class info
+Render debug information on complex class
+
+```ruby
+puts api.render_class(:class_debug, instance: Sample::ComplexClass.new)
+```
+
+
+
+```text
+----------------------------------------------------------------------
+class name                    : ComplexClass
+module name                   : Sample
+class full name               : Sample::ComplexClass
+
+-- Attributes --------------------------------------------------------
+attr_accessor                 : a_read_write1
+attr_accessor                 : a_read_write2
+attr_reader                   : b_another_reader
+attr_reader                   : b_reader
+attr_reader                   : looks_like_an_attr_reader
+attr_writer                   : c_another_writer
+attr_writer                   : c_writer
+
+-- Public Methods ----------------------------------------------------
+alpha_sort1::
+name                 param format         type
+----------------------------------------------------------------------
+
+alpha_sort2::
+name                 param format         type
+----------------------------------------------------------------------
+
+destructive!::
+name                 param format         type
+----------------------------------------------------------------------
+
+do_something_method::
+name                 param format         type
+----------------------------------------------------------------------
+
+method_01::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+
+method_02::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  bbb = nil            param_optional
+
+method_03::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  bbb = nil            param_optional
+ccc                  ccc = nil            param_optional
+
+method_04::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  *aaa                 splat
+
+method_05::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  bbb = nil            param_optional
+ccc                  *ccc                 splat
+
+method_06::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  **aaa                double_splat
+
+method_07::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  *bbb                 splat
+ccc                  **ccc                double_splat
+
+method_08::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  *bbb                 splat
+ccc                  **ccc                double_splat
+ddd                  &ddd                 block
+
+method_09::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa:                 key_required
+
+method_10::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa:                 key_required
+bbb                  bbb: nil             key_optional
+
+method_with_every_type_of_paramater::
+name                 param format         type
+----------------------------------------------------------------------
+aaa                  aaa                  param_required
+bbb                  bbb = nil            param_optional
+ccc                  *ccc                 splat
+ddd                  ddd:                 key_required
+eee                  eee: nil             key_optional
+fff                  **fff                double_splat
+ggg                  &ggg                 block
+
+questionable?::
+name                 param format         type
+----------------------------------------------------------------------
+```

data/lib/peeky.rb

@@ -12,6 +12,7 @@ require 'peeky/parameter_info'
 require 'peeky/predicates/attr_reader_predicate'
 require 'peeky/predicates/attr_writer_predicate'
 
+require 'peeky/renderer/class_debug_render'
 require 'peeky/renderer/class_interface_render'
 require 'peeky/renderer/class_interface_yard_render'
 require 'peeky/renderer/method_call_minimum_params_render'

data/lib/peeky/api.rb

@@ -55,6 +55,8 @@ module Peeky
     # TODO: Refactor to a configurable system
     def class_renderer(key)
       case key
+      when :class_debug
+        Peeky::Renderer::ClassDebugRender
       when :class_interface
         Peeky::Renderer::ClassInterfaceRender
       when :class_interface_yard

data/lib/peeky/renderer/class_debug_render.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Peeky
+  module Renderer
+    # Class Debug Render
+    class ClassDebugRender
+      attr_reader :class_info
+
+      def initialize(class_info)
+        @key_width = 30
+        @class_info = class_info
+      end
+
+      # Render the class interface
+      # rubocop:disable Metrics/AbcSize
+      def render
+        output = []
+        output.push class_details
+        attributes = render_accessors + render_readers + render_writers
+
+        if attributes.length.positive?
+          output.push("-- Attributes #{'-' * 56}")
+          output.push(*attributes)
+          output.push('')
+        end
+
+        methods = render_methods
+
+        if methods.length.positive?
+          output.push("-- Public Methods #{'-' * 52}")
+          output.push(*methods)
+          output.push('')
+        end
+
+        output.pop if output.last == ''
+
+        output.join("\n")
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def lj(value, size = 20)
+        value.to_s.ljust(size)
+      end
+
+      def kv(key, value)
+        "#{key.to_s.ljust(@key_width)}: #{value}"
+      end
+
+      def class_details
+        [
+          '-' * 70,
+          kv('class name', @class_info.class_name),
+          kv('module name', @class_info.module_name),
+          kv('class full name', @class_info.class_full_name),
+          ''
+        ]
+      end
+
+      def render_accessors
+        @class_info.accessors.map { |attr| kv('attr_accessor', attr.name) }
+      end
+
+      def render_readers
+        @class_info.readers.map { |attr| kv('attr_reader', attr.name) }
+      end
+
+      def render_writers
+        @class_info.writers.map { |attr| kv('attr_writer', attr.name) }
+      end
+
+      def render_methods
+        @class_info.methods.flat_map do |method|
+          [
+            "#{method.name}::",
+            *render_paramaters(method.parameters),
+            ''
+          ]
+        end
+      end
+
+      def render_paramaters(parameters)
+        result = [
+          "#{lj('name')} #{lj('param format')} #{lj('type')}",
+          '-' * 70
+        ]
+
+        result + parameters.map do |param|
+          "#{lj(param.name)} #{lj(param.signature_format)} #{lj(param.type)}"
+        end
+      end
+    end
+  end
+end

data/lib/peeky/renderer/class_interface_yard_render.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# require 'active_support/core_ext'
 require 'active_support/core_ext/string'
 
 module Peeky
@@ -37,10 +36,7 @@ module Peeky
         output = []
         output.push render_start
         @indent += '  '
-        output += render_accessors
-        output += render_readers
-        output += render_writers
-        output += render_methods
+        output += (render_accessors + render_readers + render_writers + render_methods)
         output.pop if output.last == ''
 
         @indent = @indent[0..-3]

data/lib/peeky/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peeky
-  VERSION = '0.0.31'
+  VERSION = '0.0.33'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.0.33
 platform: ruby
 authors:
 - David Cruwys
@@ -65,6 +65,7 @@ files:
 - lib/peeky/parameter_info.rb
 - lib/peeky/predicates/attr_reader_predicate.rb
 - lib/peeky/predicates/attr_writer_predicate.rb
+- lib/peeky/renderer/class_debug_render.rb
 - lib/peeky/renderer/class_interface_render.rb
 - lib/peeky/renderer/class_interface_yard_render.rb
 - lib/peeky/renderer/method_call_minimum_params_render.rb