cukehead 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Bill Melvin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,55 @@
+== cukehead
+
+=== Introduction
+
+Cukehead provides hours (well, maybe a couple minutes) of fun
+exploring Cucumber feature files in the form of FreeMind mind 
+maps. If you want to create feature files based on a mind map
+it can do that too but I'm not sure anyone will want to do 
+that.
+
+Cukehead is the result of the author wanting to learn how Cucumber works
+in preparation for a Rails project during the same period of time he was
+exploring mind mapping software in a questionable attempt to become more
+organized. Somehow the two came together as an exercise to learn how to
+build a Ruby application.
+
+
+=== Usage
+
+cukehead command [options]
+
+command:
+  map
+      Read Cucumber feature files and create a FreeMind mind map file.
+
+  cuke
+      Read a FreeMind mind map file and create Cucumber feature files.
+
+options:
+  -h or --help
+      Show the help text.
+
+  -o or --overwrite
+      Overwrite existing output file(s).
+
+  -m FILENAME or --mm-filename FILENAME
+      map: Name of output file (default is mm/cukehead-output.mm).
+
+  -f PATH or --features-path PATH
+      map: Directory containing feature files to read (default is directory
+      named 'features' in current directory).
+
+      cuke: Directory feature files  will be written to.
+
+  -s FILENAME or --source-mm FILENAME
+      map: FreeMind mind map file to use as a template for creating
+      the output file. If the template contains a node with the text
+      'Cucumber features:' then the feature nodes will be inserted there.
+
+=== Resources
+
+Cucumber project: http://cukes.info/
+
+FreeMind project: http://freemind.sourceforge.net/wiki/index.php/Main_Page
+

data/Rakefile

@@ -0,0 +1,101 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'cucumber/rake/task'
+
+GEM = 'cukehead'
+
+spec = Gem::Specification.new do |s|
+  s.name = "cukehead"
+  s.version = "0.1.1"
+  s.author = "Bill Melvin"
+  s.email = "bill@bogusoft.com"
+  s.homepage = "http://www.bogusoft.com/cukehead/"
+  s.description = s.summary = "A gem that creates a FreeMind mind map from Cucumber feature files and vice versa."
+  
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  #s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.extra_rdoc_files = ["README"]
+  #s.summary = SUMMARY
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  #s.autorequire = GEM
+
+  #s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+
+  s.executables = ["cukehead"]
+
+  files = []
+  File.open('Manifest.txt', 'r') {|f| f.each {|line| files << line.strip}}
+  s.files = files
+end
+
+#task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  #t.spec_opts = %w(-fs --color)
+  t.spec_opts = %w(-fs --color --debug)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+#desc "install the gem locally"
+#task :install => [:package] do
+#  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+#end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+
+desc "run unit tests"
+Rake::TestTask.new("unit_tests") {|t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}
+
+
+desc "Run RDoc to generate documentation"
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'doc/rdocs'
+  rd.main = 'README'
+  rd.rdoc_files.include 'README', "lib/**/*\.rb"
+  rd.options << '--all'
+  rd.options << '--inline-source'
+  #rd.options << '--line-numbers'
+end
+
+
+desc "Cucumber features"
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+
+desc "Make feature files from CukeHead mind map"
+task 'cukehead' do
+  sh "bin/cukehead cuke -m mm/CukeHead.mm -o"
+end
+
+
+task :cuke => [:cukehead, :features]
+
+task :default => [:unit_tests, :spec, :cuke]

data/bin/cukehead

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'cukehead'
+
+app = Cukehead::App.new
+app.run

data/lib/cukehead.rb

@@ -0,0 +1 @@
+require 'cukehead/app'

data/lib/cukehead/app.rb

