rspec-usecases 0.0.12 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbf5167aac3c896a46c81986794c7505fe50cad8efb7fa5b6986a962c0ca1d51
-  data.tar.gz: d93be1d47ac05674e9eab8f7d77514064ab727d47548a9ee251591f819e44d3f
+  metadata.gz: 0fe106f2d54203a80a9fdf117c87cc1f904628bb9eaa0724d5f8fb32f34be56e
+  data.tar.gz: 81e90bf6bfe148ecb97d070f8b01e1367f37162252577cca12ba7bcef3b46835
 SHA512:
-  metadata.gz: f7e09d32dbcd1c397d51e10f30a0f1d767682298b4d7379857b4b50698e3f205f005b74e7c21a586d28cc279953681633e17ac626832d3722462d0dee434a722
-  data.tar.gz: 66bd3d2d1af7e388b819285bdc7b32831ba59a8adfd43b4162ac4269317abb67f7b06580fee95f2b27632df5becb29ddd56bc9362af1c182af7889b5681d9fdb
+  metadata.gz: be8597d40eb2151612162d9807662168ba3ff19501c61cdd4bb9e72a27aa971522e3b60bb8eacac8c2f04f6af8c09f5f566ca237c6d1487aac421273d8573314
+  data.tar.gz: fb25e0896e1dc643cc93de59ed3b18993cd9018b85d387616918aa6830fb685826b0cc23b488140fbd7e914d77c4b22fea4056e82c8f84cf895d4b05eace1bdb

data/.github/workflows/main.yml

@@ -26,6 +26,8 @@ jobs:
         gem install bundler -v 2.2.5
         bundle install
     - name: Run tests
+      env:
+        USAGE_CI: 'github_actions'
       run: bundle exec rspec
     - name: Run rubocop
       run: bundle exec rubocop

data/.gitignore

@@ -40,8 +40,13 @@ mkmf.log
 # Gems should not use a Gemfile.lock
 Gemfile.lock
 
+# RubyGem definitions
+*.gem
+
 # rspec failure tracking
 .rspec_status
 
 # ByeBug history
 .byebug_history
+
+generate_markdown.md

data/.rubocop.yml

@@ -8,6 +8,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - "_/**/*"
+    - "spec/samples/**/*"
 
 Metrics/BlockLength:
   Exclude:
@@ -45,6 +46,9 @@ Layout/LineLength:
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
+Style/DoubleNegation:
+  Enabled: false
+
 Style/BlockComments:
   Enabled: false
   Include:
@@ -53,6 +57,9 @@ Style/BlockComments:
 # My Preferences - Start
 Metrics/ClassLength:
   Enabled: false
+Metrics/ModuleLength:
+  Exclude:
+    - "**/spec/**/*"
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 Naming/VariableNumber:

data/Gemfile

@@ -7,23 +7,32 @@ gemspec
 
 group :development do
   if ENV['RUBY_DEBUG_DEVELOPMENT']
-    # Currently conflicts with GitHub actions and so only available when
-    # environment varialbe is set.
-    # On Mac:
-    # ```export RUBY_DEBUG_DEVELOPMENT=true```
-    gem 'jazz_fingers'
+    #   # Currently conflicts with GitHub actions and so only available when
+    #   # environment varialbe is set.
+    #   # On Mac:
+    #   # ```export RUBY_DEBUG_DEVELOPMENT=true```
+    #   # gem 'jazz_fingers'
+    #   # 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'
   end
 end
-
 group :development, :test do
-  gem 'guard-bundler'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
+  gem 'guard-bundler', '~> 3.0'
+  gem 'guard-rspec', '~> 4.0'
+  gem 'guard-rubocop', '~> 1.2'
+  gem 'jazz_fingers'
+  gem 'pry'
   gem 'rake', '~> 12.0'
   gem 'rake-compiler', require: false
   gem 'rspec', '~> 3.0'
-  gem 'rubocop'
+
+  # # gem 'rspec', path: '~/dev/gems_3rd/rspec'
+  # gem 'rspec-core', path: '~/dev/gems_3rd/rspec-core'
+  # gem 'rspec-expectations', path: '~/dev/gems_3rd/rspec-expectations'
+  # gem 'rspec-mocks', path: '~/dev/gems_3rd/rspec-mocks'
+  # gem 'rspec-support', path: '~/dev/gems_3rd/rspec-support'
+
+  gem 'rubocop', '~> 1.9'
   gem 'rubocop-rake', require: false
   gem 'rubocop-rspec', require: false
 end

data/Guardfile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'guard/rspec/dsl'
 guard :bundler, cmd: 'bundle install' do
   watch('Gemfile')
   watch('rspec_usecases.gemspec')

data/STORIES.md

