gitnesse 0.12.6 → 1.0.0.beta2

data/spec/lib/dependency_checker_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe DependencyChecker do
+    let(:checker) { DependencyChecker.new }
+    let(:config)  { Config.instance }
+
+    describe "#check" do
+      it "calls other dependency checks" do
+        checks = %w(check_git check_cucumber check_repository_url
+                    check_identifier check_features_dir_exists)
+        checks.each do |check|
+          checker.should_receive(check.to_sym).and_return(true)
+        end
+
+        checker.check
+      end
+
+      it "calls display_errors if there are any errors" do
+        checks = %w(check_cucumber check_repository_url check_identifier
+                    check_features_dir_exists)
+
+        checks.each do |check|
+          checker.should_receive(check.to_sym).and_return(true)
+        end
+
+        checker.should_receive(:system).with('git --version &> /dev/null').and_return(nil)
+        checker.should_receive(:display_errors)
+
+        checker.check
+      end
+    end
+
+    describe "#display_errors" do
+      before do
+        checker.instance_variable_set(:@errors, ["this is an example error"])
+
+        checker.should_receive(:puts).with("Configuration errors were found!")
+        checker.should_receive(:puts).with("  - this is an example error")
+        checker.should_receive(:exit)
+      end
+
+      it "prints a note saying errors were found" do
+        checker.display_errors
+      end
+
+      it "displays every error in @errors" do
+        checker.display_errors
+      end
+
+      it "should exit" do
+        checker.display_errors
+      end
+    end
+
+    describe '#check_git' do
+      context 'when git is installed' do
+        before do
+          checker.should_receive(:system).with('git --version &> /dev/null').and_return(true)
+        end
+
+        it 'returns true' do
+          expect(checker.check_git).to be_true
+        end
+      end
+
+      context 'when git is not installed' do
+        before do
+          checker.should_receive(:system).with('git --version &> /dev/null').and_return(nil)
+        end
+
+        it 'adds an error' do
+          expect {
+            checker.check_git
+          }.to change{checker.errors.length}.from(0).to(1)
+        end
+      end
+    end
+
+    describe '#check_cucumber' do
+      context 'when cucumber is installed' do
+        before do
+          checker.should_receive(:system).with('cucumber --version &> /dev/null').and_return(true)
+        end
+
+        it 'returns true' do
+          expect(checker.check_cucumber).to be_true
+        end
+      end
+
+      context 'when cucumber is not installed' do
+        before do
+          checker.should_receive(:system).with('cucumber --version &> /dev/null').and_return(nil)
+        end
+
+        it 'adds an error' do
+          expect {
+            checker.check_cucumber
+          }.to change{checker.errors.length}.from(0).to(1)
+        end
+      end
+    end
+
+    describe "#check_repository_url" do
+      context "when repository_url is set" do
+        before do
+          config.repository_url = "git@github.com:hybridgroup/gitnesse.wiki.git"
+        end
+
+        it "returns true" do
+          expect(checker.check_repository_url).to be_true
+        end
+      end
+
+      context "when repository_url is not set" do
+        before do
+          config.repository_url = nil
+        end
+
+        it "adds an error" do
+          expect {
+            checker.check_repository_url
+          }.to change{checker.errors.length}.from(0).to(1)
+        end
+      end
+    end
+
+
+    describe "#check_identifier" do
+      context "when annotate_results is true" do
+        before do
+          config.annotate_results = true
+        end
+
+        context "when identifier is set" do
+          before do
+            config.identifier = "Uncle Bob's Macbook Pro"
+          end
+
+          it "returns true" do
+            expect(checker.check_identifier).to be_true
+          end
+        end
+
+        context "when identifier is not set" do
+          before do
+            config.identifier = nil
+          end
+
+          it "adds an error" do
+            expect {
+              checker.check_identifier
+            }.to change{checker.errors.length}.from(0).to(1)
+          end
+        end
+      end
+
+      context "when annotate_results is false" do
+        before do
+          config.annotate_results = false
+        end
+
+        it "returns true" do
+          expect(checker.check_identifier).to be_true
+        end
+      end
+    end
+
+    describe "#check_features_dir_exists" do
+      context "when features_dir exists" do
+        before do
+          File.should_receive(:directory?).and_return(true)
+        end
+
+        it "returns true" do
+          expect(checker.check_features_dir_exists).to be_true
+        end
+      end
+
+      context "when features_dir does not exist or is a file" do
+        before do
+          File.should_receive(:directory?).and_return(false)
+        end
+
+        it "adds an error" do
+          expect {
+            checker.check_features_dir_exists
+          }.to change{checker.errors.length}.from(0).to(1)
+        end
+      end
+    end
+  end
+end

