spec_query 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in spec_query.gemspec
+gemspec
+

data/README

@@ -0,0 +1,31 @@
+spec-query
+==========
+
+This is a small utility to query specs for Ruby on Rails projects.
+This is useful if:
+* you want to run specs that only contain some keywords
+* you have a lot of slow specs and do not have a good organization of them
+
+Install
+=======
+
+If you are using bundler, add this to the Gemfile:
+
+gem "spec_query", :require => nil
+
+No need for require, this is used only through a rake task.
+
+You need to install the rake task manually. The easiest way is to find spec_query/lib/tasks/spec_query.rake in your GEM_PATH (run: `gem env` in console) and copy it to your projects lib/tasks.
+
+Copy
+
+Examples
+========
+
+# for help
+rake q:spec # see help
+rake q:spec q="keyword" # run only specs that have a keyword
+rake q:spec q='keyword1&&keyword2||keyword3&&keyword4' # || is or, && is and
+rake q:spec q='regexp --r' # use regexp
+rake q:spec q='Case Sensitive statement --c' use case sensitive
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/extentions/README

@@ -0,0 +1,5 @@
+Extentions
+==========
+
+If you want to add custom behavior to this gem you can do it via extentions. These modules will extend the SpecQuery::Query class. Default convention: extentions should be named *_query_ext.rb and put in ./spec directory. See examples for code.
+

data/lib/extentions/examples/breakout_query_ext.rb

@@ -0,0 +1,139 @@
+# created by Titas Norkūnas
+# run specs by file contents extention for Breakout
+# run specs by components
+
+module BreakoutQuery
+  USE_CASE = "\nBreakout use cases:\n
+    1. Run specs by Breakout components. Use any (or just unique prefix) component name
+    rake q:spec g=Alerts
+    # runs all specs related to Alerts component
+    rake q:spec g=ag
+    # runs all specs related to Agile Planner component, as ag is unique prefix for this component
+    2. Provided there is a change related to space backups. To run only tests that can be related.
+    rake q:spec q=backup
+    3. Provided there are some changes related to portfolio views. To run only specs that can be related:
+    rake q:spec q='portfolio&&template||portfolio&&view'
+    # this will run all specs that have: (('portfolio' AND 'template') OR ('portfolio' AND 'view'))
+    4. Provided someone changed :space and :ticket factories. To run tests that use them:
+    rake q:spec q='Factory :space||Factory :ticket --c'
+    # this will run all specs that have either \"Factory :space\" OR \"Factory :ticket\" text. --c is for case-sensitive"
+
+  GROUP = "Please supply query q=query or g=group parameter for this rake task"
+
+  # TODO
+  # * add tags for missing components
+  COMPONENT_HASH = {
+    "Agile Planner"             => "agile&&planner",
+    "Alerts"                    => "alerter||user_notify",
+    "App Admin"                 => "admin",
+    "Branded spaces"            => "?",
+    "BreakoutParser"            => "breakout&&parser",
+    "Catalog"                   => "?",
+    "Chat"                      => "chat",
+    "Commercial"                => "?",
+    "Core"                      => "?",
+    "Core - spaces"             => "?",
+    "Core - users"              => "?",
+    "Core-processors"           => "?",
+    "cron tasks scripts"        => "?",
+    "Custom Status"             => "ticket_status",
+    "Dashboard"                 => "?",
+    "Events"                    => "event",
+    "Files"                     => "?",
+    "Fork and Merge"            => "fork||merge",
+    "FTP Tool"                  => "ftp",
+    "Gerrit"                    => "gerrit",
+    "Help and Docs"             => "?",
+    "Home / Marketing"          => "?",
+    "I18N"                      => "?",
+    "Image annotation"          => "?",
+    "Jobs/recruit/contract"     => "?",
+    "Messages"                  => "?",
+    "Milestones"                => "milestone",
+    "New Tools"                 => "?",
+    "Other"                     => "?",
+    "Other Tools"               => "?",
+    "Performance"               => "?",
+    "Portfolio#Admin"           => "portfolio&&admin",
+    "Portfolio#BrandingAndHome" => "portfolio&&brand",
+    "Portfolio#Filters"         => "portfolio&&filter",
+    "Portfolio#Projects"        => "portfolio&&project",
+    "Portfolio#Start"           => "?",
+    "Portfolio#Stream"          => "?",
+    "Portfolio#Tickets"         => "portfolio&&ticket",
+    "Portfolio#Time"            => "portfolio&&time",
+    "Portfolio#Users"           => "portfolio&&user",
+    "Private Installation"      => "?",
+    "Project Portfolio"         => "?",
+    "RCB"                       => "rcb",
+    "Repo Exp."                 => "?",
+    "Repositories"              => "?",
+    "REST-auth module"          => "?",
+    "Scrum tool"                => "?",
+    "Search"                    => "?",
+    "Server admin"              => "?",
+    "Server Tool"               => "?",
+    "Site Architecture"         => "?",
+    "Skype"                     => "?",
+    "Spaces Admin"              => "?",
+    "Staffing"                  => "?",
+    "Support"                   => "?",
+    "Ticket tool"               => "?",
+    "Time tool"                 => "?",
+    "Time/bill/pay"             => "?",
+    "Tool Permissions"          => "permission",
+    "Trac"                      => "trac",
+    "Wiki"                      => "wiki"
+  }
+
+
+  def initialize(*args)
+    self.extend BreakoutQuery::QueryMethods
+  end
+
+  module QueryMethods
+    def help
+      help_info    = super
+      help_info[0] = GROUP
+      help_info + [USE_CASE]
+    end
+
+    def env_condition
+      super || env["g"]
+    end
+
+     def make_query
+       group = env["g"]
+       if group
+         key, value = get_group(group)
+         puts "Running specs for: #{key}"
+         value
+       else
+        super
+      end
+    end
+
+    private
+
+    def get_group(group)
+      c = COMPONENT_HASH[group]
+      if c == "?"
+        puts "Group not implemented"
+        exit 1
+      else
+        return [group, c] if c.present?
+        # if only one key starts with group
+        keys = COMPONENT_HASH.keys.select do |k|
+          k.downcase.start_with?(group.downcase)
+        end
+        if keys.length == 1
+          return [keys.first, COMPONENT_HASH[keys.first]]
+        else
+          puts "Please be more specific, multiple matches:", keys
+          exit 1
+        end
+      end
+    end
+  end
+end
+

