yard-nrser-cucumber 0.1.0

data/lib/yard/server/router.rb

@@ -0,0 +1,32 @@
+module YARD
+  module Server
+
+    #
+    # The YARD::Server::Router needs the following modification,
+    # so that it will provide routing for the features and tags commands
+    # to their appropriate definitions
+    #
+    Router.class_eval do
+
+      alias_method :core_route_list, :route_list
+
+      #
+      # Provide the full list of features and tags
+      #
+      def route_list(library, paths)
+          
+        if paths && !paths.empty? && paths.first =~ /^(?:features|tags)$/
+          case paths.shift
+          when "features"; cmd = Commands::ListFeaturesCommand
+          when "tags"; cmd = Commands::ListTagsCommand
+          end
+          cmd.new(final_options(library, paths)).call(request)
+        else
+          core_route_list(library,paths)
+        end
+        
+      end
+
+    end
+  end
+end

data/lib/yard/templates/helpers/base_helper.rb

@@ -0,0 +1,26 @@
+module YARD::Templates::Helpers
+
+  module BaseHelper
+
+    def format_object_title(object)
+      if object.is_a?(YARD::CodeObjects::Cucumber::FeatureTags)
+        "Tags"
+      elsif object.is_a?(YARD::CodeObjects::Cucumber::StepTransformersObject)
+        "Step Definitions and Transforms"
+      elsif object.is_a?(YARD::CodeObjects::Cucumber::NamespaceObject)
+        "#{format_object_type(object)}#{object.value ? ": #{object.value}" : ''}"
+      elsif object.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)
+        "Feature Directory: #{object.name}"
+      else
+        case object
+        when YARD::CodeObjects::RootObject
+          "Top Level Namespace"
+        else
+          format_object_type(object) + ": " + object.path
+        end
+      end
+    end
+    
+  end
+
+end  

data/lib/yard/templates/helpers/html_helper.rb