@@ -16,12 +16,12 @@ As a Developer, I can build documentable usecases, so that I easily document usa
 
 - Build Usecase
 
-### Tasks next on list
+As a Developer, I can build documentation presentations, so that I can create videos quickly
 
-Setup RubyGems and RubyDoc
+- https://revealjs.com/
+- https://mofesolapaul.github.io/sectionizr/
 
-- Build and deploy gem to [rubygems.org](https://rubygems.org/gems/rspec-usecases)
-- Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/rspec-usecases/master)
+### Tasks next on list
 
 Setup GitHub Action (test and lint)
 
@@ -32,12 +32,33 @@ Setup GitHub Action (test and lint)
 
 ### Stories - completed
 
+As a Developer, I can extend Rspec with code specific documentation extensions, so that I easily build documentation that parses unit tests
+
+As a Developer, I can have component based renderers, so that I easily extend documentation output renders
+
+- Build JSON renderer
+- Build Debug renderer
+- Build Markdown renderer
+
+Remove cooline and jazz_fingers gem from github actions by running from env variable
+
+- On Mac `export RUBY_DEBUG_DEVELOPMENT=true`
+
 As a Developer, I can extract code and other content from unit test, so that I can inject it into documentation
 
 - Build Content, ContentCode an ContentOutcome
 
 ### Tasks - completed
 
+Move content.\* into a namespace called contents
+
+- Content items take on the same role as Rspec::Example
+
+Setup RubyGems and RubyDoc
+
+- Build and deploy gem to [rubygems.org](https://rubygems.org/gems/rspec-usecases)
+- Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/rspec-usecases/master)
+
 Setup project management, requirement and SCRUM documents
 
 - Setup readme file

data/bin/console

@@ -3,7 +3,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'rspec_usecases'
+require 'rspec/usecases'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/docs/regexp-01.md

@@ -0,0 +1,56 @@
+# Ruby RegExp by example
+
+Working through various regular expression scenarios using Ruby syntax
+
+## Character classes
+
+#### match index `=~`
+
+```ruby
+source = 'abcdefghijklmnopqrstuvwxyz'
+
+label_value('source =~ /[aeiou]/', source =~ /[aeiou]/)
+label_value('source =~ /[crazy]/', source =~ /[crazy]/)
+label_value('source =~ /[12345]/', source =~ /[12345]/)
+```
+
+```ruby
+# source =~ /[aeiou]/           : 0
+# source =~ /[crazy]/           : 0
+# source =~ /[12345]/           : nil
+```
+
+#### global variable `$~` for MatchData
+
+```ruby
+source = 'abcdefghijklmnopqrstuvwxyz'
+
+puts source =~ /[aeiou]/
+puts $~
+puts source =~ /[12345]/
+puts $~
+puts source =~ /[d]/
+puts $~
+```
+
+```ruby
+# 0
+# a
+# 3
+# d
+```
+
+#### match() for MatchData
+
+```ruby
+source = 'abcdefghijklmnopqrstuvwxyz'
+
+puts source.match(/[aeiou]/)
+puts source.match(/[12345]/)
+puts source.match(/[d]/)
+```
+
+```ruby
+# a
+# nil
+```

data/docs/samples.md

@@ -0,0 +1,62 @@
+# Usage Samples
+
+Some examples of how to use Rspec::Usage
+
+## Array load 1st basics
+
+### Array.load
+
+Array.load - description goes here
+
+#### Initialize an array
+
+```
+ar = [1,2,3]
+```
+
+#### Push to array
+
+```
+# ar << 4
+```
+
+- AAAAAA
+- BBBBBB
+
+## Array load 2nd basics
+
+### Array.load
+
+Array.load - description goes here
+
+---
+
+#### Initialize an array
+
+```ruby
+display = false
+[1, 2, 3].each do |i|
+  puts "the quick brown fox: #{i}" if display
+
+  %w[A B C].each { |x| puts "the quick brown fox: #{i}:#{x}" if display }
+  puts '-----------------------' if display
+end
+```
+
+## Default.load will load your application configuration from your `.env` file found in the project root
+
+### Array.load
+
+- aaaa
+
+## Array load -> namespace -> Can I move content_block into a test block
+
+### Array.load
+
+#### example
+
+```
+#
+```
+
+- xxxxx

data/docs/test.debug.txt

