peeky 0.0.31 → 0.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb80ec928d5d4495d464467e28bbb6b16638a14773eca16891ddbea915335a5
-  data.tar.gz: febac36ff7fa54d618d0ef6f3ef20da522b5918904c76550b823f11e1eb6ffde
+  metadata.gz: 920d6f10ed0e11acad5844cc60e290ba9e7ee85e27e801cf766e6934e6e3ea06
+  data.tar.gz: 4637e61e368dba0a5c4a9c3e8b0e8ff058b11c939ea848040eeff4a71a15e627
 SHA512:
-  metadata.gz: 4c984b3df997d970c6da34e654495802f54ce67c18bf7a057e22b56ab6f0c7b9e68579834715b09288059ac389662d5c3504ebe1aa42eee7675978b8010cb1b3
-  data.tar.gz: c2e45fbfda42652aeec5334edc8a5d596948eba45ecaa91d3a3f8522e603c39284deff97a78abc519edc0be675e29811624b7c51a2e17d48a3fe501acd9ca669
+  metadata.gz: 56c35b423fb6b786a187548d9b9fe9a1d76f47da18dd6fb53eea1143593cbcfb6ff19de8f2ac5237193b6df7250726ef73d9e3c287655ded452331f99bca05f0
+  data.tar.gz: cd58b3be796b1e185a697ac3f6dca2836154750bf856b4455e4dbd6c7224d6b629e3bd3184dd67ebd0195b0293affbb3feadfc62f9032fb07948f0b1bfafa2c0

data/.github/workflows/ruby.yml

@@ -1,6 +1,5 @@
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: Ruby
 
 on:
@@ -19,10 +18,10 @@ jobs:
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6
+        # bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Install dependencies
       run: bundle install
     - name: Run tests

data/.rubocop.yml

@@ -1,15 +1,20 @@
 AllCops:
+  TargetRubyVersion: 2.5
   DisplayCopNames: true
   ExtraDetails: true
   NewCops: enable
   Exclude:
     - "_/**/*"
-    - "lib/peeky/example/yard_sample.rb"
+    - "spec/sample/**/*"
 
 # My Preferences - Start
+Metrics/ClassLength:
+  Enabled: false
 Naming/MemoizedInstanceVariableName:
   Enabled: false
-
+Naming/VariableNumber:
+  Exclude:
+    - "**/spec/**/*"
 Style/EmptyMethod:    
   Exclude:
     - "**/spec/**/*"
@@ -33,9 +38,9 @@ Layout/SpaceBeforeComma:
   
 Metrics/BlockLength:
   Exclude:
-    - "**/spec/*"
+    - "**/spec/**/*"
     - "*.gemspec"
-  ExcludedMethods:
+  IgnoredMethods:
     - configure
     - context
     - define

data/Gemfile

@@ -5,19 +5,25 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in poc_github_ap.gemspec
 gemspec
 
-# group :development do
-#   # pry on steroids
-#   gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
-#   gem 'jazz_fingers'
-# end
+group :development do
+  # pry on steroids
+  # gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
+  # gem 'jazz_fingers'
+end
 
 group :development, :test do
-  gem 'guard-bundler'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
+  gem 'guard-bundler', '~> 3.0'
+  gem 'guard-rspec', '~> 4.0'
+  gem 'guard-rubocop', '~> 1.2'
   gem 'rake', '~> 12.0'
   # this is used for cmdlets 'self-executing gems'
   gem 'rake-compiler'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop'
+  gem 'rubocop', '~> 1.9'
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
 end
+
+# group :test do
+#   gem 'k_usecases', path: '~/dev/kgems/k_usecases'
+# end

data/Guardfile

@@ -23,8 +23,8 @@ 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
-  #   watch(%r{.+\.rb$})
-  #   watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
-  # end
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end

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:
@@ -40,7 +44,7 @@ See all [stories](./STORIES.md)
 
 ## Usage
 
-See all [usages](./USAGE.md)
+See all [usage examples](./USAGE.md)
 
 ### Basic Example
 
@@ -104,6 +108,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 +145,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 +153,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/Rakefile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+GEM_NAME = 'peeky'
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
@@ -14,3 +16,16 @@ Rake::ExtensionTask.new('peeky') do |ext|
 end
 
 task default: %i[clobber compile spec]
+
+desc 'Publish the gem to RubyGems.org'
+task :publish do
+  system 'gem build'
+  system "gem push #{GEM_NAME}-#{Peeky::VERSION}.gem"
+end
+
+desc 'Remove old *.gem files'
+task :clean do
+  system 'rm *.gem'
+end
+
+task default: %i[clobber compile spec]

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/USAGE2.md

