featuremap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86efa555940a3ecfa35430fd247a007583a72a05
+  data.tar.gz: c7eb0547652f637f9b6f8c4b305693d00c003c55
+SHA512:
+  metadata.gz: 66e19dfa9829ed6b5ff48a115f7f95ba31719acda098cc2ab7257c6cd83f2ca2dd87bd16287cfe5000237e1bc378a3ed9ce53c95a7b4f41847afff449f542295
+  data.tar.gz: d1dacaec2c48e46af63d0f138f1a6eb7a321f2e1cfc7f814b7913b667784fcbbd2cdda31738f606a43fe25a22225ea60727120d757a3331faae6802b5a59d84a

data/bin/featuremap

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/featuremap'
+
+options = {}
+option_parser = OptionParser.new do |opts|
+
+  executable_name = File.basename($PROGRAM_NAME)
+  opts.banner = "Create a mindmap from Gherkin feature files\n\n" + \
+  "Usage: #{executable_name} [options] features_dir [mindmap_file]\n"
+
+  opts.on("-v","--verbose") do
+    options[:verbose] = true
+  end
+
+end
+
+option_parser.parse!
+if ARGV.empty?
+  puts "you must supply the location of the feature files\n\n"
+  puts option_parser.help
+  exit 64 # see https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3 for more info
+else
+  feature_dir = ARGV[0]
+  if ARGV[1]
+    output_file = ARGV[1]
+  else
+    output_file = "STDOUT"
+  end
+  featuremap = Featuremap.new(feature_dir,options[:verbose])
+  featuremap.create_featuremap(output_file)
+  puts featuremap.err_msg.join("\n")
+  exit featuremap.exit_status
+end

data/lib/featuremap.rb

@@ -0,0 +1,112 @@
+# use securerandom to create unique id's
+require 'securerandom'
+require 'logger'
+require_relative 'mindmap'
+
+
+class Featuremap
+
+  attr_reader :nodes, :exit_status, :err_msg
+
+  def initialize(p_features_path, p_verbose = false)
+    @exit_status = 0
+    @err_msg = []
+    @log = Logger.new(STDOUT)
+    @log.datetime_format = "%H:%M:%S"
+    if ENV['LOG_LEVEL'] == 'debug'
+      @log.level = Logger::DEBUG
+    elsif ENV['LOG_LEVEL'] == 'info'
+      @log.level = Logger::INFO
+    else
+      # default log level
+      @log.level = Logger::ERROR
+    end
+    if p_verbose
+      @log.level = Logger::INFO
+    end
+    if Dir.exists?(p_features_path)
+      @features_path = p_features_path
+    else
+      @exit_status = 66  # see https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3 for more info
+      @err_msg.push("can't find >>#{p_features_path}<< as feature dir")
+    end
+    @log.info("create a new featuremap")
+    @mindmap = Mindmap.new(@log)
+  end
+
+  # class entry point - create a mindmap for a given path
+  def create_featuremap(p_featuremap_path)
+    if p_featuremap_path
+      featuremap_path = p_featuremap_path
+    else
+      featuremap_path = Dir.pwd + "/featuremap.mm"
+    end
+    while File.exists?(featuremap_path)
+      filename_parts = featuremap_path.split(".")
+      if filename_parts[0] =~ /-\d+$/
+        filename_parts = filename_parts[0].split("-")
+        featuremap_path = "#{filename_parts[0]}-#{filename_parts[1].to_i + 1}.mm"
+      else
+        featuremap_path = "#{filename_parts[0]}-1.mm"
+      end
+    end
+    if featuremap_path != p_featuremap_path
+      @err_msg.push("given mindmap name is already in use, created #{featuremap_path}")
+    end
+    begin
+      IO.write("#{featuremap_path}","")
+    rescue Exception
+      @err_msg.push("can't write to #{featuremap_path}")
+      @log.warn @err_msg
+      @exit_status = 74
+      return
+    end
+    read_features(@features_path)
+    mindmap_file = File.open(featuremap_path,"w")
+    mindmap_file.write(@mindmap.to_s)
+    mindmap_file.close
+  end
+
+  # scan feature folder for feature files and subdirs
+  def read_features(p_features_path, p_parent_node = nil)
+    # don't read features if some error happened before
+    if @exit_status == 0
+      feature_node = nil
+      begin
+        features = Dir.entries(p_features_path)
+      rescue Exception
+        @err_msg.push("can't access >>#{p_features_path}<< as feature dir")
+        @log.warn @err_msg
+        @exit_status = 66
+        return
+      end
+      features.each do |feature_file|
+        #ignore files starting with .
+        if feature_file =~ /^[^\.]/
+          #look for features in only in .feature files
+          if feature_file =~ /\.feature$/
+            feature = File.read("#{p_features_path}/#{feature_file}")
+            feature.scan(/^\s*(Feature|Ability|Business Need):\s*(\S.*)$/) do |feature_type, feature_name|
+              feature_node = @mindmap.add_node(feature_name, "feature", p_parent_node)
+            end
+            feature.scan(/^\s*(Scenario|Scenario Outline):\s*(\S.*)$/) do |scenario_type, scenario_name|
+              case scenario_type
+              when "Scenario Outline" then @mindmap.add_node(scenario_name, "scenario_outline", feature_node)
+                when "Scenario"  then @mindmap.add_node(scenario_name, "scenario", feature_node)
+              end
+            end
+          end
+          # look for subdirs
+          if File.directory?("#{p_features_path}/#{feature_file}")
+            # ignore step_definitions and support folders because those are used for code
+            if feature_file != "step_definitions" && feature_file != "support"
+              subdir_node = @mindmap.add_node(feature_file, "subdir", p_parent_node)
+              read_features("#{p_features_path}/#{feature_file}", subdir_node)
+            end
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/mindmap.rb

