peeky 0.0.40 → 0.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08eb3e66afafe6b6af1896abb030457b6bd417ddaed97311f174b30458805146'
-  data.tar.gz: 587f9afee745e58ee2783aa80d23c482a096ad8f96b8d50cbe9a1683b5f23188
+  metadata.gz: 920d6f10ed0e11acad5844cc60e290ba9e7ee85e27e801cf766e6934e6e3ea06
+  data.tar.gz: 4637e61e368dba0a5c4a9c3e8b0e8ff058b11c939ea848040eeff4a71a15e627
 SHA512:
-  metadata.gz: 2cf0854c592886fc801068f7bf3bb310bcbb8db1b343be375e1b4ad82ab574fba783697bdce642358747784a247ba4b1ee49885a6737662866568f1e550e71f8
-  data.tar.gz: 6a77ec688a91339da22a3f7c7c58e2ea7b9f8f7c99ec19e1998673484c4e197a2291d207c34fc42ab64d288055cc3b50e827a32659a39c1ee48aa7b758cb0e9c
+  metadata.gz: 56c35b423fb6b786a187548d9b9fe9a1d76f47da18dd6fb53eea1143593cbcfb6ff19de8f2ac5237193b6df7250726ef73d9e3c287655ded452331f99bca05f0
+  data.tar.gz: cd58b3be796b1e185a697ac3f6dca2836154750bf856b4455e4dbd6c7224d6b629e3bd3184dd67ebd0195b0293affbb3feadfc62f9032fb07948f0b1bfafa2c0

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - "_/**/*"
-    - "lib/peeky/example/yard_sample.rb"
+    - "spec/sample/**/*"
 
 # My Preferences - Start
 Metrics/ClassLength:

data/README.md

@@ -4,6 +4,10 @@
 
 When using the source code for this gem, start by running `bin/setup` to install locally or `bundle install`
 
+## TODO
+
+@klueless-io - look at [show-source](https://stackoverflow.com/questions/13012109/get-class-location-from-class-object)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/peeky/class_info.rb

@@ -26,16 +26,20 @@ module Peeky
       else
         result.push kv('# of instance methods', '')
       end
-      if defined?(@_signatures)
+      if defined?(@signatures)
         result.push kv('# of accessors', accessors.length)
         result.push kv('# of readers', readers.length)
         result.push kv('# of writers', writers.length)
-        result.push kv('# of methods', methods.length)
+        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)
       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', '')
       end
       result.join("\n")
     end
@@ -50,7 +54,7 @@ module Peeky
     # pre-load this information early.
     def load
       ruby_instance_methods
-      ruby_instance_method_names
+      # ruby_instance_method_names
       signatures
     end
 
@@ -61,19 +65,19 @@ module Peeky
 
     # Class name
     def class_name
-      @_class_name ||= class_full_name.to_s.gsub(/^.*::/, '')
+      @class_name ||= class_full_name.to_s.gsub(/^.*::/, '')
       # instance.class.name.split('::').last
     end
 
     # Module name
     def module_name
-      @_module_name ||= class_full_name.to_s.gsub(/(.*)::.*/, '\1')
+      @module_name ||= class_full_name.to_s.gsub(/(.*)::.*/, '\1')
     end
 
     # Get a list of :attr_accessor on the class
     # @return [Array<AttrInfo>] list of AttrInfo where type is :attr_accessor
     def accessors
-      @_accessors ||= attribute_infos.select { |attribute_info| attribute_info.type == :attr_accessor }
+      @accessors ||= attribute_infos.select { |attribute_info| attribute_info.type == :attr_accessor }
     end
 
     # Get a list of :attr_accessors ordered the way they are in the source code
@@ -86,7 +90,7 @@ module Peeky
 
     # Attribute infos
     def attribute_infos
-      @_attribute_infos ||= begin
+      @attribute_infos ||= begin
         grouped_method_infos = signatures.select { |signature| signature.readable? || signature.writable? }.group_by(&:clean_name)
 
         grouped_method_infos.keys.map { |key| AttrInfo.create(*grouped_method_infos[key]) }