@@ -0,0 +1,241 @@
+require 'getoptlong'
+require 'fileutils'
+require 'cukehead/feature_reader'
+require 'cukehead/freemind_writer'
+require 'cukehead/freemind_reader'
+require 'cukehead/feature_writer'
+
+module Cukehead
+
+  # The Cukehead::App class is responsible for responding to
+  # command line arguments and providing the main functionality
+  # of the cukehead application.
+  #
+  class App
+    attr_accessor :features_path
+    attr_accessor :mindmap_filename
+    attr_accessor :mindmap_template_filename
+    attr_accessor :do_overwrite
+    attr_reader :errors
+    attr_reader :feature_reader
+
+    def initialize
+      @command = ''
+      @features_path = File.join(Dir.getwd, 'features')
+      @mindmap_filename = File.join(Dir.getwd, 'mm', 'cukehead-output.mm')
+      @mindmap_template_filename = ''
+      @feature_reader = nil
+      @mindmap_reader = nil
+      @do_overwrite = false
+      @errors = []
+    end
+
+
+    # Main entry point for executing the cukehead application.
+    # Responsible for responding to the command line arguments.
+    #
+    def run
+      get_options
+      if @errors.empty?
+        if @command == 'map'
+          read_features
+          write_mindmap
+          show_errors
+        elsif @command == 'cuke'
+          read_mindmap
+          write_features
+          show_errors
+        else
+          show_help
+        end
+      else
+        show_errors
+      end
+    end
+
+  private
+
+    def read_features
+      @feature_reader = FeatureReader.new get_source_xml
+      search_path = File.join @features_path, '*.feature'
+      puts "Reading #{search_path}"
+      Dir[search_path].sort.each {|filename|
+        File.open(filename, 'r') {|f|
+          text = f.readlines
+          @feature_reader.extract_features filename, text #unless text.nil?
+        }
+      }
+    end
+
+
+    def write_mindmap
+      if @feature_reader.nil?
+        @errors << "No features to write (perhaps read_features has not been called)"
+        return false
+      end
+      if @do_overwrite != true and File.exists? @mindmap_filename
+        @errors << "File already exists: #{@mindmap_filename}"
+        return false
+      end
+      dir = File.dirname(@mindmap_filename)
+      FileUtils.mkdir_p(dir) unless File.directory? dir
+      writer = FreemindWriter.new
+      puts "Writing " + @mindmap_filename
+      writer.write_mm @mindmap_filename, @feature_reader.freemind_xml
+      return true
+    end
+
+
+    def default_mm_search_path
+      File.join(Dir.getwd, 'mm', '*.mm')
+    end
+
+
+    def read_mindmap
+      puts "Reading #{@mindmap_filename}"      
+      begin
+        @mindmap_reader = FreemindReader.new @mindmap_filename
+      rescue => ex
+        @errors << 'Error in read_mindmap: ' + ex.message
+      end
+    end
+
+
+    def write_features
+      if @mindmap_reader.nil?
+        @errors << "No mind map data."
+        return false
+      end
+      begin
+        writer = FeatureWriter.new
+        writer.output_path = @features_path
+        writer.overwrite = @do_overwrite
+        features = @mindmap_reader.get_features
+        if features.empty?
+          @errors << 'No Cucumber features found in the mind map file.'
+          @errors << 'Mind map may be missing a "Cucumber features:" node.'
+        else
+          features.each_key {|filename| puts "Writing #{File.join(@features_path, filename)}"}
+          writer.write_features features
+          @errors << writer.errors unless writer.errors.empty?
+        end
+      rescue => ex
+        @errors << 'Error in write_features: ' + ex.message
+      end
+    end
+
+
+    def get_source_xml
+      if @mindmap_template_filename.empty?
+        nil
+      else
+        text = nil
+        File.open(@mindmap_template_filename, 'r') {|f|
+          text = f.readlines
+        }
+        text.join
+      end
+    end
+
+
+    def default_mm_file
+      Dir[default_mm_search_path].first
+    end
+
+
+    def get_options
+      mm = ''
+      fp = ''
+      begin
+        opts = GetoptLong.new(
+          ['--help', '-h', GetoptLong::NO_ARGUMENT],
+          ['--overwrite', '-o', GetoptLong::NO_ARGUMENT],
+          ['--mm-filename', '-m', GetoptLong::REQUIRED_ARGUMENT],
+          ['--features-path', '-f', GetoptLong::REQUIRED_ARGUMENT],
+          ['--source-mm', '-s', GetoptLong::REQUIRED_ARGUMENT]
+        )
+        opts.each do |opt, arg|
+          case
+            when opt == '--help' then @command = 'help'
+            when opt == '--overwrite' then @do_overwrite = true
+            when opt == '--mm-filename' then mm = arg
+            when opt == '--features-path' then fp = arg
+            when opt == '--source-mm' then @mindmap_template_filename = arg
+          end
+        end
+      rescue => ex
+        @errors << ex.message
+      end
+
+      # If features path or mindmap file name was not specified
+      # in option arguments then infer them from any remaining
+      # command line arguments. Specific option takes precidence.
+      ARGV.each do |a|
+        if a == 'map'
+          @command = 'map' if @command == ''
+        elsif a == 'cuke'
+          @command = 'cuke' if @command == ''
+        elsif a.slice(-9, 9) == '/features'
+          fp = a if fp.empty?
+        elsif a.slice(-3, 3) == '.mm'
+          mm = a if mm.empty?
+        else
+          @errors << "Unknown command or option: #{a}"
+        end
+      end
+
+      @features_path = fp unless fp.empty?
+      @mindmap_filename = mm unless mm.empty?
+    end
+
+
+    def show_errors
+      unless @errors.empty?
+        puts "Errors:"
+        @errors.each {|err| puts err}
+      end
+    end
+
+
+    def show_help
+      puts <<xxx
+
+Usage: cukehead command [options]
+
+command:  
+  map
+      Read Cucumber feature files and create a FreeMind mind map file.
+
+  cuke
+      Read a FreeMind mind map file and create Cucumber feature files.
+
+options:
+  -h or --help
+      Show this help message.
+
+  -o or --overwrite
+      Overwrite existing output file(s).
+
+  -m FILENAME or --mm-filename FILENAME
+      map: Name of output file (default is mm/cukehead-output.mm).
+
+      cuke: Name of mind map file containing Cucumber features.
+
+  -f PATH or --features-path PATH
+      map: Directory containing feature files to read (default is directory
+      named 'features' in current directory).
+
+      cuke: Directory feature files will be written to.
+
+  -s FILENAME or --source-mm FILENAME
+      map: FreeMind mind map file to use as a template for creating
+      the output file. If the template contains a node with the text
+      'Cucumber features:' then the feature nodes will be inserted there.
+
+xxx
+    end
+
+
+  end
+  
+end

