peeky 0.0.42 → 0.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 920d6f10ed0e11acad5844cc60e290ba9e7ee85e27e801cf766e6934e6e3ea06
-  data.tar.gz: 4637e61e368dba0a5c4a9c3e8b0e8ff058b11c939ea848040eeff4a71a15e627
+  metadata.gz: b101eb2cf5f68f0a26a46579ddc1b87df3f8b2edbfefa9aa8301a8efe1b6f44a
+  data.tar.gz: 56e16cec9351212f107137cb1efda57c0221a8ffac84945b36a51231f66536c4
 SHA512:
-  metadata.gz: 56c35b423fb6b786a187548d9b9fe9a1d76f47da18dd6fb53eea1143593cbcfb6ff19de8f2ac5237193b6df7250726ef73d9e3c287655ded452331f99bca05f0
-  data.tar.gz: cd58b3be796b1e185a697ac3f6dca2836154750bf856b4455e4dbd6c7224d6b629e3bd3184dd67ebd0195b0293affbb3feadfc62f9032fb07948f0b1bfafa2c0
+  metadata.gz: 8bef9b277830666604a788bdc0f1dc242b5d58c15d1c44d83a58ad559fc883d6888b1fbfde996514af27b4e90729d65a69c5b49ce81df7c79685ce89f7d953b1
+  data.tar.gz: 8c650d21456723d845c994d117a30ca9a6dcb5dbc26bb35a12b50bf33805f4ba863f8de665b8265a0d58cf5ee1eb17f2aa035b00c3ba1044624661becc6e24c9

data/Guardfile