data/spec/lib/dir_manager_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe DirManager do
+    let(:path) { "#{Dir.home}/.gitnesse/gitnesse" }
+
+    describe ".make_project_dir" do
+      before do
+        FileUtils.should_receive(:mkdir_p).with(path).and_return(true)
+      end
+
+      it "creates a dir based on the current project name" do
+        expect(DirManager.make_project_dir).to eq path
+      end
+    end
+
+    describe ".remove_project_dir" do
+      it "removes the wiki dir for the current project" do
+        FileUtils.should_receive(:rm_rf).with(path).and_return(true)
+        DirManager.remove_project_dir
+      end
+    end
+
+    describe ".project_dir_present?" do
+      context "if project dir is a directory" do
+        before do
+          File.should_receive(:directory?).with(path).and_return(true)
+        end
+
+        it "returns true" do
+          expect(DirManager.project_dir_present?).to be_true
+        end
+      end
+
+      context "if project dir does not exists" do
+        before do
+          File.should_receive(:directory?).with(path).and_return(false)
+        end
+
+        it "returns false" do
+          expect(DirManager.project_dir_present?).to be_false
+        end
+      end
+    end
+  end
+end

data/spec/lib/feature_extractor_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe FeatureExtractor do
+    let(:example_page) { Support.example_wiki_page }
+    let(:expected_features) { Support.example_features }
+
+    describe ".extract!" do
+      it "extracts Cucumber features from Markdown wiki pages as an array" do
+        extracted_page = FeatureExtractor.extract!(example_page)
+        expect(extracted_page).to eq expected_features
+        expect(extracted_page).to be_an Array
+      end
+
+      it "returns an empty array if no examples were found" do
+        expect(FeatureExtractor.extract!("")).to eq []
+      end
+    end
+
+    describe ".contains_features?" do
+      it "returns true if the page contains features" do
+        expect(FeatureExtractor.contains_features?(example_page)).to be_true
+      end
+
+      it "returns false if no features were found" do
+        expect(FeatureExtractor.contains_features?("")).to be_false
+      end
+    end
+  end
+end

data/spec/lib/feature_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe Feature do
+    let(:feature) { Feature.new "thing.feature" }
+    let(:nested_feature) { Feature.new "nested_features/thing.feature" }
+
+    it "accepts a filename as an argument" do
+      expect(feature.filename).to eq "thing.feature"
+    end
+
+    it "can generate a wiki filename" do
+      expect(feature.wiki_filename).to eq "features > thing.feature.md"
+    end
+
+    describe "#wiki_filename" do
+      it "generates wiki filenames for nested features" do
+        expect(nested_feature.wiki_filename).to eq "features > nested_features > thing.feature.md"
+      end
+    end
+
+    describe "#read" do
+      before do
+        expect(File).to receive(:read).once.with("features/thing.feature").and_return('')
+      end
+
+      it "reads and caches the content of the file" do
+        expect(feature.read).to be_a String
+        expect(feature.read).to eq ''
+      end
+    end
+
+    describe "#write" do
+      before do
+        @stringio = StringIO.new
+        expect(File).to receive(:open).with("features/thing.feature", "w").and_yield(@stringio)
+        allow(File).to receive(:read).with("features/thing.feature").and_return(@stringio.string)
+      end
+
+      it "writes content to the file" do
+        feature.write('testing')
+        expect(feature.read).to eq "testing"
+      end
+    end
+
+    describe "#index_page" do
+      it "generates the path to the index page the feature will appear on" do
+        expect(feature.index_page).to eq "features.md"
+        expect(nested_feature.index_page).to eq "features > nested_features.md"
+      end
+    end
+  end
+end

data/spec/lib/feature_transform_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe FeatureTransform do
+    describe ".convert" do
+      context "when a feature is passed" do
+        it "converts a Cucumber feature to a Markdown wiki page" do
+          wiki_page = FeatureTransform.convert(Support.addition_feature)
+          expect(wiki_page).to eq Support.wiki_addition_feature
+        end
+      end
+
+      context "when a non-feature string is passed" do
+        it "returns a 'undefined feature' page" do
+          result = <<-EOS.chomp
+# Undefined Feature
+
+This feature hasn't been added yet.
+          EOS
+          expect(FeatureTransform.convert('')).to eq result
+        end
+      end
+    end
+  end
+end

