nuker 0.0.47 → 1.0.0

data/features/scenario_page.feature

@@ -0,0 +1,84 @@
+Feature: Scenario Page
+  In order to view a scenario's intent
+  As a stakeholder
+  I want a page that displays each scenario and its steps
+
+  Scenario: Content
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+
+    @tag1 @tag2
+    Scenario: Sample Aidy
+      Given my name is "Aidy"
+      When I drink alcohol
+      Then I go nuts
+     """
+    When I visit the sample feature page
+    And click on a scenario header link
+    Then a page appears with the scenario content
+    And I see "tag1"
+    And I see "tag2"
+
+  Scenario: Background
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+
+    Background:
+      Given some things
+
+    Scenario: Sample Aidy
+     """
+    When I visit the sample feature page
+    And click on a scenario header link
+    Then the background is visible
+
+  Scenario: Tags
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+
+    Background:
+      Given some things
+
+    @work_in_progress
+    Scenario: Sample Aidy
+     """
+    When I visit the sample feature page
+    And click on a scenario header link
+    Then I see "work_in_progress"
+
+  Scenario: Data Table
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+
+      Scenario: Data Table
+        Given the following people exist:
+          | name   | email            |
+          | Aidy   | aidy@example.com |
+          | Andrew | vos@example.com  |
+    """
+    When I visit the sample feature page
+    And click on a scenario header link
+    Then I see the data table
+
+  Scenario: Scenario Outline
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+
+      Scenario Outline: Outline with examples
+        Given there are <start> cucumbers
+        When I eat <eat> cucumbers
+        Then I have <left> cucumbers
+
+        Examples:
+          | start | eat | left |
+          |  12   |  5  |  7   |
+          |  20   |  5  |  15  |
+    """
+    When I visit the sample feature page
+    And click on a scenario header link
+    Then I see the examples table

data/features/search_features.feature

@@ -0,0 +1,100 @@
+Feature: Search features
+  In order to have fast access to features and scenarios
+  As a stakeholder
+  I want to be able to search features
+
+  Scenario Outline: Search feature name
+    Given a feature file named "sample.feature" with the contents:
+    """
+    @QA
+    Feature: Sample Feature
+    """
+    And I am on the search page
+    When I search for "<query>"
+    Then I see a search result link to "<feature name>" with the url "<url>"
+
+    Examples:
+      | query        | feature name   | url                      |
+      | Sample       | Sample Feature |/projects/project/features/sample-feature  |
+      | sAmPlE       | Sample Feature |/projects/project/features/sample-feature  |
+      | @QA          | Sample Feature |/projects/project/features/sample-feature  |
+
+  Scenario: Search feature narrative
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+      In order to bla bla bla
+      As donkey
+      I want ermm I dunno.
+    """
+    And I am on the search page
+    When I search for "donkey"
+    Then I see a search result link to "Sample Feature" with the url "/projects/project/features/sample-feature"
+
+  Scenario: Search scenario name
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+    Scenario: Sample Scenario
+    """
+    And I am on the search page
+    When I search for "Sample Scenario"
+    Then I see a search result link to "Sample Scenario" with the url "/projects/project/features/sample-feature/scenario/sample-scenario"
+
+  Scenario: Search scenario steps
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Sample Feature
+    Scenario: Sample Scenario
+      Given I do something
+    """
+    And I am on the search page
+    When I search for "I do something"
+    Then I see a search result link to "Sample Scenario" with the url "/projects/project/features/sample-feature/scenario/sample-scenario"
+
+  Scenario: Search suggests other searches
+    Given a feature file named "sample.feature" with the contents:
+    """
+    Feature: Batman
+    """
+    And I am on the search page
+    When I search for "btman"
+    Then I see "Did you mean"
+    And I see a search result link to "Batman" with the url "/projects/project/search?q=Batman"
+
+  Scenario: Search displays tags
+    Given a feature file named "sample.feature" with the contents:
+    """
+    @feature_tag
+    Feature: Batman
+
+    @scenario_tag
+    Scenario: Batman?
+    """
+    And I am on the search page
+    When I search for "Batman"
+    Then I see "feature_tag" in the search results
+    And I see "scenario_tag" in the search results
+
+  Scenario: Highlighted search result with multiple matches
+    Given a feature file named "sample1.feature" with the contents:
+    """
+    @feature_tag
+    Feature: Some <long WORD feature word name
+    Scenario: Some <long WORD scenario word name
+    Given I have a word
+    """
+    And I am on the search page
+    When I search for "word"
+    Then I see the html:
+    """
+    Some &lt;long <span class="search-result">WORD</span> feature <span class="search-result">word</span> name
+    """
+    And I see the html:
+    """
+    Some &lt;long <span class="search-result">WORD</span> scenario <span class="search-result">word</span> name
+    """
+    And I see the html:
+    """
+    I have a <span class="search-result">word</span>
+    """

