gitnesse 0.12.6 → 1.0.0.beta2

data/lib/gitnesse/config.rb

@@ -0,0 +1,68 @@
+require 'singleton'
+
+module Gitnesse
+  class Config
+    include Singleton
+
+    ConfigStruct = Struct.new :repository_url, :features_dir, :branch,
+                              :annotate_results, :identifier
+
+    # Config Options:
+    #
+    # repository_url   - URl to remote git-based wiki.
+    # features_dir     - directory for local features. Defaults to "features"
+    # branch           - git branch of remote git-based wiki to use. Defaults to
+    #                    'master'
+    # annotate_results - boolean, determines if Gitnesse will annotate cucumber
+    #                    results to wiki pages. Defaults to false
+    # identifier       - if annotate_results is checked, an identifier to use
+    #                    to indicate who ran the cukes.
+    #                    e.g. "Uncle Bob's MacBook Air"
+
+    @@config = ConfigStruct.new
+
+    # default config options
+    @@config.annotate_results = false
+    @@config.branch = 'master'
+    @@config.features_dir = 'features'
+
+    # Allows external configuration of the ConfigStruct using a block.
+    #
+    # Accepts a block for config options
+    #
+    # Returns the current configuration
+    #
+    # Example:
+    #   @config = Gitnesse::Config.instance
+    #
+    #   Gitnesse::Config.config do |config|
+    #     config.annotate_results = true
+    #   end
+    #
+    #   @config.annotate_results #=> true
+    def self.config
+      yield @@config if block_given?
+      Hash[@@config.each_pair.to_a]
+    end
+
+    # Converts the current configuration option to a hash
+    #
+    # Returns a hash
+    def to_h
+      Hash[@@config.each_pair.to_a]
+    end
+
+    # Method_missing used to make it easier to access ConfigStruct values
+    #
+    # Example:
+    #   @config = Gitnesse::Config.instance
+    #   @config.annotate_results #=> false
+    def method_missing(method, *args, &block)
+      if @@config.respond_to?(method)
+        @@config.send(method, *args, &block)
+      else
+        raise NoMethodError
+      end
+    end
+  end
+end

data/lib/gitnesse/config_loader.rb

@@ -0,0 +1,36 @@
+module Gitnesse
+  class ConfigLoader
+    class ConfigFileError < StandardError ; end
+
+    def self.find_and_load
+      files = Dir.glob(File.join("**", "gitnesse.rb"))
+
+      files = reject_irrelevant_files files
+
+      files_with_config = files.select do |file_name|
+        file_content = File.read(file_name)
+        file_content.match("Gitnesse::Config.config do")
+      end
+
+      case files_with_config.length
+      when 0
+        raise_error "Can't find a gitnesse.rb file with Gitnesse configuration."
+      when 1
+        load(File.absolute_path(files_with_config.first))
+      else
+        raise_error "Multiple configuration files found:", files_with_config
+      end
+    end
+
+    private
+    def self.reject_irrelevant_files(files)
+      files.reject { |f| !!(File.absolute_path(f) =~ /.*(spec|vendor).*/) }
+    end
+
+    def self.raise_error(message, files = nil)
+      puts message
+      files.each { |f| puts f } if files
+      exit 1
+    end
+  end
+end

data/lib/gitnesse/dependency_checker.rb

@@ -0,0 +1,86 @@
+module Gitnesse
+  class DependencyChecker
+    attr_reader :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def check
+      check_git
+      check_cucumber
+      check_repository_url
+      check_identifier
+      check_features_dir_exists
+
+      display_errors if @errors.any?
+    end
+
+    def display_errors
+      puts "Configuration errors were found!"
+
+      @errors.each do |error|
+        puts "  - #{error}"
+      end
+
+      exit
+    end
+
+    # Checks that Git is installed on the system.
+    #
+    # Returns true or raises DependencyNotMetError if git is broken
+    def check_git
+      if system("git --version &> /dev/null")
+        true
+      else
+        @errors << "Git not found or not working"
+      end
+    end
+
+    # Checks that Cucumber is installed on the system.
+    #
+    # Returns true or raises DependencyNotMetError if Cucumber is broken
+    def check_cucumber
+      if system("cucumber --version &> /dev/null")
+        true
+      else
+        @errors << "Cucumber not found or not working"
+      end
+    end
+
+    # Checks that repository_url is set in Gitnesse::Config.
+    #
+    # Returns true or raises DependencyNotMetError if repository_url isn't set
+    def check_repository_url
+      url = Gitnesse::Config.instance.repository_url
+      if url.nil? || url.empty?
+        @errors << "You must specify a repository_url to run Gitnesse"
+      else
+        true
+      end
+    end
+
+    # Checks that identifier is set in Gitnesse::Config, if annotate_results is
+    # set.
+    #
+    # Returns true or raises DependencyNotMetError if identifier isn't set
+    def check_identifier
+      return true unless Gitnesse::Config.instance.annotate_results
+      identifier = Gitnesse::Config.instance.identifier
+      if identifier.nil? || identifier.empty?
+        @errors << "You must specify identifier to use the annotate_results option"
+      else
+        true
+      end
+    end
+
+    def check_features_dir_exists
+      dir = Gitnesse::Config.instance.features_dir
+      if File.directory?(dir)
+        true
+      else
+        @errors << "The features directory './#{dir}' does not exist."
+      end
+    end
+  end
+end

