gitnesse 0.12.6 → 1.0.0.beta2

data/lib/gitnesse/wiki.rb

@@ -1,182 +1,119 @@
+Dir[File.dirname(__FILE__) + "/wiki/*.rb"].each { |f| require(f) }
+
+require 'git'
+
 module Gitnesse
   class Wiki
-    attr_accessor :wiki
-
-    def initialize(dir = Dir.mktmpdir)
-      @wiki = Gollum::Wiki.new(dir)
-      @commit_info = Gitnesse.generate_commit_info
-    end
+    attr_reader :repo, :pages, :dir
 
-    # Public: Loads the provided feature files into the wiki
+    # Public: Clones/updates a wiki in the provided dir
     #
-    # feature_files - a collection of files to search for features
-    #                 e.g. Dir.glob("./features/**/*.feature")
+    # url - cloneable URL for wiki repository
+    # dir - directory to clone git wiki into
+    # opts - hash of options:
+    #   clone - whether or not to clone/update local copy of remote wiki
     #
-    def load_feature_files(feature_files)
-      return if feature_files.nil?
+    # Returns a Gitnesse::Wiki object
+    def initialize(url, dir, opts={clone: true})
+      @url = url
+      @dir = dir
+      @opts = opts
+      @config = Gitnesse::Config.instance
+
+      clone_or_update_repo unless !opts[:clone]
 
-      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")
+      @repo ||= Git.init(dir)
 
-        if wiki_page
-          update_wiki_page(wiki_page, feature_name, feature_content)
-        else
-          create_wiki_page(feature_name, feature_content)
+      @pages = @repo.status.each_with_object([]) do |s, a|
+        if s.path =~ /\.feature\.md$/
+          a << Gitnesse::Wiki::Page.new("#{dir}/#{s.path}")
         end
       end
-    end
 
-    # Public: Returns the Wiki's pages
-    #
-    # Returns an array of Wiki pages
-    def pages
-      @wiki.pages
+      @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
+    # Public: Removes pages previously placed by Gitnesse. This includes the
+    # feature listing pages.
+    #
+    # Returns nothing.
+    def remove_features
+      @repo.status.each do |file|
+        if file.path =~ /^features(\.md|\ >)/
+          begin
+            @repo.remove(file.path)
+          rescue Git::GitExecuteError => e
+            # Git spat something on git rm [file]. Likely the file doesn't
+            # exist, or was previously removed and hasn't been committed yet.
+            # It's likely fine. If not, we'll abort and show the end user the
+            # error Git sent to us.
+            unless e.message =~ /did not match any files/
+              puts "  A Git error occured. The message it passed to us was:"
+              abort e.message
+            end
           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
+    # Public: Commits staged wiki changes
     #
     # 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)
+    def commit
+      begin
+        @repo.commit("Update features with Gitnesse")
+      rescue Git::GitExecuteError => e
+        unless e.message =~ /nothing to commit/
+          puts "  A Git error occured. The message it passed to us was:"
+          abort e.message
         end
       end
     end
 
-    # Public: Strips old cucumber results
-    #
-    # content - the string to remote old results from
+    # Public: Pushes new commits to remote wiki
     #
-    # 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
+    # Returns nothing
+    def push
+      @repo.push
     end
 
-    # Public: Appends results of cucumber scenario to wiki
+    # Public: Adds or updates wiki page
     #
-    # scenario - Cucumber scenario from After hook
+    # filename - filename for wiki page
+    # content - content for page
     #
-    # Returns a string containing the scenario result
-    def append_results(scenario)
-      filename = File.basename(scenario.feature.file, ".feature")
-      @commit_info[:message] = Gitnesse.configuration.info
-
-      self.pages.each do |page|
-        if page.name == filename || page.name == "#{filename}.feature"
-          if page.text_data.include? scenario.name
-            content = page.raw_data
+    # Returns a Wiki::Page
+    def add_page(filename, content)
+      full_filename = "#{@dir}/#{filename}"
 
-            case scenario.status
-            when :undefined then image = "![](https://s3.amazonaws.com/gitnesse/github/undefined.png)"
-            when :passed   then image = "![](https://s3.amazonaws.com/gitnesse/github/passing.png)"
-            when :failed   then image = "![](https://s3.amazonaws.com/gitnesse/github/failing.png)"
-            when :pending   then image = "![](https://s3.amazonaws.com/gitnesse/github/pending.png)"
-            else image = "![](https://s3.amazonaws.com/gitnesse/github/undefined.png)"
-            end
-
-            string = "\n#{image} \`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)
-            return string
-          end
-        end
+      if @pages.detect { |f| f.wiki_path == full_filename }
+        page = @pages.find { |f| f.wiki_path == full_filename }
+      else
+        page = Gitnesse::Wiki::Page.new(full_filename)
+        @pages << page
       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 "  \e[32mCreated page \e[0m#{name}."
