peeky 0.0.19 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17aca44d1863e4d7d811c2fdf09bbe4aec22c8aa5a2d0d09983a8d9c50f14430
-  data.tar.gz: ff605fe00998f4e7ca15725f20171180329edd882256c46eaa20c96d41491488
+  metadata.gz: 2f39a9477e701fff31e203e1d90fb479cd8898662499edf4c4722673e7c0da20
+  data.tar.gz: d7a743fc208c5dbfe640c687833e3cc69b663654630cad0d15a582033f3f39f8
 SHA512:
-  metadata.gz: e212ec6b8cb3e88e78e57f42d7a880aabf73e46cabd0b23e8d3ce93a0819a74d36f7dbf1d1af95f2677824aa885e277d003445c4d8bc656afd4e1245f8cd8d04
-  data.tar.gz: 3498282a3c71032ef6866783d06f642b7c834079d3cfae164d577a734ba5194c082b820b956bef116f7277fed19993f7833776e3fe97c1401d1485cf976e176c
+  metadata.gz: dd1a24d91ef1fef5b72fc90f2c041112462cc842009ed68f9499f9a94cc3218ff0e2a0bc46ba4b5564487891b54d2bff023cf4deaa8af64a607f207b4f6a8e6f
+  data.tar.gz: 8fe132fffb24332d7b28b92a288b799ed51dac71df7bcfb8887bec7c6433c3b58bda9a6af05cb81dc006322b5991b6b05735760756dcef4c8919575e16155bd8

data/.rubocop.yml

@@ -4,8 +4,28 @@ AllCops:
   NewCops: enable
   Exclude:
     - "_/**/*"
+    - "lib/peeky/example/yard_sample.rb"
 
 # My Preferences - Start
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/VariableNumber:
+  Exclude:
+    - "**/spec/**/*"
+Style/EmptyMethod:    
+  Exclude:
+    - "**/spec/**/*"
+Metrics/ParameterLists:
+  Exclude:
+    - "**/spec/**/*"
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - "**/spec/**/*"
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "**/spec/**/*"
+
 Style/AccessorGrouping:
   Enabled: false
 
@@ -16,6 +36,7 @@ Layout/SpaceBeforeComma:
 Metrics/BlockLength:
   Exclude:
     - "**/spec/*"
+    - "*.gemspec"
   ExcludedMethods:
     - configure
     - context

data/.rubocop_todo.yml

@@ -21,6 +21,10 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'peeky.gemspec'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'peeky.gemspec'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at david.cruwys@bugcrowd.com. All
+reported by contacting the project team at david@ideasmne.com.au. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile

@@ -5,13 +5,16 @@ 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, :test do
   gem 'guard-bundler'
   gem 'guard-rspec'
   gem 'guard-rubocop'
-  # pry on steroids
-  # gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
-  gem 'jazz_fingers'
   gem 'rake', '~> 12.0'
   # this is used for cmdlets 'self-executing gems'
   gem 'rake-compiler'

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

@@ -2,12 +2,8 @@
 
 > Peeky is a Ruby GEM for peaking into ruby classes and extracting meta
 