data/lib/spec_query.rb

@@ -0,0 +1,37 @@
+require "spec_query/query/query"
+require "spec_query/run/simple_cmd"
+require "spec_query/search/search"
+require "spec_query/search/grep"
+require "spec_query/version"
+
+module SpecQuery
+  class SpecRunner
+    def run(env)
+      query_maker = SpecQuery::Query.new()
+      query_maker.other_help = ["Available options:"] +
+        search_strategy.available_options.map{|k,v| "#{k}    #{v}"}
+      searcher    = search_strategy.new(query_maker.query(env))
+      spec_files  = searcher.get_files
+      runner      = run_strategy.new(spec_files)
+      runner.spec
+    end
+
+    private
+
+    # implement other strategy for non-unix
+    def search_strategy
+      if SpecQuery::Grep.available?
+        SpecQuery::Grep
+      else
+        puts "not implemented, sorry"
+        exit 1
+      end
+    end
+
+    # implement a more sophisticated strategy
+    def run_strategy
+      SpecQuery::SimpleCmd
+    end
+  end
+end
+

data/lib/spec_query/query/query.rb

@@ -0,0 +1,45 @@
+module SpecQuery
+  class Query
+    # require *_query_ext.rb files from spec directory
+    @@modules = []
+    Dir.new("spec").entries.select{|f| f.end_with?("_query_ext.rb")}.each do |mdl|
+      @@modules << (require "spec/#{mdl}")
+    end if File.exists?("spec")
+
+    # include specific modules
+    @@modules.each do |mdl|
+      include Object.const_get(mdl.first) unless mdl == true
+    end
+
+    attr_accessor :env, :other_help
+    def query(environment)
+      self.env = environment
+      unless env_condition
+        puts help
+        exit 1
+      else
+        query = make_query
+      end
+      if query.blank?
+        puts "No query supplied"
+        exit 1
+      end
+      query
+    end
+
+    def help
+      ["Please supply query q=query parameter for this rake task",
+      "Sample use: rake q:spec q='keyword1&&keyword2||keyword3&&keyword4'"] + (other_help ? other_help : [])
+    end
+
+    def env_condition
+      env["q"]
+    end
+
+    def make_query
+      puts "Running specs for: #{env['q']}"
+      env["q"]
+    end
+  end
+end
+

data/lib/spec_query/run/simple_cmd.rb

@@ -0,0 +1,19 @@
+module SpecQuery
+  class SimpleCmd
+    attr_accessor :files
+    def initialize(files)
+      self.files = files
+    end
+
+    def spec
+      if files.present?
+        puts "Matched specs: #{files.size}"
+        puts files
+        system "ruby -Itest -Ispec #{files.join(' ')}"
+      else
+        puts "No maches"
+      end
+    end
+  end
+end
+

data/lib/spec_query/search/grep.rb