@@ -0,0 +1,59 @@
+class Mindmap
+
+  def initialize(p_logger)
+    @log = p_logger
+    @nodes = []
+    root_node = create_node("featuremap","root")
+    @nodes.insert(0, root_node)
+  end
+
+  # convert mindmap object to string
+  def to_s
+    map = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+    map << "<map version=\"1.0.1\">\n"
+    map << "<!-- To view this file, download free mind mapping software FreeMind from http://freemind.sourceforge.net -->\n"
+    map << nodes_to_s(@nodes)
+    map << "</map>\n"
+  end
+
+  # create a new node
+  def create_node(p_node_text, p_node_type)
+    node = {"created" => Time.now.to_i, "id" => SecureRandom.uuid.gsub(/-/,''), "modified" => Time.now.to_i, "text" => p_node_text, "type" => p_node_type, "nodes" => []}
+  end
+
+  # add a new node
+  def add_node(p_node_text, p_node_type, p_parent_node = nil)
+    new_node = create_node(p_node_text, p_node_type)
+    # add new node on top level per default
+    if p_parent_node.nil?
+       p_parent_node = @nodes[0]
+    end
+    p_parent_node["nodes"].insert(0, new_node)
+    return new_node
+  end
+
+  # turn hash of nodes into mindmap xml string
+  def nodes_to_s(p_nodes, p_nodes_text="")
+    nodes_text = p_nodes_text
+    #@log.debug nodes_text
+    p_nodes.each do |node|
+      nodes_text << "<node CREATED=\"#{node["created"]}\" ID=\"#{node["type"]}_#{node["id"]}\" MODIFIED=\"#{node["modified"]}\" TEXT=\"#{node["text"]}\">\n"
+      # add icons and fonts to nodes
+      case node["type"]
+      when "feature"
+        nodes_text << "<font BOLD=\"true\" NAME=\"SansSerif\" SIZE=\"12\"/>"
+      when "subdir"
+        nodes_text << "<icon BUILTIN=\"folder\"/>\n"
+      when "scenario_outline"
+        nodes_text << "<icon BUILTIN=\"list\"/>\n"
+      end
+      # call function recursively for sublevel nodes
+      if not node["nodes"].empty?
+        nodes_to_s(node["nodes"], nodes_text)
+      end
+      nodes_text << "</node>\n"
+    end
+    return nodes_text
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: featuremap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthias Carell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Featurmaps helps you to visualize the functionality of your \
+      application by presenting your features as a mindmap
+email:
+- rumpelcenter-featuremap at yahoo.com
+executables:
+- featuremap
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/featuremap
+- lib/featuremap.rb
+- lib/mindmap.rb
+homepage: https://github.com/mckryton/featuremap
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: featuremap
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A script to convert Gherkin features into a mindmap
+test_files: []