-Welcome to your new ruby 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/peeky`.
-
 When using the source code for this gem, start by running `bin/setup` to install locally or `bundle install`
 
-To experiment with that code, run `bin/console` for an interactive prompt or run `exe/peeky` to see a list of commands.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,17 +30,108 @@ gem install peeky
 
 As a Ruby Developer, I should be able to Reverse engineer classes and methods, so that I can document and understand them
 
-See all [stories](./README-stories.md)
+See all [stories](./STORIES.md)
 
 ### Featured Stories
 
 - As a Developer, I should be able to interrogate class instance information, so that I can reverse engineer a ruby class
-- As a Developer, I can render method with minimal parameter calls, So that I know the minimum parameters when calling a method
+- As a Developer, I can render a method with minimal parameter calls, So that I know the minimum parameters when calling a method
 - As a Developer, I can render a class with instance attributes and methods, So that I can quickly mock out an entire class
 
 ## Usage
 
-TODO: Write usage instructions here
+See all [usage examples](./USAGE.md)
+
+### Basic Example
+
+This example assumes you have this simple class
+
+
+
+```ruby
+module Sample
+  class SimpleClass
+    attr_accessor :read_write
+
+    def position_and_optional(aaa, bbb = 1)
+    end
+  end
+end      
+```
+
+
+### Rendering Examples
+
+Here a list of example renderers for the simple class
+
+#### Class interface
+Render simple class using class_interface renderer with compact formatting
+
+```ruby
+puts api.render_class(:class_interface, instance: Sample::SimpleClass.new)
+```
+
+
+
+```ruby
+class SimpleClass
+  attr_accessor :read_write
+
+  def position_and_optional(aaa, bbb = nil);                                      end
+end
+```
+
+#### Documented class interface
+Render simple class using class_interface_yard renderer to product YARD compatible documentation
+
+```ruby
+puts api.render_class(:class_interface_yard, instance: Sample::SimpleClass.new)
+```
+
+
+
+```ruby
+class SimpleClass
+  # Read write
+  attr_accessor :read_write
+
+  # Position and optional
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [String] bbb (optional)
+  def position_and_optional(aaa, bbb = nil)
+  end
+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
+```
+
+
+
 
 ## Development
 
@@ -54,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
 
@@ -62,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/{README-stories.md → STORIES.md}

@@ -4,7 +4,26 @@
 
 As a Ruby Developer, I should be able to Reverse engineer classes and methods, so that I can document and understand them
 
-## Stories
+## Development radar
+
+
+### Tasks next on list
+
+As a Developer, I can use Peeky with a simple API, so that I use Peeky quickly
+
+- Add simplified API with examples
+- Start documenting usage instructions
+
+As a Developer, I can quickly build requirements, so that I can document project features
+
+- Add support for backlog stories and tasks
+- Add usage instructions
+
+
+
+## Stories and tasks
+
+### Stories - completed
 
 As a Developer, I can render a class with instance attributes and methods, So that I can quickly mock out an entire class
 
@@ -18,7 +37,7 @@ As a Developer, I can see the method signature of a method, So that I understand
 
 - Render: Method Signature in compact format
 
-As a Developer, I can render method with minimal parameter calls, So that I know the minimum parameters when calling a method
+As a Developer, I can render a method with minimal parameter calls, So that I know the minimum parameters when calling a method
 
 - Render: Simple instance method calls with minimum parameters
 
@@ -35,15 +54,20 @@ As a Developer, I should be able to interrogate class instance information, so t
 - ClassInfo stores information about a ruby class. Only support instance methods
 
 
-## Tasks
+### Tasks - completed
+
+As a Developer, I can render a class with RDoc documentation, so that I do not have to manually type RDoc references
 
 
+As a Developer, I can read detailed API documentation on Peaky, so that I use Peeky quickly
+
+- Acid Test: Use the YARD renderer to document Peaky the GEM
+
 Setup GitHub Action (test and lint)
 
 - Setup Rspec action
 - Setup RuboCop action
 
-
 Setup new Ruby GEM
 
 - Build out a standard GEM structure

data/USAGE.md

@@ -0,0 +1,438 @@
+# Peeky
+
+> Peeky is a Ruby GEM for peaking into ruby classes and extracting meta
+
+As a Ruby Developer, I should be able to Reverse engineer classes and methods, so that I can document and understand them
+
+## Usage
+
+### Sample Classes
+
+The usage examples listed below will work with these sample classes
+
+#### Simple example
+
+
+```ruby
+module Sample
+  class SimpleClass
+    attr_accessor :read_write
+
+    def position_and_optional(aaa, bbb = 1)
+    end
+  end
+end      
+```
+
+#### Complex example
+
+
+```ruby
+module Sample
+  class ComplexClass
+    attr_accessor :a_read_write1, :a_read_write2
+    attr_reader   :b_reader, :b_another_reader
+    attr_writer   :c_writer, :c_another_writer
+
+    def do_something_method
+    end
+
+    def looks_like_an_attr_reader
+      @looks_like_an_attr_reader ||= 5
+    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); end
+
+    def method_08(aaa, *bbb, **ccc, &ddd); end
+
+    def method_09(aaa:); end
+
+    def method_10(aaa:, bbb: 1); end
+
+    def questionable?; end
+
+    def destructive!; end
+
+    def method_with_every_type_of_paramater(aaa, bbb = 1, *ccc, ddd:, eee: 1, **fff, &ggg); end
+
+    # Check that methods are sorted
+    def alpha_sort2;                                        end
+    def alpha_sort1;                                        end
+  end
+end      
+```
+
+
+### Build Class Information
+
+Use build_class_info to extract meta data from a ruby class
+
+#### Build ClassInfo
+By default information is lazy loaded only when accessed
+
+
+```ruby
+class_info = api.build_class_info(Sample::SimpleClass.new)
+
+puts class_info
+```
+
+
+
+```shell
+Sample::SimpleClass
+```
+
+#### Build ClassInfo - pre-loaded
+Pre-load will ensure that methods and parameters are loaded straight away.
+
+
+```ruby
+class_info = api.build_class_info(Sample::ComplexClass.new, lazy: false)
+
+puts class_info
+```
+
+
+
+```shell
+Sample::ComplexClass
+```
+
+
+### Render Class
+
+Render a class using a pre-defined class renderer that can be referenced by key
+
+#### Render class interface using class_info
+Render a basic class interface in compact format "One line per method".
+
+Note: Modules are not yet supported in Peeky
+
+
+```ruby
+class_info = api.build_class_info(Sample::SimpleClass.new)
+
+puts api.render_class(:class_interface, class_info: class_info)
+```
+
+#### Render class interface using an instance of the intended class
+
+
+```ruby
+puts api.render_class(:class_interface, instance: Sample::SimpleClass.new)
+```
+
+
+### Render Class Examples
+
+Here a list of example renderers for the complex class
+
+#### Class interface
+Render simple class using class_interface renderer
+
+```ruby
+puts api.render_class(:class_interface, instance: Sample::SimpleClass.new)
+```
+
+
+
+```ruby
+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 = nil);                                                  end
+  def method_03(aaa, bbb = nil, ccc = nil);                                       end
+  def method_04(*aaa);                                                            end
+  def method_05(aaa, bbb = nil, *ccc);                                            end
+  def method_06(**aaa);                                                           end
+  def method_07(aaa, *bbb, **ccc);                                                end
+  def method_08(aaa, *bbb, **ccc, &ddd);                                          end
+  def method_09(aaa:);                                                            end
+  def method_10(aaa:, bbb: nil);                                                  end
+  def method_with_every_type_of_paramater(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg);end
+  def questionable?;                                                              end
+end
+```
+
+#### Class interface - YARD
+Render complex class using class_interface_yard renderer
+
+```ruby
+puts api.render_class(:class_interface_yard, instance: Sample::ComplexClass.new)
+```
+
+
+
+```ruby
+class ComplexClass
+  # A read write1
+  attr_accessor :a_read_write1
+
+  # A read write2
+  attr_accessor :a_read_write2
+
+  # B another reader
+  attr_reader :b_another_reader
+
+  # B reader
+  attr_reader :b_reader
+
+  # Looks like an attr reader
+  attr_reader :looks_like_an_attr_reader
+
+  # C another writer
+  attr_writer :c_another_writer
+
+  # C writer
+  attr_writer :c_writer
+
+  # Alpha sort1
+  def alpha_sort1
+  end
+
+  # Alpha sort2
+  def alpha_sort2
+  end
+
+  # Destructive!
+  def destructive!
+  end
+
+  # Do something method
+  def do_something_method
+  end
+
+  # Method 01
+  #
+  # @param aaa [String] aaa (required)
+  def method_01(aaa)
+  end
+
+  # Method 02
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [String] bbb (optional)
+  def method_02(aaa, bbb = nil)
+  end
+
+  # Method 03
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [String] bbb (optional)
+  # @param ccc [String] ccc (optional)
+  def method_03(aaa, bbb = nil, ccc = nil)
+  end
+
+  # Method 04
+  #
+  # @param aaa [Array<Object>] *aaa - list of aaa
+  def method_04(*aaa)
+  end
+
+  # Method 05
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [String] bbb (optional)
+  # @param ccc [Array<Object>] *ccc - list of ccc
+  def method_05(aaa, bbb = nil, *ccc)
+  end
+
+  # Method 06
+  #
+  # @param aaa [<key: value>...] **aaa - list of key/values
+  def method_06(**aaa)
+  end
+
+  # Method 07
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [Array<Object>] *bbb - list of bbb
+  # @param ccc [<key: value>...] **ccc - list of key/values
+  def method_07(aaa, *bbb, **ccc)
+  end
+
+  # Method 08
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [Array<Object>] *bbb - list of bbb
+  # @param ccc [<key: value>...] **ccc - list of key/values
+  # @param ddd [Block] &ddd
+  def method_08(aaa, *bbb, **ccc, &ddd)
+  end
+
+  # Method 09
+  #
+  # @param aaa [String] aaa: <value for aaa> (required)
+  def method_09(aaa:)
+  end
+
+  # Method 10
+  #
+  # @param aaa [String] aaa: <value for aaa> (required)
+  # @param bbb [String] bbb: <value for bbb> (optional)
+  def method_10(aaa:, bbb: nil)
+  end
+
+  # Method with every type of paramater
+  #
+  # @param aaa [String] aaa (required)
+  # @param bbb [String] bbb (optional)
+  # @param ccc [Array<Object>] *ccc - list of ccc
+  # @param ddd [String] ddd: <value for ddd> (required)
+  # @param eee [String] eee: <value for eee> (optional)
+  # @param fff [<key: value>...] **fff - list of key/values
+  # @param ggg [Block] &ggg
+  def method_with_every_type_of_paramater(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg)
+  end
+
+  # Questionable?
+  #
+  # @return [Boolean] true when questionable?
+  def questionable?
+  end
+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
+----------------------------------------------------------------------
+```