@@ -102,8 +106,20 @@ module Peeky
 
     # Get a list methods
     # @return [Array<MethodInfo>] list of MethodInfo where type is :method
-    def methods
-      @_methods ||= signatures.select { |signature| signature.implementation_type == :method }
+    def all_methods
+      @all_methods ||= signatures.select { |signature| signature.implementation_type == :method }
+    end
+
+    # Get a list of private methods
+    # @return [Array<MethodInfo>] list of MethodInfo where type is :method
+    def private_methods
+      @private_methods ||= signatures.select { |signature| signature.implementation_type == :method && signature.access_control == :private }
+    end
+
+    # Get a list of public methods
+    # @return [Array<MethodInfo>] list of MethodInfo where type is :method
+    def public_methods
+      @public_methods ||= signatures.select { |signature| signature.implementation_type == :method && signature.access_control == :public }
     end
 
     # Get a list methods ordered the way they are in the source code
@@ -111,7 +127,7 @@ module Peeky
     def methods_source_order
       # TODO: This feature is required
       # May be best to have a sort object that can be created for each type of ordering that is needed
-      methods
+      all_methods
     end
 
     # Reader by name
@@ -124,7 +140,7 @@ module Peeky
     # Get a list of :attr_reader on the class
     # @return [Array<AttrInfo>] list of AttrInfo where type is :attr_accessor
     def readers
-      @_readers ||= attribute_infos.select { |attribute_info| attribute_info.type == :attr_reader }
+      @readers ||= attribute_infos.select { |attribute_info| attribute_info.type == :attr_reader }
     end
 
     # Get a list of :attr_reader ordered the way they are in the source code
@@ -138,7 +154,7 @@ module Peeky
     # Get a list of :attr_writer on the class
     # @return [Array<AttrInfo>] list of AttrInfo where type is :attr_writer
     def writers
-      @_writers ||= attribute_infos.select { |attribute_info| attribute_info.type == :attr_writer }
+      @writers ||= attribute_infos.select { |attribute_info| attribute_info.type == :attr_writer }
     end
 
     # Get a list of :attr_writer ordered the way they are in the source code
@@ -161,7 +177,13 @@ module Peeky
     #         such as static, private vs public
     #         deep, deep_to_level, this_instance.
     def signatures
-      @_signatures ||= ruby_instance_methods.map { |im| MethodInfo.new(im, @instance) }
+      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
+      end
     end
 
     # Signatures by clean name
@@ -188,11 +210,21 @@ module Peeky
     end
 
     def ruby_instance_method_names
-      @_ruby_instance_method_names ||= instance.class.instance_methods(false).sort
+      @ruby_instance_method_names ||= instance.class.instance_methods(false).sort
+    end
+
+    def ruby_private_method_names
+      @ruby_private_method_names ||= instance.private_methods(false).sort
+    end
+
+    def ruby_private_methods
+      @ruby_private_methods ||= ruby_private_method_names.map { |method_name| instance.method(method_name) }
+    rescue StandardError => e
+      puts e
     end
 
     def ruby_instance_methods
-      @_ruby_instance_methods ||= ruby_instance_method_names.map { |method_name| instance.method(method_name) }
+      @ruby_instance_methods ||= ruby_instance_method_names.map { |method_name| instance.method(method_name) }
     rescue StandardError => e
       puts e
     end

data/lib/peeky/method_info.rb

@@ -14,6 +14,8 @@ module Peeky
     # MethodInfo delegates to the underlying ruby method object
     attr_reader :focal_method
 
+    attr_reader :access_control
+
     def_delegators :focal_method, :name, :receiver, :arity, :super_method
 
     ## Stage 2 is the method likely to be an attribute reader or writer
@@ -23,9 +25,10 @@ module Peeky
     # method in ruby, was it `def method` or `attr_reader` / `attr_writer`
     attr_reader :implementation_type
 
