featuremap 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3e9b97e4894658a5d3d8f8dea733013c28c2a74e
-  data.tar.gz: 453f5df89b88b09fd3b6e67f50781a6044f12210
+SHA256:
+  metadata.gz: 1ab3ac84cd60d91bf241cd06522c32ec7d934d665600ee3dcb6784cfcd971fc7
+  data.tar.gz: af5666ed23c58b5710beb9e734afa07a10113d724e164dc44987befda31431eb
 SHA512:
-  metadata.gz: c4b2b50674749818acee3d3f6ad6d3774f9afd6872ca005584a67f2941a030d8631c08c19c4d9a78cfadd53890fb06be525541b72de996cac30c265ca8cc643c
-  data.tar.gz: 14436d3a64bbf81b951c374fb9baf82b88282f6b2c04ad17747f05be34e53b3f4c3a8a2f21bc07724548d2eb4f475f0043f9cebc55a21b4e5e91d5ceb9a4689f
+  metadata.gz: 3ce368221cf8218c46c635d51dd3e13a934f02527a40c8e67e450c65ac0cf1c18495ae6efeca6691b111a1458b378e0839d1ea509781d78f4135b6dcd2eabc6f
+  data.tar.gz: b261f82c0494592aa193ed736d351151556ec67293ae60715daa7cab3d1215097c64c7f5fc7fa7945134a1947939b46c17ad048369bfedc8b0f323ed30c8975b

data/bin/featuremap

@@ -28,7 +28,7 @@ else
   else
     output_file = "STDOUT"
   end
-  featuremap = Featuremap.new(feature_dir, output_file, options[:verbose])
+  featuremap = Featuremap::Featuremap.new(feature_dir, output_file, options[:verbose])
   if featuremap.exit_status == 0
     featuremap.create_featuremap()
   end

data/features/give_feedback.feature

@@ -17,7 +17,7 @@ Ability: give feedback
       And the user rights for the feature dir don't allow access
      When the user runs featuremap
      Then featuremap exits with 66
-      And featuremap shows the message "can't access >>secret_features/<< as feature dir"
+      And featuremap shows the message "can't access >>secret_features<< as feature dir"
 
 
   # rule: show an error message if the featuremap can't write the mindmap

data/features/step_definitions/common_steps.rb

@@ -23,7 +23,7 @@ end
 When("the mapper is called") do
   create_path(@path_to_results)
   @featuremap_file = "#{@path_to_results}/featuremap.mm"
-  @mapper = Featuremap.new("#{@path_to_testdata}/#{@feature_dir}", @featuremap_file)
+  @mapper = Featuremap::Featuremap.new("#{@path_to_testdata}/#{@feature_dir}", @featuremap_file)
   @mapper.create_featuremap()
 end
 

data/lib/featuremap.rb

@@ -1,137 +1,119 @@
 # use securerandom to create unique id's
 require 'securerandom'
 require 'logger'
+require 'cuke_modeler'
 require_relative 'mindmap'
 
+module Featuremap
 
-class Featuremap
+  class Featuremap
 
-  attr_reader :nodes, :exit_status, :mindmap_path, :features_path
+    attr_reader :nodes, :exit_status, :mindmap_path, :features_path
 