@@ -0,0 +1,93 @@
+****************************************************************************************************
+Title                         : debug title
+Description                   : debug description
+====================================================================================================
+Key                           : RSpec::ExampleGroups::RspecUsecasesGeneratorDebugGenerator::ValidLevel1Usecase1
+Title                         : valid level 1 usecase #1
+Deep Title                    : Rspec::Usecases::Generator::DebugGenerator valid level 1 usecase #1
+Summary                       : first encountered usecases
+Usage                         : SomeClass.some_method
+Usage Description             : Calls some_method on SomeClass
+----------------------------------------------------------------------------------------------------
+  Type                        : outcome
+  # Title should be blank on this outcome
+----------------------------------------------------------------------------------------------------
+  Title                       : this outcome has a title
+  Type                        : outcome
+  # Source code goes here
+----------------------------------------------------------------------------------------------------
+  Title                       : this outcome has a note
+  Type                        : outcome
+  Note                        : outcome note
+  # Source code goes here
+----------------------------------------------------------------------------------------------------
+  Title                       : this outcome has an hr
+  Type                        : outcome
+  #
+----------------------------------------------------------------------------------------------------
+  Title                       : this is some unknown code
+  Type                        : code
+  # Source code goes here
+----------------------------------------------------------------------------------------------------
+  Title                       : this is some ruby code
+  Type                        : code
+  # Source code goes here
+====================================================================================================
+  Key                         : RSpec::ExampleGroups::RspecUsecasesGeneratorDebugGenerator::ValidLevel1Usecase1::ValidLevel2Usecase11
+  Title                       : valid level 2 usecase #1.1
+  Deep Title                  : Rspec::Usecases::Generator::DebugGenerator valid level 1 usecase #1 valid level 2 usecase #1.1
+  Summary                     : override the summary
+  Usage                       : 
+  Usage Description           : 
+====================================================================================================
+  Key                         : RSpec::ExampleGroups::RspecUsecasesGeneratorDebugGenerator::ValidLevel1Usecase1::ValidLevel2Usecase12
+  Title                       : valid level 2 usecase #1.2
+  Deep Title                  : Rspec::Usecases::Generator::DebugGenerator valid level 1 usecase #1 valid level 2 usecase #1.2
+  Summary                     : 
+  Usage                       : 
+  Usage Description           : 
+====================================================================================================
+Key                           : RSpec::ExampleGroups::RspecUsecasesGeneratorDebugGenerator::SomeMethod::ValidLevel1Usecase2
+Title                         : valid level 1 usecase #2
+Deep Title                    : Rspec::Usecases::Generator::DebugGenerator #some_method valid level 1 usecase #2
+Summary                       : 
+Usage                         : 
+Usage Description             : 
+====================================================================================================
+  Key                         : RSpec::ExampleGroups::RspecUsecasesGeneratorDebugGenerator::SomeMethod::ValidLevel1Usecase2::FlattenMeOutOfTheHierarchy::ValidLevel2Usecase21
+  Title                       : valid level 2 usecase #2.1
+  Deep Title                  : Rspec::Usecases::Generator::DebugGenerator #some_method valid level 1 usecase #2 flatten me out of the hierarchy valid level 2 usecase #2.1
+  Summary                     : 
+  Usage                       : 
+  Usage Description           : 
+====================================================================================================
+  Key                         : RSpec::ExampleGroups::RspecUsecasesGeneratorDebugGenerator::SomeMethod::ValidLevel1Usecase2::ValidLevel2Usecase22
+  Title                       : valid level 2 usecase #2.2
+  Deep Title                  : Rspec::Usecases::Generator::DebugGenerator #some_method valid level 1 usecase #2 valid level 2 usecase #2.2
+  Summary                     : 
+  Usage                       : 
+  Usage Description           : 
+----------------------------------------------------------------------------------------------------
+    Title                     : some code code
+    Type                      : code
+    # code goes here
+----------------------------------------------------------------------------------------------------
+    Title                     : some ruby code
+    Type                      : code
+    Code Type                 : ruby
+    # ruby goes here
+----------------------------------------------------------------------------------------------------
+    Title                     : some css code
+    Type                      : code
+    Code Type                 : css
+    # css goes here
+----------------------------------------------------------------------------------------------------
+    Title                     : some js code
+    Type                      : code
+    Code Type                 : javascript
+    # js goes here
+----------------------------------------------------------------------------------------------------
+    Title                     : some javascript code
+    Type                      : code
+    Code Type                 : javascript
+    # javascript  goes here

data/docs/test.json

