peeky 0.0.14

data/lib/peeky/renderer/method_call_minimum_params_render.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Peeky
+  module Renderer
+    # Render: Simple instance method calls with minimum parameters
+    #
+    # Example output:
+    #   instance.simple('first_param')
+    #   instance.complex('aaa', ddd: 'ddd')
+    class MethodCallMinimumParamsRender
+      attr_reader :method_signature
+
+      def initialize(method_signature, instance_name = 'instance')
+        @instance_name = instance_name
+        @method_signature = method_signature
+      end
+
+      def render
+        name = method_signature.name
+
+        minimal_call_parameters = method_signature
+                                  .parameters
+                                  .map(&:minimal_call_format)
+                                  .reject { |minimal_call| minimal_call.nil? || minimal_call.strip.empty? }
+                                  .join(', ')
+
+        params = minimal_call_parameters.length.zero? ? '' : "(#{minimal_call_parameters})"
+
+        "#{@instance_name}.#{name}#{params}"
+      end
+
+      def debug
+        puts render
+      end
+    end
+  end
+end

data/lib/peeky/renderer/method_signature_render.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Peeky
+  module Renderer
+    # Render: Method Signature in compact format
+    #
+    # Example output:
+    #   def simple(first_param);                                           end
+    #   def complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg);    end
+    class MethodSignatureRender
+      attr_reader :method_signature
+
+      def initialize(method_signature)
+        @method_signature = method_signature
+      end
+
+      def render_signature
+        name = method_signature.name
+
+        formatted_parameters = method_signature.parameters.map(&:signature_format).join(', ')
+        params = formatted_parameters.length.zero? ? '' : "(#{formatted_parameters})"
+        "def #{name}#{params}"
+      end
+
+      def render_end
+        'end'
+      end
+
+      def render
+        signature = "#{render_signature};"
+        "#{signature.ljust(80)}#{render_end}"
+      end
+
+      def debug
+        puts render
+      end
+    end
+  end
+end

data/lib/peeky/renderer/method_signature_with_debug_render.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Peeky
+  module Renderer
+    # Render: Method signature with debug code
+    # Stubbed Method Render
+    #
+    # Example output:
+    #   def simple(first_param)
+    #     puts 'method name: simple'
+    #     puts first_param                    # first_param is a required positional paramater
+    #   end
+    #
+    #   def complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg)
+    #     puts 'method name: complex'
+    #     puts aaa                            # aaa is a required positional paramater
+    #     puts bbb                            # bbb is an optional positional paramater
+    #     puts ccc                            # *ccc takes a list of positional params
+    #     puts ddd                            # ddd: is a required named parameter
+    #     puts eee                            # eee: is an optional named parameter
+    #     puts fff                            # **fff takes a list of optional named parameters
+    #     puts ggg                            # &ggg is block with many calling options, example - instance_eval(&block) if block_given?
+    #   end
+    class MethodSignatureWithDebugRender
+      attr_reader :method_signature
+
+      def initialize(method_signature)
+        @method_signature = method_signature
+
+        @render_signature = Peeky::Renderer::MethodSignatureRender.new(method_signature)
+      end
+
+      def render_method
+        name = method_signature.name
+
+        indent = ''
+        output = "#{indent}#{@render_signature.render_signature}\n"
+        indent = '  '
+        output += "#{indent}puts 'method name: #{name}'\n"
+
+        output += render_logic(indent, 30)
+
+        indent = ''
+        output += "#{indent}#{@render_signature.render_end}\n"
+
+        output
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def render_logic(indent, size)
+        output = ''
+        method_signature.parameters.each do |parameter|
+          line = ''
+          case parameter.type
+          when :param_required
+            line = "puts #{parameter.name.ljust(size)} # #{parameter.name} is a required positional paramater"
+          when :param_optional
+            line = "puts #{parameter.name.ljust(size)} # #{parameter.name} is an optional positional paramater"
+          when :splat
+            line = "puts #{parameter.name.ljust(size)} # *#{parameter.name} takes a list of positional params"
+          when :key_required
+            line = "puts #{parameter.name.ljust(size)} # #{parameter.name}: is a required named parameter"
+          when :key_optional
+            line = "puts #{parameter.name.ljust(size)} # #{parameter.name}: is an optional named parameter"
+          when :double_splat
+            line = "puts #{parameter.name.ljust(size)} # **#{parameter.name} takes a list of optional named parameters"
+          when :block
+            line = "puts #{parameter.name.ljust(size)} # &#{parameter.name} is block with many calling options, example - instance_eval(&block) if block_given?"
+          end
+
+          output += "#{indent}#{line}\n"
+        end
+        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

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

data/peeky.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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']
+  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.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.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
+
+  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'
+
+  # 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
+  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.add_dependency 'tty-box',         '~> 0.5.0'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: peeky
+version: !ruby/object:Gem::Version
+  version: 0.0.14
+platform: ruby
+authors:
+- David
+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
+email:
+- david@ideasmen.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/k
+- bin/kgitsync
+- bin/khotfix
+- bin/setup
+- hooks/pre-commit
+- hooks/update-version
+- lib/peeky.rb
+- lib/peeky/attr_info.rb
+- lib/peeky/class_info.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/method_call_minimum_params_render.rb
+- lib/peeky/renderer/method_signature_render.rb
+- lib/peeky/renderer/method_signature_with_debug_render.rb
+- lib/peeky/version.rb
+- peeky.gemspec
+homepage: http://appydave.com/gems/peeky
+licenses:
+- MIT
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Extracting meta data from ruby classes
+test_files: []