data/lib/gitnesse/dir_manager.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+
+module Gitnesse
+  class DirManager
+    # Public: Checks/Creates ~/.gitnesse/{{project_name}} dir.
+    # The project name is derived from the folder gitnesse is run in.
+    #
+    # Returns the path to the created project dir
+    def self.make_project_dir
+      FileUtils.mkdir_p project_dir
+      project_dir
+    end
+
+    # Public: Removes project dir, but not ~/.gitnesse dir
+    #
+    # Returns nothing
+    def self.remove_project_dir
+      FileUtils.rm_rf project_dir
+    end
+
+    # Public: Checks that project directory is present
+    #
+    # Returns a boolean indicating if the dir exists or not
+    def self.project_dir_present?
+      File.directory? project_dir
+    end
+
+    private
+    # Private: Constructs project dir path in ~/.gitnesse folder
+    #
+    # Returns a string path
+    def self.project_dir
+      project_name = File.basename Dir.pwd
+      "#{Dir.home}/.gitnesse/#{project_name}"
+    end
+  end
+end

data/lib/gitnesse/feature.rb

@@ -0,0 +1,63 @@
+module Gitnesse
+  class Feature
+    attr_accessor :filename
+
+    def initialize(filename)
+      if filename =~ /^\.\/features\/(.+)/
+        @filename = filename.scan(/^\.?\/?features\/(.+)/).flatten.first
+      else
+        @filename = filename
+      end
+
+      @config = Gitnesse::Config.instance
+    end
+
+    # Public: Converts feature filename into the filename used on the remote
+    # git-based wiki
+    #
+    # Returns the converted filename
+    def wiki_filename
+      "features/#{@filename}.md".gsub('/', ' > ')
+    end
+
+    # Public: Reads the feature's contents. Caches result so only reads from FS
+    # first time it's called.
+    #
+    # Returns a string
+    def read
+      @content ||= File.read("#{@config.features_dir}/#{@filename}")
+    end
+
+    # Public: Writes updated content to the feature, or creates a new feature if
+    # it doesn't exist.
+    #
+    # content - The new/updated content to write to the file
+    #
+    # Returns the passed content
+    def write(content)
+      File.open("#{@config.features_dir}/#{@filename}", 'w') do |f|
+        f.write content
+      end
+
+      @content = nil
+
+      content
+    end
+
+    # Public: Generates the path to the index page the feature would appear on.
+    # Used to group Features for creating index pages.
+    #
+    # Returns a string indicating the index page.
+    def index_page
+      p = wiki_filename.scan(/^(features\ \>\ .+) >/).flatten[0] || 'features'
+      p + ".md"
+    end
+
+    # Public: Generates relative link for wiki index pages.
+    #
+    # Returns a string containing the relative link as markdown
+    def relative_link
+      "[[#{wiki_filename.gsub('.md', '')}]]"
+    end
+  end
+end

data/lib/gitnesse/feature_extractor.rb

@@ -0,0 +1,29 @@
+module Gitnesse
+  class FeatureExtractor
+
+    # Extracts Cucumber features from a Markdown-formatted string
+    #
+    # string - Markdown-formatted string to find Cucumber features in
+    #
+    # Returns an array of matches
+    def self.extract!(string)
+      matches = string.scan(/\u0060{3}gherkin\s*(.+?)\u0060{3}/im).flatten
+
+      if matches.any?
+        # Remove newline characters from beginning/end of each feature
+        matches.map { |m| m.lstrip! ; m.chomp! }
+      else
+        []
+      end
+    end
+
+    # Checks if a string contains a Cucumber feature
+    #
+    # string - Markdown-formatted string to check for Cucumber features in
+    #
+    # Returns true if there are features, false otherwise
+    def self.contains_features?(string)
+      string.scan(/\u0060{3}gherkin\s*(.+?)\u0060{3}/im).flatten.any?
+    end
+  end
+end