-  def initialize(p_features_path, p_mindmap_path, p_verbose = false)
-    if p_mindmap_path == "STDOUT"
-      @log = Logger.new(STDERR)
-    else
-      @log = Logger.new(STDOUT)
-    end
-    @log.formatter = proc do |severity, datetime, progname, msg|
-      date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
-      "[#{date_format}] #{severity.ljust(5,' ')}: #{msg}\n"
-    end
-    @log.datetime_format = "%H:%M:%S"
-    if ENV['LOG_LEVEL'] == 'debug'
-      @log.level = Logger::DEBUG
-    elsif ENV['LOG_LEVEL'] == 'info'
-      @log.level = Logger::INFO
-    elsif ENV['LOG_LEVEL'] == 'warn'
-      @log.level = Logger::WARN
-    else
-      # default log level
-      @log.level = Logger::ERROR
-    end
-    if p_verbose && @log.level != Logger::DEBUG && p_mindmap_path != "STDOUT"
-      @log.level = Logger::INFO
-      @log.info "set log level to verbose"
-    end
-    @exit_status = 0
-    @mindmap_path = p_mindmap_path
-    if Dir.exists?(p_features_path)
-      @features_path = p_features_path
-      @log.info("create a new featuremap")
-      @mindmap = Mindmap.new(@log)
-    else
-      @exit_status = 66  # see https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3 for more info
-      @log.error("can't find >>#{p_features_path}<< as feature dir")
-      return
-    end
-  end
-
-  # class entry point - create a mindmap for a given path
-  def create_featuremap()
-    mindmap_path = @mindmap_path
-    if mindmap_path != "STDOUT"
-      while File.exists?(mindmap_path)
-        filename_parts = mindmap_path.split(".")
-        if filename_parts[0] =~ /-\d+$/
-          filename_parts = filename_parts[0].split("-")
-          mindmap_path = "#{filename_parts[0]}-#{filename_parts[1].to_i + 1}.mm"
-        else
-          mindmap_path = "#{filename_parts[0]}-1.mm"
-        end
+    def initialize(p_features_path, p_mindmap_path, p_verbose = false)
+      if p_mindmap_path == "STDOUT"
+        @log = Logger.new(STDERR)
+      else
+        @log = Logger.new(STDOUT)
       end
-      if mindmap_path != @mindmap_path
-        @log.warn("given mindmap name is already in use, created #{mindmap_path}")
+      @log.formatter = proc do |severity, datetime, progname, msg|
+        date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
+        "[#{date_format}] #{severity.ljust(5,' ')}: #{msg}\n"
       end
-      begin
-        IO.write("#{mindmap_path}","")
-      rescue Exception
-        @log.error("can't write to #{mindmap_path}")
-        @exit_status = 74
-        return
+      @log.datetime_format = "%H:%M:%S"
+      if ENV['LOG_LEVEL'] == 'debug'
+        @log.level = Logger::DEBUG
+      elsif ENV['LOG_LEVEL'] == 'info'
+        @log.level = Logger::INFO
+      elsif ENV['LOG_LEVEL'] == 'warn'
+        @log.level = Logger::WARN
+      else
+        # default log level
+        @log.level = Logger::ERROR
       end
-    end
-    read_features(@features_path)
-    if @exit_status == 0
-      if mindmap_path != "STDOUT"
-        mindmap_file = File.open(mindmap_path,"w")
-        mindmap_file.write(@mindmap.to_s)
-        mindmap_file.close
+      if p_verbose && @log.level != Logger::DEBUG && p_mindmap_path != "STDOUT"
+        @log.level = Logger::INFO
+        @log.info "set log level to verbose"
+      end
+      @exit_status = 0
+      @mindmap_path = p_mindmap_path
+      if Dir.exists?(p_features_path)
+        @features_path = p_features_path
+        @log.info("create a new featuremap")
+        @mindmap = Mindmap.new(@log)
       else
-        puts @mindmap.to_s
+        @exit_status = 66  # see https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3 for more info
+        @log.error("can't find >>#{p_features_path}<< as feature dir")
+        return
       end
     end
-  end
 
-  # scan feature folder for feature files and subdirs
-  def read_features(p_features_path = @features_path, p_parent_node = nil)
-    # don't read features if some error happened before
-    if @exit_status == 0
-      feature_node = nil
-      begin
-        if p_features_path.end_with?("/")
-          features_path = p_features_path
-        else
-          features_path = p_features_path + "/"
+    # class entry point - create a mindmap for a given path
+    def create_featuremap()
+      mindmap_path = @mindmap_path
+      if mindmap_path != "STDOUT"
+        while File.exists?(mindmap_path)
+          filename_parts = mindmap_path.split(".")
+          if filename_parts[0] =~ /-\d+$/
+            filename_parts = filename_parts[0].split("-")
+            mindmap_path = "#{filename_parts[0]}-#{filename_parts[1].to_i + 1}.mm"
+          else
+            mindmap_path = "#{filename_parts[0]}-1.mm"
+          end
+        end
+        if mindmap_path != @mindmap_path
+          @log.warn("given mindmap name is already in use, created #{mindmap_path}")
         end