@@ -0,0 +1,5 @@
+# Peeky
+
+This document will show you how to use Peeky.
+
+Peeky is a Ruby GEM for peaking into ruby classes and extracting meta

data/lib/peeky/api.rb

@@ -16,6 +16,9 @@ module Peeky
     # ClassInfo stores information about the instance of a
     # class that is passed in including methods, attr_accessors
     # attr_readers and attr_writers.
+    #
+    # @param instance [Object] instance of class to gather information about (required)
+    # @param lazy [TrueClass] lazy load method and parameter information, laze: is optional, defaults to true
     def build_class_info(instance, lazy: true)
       ci = Peeky::ClassInfo.new(instance)
       ci.load unless lazy
@@ -23,6 +26,14 @@ module Peeky
     end
 
     # Render a class using a predefined class renderer
+    #
+    # ^1: One of class_info and instance must supplied, they are mutually
+    # exclusive to each other.
+    #
+    # @param render_key [Symbol] class render key (required)
+    # @param class_info [Object] class_info: is optional^1, defaults to nil
+    # @param instance [Object] instance: is optional^1, defaults to nil
+    # @param _opts [<key: value>...] **_opts - list of key/values that can help configure render
     def render_class(render_key, class_info: nil, instance: nil, **_opts)
       raise 'Call render_class with class_info OR instance.' if class_info.nil? && instance.nil?
       raise 'Call render_class with class_info OR instance, these parameters are mutually exclusive' if !class_info.nil? && !instance.nil?
@@ -37,6 +48,7 @@ module Peeky
     # Get a method renderer by :key
     #
     # TODO: Refactor to a configurable system
+    # @param key [String] key is a shortcut to a specific Peeky::Render that handles method_info (required)
     def method_renderer(key)
       case key
       when :signature
@@ -53,8 +65,11 @@ module Peeky
     # Get a class renderer by :key
     #
     # TODO: Refactor to a configurable system
+    # @param key [String] key is a shortcut to a specific Peeky::Renderer that handles class_info (required)
     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/attr_info.rb

@@ -6,7 +6,9 @@ module Peeky
   # Attr Info is a container that holds read, write or read/write
   # attributes in the form of MethodInfo objects
   class AttrInfo
+    # reader stores a MethodInfo for a matching reader, nil if readable style method_info not found
     attr_reader :reader
+    # writer stores a MethodInfo for a matching writer, nil if writable style method_info not found
     attr_reader :writer
 
     def initialize(reader: nil, writer: nil)
@@ -16,6 +18,7 @@ module Peeky
       @writer = writer
     end
 
+    # Type of the attribute [:attr_writer, :attr_reader or :attr_accessor]
     def type
       @type ||= if @reader.nil?
                   :attr_writer
@@ -24,6 +27,7 @@ module Peeky
                 end
     end
 
+    # Name of the attribute
     def name
       @name ||= @reader.nil? ? @writer.clean_name : @reader.clean_name
     end

data/lib/peeky/class_info.rb

@@ -17,9 +17,33 @@ module Peeky
       @instance = instance
     end
 
+    # rubocop:disable Metrics/AbcSize
     def to_s
-      class_full_name
+      result = []
+      result.push kv('class', class_full_name)
+      if defined?(@_ruby_instance_method_names)
+        result.push kv('# of instance methods', @_ruby_instance_method_names.join(', '))
+      else
+        result.push kv('# of instance methods', '')
+      end
+      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', 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
+    # rubocop:enable Metrics/AbcSize
 
     # Load class_info
     #
@@ -30,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
 
@@ -41,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
@@ -66,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]) }
@@ -82,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
@@ -91,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
@@ -104,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
@@ -118,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
@@ -141,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
@@ -161,40 +203,28 @@ module Peeky
       signatures.select { |im| im.name == name && im.implementation_type == filter_type }
     end
 
-    # Debug
-    #
-    # Refact: PATTERN: Come up it an debug inclusion system so that
-    # so that debug helpers can be included for development and excluded
-    # for production
-    # @param format [String] format: <value for format> (optional)
-    def debug(format: [:signatures])
-      debug_method_names if format.include?(:method_names)
-
-      return unless format.include?(:signatures)
-
-      puts '-' * 70
-      puts 'Methods'
-      puts '-' * 70
-      signatures.each(&:debug)
-    end
-
-    def debug_method_names
-      puts '-' * 70
-      puts 'Method Names'
-      puts '-' * 70
-      ruby_instance_method_names.each do |method_name|
-        puts method_name
-      end
-    end
-
     private
 
+    def kv(key, value)
+      "#{key.to_s.ljust(25)}: #{value}"
+    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