@@ -23,7 +23,7 @@ group :green_pass_then_cop, halt_on_fail: true do
     watch(%r{^lib/peeky/commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
   end
 
-  guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '-a'] do
     watch(%r{.+\.rb$})
     watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
   end

data/lib/peeky/class_info.rb

@@ -17,6 +17,20 @@ module Peeky
       @instance = instance
     end
 
+    def to_h
+      {
+        class_name: class_name,
+        module_name: module_name,
+        class_full_name: class_full_name,
+        attr_accessor: accessors.map(&:name),
+        attr_reader: readers.map(&:name),
+        attr_writer: writers.map(&:name),
+        klass: methods_to_h(class_methods),
+        instance_public: methods_to_h(public_methods),
+        instance_private: methods_to_h(private_methods)
+      }
+    end
+
     # rubocop:disable Metrics/AbcSize
     def to_s
       result = []
@@ -33,13 +47,16 @@ module Peeky
         result.push kv('# of methods', all_methods.length)
         result.push kv('# of methods - public', public_methods.length)
         result.push kv('# of methods - private', private_methods.length)
+        result.push kv('# of class methods', class_methods.length)
+
       else
-        result.push kv('# of accessors', '')
-        result.push kv('# of readers', '')
-        result.push kv('# of writers', '')
-        result.push kv('# of methods', '')
-        result.push kv('# of methods - public', '')
-        result.push kv('# of methods - private', '')
+        result.push 'Not Loaded'
+        # result.push kv('# of accessors', '')
+        # result.push kv('# of readers', '')
+        # result.push kv('# of writers', '')
+        # result.push kv('# of methods', '')
+        # result.push kv('# of methods - public', '')
+        # result.push kv('# of methods - private', '')
       end
       result.join("\n")
     end
@@ -53,8 +70,6 @@ module Peeky
     # At times during debug or other edge cases, it may be useful to
     # pre-load this information early.
     def load
-      ruby_instance_methods
-      # ruby_instance_method_names
       signatures
     end
 
@@ -71,7 +86,13 @@ module Peeky
 
     # Module name
     def module_name
-      @module_name ||= class_full_name.to_s.gsub(/(.*)::.*/, '\1')
+      return @module_name if defined? @module_name
+
+      @module_name = if class_full_name.include?('::')
+                       class_full_name.to_s.gsub(/(.*)::.*/, '\1')
+                     else
+                       ''
+                     end
     end
 
     # Get a list of :attr_accessor on the class
@@ -122,6 +143,12 @@ module Peeky
       @public_methods ||= signatures.select { |signature| signature.implementation_type == :method && signature.access_control == :public }
     end
 
+    # Get a list of class methods
+    # @return [Array<MethodInfo>] list of MethodInfo where type is :method
+    def class_methods
+      @class_methods ||= signatures.select { |signature| signature.implementation_type == :class_method }
+    end
+
     # Get a list methods ordered the way they are in the source code
     # @return [Array<MethodInfo>] list of MethodInfo
     def methods_source_order
@@ -180,9 +207,10 @@ module Peeky
       return @signatures if defined? @signatures
 
       @signatures = begin
-        instance_methods = ruby_instance_methods.map { |im| MethodInfo.new(im, @instance) }
-        private_methods  = ruby_private_methods.map  { |im| MethodInfo.new(im, @instance, access_control: :private) }
-        instance_methods + private_methods
+        instance_methods  = ruby_instance_methods.map { |im| MethodInfo.new(im, @instance) }
+        private_methods   = ruby_private_methods.map  { |im| MethodInfo.new(im, @instance, access_control: :private) }
+        class_methods     = ruby_class_methods.map    { |im| MethodInfo.new(im, @instance, implementation_type: :class_method) }
+        instance_methods + private_methods + class_methods
       end
     end
 
@@ -209,6 +237,10 @@ module Peeky
       "#{key.to_s.ljust(25)}: #{value}"
     end
 
+    def ruby_class_method_names
+      @ruby_class_method_names ||= instance.class.methods(false).sort # singleton_class.instance_methods(false).sort
+    end
+
     def ruby_instance_method_names
       @ruby_instance_method_names ||= instance.class.instance_methods(false).sort
     end
@@ -217,16 +249,40 @@ module Peeky
       @ruby_private_method_names ||= instance.private_methods(false).sort
     end
 
+    def ruby_class_methods
+      @ruby_class_methods ||= ruby_class_method_names.map { |method_name| instance.class.method(method_name) }
+    rescue StandardError => e
+      # puts 'ruby_class_methods'
+      puts e
+    end
+
     def ruby_private_methods
       @ruby_private_methods ||= ruby_private_method_names.map { |method_name| instance.method(method_name) }
     rescue StandardError => e
+      # puts 'ruby_private_methods'
       puts e
     end
 
     def ruby_instance_methods
       @ruby_instance_methods ||= ruby_instance_method_names.map { |method_name| instance.method(method_name) }
     rescue StandardError => e
+      # puts 'ruby_instance_methods'
       puts e
     end
+
+    def methods_to_h(methods)
+      methods.map do |m|
+        {
+          name: m.name,
+          paramaters: m.parameters.map do |p|
+            {
+              name: p.name,
+              type: p.type,
+              default_value: p.default_value
+            }
+          end
+        }
+      end
+    end
   end
 end

data/lib/peeky/method_info.rb

@@ -22,21 +22,21 @@ module Peeky
     #
 
     # Implementation type indicates the probable representation of this
-    # method in ruby, was it `def method` or `attr_reader` / `attr_writer`
+    # method in ruby, was it
+    # instance method         `def method`
+    # instance method reader  `attr_reader`
+    # instance method writer  `attr_writer`
+    # class method            `def self.method`
     attr_reader :implementation_type
 
-    def initialize(method, target_instance, access_control: :public)
+    def initialize(method, target_instance, implementation_type: :method, access_control: :public)
       @focal_method = method
       @target_instance = target_instance
       @access_control = access_control
+      @implementation_type = implementation_type
       @parameters = ParameterInfo.from_method(method)
-      # stage 1
-      # @implementation_type = :method
 
-      # stage 2
       infer_implementation_type
-
-      # stage 3
       infer_default_paramaters
     end
 
@@ -55,20 +55,13 @@ module Peeky
       end
     end
 
-    # Infer implementation type [:method, :attr_reader or :attr_writer]
-    # rubocop:disable Lint/DuplicateBranch
+    # Infer implementation type [:class_method, :method, :attr_reader or :attr_writer]
     def infer_implementation_type
-      @implementation_type = if @target_instance.nil?
-                               :method
-                             elsif match(Peeky::Predicates::AttrReaderPredicate)
-                               :attr_reader
-                             elsif match(Peeky::Predicates::AttrWriterPredicate)
-                               :attr_writer
-                             else
-                               :method
-                             end
+      return unless @implementation_type == :method
+
+      @implementation_type = :attr_reader if match(Peeky::Predicates::AttrReaderPredicate)
+      @implementation_type = :attr_writer if match(Peeky::Predicates::AttrWriterPredicate)
     end
-    # rubocop:enable Lint/DuplicateBranch
 
     # Get parameter by name
     #
@@ -95,13 +88,16 @@ module Peeky
     # The tests are now down to 5 seconds, but it highlights the cost of use
     # TracePoint.
     def infer_default_paramaters
-      minimalist_method = Peeky::Renderer::MethodCallMinimumParamsRender.new(self).render
+      class_name = @implementation_type == :class_method ? @target_instance.class.name : nil
+      minimalist_method = Peeky::Renderer::MethodCallMinimumParamsRender.new(self, class_name: class_name).render
 
       return if minimalist_method.end_with?('=')
       return unless optional?
 
       tracer.enable do
-        @target_instance.instance_eval(minimalist_method)
+        # TODO: minimalist method should be able to handle class methods
+        @target_instance.instance_eval(minimalist_method)       if @implementation_type == :method
+        @target_instance.class.instance_eval(minimalist_method) if @implementation_type == :class_method
       rescue StandardError => e
         # just print the error for now, we are only attempting to capture the
         # first call, any errors inside the call cannot be dealt with and should

data/lib/peeky/renderer/class_debug_render.rb

@@ -24,21 +24,9 @@ module Peeky
           output.push('')
         end
 
-        methods = render_methods(@class_info.public_methods)
-
-        if methods.length.positive?
-          output.push("-- Public Methods #{'-' * 82}")
-          output.push(*methods)
-          output.push('')
-        end
-
-        methods = render_methods(@class_info.private_methods)
-
-        if methods.length.positive?
-          output.push("-- Private Methods #{'-' * 82}")
-          output.push(*methods)
-          output.push('')
-        end
+        render_methods_with_heading(output, @class_info.public_methods, 'Public Methods')
+        render_methods_with_heading(output, @class_info.class_methods, 'Class Methods')
+        render_methods_with_heading(output, @class_info.private_methods, 'Private Methods')
 
         output.pop if output.last == ''
 
@@ -78,6 +66,16 @@ module Peeky
         @class_info.writers.map { |attr| kv('attr_writer', attr.name) }
       end
 
+      def render_methods_with_heading(output, method_list, heading)
+        methods = render_methods(method_list)
+
+        return unless methods.length.positive?
+
+        output.push("-- #{heading} #{'-' * 82}")
+        output.push(*methods)
+        output.push('')
+      end
+
       def render_methods(method_list)
         method_list.flat_map do |method|
           [

data/lib/peeky/renderer/class_interface_render.rb

@@ -2,32 +2,44 @@
 
 module Peeky
   module Renderer
-    # Render: Class Interface
+    # Render: Class Interface Example
     #
-    # Example output:
-    # class SampleClassClassInterfaceRender
-    #   attr_accessor :a
+    # class ComplexClass
+    #   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
+
+    #   def alpha_sort1;                                                                end
+    #   def alpha_sort2;                                                                end
+    #   def destructive!;                                                               end
+    #   def do_something_method;                                                        end
+    #   def method_01(aaa);                                                             end
+    #   def method_02(aaa, bbb = 1);                                                    end
+    #   def method_03(aaa, bbb = 1, ccc = 2);                                           end
+    #   def method_04(*aaa);                                                            end
+    #   def method_05(aaa, bbb = 1, *ccc);                                              end
+    #   def method_06(**aaa);                                                           end
+    #   def method_07(aaa, *bbb, ccc: 'string1', **ddd);                                end
+    #   def method_08(aaa, *bbb, **ccc, &ddd);                                          end
+    #   def method_09(aaa:);                                                            end
+    #   def method_10(aaa:, bbb: 1);                                                    end
+    #   def method_with_every_type_of_paramater(aaa, bbb = 1, *ccc, ddd:, eee: 1, **fff, &ggg);end
+    #   def questionable?;                                                              end
     #
-    #   attr_reader :b
+    #   class << self
+    #     def klass_complex(aaa, bbb = nil, *ccc, ddd:, eee: , **fff, &ggg);              end
+    #     def klass_simple(first_param);                                                  end
+    #   end
     #
-    #   attr_writer :c
+    #   private
     #
-    #   def alpha_sort1;                                                                end
-    #   def alpha_sort2;                                                                end
-    #   def d;                                                                          end
-    #   def e(aaa);                                                                     end
-    #   def f(aaa, bbb = nil);                                                          end
-    #   def g(aaa, bbb = nil, ccc = nil);                                               end
-    #   def h(*aaa);                                                                    end
-    #   def i(aaa, bbb, *ccc);                                                          end
-    #   def j(**aaa);                                                                   end
-    #   def k(aaa, *bbb, **ccc);                                                        end
-    #   def l(aaa, *bbb, **ccc, &ddd);                                                  end
-    #   def m(aaa:);                                                                    end
-    #   def n(aaa:, bbb: nil);                                                          end
-    #   def p?;                                                                         end
-    #   def q!;                                                                         end
-    #   def z(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg);                       end
+    #   def keep_me_private;                                                            end
     # end
     class ClassInterfaceRender
       # ClassInfo with information about the class instance to be rendered.
@@ -38,28 +50,27 @@ module Peeky
       end
 
       # Render the class interface
-      # rubocop:disable Metrics/AbcSize
       def render
         @indent = ''
-        output  = []
-        output.push render_start
+        @output = []
+        @output.push render_start
         @indent = '  '
-        output += render_accessors
-        output += render_readers
-        output += render_writers
-        output += render_methods(@class_info.public_methods)
-        unless @class_info.private_methods.length.zero?
-          output += ["#{@indent}private", '']
-          output += render_methods(@class_info.private_methods)
-        end
-        output.pop if output.last == ''
+
+        render_accessors
+        render_readers
+        render_writers
+
+        render_methods(@class_info.public_methods)
+        render_class_methods(@class_info.class_methods)
+        render_private_methods(@class_info.private_methods)
+
+        @output.pop if @output.last == ''
 
         @indent = ''
-        output.push render_end
+        @output.push render_end
 
-        output.join("\n")
+        @output.join("\n")
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -70,19 +81,19 @@ module Peeky
       def render_accessors
         result = @class_info.accessors.map { |attr| "#{@indent}attr_accessor :#{attr.name}" }
         result.push '' unless result.length.zero?
-        result
+        @output += result
       end
 
       def render_readers
         result = @class_info.readers.map { |attr| "#{@indent}attr_reader :#{attr.name}" }
         result.push '' unless result.length.zero?
-        result
+        @output += result
       end
 
       def render_writers
         result = @class_info.writers.map { |attr| "#{@indent}attr_writer :#{attr.name}" }
         result.push '' unless result.length.zero?
-        result
+        @output += result
       end
 
       def render_methods(method_list)
@@ -91,7 +102,25 @@ module Peeky
           "#{@indent}#{render_signature.render}"
         end
         result.push '' unless result.length.zero?
-        result
+        @output += result
+      end
+
+      def render_class_methods(methods)
+        return if methods.length.zero?
+
+        @output += ["#{@indent}class << self"]
+        @indent += '  '
+        @output += render_methods(methods)
+        @indent.delete_suffix!('  ')
+        @output.pop if @output.last == ''
+        @output += ["#{@indent}end", '']
+      end
+
+      def render_private_methods(methods)
+        return if methods.length.zero?
+
+        @output += ["#{@indent}private", '']
+        @output += render_methods(methods)
       end
 
       def render_end

data/lib/peeky/renderer/class_interface_yard_render.rb

@@ -33,26 +33,33 @@ module Peeky
 
       # Render the class interface with YARD documentation
       def render
-        output = []
-        output.push render_start
+        @output = []
+
+        render_start
         @indent += '  '
-        output += (render_accessors + render_readers + render_writers + render_methods)
-        output.pop if output.last == ''
+
+        render_accessors
+        render_readers
+        render_writers
+
+        render_public_methods
+        render_class_methods
+        render_private_methods
+
+        @output.pop if @output.last == ''
 
         @indent = @indent[0..-3]
 
-        output.push render_end
+        @output.push render_end
 
-        output.join("\n")
+        @output.join("\n")
       end
 
       private
 
       def render_start
-        [
-          "#{@indent}# #{@class_info.class_name.titleize.humanize}",
-          "#{@indent}class #{@class_info.class_name}"
-        ]
+        @output.push "#{@indent}# #{@class_info.class_name.titleize.humanize}"
+        @output.push "#{@indent}class #{@class_info.class_name}"
       end
 
       def render_accessors
@@ -63,7 +70,7 @@ module Peeky
           result.push "#{@indent}attr_accessor :#{attr.name}"
         end
         result.push '' unless result.length.zero?
-        result
+        @output += result
       end
 
       def render_readers
@@ -74,7 +81,7 @@ module Peeky
           result.push "#{@indent}attr_reader :#{attr.name}"
         end
         result.push '' unless result.length.zero?
-        result
+        @output += result
       end
 
       def render_writers
@@ -85,23 +92,40 @@ module Peeky
           result.push "#{@indent}attr_writer :#{attr.name}"
         end
         result.push '' unless result.length.zero?
-        result
+        @output += result
       end
 
-      # rubocop:disable Metics/AbcSize
-      def render_methods
+      def render_public_methods
         result = []
         class_info.public_methods.map.with_index do |method_signature, index|
           render_method(result, method_signature, index)
         end
+        result.push '' unless result.length.zero?
+        @output += result
+      end
+
+      def render_class_methods
+        return if class_info.class_methods.length.zero?
+
+        result = ["#{@indent}# Class methods", "#{@indent}class << self"]
+        @indent += '  '
+        class_info.class_methods.map.with_index do |method_signature, index|
+          render_method(result, method_signature, index)
+        end
+        @indent.delete_suffix!('  ')
+        result.push "#{@indent}end"
+
+        @output += result
+      end
+
+      def render_private_methods
+        result = []
         class_info.private_methods.map.with_index do |method_signature, index|
           result.push "\n#{indent}private\n" if index.zero?
           render_method(result, method_signature, index)
         end
-        result.push '' unless result.length.zero?
-        result
+        @output += result
       end
-      # rubocop:enable Metics/AbcSize
 
       # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       def render_method(result, method_signature, index)

data/lib/peeky/renderer/method_call_minimum_params_render.rb

@@ -13,7 +13,8 @@ module Peeky
 
       def initialize(method_signature, **opts)
         # instance_name = opts[:instance_name] || 'instance'
-        @instance_name = opts[:instance_name]
+        @instance_name    = opts[:instance_name]
+        @class_name       = opts[:class_name]
         @method_signature = method_signature
       end
 
@@ -29,11 +30,10 @@ module Peeky
 
         params = minimal_call_parameters.length.zero? ? '' : "(#{minimal_call_parameters})"
 
-        if @instance_name.nil?
-          "#{name}#{params}"
-        else
-          "#{@instance_name}.#{name}#{params}"
-        end
+        return "#{@instance_name}.#{name}#{params}" unless @instance_name.nil?
+        return "#{@class_name}.#{name}#{params}" unless @class_name.nil?
+
+        "#{name}#{params}"
       end
     end
   end

data/lib/peeky/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.42
+  version: 0.0.48
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport