gitnesse 0.12.6 → 1.0.0.beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 319d9cc7127178d8e7fe987e28efec8c6229cfbe
+  data.tar.gz: 5568348a2109c7078ccfbd832b8957a7e96fdf0e
+SHA512:
+  metadata.gz: c6f71b9db9c3e09715e2a02f69a4a5b16fbdac250a620de68baf57251606363d0ef95e354e29c83200f2c064aecbd6a1a274185ea5b6b465100617551fb2c1c3
+  data.tar.gz: 080d0b3968b3ba38af8d3535d246c09f31d1ba5755584b792c6fb190f191e9b8e5c02d80ebae2321b10b89731332d34909da029c3e2b37aa45af4c7c7df745b1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/Rakefile

@@ -1,13 +1,8 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'rake/testtask'
-require_relative 'lib/gitnesse'
-require_relative 'lib/gitnesse/tasks'
+require 'bundler'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
-  t.libs << 'lib/gitnesse'
-  t.test_files = FileList['test/lib/gitnesse/*_test.rb']
-  t.verbose = true
-end
-task :default => :test
+Bundler::GemHelper.install_tasks
 
+task default: :spec
+
+RSpec::Core::RakeTask.new :spec

data/bin/gitnesse

@@ -1,35 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'gitnesse'
+require 'gitnesse/cli'
 
-Gitnesse::Configuration.load_using_search
-
-if ARGV[0].nil?
-  Gitnesse.run
-end
-
-def print_help
-  puts "Gitnesse commands:"
-  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"
-end
-
-case ARGV[0]
-when "push"
-  Gitnesse.push
-when "pull"
-  Gitnesse.pull
-when "run"
-  Gitnesse.run
-when "info"
-  puts Gitnesse.configuration.to_yaml
-when "push_results"
-  Gitnesse.push_results
-when "help"
-  print_help
-else
-  print_help
-end
+Gitnesse::Cli.new.parse

data/config/gitnesse.rb.example

@@ -1,5 +1,3 @@
-Gitnesse.configure do |config|
-  config.repository_url = "git@github.com:hybridgroup/gitnesse.wiki.git"
-  config.annotate_results = true
-  config.info = "Bob Martin's development laptop"
+Gitnesse::Config.config do |c|
+  c.repository_url = "https://github.com/hybridgroup/gitnesse.wiki.git"
 end

data/gitnesse.gemspec

@@ -1,25 +1,26 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gitnesse/version'
+require File.expand_path '../lib/gitnesse/version', __FILE__
 
-Gem::Specification.new do |gem|
-  gem.name          = "gitnesse"
-  gem.version       = Gitnesse::VERSION
-  gem.authors       = ["www.hybridgroup.com"]
-  gem.email         = ["info@hybridgroup.com"]
-  gem.description   = %q{Use github wiki to store feature stories, then execute then using Cucumber}
-  gem.summary       = %q{Features on git-based Wiki!}
-  gem.homepage      = "https://github.com/hybridgroup/gitnesse"
+Gem::Specification.new do |spec|
+  spec.name          = "gitnesse"
+  spec.version       = Gitnesse::VERSION
+  spec.authors       = ["www.hybridgroup.com"]
+  spec.email         = ["info@hybridgroup.com"]
+  spec.description   = %q{Gitnesse lets you sync Cucumber feature stories
+                          through a Git-based wiki, and display current
+                          scenario results on wiki pages}
+  spec.summary       = %q{Sync your feature stories using a Git-based wiki!}
+  spec.homepage      = "https://github.com/hybridgroup/gitnesse"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  gem.add_dependency("bundler")
-  gem.add_dependency("gollum","~> 2.3.12")
-  gem.add_development_dependency("minitest-matchers")
-  gem.add_development_dependency("mocha")
-  gem.add_development_dependency("cucumber")
-  gem.add_development_dependency("rake")
-  gem.executables = ['gitnesse']
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.3"
+  spec.add_dependency "git", "~> 1.2.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",   "~> 2.14.1"
+  spec.add_development_dependency "cucumber", "~> 1.3.4"
 end

data/lib/gitnesse/cli/helpers/config_helpers.rb