@@ -0,0 +1,66 @@
+module SpecQuery
+  class Grep < Search
+    attr_accessor :grep_opts
+    GREP_TMP_FILE = ".tests.tmp"
+
+    def self.available?
+      system("grep --v > /dev/null")
+    end
+
+    def self.available_options
+      parent_options = super()
+      parent_options[" --r"] = "Use grep regexp subset: https://help.ubuntu.com/community/grep"
+      parent_options
+    end
+
+    # TODO parse self.options to grep options
+    def parse_options
+      self.grep_opts = ""
+    end
+
+    def get_files_with_regex(regex, options)
+      # find all file names in spec/ by regular expression
+      # -r => recursive
+      # -l => file names with matches
+      # write to GREP_TMP_FILE file
+      res = system "grep -r -l #{grep_opts} '#{regex}' spec/* | grep _spec.rb > #{GREP_TMP_FILE}"
+      read_tmp_file(res, GREP_TMP_FILE)
+    end
+
+    def get_with_keyword(keyword, options)
+      # find all file names in spec/ that contain keyword.
+      # -F => fixed string, not regexp
+      # -r => recursive
+      # -l => file names with matches
+      # -i => ingore case
+      # write to GREP_TMP_FILE file
+      self.grep_opts += options.include?("--c") ? "" : " -i "
+      res = system "grep -F -r -l #{grep_opts} '#{keyword}' spec/* | grep _spec.rb > #{GREP_TMP_FILE}"
+      read_tmp_file(res, GREP_TMP_FILE)
+    end
+
+    private
+
+    def read_tmp_file(res, file_name)
+      unless res
+        puts "No maches"
+        exit 1
+      end
+      begin
+        file = File.open(file_name, "rb")
+        contents = file.read
+        file.close
+      rescue => e
+        puts "Exception: #{e}"
+        exit 1
+      end
+      cleanup
+      contents.split("\n")
+    end
+
+    def cleanup
+      system "rm #{GREP_TMP_FILE}"
+    end
+  end
+end
+

data/lib/spec_query/search/search.rb

@@ -0,0 +1,59 @@
+module SpecQuery
+  class Search
+    # original options, original query
+    attr_accessor :options, :query
+
+    def self.available_options
+      {" --c" => "Case sensitive", " --r" => "Use regexp"}
+    end
+
+    def initialize(query)
+      self.query, self.options = split_query(query)
+    end
+
+    def get_files
+      parse_options
+      if options.include?("--r")
+        get_files_with_regex(query, options)
+      else
+        get_files_with_keywords(query, options)
+      end
+    end
+
+    protected
+
+    # TODO
+    # * use some library for parsing this
+    def split_query(original_query)
+      options = []
+      query = original_query
+      self.class.available_options.keys.each do |o|
+        if original_query.include?(o)
+          query = query.gsub(o, "")
+          options << o.strip
+        end
+      end
+      [query, options]
+    end
+
+    def get_files_with_keywords(keywords, options)
+      files = []
+      # keyword1&&keyword2||keyword3&&keyword4
+      keywords.split("||").each do |keywords_and|
+        # [keyword1&&keyword2, keyword3&&keyword4]
+        files_and = []
+        keywords_and.split("&&").each_with_index do |k, i|
+          # [[keyword1, keyword2], [keyword3, keyword4]]
+          if i == 0 # first time just add
+            files_and = get_with_keyword(k, options)
+          else # use & for getting only what we were requested
+            files_and = files_and & get_with_keyword(k, options)
+          end
+        end
+        files << files_and
+      end
+      files.flatten.uniq
+    end
+  end
+end
+

data/lib/spec_query/version.rb

@@ -0,0 +1,4 @@
+module SpecQuery
+  VERSION = "0.0.1"
+end
+

data/lib/tasks/spec_query.rake

@@ -0,0 +1,20 @@
+# created by Titas Norkūnas
+# run specs by file contents
+# searches all spec files for keywords and runs only those specs, that contain them.
+# you can use || as OR and && as AND.
+
+require "rubygems"
+require "spec_query" # do not load environment == faster
+
+namespace :q do
+  # TODO
+  # * add more options
+  #   ** add option to search in filenames, not only contents
+  # * make this work on non-unix
+  desc "Query spec: searches all spec files for keywords and runs only those specs, that contain them"
+  task :spec do
+    spec_runner = SpecQuery::SpecRunner.new
+    spec_runner.run(ENV)
+  end
+end
+

data/spec_query.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "spec_query/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spec_query"
+  s.version     = SpecQuery::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Titas Norkūnas"]
+  s.email       = ["titas.norkunas@gmail.com"]
+  s.homepage    = "http://www.assembla.com/profile/titas.norkunas"
+  s.summary     = %q{Run specs by keywords they contain}
+  s.description = %q{This is a small utility to query specs for Ruby on Rails projects}
+
+  s.rubyforge_project = "spec_query"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: spec_query
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Titas Nork\xC5\xABnas"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-28 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: This is a small utility to query specs for Ruby on Rails projects
+email: 
+- titas.norkunas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- init.rb
+- lib/extentions/README
+- lib/extentions/examples/breakout_query_ext.rb
+- lib/spec_query.rb
+- lib/spec_query/query/query.rb
+- lib/spec_query/run/simple_cmd.rb
+- lib/spec_query/search/grep.rb
+- lib/spec_query/search/search.rb
+- lib/spec_query/version.rb
+- lib/tasks/spec_query.rake
+- spec_query.gemspec
+has_rdoc: true
+homepage: http://www.assembla.com/profile/titas.norkunas
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: spec_query
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Run specs by keywords they contain
+test_files: []
+