@@ -0,0 +1,153 @@
+# Namespace
+module YARD
+module Templates
+module Helpers
+
+# Monkey into YARD's 
+# {https://www.rubydoc.info/gems/yard/YARD/Templates/Helpers/HtmlHelper HtmlHelper}
+# module to add common methods we want available in HTML templates.
+# 
+module HtmlHelper
+  
+  # Original HTML-ification method, that is now referred to as `:none` markup.
+  # Escapes HTML entities and replaces newlines with `<br/>`.
+  # 
+  # @note 2019.01.10 nrser
+  #   This method used to be duplicated in `lib/templates/default/`...
+  #   
+  #   1.  {file:lib/templates/default/feature/html/setup.rb feature/html/setup.rb}
+  #   2.  {file:lib/templates/default/featuredirectory/html/setup.rb featuredirectory/html/setup.rb}
+  #   
+  #   but de-duplicated it to here after creating this file for
+  #   {#htmlify_cucumber_text}.
+  # 
+  # @see #htmlify_cucumber_text
+  # 
+  # @param [String] text
+  #   String to be converted to HTML markup.
+  # 
+  # @return [String]
+  #   HTML markup.
+  # 
+  def htmlify_with_newlines(text)
+    text.split("\n").collect {|c| h(c).gsub(/\s/,'&nbsp;') }.join("<br/>")
+  end
+  
+  # Resolve the `markup` value given an argument, as provided to 
+  # {#htmlify_cucumber_text} or {#htmlify_cucumber_line}. Looks in the config
+  # when given `nil`, and defaults to `:none` to preserve old behavior if it
+  # finds nothing there either.
+  # 
+  # @param [nil | #to_sym] markup
+  #   The argument value.
+  # 
+  # @return [Symbol]
+  #   The value to use.
+  # 
+  def resolve_cucumber_markup(markup = nil)
+    if markup.nil?
+      markup = YARD::Config.options[ :'yard-cucumber.markup' ] || :none
+    end
+    
+    markup = markup.to_sym unless markup.is_a?( Symbol )
+    
+    markup
+  end
+  
+  private :resolve_cucumber_markup
+
+  # Wrapper for HTML-ifying text from Cucumber features and scenarios that takes
+  # into account the `yard-cucumber.markup` config value.
+  # 
+  # @param [String] text
+  #   String to be converted to HTML markup.
+  # 
+  # @param [nil | #to_sym] markup
+  #   The markup with which to parse the text:
+  #   
+  #   1.  `nil` consults the `yard-cucumber.markup` config setting, then 
+  #       proceeds with that value as if it was passed in.
+  #       
+  #       If the setting is missing or has a `nil` value, then `:none` is used
+  #       to maintain the same behavior as before this method was introduced.
+  #       
+  #   2.  `:none` uses {#htmlify_with_newlines}, which is what the call sites
+  #       for this method used to use beforehand.
+  #       
+  #   3.  `:default` uses {#htmlify} with no `markup` argument, causing it to
+  #       use whatever markup is configured in the {#options}.
+  #       
+  #   4.  Anything else is passed as the `markup` argument to {#htmlify}.
+  # 
+  # @param [Boolean] strip
+  #   When `true`, {String#strip} will be called on `text` before HTML-ifying.
+  #   
+  #   Texts strings from features and scenarios seem to sometimes have at least
+  #   leading whitespace that does not seem intended given the `.feature` file.
+  #   
+  #   This can trigger code-formatting on the text when processing with 
+  #   Markdown, and I might imagine cause weirdness given other markups as well.
+  #   
+  #   *NOTE* To preserve legacy behavior `text` is *never* stripped when 
+  #   `markup` is resolved to `:none`.
+  # 
+  # @return [String]
+  #   HTML markup.
+  # 
+  def htmlify_cucumber_text(text, markup=nil, strip: true)
+    # Resolve the `markup` {Symbol}
+    markup = resolve_cucumber_markup markup
+    
+    # Switch off to the appropriate method.
+    case markup
+    when :none
+      # Do what it was before: call {#htmlify_with_newlines}, escapes entities 
+      # and replaces "\n" with `<br/>` tags.
+      htmlify_with_newlines(text)
+    when :default
+      # Do whatever the rest of YARD is doing.
+      htmlify(strip ? text.strip : text)
+    else
+      htmlify(strip ? text.strip : text, markup)
+    end
+  end # #htmlify_cucumber_text
+  
+  # Like {#htmlify_cucumber_text} but operates on single lines via {#h} for
+  # `:none`.
+  # 
+  # @param [String] text
+  #   The text to HTML-ify.
+  # 
+  # @param [nil | #to_sym] markup
+  #   What markup to use; see {#htmlify_cucumber_text} for details.
+  # 
+  # @param [Boolean] strip
+  #   Should `text` have {String#strip} called on it first when rendering
+  #   markup?
+  # 
+  # @return [String]
+  #   HTML.
+  # 
+  def htmlify_cucumber_line(text, markup=nil, strip: true)
+    # Resolve the `markup` {Symbol}
+    markup = resolve_cucumber_markup markup
+    
+    # Switch off to the appropriate method.
+    case markup
+    when :none
+      # Do what it was before: call {#h}
+      h(text)
+    when :default
+      # Do whatever the rest of YARD is doing.
+      htmlify_line(strip ? text.strip : text)
+    else
+      htmlify_line(strip ? text.strip : text, markup)
+    end
+  end # #htmlify_cucumber_line
+  
+end # module HtmlHelper
+
+# /Namespace
+end # module YARD
+end # module Templates
+end # module Helpers

data/yard-nrser-cucumber.gemspec