@@ -0,0 +1,13 @@
+module Gitnesse
+  class Cli
+    module ConfigHelpers
+      # Loads and checks Gitnesse configuration/dependencies
+      #
+      # Returns an instance of Gitnesse::Config
+      def load_and_check_config
+        Gitnesse::ConfigLoader.find_and_load
+        Gitnesse::DependencyChecker.new.check
+      end
+    end
+  end
+end

data/lib/gitnesse/cli/helpers/feature_helpers.rb

@@ -0,0 +1,26 @@
+module Gitnesse
+  class Cli
+    module FeatureHelpers
+      # Public: Creates or updates local cucumber features
+      #
+      # Returns nothing.
+      def create_or_update_local_features
+        puts "  Creating and updating local features."
+
+        @feature_pages.each do |page|
+          if File.exists?(page.path)
+            puts "    - Updating #{page.path}"
+          else
+            puts "    - Creating #{page.path}"
+            FileUtils.mkdir_p page.relative_path
+          end
+
+          feature = Gitnesse::Feature.new(page.path)
+          features = Gitnesse::FeatureExtractor.extract!(page.read)
+
+          feature.write(features.join("\n\n"))
+        end
+      end
+    end
+  end
+end

data/lib/gitnesse/cli/helpers/wiki_helpers.rb

@@ -0,0 +1,53 @@
+module Gitnesse
+  class Cli
+    module WikiHelpers
+      # Public: Clones or updates local copy of remote git-based wiki. Also prints
+      # message indicating which operation is taking place
+      #
+      # Returns instance of Gitnesse::Wiki referring to new/updated local wiki
+      def clone_wiki
+        opts = {}
+        @dir = Gitnesse::DirManager.project_dir
+
+        unless Gitnesse::DirManager.project_dir_present?
+          Gitnesse::DirManager.make_project_dir
+        end
+
+        @wiki = Gitnesse::Wiki.new @config.repository_url, @dir
+      end
+
+      # Public: Removes existing features from local copy of remote wiki.
+      #
+      # Returns nothing.
+      def remove_existing_features
+        @wiki.remove_features
+      end
+
+      # Public: Commits wiki changes, and pushes changes to remote wiki.
+      #
+      # Returns nothing.
+      def commit_and_push_changes
+        puts "  Commiting changes."
+        @wiki.commit
+
+        puts "  Pushing changes to remote wiki."
+        @wiki.push
+      end
+
+      # Public: Extracts wiki pages that contain cucumber features.
+      #
+      # Returns an array of wiki pages containing features
+      def extract_features_from_wiki
+        unless @wiki.pages.any?
+          abort "  Wiki contains no features."
+        end
+
+        puts "  Extracting wiki pages containing features."
+
+        @feature_pages = @wiki.pages.select do |page|
+          Gitnesse::FeatureExtractor.contains_features? page.read
+        end
+      end
+    end
+  end
+end

data/lib/gitnesse/cli/task/help.rb

@@ -0,0 +1,42 @@
+Gitnesse::Cli.task :help, nil do
+  def perform(name = nil)
+    return overview unless name
+
+    task = tasks_by_name[name]
+    abort "No help for task '#{name}'" unless task && task.help
+
+    puts task.help
+  end
+
+  private
+  def overview
+    puts <<-EOS
+USAGE: gitnesse <task> [<args>]
+
+The gitnesse tasks are:
+    EOS
+
+    tasks_to_show do |name, desc|
+      puts "  #{name}   #{desc}"
+    end
+
+    puts ''
+    puts "See 'gitnesse help <task>' for more information on a specific task."
+  end
+
+  def tasks_by_name
+    Gitnesse::Cli.tasks
+  end
+
+  def tasks
+    tasks_by_name.values.uniq
+  end
+
+  def tasks_to_show
+    size = tasks.map { |t| t.name.length }.max
+    tasks.sort_by(&:name).each do |task|
+      next unless task.desc
+      yield task.name.ljust(size), task.desc
+    end
+  end
+end

data/lib/gitnesse/cli/task/info.rb