-        features = Dir.entries(features_path)
-      rescue Exception
+        begin
+          IO.write("#{mindmap_path}","")
+        rescue Exception
+          @log.error("can't write to #{mindmap_path}")
+          @exit_status = 74
+          return
+        end
+      end
+      begin
+        directory_model = CukeModeler::Directory.new(@features_path)
+        @log.info "start reading features from dir #{@features_path}"
+        read_features(directory_model)
+      rescue Exception => e
         @log.error("can't access >>#{features_path}<< as feature dir")
+        @log.debug(e.message)
         @exit_status = 66
         return
       end
-      @log.info "start reading features from dir #{features_path}"
-      feature_count = 0
-      scenario_count = 0
-      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("#{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)
-              feature_count += 1
-            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
-              scenario_count += 1
-            end
-          end
-          # look for subdirs
-          if File.directory?("#{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("#{features_path}#{feature_file}", subdir_node)
-            end
+      if @exit_status == 0
+        if mindmap_path != "STDOUT"
+          mindmap_file = File.open(mindmap_path,"w")
+          mindmap_file.write(@mindmap.to_s)
+          mindmap_file.close
+        else
+          puts @mindmap.to_s
+        end
+      end
+    end
+
+    #TODO work in progress: use cuke modeler
+    def read_features(p_cm_directory, p_parent_node = nil)
+      feature_node = nil
+      p_cm_directory.feature_files.each do |feature_file|
+        feature_node = @mindmap.add_node(feature_file.feature.name, "feature", p_parent_node)
+        feature_file.feature.tests.each do |scenario|
+          if scenario.keyword == "Scenario"
+            @mindmap.add_node(scenario.name, "scenario", feature_node)
+          elsif scenario.keyword == "Scenario Outline"
+            @mindmap.add_node(scenario.name, "scenario_outline", feature_node)
           end
         end
       end
-      @log.info "found #{feature_count} feature(s) and #{scenario_count} scenarios in dir #{features_path}"
+      p_cm_directory.directories.each do |sub_dir|
+        if sub_dir.name != "step_definitions" and sub_dir.name != "support"
+          subdir_node = @mindmap.add_node(sub_dir.name, "subdir", p_parent_node)
+          @log.info("add features from #{sub_dir.path}")
+          read_features(sub_dir, subdir_node)
+        end
+      end
     end
-  end
 
+  end
 end

data/lib/mindmap.rb

@@ -1,59 +1,61 @@
-class Mindmap
+module Featuremap
+  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
+    def initialize(p_logger)
+      @log = p_logger
+      @nodes = []
+      root_node = create_node("featuremap","root")
+      @nodes.insert(0, root_node)
+    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
+    # 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
 
-  # 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]
+    # 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
-    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"
+    # 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
-      # call function recursively for sublevel nodes
-      if not node["nodes"].empty?
-        nodes_to_s(node["nodes"], nodes_text)
+      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
-      nodes_text << "</node>\n"
+      return nodes_text
     end
-    return nodes_text
-  end
 
+  end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Featuremap
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,18 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: featuremap
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthias Carell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
-dependencies: []
+date: 2019-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cuke_modeler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Featurmaps helps you to visualize the functionality of your \
-      application by presenting your features as a mindmap
+      application by turning your Gherkin features into a mindmap
 email:
 - rumpelcenter-featuremap at yahoo.com
 executables:
@@ -37,7 +51,8 @@ files:
 - lib/mindmap.rb
 - lib/version.rb
 homepage: https://github.com/mckryton/featuremap
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -54,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: featuremap
-rubygems_version: 2.6.14
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A script to convert Gherkin features into a mindmap