fitquery 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmMzOTJiM2I5ODYzMmExMzM5NTJlZjBiNGI5MDI0NWUzZDlmOTBkNw==
+  data.tar.gz: !binary |-
+    OWI2MTAyOGI0MTkxYjM1MzgzMzdmOGY4NDY2OWIzNmMyZmNiNWRiMA==
+SHA512:
+  metadata.gz: !binary |-
+    MDY2MTU3ODFjM2Y4NjQyYjkzM2Y0YTI4NGRjODdjYTJhNjUwZjE1M2QzNGM2
+    YTVkNzc1NGM5Yjk3YmMwMjk2Y2MxNmFmNzhhOWQzZGFkNmUwMjU1ODAwOGU0
+    NmM0M2ZlYTk0YWZiODFkYWMzM2Q4ZWU5MDY3MjYyODEwZjAxNmE=
+  data.tar.gz: !binary |-
+    MDljNjM0ZjkzZmEzYjNmYmI4ZTc2ODg3OGRlNWI5MWUzYzI2NDgzMWViMjRj
+    ODAxZGI0MzM3MzY5OTMwMzcyZmNkYWI3OWY1NThjYzZmZTE2NjhhMTNjNWVh
+    NDZkNjU1ZDM4MmI0ZmVmMDg4OGMwMjRmMmI1M2Q2MGYzYzY4MmQ=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fitquery.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Peguero
+
+MIT License
+
+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.md

@@ -0,0 +1,36 @@
+# Fitquery
+
+Tools for inspecting and querying a FitNesse test hierarchy.
+This Ruby gem allows you to create an enumerable structure that represents an entire test hierarchy, and then inspect that
+structure. For example, let's say that your organization makes heavy use of tags in FitNesse, and you would like to find
+all the tests that are not included by a particular tag. That could be done like this:
+
+    fitnesse = FitnesseRoot.new("C:/gitrepos/centralrepobare/FitTest/FitNesseRoot")
+    untagged = fitnesse.find_all {|node|
+      node.runable? && node.test? && !node.has_tag?('Nightly')
+    }
+    puts untagged
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fitquery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fitquery
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fitquery/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/fitquery.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fitquery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fitquery"
+  spec.version       = Fitquery::VERSION
+  spec.authors       = ["Tony Peguero"]
+  spec.email         = ["tony.peguero@payglobal.com"]
+  spec.summary       = %q{Tools for inspecting and querying a FitNesse test hierarchy}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/fitquery/fitnesse_node.rb