-    def initialize(method, target_instance)
+    def initialize(method, target_instance, access_control: :public)
       @focal_method = method
       @target_instance = target_instance
+      @access_control = access_control
       @parameters = ParameterInfo.from_method(method)
       # stage 1
       # @implementation_type = :method

data/lib/peeky/predicates/attr_reader_predicate.rb

@@ -32,7 +32,12 @@ module Peeky
         cloned = instance.clone
 
         cloned.instance_eval(code)
-        current_value = cloned.send(method_name)
+        begin
+          current_value = cloned.send(method_name)
+        rescue StandardError #=> exception
+          current_value = nil
+        end
+
         current_value == new_value
       end
 

data/lib/peeky/renderer/class_debug_render.rb

@@ -24,7 +24,7 @@ module Peeky
           output.push('')
         end
 
-        methods = render_methods
+        methods = render_methods(@class_info.public_methods)
 
         if methods.length.positive?
           output.push("-- Public Methods #{'-' * 82}")
@@ -32,6 +32,14 @@ module Peeky
           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
+
         output.pop if output.last == ''
 
         output.join("\n")
@@ -70,10 +78,10 @@ module Peeky
         @class_info.writers.map { |attr| kv('attr_writer', attr.name) }
       end
 
-      def render_methods
-        @class_info.methods.flat_map do |method|
+      def render_methods(method_list)
+        method_list.flat_map do |method|
           [
-            "#{method.name}::",
+            "[ #{method.name} ]",
             *render_paramaters(method.parameters),
             ''
           ]

data/lib/peeky/renderer/class_interface_render.rb

@@ -38,15 +38,20 @@ module Peeky
       end
 
       # Render the class interface
+      # rubocop:disable Metrics/AbcSize
       def render
         @indent = ''
-        output = []
+        output  = []
         output.push render_start
         @indent = '  '
         output += render_accessors
         output += render_readers
         output += render_writers
-        output += render_methods
+        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 == ''
 
         @indent = ''
@@ -54,6 +59,7 @@ module Peeky
 
         output.join("\n")
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -79,8 +85,8 @@ module Peeky
         result
       end
 
-      def render_methods
-        result = @class_info.methods.map do |method_signature|
+      def render_methods(method_list)
+        result = method_list.map do |method_signature|
           render_signature = Peeky::Renderer::MethodSignatureRender.new(method_signature)
           "#{@indent}#{render_signature.render}"
         end

data/lib/peeky/renderer/class_interface_yard_render.rb

@@ -88,51 +88,61 @@ module Peeky
         result
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/BlockLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      # rubocop:disable Metics/AbcSize
       def render_methods
         result = []