+      page.write(content)
+      @repo.add(filename)
+      page
     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
+    private
+    # Private: Clones or Updates the local copy of the remote wiki
     #
-    # 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 "  \e[32mPage \e[0m#{page_name} \e[32mdidn't change\e[0m."
+    # Returns nothing
+    def clone_or_update_repo
+      if File.directory?(@dir + "/.git")
+        puts "  Updating local copy of remote wiki."
+        @repo = Git.open(@dir)
+        @repo.pull('origin', @config.branch)
       else
-        @wiki.update_page(wiki_page, page_name, :markdown, new_page_content, @commit_info)
-        puts "  \e[33mUpdated page \e[0m#{page_name}."
+        puts "  Creating local copy of remote wiki."
+        Dir.mkdir @dir unless File.directory?(@dir)
+        @repo = Git.clone @url, @dir
       end
+
+      @repo.checkout(@config.branch)
     end
   end
 end

data/lib/gitnesse.rb

@@ -1,107 +1,15 @@
-require 'bundler/setup'
-require 'gollum'
-require 'fileutils'
-require 'pathname'
-require 'tmpdir'
-require 'gitnesse/configuration'
-require 'gitnesse/git_config'
-require 'gitnesse/dependencies'
-require 'gitnesse/features'
-require 'gitnesse/hooks'
+require 'gitnesse/version'
+require 'gitnesse/config'
+require 'gitnesse/config_loader'
+require 'gitnesse/dependency_checker'
+require 'gitnesse/feature'
+require 'gitnesse/feature_extractor'
+require 'gitnesse/feature_transform'
+require 'gitnesse/dir_manager'
 require 'gitnesse/wiki'
+require 'gitnesse/hooks'
+
 require 'gitnesse/railtie' if defined?(Rails)
 
-# core module
 module Gitnesse