data/features/step_definitions/feature_page_steps.rb

@@ -0,0 +1,15 @@
+Then /^I see the feature free\-form narrative$/ do
+  page.should have_content "In order to get some value"
+  page.should have_content "As a person"
+  page.should have_content "I want to create value"
+end
+
+Then /^I see Scenario headers as links$/ do
+  page.body.should have_content "Scenarios"
+  page.should have_link "Sample Aidy", :href => "/projects/project/features/sample-feature/scenario/sample-aidy"
+  page.should have_link "Sample Andrew", :href => "/projects/project/features/sample-feature/scenario/sample-andrew"
+end
+
+Then /^the scenario links are sorted$/ do
+  page.body.should =~ /C.*I.*N.*V/m
+end

data/features/step_definitions/notifications_steps.rb

@@ -0,0 +1,11 @@
+Given /^a feature file with (\d+) @wip tags$/ do |wip_tag_count|
+  contents = "Feature: Feature 1\n"
+  1.upto(wip_tag_count.to_i) do |number|
+    contents += "@wip\nScenario: Scenario #{number}\n"
+  end
+  create_feature("project", "sample1.feature", contents)
+end
+
+Then /^I see a notification that says "([^"]*)"$/ do |text|
+  page.should have_content text
+end

data/features/step_definitions/project_home_steps.rb

@@ -0,0 +1,10 @@
+Then /^I see a link to my sample features$/ do
+  page.should have_link "Kate Moss", :href => "/projects/project/features/kate-moss"
+  page.should have_link "Katie Price", :href => "/projects/project/features/katie-price"
+  page.should have_link "Jessica-Jane Clement", :href => "/projects/project/features/jessica-jane-clement"
+  page.should have_link "Elle Macpherson", :href => "/projects/project/features/elle-macpherson"
+end
+
+Then /^the features are ordered alphabetically$/ do
+  page.body.should =~ /Elle Macpherson.*Jessica-Jane Clement.*Kate Moss.*Katie Price/m
+end

data/features/step_definitions/projects_steps.rb

@@ -0,0 +1,28 @@
+Given /^a feature file on the project "([^"]*)" with the contents:$/ do |project, contents|
+  create_feature(project, "feature1.feature", contents)
+end
+
+Given /^I visit the project page for "([^"]*)"$/ do |project|
+  visit "/projects/#{project}"
+end
+
+Given /^(\d+) projects exist$/ do |number_of_projects|
+  number_of_projects.to_i.times do |project_number|
+    project(project_number + 1)
+  end
+end
+
+Then /^I see a link to the feature "([^"]*)"$/ do |feature|
+  page.should have_link feature
+end
+
+Then /^I can switch to the (\d).+ project$/ do |project_number|
+  select project_number, :from => 'projects'
+
+  #This is needed because there seems to be a bug in the chrome driver.
+  #The first time this is called, we get the old url, and the second time we get the new url.
+  page.current_url
+
+  page.current_url.end_with?(project_number).should be_true
+end
+

data/features/step_definitions/push_features_steps.rb

