specss 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62e0dda02c8ae2b19b17707496db1b5074ffdd0cb592ace3ca41e09b715f52e3
+  data.tar.gz: acce2bed54b8bde82ba941ea4e968633c53237fce1345731bd09ba86b58a5e40
+SHA512:
+  metadata.gz: e71febd9e68f475df1d9e46bccddbc813b21e8d6c8824d6f30cdaa2a72938253e50f498b9f6be2d37e5798618487578eeb302ea25b878d253601c41c88c54db1
+  data.tar.gz: a6b638d032f2bd789e4b94a4efb75a65c52702ae99dd41e7a930ac502112ca12c769cd4addd00dd529843ef920f13997990f95b9eacc7e1282cd84539d2176b9

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_STORE
+Gemfile.lock
+/builds
+*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# Smarter Rspec Runner
+Script that runs specs for Spectra Rails projects based off of dependencies and perforce changelists
+
+### Gathering Dependents
+In the script I utilize the [Rubrowser](https://github.com/emad-elsaid/rubrowser) gem to create a dependency graph for the code. 
+
+### Installation
+This gem is publicly available on RubyGems. 
+```
+gem install specss
+```
+If your projects use different Ruby versions, then each one will require this step in order to run.
+
+### Use
+Navigate to the root of your rails app or ruby project and simply run:
+
+``` 
+specss
+```
+
+By default, it only runs the 'lite' version that executes specs based on your p4 status. To run specs on all changed files and 
+all dependents of those changed files, run:
+
+```
+specss -e
+```
+
+For other information, print the help after running the executable:
+
+```
+[~]$ specss -h
+Usage: specss [option]
+    -e, --extended                   Run specs of modified files and dependents
+    -l, --lite                       Run specs of modified files only
+    -v, --version                    Smarter Specs Version
+    -h, --help                       Prints this help
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+# Auto load gem into ruby console
+task :console do
+  exec "irb -r specss -I ./lib"
+end
+
+

data/bin/specss

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'specss'
+require 'specss/executor'
+
+ARGV << '-l' if ARGV.empty? # Default to lite if no arguments are passed
+
+Options = Struct.new(:name)
+
+##
+# Parse arguments that are passed when running specs
+class Parser
+  def self.parse(options)
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: specss [option]"
+
+      opts.on("-e", "--extended", "Run specs of modified files and dependents") do |n|
+        Executor.main('extended')
+      end
+
+      opts.on("-l", "--lite", "Run specs of modified files only") do |n|
+        Executor.main('lite')
+      end
+
+      opts.on("-v", "--version", "Smarter Specs Version") do |n|
+        puts "Specss #{Specss::VERSION}"
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+  end
+end
+
+begin
+  Parser.parse(ARGV)
+rescue OptionParser::InvalidOption
+  puts "Warning: Invalid option"
+  exec("specss -h")
+end

data/lib/specss/executor.rb

@@ -0,0 +1,63 @@
+require 'specss/files'
+
+module Executor
+  class << self
+
+    ##
+    # Takes in option from parse and executes main functions
+    def main(opt)
+      $changed_files = Files::Perforce.get_changelist_files
+
+      # Pass in options from ARGV on whether to run lite or extended
+      case opt
+      when 'extended'
+        specs_to_run = extended
+      else
+        specs_to_run = lite
+      end
+
+      if specs_to_run.empty?
+        puts 'No specs need to be run'
+      else
+        spec_names = Files::Specs.chop_file_paths(specs_to_run)
+        puts 'Running specs: ' + spec_names.join(" ")
+        exec "bundle exec rspec " + specs_to_run.join(" ")
+      end
+    end
+
+    ##
+    # Returns all unique files in changelist and their dependents
+    def get_all_affected_files
+      all_files = $changed_files
+      dependents = get_dependents
+
+      dependents.each do |d|
+        all_files.push(d) unless all_files.include? d
+      end
+      all_files
+    end
+
+    ##
+    # Returns all dependents of files in changelist
+    def get_dependents
+      dependents = []
+      $changed_files.each do |f|
+        dependents_array = Files::Dependencies.get_dependencies(f)
+        dependents_array.each do |d|
+          dependents.push(d) unless dependents.include? d
+        end
+      end
+      dependents
+    end
+
+    def extended
+      all_files = get_all_affected_files
+      Files::Specs.get_specs(all_files)
+    end
+
+    def lite
+      Files::Specs.get_specs($changed_files)
+    end
+  end
+  
+end

data/lib/specss/files.rb

@@ -0,0 +1,81 @@
+module Files
+  require 'json'
+  
+  module Perforce
+    ##
+    # Returns all ruby files in changelist as an array of files without extension
+    def self.get_changelist_files
+      changed_files = []
+      p4_status = %x|p4 status &|
+      p4_array = p4_status.split("\n")
+
+      # Add all ruby files ready to be submitted to changed file array
+      p4_array.each do |p|
+        next unless p.include?('.rb')
+        file = p.split(' - ')[0]
+        status = p.split(' - ')[1]
+        changed_files.push(File.basename(file, ".*")) if status.include? 'submit'
+      end
+      changed_files
+    end
+  end
+
+  module Dependencies
+    ##
+    # Takes in a file and returns all files that are dependents as an array of files without extension
+    def self.get_dependencies(file)
+      dependents = []
+      # Get file name without extension and convert to camel case
+      basename = File.basename(file, ".*")
+      basename = basename.gsub(/(?:^|_)([a-z])/) do $1.upcase end
+
+      # Get rubrowser output and parse for the relation data
+      output = %x|rubrowser &|
+      data = output.match(/var\s+data\s+=\s+(.*?);/m)[1].split('</script>')[0]
+      data_hash = JSON.parse(data)
+      relations = data_hash['relations']
+
+      # Return dependents of input file
+      dependents_data = relations.select { |i| i['resolved_namespace'] == basename }
+      dependents_data.each do |d|
+        filename = d['file']
+        basename = File.basename(filename, ".*")
+        next if basename.include? '_spec'
+        dependents.push(basename) unless dependents.include? basename
+      end
+      dependents
+    end
+  end
+
+  module Specs
+    ##
+    # Returns all specs to run as an array of file paths relative to root
+    def self.get_specs(changed_files)
+      specs_to_run = []
+      specs = Dir.glob('spec/**/*').select{ |e| File.file? e }
+
+      # Check if each spec is included in the list of changed files
+      specs.each do |s|
+        spec_name = File.basename(s, ".*")
+        spec_name.slice! '_spec' if spec_name.include? '_spec'
+        next if spec_name.include? 'shared_examples'
+        specs_to_run.push(s) if changed_files.include? spec_name
+      end
+      specs_to_run
+    end
+
+    ##
+    # Returns array of specs to run with the absolute path chopped off
+    def self.chop_file_paths(specs)
+      specs_to_run = []
+      
+      specs.each do |s|
+        spec_name = File.basename(s)
+        specs_to_run.push(spec_name)
+      end
+      specs_to_run
+    end
+  end
+  
+end
+

data/lib/specss/version.rb

@@ -0,0 +1,3 @@
+module Specss
+  VERSION = '1.0.0'
+end

data/lib/specss.rb

@@ -0,0 +1,5 @@
+require 'specss/version'
+require 'specss/executor'
+
+module Specss
+end

data/specss.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'specss/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'specss'
+  s.version     = Specss::VERSION
+  s.authors     = ['Tom Bonan']
+  s.email       = ['tombonan@spectralogic.com']
+  s.homepage    = 'https://github.com/tombonan/smarter-specs'
+  s.summary     = 'A smarter Rspec Runner'
+  s.description = 'A smarter Rspec Runner'
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.bindir        = 'bin'
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rubrowser', '~> 2.0.0'
+  
+  s.post_install_message = "Welcome to the Spec Party"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: specss
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Bonan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubrowser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A smarter Rspec Runner
+email:
+- tombonan@spectralogic.com
+executables:
+- specss
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/specss
+- lib/specss.rb
+- lib/specss/executor.rb
+- lib/specss/files.rb
+- lib/specss/version.rb
+- specss.gemspec
+homepage: https://github.com/tombonan/smarter-specs
+licenses:
+- MIT
+metadata: {}
+post_install_message: Welcome to the Spec Party
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A smarter Rspec Runner
+test_files: []