gitnesse 0.1.3 → 0.12.5

data/README.md

@@ -1,8 +1,10 @@
 # Gitnesse
 
- Gitnesse is a Cucumber-wiki integration tool.
- It enables a project to store cucumber features in a git-based wiki, and then test them against your code.
- Conceptually influenced by Fitnesse http://fitnesse.org/
+ Gitnesse is an acceptance testing tool.
+
+ It enables a project to store Cucumber feature stories in a git-based wiki, test them against your code, and then update the wiki with the latest test results.
+
+ Conceptually influenced by Fitnesse http://fitnesse.org/ thank you Uncle Bob!
 
 ## Installation
 
@@ -21,8 +23,10 @@ Or install it yourself as:
 Create a `gitnesse.rb` file somewhere in your project, and add something like
 the following to it:
 
-    Gitnesse.config do
-      repository_url "git@github.com:hybridgroup/gitnesse-demo.wiki"
+    Gitnesse.configure do |config|
+      config.repository_url = "git@github.com:hybridgroup/gitnesse-demo.wiki"
+      config.annotate_results = true
+      config.info = "Bob Martin's development laptop"
     end
 
 ## rake tasks
@@ -31,6 +35,7 @@ the following to it:
     $ rake gitnesse:push
     $ rake gitnesse:run
     $ rake gitnesse:info
+    $ rake gitnesse:push_results
 
 ## Usage In Rails 3
 
