yard-gherkin-turnip 1.0.0

data/lib/yard/handlers/placeholder_handler.rb

@@ -0,0 +1,28 @@
+class YARD::Handlers::Ruby::PlaceholderHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:placeholder)
+
+  process do
+    instance = YARD::CodeObjects::Placeholder.new(step_transform_namespace,placeholder_name) do |o|
+      o.source = statement.source
+      o.comments = statement.comments
+      o.keyword = 'placeholder'
+      o.literal_value = statement[1].source
+    end
+    parse_block(statement.last.last,owner: instance)
+    register instance if instance.value
+  rescue StandardError => e
+    log.warn(e)
+  end
+
+  def step_transform_namespace
+    YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE
+  end
+
+  def placeholder_name
+    "placeholder#{self.class.generate_unique_id}"
+  end
+
+  def self.generate_unique_id
+    @placeholder_count = @placeholder_count.to_i + 1
+  end
+end

data/lib/yard/handlers/placeholder_match_handler.rb

@@ -0,0 +1,17 @@
+class YARD::Handlers::Ruby::PlaceholderMatchHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:match)
+
+  process do
+    if owner.is_a?(YARD::CodeObjects::Placeholder)
+      regex = "(?:#{statement.parameters[0].source.gsub(/^(["\/]|%r[{])|([}]|["\/])$/,'')})"
+      if owner.value
+        owner.value = "#{owner.value}|#{regex}"
+      else
+        owner.value = regex
+      end
+    end
+  rescue StandardError => e
+    log.warn(e.backtrace)
+    log.warn(e)
+  end
+end

data/lib/yard/handlers/step_definition_handler.rb

@@ -0,0 +1,55 @@
+#
+# Finds and processes all the step definitions defined in the ruby source
+#
+class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
+
+  handles method_call(:step)
+
+  process do
+
+    instance = YARD::CodeObjects::StepDefinition.new(step_transform_namespace,step_definition_name) do |o|
+      o.source = statement.source
+      o.comments = statement.comments
+      step_name = statement.parameters[0].source
+      if step_name[0] == ":"
+        step_name = statement.parameters[1].source
+      else
+        o.pending = pending_keyword_used?(statement.block)
+      end
+      o.keyword = statement.method_name.source
+      step_name.gsub!(/(?<!\\)"[\s]*(?:\+|\\)[\s]*"/,"")
+      o.literal_value = step_name
+      o.value = step_name.gsub(/^\"|\"$/, "")
+    end
+
+    obj = register instance
+    parse_block(statement[2],:owner => obj) unless statement.parameters[0].source[0] == ":"
+  rescue StandardError => e
+    log.warn(e)
+  end
+
+  def pending_keyword
+    "skip"
+  end
+
+  def pending_command_statement?(line)
+    (line.type == :command || line.type == :vcall) && line.first.source == pending_keyword
+  end
+
+  def pending_keyword_used?(block)
+    code_in_block = block.last
+    code_in_block.find { |line| pending_command_statement?(line) }
+  end
+
+  def step_transform_namespace
+    YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE
+  end
+
+  def step_definition_name
+    "step_definition#{self.class.generate_unique_id}"
+  end
+
+  def self.generate_unique_id
+    @step_definition_count = @step_definition_count.to_i + 1
+  end
+end

data/lib/yard/parser/cucumber/feature.rb

@@ -0,0 +1,72 @@
+module YARD::Parser::Cucumber
+
+  class FeatureParser < YARD::Parser::Base
+    
+    #
+    # Each found feature found is creates a new FeatureParser
+    # 
+    # This logic was copied from the logic found in Cucumber to create the builder
+    # and then set up the formatter and parser. The difference is really the
+    # custom Cucumber::Parser::CityBuilder that is being used to parse the elements
+    # of the feature into YARD::CodeObjects.
+    # 
+    # @param [<String>] source containing the string conents of the feauture file
+    # @param [<String>] file the filename that contains the source
+    # 
+    def initialize(source, file = '(stdin)')
+
+      @builder = Cucumber::Parser::CityBuilder.new(file)
+      @tag_counts = {}
+      @parser = Gherkin::Parser.new(@builder)
+
+      @source = source
+      @file = file
+
+      @feature = nil
+    end
+
+    #
+    # When parse is called, the gherkin parser is executed and all the feature
+    # elements that are found are sent to the various methods in the 
+    # Cucumber::Parser::CityBuilder. The result of which is the feature element
+    # that contains all the scenarios, steps, etc. associated with that feature.
+    # 
+    # @see Cucumber::Parser::CityBuilder
+    def parse
+      begin
+        @parser.parse(@source)
+        @feature = @builder.ast
+        return nil if @feature.nil? # Nothing matched
+        
+        # The parser used the following keywords when parsing the feature
+        # @feature.language = @parser.i18n_language.get_code_keywords.map {|word| word }
+        
+      rescue Gherkin::ParserError => e
+        e.message.insert(0, "#{@file}: ")
+        warn e
+      end
+      
+      self
+    end
+
+    #
+    # This is not used as all the work is done in the parse method
+    # 
+    def tokenize
+      
+    end
+
+    # 
+    # The only enumeration that can be done here is returning the feature itself
+    # 
+    def enumerator
+      [@feature]
+    end
+
+  end
+
+  # 
+  # Register all feature files (.feature) to be processed with the above FeatureParser
+  YARD::Parser::SourceParser.register_parser_type :feature, FeatureParser, 'feature'
+
+end

data/lib/yard/server/adapter.rb

@@ -0,0 +1,43 @@
+module YARD
+  module Server
+
+    class Adapter
+
+      class << self
+
+        alias_method :yard_setup, :setup
+
+        #
+        # To provide the templates necessary for `yard-gherkin-turnip` to integrate
+        # with YARD the adapter has to around-alias the setup method to place
+        # the `yard-gherkin-turnip` server templates as the last template in the list.
+        #
+        # When they are normally loaded with the plugin they cause an error with
+        # the `yardoc` command. They are also not used because the YARD server
+        # templates are placed after all plugin templates.
+        #
+        def setup
+          yard_setup
+          YARD::Templates::Engine.template_paths +=
+          [File.dirname(__FILE__) + '/../../templates',File.dirname(__FILE__) + '/../../docserver']
+        end
+
+        alias_method :yard_shutdown, :shutdown
+
+        #
+        # Similar to the addition, it is good business to tear down the templates
+        # that were added by again around-aliasing the shutdown method.
+        #
+        def shutdown
+          yard_shutdown
+          YARD::Templates::Engine.template_paths -=
+          [File.dirname(__FILE__) + '/../../templates',File.dirname(__FILE__) + '/../../docserver']
+        end
+
+      end
+
+
+    end
+
+  end
+end

data/lib/yard/server/commands/list_command.rb

@@ -0,0 +1,31 @@
+module YARD
+  module Server
+    module Commands
+      
+      #
+      # List Features powers the features menu option in `yard server`
+      #
+      class ListFeaturesCommand < ListCommand
+        def type; :features end
+        
+        def items
+          Registry.load_all
+          run_verifier(Registry.all(:feature))
+        end
+      end
+      
+      #
+      # List Tags powers the tags menu option in `yard server`
+      #
+      class ListTagsCommand < ListCommand
+        def type; :tags end
+        
+        def items
+          Registry.load_all
+          run_verifier(Registry.all(:tag).sort_by {|t| t.value.to_s })
+        end
+      end
+      
+    end
+  end
+end

data/lib/yard/server/router.rb

@@ -0,0 +1,31 @@
+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::StepTransformers)
+        "Step Definitions and Placeholders"
+      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/yard-gherkin-turnip.gemspec

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + "/lib/yard-gherkin-turnip/version"
+
+module YardTurnip
+  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 |s|
+  s.name        = 'yard-gherkin-turnip'
+  s.version     = ::YardTurnip::VERSION
+  s.authors     = ["Franklin Webber", "Angela Todd"]
+  s.description = %{
+    YARD-Gherkin-Turnip is a YARD extension that processes Gherkin Features, Scenarios, Steps and Tags
+    and Turnip Step Definitions and Placeholders 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.  }
+  s.summary     = "Turnip Features in YARD"
+  s.homepage    = "http://github.com/angelatodd/yard-gherkin-turnip"
+  s.license     = 'MIT'
+
+  s.platform    = Gem::Platform::RUBY
+
+  changes = YardTurnip.show_version_changes(::YardTurnip::VERSION)
+
+  s.post_install_message = %{
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+
+  Thank you for installing yard-gherkin-turnip #{::YardTurnip::VERSION} / #{changes[:date]}.
+
+  Changes:
+  #{changes[:changes].collect{|change| "  #{change}"}.join("")}
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+
+}
+
+  s.add_development_dependency 'rake', '~> 10'
+
+  s.add_dependency 'gherkin', '>= 4.0', '< 6.0'
+  s.add_dependency 'cucumber', '>= 2.0', '< 4.0'
+  s.add_dependency 'yard', '~> 0.8', '>= 0.8.1'
+
+  s.rubygems_version   = "1.3.7"
+  s.files            = `git ls-files`.split("\n")
+  s.extra_rdoc_files = ["README.md", "History.txt"]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: yard-gherkin-turnip
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Franklin Webber
+- Angela Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-28 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    YARD-Gherkin-Turnip is a YARD extension that processes Gherkin
+  Features, Scenarios, Steps and Tags\n    and Turnip Step Definitions and Placeholders
+  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: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- History.txt
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- History.txt
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/README.md
+- example/child_feature/README.md
+- example/child_feature/child.feature
+- example/child_feature/grandchild_feature/grandchild.feature
+- example/empty.feature
+- example/placeholder.feature
+- example/scenario.feature
+- example/scenario_outline.feature
+- example/scenario_outline_multi.feature
+- example/step_definitions/customer.step.rb
+- example/step_definitions/duck.step.rb
+- example/step_definitions/placeholder.step.rb
+- example/step_definitions/text.step.rb
+- example/tags.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/placeholders.erb
+- lib/templates/default/steptransformers/html/setup.rb
+- lib/templates/default/steptransformers/html/step_definitions.erb
+- lib/templates/default/steptransformers/html/undefined_steps.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-gherkin-turnip.rb
+- lib/yard-gherkin-turnip/version.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/placeholder.rb
+- lib/yard/code_objects/step_definition.rb
+- lib/yard/code_objects/step_transformer.rb
+- lib/yard/handlers/cucumber/base.rb
+- lib/yard/handlers/cucumber/feature_handler.rb
+- lib/yard/handlers/placeholder_handler.rb
+- lib/yard/handlers/placeholder_match_handler.rb
+- lib/yard/handlers/step_definition_handler.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
+- yard-gherkin-turnip.gemspec
+homepage: http://github.com/angelatodd/yard-gherkin-turnip
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::)\n\n  Thank you for installing yard-gherkin-turnip 1.0.0 / 2020-06-28.\n\n
+  \ Changes:\n    \n  * Forked from yard-cucumber and renamed yard-gherkin-turnip\n
+  \ * Support added for Turnip `step` and `placeholder` definitions\n  \n\n(::) (::)
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Turnip Features in YARD
+test_files: []