rspec-usecases 0.0.12 → 0.0.37

data/lib/rspec/usecases/groups/group.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    module Groups
+      # Group can be used as a basic container, it is
+      # similar in nature to describe and context but
+      # it will enter the flatten_group_hierarchy as
+      # it is a known usecase type
+      class Group < Rspec::Usecases::Groups::BaseGroup
+      end
+    end
+  end
+end

data/lib/rspec/usecases/groups/usecase.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    module Groups
+      # A usecase stores documentation for a single code usage scenario.
+      class Usecase < Rspec::Usecases::Groups::BaseGroup
+        # Usage contains a sample on how to call some code
+        attr_reader :usage
+
+        # Usage description gives extra details to support the usage example
+        attr_reader :usage_description
+
+        def build_attributes(example_group)
+          super(example_group)
+
+          @usage = example_group.metadata[:usage] || ''
+          @usage_description = example_group.metadata[:usage_description] || ''
+        end
+
+        def to_h
+          {
+            usage: usage,
+            usage_description: usage_description
+          }.merge(super.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/usecases/helpers/uc_file_as_markdown_content.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    # These helpers can be used from RSpec tests
+    module Helpers
+      # Builds markdown ```content block``` by injecting content
+      # from an existing file.
+      #
+      # @param [String] filename to read content from
+      # @param [Array<Integer>] lines (optional) - specific list of line numbers to grab using a 1 based index
+      # @param [String] code_type (optional) - what type of content is this, eg. javascript, ruby, css
+      def uc_file_as_markdown_content(filename, lines: nil, code_type: nil)
+        content = File.read(filename)
+
+        content = uc_grab_lines(content, lines) if lines
+
+        # To Deprecate: It may not be smart to support the code_type arg
+        #               it is probably better to pass content into markdown
+        #               components in raw format and let them apply this value
+        content = "```#{code_type}\n#{content}\n```" unless code_type.nil?
+        content
+      end
+    end
+  end
+end

data/lib/rspec/usecases/helpers/uc_grab_lines.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    # These helpers can be used from RSpec tests
+    module Helpers
+      # Grab lines from content into lines array and then extract specific lines
+      #
+      # Note that this is a 1 based index, instead of a traditional zero based index
+      #
+      # An array of [to, from] can be passed to grab specific lines
+      # from the content
+      #
+      # content = <<~TEXT.strip
+      #                 line 1
+      #                 line 2
+      #           #{'      '}
+      #                 line 4
+      #                 line 5
+      #           TEXT
+      #
+      # @example - grab specific line numbers
+      #
+      #   lines = uc_grab_lines(content, [1, 3, 5])
+      #   it { lines.to match_array(['line 1', '', 'line 5']) }
+      #
+      # @example - specific and range of line numbers
+      #
+      #   lines = uc_grab_lines(content, [1, *(3..4), 5])
+      #   it { lines.to match_array(['line 1', '', 'line 4', 'line 5']) }
+      #
+      # @raise [Rspec::Usecases::Error] if lines to include contains a value less than 1
+      # @raise [Rspec::Usecases::Error] if lines to include contains a value greater than the content.line_count
+      #
+      # @param [Array<Integer>] lines_to_include is a list of line numbers to pluck from string
+      # rubocop:disable Metrics/AbcSize
+      def uc_grab_lines(content, lines_to_include)
+        content_lines = content.lines
+
+        line_nos = lines_to_include.sort.collect
+
+        raise(Rspec::Usecases::Error, 'Line numbers must start from 1') if line_nos.min < 1
+
+        raise(Rspec::Usecases::Error, "Line number out of range - content_length: #{content_lines.length} - line_no: #{line_nos.max}") if
+          content_lines.length <= line_nos.max - 1
+
+        output_lines = line_nos.map { |line_no| content_lines[line_no - 1].chomp }
+
+        output_lines.join("\n")
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/rspec/usecases/options/debug_options.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    # Debug Options
+    module Options
+      # Options for debugging usecases objects
+      class DebugOptions < Rspec::Usecases::Options::DynamicOptions
+        def initialize(config)
+          super(:debug, config, {
+            format: :detail,
+            print: true,
+            write: false,
+            file: '',
+            open: false
+          })
+        end
+
+        def printable?
+          self.print == true
+        end
+
+        def writable?
+          write == true
+        end
+
+        def openable?
+          self.open == true
+        end
+      end
+    end
+  end
+end

data/lib/rspec/usecases/options/document_options.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    module Options
+      # Document Options
+      class DocumentOptions
+        attr_reader :json
+        attr_reader :debug
+        attr_reader :markdown
+
+        def initialize(config)
+          @json = Rspec::Usecases::Options::JsonOptions.new(config[:json])
+          @debug = Rspec::Usecases::Options::DebugOptions.new(config[:debug])
+          @markdown = Rspec::Usecases::Options::MarkdownOptions.new(config[:markdown])
+        end
+
+        def to_h
+          Rspec::Usecases::Options::DynamicOptions.struct_to_hash(OpenStruct.new(json: json, debug: debug, markdown: markdown))
+        end
+      end
+    end
+  end
+end

data/lib/rspec/usecases/options/dynamic_options.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    # Dynamic Option
+    module Options
+      # Dynamic option will convert a value
+      class DynamicOptions < OpenStruct
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def initialize(option_key, value, api = {})
+          super()
+
+          # This will load app the default values
+          parse(api)
+
+          self.empty = value.nil? || (value.is_a?(Hash) && value.empty?)
+
+          if !value.nil? && (value.is_a?(TrueClass) || value.is_a?(FalseClass))
+            self.empty = value.is_a?(FalseClass)
+            return
+          end
+
+          return if empty?
+          return if value == option_key
+
+          parse(value)
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        def active?
+          !empty?
+        end
+
+        def empty?
+          empty
+        end
+
+        def to_h
+          DynamicOptions.struct_to_hash(self)
+        end
+
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+        def self.struct_to_hash(data)
+          # No test yet
+          if data.is_a?(Array)
+            return data.map { |v| v.is_a?(OpenStruct) ? struct_to_hash(v) : v }
+          end
+
+          data.each_pair.with_object({}) do |(key, value), hash|
+            case value
+            when OpenStruct
+              hash[key] = struct_to_hash(value)
+            when Array
+              # No test yet
+              values = value.map { |v| v.is_a?(OpenStruct) ? struct_to_hash(v) : v }
+              hash[key] = values
+            else
+              hash[key] = value
+            end
+          end
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
+
+        private
+
+        def parse(value)
+          case value
+          when Array
+            parse_array(value)
+          when Hash
+            parse_hash(value)
+          else
+            parse_value(value)
+          end
+        end
+
+        def parse_hash(data)
+          data.each do |k, v|
+            send("#{k}=", v)
+          end
+        end
+
+        def parse_array(values)
+          values.map do |value|
+            case value
+            when Symbol, String
+              parse_symbol_or_string(value)
+            when Hash
+              parse_hash(value)
+            else
+              raise Rspec::Usecases::Error, 'Unknown option paramater'
+            end
+          end
+        end
+
+        def parse_symbol_or_string(value)
+          send("#{value}=", true)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/usecases/options/json_options.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    module Options
+      # Options for turning usecases into JSON objects
+      class JsonOptions < Rspec::Usecases::Options::DynamicOptions
+        def initialize(config)
+          super(:json, config, {
+            format: :detail,
+            print: true,
+            write: false,
+            file: '',
+            open: false
+          })
+        end
+
+        def printable?
+          self.print == true
+        end
+
+        def writable?
+          write == true
+        end
+
+        def openable?
+          self.open == true
+        end
+      end
+    end
+  end
+end

data/lib/rspec/usecases/options/markdown_options.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Usecases
+    module Options
+      # Options for generating MarkDown files from usecases
+      class MarkdownOptions < Rspec::Usecases::Options::DynamicOptions
+        def initialize(config)
+          super(:markdown, config, {
+            format: :detail,
+            print: true,
+            write: false,
+            file: '',
+            pretty: false,
+            open: false
+          })
+        end
+
+        def printable?
+          self.print == true
+        end
+
+        def writable?
+          write == true
+        end
+
+        def prettier?
+          pretty == true
+        end
+
+        def openable?
+          self.open == true
+        end
+      end
+    end
+  end
+end

data/lib/rspec/usecases/version.rb

@@ -2,6 +2,6 @@
 
 module Rspec
   module Usecases
-    VERSION = '0.0.12'
+    VERSION = '0.0.37'
   end
 end

data/rspec-usecases.gemspec

@@ -37,6 +37,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/rspec_usecases/extconf.rb']
+  spec.extra_rdoc_files = ['README.md', 'STORIES.md', 'USAGE.md']
+  spec.rdoc_options    += [
+    '--title', 'rspec-usecases by appydave.com',
+    '--main', 'README.md',
+    '--files STORIES.MD USAGE.MD'
+  ]
 
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-usecases
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.37
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-24 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies: []
 description: "    Rspec Usecases helps to write self-documenting code usage examples
   that execute as normal unit tests while outputting documentation in varied formats\n"
@@ -16,7 +16,10 @@ email:
 - david@ideasmen.com.au
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- STORIES.md
+- USAGE.md
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -31,18 +34,46 @@ files:
 - Rakefile
 - STORIES.md
 - USAGE.md
+- _/app
+- _/def-ruby-gem
+- _/tem-ruby-gem
 - bin/console
 - bin/k
 - bin/kgitsync
 - bin/khotfix
+- bin/runonce/common.sh
+- bin/runonce/setup-chmod.sh
+- bin/runonce/setup-git.sh
 - bin/setup
+- docs/regexp-01.md
+- docs/samples.md
+- docs/test.debug.txt
+- docs/test.json
+- docs/test.md
+- generate_markdown.md
 - hooks/pre-commit
 - hooks/update-version
 - lib/rspec/usecases.rb
-- lib/rspec/usecases/content.rb
-- lib/rspec/usecases/content_code.rb
-- lib/rspec/usecases/content_outcome.rb
-- lib/rspec/usecases/usecase.rb
+- lib/rspec/usecases/configure.rb
+- lib/rspec/usecases/contents/base_content.rb
+- lib/rspec/usecases/contents/code.rb
+- lib/rspec/usecases/contents/outcome.rb
+- lib/rspec/usecases/document.rb
+- lib/rspec/usecases/documentor.rb
+- lib/rspec/usecases/generator/base_generator.rb
+- lib/rspec/usecases/generator/debug_generator.rb
+- lib/rspec/usecases/generator/json_generator.rb
+- lib/rspec/usecases/generator/markdown_generator.rb
+- lib/rspec/usecases/groups/base_group.rb
+- lib/rspec/usecases/groups/group.rb
+- lib/rspec/usecases/groups/usecase.rb
+- lib/rspec/usecases/helpers/uc_file_as_markdown_content.rb
+- lib/rspec/usecases/helpers/uc_grab_lines.rb
+- lib/rspec/usecases/options/debug_options.rb
+- lib/rspec/usecases/options/document_options.rb
+- lib/rspec/usecases/options/dynamic_options.rb
+- lib/rspec/usecases/options/json_options.rb
+- lib/rspec/usecases/options/markdown_options.rb
 - lib/rspec/usecases/version.rb
 - rspec-usecases.gemspec
 homepage: http://appydave.com/gems/rspec-usecases
@@ -53,7 +84,12 @@ metadata:
   source_code_uri: https://github.com/klueless-io/rspec-usecases
   changelog_uri: https://github.com/klueless-io/rspec-usecases/commits/master
 post_install_message:
-rdoc_options: []
+rdoc_options:
+- "--title"
+- rspec-usecases by appydave.com
+- "--main"
+- README.md
+- "--files STORIES.MD USAGE.MD"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -67,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.2.7
 signing_key:
 specification_version: 4
 summary: Rspec Usecases helps to write self-documenting code usage examples that execute