-        class_info.methods.map.with_index do |method_signature, index|
-          result.push '' if index.positive?
-          result.push "#{@indent}# #{method_signature.name.to_s.humanize}"
-
-          method_signature.parameters.each_with_index do |parameter, param_index|
-            result.push "#{@indent}#" if param_index.zero?
-
-            case parameter.type
-            when :splat
-              result.push "#{@indent}# @param #{parameter.name} [Array<#{default_splat_param_type}>] *#{parameter.name} - list of #{parameter.name.to_s.humanize.downcase}"
-            when :double_splat
-              result.push "#{@indent}# @param #{parameter.name} [<key: value>...] **#{parameter.name} - list of key/values"
-            when :block
-              result.push "#{@indent}# @param #{parameter.name} [Block] &#{parameter.name}"
-            when :key_required
-              result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name}: <value for #{parameter.name.to_s.humanize.downcase}> (required)"
-            when :key_optional
-              result.push "#{@indent}# @param #{parameter.name} [#{parameter.default_value_type}] #{parameter.name}: is optional, defaults to #{parameter.wrap_default_value('nil')}"
-            when :param_required
-              result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase} (required)"
-            when :param_optional
-              result.push "#{@indent}# @param #{parameter.name} [#{parameter.default_value_type}] #{parameter.name} is optional, defaults to #{parameter.wrap_default_value('nil')}"
-              # result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase} (optional)"
-            else
-              result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase}"
-            end
-          end
-
-          if method_signature.name.to_s.end_with?('?')
-            result.push ''
-            result.push "#{@indent}# @return [Boolean] true when #{method_signature.name.to_s.humanize.downcase}"
-          end
-
-          render_signature = Peeky::Renderer::MethodSignatureRender.new(method_signature)
-          render_signature.indent = @indent
-          render_signature.style = :default
-          result.push render_signature.render
+        class_info.public_methods.map.with_index do |method_signature, index|
+          render_method(result, method_signature, index)
+        end
+        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
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/BlockLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      # rubocop:enable Metics/AbcSize
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def render_method(result, method_signature, index)
+        result.push '' if index.positive?
+        result.push "#{@indent}# #{method_signature.name.to_s.humanize}"
+
+        method_signature.parameters.each_with_index do |parameter, param_index|
+          result.push "#{@indent}#" if param_index.zero?
+
+          case parameter.type
+          when :splat
+            result.push "#{@indent}# @param #{parameter.name} [Array<#{default_splat_param_type}>] *#{parameter.name} - list of #{parameter.name.to_s.humanize.downcase}"
+          when :double_splat
+            result.push "#{@indent}# @param #{parameter.name} [<key: value>...] **#{parameter.name} - list of key/values"
+          when :block
+            result.push "#{@indent}# @param #{parameter.name} [Block] &#{parameter.name}"
+          when :key_required
+            result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name}: <value for #{parameter.name.to_s.humanize.downcase}> (required)"
+          when :key_optional
+            result.push "#{@indent}# @param #{parameter.name} [#{parameter.default_value_type}] #{parameter.name}: is optional, defaults to #{parameter.wrap_default_value('nil')}"
+          when :param_required
+            result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase} (required)"
+          when :param_optional
+            result.push "#{@indent}# @param #{parameter.name} [#{parameter.default_value_type}] #{parameter.name} is optional, defaults to #{parameter.wrap_default_value('nil')}"
+            # result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase} (optional)"
+          else
+            result.push "#{@indent}# @param #{parameter.name} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase}"
+          end
+        end
+
+        if method_signature.name.to_s.end_with?('?')
+          result.push ''
+          result.push "#{@indent}# @return [Boolean] true when #{method_signature.name.to_s.humanize.downcase}"
+        end
+
+        render_signature = Peeky::Renderer::MethodSignatureRender.new(method_signature)
+        render_signature.indent = @indent
+        render_signature.style = :default
+        result.push render_signature.render
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       def render_end
         "#{@indent}end"

data/lib/peeky/version.rb

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

data/lib/peeky.rb

@@ -24,4 +24,9 @@ module Peeky
   # Your code goes here...
 end
 
-puts "Peeky::Version: #{Peeky::VERSION}" if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+  namespace = 'Peeky::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('peeky/version') }
+  version   = Peeky::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.40
+  version: 0.0.42
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,7 +59,6 @@ files:
 - lib/peeky/api.rb
 - lib/peeky/attr_info.rb
 - lib/peeky/class_info.rb
-- lib/peeky/example/yard_sample.rb
 - lib/peeky/method_info.rb
 - lib/peeky/parameter_info.rb
 - lib/peeky/predicates/attr_reader_predicate.rb

data/lib/peeky/example/yard_sample.rb