@@ -0,0 +1,184 @@
+require 'rexml/document'
+require 'pathname'
+require 'set'
+require 'find'
+
+# The FitnesseNode class represents a node in the Fitnesse tree, i.e. a test, suite, or static page.
+# There are methods for querying tags, state, etc., which are based on the properties file.
+# The content of the page is currently ignored.
+
+# @attr_reader [FitnesseRoot] root The root of the Fitnesse tree of which this node is a part.
+# @attr_reader [FitnesseNode,FitnesseRoot] parent The parent of this node (which may be the root object)
+# @attr_reader [Array<FitnesseNode>] children The child nodes of this node.
+# @attr_reader [Pathname] path The path of this node's folder.
+# @attr_reader [String] name The name of this node. This is the "short" name of the node itself, not the fully qualified name.
+# @attr_reader [Rexml::Document] properties The properties XML document of this node.
+# @attr_reader [SortedSet<String>] explicit_tags The set of tags that have been explicitly set on this node.
+class FitnesseNode
+  attr_reader :root, :parent, :children, :path, :name, :properties, :explicit_tags
+
+
+  def initialize(root, parent, name)
+    @root = root
+    @parent = parent
+    @children = []
+    @name = name.to_s
+    @path = name == :root ? parent.path : Pathname.new(parent.path.join(name))
+    begin
+      File.open(@path.join('properties.xml'), 'r') {|f|	@properties = REXML::Document.new f	}
+    rescue
+      @properties = nil
+    end
+    begin
+      tags_element = @properties.get_elements('/properties/Suites')
+      unless tags_element.nil?
+        @explicit_tags = SortedSet.new(tags_element.first.text.split(',').map{|tag| tag.strip })
+      end
+    rescue
+      @explicit_tags = SortedSet.new([])
+    end
+    @path.children.each do |sub|
+      next unless sub.directory?
+      rel_path = sub.relative_path_from(@root.path)
+      next if @root.blacklist.any? {|blacklisted| rel_path.fnmatch?(blacklisted) }
+      child_node = FitnesseNode.new(@root, self, sub.basename)
+      @children.push(child_node) unless child_node.nil?
+    end
+  end
+
+  # Yield this node and its children.
+  # @param order [Symbol] Use :pre to yield this node before its children, or :post to yield the children first.
+  def traverse(order = :pre, &block)
+    yield self if order == :pre
+    unless @children.nil?
+      @children.each do |child|
+        child.traverse(&block)
+      end
+    end
+    yield self if order == :post
+  end
+
+  # Yield this node and its children.
+  def each(&block)
+    traverse(:pre, &block)
+  end
+
+  # Yield this node and its children, but provides a way to stop further recursion down this node's branch of the tree.
+  # @example Ignore all nodes that are the children of a node which is marked as skipped.
+  #   start_node.find {|node|
+  #     Find.prune if node.explicitly_skipped?
+  #     # only gets to here if none of the current node's ancestors have been skipped.
+  #   }
+  def find(&block)
+    catch(:prune) do
+      yield self
+      unless @children.nil?
+        @children.each do |child|
+          child.find(&block)
+        end
+      end
+    end
+  end
+
+  # Determines the set of tags that are set on this node or any of its ancestors.
+  # @return [SortedSet<String>] The set of tags that apply to this node.
+  def effective_tags
+    if @parent.respond_to?(:effective_tags)
+      @parent.effective_tags + @explicit_tags
+    else
+      @explicit_tags
+    end
+  end
+
+  # @return [Boolean] Does this node have the Prune property explicitly set on it?
+  def explicitly_skipped?
+    @properties.nil? ? false : (@properties.get_elements('/properties/Prune').count > 0)
+  end
+
+  # @return [Boolean] Does this node have the Prune property set on it or on any of its ancestors?
+  def effectively_skipped?
+    if @parent.respond_to?(:effectively_skipped?)
+      @parent.effectively_skipped? || explicitly_skipped?
+    else
+      explicitly_skipped?
+    end
+  end
+
+  # Gets the fully qualified name of this node.
+  # @param sep [String] Sets the preferred separator string for the name. If nil, the name will use the system default file path separator.
+  # @return [String] The fully qualified name of the node, consisting of the names of each node in the tree leading to this one.
+  def full_name(sep = nil)
+    rel_path = @path.relative_path_from(@root.path)
+    if sep.nil?
+      rel_path.to_s
+    else
+      rel_path.to_s.gsub(Pathname::SEPARATOR_PAT, sep)
+    end
+  end
+
+  # Gets the depth of this node, i.e. the number of levels down the tree from the root node.
+  # @return [Integer] The depth of the node
+  def depth
+    rel_path = @path.relative_path_from(@root.path)
+    rel_path.to_s.scan(Pathname::SEPARATOR_PAT).size
+  end
+
+  # Gets the name of the node, prefixed with a number of characters determined by the node's depth.
+  # Handy for displaying the node in a simple tree representation.
+  # @param indent_string [String] The string from which to construct the indentation.
+  # @return [String] The indented name.
+  # @example A node with a full name of 'Root/Foo/Bar/Baz'
+  #   node.indented_name('-')  =>  '---Baz'
+  def indented_name(indent_string = ' ')
+    indent = indent_string * depth
+    indent + @name.to_s
+  end
+
+  # @return [Boolean] Is this node defined as a Test?
+  def test?
+    @properties.nil? ? false : (@properties.get_elements('/properties/Test').count > 0)
+  end
+
+  # @return [Boolean] Is this node defined as a Suite?
+  def suite?
+    @properties.nil? ? false : (@properties.get_elements('/properties/Suite').count > 0)
+  end
+
+  # @return [Boolean] Is this node defined as a Static page?
+  def static?
+    @properties.nil? ? false : (@properties.get_elements('/properties/Static').count > 0)
+  end
+
+  # @return [Boolean] Is this node runable? I.e. is it either a test or a suite which is not skipped?
+  def runable?
+    !static? && !effectively_skipped? && (test? || suite?)
+  end
+
+  # Determine whether this node has a particular tag on it.
+  # @param tag [String,Regexp] The tag to find. If a string, the search will be case insensitive.
+  #     If a regular expression is used, the regex's case sensitivity flag will be respected.
+  # @param explicit_only [Boolean] Specify whether to search within the explicit tags or the effective tags of this node.
+  def has_tag?(tag, explicit_only = false)
+    tag_set = explicit_only ? explicit_tags : effective_tags
+    if tag.instance_of?(Regexp)
+      pattern = tag
+    elsif tag.instance_of?(String)
+      pattern = /^#{tag}$/i
+    end
+    tag_set.any? {|t| t.match(pattern) }
+  end
+
+  def to_s
+    full_name
+  end
+
+  def <=>(other)
+    if depth == other.depth
+      name <=> other.name
+    else
+      depth <=> other.depth
+    end
+  end
+
+end
+

