yard-cucumber 2.0.0

data/lib/yard/handlers/legacy/step_transform_handler.rb

@@ -0,0 +1,24 @@
+class YARD::Handlers::Ruby::Legacy::StepTransformHandler < YARD::Handlers::Ruby::Legacy::Base
+  STEP_TRANSFORM_MATCH = /^(Transform\s*(\/.+\/)\s+do(?:\s*\|.+\|)?\s*)$/ unless defined?(STEP_TRANSFORM_MATCH)
+  handles STEP_TRANSFORM_MATCH
+
+  @@unique_name = 0
+  
+  def process
+    transform = statement.tokens.to_s[STEP_TRANSFORM_MATCH,2]
+    @@unique_name = @@unique_name + 1
+    
+    instance = StepTransformObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "transform_#{@@unique_name}") do |o| 
+      o.source = "Transform #{transform} do #{statement.block.to_s}\nend"
+      o.value = transform
+      o.keyword = "Transform"
+    end
+  
+    obj = register instance
+    parse_block :owner => obj
+    
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+  
+end
+

data/lib/yard/handlers/step_definition_handler.rb

@@ -0,0 +1,22 @@
+
+class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:When),method_call(:Given),method_call(:And),method_call(:Then)
+  
+  @@unique_name = 0
+  
+  process do
+    @@unique_name += 1
+
+    instance = YARD::CodeObjects::StepDefinitionObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE,"step_definition#{@@unique_name}") do |o| 
+      o.source = statement.source
+      o.comments = statement.comments
+      o.keyword = statement[0].source
+      o.value = statement[1].source
+    end
+
+    obj = register instance
+    parse_block(statement[2],:owner => obj)
+    
+  end
+  
+end

data/lib/yard/handlers/step_transform_handler.rb

@@ -0,0 +1,23 @@
+
+class YARD::Handlers::Ruby::StepTransformHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:Transform)
+  
+  @@unique_name = 0
+
+  process do
+    @@unique_name += 1
+    
+    instance = YARD::CodeObjects::StepTransformObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE,"step_transform#{@@unique_name}") do |o| 
+      o.source = statement.source
+      o.comments = statement.comments
+      o.keyword = statement[0].source
+      o.value = statement[1].source
+    end
+
+    obj = register instance
+    parse_block(statement[2],:owner => obj)
+
+  end
+
+end
+

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

@@ -0,0 +1,46 @@
+module YARD::Parser::Cucumber
+
+  class FeatureParser < YARD::Parser::Base
+
+    def initialize(source, file = '(stdin)')
+
+      @builder = Cucumber::Parser::CityBuilder.new(file)
+      @tag_counts = {}
+      @tag_formatter = Gherkin::Formatter::TagCountFormatter.new(@builder, @tag_counts)
+      @parser = Gherkin::Parser::Parser.new(@tag_formatter, true, "root", false)
+
+      @source = source
+      @file = file
+
+      @feature = nil
+    end
+
+    def parse
+      begin
+        @parser.parse(@source, @file, 0)
+        @feature = @builder.ast
+        return nil if @feature.nil? # Nothing matched
+        @feature.language = @parser.i18n_language
+      rescue Gherkin::Lexer::LexingError, Gherkin::Parser::ParseError => e
+        e.message.insert(0, "#{@file}: ")
+        raise e
+      end
+
+      self
+    end
+
+    def tokenize
+      
+    end
+
+
+    def enumerator
+      [@feature]
+    end
+
+  end
+
+
+  YARD::Parser::SourceParser.register_parser_type :feature, FeatureParser, 'feature'
+
+end

data/lib/yard/parser/source_parser.rb

@@ -0,0 +1,54 @@
+module YARD::Parser
+
+  class SourceParser
+    class << self
+
+      #
+      # Following the conventions of ordering as Cucumber performs it
+      #  
+      #  environment files - 'directory/support/env.rb,env_*.rb'
+      #  support files     - 'directory/support/*.rb' (but not env prefixed)
+      #  directory files   - 'directory/*.rb'
+      #  
+      #  feature files     - 'directory/*.feature'
+      #
+      def order_by_cucumber_standards(*files)
+        
+        non_feature_files = files.reject {|x| x =~ /^.+\.feature$/}
+        feature_files = files.find_all {|x| x =~ /^.+\.feature$/ }
+        
+        support_files = non_feature_files.find_all {|file| file =~ /support\/.+\.rb$/ }
+        other_files = non_feature_files - support_files
+        
+        environment_files = support_files.find_all {|file| file =~ /support\/env.*\.rb$/ }
+        environment_files.sort_by {|x| x.length if x }
+        
+        support_files = support_files - environment_files
+        
+        environment_files + support_files + other_files + feature_files
+      end
+
+      def parse_in_order(*files)
+        
+        files = order_by_cucumber_standards(*files)
+        
+        while file = files.shift
+          begin
+            if file.is_a?(Array) && file.last.is_a?(Continuation)
+              log.debug("Re-processing #{file.first}")
+              file.last.call
+            elsif file.is_a?(String)
+              log.debug("Processing #{file}...")
+              new(parser_type, true).parse(file)
+            end
+          rescue LoadOrderError => e
+            # Out of order file. Push the context to the end and we'll call it
+            files.push([file, e.message])
+          end
+        end
+      end
+      
+    end
+  end
+  
+end