@@ -1,146 +0,0 @@
-module Peeky
-  module Example
-    # Yard sample
-    class YardSample
-      # A read write1
-      attr_accessor :a_read_write1
-
-      # A read write2
-      attr_accessor :a_read_write2
-
-      # A read write3
-      attr_accessor :a_read_write3
-
-      # B reader1
-      attr_reader :b_reader1
-
-      # B reader2
-      attr_reader :b_reader2
-
-      # E looks like an attr reader
-      attr_reader :e_looks_like_an_attr_reader
-
-      # C writer1
-      attr_writer :c_writer1
-
-      # C writer2
-      attr_writer :c_writer2
-
-      # Alpha sort1
-      def alpha_sort1
-      end
-
-      # Alpha sort2
-      def alpha_sort2
-      end
-
-      # D do something method
-      def d_do_something_method
-      end
-
-      # E method with required param
-      #
-      # @param first_name [String] first name (required)
-      def e_method_with_required_param(first_name)
-      end
-
-      # F method with required param and optional param
-      #
-      # @param first_name [String] first name (required)
-      # @param last_name [String] last_name is optional, defaults to ''
-      def f_method_with_required_param_and_optional_param(first_name, last_name = '')
-      end
-
-      # G method with required param and two optional params
-      #
-      # @param first_name [String] first name (required)
-      # @param last_name [String] last_name is optional, defaults to ''
-      # @param age [Integer] age is optional, defaults to 21
-      def g_method_with_required_param_and_two_optional_params(first_name, last_name = '', age = 21)
-      end
-
-      # H list of optional parameters
-      #
-      # @param command_args [Array<Object>] *command_args - list of command args
-      def h_list_of_optional_parameters(*command_args)
-      end
-
-      # I method with two required params and list of optional params
-      #
-      # @param first_name [String] first name (required)
-      # @param last_name [String] last name (required)
-      # @param alias_names [Array<Object>] *alias_names - list of alias names
-      def i_method_with_two_required_params_and_list_of_optional_params(first_name, last_name, *alias_names)
-      end
-
-      # J method with list of named arguments
-      #
-      # @param options [<key: value>...] **options - list of key/values
-      def j_method_with_list_of_named_arguments(**options)
-      end
-
-      # Jin
-      #
-      # @param aaa [String] aaa (required)
-      def jin(aaa)
-      end
-
-      # K method with block
-      #
-      # @param code_block [Block] &code_block
-      def k_method_with_block(&code_block)
-      end
-
-      # L method with key value param required
-      #
-      # @param name [String] name: <value for name> (required)
-      def l_method_with_key_value_param_required(name:)
-      end
-
-      # N method with key value param required and optional key value
-      #
-      # @param last_name [String] last_name: <value for last name> (required)
-      # @param salutation [String] salutation: is optional, defaults to 'Mr'
-      def n_method_with_key_value_param_required_and_optional_key_value(last_name:, salutation: 'Mr')
-      end
-
-      # P available?
-
-      # @return [Boolean] true when p available?
-      def p_available?
-      end
-
-      # Q danger will robinson!
-      def q_danger_will_robinson!
-      end
-
-      # Z complex
-      #
-      # @param aaa [String] aaa (required)
-      # @param bbb [Integer] bbb is optional, defaults to 1
-      # @param ccc [Array<Object>] *ccc - list of ccc
-      # @param ddd [String] ddd: <value for ddd> (required)
-      # @param eee [Integer] eee: is optional, defaults to 1
-      # @param fff [<key: value>...] **fff - list of key/values
-      # @param ggg [Block] &ggg
-      def z_complex(aaa, bbb = 1, *ccc, ddd:, eee: 1, **fff, &ggg)
-      end
-
-      # Z optional styles
-      #
-      # @param aaa [String] aaa (required)
-      # @param bbb [Integer] bbb is optional, defaults to 123
-      # @param ccc [String] ccc is optional, defaults to 'abc'
-      # @param ddd [TrueClass] ddd is optional, defaults to true
-      # @param eee [FalseClass] eee is optional, defaults to false
-      # @param fff [Object] fff is optional, defaults to nil
-      # @param ggg [Integer] ggg: is optional, defaults to 123
-      # @param hhh [String] hhh: is optional, defaults to 'xyz'
-      # @param iii [TrueClass] iii: is optional, defaults to true
-      # @param jjj [FalseClass] jjj: is optional, defaults to false
-      # @param kkk [Object] kkk: is optional, defaults to nil
-      def z_optional_styles(aaa, bbb = 123, ccc = 'abc', ddd = true, eee = false, fff = nil, ggg: 123, hhh: 'xyz', iii: true, jjj: false, kkk: )
-      end
-    end
-  end
-end