data/lib/cukehead/feature_file_section.rb

@@ -0,0 +1,73 @@
+require 'cukehead/feature_part'
+
+module Cukehead
+
+  # Base class for a container that holds a part of a Cucumber
+  # feature file that will be passed to a FreemindBuilder object
+  # once the part has been read.
+  #
+  class FeatureFileSection
+
+    # ===Parameters
+    # <tt>builder</tt> - Instance of FreemindBuilder that will receive this section of the file.
+    #
+    # <tt>title</tt> - String containing the title of the section.
+    #
+    def initialize(builder, title)
+      @builder = builder
+      @part = FeaturePart.new title
+    end
+
+
+    def add(line)
+      @part.add_line(line)
+    end
+
+
+    def set_tags(tags)
+      @part.tags = tags.clone
+    end
+
+
+    def finish
+      raise "Not implemented"
+    end
+
+  end
+
+
+  # Serves as a container for the feature description part of a Cucumber 
+  # feature file while parsing the file.
+  #
+  class FeatureSection < FeatureFileSection
+
+    def initialize (builder, text, filename)
+      @feature_filename = filename
+      super builder, text
+    end
+
+    def finish
+      @builder.add_feature(@part, @feature_filename)
+    end
+
+  end
+
+
+  class BackgroundSection < FeatureFileSection
+
+    def finish
+      @builder.add_background(@part)
+    end
+
+  end
+
+
+  class ScenarioSection < FeatureFileSection
+
+    def finish
+      @builder.add_scenario(@part)
+    end
+
+  end
+
+end