data/lib/yard/rake/city_task.rb

@@ -0,0 +1,12 @@
+module YARD::Rake
+  
+  class CitydocTask < YardocTask
+  
+    def initialize(name = :yard)
+      super
+      self.options += [ "-e", "#{ File.dirname(__FILE__)}/../../city.rb", "-p", "#{File.dirname(__FILE__)}/../../templates" ]
+    end
+    
+  end
+  
+end

data/lib/yard/server/adapter.rb

@@ -0,0 +1,29 @@
+module YARD
+  module Server
+    
+    class Adapter
+      
+      class << self
+      
+        alias_method :yard_setup, :setup
+      
+        def setup
+          yard_setup
+          YARD::Templates::Engine.template_paths += 
+          [File.dirname(__FILE__) + '/../../templates',File.dirname(__FILE__) + '/../../docserver']
+        end
+        
+        alias_method :yard_shutdown, :shutdown
+
+        def 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,25 @@
+module YARD
+  module Server
+    module Commands
+      
+      class ListFeaturesCommand < ListCommand
+        def type; :features end
+        
+        def items
+          Registry.load_all
+          run_verifier(Registry.all(:feature))
+        end
+      end
+      
+      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,
+    # otherwise it perfectly suited for the requirements documents
+    #
+    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-cucumber.rb

@@ -0,0 +1,53 @@
+require 'cucumber/parser/gherkin_builder'
+require 'gherkin/parser/parser'
+require 'gherkin/formatter/tag_count_formatter'
+
+
+module CucumberInTheYARD
+  VERSION = '2.0.0' unless defined?(CucumberInTheYARD::VERSION)
+end
+
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/base.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/namespace_object.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/feature.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/scenario_outline.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/scenario.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/step.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/tag.rb"
+
+require File.dirname(__FILE__) + "/cucumber/city_builder.rb"
+
+require File.dirname(__FILE__) + "/yard/code_objects/step_transformer.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/step_definition.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/step_transform.rb"
+
+require File.dirname(__FILE__) + "/yard/parser/cucumber/feature.rb"
+
+require File.dirname(__FILE__) + "/yard/handlers/cucumber/base.rb"
+require File.dirname(__FILE__) + "/yard/handlers/cucumber/feature_handler.rb"
+
+if RUBY19
+  require File.dirname(__FILE__) + "/yard/handlers/step_definition_handler.rb"
+  require File.dirname(__FILE__) + "/yard/handlers/step_transform_handler.rb"
+end
+
+require File.dirname(__FILE__) + "/yard/handlers/legacy/step_definition_handler.rb"
+require File.dirname(__FILE__) + "/yard/handlers/legacy/step_transform_handler.rb"
+
+require File.dirname(__FILE__) + "/yard/parser/source_parser.rb"
+require File.dirname(__FILE__) + "/yard/templates/helpers/base_helper.rb"
+
+require File.dirname(__FILE__) + "/yard/server/commands/list_command.rb"
+require File.dirname(__FILE__) + "/yard/server/router.rb"
+
+
+# This registered template works for yardoc
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/templates'
+
+# This template is for yard server but will raise an error if included here, it
+# is patched in the adapter setup.
+#YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/docserver'
+
+# The following static paths and templates are for yard server
+YARD::Server.register_static_path File.dirname(__FILE__) + "/templates/default/fulldoc/html"
+YARD::Server.register_static_path File.dirname(__FILE__) + "/docserver/default/fulldoc/html"

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: yard-cucumber
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Franklin Webber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gherkin
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.3
+  type: :runtime
+  version_requirements: *id003
+description: " \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: franklin.webber@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- History.txt
+files: 
+- .rspec
+- History.txt
+- README.md
+- Rakefile
+- city.gemspec
+- example/README.md
+- example/child_feature/README.md
+- example/child_feature/child.feature
+- example/child_feature/grandchild_feature/grandchild.feature
+- example/empty.feature
+- example/scenario.feature
+- example/scenario_outline.feature
+- example/step_definitions/example.step.rb
+- example/step_definitions/first.step.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/common.css
+- lib/templates/default/fulldoc/html/full_list.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/index.erb
+- lib/templates/default/fulldoc/html/js/cucumber.js
+- lib/templates/default/fulldoc/html/setup.rb
+- lib/templates/default/layout/html/headers.erb
+- lib/templates/default/layout/html/search.erb
+- 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-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/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/parser/cucumber/feature.rb
+- lib/yard/parser/source_parser.rb
+- lib/yard/rake/city_task.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
+has_rdoc: true
+homepage: http://github.com/burtlo/yard-cucumber
+licenses: []
+
+post_install_message: "\n\
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.0.0 / 2011-02-08.\n  \n  Changes:\n    \n  * Cucumber In The YARD becomes `yard-cucumber` and with that gains the\n    benefits of being a YARD plugin\n  \n\n\
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Cucumber Features in YARD
+test_files: []
+