gitnesse 0.1.3 → 0.12.5

data/lib/gitnesse/dependencies.rb

@@ -0,0 +1,38 @@
+module Gitnesse
+  class Dependencies
+    class NoGitError < StandardError ; end
+    class NoCucumberError < StandardError ; end
+    class NoRepositoryURLError < StandardError ; end
+    class NoAnnotationInfoError < StandardError ; end
+
+    # Checks Gitnesse's dependencies, and throws an error if one of them is
+    # missing.
+    def self.check
+      check_git
+      check_cucumber
+      check_repository_url
+    end
+
+    protected
+
+    def self.check_git
+      raise NoGitError, "git not found or not working." unless Kernel.system("git --version")
+    end
+
+    def self.check_cucumber
+      raise NoCucumberError, "cucumber not found or not working." unless Kernel.system("cucumber --version")
+    end
+
+    def self.check_repository_url
+      raise NoRepositoryURLError, "You must select a repository_url to run Gitnesse." if Gitnesse.configuration.repository_url.nil?
+    end
+
+    def self.check_annotation_info
+      if Gitnesse.configuration.annotate_results
+        if Gitnesse.configuration.info.nil?
+          raise NoAnnotationInfoError, "You must enter local information to annotate test results in the wiki"
+        end
+      end
+    end
+  end
+end

data/lib/gitnesse/features.rb

@@ -0,0 +1,38 @@
+module Gitnesse
+  class Features
+
+    # Public: Writes a feature to disk, given the filename and the
+    # features.
+    #
+    # filename - the filename to use for the feature
+    # features - the features to write to disk
+    #
+    def self.write_file(filename, features)
+      File.open(filename, "w") do |file|
+        file.write(gather(features))
+      end
+    end
+
+    # Public: Gathers features for placing into files. Currently only supports
+    # one feature per page. Others are discarded
+    #
+    # page_features - the features
+    #
+    # Returns a string containing the
+    def self.gather(page_features)
+      return '' if page_features.nil? || page_features.empty?
+
+      features = ''
+
+      name, content = page_features.shift
+      puts "  # Pulling Feature: #{name}"
+      features += content
+
+      page_features.each do |name, feature|
+        puts "  # WARNING! Discarding Feature: #{name}"
+      end
+
+      features
+    end
+  end
+end

data/lib/gitnesse/git_config.rb

@@ -0,0 +1,39 @@
+module Gitnesse
+  class GitConfig
+    class NoValueSetError < StandardError ; end
+
+    # Public: Reads a value from the system's git config.
+    #
+    # key - the value to look up from the git config
+    #
+    # Returns a string containing the git config value or GitConfigNotFoundError
+    def self.read(key)
+      value = get_from_git_config key
+
+      if value.empty? || value == ''
+        raise NoValueSetError, "Cannot read git config value for #{key}"
+      end
+
+      value
+    end
+
+    private
+
+    # Private: Tries to fetch a value using git config --get
+    #
+    # key - the value to look up from the git config
+    #
+    # Returns a string containing the value supplied by git
+    def self.get_from_git_config(key)
+      value = ''
+
+      value = `git config --get #{key}`
+
+      if value.empty? || value == ''
+        value = `git config --get --global #{key}`
+      end
+
+      value.strip
+    end
+  end
+end

data/lib/gitnesse/hooks.rb

@@ -0,0 +1,50 @@
+module Gitnesse
+  class Hooks
+    @dir = File.join(Dir.home, ".gitnesse")
+
+    # Public: Sets up ~/.gitnesse for appending scenario results
+    #
+    # Returns nothing
+    def self.setup
+      Gitnesse::Configuration.load_using_search
+      FileUtils.rm_rf(@dir) if File.directory?(@dir)
+      Dir.mkdir(@dir)
+      `git clone #{Gitnesse.configuration.repository_url} #{@dir}`
+      Wiki.new(@dir).remove_past_results
+    end
+
+    # Public: Removes ~/.gitnesse after all cukes are run
+    #
+    # Returns nothing
+    def self.teardown
+      Dir.chdir(@dir) do
+        `git push origin master`
+      end
+
+      FileUtils.rm_rf(@dir)
+      FileUtils.rm(File.absolute_path("#{Gitnesse.configuration.target_directory}/support/gitnesse_hooks.rb"))
+    end
+
+    # Public: Adds hooks into Cucumber
+    #
+    # Returns nothing
+    def self.create
+      hook_file   = File.join(File.dirname(__FILE__), "support/hook.rb")
+      support_dir = File.absolute_path("#{Gitnesse.configuration.target_directory}/support")
+      target_file = File.join(support_dir, "gitnesse_hooks.rb")
+
+      Dir.mkdir(support_dir) unless File.directory?(support_dir)
+
+      File.write(target_file, File.read(hook_file))
+    end
+
+    # Public: Appends scenario results to relevant page in wiki
+    #
+    # scenario - the scenario results from Cucumber
+    #
+    # Returns nothing
+    def self.append_to_wiki(scenario)
+      Wiki.new(@dir).append_results(scenario)
+    end
+  end
+end