data/lib/fitquery/fitnesse_root.rb

@@ -0,0 +1,53 @@
+require 'pathname'
+require_relative 'fitnesse_node'
+
+# The FitnesseRoot class represents an entire tree of Fitnesse tests/suites.
+# @attr_reader [Pathname] path The root path of the Fitnesse tree.
+# @attr_reader [Array<String>] blacklist An array of names that should be ignored during the initial tree inspection.
+class FitnesseRoot
+  include Enumerable
+  attr_reader :path, :blacklist
+
+  STANDARD_BLACKLIST = ["files", "FitNesse", "FrontPage", "HelpMenu", "ErrorLogs", "Recent Changes"]
+
+  def initialize(path, blacklist = STANDARD_BLACKLIST)
+    @path = Pathname.new(path)
+    @blacklist = blacklist
+    @root_node = FitnesseNode.new(self, self, :root)
+  end
+
+  # Print a summary of the entire tree, indicating types, skipped status, and effective tags on each node.
+  def print_summary
+    traverse do |node|
+      print node.effectively_skipped? ? '-' : '+'
+      case
+        when node.test? then print 'T'
+        when node.suite? then print 'S'
+        when node.static? then print 'X'
+        else print '?'
+      end
+      print node.indented_name('  ')
+      tags = node.effective_tags.to_a
+      unless tags.empty?
+        # highlight the tags that are explicit on this node
+        tags = tags.map {|tag| node.explicit_tags.include?(tag) ? "*#{tag}" : tag }
+        print "  [#{tags.join(',')}]"
+      end
+      print "\n"
+    end
+  end
+
+  def traverse(order = :pre, &block)
+    @root_node.traverse(order, &block)
+  end
+
+  def each(&block)
+    @root_node.traverse(:pre, &block)
+  end
+
+  def find(&block)
+    @root_node.find(&block)
+  end
+end
+
+

data/lib/fitquery/version.rb

@@ -0,0 +1,3 @@
+module Fitquery
+  VERSION = '0.1.0'
+end

data/lib/fitquery.rb

@@ -0,0 +1,6 @@
+require "fitquery/version"
+require "fitquery/fitnesse_root"
+
+module Fitquery
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: fitquery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Peguero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tony.peguero@payglobal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fitquery.gemspec
+- lib/fitquery.rb
+- lib/fitquery/fitnesse_node.rb
+- lib/fitquery/fitnesse_root.rb
+- lib/fitquery/version.rb
+homepage: ''
+licenses:
+- MIT
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Tools for inspecting and querying a FitNesse test hierarchy
+test_files: []