@@ -0,0 +1,75 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "yard/nrser/cucumber/version"
+
+# module CucumberInTheYARD
+#   def self.show_version_changes(version)
+#     date = ""
+#     changes = []
+#     grab_changes = false
+
+#     File.open("#{File.dirname(__FILE__)}/History.txt",'r') do |file|
+#       while (line = file.gets) do
+
+#         if line =~ /^===\s*#{version.gsub('.','\.')}\s*\/\s*(.+)\s*$/
+#           grab_changes = true
+#           date = $1.strip
+#         elsif line =~ /^===\s*.+$/
+#           grab_changes = false
+#         elsif grab_changes
+#           changes = changes << line
+#         end
+
+#       end
+#     end
+
+#     { :date => date, :changes => changes }
+#   end
+# end
+
+Gem::Specification.new do |spec|
+  spec.name        = ::YARD::NRSER::Cucumber::NAME
+  spec.version     = ::YARD::NRSER::Cucumber::VERSION
+  spec.authors     = ["Neil Souza", "Franklin Webber"]
+  spec.description = %{
+    This is my fork of https://github.com/burtlo/yard-cucumber with some changes that I would
+    like to consider improvements.
+    
+    YARD-Cucumber is a YARD extension that processes Cucumber Features, Scenarios, Steps,
+    Step Definitions, Transforms, and Tags and provides a documentation interface that allows you
+    easily view and investigate the test suite.  This tools hopes to bridge the gap of being able
+    to provide your feature descriptions to your Product Owners and Stakeholders.  }
+  spec.summary     = "Cucumber Features in YARD"
+  spec.email       = 'neil@neilsouza.com'
+  spec.homepage    = "http://github.com/nrser/yard-nrser-cucumber"
+  spec.license     = 'MIT'
+
+  spec.platform    = Gem::Platform::RUBY
+
+#   changes = CucumberInTheYARD.show_version_changes(::CucumberInTheYARD::VERSION)
+
+#   s.post_install_message = %{
+# (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+
+#   Thank you for installing yard-cucumber #{::CucumberInTheYARD::VERSION} / #{changes[:date]}.
+
+#   Changes:
+#   #{changes[:changes].collect{|change| "  #{change}"}.join("")}
+# (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+
+# }
+
+  spec.add_development_dependency 'rake', '~> 10'
+
+  spec.add_dependency 'gherkin', '>= 4.0', '< 6.0'
+  spec.add_dependency 'cucumber', '>= 2.0', '< 4.0'
+  spec.add_dependency 'yard', '~> 0.8', '>= 0.8.1'
+  
+  # Don't think we need this guy..?
+  # spec.rubygems_version   = "1.3.7"
+  spec.files            = `git ls-files`.split("\n")
+  spec.extra_rdoc_files = ["README.md", "History.txt"]
+  spec.rdoc_options     = ["--charset=UTF-8"]
+  spec.require_path     = "lib"
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: yard-nrser-cucumber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil Souza
+- Franklin Webber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: gherkin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: "\n    This is my fork of https://github.com/burtlo/yard-cucumber with
+  some changes that I would\n    like to consider improvements.\n    \n    YARD-Cucumber
+  is a YARD extension that processes Cucumber Features, Scenarios, Steps,\n    Step
+  Definitions, Transforms, and Tags and provides a documentation interface that allows
+  you\n    easily view and investigate the test suite.  This tools hopes to bridge
+  the gap of being able\n    to provide your feature descriptions to your Product
+  Owners and Stakeholders.  "
+email: neil@neilsouza.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- History.txt
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- Gemfile
+- History.txt
+- LICENSE.txt
+- NAME
+- README.md
+- Rakefile
+- VERSION
+- example/README.md
+- example/child_feature/README.md
+- example/child_feature/child.feature
+- example/child_feature/grandchild_feature/grandchild.feature
+- example/empty.feature
+- example/french.feature
+- example/scenario.feature
+- example/scenario_outline.feature
+- example/scenario_outline_multi.feature
+- example/step_definitions/example.step.rb
+- example/step_definitions/first.step.rb
+- example/step_definitions/french_steps.rb
+- example/step_definitions/struct.rb
+- example/step_definitions/support/env.rb
+- example/step_definitions/support/env_support.rb
+- example/step_definitions/support/support.rb
+- example/tags.feature
+- example/transform.feature
+- lib/cucumber/city_builder.rb
+- lib/docserver/default/fulldoc/html/js/cucumber.js
+- lib/docserver/default/layout/html/headers.erb
+- lib/docserver/doc_server/full_list/html/full_list.erb
+- lib/docserver/doc_server/full_list/html/setup.rb
+- lib/templates/default/feature/html/feature.erb
+- lib/templates/default/feature/html/no_steps_defined.erb
+- lib/templates/default/feature/html/outline.erb
+- lib/templates/default/feature/html/pystring.erb
+- lib/templates/default/feature/html/scenario.erb
+- lib/templates/default/feature/html/setup.rb
+- lib/templates/default/feature/html/steps.erb
+- lib/templates/default/feature/html/table.erb
+- lib/templates/default/featuredirectory/html/alpha_table.erb
+- lib/templates/default/featuredirectory/html/directory.erb
+- lib/templates/default/featuredirectory/html/setup.rb
+- lib/templates/default/featuretags/html/namespace.erb
+- lib/templates/default/featuretags/html/setup.rb
+- lib/templates/default/fulldoc/html/css/cucumber.css
+- lib/templates/default/fulldoc/html/directories.erb
+- lib/templates/default/fulldoc/html/full_list_featuredirectories.erb
+- lib/templates/default/fulldoc/html/full_list_features.erb
+- lib/templates/default/fulldoc/html/full_list_stepdefinitions.erb
+- lib/templates/default/fulldoc/html/full_list_steps.erb
+- lib/templates/default/fulldoc/html/full_list_tags.erb
+- lib/templates/default/fulldoc/html/js/cucumber.js
+- lib/templates/default/fulldoc/html/setup.rb
+- lib/templates/default/layout/html/setup.rb
+- lib/templates/default/requirements/html/alpha_table.erb
+- lib/templates/default/requirements/html/requirements.erb
+- lib/templates/default/requirements/html/setup.rb
+- lib/templates/default/steptransformers/html/header.erb
+- lib/templates/default/steptransformers/html/index.erb
+- lib/templates/default/steptransformers/html/setup.rb
+- lib/templates/default/steptransformers/html/transformers.erb
+- lib/templates/default/steptransformers/html/undefinedsteps.erb
+- lib/templates/default/tag/html/alpha_table.erb
+- lib/templates/default/tag/html/setup.rb
+- lib/templates/default/tag/html/tag.erb
+- lib/yard-nrser-cucumber.rb
+- lib/yard/code_objects/cucumber/base.rb
+- lib/yard/code_objects/cucumber/feature.rb
+- lib/yard/code_objects/cucumber/namespace_object.rb
+- lib/yard/code_objects/cucumber/scenario.rb
+- lib/yard/code_objects/cucumber/scenario_outline.rb
+- lib/yard/code_objects/cucumber/step.rb
+- lib/yard/code_objects/cucumber/tag.rb
+- lib/yard/code_objects/step_definition.rb
+- lib/yard/code_objects/step_transform.rb
+- lib/yard/code_objects/step_transformer.rb
+- lib/yard/handlers/constant_transform_handler.rb
+- lib/yard/handlers/cucumber/base.rb
+- lib/yard/handlers/cucumber/feature_handler.rb
+- lib/yard/handlers/legacy/step_definition_handler.rb
+- lib/yard/handlers/legacy/step_transform_handler.rb
+- lib/yard/handlers/step_definition_handler.rb
+- lib/yard/handlers/step_transform_handler.rb
+- lib/yard/nrser/cucumber/version.rb
+- lib/yard/parser/cucumber/feature.rb
+- lib/yard/server/adapter.rb
+- lib/yard/server/commands/list_command.rb
+- lib/yard/server/router.rb
+- lib/yard/templates/helpers/base_helper.rb
+- lib/yard/templates/helpers/html_helper.rb
+- yard-nrser-cucumber.gemspec
+homepage: http://github.com/nrser/yard-nrser-cucumber
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Cucumber Features in YARD
+test_files: []