data/lib/gitnesse/railtie.rb

@@ -3,10 +3,10 @@ require 'rails'
 
 module Gitnesse
   class Railtie < Rails::Railtie
-  	railtie_name :gitnesse
+    railtie_name :gitnesse
 
     rake_tasks do
       load File.dirname(__FILE__) + '/tasks.rake'
     end
   end
-end
+end

data/lib/gitnesse/support/hook.rb

@@ -0,0 +1,11 @@
+require 'gitnesse'
+
+Gitnesse::Hooks.setup
+
+After do |scenario|
+  Gitnesse::Hooks.append_to_wiki(scenario)
+end
+
+at_exit do
+  Gitnesse::Hooks.teardown
+end

data/lib/gitnesse/tasks.rake

@@ -4,25 +4,31 @@ namespace :gitnesse do
 
   desc "Pull features from remote repository and run cucumber."
   task :run => :environment do
-    Gitnesse.load_config
+    Gitnesse::Configuration.load_using_search
     Gitnesse.run
   end
 
   desc "Pull features from remote git wiki repository."
   task :pull => :environment do
-    Gitnesse.load_config
+    Gitnesse::Configuration.load_using_search
     Gitnesse.pull
   end
 
   desc "Push features to remote git wiki repository."
   task :push => :environment do
-    Gitnesse.load_config
+    Gitnesse::Configuration.load_using_search
     Gitnesse.push
   end
 
+  desc "Push features to remote git wiki repository, run cucumber, and push results to wiki"
+  task :push => :environment do
+    Gitnesse::Configuration.load_using_search
+    Gitnesse.push_results
+  end
+
   desc "Dump the current config info to the console."
   task :info => :environment do
-    Gitnesse.load_config
-    puts Gitnesse.config_to_hash.to_yaml
+    Gitnesse::Configuration.load_using_search
+    puts Gitnesse.configuration.to_yaml
   end
-end
+end

data/lib/gitnesse/version.rb

@@ -1,3 +1,3 @@
 module Gitnesse
-  VERSION = "0.1.3"
+  VERSION = "0.12.5"
 end

data/lib/gitnesse/wiki.rb