data/spec/lib/hooks_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe Hooks do
+    let(:hook) { File.expand_path("#{File.dirname(__FILE__)}/../../lib/gitnesse/hooks/gitnesse.rb") }
+    let(:path) { Hooks::PATH }
+    let(:dir) { Hooks::DIR }
+
+    it "sets DIR to the 'support' cucumber dir" do
+      expect(dir).to match "features/support"
+    end
+
+    it "sets PATH to the filename for the Cucumber hook" do
+      expect(path).to match "features/support/gitnesse.rb"
+    end
+
+    describe ".create!" do
+      before do
+        expect(FileUtils).to receive(:cp).with(hook, path)
+      end
+
+      it "copies the hooks to the support dir" do
+        Hooks.create!
+      end
+
+      it "creates the support dir if it doesn't exist" do
+        expect(File).to receive(:directory?).with(dir).and_return(false)
+        expect(FileUtils).to receive(:mkdir_p).with(dir).and_return(nil)
+        Hooks.create!
+      end
+    end
+
+    describe ".destroy!" do
+      it "removes the Gitnesse hooks from the Cucumber support dir" do
+        expect(FileUtils).to receive(:rm).with(path, force: true).and_return(nil)
+        Hooks.destroy!
+      end
+    end
+  end
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe VERSION do
+    it "should have a version number string" do
+      expect(VERSION).to be_a String
+    end
+  end
+end

data/spec/lib/wiki/page_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'time'
+
+module Gitnesse
+  describe Wiki::Page do
+    let(:page) { Wiki::Page.new("~/.gitnesse/gitnesse/features > new_features > new_feature.feature.md") }
+
+    it "converts the filename to a local path" do
+      expect(page.relative_path).to eq "./features/new_features"
+    end
+
+    it "extracts the feature filename" do
+      expect(page.filename).to eq "new_feature.feature"
+    end
+
+    it "constructs the full local file path" do
+      expect(page.path).to eq "./features/new_features/new_feature.feature"
+    end
+
+    describe "#read" do
+      it "reads and caches the page's contents" do
+        File.should_receive(:read).with(page.wiki_path).once.and_return("test")
+
+        expect(page.read).to be_a String
+        expect(page.read).to eq "test"
+      end
+    end
+
+    describe "#write" do
+      before do
+        @stringio = StringIO.new
+        expect(File).to receive(:open).with(page.wiki_path, 'w+').and_yield(@stringio)
+        allow(File).to receive(:read).with(page.wiki_path).and_return(@stringio.string)
+      end
+
+      it "writes content to the file" do
+        page.write('testing')
+        expect(page.read).to eq "testing"
+      end
+    end
+
+    describe "#remove_results" do
+      before do
+        @stringio = StringIO.new(Support.wiki_feature_with_annotations)
+        expect(File).to receive(:read).with(page.wiki_path).and_return(@stringio.string)
+        allow(File).to receive(:open).with(page.wiki_path, 'w+').and_yield(@stringio)
+      end
+
+      it "removes all existing scenario results from the wiki page" do
+        expect(page.remove_results).to eq Support.wiki_feature_without_annotations
+      end
+    end
+
+    describe "#append_result" do
+      before do
+        @stringio = StringIO.new(Support.wiki_feature_without_annotations)
+        allow(File).to receive(:read).with(page.wiki_path).and_return(@stringio.string)
+        allow(File).to receive(:open).with(page.wiki_path, 'w+').and_yield(@stringio)
+        allow(Time).to receive(:now).and_return(Time.parse("Sep 06 2013 10:10"))
+      end
+
+      it "appends scenario results to the wiki page" do
+        page.append_result('Divide two numbers', :passed)
+        expect(page.read).to eq Support.wiki_feature_with_annotations
+      end
+    end
+  end
+end

data/spec/lib/wiki_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe Wiki do
+    describe "#remove_features" do
+      before do
+        Wiki.any_instance.stub(:clone_or_update_repo).and_return(true)
+
+        @repo = double('repo', status: [])
+        expect(Git).to receive(:init).with("~/.gitnesse/gitnesse").and_return(@repo)
+
+        @wiki = Wiki.new "", "~/.gitnesse/gitnesse"
+      end
+
+      it "removes gitnesse-created files from the wiki" do
+        files = [
+            double(path: "Home.md"),
+            double(path: "features.md"),
+            double(path: "features > test.md"),
+            double(path: "features > test > thing.feature.md")
+        ]
+
+        allow(@repo).to receive(:status).and_return(files)
+
+        expect(@repo).to_not receive(:remove).with("Home.md")
+        expect(@repo).to receive(:remove).with("features.md")
+        expect(@repo).to receive(:remove).with("features > test.md")
+        expect(@repo).to receive(:remove).with("features > test > thing.feature.md")
+
+        @wiki.remove_features
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'gitnesse'
+
+require 'rspec'
+require 'support_helper'

data/spec/support/cli.rb

