peeky 0.0.25 → 0.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75fed761de619d444f8e84f4e08df5df41e9f12b89e95051b60dd0f60bafa57e
-  data.tar.gz: 05e1ba1ec76ffe0689f536e8e2c78c86fd16570051212ca9031ef3cf5f302e9b
+  metadata.gz: 3247c282a72d505136e9a837dfc2b834b793234fafac57d34abf01845d3573cb
+  data.tar.gz: 7687ce409a954be8b01462f707bb08f8724ed5fee649203a1ddbc3a5d22802d8
 SHA512:
-  metadata.gz: 19bb5a15dc9c0db1a5346632f448da2ff7396f247c474a89b1dee7c2097e1fdf824bce8227a35762bc85db49d4301463f613f78999a20f1656edb870e4eabb51
-  data.tar.gz: 89ae53bd7a7a840a92214337bc7a08c5e813eab892a94391cb69b2e27a0ad87546c7489f03c710f20328b770abafd3ccf45c92a5bdaf22ed0d5ffb2b93fcd2cf
+  metadata.gz: 4bdaba25fa466a29378293696530be6f8e7630e45e9d37c77016e0fe09fc5e0712b411a3c70627a21dae7e439c82d66465c09f3b08607534dbb0650ae7dd2185
+  data.tar.gz: 32a64cf623e9056e47a66861a541199d6144efdbf2551341cd4d770cce51962f4b3f5c840bda0b1d3c8545476f66c74885d7b530617246a0a4a97dfe3773f3fd

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,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.5
   DisplayCopNames: true
   ExtraDetails: true
   NewCops: enable
@@ -7,6 +8,13 @@ AllCops:
     - "lib/peeky/example/yard_sample.rb"
 
 # My Preferences - Start
+Metrics/ClassLength:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/VariableNumber:
+  Exclude:
+    - "**/spec/**/*"
 Style/EmptyMethod:    
   Exclude:
     - "**/spec/**/*"
@@ -30,9 +38,9 @@ Layout/SpaceBeforeComma:
   
 Metrics/BlockLength:
   Exclude:
-    - "**/spec/*"
+    - "**/spec/**/*"
     - "*.gemspec"
-  ExcludedMethods:
+  IgnoredMethods:
     - configure
     - context
     - define

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

@@ -7,17 +7,23 @@ gemspec
 
 group :development do
   # pry on steroids
-  gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
-  gem 'jazz_fingers'
+  # 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

@@ -30,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
 
@@ -50,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
 
@@ -58,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.
+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,17 +4,12 @@
 
 As a Ruby Developer, I should be able to Reverse engineer classes and methods, so that I can document and understand them
 
-## Development rader
+## Development radar
 
 
 ### Tasks next on list
 
-As a Developer, I can render a class with RDoc documentation, so that I do not have to manually type RDoc references
-
-- Add simplified API with examples
-- Start documenting usage instructions
-
-As a Developer, I can use Peeky with a simple API, so that I use this GEM quickly
+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
@@ -30,12 +25,6 @@ As a Developer, I can quickly build requirements, so that I can document project
 
 ### Stories - completed
 
-As a David, I can edify Karin, because she is cool
-
-- karin_is_awesome
-- i_am_very_grateful_for_karin
-- karin_the_beautiful
-
 As a Developer, I can render a class with instance attributes and methods, So that I can quickly mock out an entire class
 
 - Render: Class Interface
@@ -48,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
 
@@ -65,7 +54,14 @@ 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 - completed
+### 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)
 

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
+----------------------------------------------------------------------
+```