@@ -0,0 +1,29 @@
+Gitnesse::Cli.task :info do
+  desc "Prints current Gitnesse configuration"
+
+  def perform
+    Gitnesse::ConfigLoader.find_and_load
+    config = Gitnesse::Config.instance.to_h
+    size = config.keys.map(&:length).max
+
+    puts "Current Gitnesse Configuration:"
+
+    config.each do |key, value|
+      puts "  #{key.to_s.rjust(size)} - #{value || "[not set]"}"
+    end
+  end
+
+  help do
+    <<-EOS
+USAGE: gitnesse info
+
+#{desc}
+
+Prints the current Gitnesse configuration settings, including settings loaded
+from gitnesse.rb configuration files.
+
+Examples:
+  gitnesse list  # will print current configuration
+    EOS
+  end
+end

data/lib/gitnesse/cli/task/pull.rb

@@ -0,0 +1,26 @@
+Gitnesse::Cli.task :pull do
+  desc "Pulls features from remote git-based wiki"
+
+  help do
+    <<-EOS
+USAGE: gitnesse pull
+
+#{desc}
+
+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
+
+  def perform
+    load_and_check_config
+    clone_wiki
+    extract_features_from_wiki
+    create_or_update_local_features
+
+    puts "  Done."
+  end
+end

data/lib/gitnesse/cli/task/push.rb

@@ -0,0 +1,101 @@
+Gitnesse::Cli.task :push do
+  desc "Pushes local features to remote git-based wiki"
+
+  help do
+    <<-EOS
+USAGE: gitnesse push
+
+#{desc}
+
+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
+
+  def perform
+    load_and_check_config
+    clone_wiki
+    remove_existing_features
+    collect_features
+    add_index_page
+    add_feature_index_pages_to_wiki
+    add_features_to_wiki
+    commit_and_push_changes
+
+    puts "  Done."
+  end
+
+  private
+  def collect_features
+    puts "  Collecting local features."
+    Dir.chdir @config.features_dir do
+      @features = Dir.glob("**/*.feature").each_with_object([]) do |f, a|
+        a << Gitnesse::Feature.new(f)
+      end
+    end
+
+    unless @features.any?
+      abort "  No local features found."
+    end
+  end
+
+  def add_feature_index_pages_to_wiki
+    nested = @features.group_by(&:index_page)
+    nested.reject! { |k,v| k == 'features.md' }
+
+    if nested.any?
+      puts "  Creating index pages:"
+    end
+
+    nested.each do |filename, features|
+      content = features.each_with_object("") do |f, s|
+        s << "- #{f.relative_link}\n"
+      end
+
+      puts "    - #{filename}"
+
+      @wiki.add_page(filename, content)
+    end
+  end
+
+  def add_features_to_wiki
+    puts "  Creating/updating wiki features:"
+    @features.each do |feature|
+      puts "    - #{feature.wiki_filename}"
+
+      filename = feature.wiki_filename
+      content = Gitnesse::FeatureTransform.convert(feature.read)
+      @wiki.add_page(filename, content)
+    end
+  end
+
+  def add_index_page
+    filename = "features.md"
+    content = "# Features\n\n"
+
+    puts "  Creating index page: #{filename}"
+
+    nested = @features.group_by(&:index_page)
+
+    if nested.key?("features.md") && nested["features.md"].any?
+      features = nested.delete("features.md")
+
+      features.each do |f|
+        content << "- #{f.relative_link}\n"
+      end
+    end
+
+    nested.each do |folder, features|
+      content << "- **[[#{folder.gsub('.md', '')}|#{folder}]]**\n"
+
+      features.each do |f|
+        content << "    - #{f.relative_link}\n"
+      end
+    end
+
+    @wiki.add_page(filename, content)
+  end
+end

data/lib/gitnesse/cli/task/run.rb

