knapsack 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed337f85241e8de0a55b8f40474e07c491ffa954
+  data.tar.gz: 594c3f97f5076272f0883de5f093e6c6930e68f9
+SHA512:
+  metadata.gz: 18e3ba7b288ce4b91d174b121b7f731564bf39e720ef7fa37191bfd68387696e5bbc45c1bc06a28fb0bc503c875078748d673a1f851af321eb657c92bcea78e4
+  data.tar.gz: 6eed013b760611599ce3bb8028cfc7bea32e6e853b5fc7a1366bdf26d8d2b41f443aed166777fd1d7dc7b6d2c467572f0a0cc7ab36dd4d94f26610030a2ef9f0

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/.rspec

@@ -0,0 +1,5 @@
+--color
+--warnings
+--require spec_helper
+--format documentation
+#--profile

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+addons:
+  code_climate:
+    repo_token: 38686058eed480dd0fcf8bce9015733e0bae88e44e30f4a1ac63df8aec2f86d8
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
+script:
+  - bundle exec rspec spec
+  # generate knapsack report
+  - KNAPSACK_GENERATE_REPORT=true bundle exec rspec --default-path spec_examples
+  # run specs with enabled time offset warning
+  - bundle exec rspec --default-path spec_examples
+notifications:
+  email: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ArturT
+
+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,71 @@
+# Knapsack
+
+[![Build Status](https://travis-ci.org/ArturT/knapsack.svg?branch=master)](travis)
+[![Code Climate](https://codeclimate.com/github/ArturT/knapsack.png)](codeclimate)
+[![Coverage Status](https://codeclimate.com/github/ArturT/knapsack/coverage.png)][coverage]
+
+[travis]: http://travis-ci.org/ArturT/knapsack
+[codeclimate]: https://codeclimate.com/github/ArturT/knapsack
+[coverage]: https://codeclimate.com/github/ArturT/knapsack
+
+Parallel specs across CI server nodes based on each spec file's time execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knapsack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knapsack
+
+## Usage
+
+Add at the beginning of your `spec_helper.rb`:
+
+    require 'knapsack'
+    # default configuration, you can change it or omit
+    Knapsack.tracker.config({
+        enable_time_offset_warning: true,
+        time_offset_warning: 30,
+    })
+    Knapsack::Adapters::Rspec.bind
+
+Generate time execution report for your spec files.
+
+    $ KNAPSACK_GENERATE_REPORT=true rspec spec
+
+Commit generated report `knapsack_report.json` into your repository.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/knapsack/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
+
+## Tests
+
+### Spec
+
+To run specs for Knapsack gem type:
+
+    $ rspec spec
+
+### Spec examples
+
+Directory `spec_examples` contains examples of fast and slow specs. There is a `spec_helper.rb` with binded Knapsack.
+
+Change one spec to make it sure it will take more than 5 seconds then run below to see Knapsack time offset warning.
+
+    $ rspec --default-path spec_examples
+
+To generate a new knapsack report file please type:
+
+    $ KNAPSACK_GENERATE_REPORT=true rspec --default-path spec_examples

data/Rakefile

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

data/knapsack.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knapsack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knapsack"
+  spec.version       = Knapsack::VERSION
+  spec.authors       = ["ArturT"]
+  spec.email         = ["arturtrzop@gmail.com"]
+  spec.summary       = %q{Parallel specs across CI server nodes based on each spec file's time execution.}
+  spec.description   = %q{Parallel specs across CI server nodes based on each spec file's time execution. It generates spec time execution report and uses it for further test runs.}
+  spec.homepage      = "https://github.com/ArturT/knapsack"
+  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', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  spec.add_development_dependency 'timecop', '~> 0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
+end

data/knapsack_report.json

@@ -0,0 +1,14 @@
+{
+  "./spec_examples/fast/1_spec.rb": 9.584426879882812e-05,
+  "./spec_examples/fast/2_spec.rb": 0.00014638900756835938,
+  "./spec_examples/fast/3_spec.rb": 0.0002243518829345703,
+  "./spec_examples/fast/4_spec.rb": 0.0002560615539550781,
+  "./spec_examples/fast/5_spec.rb": 0.00023126602172851562,
+  "./spec_examples/fast/6_spec.rb": 0.00020503997802734375,
+  "./spec_examples/slow/a_spec.rb": 1.6018133163452148,
+  "./spec_examples/slow/b_spec.rb": 3.202699661254883,
+  "./spec_examples/slow/c_spec.rb": 1.0021936893463135,
+  "./spec_examples/slow/d_spec.rb": 4.001989841461182,
+  "./spec_examples/slow/e_spec.rb": 2.4013099670410156,
+  "./spec_examples/slow/f_spec.rb": 0.60198974609375
+}

data/lib/knapsack.rb

@@ -0,0 +1,14 @@
+require 'knapsack/version'
+require 'knapsack/tracker'
+require 'knapsack/presenter'
+require 'knapsack/report'
+require 'knapsack/adapters/base'
+require 'knapsack/adapters/rspec'
+
+module Knapsack
+  class << self
+    def tracker
+      Knapsack::Tracker.instance
+    end
+  end
+end

data/lib/knapsack/adapters/base.rb

@@ -0,0 +1,33 @@
+module Knapsack
+  module Adapters
+    class Base
+      def self.bind
+        new
+      end
+
+      protected
+
+      def initialize
+        if Knapsack.tracker.generate_report?
+          puts 'Knapsack report generator started!'
+          bind_time_tracker
+          bind_report_generator
+        elsif Knapsack.tracker.config[:enable_time_offset_warning]
+          puts 'Knapsack time offset warning enabled!'
+          bind_time_tracker
+          # TODO
+        else
+          puts 'Knapsack is off!'
+        end
+      end
+
+      def bind_time_tracker
+        raise NotImplementedError
+      end
+
+      def bind_report_generator
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/knapsack/adapters/rspec.rb

@@ -0,0 +1,38 @@
+module Knapsack
+  module Adapters
+    class Rspec < Base
+      protected
+
+      def bind_time_tracker
+        ::RSpec.configure do |config|
+          config.before(:each) do
+            Knapsack.tracker.spec_path = Rspec.spec_path
+            Knapsack.tracker.start_timer
+          end
+
+          config.after(:each) do
+            Knapsack.tracker.stop_timer
+          end
+
+          config.after(:suite) do
+            puts
+            puts Presenter.global_time
+          end
+        end
+      end
+
+      def bind_report_generator
+        ::RSpec.configure do |config|
+          config.after(:suite) do
+            Report.save
+            puts Presenter.report_details
+          end
+        end
+      end
+
+      def self.spec_path
+        ::RSpec.current_example.metadata[:example_group][:file_path]
+      end
+    end
+  end
+end

data/lib/knapsack/presenter.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+require 'json'
+
+module Knapsack
+  class Presenter
+    class << self
+      def report_yml
+        Knapsack.tracker.files.to_yaml
+      end
+
+      def report_json
+        JSON.pretty_generate(Knapsack.tracker.files)
+      end
+
+      def global_time
+        "Knapsack global time execution for specs: #{Knapsack.tracker.global_time}s"
+      end
+
+      def report_details
+        "Knapsack report was generated. Preview:\n" + Presenter.report_json
+      end
+    end
+  end
+end

data/lib/knapsack/report.rb

@@ -0,0 +1,20 @@
+module Knapsack
+  class Report
+    REPORT_PATH = 'knapsack_report.json'
+
+    class << self
+      def save
+        File.open(REPORT_PATH, 'w+') do |f|
+          f.write(Presenter.report_json)
+        end
+      end
+
+      def open
+        report = File.read(REPORT_PATH)
+        JSON.parse(report)
+      rescue Errno::ENOENT
+        raise "Knapsack report file doesn't exist. Please generate report first!"
+      end
+    end
+  end
+end

data/lib/knapsack/tracker.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+
+module Knapsack
+  class Tracker
+    include Singleton
+
+    attr_reader :global_time, :files
+    attr_writer :spec_path
+
+    def initialize
+      set_defaults
+    end
+
+    def generate_report?
+      ENV['KNAPSACK_GENERATE_REPORT'] || false
+    end
+
+    def config(opts={})
+      @config ||= default_config
+      @config.merge!(opts)
+    end
+
+    def reset!
+      set_defaults
+    end
+
+    def start_timer
+      @start_time = Time.now.to_f
+    end
+
+    def stop_timer
+      @execution_time = Time.now.to_f - @start_time
+      update_global_time
+      update_spec_file_time
+      @execution_time
+    end
+
+    private
+
+    def default_config
+      {
+        enable_time_offset_warning: true,
+        time_offset_warning: 30,
+      }
+    end
+
+    def set_defaults
+      @global_time = 0
+      @files = {}
+    end
+
+    def update_global_time
+      @global_time += @execution_time
+    end
+
+    def update_spec_file_time
+      @files[spec_path] ||= 0
+      @files[spec_path] += @execution_time
+    end
+
+    def spec_path
+      @spec_path || raise("spec_path needs to be set by Knapsack Adapter's bind method")
+    end
+  end
+end

data/lib/knapsack/version.rb

@@ -0,0 +1,3 @@
+module Knapsack
+  VERSION = "0.0.3"
+end

data/spec/knapsack/tracker_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+shared_examples 'default trakcer attributes' do
+  it { expect(tracker.global_time).to eql 0 }
+  it { expect(tracker.files).to eql({}) }
+end
+
+describe Knapsack::Tracker do
+  let(:tracker) { described_class.send(:new) }
+
+  it_behaves_like 'default trakcer attributes'
+
+  describe '#generate_report?' do
+    subject { tracker.generate_report? }
+
+    context 'when ENV variable is defined' do
+      before do
+        stub_const("ENV", { 'KNAPSACK_GENERATE_REPORT' => true })
+      end
+      it { should be true }
+    end
+
+    context 'when ENV variable is not defined' do
+      it { should be false }
+    end
+  end
+
+  describe '#config' do
+    context 'when passed options' do
+      let(:opts) do
+        {
+          enable_time_offset_warning: false,
+          fake: true
+        }
+      end
+
+      it do
+        expect(tracker.config(opts)).to eql({
+          enable_time_offset_warning: false,
+          time_offset_warning: 30,
+          fake: true
+        })
+      end
+    end
+
+    context "when didn't pass options" do
+      it do
+        expect(tracker.config).to eql({
+          enable_time_offset_warning: true,
+          time_offset_warning: 30,
+        })
+      end
+    end
+  end
+
+  describe 'track time execution' do
+    let(:now) { Time.now }
+    let(:spec_paths) { ['a_spec.rb', 'b_spec.rb'] }
+
+    before do
+      spec_paths.each_with_index do |spec_path, index|
+        Timecop.freeze(now) do
+          tracker.spec_path = spec_path
+          tracker.start_timer
+        end
+
+        seconds = index + 1
+        Timecop.freeze(now+seconds) do
+          tracker.stop_timer
+        end
+      end
+    end
+
+    it { expect(tracker.global_time).to eql 3.0 }
+    it do
+      expect(tracker.files).to eql({
+        'a_spec.rb' => 1.0,
+        'b_spec.rb' => 2.0,
+      })
+    end
+
+    context '#reset!' do
+      before { tracker.reset! }
+      it_behaves_like 'default trakcer attributes'
+    end
+  end
+end

data/spec/knapsack_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Knapsack do
+  describe '.tracker' do
+    subject { described_class.tracker }
+
+    it { should be_a Knapsack::Tracker }
+    it { expect(subject.object_id).to eql described_class.tracker.object_id }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'timecop'
+Timecop.safe_mode = true
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'knapsack'
+
+RSpec.configure do |config|
+  config.order = :random
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec_examples/fast/1_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe 'Fast 1' do
+  it {}
+end
+

data/spec_examples/fast/2_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Fast 2' do
+  it {}
+  it {}
+end
+

data/spec_examples/fast/3_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Fast 3' do
+  it {}
+  it {}
+  it {}
+end
+

data/spec_examples/fast/4_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'Fast 4' do
+  it {}
+  it {}
+  it {}
+  it {}
+end
+

data/spec_examples/fast/5_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'Fast 5' do
+  it {}
+  it {}
+  it {}
+  it {}
+  it {}
+end
+

data/spec_examples/fast/6_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Fast 6' do
+  it {}
+  it {}
+  it {}
+  it {}
+  it {}
+  it {}
+end
+

data/spec_examples/slow/a_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Slow A' do
+  it { sleep 1 }
+  it { sleep 0.1 }
+  it { sleep 0.5 }
+end

data/spec_examples/slow/b_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Slow B' do
+  it { sleep 2 }
+  it { sleep 0.2 }
+  it { sleep 1 }
+end

data/spec_examples/slow/c_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Slow C' do
+  it { sleep 0.8 }
+  it { sleep 0.1 }
+  it { sleep 0.1 }
+end

data/spec_examples/slow/d_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Slow D' do
+  it { sleep 1 }
+  it { sleep 1 }
+  it { sleep 2 }
+end

data/spec_examples/slow/e_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Slow E' do
+  it { sleep 1 }
+  it { sleep 0.9 }
+  it { sleep 0.5 }
+end

data/spec_examples/slow/f_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Slow F' do
+  it { sleep 0.1 }
+  it { sleep 0.2 }
+  it { sleep 0.3 }
+end

data/spec_examples/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'knapsack'
+Knapsack.tracker.config({
+  enable_time_offset_warning: true,
+  time_offset_warning: 5
+})
+Knapsack::Adapters::Rspec.bind
+
+RSpec.configure do |config|
+  config.order = :random
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: knapsack
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- ArturT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-04 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Parallel specs across CI server nodes based on each spec file's time
+  execution. It generates spec time execution report and uses it for further test
+  runs.
+email:
+- arturtrzop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- knapsack.gemspec
+- knapsack_report.json
+- lib/knapsack.rb
+- lib/knapsack/adapters/base.rb
+- lib/knapsack/adapters/rspec.rb
+- lib/knapsack/presenter.rb
+- lib/knapsack/report.rb
+- lib/knapsack/tracker.rb
+- lib/knapsack/version.rb
+- spec/knapsack/tracker_spec.rb
+- spec/knapsack_spec.rb
+- spec/spec_helper.rb
+- spec_examples/fast/1_spec.rb
+- spec_examples/fast/2_spec.rb
+- spec_examples/fast/3_spec.rb
+- spec_examples/fast/4_spec.rb
+- spec_examples/fast/5_spec.rb
+- spec_examples/fast/6_spec.rb
+- spec_examples/slow/a_spec.rb
+- spec_examples/slow/b_spec.rb
+- spec_examples/slow/c_spec.rb
+- spec_examples/slow/d_spec.rb
+- spec_examples/slow/e_spec.rb
+- spec_examples/slow/f_spec.rb
+- spec_examples/spec_helper.rb
+homepage: https://github.com/ArturT/knapsack
+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: Parallel specs across CI server nodes based on each spec file's time execution.
+test_files:
+- spec/knapsack/tracker_spec.rb
+- spec/knapsack_spec.rb
+- spec/spec_helper.rb