peeky 0.0.27 → 0.0.40

data/lib/peeky/renderer/class_debug_render.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Peeky
+  module Renderer
+    # Class Debug Render
+    class ClassDebugRender
+      attr_reader :class_info
+
+      def initialize(class_info)
+        @key_width = 30
+        @class_info = class_info
+      end
+
+      # Render the class interface
+      # rubocop:disable Metrics/AbcSize
+      def render
+        output = []
+        output.push class_details
+        attributes = render_accessors + render_readers + render_writers
+
+        if attributes.length.positive?
+          output.push("-- Attributes #{'-' * 86}")
+          output.push(*attributes)
+          output.push('')
+        end
+
+        methods = render_methods
+
+        if methods.length.positive?
+          output.push("-- Public Methods #{'-' * 82}")
+          output.push(*methods)
+          output.push('')
+        end
+
+        output.pop if output.last == ''
+
+        output.join("\n")
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def lj(value, size = 24)
+        value.to_s.ljust(size)
+      end
+
+      def kv(key, value)
+        "#{key.to_s.ljust(@key_width)}: #{value}"
+      end
+
+      def class_details
+        [
+          '-' * 100,
+          kv('class name', @class_info.class_name),
+          kv('module name', @class_info.module_name),
+          kv('class full name', @class_info.class_full_name),
+          ''
+        ]
+      end
+
+      def render_accessors
+        @class_info.accessors.map { |attr| kv('attr_accessor', attr.name) }
+      end
+
+      def render_readers
+        @class_info.readers.map { |attr| kv('attr_reader', attr.name) }
+      end
+
+      def render_writers
+        @class_info.writers.map { |attr| kv('attr_writer', attr.name) }
+      end
+
+      def render_methods
+        @class_info.methods.flat_map do |method|
+          [
+            "#{method.name}::",
+            *render_paramaters(method.parameters),
+            ''
+          ]
+        end
+      end
+
+      def render_paramaters(parameters)
+        result = [
+          "#{lj('name')} #{lj('param format')} #{lj('type')} #{lj('default')}",
+          '-' * 100
+        ]
+
+        result + parameters.map do |param|
+          "#{lj(param.name)} #{lj(param.signature_format)} #{lj(param.type)} #{lj(param.default_value)}"
+        end
+      end
+    end
+  end
+end

data/lib/peeky/renderer/class_interface_yard_render.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# require 'active_support/core_ext'
 require 'active_support/core_ext/string'
 
 module Peeky
@@ -37,10 +36,7 @@ module Peeky
         output = []
         output.push render_start
         @indent += '  '
-        output += render_accessors
-        output += render_readers
-        output += render_writers
-        output += render_methods
+        output += (render_accessors + render_readers + render_writers + render_methods)
         output.pop if output.last == ''
 
         @indent = @indent[0..-3]
@@ -112,17 +108,21 @@ module Peeky
             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} [#{default_param_type}] #{parameter.name}: <value for #{parameter.name.to_s.humanize.downcase}> (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} [#{default_param_type}] #{parameter.name.to_s.humanize.downcase} (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
 
-          result.push "#{@indent}# @return [Boolean] true when #{method_signature.name.to_s.humanize.downcase}" if method_signature.name.to_s.end_with?('?')
+          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

data/lib/peeky/renderer/method_call_minimum_params_render.rb

@@ -12,8 +12,8 @@ module Peeky
       attr_reader :method_signature
 
       def initialize(method_signature, **opts)
-        instance_name = opts[:instance_name] || 'instance'
-        @instance_name = instance_name
+        # instance_name = opts[:instance_name] || 'instance'
+        @instance_name = opts[:instance_name]
         @method_signature = method_signature
       end
 
@@ -29,7 +29,11 @@ module Peeky
 
         params = minimal_call_parameters.length.zero? ? '' : "(#{minimal_call_parameters})"
 
-        "#{@instance_name}.#{name}#{params}"
+        if @instance_name.nil?
+          "#{name}#{params}"
+        else
+          "#{@instance_name}.#{name}#{params}"
+        end
       end
     end
   end

data/lib/peeky/version.rb

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

data/peeky.gemspec

@@ -3,25 +3,16 @@
 require_relative 'lib/peeky/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version  = '>= 2.5'
   spec.name                   = 'peeky'
   spec.version                = Peeky::VERSION
   spec.authors                = ['David Cruwys']
   spec.email                  = ['david@ideasmen.com.au']
 
-  spec.summary                = 'Extracting meta data from ruby classes'
-  spec.description            = <<-TEXT
-  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.
-  TEXT
-
+  spec.summary                = 'Take a peek into your ruby classes and extract useful meta data'
+  spec.description            = 'peeky'
   spec.homepage               = 'http://appydave.com/gems/peeky'
   spec.license                = 'MIT'
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   # spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
 
@@ -32,20 +23,23 @@ Gem::Specification.new do |spec|
   # Click Add Project:
   # git@github.com:klueless-io/peeky
   spec.metadata['documentation_uri'] = 'https://rubydoc.info/github/klueless-io/peeky/master'
-  spec.extra_rdoc_files = ['README-stories.md', 'README-stories.md']
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the RubyGem files that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
-    end
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
   # spec.extensions    = ['ext/peeky/extconf.rb']
+  spec.extra_rdoc_files = ['README.md', 'STORIES.md', 'USAGE.md']
+  spec.rdoc_options    += [
+    '--title', 'peeky by appydave.com',
+    '--main', 'README.md',
+    '--files STORIES.MD USAGE.MD'
+  ]
 
   spec.add_dependency 'activesupport'
-  # spec.add_dependency 'tty-box',         '~> 0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.40
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,16 +24,15 @@ 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: []
 extensions: []
 extra_rdoc_files:
-- README-stories.md
+- README.md
+- STORIES.md
+- USAGE.md
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -44,9 +43,11 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
-- README-stories.md
 - README.md
 - Rakefile
+- STORIES.md
+- USAGE.md
+- USAGE2.md
 - bin/console
 - bin/k
 - bin/kgitsync
@@ -63,6 +64,7 @@ files:
 - 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
@@ -79,22 +81,27 @@ metadata:
   changelog_uri: https://github.com/klueless-io/peeky/commits/master
   documentation_uri: https://rubydoc.info/github/klueless-io/peeky/master
 post_install_message:
-rdoc_options: []
+rdoc_options:
+- "--title"
+- peeky by appydave.com
+- "--main"
+- README.md
+- "--files STORIES.MD USAGE.MD"
 require_paths:
 - lib
 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: Extracting meta data from ruby classes
+summary: Take a peek into your ruby classes and extract useful meta data
 test_files: []