@@ -0,0 +1,20 @@
+require 'fileutils'
+require 'tempfile'
+require 'tmpdir'
+
+module CliSpecs
+  def gitnesse(args)
+    out = StringIO.new
+    Gitnesse::Cli.new(out).parse(args.split(/\s+/))
+
+    out.rewind
+    out.read
+  rescue SystemExit
+    out.rewind
+    out.read
+  end
+end
+
+RSpec.configure do |c|
+  c.include CliSpecs, type: :cli
+end

data/spec/support/example_config/gitnesse.rb

@@ -0,0 +1,4 @@
+Gitnesse::Config.config do |config|
+  config.annotate_results = true
+  config.identifier = "Uncle Bob's Laptop"
+end

data/{test/test_helper.rb → spec/support/example_features/addition.feature}

@@ -1,16 +1,3 @@
-require "minitest/matchers"
-require "minitest/autorun"
-require "minitest/pride"
-require "mocha"
-require File.expand_path('../../lib/gitnesse.rb', __FILE__)
-
-module FeatureTestMethods
-
-  # Creates a basic test feature
-  #
-  # Returns a string
-  def create_test_feature
-    <<-EOF
 Feature: Addition
   In order to avoid silly mistakes
   As a math idiot
@@ -21,6 +8,3 @@ Feature: Addition
     And I have entered 70 into the calculator
     When I press add
     Then the result should be 120 on the screen
-    EOF
-  end
-end

data/spec/support/example_features/division.feature

@@ -0,0 +1,10 @@
+Feature: Division
+  In order to avoid silly mistakes
+  As a math idiot
+  I want to be told the quotient of two numbers
+
+  Scenario: Divide two numbers
+    Given I have entered 6 into the calculator
+    And I have entered 2 into the calculator
+    When I divide
+    Then the result should be 3

data/spec/support/example_wiki_pages/developer_can_sync_features_to_code.md

@@ -0,0 +1,29 @@
+# Developer Can Sync Features To Code
+
+```Gherkin
+Feature: Addition
+  In order to avoid silly mistakes
+  As a math idiot
+  I want to be told the sum of two numbers
+
+  Scenario: Add two numbers
+    Given I have entered 50 into the calculator
+    And I have entered 70 into the calculator
+    When I press add
+    Then the result should be 120 on the screen
+```
+
+```gherkin
+Feature: Division
+  In order to avoid silly mistakes
+  As a math idiot
+  I want to be told the quotient of two numbers
+
+  Scenario: Divide two numbers
+    Given I have entered 6 into the calculator
+    And I have entered 2 into the calculator
+    When I divide
+    Then the result should be 3
+```
+
+![](https://s3.amazonaws.com/gitnesse/github/passing.png) `Last result was PASSED: Features already exist in wiki but not in code (2013-01-01 00:00:00 -0800 - Developer Computer)`

data/spec/support_helper.rb

@@ -0,0 +1,79 @@
+SUPPORT_FILES_DIR = File.join(File.dirname(__FILE__), "/support")
+
+Dir[File.join(File.dirname(__FILE__), "support", "*.rb")].each { |f| require(f) }
+
+class Support
+  class << self
+    def example_config_file_path
+      "#{SUPPORT_FILES_DIR}/example_config/gitnesse.rb"
+    end
+
+    def example_config_file
+      @example_config ||= begin
+        File.read(example_config_file_path)
+      end
+    end
+
+    def addition_feature
+      @addition ||= begin
+        File.read("#{SUPPORT_FILES_DIR}/example_features/addition.feature")
+      end.lstrip.chomp
+    end
+
+    def wiki_addition_feature
+      <<-EOS.chomp
+# Addition
+
+```gherkin
+#{addition_feature}
+```
+      EOS
+    end
+
+    def division_feature
+      @division ||= begin
+        File.read "#{SUPPORT_FILES_DIR}/example_features/division.feature"
+      end.lstrip.chomp
+    end
+
+    def wiki_division_feature
+      <<-EOS.chomp
+# Division
+
+```gherkin
+#{division_feature}
+```
+      EOS
+    end
+
+    def wiki_feature_without_annotations
+      wiki_division_feature
+    end
+
+    def wiki_feature_with_annotations
+      <<-EOS.chomp
+# Division
+
+```gherkin
+#{division_feature}
+```
+
+![](https://s3.amazonaws.com/gitnesse/github/passed.png) `Last Result For Scenario 'Divide two numbers': PASSED (Sep 06, 2013, 10:10 AM - )`
+      EOS
+    end
+
+    def example_features
+      [addition_feature, division_feature]
+    end
+
+    def example_wiki_page
+      @example_wiki ||= begin
+        File.read "#{SUPPORT_FILES_DIR}/example_wiki_pages/developer_can_sync_features_to_code.md"
+      end
+    end
+
+    def example_wiki_page_features
+      [addition_feature, division_feature]
+    end
+  end
+end