@@ -0,0 +1,48 @@
+After do
+  File.delete ".nuker" if File.exist? ".wally"
+end
+
+Given /^I don't have a \.nuker authorisation file$/ do
+end
+
+Given /^I have a \.nuker authentication file$/ do
+  @authentication_code = "authCodE!!2322"
+  File.open(".nuker", "w") do |file|
+    file.write @authentication_code
+  end
+end
+
+Then /^I get a (\d+) http status$/ do |status|
+  page.driver.status_code.should eql status.to_i
+end
+
+Then /^I see the uploaded feature$/ do
+  page.body.should have_content "Feature Name"
+end
+
+When /^I put data to \/my_project_name\/features with the authentication code$/ do
+  gherkin = Nuker::ParsesFeatures.new.parse("Feature: Feature Name")
+  data = [{:path => "feature-name.feature", :gherkin => gherkin}].to_json
+  page.driver.put "/projects/my_project_name/features?authentication_code=#{@authentication_code}", data
+end
+
+Given /^I create a project called "([^"]*)"$/ do |project_name|
+  project project_name
+  Nuker::Project.first(:name => project_name).class.should equal Nuker::Project
+end
+
+When /^I send DELETE to "([^"]*)"$/ do |project_path|
+  page.driver.delete "#{project_path}?authentication_code=#{@authentication_code}"
+end
+
+Then /^"([^"]*)" should exist$/ do |project_name|
+  Nuker::Project.first(:name => project_name).class.should equal Nuker::Project
+end
+
+Then /^"([^"]*)" should not exist$/ do |project_name|
+  Nuker::Project.first(:name => project_name).class.should_not equal Nuker::Project
+end
+
+When /^I visit "([^"]*)" page$/ do |project_name|
+  visit "/projects/#{project_name}"
+end

data/features/step_definitions/scenario_page_steps.rb

@@ -0,0 +1,29 @@
+When /^click on a scenario header link$/ do
+  find('.scenarios a').click
+end
+
+Then /^a page appears with the scenario content$/ do
+  page.body.should have_content "Sample Aidy"
+  page.body.should have_content "Given my name is \"Aidy\""
+  page.body.should have_content "When I drink alcohol"
+  page.body.should have_content "Then I go nuts"
+end
+
+Then /^the background is visible$/ do
+  page.body.should have_content "Background:"
+  page.body.should have_content "Given some things"
+end
+
+Then /^I see the data table$/ do
+  text_for_all('th').should == ['name', 'email']
+  text_for_all('td').should == ['Aidy', 'aidy@example.com', 'Andrew', 'vos@example.com']
+end
+
+Then /^I see the examples table$/ do
+  text_for_all('th').should == ['start', 'eat', 'left']
+  text_for_all('td').should == ['12', '5', '7', '20', '5', '15']
+end
+
+def text_for_all tag
+  page.all(tag).collect { |heading| heading.text.strip }
+end

data/features/step_definitions/search_features_steps.rb

@@ -0,0 +1,24 @@
+Given /^I am on the search page$/ do
+  visit "/projects/project/search"
+end
+
+When /^I search for "([^"]*)"$/ do |text|
+  fill_in 'q', :with => text
+  click_button 'Search'
+end
+
+Then /^I see a search result link to "([^"]*)" with the url "([^"]*)"$/ do |text, url|
+  within ".content" do
+    page.should have_link text, :href => url
+  end
+end
+
+Then /^I see "([^"]*)" in the search results$/ do |text|
+  within ".content" do
+    page.should have_content text
+  end
+end
+
+Then /^I see the html:$/ do |html|
+  page.body.should include html
+end

data/features/step_definitions/steps.rb

@@ -0,0 +1,35 @@
+Given /^a feature file named "([^"]*)" with the contents:$/ do |filename, contents|
+  @contents = contents
+  create_feature("project", filename, @contents)
+end
+
+When /^I visit the project page$/ do
+  visit "/projects/project"
+end
+
+When /^I visit the sample feature page$/ do
+  visit "/projects/project/features/sample-feature"
+end
+
+When /^I select "([^"]*)"$/ do |text|
+  click_link text
+end
+
+Then /^I see a link to "([^"]*)" with the url "([^"]*)"$/ do |text, url|
+  page.should have_link text, :href => url
+end
+
+Then /^I see "([^"]*)"$/ do |text|
+  page.should have_content(text)
+end
+
+Then /^the total tag count is displayed$/ do
+  save_and_open_page
+end
+
+Then /^I see each tag has an individual colour$/ do
+ find('a.tag-tag1').should be_visible
+ find('a.tag-tag2').should be_visible
+ find('a.tag-tag3').should be_visible
+end
+

data/features/step_definitions/welcome_page.rb