-  class << self
-    attr_accessor :configuration
-    attr_accessor :commit_info
-  end
-
-  self.configuration ||= Configuration.new
-
-  extend self
-
-  def self.configure
-    yield(configuration)
-  end
-
-  # -- all methods after this are module functions --
-  module_function
-
-  def run
-    if pull
-      Hooks.create
-      puts "\n  Now going to run Cucumber."
-      exec("cucumber #{Gitnesse.configuration.target_directory}/*.feature")
-    end
-  end
-
-  def push_results
-    if push
-      Hooks.create
-      puts "\n  Now going to run Cucumber."
-      exec("cucumber #{Gitnesse.configuration.target_directory}/*.feature")
-    end
-  end
-
-  # pull features from git wiki, and sync up with features dir
-  def pull
-    Dependencies.check
-
-    relative_path = Pathname.new(Gitnesse.configuration.target_directory).relative_path_from(Pathname.new(Dir.pwd))
-
-    puts "  Pulling features into ./#{relative_path} from #{Gitnesse.configuration.repository_url}."
-    Dir.mktmpdir do |tmp_dir|
-      if clone_feature_repo(tmp_dir)
-        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 "  \e[32mDone pulling features.\e[0m"
-    true
-  end
-
-  # push features back up to git wiki from features directory
-  def push
-    Dependencies.check
-    generate_commit_info
-
-    relative_path = Pathname.new(Gitnesse.configuration.target_directory).relative_path_from(Pathname.new(Dir.pwd))
-
-    puts "  Pushing features from ./#{relative_path} to #{Gitnesse.configuration.repository_url}."
-    Dir.mktmpdir do |tmp_dir|
-      if clone_feature_repo(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
-          `git push origin master &> /dev/null`
-        end
-      end
-    end
-    puts "  \e[32mDone pushing features.\e[0m"
-    true
-  end
-
-  def clone_feature_repo(dir)
-    output = `git clone #{Gitnesse.configuration.repository_url} #{dir} &> /dev/null`
-    $?.success?
-  end
-
-  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/spec/lib/cli/task/help_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'gitnesse/cli'
+
+module Gitnesse
+  describe Cli, type: :cli do
+    let(:overview) do
+      <<-EOS
+USAGE: gitnesse <task> [<args>]
+
+The gitnesse tasks are:
+  info   Prints current Gitnesse configuration
+  pull   Pulls features from remote git-based wiki
+  push   Pushes local features to remote git-based wiki
+  run    Pulls changes from remote git-based wiki, and runs Cucumber.
+
+See 'gitnesse help <task>' for more information on a specific task.
+      EOS
+    end
+
+    it 'displays help overview when called with no args' do
+      expect(gitnesse("")).to eq overview
+    end
+
+    it 'displays help overview when help task is called with no arguments' do
+      expect(gitnesse("help")).to eq overview
+    end
+
+    context "when no help text for a given topic is available" do
+      it "prints out a message" do
+        expect(gitnesse("help missing")).to eq "No help for task 'missing'\n"
+      end
+    end
+  end
+end

data/spec/lib/cli/task/info_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'gitnesse/cli'
+
+module Gitnesse
+  describe Cli, type: :cli do
+    let(:result) do
+      <<-EOS
+Current Gitnesse Configuration:
+    repository_url - [not set]
+      features_dir - features
+            branch - master
+  annotate_results - [not set]
+        identifier - [not set]
+      EOS
+    end
+
+    it "prints the current configuration" do
+      expect(Gitnesse::ConfigLoader).to receive(:find_and_load)
+      expect(gitnesse("info")).to eq result
+    end
+  end
+end

data/spec/lib/cli/task/pull_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'gitnesse/cli'
+
+module Gitnesse
+  describe Cli, type: :cli do
+    let(:help) do
+      <<-EOS
+USAGE: gitnesse pull
+
+Pulls features from remote git-based wiki
+
+Pulls the remote wiki, finds the feature files it contains, and updates the
+relevant local features, creating new ones if necessary.
+
+Examples:
+  gitnesse pull  # will pull features from remote wiki
+      EOS
+    end
+
+    it "has help info" do
+      expect(gitnesse("help pull")).to eq help
+    end
+  end
+end

data/spec/lib/cli/task/push_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'gitnesse/cli'
+
+module Gitnesse
+  describe Cli, type: :cli do
+    let(:help) do
+      <<-EOS
+USAGE: gitnesse push
+
+Pushes local features to remote git-based wiki
+
+Pushes the local features files to the remote git-based wiki, creating/updating
+wiki pages as necessary.
+
+Examples:
+  gitnesse push  # will push local features to remote wiki
+      EOS
+    end
+
+    it "has help info" do
+      expect(gitnesse("help push")).to eq help
+    end
+  end
+end

data/spec/lib/cli_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'gitnesse/cli'
+
+module Gitnesse
+  describe Cli, type: :cli do
+    describe "-v, --version" do
+      it "outputs the gem name and version" do
+        expect(gitnesse("--version")).to eq "gitnesse #{Gitnesse::VERSION}\n"
+        expect(gitnesse("-v")).to eq "gitnesse #{Gitnesse::VERSION}\n"
+      end
+    end
+  end
+end

data/spec/lib/config_loader_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe ConfigLoader do
+    let(:config) { Config.instance }
+
+    describe "#find_and_load" do
+      context "when no config file exists" do
+        before do
+          Dir.should_receive(:glob).and_return([])
+          ConfigLoader.should_receive(:raise_error).with("Can't find a gitnesse.rb file with Gitnesse configuration.")
+        end
+
+        it "raises an error" do
+          ConfigLoader.find_and_load
+        end
+      end
+
+      context "when one config file exists" do
+        before do
+          files = [Support.example_config_file_path]
+          Dir.should_receive(:glob).and_return(files)
+          ConfigLoader.should_receive(:load).and_return(true)
+          ConfigLoader.should_receive(:reject_irrelevant_files).and_return(files)
+        end
+
+        it "loads the config file" do
+          ConfigLoader.find_and_load
+        end
+      end
+
+      context "when multiple config files exist" do
+        before do
+          files = [Support.example_config_file_path, Support.example_config_file_path]
+          Dir.should_receive(:glob).and_return(files)
+          ConfigLoader.should_receive(:reject_irrelevant_files).and_return(files)
+          ConfigLoader.should_receive(:raise_error).with("Multiple configuration files found:", files)
+        end
+
+        it "raises an error" do
+          ConfigLoader.find_and_load
+        end
+      end
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+module Gitnesse
+  describe Config do
+    let(:config) { Config.instance }
+    let(:default_config_hash) do
+      {
+        annotate_results: false,
+        branch: 'master',
+        identifier: nil,
+        features_dir: 'features',
+        repository_url: nil
+      }
+    end
+
+    it "is a singleton" do
+      expect(Config.instance).to eq config
+      expect{Config.new}.to raise_error NoMethodError
+    end
+
+    it "has default settings" do
+      expect(config.branch).to eq 'master'
+      expect(config.annotate_results).to be_false
+      expect(config.features_dir).to eq 'features'
+    end
+
+    describe ".to_h" do
+      it "returns a hash of config data" do
+        expect(config.to_h).to eq default_config_hash
+      end
+    end
+
+    describe ".setup" do
+      context "when a block is not passed" do
+        it "returns the configuration hash" do
+          expect(Config.config).to eq default_config_hash
+        end
+      end
+
+      context "when a block is passed" do
+        before do
+          Config.config do |config|
+            config.annotate_results = true
+          end
+        end
+
+        let(:expected_results) do
+          default_config_hash.tap { |h| h[:annotate_results] = true }
+        end
+
+        it "allows for config values to be set" do
+          expect(config.annotate_results).to be_true
+        end
+
+        it "returns the configuration hash" do
+          expect(Config.config).to eq expected_results
+        end
+      end
+    end
+  end
+end