@@ -0,0 +1,173 @@
+module Gitnesse
+  class Wiki
+    attr_accessor :wiki
+
+    def initialize(dir = Dir.mktmpdir)
+      @wiki = Gollum::Wiki.new(dir)
+      @commit_info = Gitnesse.generate_commit_info
+    end
+
+    # Public: Loads the provided feature files into the wiki
+    #
+    # feature_files - a collection of files to search for features
+    #                 e.g. Dir.glob("./features/**/*.feature")
+    #
+    def load_feature_files(feature_files)
+      return if feature_files.nil?
+
+      feature_files.each do |feature_file|
+        feature_name    = File.basename(feature_file, ".feature")
+        feature_content = File.read(feature_file)
+        wiki_page       = @wiki.page(feature_name)
+        wiki_page       ||= @wiki.page("#{feature_name}.feature")
+
+        if wiki_page
+          update_wiki_page(wiki_page, feature_name, feature_content)
+        else
+          create_wiki_page(feature_name, feature_content)
+        end
+      end
+    end
+
+    # Public: Returns the Wiki's pages
+    #
+    # Returns an array of Wiki pages
+    def pages
+      @wiki.pages
+    end
+
+    # Public: Extracts gherkins from wiki page
+    #
+    # page - Wiki page to get features from
+    #
+    # Returns a hash of Cucumber features
+    def self.extract_features(page)
+      data = page.respond_to?(:raw_data) ? page.raw_data : page
+      features = {}
+
+      if match_result = data.match(/\u0060{3}gherkin(.+)\u0060{3}/m)
+        captures = match_result.captures
+
+        # create hash with feature name as key and feature text as value
+        captures.each do |capture|
+          feature_definition_at = capture.index('Feature:')
+          feature_text = capture[feature_definition_at,capture.size-1]
+          feature_lines = feature_text.split("\n")
+          feature_definition = feature_lines.grep(/^Feature:/).first
+
+          if feature_definition
+            feature_name = feature_definition.split(":").last.strip.gsub(" ","-").downcase
+            features[feature_name] = feature_text
+          end
+        end
+      end
+
+      features
+    end
+
+    # Public: Builds wiki page content
+    #
+    # feature_content - Content to generate the page content from
+    # old_page_content - old page content to replace with new page content
+    #
+    # Returns a string containing the generated page content
+    def build_page_content(feature_content, old_page_content = nil)
+      content = "```gherkin\n#{feature_content}\n```"
+      return content if old_page_content.nil? || old_page_content.empty?
+
+      features = Wiki.extract_features(old_page_content)
+
+      _, old_feature_content = features.shift
+      old_page_content.sub(old_feature_content, feature_content)
+    end
+
+    # Public: Removes past Cucumber results from feature files
+    #
+    # Returns nothing
+    def remove_past_results
+      @commit_info[:message] = Gitnesse.configuration.info
+      features = Dir.glob("#{Gitnesse.configuration.target_directory}/*.feature")
+
+      features.each do |feature|
+        feature_name = File.basename(feature, ".feature")
+        page = @wiki.page(feature_name) || @wiki.page("#{feature_name}.feature")
+
+        if page
+          content = page.raw_data
+          content = strip_results(content)
+          @wiki.update_page(page, page.name, :markdown, content, @commit_info)
+        end
+      end
+    end
+
+    # Public: Strips old cucumber results
+    #
+    # content - the string to remote old results from
+    #
+    # Returns a string
+    def strip_results(content)
+      if content.match(/\u0060{3}gherkin.*\u0060{3}(.*)/m)[1]
+        [ "FAILED", "PASSED", "PENDING", "UNDEFINED" ].each do |type|
+          content.gsub!(/\n*\`Last result was #{type}: .*\n*/, '')
+        end
+      end
+      content
+    end
+
+    # Public: Appends results of cucumber scenario to wiki
+    #
+    # scenario - Cucumber scenario from After hook
+    #
+    # Returns nothing
+    def append_results(scenario)
+      pages = @wiki.pages
+      filename = File.basename(scenario.feature.file, ".feature")
+      @commit_info[:message] = Gitnesse.configuration.info
+
+      pages.each do |page|
+        if page.name == filename || page.name == "#{filename}.feature"
+          if page.text_data.include? scenario.name
+            content = page.raw_data
+            string = "\n\`Last result was #{scenario.status.to_s.upcase}: #{scenario.name} (#{Time.now.to_s} - #{Gitnesse.configuration.info})\`\n"
+            content.gsub(string, '')
+            content << string
+            @wiki.update_page(page, page.name, :markdown, content, @commit_info)
+          end
+        end
+      end
+    end
+
+    private
+
+    # Private: Creates a new wiki page for the provided name and content
+    #
+    # name - the name of the page to create
+    # content - the content the page should have
+    #
+    # Returns the newly created wiki page
+    def create_wiki_page(name, content)
+      new_page_content = build_page_content(content)
+      @wiki.write_page(name, :markdown, new_page_content, @commit_info)
+      puts "  # Created Page: #{name}"
+    end
+
+    # Private: Updates a wiki page with the provided name and content
+    #
+    # wiki_page - the page to update
+    # page_name - the name of the page
+    # feature_content - the feature content to compare/update
+    #
+    # Returns the page
+    def update_wiki_page(wiki_page, page_name, feature_content)
+      wiki_page_content = wiki_page.raw_data
+      new_page_content  = build_page_content(feature_content, wiki_page_content)
+
+      if new_page_content == wiki_page_content
+        puts "  # Page #{page_name} didn't change"
+      else
+        @wiki.update_page(wiki_page, page_name, :markdown, new_page_content, @commit_info)
+        puts "  # Updated Page: #{page_name}"
+      end
+    end
+  end
+end

data/test/lib/gitnesse/build_page_content_test.rb

@@ -1,6 +1,15 @@
 require_relative '../../test_helper'
 
-describe Gitnesse do
+describe Gitnesse::Wiki do
+  let(:dir) { Dir.mktmpdir }
+  let(:wiki) { Gitnesse::Wiki.new(dir) }
+
+  before do
+    Dir.chdir(dir) do
+      `git init`
+    end
+  end
+
   describe ".build_page_content" do
     let(:wiki_page_content) do
       <<-EOS
@@ -35,7 +44,7 @@ Feature: Addition
     end
 
     describe "without existing wiki page content" do
-      let(:method) { lambda { Gitnesse.build_page_content(new_feature_content) } }
+      let(:method) { lambda { wiki.build_page_content(new_feature_content) } }
       let(:expected_result) do
         "```gherkin
 Feature: Addition
@@ -55,7 +64,7 @@ Feature: Addition
     end
 
     describe "with existing wiki page content" do
-      let(:method) { lambda { Gitnesse.build_page_content(new_feature_content, wiki_page_content) } }
+      let(:method) { lambda { wiki.build_page_content(new_feature_content, wiki_page_content) } }
       let(:expected_result) do
         <<-EOS
 # Addition is Awesome