@@ -0,0 +1,85 @@
+Gitnesse::Cli.task :run do
+  desc "Pulls changes from remote git-based wiki, and runs Cucumber."
+
+  help do
+    <<-EOS
+USAGE: gitnesse run
+
+#{desc}
+
+Pulls changed features from remote git-based wiki, runs Cucumber, and pushes
+annotated results to the remote git-based wiki if the "annotate_results" setting
+is enabled.
+
+Examples:
+  gitnesse run  # will pull changes, run cucumber, and annotate results
+    EOS
+  end
+
+  def perform
+    load_and_check_config
+    clone_wiki
+    extract_features_from_wiki
+    create_or_update_local_features
+
+    puts "  Local features updated."
+
+    remove_existing_results_from_wiki
+
+    create_hooks
+    run_features
+    remove_hooks
+
+    push_annotated_results_to_wiki
+
+    puts "  Done."
+  end
+
+  # Public: Removes existing Gitnesse results from all wiki pages
+  #
+  # Returns nothing
+  def remove_existing_results_from_wiki
+    @wiki.pages.each(&:remove_results) if @config.annotate_results
+  end
+
+  # Public: Installs Gitnesse hooks for Cucumber
+  #
+  # Returns nothing
+  def create_hooks
+    if @config.annotate_results
+      puts "  Installing Gitnesse Cucumber hooks."
+      Gitnesse::Hooks.create!
+    end
+  end
+
+  # Public: Removes installed Gitnesse Cucumber hooks
+  #
+  # Returns nothing
+  def remove_hooks
+    if @config.annotate_results
+      puts "  Removing Gitnesse Cucumber hooks."
+      Gitnesse::Hooks.destroy!
+    end
+  end
+
+  # Public: Runs Cucumber features
+  #
+  # Returns nothing
+  def run_features
+    puts "  Running cucumber."
+    puts '  -------------------', ''
+    system "cucumber #{@config.features_dir}"
+    puts '  -------------------', ''
+  end
+
+  # Public: Pushes features with annotations to remote wiki
+  #
+  # Returns nothing
+  def push_annotated_results_to_wiki
+    if @config.annotate_results
+      puts "  Pushing annotated results to remote wiki."
+      @wiki.commit
+      @wiki.push
+    end
+  end
+end

data/lib/gitnesse/cli/task.rb

@@ -0,0 +1,67 @@
+Dir["#{File.dirname(__FILE__)}/helpers/*.rb"].each { |f| require f }
+
+module Gitnesse
+  class Cli
+    class Task
+      include Gitnesse::Cli::ConfigHelpers
+      include Gitnesse::Cli::FeatureHelpers
+      include Gitnesse::Cli::WikiHelpers
+
+      attr_accessor :out
+
+      class << self
+        attr_accessor :name
+
+        def desc(string = nil)
+          string ? @desc = string : @desc
+        end
+
+        def help
+          block_given? ? @help = yield : @help
+        end
+      end
+
+      def initialize(out)
+        @out = out
+        @config = Gitnesse::Config.instance
+      end
+
+      def perform(*); end
+      def description; end
+      def help; end
+
+      private
+      def puts(*args)
+        out.puts *args
+      end
+
+      def print(*args)
+        out.print *args
+      end
+
+      def abort(*args)
+        out.puts *args
+        exit 1
+      end
+    end
+
+    def tasks
+      @tasks ||= Hash[self.class.tasks.map { |name, t| [name, t.new(out)] }]
+    end
+
+    class << self
+      def task(*names, &block)
+        task = Class.new(Task, &block)
+        names.map!(&:to_s)
+        task.name = names.first
+        names.each { |name| tasks[name] = task }
+      end
+
+      def tasks
+        @tasks ||= {}
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/task/*.rb"].each { |f| require(f) }

data/lib/gitnesse/cli.rb

@@ -0,0 +1,55 @@
+require 'gitnesse'
+
+require 'optparse'
+require 'optparse/version'
+
+require 'gitnesse/cli/task'
+
+module Gitnesse
+  class Cli
+    attr_accessor :out, :parser
+
+    def initialize(out = STDOUT)
+      @out = out
+      setup_parser
+    end
+
+    def parse(args = ARGV)
+      parser.parse! args
+
+      arg = args.shift.to_s
+
+      if task = tasks[arg]
+        task.perform(*args)
+      else
+        abort "No such task."
+      end
+    end
+
+    private
+    def setup_parser
+      @parser = OptionParser.new do |o|
+        o.on_tail '-v', '--version' do
+          puts parser.ver
+          exit
+        end
+      end
+
+      parser.program_name = 'gitnesse'
+      parser.version = Gitnesse::VERSION
+    end
+
+    def print(*args)
+      out.print *args
+    end
+
+    def puts(*args)
+      out.puts *args
+    end
+
+    def abort(*args)
+      puts *args
+      exit 1
+    end
+  end
+end