peeky 0.0.14 → 0.0.28

data/lib/peeky/renderer/method_signature_render.rb

@@ -4,14 +4,54 @@ module Peeky
   module Renderer
     # Render: Method Signature in compact format
     #
-    # Example output:
+    # === Example output (:default):
+    #   def simple(first_param)
+    #   end
+    #
+    #   def complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg)
+    #   end
+    #
+    # === Example output (:compact):
     #   def simple(first_param);                                           end
     #   def complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg);    end
     class MethodSignatureRender
+      # Indentation prefix as a string.
+      #
+      # Defaults to ''
+      #
+      # If you were writing a class into a file with an existing
+      # module, you may set the indent to '  ' if you wanted this
+      # render to indent by two spaces
+      attr_accessor :indent
+
+      # Style of method rendering [:default, :compact]
+      #
+      # default:: will render +def method_name+ and +end+ on separate lines
+      # compact:: will render +def method_name+ and +end+ on same line
+      # @return [Symbol] style
+      attr_accessor :style
+
+      # Method signature stores a MethodInfo object
       attr_reader :method_signature
 
-      def initialize(method_signature)
+      def initialize(method_signature, **_opts)
         @method_signature = method_signature
+        @indent = ''
+        @style = :compact
+      end
+
+      # Render the method signature in the selected style
+      def render
+        output = []
+        if @style == :compact
+          signature = "#{render_signature};"
+          output.push "#{signature.ljust(80)}#{render_end}"
+        end
+        if @style == :default
+          output.push render_signature
+          output.push render_end
+        end
+        output.join("\n")
       end
 
       def render_signature
@@ -19,20 +59,11 @@ module Peeky
 
         formatted_parameters = method_signature.parameters.map(&:signature_format).join(', ')
         params = formatted_parameters.length.zero? ? '' : "(#{formatted_parameters})"
-        "def #{name}#{params}"
+        "#{@indent}def #{name}#{params}"
       end
 
       def render_end
-        'end'
-      end
-
-      def render
-        signature = "#{render_signature};"
-        "#{signature.ljust(80)}#{render_end}"
-      end
-
-      def debug
-        puts render
+        "#{@indent}end"
       end
     end
   end

data/lib/peeky/renderer/method_signature_with_debug_render.rb

@@ -22,14 +22,22 @@ module Peeky
     #     puts ggg                            # &ggg is block with many calling options, example - instance_eval(&block) if block_given?
     #   end
     class MethodSignatureWithDebugRender
+      # Method signature stores a MethodInfo object
       attr_reader :method_signature
 
-      def initialize(method_signature)
+      def initialize(method_signature, **_opts)
         @method_signature = method_signature
 
         @render_signature = Peeky::Renderer::MethodSignatureRender.new(method_signature)
       end
 
+      # Render the method with debug statements for each parameter
+      def render
+        render_method
+      end
+
+      private
+
       def render_method
         name = method_signature.name
 
@@ -38,7 +46,7 @@ module Peeky
         indent = '  '
         output += "#{indent}puts 'method name: #{name}'\n"
 
-        output += render_logic(indent, 30)
+        output += render_debug_logic(indent, 30)
 
         indent = ''
         output += "#{indent}#{@render_signature.render_end}\n"
@@ -47,7 +55,7 @@ module Peeky
       end
 
       # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-      def render_logic(indent, size)
+      def render_debug_logic(indent, size)
         output = ''
         method_signature.parameters.each do |parameter|
           line = ''
@@ -73,14 +81,6 @@ module Peeky
         output
       end
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
-
-      def render
-        render_method
-      end
-
-      def debug
-        puts render
-      end
     end
   end
 end

data/lib/peeky/version.rb

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

data/peeky.gemspec

@@ -3,14 +3,20 @@
 require_relative 'lib/peeky/version'
 
 Gem::Specification.new do |spec|
+  # https://piotrmurach.com/articles/writing-a-ruby-gem-specification/
   spec.required_ruby_version  = '>= 2.5'
   spec.name                   = 'peeky'
   spec.version                = Peeky::VERSION
-  spec.authors                = ['David']
+  spec.authors                = ['David Cruwys']
   spec.email                  = ['david@ideasmen.com.au']
 
-  spec.summary                = 'Extracting meta data from ruby classes'
-  spec.description            = 'Peeky is a Ruby GEM for peaking into ruby classes and extracting meta'
+  spec.summary                = 'Take a peek into your ruby classes and extract useful meta data'
+  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.homepage               = 'http://appydave.com/gems/peeky'
   spec.license                = 'MIT'
 
@@ -23,6 +29,10 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/klueless-io/peeky'
   spec.metadata['changelog_uri'] = 'https://github.com/klueless-io/peeky/commits/master'
+  # Go to: https://rubydoc.info/
+  # Click Add Project:
+  # git@github.com:klueless-io/peeky
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/github/klueless-io/peeky/master'
 
   # 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.
@@ -35,6 +45,13 @@ Gem::Specification.new do |spec|
   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']
+  spec.rdoc_options    += [
+    '--title', 'peeky by appydave.com',
+    '--main', 'README.md',
+    '--files STORIES.MD'
+  ]
+
+  spec.add_dependency 'activesupport'
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
 end

metadata

@@ -1,22 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.28
 platform: ruby
 authors:
-- David
+- David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
-dependencies: []
-description: Peeky is a Ruby GEM for peaking into ruby classes and extracting meta
+date: 2020-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.
 email:
 - david@ideasmen.com.au
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- STORIES.md
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -27,6 +47,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- STORIES.md
 - bin/console
 - bin/k
 - bin/kgitsync
@@ -35,13 +56,16 @@ files:
 - hooks/pre-commit
 - hooks/update-version
 - lib/peeky.rb
+- 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_interface_render.rb
+- lib/peeky/renderer/class_interface_yard_render.rb
 - lib/peeky/renderer/method_call_minimum_params_render.rb
 - lib/peeky/renderer/method_signature_render.rb
 - lib/peeky/renderer/method_signature_with_debug_render.rb
@@ -54,8 +78,14 @@ metadata:
   homepage_uri: http://appydave.com/gems/peeky
   source_code_uri: https://github.com/klueless-io/peeky
   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"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -72,5 +102,5 @@ requirements: []
 rubygems_version: 3.1.4
 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: []