peeky 0.0.15 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ca022f75a0c8100cb747acf3be51f77abf2ebedd092b6f235fbe717ea001dc4
-  data.tar.gz: 43250493a0da5114f6d685445a8b189d335df8dc74f3596c3d7395b4e1dd0a3a
+  metadata.gz: 17aca44d1863e4d7d811c2fdf09bbe4aec22c8aa5a2d0d09983a8d9c50f14430
+  data.tar.gz: ff605fe00998f4e7ca15725f20171180329edd882256c46eaa20c96d41491488
 SHA512:
-  metadata.gz: bbfa5087d3653aa6aee52ce37138883205e5b8ee1c3cef4419a0619c81e97f3f577c8f8482ff7c399d9a454fe07530857b8f16863129547f954cfcd45b7ddda9
-  data.tar.gz: 71738fcef6e04171391b2863f480468f3e34ed249fcee9dfd6188fbf2fdfab0b655ebe07d82170e058dcadfef2b76e4c06bd22617b78d200608478cb35e06a95
+  metadata.gz: e212ec6b8cb3e88e78e57f42d7a880aabf73e46cabd0b23e8d3ce93a0819a74d36f7dbf1d1af95f2677824aa885e277d003445c4d8bc656afd4e1245f8cd8d04
+  data.tar.gz: 3498282a3c71032ef6866783d06f642b7c834079d3cfae164d577a734ba5194c082b820b956bef116f7277fed19993f7833776e3fe97c1401d1485cf976e176c

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+# 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:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - 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
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec
+    - name: Run rubocop
+      run: bundle exec rubocop

data/Gemfile

@@ -10,7 +10,7 @@ group :development, :test do
   gem 'guard-rspec'
   gem 'guard-rubocop'
   # pry on steroids
-  gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
+  # gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
   gem 'jazz_fingers'
   gem 'rake', '~> 12.0'
   # this is used for cmdlets 'self-executing gems'

data/README-stories.md

@@ -0,0 +1,55 @@
+# 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
+
+## Stories
+
+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
+
+As a Developer, I can render method signature with debug code, So that mock out a method with parameter logging
+
+- Render: Method signature with debug code
+
+As a Developer, I can see the method signature of a method, So that I understand it's parameters
+
+- 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
+
+- Render: Simple instance method calls with minimum parameters
+
+As a Developer, I can tell if a method is attr_*, so that I can format methods using attr_* notation
+
+- Attr Writer Predicate will match true if the method info could be considered a valid attr_writer
+- Attr Writer Predicate will match true if the method info could be considered a valid attr_writer
+
+As a Developer, I should be able to interrogate class instance information, so that I can reverse engineer a ruby class
+
+- ParameterInfo model to store information about parameters on a method
+- MethodInfo model to store signature of a ruby instance method
+- AttrInfo is a container that represents attr_reader, attr_writer or attr_accessor by storying 1 or 2 MethodInfo
+- ClassInfo stores information about a ruby class. Only support instance methods
+
+
+## Tasks
+
+
+Setup GitHub Action (test and lint)
+
+- Setup Rspec action
+- Setup RuboCop action
+
+
+Setup new Ruby GEM
+
+- Build out a standard GEM structure
+- Add semantic versioning
+- Add Rspec unit testing framework
+- Add RuboCop linting
+- Add Guard for automatic watch and test
+- Add GitFlow support
+- Add GitHub Repository

data/README.md

@@ -1,30 +1,3 @@
-# ToDo
-
-* Manually create each file using the template system
-  - Models
-    - [Done] ParameterInfo
-    - [Done] AttrInfo
-    - [Done] ClassInfo
-    - [Done] MethodInfo
-  - Create predicates
-    - [Done] attr_reader_predicate
-    - [Done] attr_writer_predicate
-  - Create renderers
-    - [Done] method_call_minimum_params_render
-    - [Done] method_signature_render
-    - [Done] method_signature_with_debug_render
-    - [Done] class_interface_render
-- [Done] Recreate peeky
-- [Done] Symlink KlueLess files
-- [Done] Hot fix after each section
-- [Done] Make sure the klueless files follow a natural structure
-- [Done] Push peeky to Ruby Gems
-- Build out the readme file
-- Build out the stories
-- Back compare templates vis definitions
-- Auto create .template folder with copied definitions
-
-
 # Peeky
 
 > Peeky is a Ruby GEM for peaking into ruby classes and extracting meta
@@ -57,6 +30,17 @@ gem install peeky
 
 ## Stories
 
+### Main Story
+
+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)
+
+### 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 class with instance attributes and methods, So that I can quickly mock out an entire class
 
 ## Usage
 

data/lib/peeky/method_info.rb

@@ -3,7 +3,8 @@
 require 'forwardable'
 
 module Peeky
-  # Method Info
+  # Method info store a list of instance methods and attr_* for
+  # a ruby class.
   class MethodInfo
     extend Forwardable
 

data/lib/peeky/renderer/class_interface_render.rb

@@ -2,7 +2,7 @@
 
 module Peeky
   module Renderer
-    # Class Interface Render
+    # Render: Class Interface
     #
     # Example output:
     # class SampleClassClassInterfaceRender

data/lib/peeky/version.rb

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

data/peeky.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |spec|
   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. 
+  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'
 
@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peeky
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.19
 platform: ruby
 authors:
 - David C
@@ -10,15 +10,17 @@ 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
-  data.\n  You can use this meta data to recreate classes, interfaces, documentation
-  etc. \n  or use it just to understand the internals of a class.\n"
+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: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -27,6 +29,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- README-stories.md
 - README.md
 - Rakefile
 - bin/console