@@ -0,0 +1,172 @@
+{
+  "document": {
+    "title": "json title",
+    "description": "json description"
+  },
+  "usecases": [
+    {
+      "key": "RSpec::ExampleGroups::RspecUsecasesGeneratorJsonGenerator::ValidLevel1Usecase1",
+      "title": "valid level 1 usecase #1",
+      "deep_title": "Rspec::Usecases::Generator::JsonGenerator valid level 1 usecase #1",
+      "summary": "first encountered usecases",
+      "usage": "SomeClass.some_method",
+      "usage_description": "Calls some_method on SomeClass",
+      "contents": [
+        {
+          "note": "",
+          "title": "",
+          "type": "outcome",
+          "source": "# Title should be blank on this outcome",
+          "is_hr": false
+        },
+        {
+          "note": "",
+          "title": "this outcome has a title",
+          "type": "outcome",
+          "source": "# Source code goes here",
+          "is_hr": false
+        },
+        {
+          "note": "outcome note",
+          "title": "this outcome has a note",
+          "type": "outcome",
+          "source": "# Source code goes here",
+          "is_hr": false
+        },
+        {
+          "note": "",
+          "title": "this outcome has an hr",
+          "type": "outcome",
+          "source": "#",
+          "is_hr": true
+        },
+        {
+          "code_type": "",
+          "summary": "first encountered usecases",
+          "title": "this is some unknown code",
+          "type": "code",
+          "source": "# Source code goes here",
+          "is_hr": false
+        },
+        {
+          "code_type": "",
+          "summary": "first encountered usecases",
+          "title": "this is some ruby code",
+          "type": "code",
+          "source": "# Source code goes here",
+          "is_hr": false
+        }
+      ],
+      "usecases": [
+        {
+          "key": "RSpec::ExampleGroups::RspecUsecasesGeneratorJsonGenerator::ValidLevel1Usecase1::ValidLevel2Usecase11",
+          "title": "valid level 2 usecase #1.1",
+          "deep_title": "Rspec::Usecases::Generator::JsonGenerator valid level 1 usecase #1 valid level 2 usecase #1.1",
+          "summary": "override the summary",
+          "usage": "",
+          "usage_description": "",
+          "contents": [
+
+          ],
+          "usecases": [
+
+          ]
+        },
+        {
+          "key": "RSpec::ExampleGroups::RspecUsecasesGeneratorJsonGenerator::ValidLevel1Usecase1::ValidLevel2Usecase12",
+          "title": "valid level 2 usecase #1.2",
+          "deep_title": "Rspec::Usecases::Generator::JsonGenerator valid level 1 usecase #1 valid level 2 usecase #1.2",
+          "summary": "",
+          "usage": "",
+          "usage_description": "",
+          "contents": [
+
+          ],
+          "usecases": [
+
+          ]
+        }
+      ]
+    },
+    {
+      "key": "RSpec::ExampleGroups::RspecUsecasesGeneratorJsonGenerator::SomeMethod::ValidLevel1Usecase2",
+      "title": "valid level 1 usecase #2",
+      "deep_title": "Rspec::Usecases::Generator::JsonGenerator #some_method valid level 1 usecase #2",
+      "summary": "",
+      "usage": "",
+      "usage_description": "",
+      "contents": [
+
+      ],
+      "usecases": [
+        {
+          "key": "RSpec::ExampleGroups::RspecUsecasesGeneratorJsonGenerator::SomeMethod::ValidLevel1Usecase2::FlattenMeOutOfTheHierarchy::ValidLevel2Usecase21",
+          "title": "valid level 2 usecase #2.1",
+          "deep_title": "Rspec::Usecases::Generator::JsonGenerator #some_method valid level 1 usecase #2 flatten me out of the hierarchy valid level 2 usecase #2.1",
+          "summary": "",
+          "usage": "",
+          "usage_description": "",
+          "contents": [
+
+          ],
+          "usecases": [
+
+          ]
+        },
+        {
+          "key": "RSpec::ExampleGroups::RspecUsecasesGeneratorJsonGenerator::SomeMethod::ValidLevel1Usecase2::ValidLevel2Usecase22",
+          "title": "valid level 2 usecase #2.2",
+          "deep_title": "Rspec::Usecases::Generator::JsonGenerator #some_method valid level 1 usecase #2 valid level 2 usecase #2.2",
+          "summary": "",
+          "usage": "",
+          "usage_description": "",
+          "contents": [
+            {
+              "code_type": "",
+              "summary": "",
+              "title": "some code code",
+              "type": "code",
+              "source": "# code goes here",
+              "is_hr": false
+            },
+            {
+              "code_type": "ruby",
+              "summary": "",
+              "title": "some ruby code",
+              "type": "code",
+              "source": "# ruby goes here",
+              "is_hr": false
+            },
+            {
+              "code_type": "css",
+              "summary": "",
+              "title": "some css code",
+              "type": "code",
+              "source": "# css goes here",
+              "is_hr": false
+            },
+            {
+              "code_type": "javascript",
+              "summary": "",
+              "title": "some js code",
+              "type": "code",
+              "source": "# js goes here",
+              "is_hr": false
+            },
+            {
+              "code_type": "javascript",
+              "summary": "",
+              "title": "some javascript code",
+              "type": "code",
+              "source": "# javascript  goes here",
+              "is_hr": false
+            }
+          ],
+          "usecases": [
+
+          ]
+        }
+      ]
+    }
+  ]
+}