peeky 0.0.31 → 0.0.42

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.0.42
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,10 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-    Peeky is a Ruby GEM for peaking into ruby classes and extracting meta data.
-    You can use this meta data to recreate classes, interfaces, documentation etc.
-    or use it just to understand the internals of a class.
+description: peeky
 email:
 - david@ideasmen.com.au
 executables: []
@@ -35,6 +32,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - STORIES.md
+- USAGE.md
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -49,6 +47,7 @@ files:
 - Rakefile
 - STORIES.md
 - USAGE.md
+- USAGE2.md
 - bin/console
 - bin/k
 - bin/kgitsync
@@ -60,11 +59,11 @@ 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
 - lib/peeky/predicates/attr_writer_predicate.rb
+- lib/peeky/renderer/class_debug_render.rb
 - lib/peeky/renderer/class_interface_render.rb
 - lib/peeky/renderer/class_interface_yard_render.rb
 - lib/peeky/renderer/method_call_minimum_params_render.rb
@@ -93,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.7
 signing_key:
 specification_version: 4
 summary: Take a peek into your ruby classes and extract useful meta data

data/lib/peeky/example/yard_sample.rb

@@ -1,124 +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 (optional)
-      def f_method_with_required_param_and_optional_param(first_name, last_name = nil)
-      end
-
-      # G method with required param and two optional params
-      #
-      # @param first_name [String] first name (required)
-      # @param last_name [String] last name (optional)
-      # @param age [String] age (optional)
-      def g_method_with_required_param_and_two_optional_params(first_name, last_name = nil, age = nil)
-      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
-
-      # 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: <value for salutation> (optional)
-      def n_method_with_key_value_param_required_and_optional_key_value(last_name:, salutation: nil)
-      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 [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 z_complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg)
-      end
-    end
-  end
-end