data/lib/gitnesse/feature_transform.rb

@@ -0,0 +1,30 @@
+module Gitnesse
+  class FeatureTransform
+
+    # Converts a Cucumber feature into a Markdown string compatible with
+    # Github's Wiki system
+    #
+    # feature - Cucumber feature to convert to Markdown
+    #
+    # Returns a string
+    def self.convert(feature)
+      unless feature.scan(/^\s*?Feature\:(.+?)\n/).flatten.any?
+        return <<-EOS.chomp
+# Undefined Feature
+
+This feature hasn't been added yet.
+        EOS
+      end
+
+      title = feature.scan(/^\s*?Feature\:(.+?)\n/).flatten.first.lstrip.chomp
+
+      <<-EOS.chomp
+# #{title}
+
+```gherkin
+#{feature.chomp}
+```
+      EOS
+    end
+  end
+end

data/lib/gitnesse/hooks/gitnesse.rb

@@ -0,0 +1,5 @@
+require 'gitnesse'
+
+After do |scenario|
+  Gitnesse::Hooks.append_results(scenario)
+end

data/lib/gitnesse/hooks.rb

@@ -1,52 +1,49 @@
 module Gitnesse
   class Hooks
-    @dir = File.join(Dir.home, ".gitnesse")
+    @config = Gitnesse::Config.instance
 
-    # Public: Sets up ~/.gitnesse for appending scenario results
+    DIR = File.expand_path("./#{@config.features_dir}/support")
+    PATH = File.expand_path("./#{@config.features_dir}/support/gitnesse.rb")
+
+    # Public: Copies Gitnesse Cucumber hooks to Cucumber's support dir.
     #
     # 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} &> /dev/null`
-      Wiki.new(@dir).remove_past_results
+    def self.create!
+      FileUtils.mkdir_p DIR unless File.directory?(DIR)
+
+      file = File.expand_path("#{File.dirname(__FILE__)}/hooks/gitnesse.rb")
+      FileUtils.cp file, PATH
     end
 
-    # Public: Removes ~/.gitnesse after all cukes are run
+    # Public: Removes existing Gitnesse hooks in Cucumber's support dir
     #
     # Returns nothing
-    def self.teardown
-      puts "  Pushing Cucumber results to wiki."
-      Dir.chdir(@dir) do
-        `git push origin master &> /dev/null`
-      end
-
-      FileUtils.rm_rf(@dir)
-      FileUtils.rm(File.absolute_path("#{Gitnesse.configuration.target_directory}/support/gitnesse_hooks.rb"))
-      puts "  Done."
+    def self.destroy!
+      FileUtils.rm PATH, force: true
     end
 
-    # Public: Adds hooks into Cucumber
+    # Public: Used by Gitnesse hook to append results to wiki page for feature
+    #
+    # scenario - Cucumber scenario passed by post-scenario hook
     #
     # 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")
+    def self.append_results(scenario)
+      Gitnesse::ConfigLoader.find_and_load
+      dir = Gitnesse::DirManager.project_dir
 