@@ -0,0 +1,19 @@
+Given /^there aren't any projects$/ do
+end
+
+When /^I view the welcome page$/ do
+  visit "/"
+end
+
+Then /^I am redirected to the "([^"]*)" project page$/ do |project|
+  sleep 1
+  page.current_path.should include "/projects/#{project}"
+end
+
+When /^I select the project "([^"]*)"$/ do |project|
+  select(project, :from => "projects")
+end
+
+Then /^I see the nuker README$/ do
+  page.should have_content "Nuker is a web-based Cucumber viewer and navigator"
+end

data/features/support/env.rb

@@ -0,0 +1,33 @@
+$:.unshift(File.join(File.dirname(__FILE__), "../../lib"))
+ENV['RACK_ENV'] = 'test'
+require "nuker"
+require "fileutils"
+require "capybara/cucumber"
+require "rspec"
+require "fakefs/spec_helpers"
+
+Capybara.app = Sinatra::Application
+
+After do
+  Nuker::Project.delete_all
+end
+
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.new(app, :browser => :chrome)
+end
+Capybara.javascript_driver = :selenium_chrome
+
+def project name
+  project = Nuker::Project.first(:name => name)
+  unless project
+    project = Nuker::Project.create(:name => name)
+  end
+  project
+end
+
+def create_feature project, path, content
+  project = project(project)
+  feature = Nuker::Feature.new(:path => path, :gherkin => Nuker::ParsesFeatures.new.parse(content))
+  project.features << feature
+  project.save
+end

data/features/welcome_page.feature

@@ -0,0 +1,30 @@
+Feature: Welcome Page
+  As a stakeholder
+  I want a welcome page
+
+  Scenario: No projects
+    Given there aren't any projects
+    When I view the welcome page
+    Then I see the nuker README
+
+  @javascript
+  Scenario: Project links on home page
+    Given a feature file on the project "sample1" with the contents:
+    """
+    Feature: Sample1
+    """
+    And a feature file on the project "sample2" with the contents:
+    """
+    Feature: Sample2
+    """
+    When I view the welcome page
+    And I select the project "sample2"
+    Then I am redirected to the "sample2" project page
+
+  Scenario: Redirect to first project
+    Given a feature file on the project "sample1" with the contents:
+    """
+    Feature: Sample1
+    """
+    When I view the welcome page
+    Then I am redirected to the "sample1" project page

data/lib/nuker/application.rb