@@ -48,14 +53,15 @@ There is an example application using Sinatra located here: [https://github.com/
 
 ## Other Usage
 
-Want to use plain old Gitnesse? There is an executable that requires the path to the configuration file:
+Want to use plain old Gitnesse? There is an executable, if you're allergic to rake tasks:
+
+    $ gitnesse
 
-    $ GITNESSE_CONFIG='./gitnesse_config.rb' gitnesse
 
 ## TODO
 
-	- test git push back to git wiki
-	- pluggable feature runners, so can be used with Spinach, Cucumber-JS, or ?
+    - pluggable feature runners, so can be used with Spinach, Cucumber-JS, or ?
+    - standalone server so end users to run tests and see live results, just like Fitnesse
 
 ## Contributing
 

data/bin/gitnesse

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'gitnesse'
 
-Gitnesse.load_config
+Gitnesse::Configuration.load_using_search
 
 if ARGV[0].nil?
   Gitnesse.run
@@ -11,7 +11,7 @@ end
 
 def print_help
   puts "Gitnesse commands:"
-  puts "  run: pull remote features from git-based wiki to local, and run Cucumber"
+  puts "  run:  pull remote features from git-based wiki to local, and run Cucumber"
   puts "  push: push local features to git-based wiki"
   puts "  pull: pull remote features from git-based wiki to local"
   puts "  info: print current Gitnesse configuration"
@@ -25,7 +25,9 @@ when "pull"
 when "run"
   Gitnesse.run
 when "info"
-  puts Gitnesse.config_to_hash.to_yaml
+  puts Gitnesse.configuration.to_yaml
+when "push_results"
+  Gitnesse.push_results
 when "help"
   print_help
 else

data/lib/gitnesse.rb

@@ -2,77 +2,27 @@ require 'bundler/setup'
 require 'gollum'
 require 'fileutils'
 require 'tmpdir'
+require 'gitnesse/configuration'
+require 'gitnesse/git_config'
+require 'gitnesse/dependencies'
+require 'gitnesse/features'
+require 'gitnesse/hooks'
+require 'gitnesse/wiki'
 require 'gitnesse/railtie' if defined?(Rails)
 
 # core module
 module Gitnesse
-
-  extend self
-
-  # Public: Set url of the git-based wiki repo containing features.
-  #
-  # repository_url - A String containing your repo's url.
-  #
-  # Example:
-  #
-  #   Gitnesse.config do
-  #     repository_url  "git@github.com:luishurtado/gitnesse-wiki.wiki"
-  #   end
-  #
-  def self.repository_url(repository_url = false)
-    if repository_url == false
-      unless defined?(@@repository_url)
-        puts "---"
-        puts "No repository_url has been defined for Gitnesse."
-        puts "Add a gitnesse.rb file to your project and use it to configure Gitnesse."
-        puts "For more details, check out gitnesse.com"
-        auts "---"
-        exit 1
-      end
-      return @@repository_url
-    else
-      @@repository_url = repository_url
-    end
+  class << self
+    attr_accessor :configuration
+    attr_accessor :commit_info
   end
 
-  # Public: Set branch of the git-based wiki repo containing features.
-  #
-  # branch - A String containing which branch of your repo to use.
-  #
-  # Example:
-  #
-  #   Gitnesse.config do
-  #     branch "master"
-  #   end
-  #
-  def self.branch(branch = false)
-    if branch == false
-      @@branch ||= "master"
-    else
-      @@branch = branch
-    end
-  end
+  self.configuration ||= Configuration.new
 
-  # Public: Set local directory used to sync with git-wiki stored feature stories.
-  #
-  # target_directory - A String containing which directory to use.
-  #
-  # Example:
-  #
-  #   Gitnesse.config do
-  #     target_directory "features"
-  #   end
-  #
-  def self.target_directory(target_directory = false)
-    if target_directory == false
-      @@target_directory ||= File.join(Dir.pwd, 'features')
-    else
-      @@target_directory = target_directory
-    end
-  end
+  extend self
 
-  def self.config(&block)
-    instance_eval &block
+  def self.configure
+    yield(configuration)
   end
 
   # -- all methods after this are module functions --
@@ -80,44 +30,52 @@ module Gitnesse
 
   def run
     if pull
+      Hooks.create
+      puts "Now going to run cucumber..."
+      exec("cucumber #{Gitnesse.configuration.target_directory}/*.feature")
+    end
+  end
+
+  def push_results
+    if push
+      Hooks.create
       puts "Now going to run cucumber..."
-      exec("cucumber #{Gitnesse.target_directory}/*.feature")
+      exec("cucumber #{Gitnesse.configuration.target_directory}/*.feature")
     end
   end
 
   # pull features from git wiki, and sync up with features dir
   def pull
-    ensure_git_available
-    ensure_cucumber_available
-    ensure_repository
+    Dependencies.check
 
-    puts "Pulling features into #{Gitnesse.target_directory} from #{Gitnesse.repository_url}..."
+    puts "Pulling features into #{Gitnesse.configuration.target_directory} from #{Gitnesse.configuration.repository_url}..."
     Dir.mktmpdir do |tmp_dir|
       if clone_feature_repo(tmp_dir)
-        FileUtils.mkdir(Gitnesse.target_directory) unless File.exists?(Gitnesse.target_directory)
-
-        wiki_pages = Gollum::Wiki.new(tmp_dir).pages
-        wiki_pages.each do |wiki_page|
-          page_name =  wiki_page.name.gsub('.feature', '')
-          page_features = extract_features(wiki_page.raw_data)
-          write_feature_file(page_name, page_features) unless page_features.empty?
+        FileUtils.mkdir(Gitnesse.configuration.target_directory) unless File.exists?(Gitnesse.configuration.target_directory)
+
+        wiki_pages = Wiki.new(tmp_dir).pages
+        wiki_pages.each do |page|
+          name =  page.name.gsub('.feature', '')
+          filename = "#{Gitnesse.configuration.target_directory}/#{name}.feature"
+          features = Wiki.extract_features(page)
+          Features.write_file(filename, features) unless features.empty?
         end
       end
     end
-    puts "DONE."
+    puts "  Done pulling features."
+    true
   end
 
   # push features back up to git wiki from features directory
   def push
-    ensure_git_available
-    ensure_cucumber_available
-    ensure_repository
-    commit_info
+    Dependencies.check
+    generate_commit_info
 
-    puts "Pushing features from #{Gitnesse.target_directory} to #{Gitnesse.repository_url}..."
+    puts "Pushing features from #{Gitnesse.configuration.target_directory} to #{Gitnesse.configuration.repository_url}..."
     Dir.mktmpdir do |tmp_dir|
       if clone_feature_repo(tmp_dir)
-        load_feature_files_into_wiki(tmp_dir)
+        feature_files = Dir.glob("#{Gitnesse.configuration.target_directory}/*.feature")
+        Wiki.new(tmp_dir).load_feature_files(feature_files)
 
         # push the changes to the remote git
         Dir.chdir(tmp_dir) do
@@ -125,178 +83,21 @@ module Gitnesse
         end
       end
     end
-    puts "DONE."
-  end
-
-  def load_feature_files_into_wiki(tmp_dir)
-    wiki = Gollum::Wiki.new(tmp_dir)
-    feature_files = Dir.glob("#{Gitnesse.target_directory}/*.feature")
-
-    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, wiki_page, feature_name, feature_content)
-      else
-        create_wiki_page(wiki, feature_name, feature_content)
-      end
-    end
-  end
-
-  def create_wiki_page(wiki, page_name, feature_content)
-    new_page_content = build_page_content(feature_content)
-
-    wiki.write_page(page_name, :markdown, new_page_content, commit_info)
-    puts "==== Created page: #{page_name} ==="
-  end
-
-  def update_wiki_page(wiki, 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
-
-  def build_page_content(feature_content, wiki_page_content = nil)
-    return "```gherkin\n#{feature_content}\n```" if wiki_page_content.nil? || wiki_page_content.empty?
-    features = extract_features(wiki_page_content)
-
-    # replace the first feature found in the wiki page
-    _, old_feature_content = features.shift
-    wiki_page_content.sub(old_feature_content, feature_content)
-  end
-
-  # look thru wiki page for features
-  def extract_features(data)
-    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
+    puts "  Done pushing features."
+    true
   end
 
   def clone_feature_repo(dir)
-    output = `git clone #{Gitnesse.repository_url} #{dir} 2>&1`
+    output = `git clone #{Gitnesse.configuration.repository_url} #{dir} 2>&1`
     puts output
     $?.success?
   end
 
-  def commit_info
-    @commit_info ||= begin
-      user_name = read_git_config("user.name")
-      email = read_git_config("user.email")
-      raise "Can't read git's user.name config" if user_name.nil? || user_name.empty?
-      raise "Can't read git's user.email config" if email.nil? || email.empty?
-
-      {:name => user_name, :email => email, :message => "Update features with Gitnesse"}
-    end
-  end
-
-  def commit_info=(commit_info)
-    @commit_info = commit_info
-  end
-
-  def read_git_config(config_name)
-    config_value = ""
-    config_value = `git config --get #{config_name}`
-    config_value = `git config --get --global #{config_name}` unless $?.success?
-    config_value.strip
-  end
-
-  # we are going to support only one feature per page
-  def gather_features(page_features)
-    return "" if page_features.nil? or page_features.empty?
-
-    features = ''
-    feature_name, feature_content = page_features.shift
-    puts "============================== Pulling Feature: #{feature_name} =============================="
-    features = features + feature_content
-
-    page_features.each do |_feature_name, _feature_content|
-      puts "============================== WARNING! Discarded Feature: #{_feature_name} =============================="
-      puts _feature_content
-    end
-
-    features
-  end
-
-  def write_feature_file(page_name, page_features)
-    File.open("#{Gitnesse.target_directory}/#{page_name}.feature","w") {|f| f.write(gather_features(page_features)) }
-  end
-
-  def ensure_git_available
-    raise "git not found or not working." unless Kernel.system("git --version")
-  end
-
-  def ensure_cucumber_available
-    raise "cucumber not found or not working." unless Kernel.system("cucumber --version")
-  end
-
-  def ensure_repository
-    raise "You must select a repository_url to run Gitnesse." if Gitnesse.repository_url.nil?
-  end
-
-  def load_config
-    load(ENV['GITNESSE_CONFIG']) and return if ENV['GITNESSE_CONFIG']
-
-    possible_config_files = Dir.glob(File.join("**", "gitnesse.rb"))
-
-    files_with_config = possible_config_files.select do |file_name|
-      if FileUtils.compare_file(__FILE__, file_name)
-        false
-      elsif File.fnmatch("vendor/**/*.rb", file_name)
-        false
-      else
-        file_content = File.read(file_name)
-        file_content.match("Gitnesse.config")
-      end
-    end
-
-    case files_with_config.length
-      when 0
-        raise "Can't find a gitnesse.rb file with Gitnesse configuration."
-      when 1
-        load(File.absolute_path(files_with_config.first))
-      else
-        raise "Several config files found: #{files_with_config.join(", ")}"
-    end
-  end
-
-  def config_to_hash
-    { "repository_url" => Gitnesse.repository_url,
-      "branch" => Gitnesse.branch,
-      "target_directory" => Gitnesse.target_directory }
-  end
-
-  def method_missing(sym, *args, &block)
-    unless ["to_str", "to_ary"].contains?(sym)
-      raise "Invalid variable name for Gitnesse configuration.
-             Allowed variables are repository_url, branch, and target_directory."
-    else
-      super
+  def generate_commit_info
+    self.commit_info ||= begin
+      user_name = GitConfig.read("user.name")
+      email = GitConfig.read("user.email")
+      { :name => user_name, :email => email, :message => "Update features with Gitnesse" }
     end
   end
 end

data/lib/gitnesse/configuration.rb

@@ -0,0 +1,54 @@
+module Gitnesse
+  class Configuration
+    attr_accessor :repository_url
+    attr_accessor :branch
+    attr_accessor :target_directory
+    attr_accessor :annotate_results
+    attr_accessor :info
+
+    class NoConfigFileError < StandardError ; end
+    class MultipleConfigFileError < StandardError ; end
+
+    def initialize
+      @branch = 'master'
+      @target_directory = File.join(Dir.pwd, 'features')
+      @annotate_results = false
+      @info = nil
+    end
+
+    # Public: Returns the current Gitnesse configuration as a Hash
+    #
+    # Returns a hash containing the current Gitnesse configuration
+    def to_hash
+      { 'repository_url'   => @repository_url,
+        'branch'           => @branch,
+        'target_directory' => @target_directory }
+    end
+
+    def self.load_using_search
+      load(ENV['GITNESSE_CONFIG']) and return if ENV['GITNESSE_CONFIG']
+
+      possible_config_files = Dir.glob(File.join("**", "gitnesse.rb"))
+
+      files_with_config = possible_config_files.select do |file_name|
+        if FileUtils.compare_file(__FILE__, file_name)
+          false
+        elsif File.fnmatch("vendor/**/*.rb", file_name)
+          false
+        else
+          file_content = File.read(file_name)
+          file_content.match("Gitnesse.configure")
+        end
+      end
+
+      case files_with_config.length
+        when 0
+          raise NoConfigFileError, "Can't find a gitnesse.rb file with Gitnesse configuration."
+        when 1
+          load(File.absolute_path(files_with_config.first))
+        else
+          raise MultipleConfigFileError, "Several config files found: #{files_with_config.join(", ")}"
+      end
+    end
+  end
+end