-      Dir.mkdir(support_dir) unless File.directory?(support_dir)
+      file = scenario.file.gsub(/^#{@config.features_dir}\//, '')
 
-      File.write(target_file, File.read(hook_file))
-    end
+      page = file.gsub("/", " > ")
+      name = scenario.name
+      status = scenario.status
 
-    # 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)
+      @wiki = Gitnesse::Wiki.new(@config.repository_url, dir, clone: false)
+      page = @wiki.pages.find { |f| f.wiki_path.include?(page) }
+
+      return unless page
+
+      page.append_result name, status
+      @wiki.repo.add(page.wiki_path)
     end
   end
 end

data/lib/gitnesse/railtie.rb

@@ -1,4 +1,6 @@
 require 'gitnesse'
+require 'gitnesse/cli/task'
+
 require 'rails'
 
 module Gitnesse
@@ -6,7 +8,7 @@ module Gitnesse
     railtie_name :gitnesse
 
     rake_tasks do
-      load File.dirname(__FILE__) + '/tasks.rake'
+      load File.dirname(__FILE__) + '/rake/tasks.rake'
     end
   end
 end

data/lib/gitnesse/rake/tasks.rake

@@ -0,0 +1,11 @@
+namespace :gitnesse do
+  task :environment do
+  end
+
+  Gitnesse::Cli.tasks.values.each do |task|
+    desc(task.desc) if task.desc
+    task task.name.to_sym => :environment do
+      task.new(STDOUT).perform
+    end
+  end
+end

data/lib/gitnesse/tasks.rb

@@ -1,8 +1,11 @@
-require "rake"
-require "rake/tasklib"
+require 'gitnesse'
+require 'gitnesse/cli/task'
+
+require 'rake'
+require 'rake/tasklib'
 
 module Gitnesse
   class Tasks < ::Rake::TaskLib
-    load File.dirname(__FILE__) + '/tasks.rake'
+    load File.dirname(__FILE__) + "/rake/tasks.rake"
   end
-end
+end

data/lib/gitnesse/version.rb

@@ -1,3 +1,3 @@
 module Gitnesse
-  VERSION = "0.12.6"
+  VERSION = "1.0.0.beta2"
 end

data/lib/gitnesse/wiki/page.rb

@@ -0,0 +1,103 @@
+module Gitnesse
+  class Wiki
+    class Page
+      attr_reader :wiki_path, :path, :filename, :relative_path
+
+      # Public: Creates a new Wiki Page object. Contains references to the page
+      # and an easy way to access/update relevant page data.
+      #
+      # path - full path to the file
+      #
+      # Returns a Wiki::Page object
+      def initialize(path)
+        @wiki_path = path
+        @relative_path = get_relative_path
+        @filename = get_filename
+        @path = "#{@relative_path}/#{@filename}"
+      end
+
+      # Public: Reads the file's contents. Caches result so only reads from FS
+      # first time it's called per page.
+      #
+      # Returns a string
+      def read
+        @content ||= File.read(@wiki_path)
+      end
+
+      # Public: Writes content to the file.
+      #
+      # Returns the passed content
+      def write(content)
+        File.open(@wiki_path, 'w+') do |f|
+          f.write content
+        end
+
+        @content = nil
+
+        content
+      end
+
+      # Public: Removes existing results from the feature page.
+      #
+      # Returns nothing
+      def remove_results
+        write(read.gsub(/(\s+\!\[\].*)/, ''))
+      end
+
+      # Public: Appends the result of a Cucumber scenario to the feature's wiki
+      # page.
+      #
+      # scenario - feature scenario that was run
+      # status - return status of the scenario, e.g. :passed, :undefined,
+      # :failing
+      #
+      # Returns nothing
+      def append_result(scenario, status)
+        status = status.to_s
+        image = "![](https://s3.amazonaws.com/gitnesse/github/#{status}.png)"
+        string = "\n\n#{image} \`"
+        string << "Last Result For Scenario '#{scenario}': "
+        string << status.upcase
+        string << " (#{Time.now.strftime("%b %d, %Y, %-l:%M %p")} - "
+        string << "#{Gitnesse::Config.instance.identifier})\`"
+
+        write(read + string)
+      end
+
+      protected
+      # Protected: Converts wiki-formatted filename into directories containing
+      # the page.
+      #
+      # Wiki filenames are formatted to accomodate nested directories, so for
+      # example the local feature "features/thing/thing.feature" would be given
+      # the filename "features > thing > thing.feature" in the wiki.
+      #
+      # path - path to convert
+      #
+      # Returns a string dir path
+      #
+      # Examples:
+      #   @wiki_path = "features > thing > thing.feature.md"
+      #   get_relative_path #=> "./features/thing"
+      #
+      #   @wiki_path = "thing.feature"
+      #   get_relative_path #=> "./features"
+      def get_relative_path
+        dirs = File.basename(@wiki_path).scan(/(\w+)\ \>/).flatten
+        dirs.shift if dirs.first == "features"
+        "./#{Gitnesse::Config.instance.features_dir}/#{dirs.join("/")}"
+      end
+
+      # Protected: Extracts the local filename for the wiki page
+      #
+      # Returns a string containing the filename
+      #
+      # Examples:
+      #   @wiki_path = "features > thing > thing.feature.md"
+      #   get_filename #=> "thing.feature"
+      def get_filename
+        File.basename(@wiki_path, '.md').scan(/(\w+\.feature)$/).flatten.first
+      end
+    end
+  end
+end