@@ -0,0 +1,161 @@
+$:.unshift(File.join(File.dirname(__FILE__)))
+require "sinatra"
+require "haml"
+require "rdiscount"
+require "mongo_mapper"
+require "nuker/feature"
+require "nuker/project"
+require "nuker/search_features"
+require "nuker/counts_tags"
+require "nuker/parses_features"
+require "cgi"
+
+configure do
+  set :haml, { :ugly=>true }
+end
+
+if ENV['MONGOHQ_URL']
+  uri = URI.parse(ENV['MONGOHQ_URL'])
+  MongoMapper.connection = Mongo::Connection.from_uri(ENV['MONGOHQ_URL'])
+  MongoMapper.database = uri.path.gsub(/^\//, '')
+else
+  MongoMapper.connection = Mongo::Connection.new('localhost')
+  MongoMapper.database = "nuker"
+end
+
+def current_project
+  @current_project ||= Nuker::Project.first(:name => params[:project])
+end
+
+def tag_count
+  return {} if current_project.nil?
+  @tag_count ||= Nuker::CountsTags.new(current_project).count_tags
+end
+
+def excessive_wip_tags
+  tag_count["@wip"] >= 10 if tag_count["@wip"]
+end
+
+def scenario_count
+  current_project.features.inject(0) do |count, feature|
+    if feature.gherkin["elements"]
+      count += feature.gherkin["elements"].select { |e| e["type"] == "scenario" }.size
+    end
+    if feature.gherkin["elements"]
+      count += feature.gherkin["elements"].select { |e| e["type"] == "scenario_outline" }.size
+    end
+    count
+  end
+end
+
+def highlighted_search_result_blurb search_result
+  offset = 0
+  highlighted = search_result.object.text.dup
+  span_start = "!!SPAN_START!!"
+  span_end = "!!SPAN_END!!"
+  search_result.matches.each do |match|
+    highlighted.insert(match.index + offset, span_start)
+    offset += span_start.length
+    highlighted.insert(match.index + match.text.length + offset, span_end)
+    offset += span_end.length
+  end
+  highlighted = CGI::escapeHTML(highlighted)
+  highlighted.gsub!(span_start, "<span class=\"search-result\">")
+  highlighted.gsub!(span_end, "</span>")
+  highlighted
+end
+
+def authenticated?
+  File.exist?(".nuker") && params[:authentication_code] == File.read(".nuker").strip
+end
+
+def get_scenario_url(scenario)
+  url = "/projects/#{current_project.name}/features/#{scenario["id"].gsub(";", "/scenario/")}"
+end
+
+def get_sorted_scenarios(feature)
+  scenarios = []
+
+  if feature.gherkin["elements"]
+    feature.gherkin["elements"].each do |element|
+      if element["type"] == "scenario" || element["type"] == "scenario_outline"
+        scenarios << element
+      end
+    end
+  end
+  scenarios.sort! { |a, b| a["name"] <=> b["name"] }
+  scenarios
+end
+
+put '/projects/:project/features/?' do
+  error 403 unless authenticated?
+
+  current_project.delete if current_project
+  project = Nuker::Project.create(:name => params[:project])
+
+  JSON.parse(request.body.read).each do |json|
+    project.features << Nuker::Feature.new(:path => json["path"], :gherkin => json["gherkin"])
+  end
+  project.save
+  halt 201
+end
+
+get '/?' do
+  first_project = Nuker::Project.first
+  if first_project
+    redirect "/projects/#{first_project.name}"
+  else
+    readme_path = File.expand_path(File.join(File.dirname(__FILE__), "../../README.md"))
+    markdown File.read(readme_path), :layout => false
+  end
+end
+
+get '/robots.txt' do
+  "User-agent: *\nDisallow: /"
+end
+
+get '/projects/:project/?' do
+  haml :project
+end
+
+delete '/projects/:project' do
+  error 403 unless authenticated?
+  project = Nuker::Project.first(:name => params[:project])
+  project.destroy
+  halt 201
+end
+
+get '/projects/:project/features/:feature/?' do
+  current_project.features.each do |feature|
+    @feature = feature if feature.gherkin["id"] == params[:feature]
+  end
+  haml :feature
+end
+
+get '/projects/:project/progress/?' do
+  haml :progress
+end
+
+get '/projects/:project/search/?' do
+  if params[:q]
+    @search_results = Nuker::SearchFeatures.new(current_project).find(:query => params[:q])
+  end
+  haml :search
+end
+
+get '/projects/:project/features/:feature/scenario/:scenario/?' do
+  current_project.features.each do |feature|
+    if feature.gherkin["id"] == params[:feature]
+      @feature = feature
+      feature.gherkin["elements"].each do |element|
+        if element["type"] == "background"
+          @background = element
+        end
+        if (element["type"] == "scenario" || element["type"] == "scenario_outline") && element["id"] == "#{params[:feature]};#{params[:scenario]}"
+          @scenario = element
+        end
+      end
+    end
+  end
+  haml :scenario
+end

data/lib/nuker/counts_tags.rb

@@ -0,0 +1,27 @@
+module Nuker 
+  class CountsTags
+    def initialize project
+      @project = project
+    end
+
+    def count_tags
+      @project.features.inject(Hash.new(0)) do |tag_count, feature|
+        if feature.gherkin["tags"]
+          feature.gherkin["tags"].each do |tag|
+            tag_count[tag["name"].downcase] += 1
+          end
+        end
+        if feature.gherkin["elements"]
+          feature.gherkin["elements"].each do |element|
+            if element["tags"]
+              element["tags"].each do |tag|
+                tag_count[tag["name"].downcase] += 1
+              end
+            end
+          end
+        end
+        tag_count
+      end
+    end
+  end
+end

data/lib/nuker/feature.rb

@@ -0,0 +1,16 @@
+module Nuker
+  class Feature
+    include MongoMapper::EmbeddedDocument
+
+    key :path, String
+    key :gherkin, Hash
+    key :name, String
+
+    before_save :save_feature_name
+
+    private
+    def save_feature_name
+      @name = gherkin["name"]
+    end
+  end
+end