continuus_lenimentus 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGRkN2E0MjI3MDhkZmEwNThmNzk5ODU0ZGViM2EyYTBmNDBlNGZhMw==
+    NDAyZDBkNDQwNTU1NGJhMzA1NDcxYjg2MWJjMDlhOTdkZTFlZjRkNg==
   data.tar.gz: !binary |-
-    NzhjMjE1ZmZjNGYyYTNmZDZkZDc1OGE1MWIyZGQ4YzdmODYzNDM0Yg==
+    NGJiMGE0NTNmZjk1ZDM5NWRlZjM2ZTU4YTViOWE2MGZkODQ3YmVkMw==
 SHA512:
   metadata.gz: !binary |-
-    ZTIxZjhhMDE4N2U5NjMzM2ZkMjJkYjAxMGMyZjI3MGRkYWJmNTY3ODgyODgw
-    NGY0YzI0Y2Y1OTczZGMzOGFjNTUxYmU5NWM3MjJkNmI1ZDUxZWEyOWZmN2Jk
-    YmRiOTRhMTc4ZGI1MTk1ZmQ4ZjVkZTY2MDI1NmE5YWU2YjY2ZTE=
+    NjllOGE5NGVhNmVmZWY3NGU4ZTdlMDc3N2M5ZWM3N2UyODZlNGJjNTA5NDU4
+    NmU1NGJiNDdmYzY3ZTg5MzM3ZTIyMTMwZjgwZmY0MDUyMmVhYWRmMjAxNDc1
+    YmFkNTc0YjRlZjE5N2U1ZjhhMTgwNmM2YzkzYzQyNjM3NGM5MjU=
   data.tar.gz: !binary |-
-    M2U4ZmFmNmVmNzU5YTJlOWQyMGZhMjZlMWMyODQyNDhlMDVmNzYzNDdiZWYy
-    YTcxM2M5MTMzMzVhZWUxZDE1YjgyNTEyZGNkYTM5NWM4OTM2MTYyZTQ5ZDMw
-    NTllMTkyMjk0YWJiZmYwZDFlNDc0MzQ4ZjhmNGMzZTJkYTExNjQ=
+    N2MxODZmMWM4MzY3NDdiZTk1YjljYjE5MzM1OGUyZjRhNTA2MGEwYTUwOGM4
+    ODgyYWM1Mzk4MmE1ODY5MTA4MjY1NDQzN2I0NGZlMzk0MGM0M2M4MWI4YzRj
+    OGRmY2M5MzdjOWY4NWVhMWM0MDAwZGRlZGQ0YTQ1YWUwOTAyNzM=

data/README.md

@@ -2,13 +2,17 @@
 
 # Continuus Lenimentus
 
-A SimpleCov Formatter for Continuus Lenimentus Local CI. When the spec suite is run a file is generated with data on the state of the test suite. This is encrypted with a key to ensure minimal conflicts when using version control.
+A SimpleCov Formatter for Continuus Lenimentus Local CI. When the spec suite is run a file is generated with metrics and the state of the test suite.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'continuus_lenimentus', '~> 0.0.1'
+    group :test do
+      gem 'rspec', '~> 2.14.1'
+      gem 'simplecov', '~> 0.7.1', require: false
+      gem 'continuus_lenimentus', '~> 0.0.3', require: false
+    end
 
 And then execute:
 
@@ -35,17 +39,70 @@ Within your applications `.simplecov` file add `SimpleCov::Formatter::ContinuusL
     
 And within your `spec_helper.rb` file add a configuration block if required.
 
+**Note**: The RSpec `ContinuusLenimentusRspecFormatter` formatter currently only supports the default `progress` format.
+
     require "simplecov"
     require 'continuus_lenimentus'
+    
+    RSpec.configure do |config|
+      config.formatter = ContinuusLenimentusRspecFormatter
+    end
 
     ContinuusLenimentus.configure do |config|
-      config.key = 'MQofYpgCMZ79shxTtgYiQFEuvPdw'
-      config.file = 'ci.enc'
+      config.encrypted = true
+      config.key       = 'MQofYpgCMZ79shxTtgYiQFEuvPdw'
+      config.file      = 'ci.enc'
       config.directory = Dir.getwd
-      condig.message = "CI generated."
+      condig.message   = "CI generated."
     end
 
-Each time you run your spec suite a file will be generated.
+Each time you run your spec suite a file will be generated, in this case `/ci.enc`.
+
+## Generated File
+
+Regardless of encryption the file generated will contain the following data.
+
+    {
+      created_at: 2013-11-07 20:49:16 +0000, 
+      duration: 0.003154, 
+      counts: {
+        example: 28, 
+        failure: 2, 
+        pending: 1
+      }, 
+      metrics: {
+        total_lines: 521, 
+        coverage: {
+          percent: 100.0, 
+          strength: 1.1428571428571428, 
+          lines: 521
+        }
+      }
+    }
+
+## Encryption
+`Type (AES - 256)`
+
+The generated file is encrypted by default to ensure minimal conflicts when using version control. Be sure to set your private `key` within the configuration block if your wish to use encryption.
+
+There may be a case where you wish to append or alter the generated file before encrypting the content. In this case, be sure to set `encrypted` in the configuration block to `false`.
+
+    require "simplecov"
+    require 'continuus_lenimentus'
+    
+    ContinuusLenimentus::Safe.new('OnTheBeach').encrypt
+    # => "EnjUhJkaI..."
+
+## Decryption
+`Type (AES - 256)`
+
+The encrypted file is useless to you unless you can decrypt it.
+
+    require "simplecov"
+    require 'continuus_lenimentus'
+    
+    ContinuusLenimentus::Safe.new(generated_content).decrypt
+    # => { created_at: 2013-11-07 20:49:16 +0000... }
 
 ## Configuration
 
@@ -58,6 +115,7 @@ Each time you run your spec suite a file will be generated.
 ## Requirements
 
 * ruby > 1.9.x
+* rspec-core > 2.0.x
 * simplecov > 0.7.x
 * gibberish > 1.3.x
 

data/continuus_lenimentus.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chuck J hardy"]
   spec.email         = ["chuckjhardy@gmail.com"]
   spec.description   = %q{A SimpleCov Formatter for Continuus Lenimentus Local CI.}
-  spec.summary       = %q{A SimpleCov Formatter for Continuus Lenimentus Local CI. When the spec suite is run a file is generated with data on the state of the test suite. This is encrypted with a key to ensure minimal conflicts when using version control.}
-  spec.homepage      = "https://github.com/ChuckJHardy/SimpleLocalCI"
+  spec.summary       = %q{A SimpleCov Formatter for Continuus Lenimentus Local CI. When the spec suite is run a file is generated with metrics and the state of the test suite.}
+  spec.homepage      = "https://github.com/ChuckJHardy/ContinuusLenimentus"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/continuus_lenimentus/adapter.rb

@@ -6,6 +6,10 @@ module ContinuusLenimentus
       @result = result
     end
 
+    def as_user
+      encrypt? ? as_json : as_hash
+    end
+
     def as_json
       as_hash.to_json
     end
@@ -13,7 +17,8 @@ module ContinuusLenimentus
     def as_hash
       {
         created_at: result.created_at,
-        command_name: result.command_name,
+        duration: rspec.fetch(:duration, 0),
+        counts: rspec.fetch(:counts, {}),
         metrics: metrics
       }
     end
@@ -21,6 +26,10 @@ module ContinuusLenimentus
     private
     attr_reader :result
 
+    def rspec
+      ContinuusLenimentus::Runner.rspec.results
+    end
+
     def metrics
       {
         total_lines: result.total_lines,
@@ -39,5 +48,9 @@ module ContinuusLenimentus
     def strength
       result.covered_strength.nan? ? 0.0 : result.covered_strength
     end
+
+    def encrypt?
+      ContinuusLenimentus.configuration.encrypted
+    end
   end
 end

data/lib/continuus_lenimentus/configuration.rb

@@ -1,6 +1,6 @@
 module ContinuusLenimentus
   class Configuration
-    attr_accessor :encrypted, :key, :file, :directory, :message
+    attr_accessor :rspec, :encrypted, :key, :file, :directory, :message
 
     def initialize
       self.encrypted = true

data/lib/continuus_lenimentus/runner.rb

@@ -0,0 +1,13 @@
+module ContinuusLenimentus
+  class Runner
+    attr_accessor :results
+
+    def initialize
+      self.results = {}
+    end
+
+    def self.rspec
+      @rspec ||= Runner.new
+    end
+  end
+end

data/lib/continuus_lenimentus/save.rb

@@ -9,11 +9,15 @@ module ContinuusLenimentus
     end
 
     def writer
-      File.open(path, mode) { |file| file.puts Safe.encrypt(@data) }
+      File.open(path, mode) { |file| file.puts data }
     end
 
     private
 
+    def data
+      encrypt? ? Safe.encrypt(@data) : @data 
+    end
+
     def mode
       'w+'
     end
@@ -21,6 +25,10 @@ module ContinuusLenimentus
     def path
       Path.full
     end
+
+    def encrypt?
+      ContinuusLenimentus.configuration.encrypted
+    end
   end
 end
 

data/lib/continuus_lenimentus/version.rb

@@ -1,3 +1,3 @@
 module ContinuusLenimentus
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/continuus_lenimentus.rb

@@ -1,10 +1,13 @@
 require "continuus_lenimentus/configuration"
+require "continuus_lenimentus/runner"
 require "continuus_lenimentus/version"
 require "continuus_lenimentus/safe"
 require "continuus_lenimentus/adapter"
 require "continuus_lenimentus/path"
 require "continuus_lenimentus/save"
 
+require "rspec/core/formatters/base_text_formatter"
+
 module ContinuusLenimentus
   def self.configuration
     @configuration ||= Configuration.new
@@ -16,12 +19,27 @@ module ContinuusLenimentus
   end
 
   def self.format(result)
-    Save.this(Adapter.new(result).as_json).tap do |_|
+    Save.this(Adapter.new(result).as_user).tap do |_|
       puts ContinuusLenimentus.configuration.message
     end
   end
 end
 
+class ContinuusLenimentusRspecFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    ContinuusLenimentus::Runner.rspec.results = {
+      duration: duration,
+      counts: {
+        example: example_count, 
+        failure: failure_count, 
+        pending: pending_count
+      }
+    }
+
+    super(duration, example_count, failure_count, pending_count)
+  end
+end
+
 class SimpleCov::Formatter::ContinuusLenimentusFormatter
   def format(result)
     ContinuusLenimentus.format(result)

data/spec/continuus_lenimentus_spec.rb

@@ -27,6 +27,34 @@ describe ContinuusLenimentus do
     end
   end
 
+  describe '#dump_summary' do
+    subject { formatter.dump_summary(duration, example_count, failure_count, pending_count) }
+
+    let(:formatter) { ContinuusLenimentusRspecFormatter.new(output) }
+    let(:output) { double('Output', puts: '') }
+    let(:runner) { ContinuusLenimentus::Runner.rspec.results }
+    let(:duration) { 100 }
+    let(:example_count) { 10 }
+    let(:failure_count) { 1 }
+    let(:pending_count) { 2 }
+
+    let(:expected_hash) do
+      {
+        duration: duration,
+        counts: {
+          example: example_count, 
+          failure: failure_count, 
+          pending: pending_count
+        }
+      }
+    end
+
+    it 'assigns the runner rspec results instance' do
+      subject
+      expect(runner).to eq(expected_hash)
+    end
+  end
+
   describe '#format' do
     subject { formatter.format(result)  }
 
@@ -45,7 +73,8 @@ describe ContinuusLenimentus do
 
     let(:data) { ContinuusLenimentus::Adapter.new(result).as_json }
 
-    it 'class off to Save with Adapted results' do
+    it 'calls off to Save with Adapted results' do
+      ContinuusLenimentus.configuration.encrypted = true
       ContinuusLenimentus::Save.should_receive(:this).with(data)
 
       described_class.should_receive(:puts).

data/spec/lib/continuus_lenimentus/adapter_spec.rb

@@ -19,7 +19,8 @@ describe ContinuusLenimentus::Adapter do
   let(:expected_hash) do
     {
       created_at: "2013-11-05 18:35:29 +0000",
-      command_name: "RSpec",
+      duration: duration,
+      counts: rspec_counts,
       metrics: {
         total_lines: 21,
         coverage: {
@@ -31,6 +32,48 @@ describe ContinuusLenimentus::Adapter do
     }
   end
 
+  let(:duration) { 0.003537 }
+  let(:rspec_results) do
+    {
+      duration: duration,
+      counts: rspec_counts
+    }
+  end
+
+  let(:rspec_counts) do
+    {
+      example: 100, 
+      failure: 10, 
+      pending: 2
+    }
+  end
+
+  before do
+    ContinuusLenimentus::Runner.rspec.results = rspec_results
+  end
+
+  describe '#as_user' do
+    subject { instance.as_user }
+
+    before { ContinuusLenimentus.configuration.encrypted = encrypted }
+
+    context 'when encrypted' do
+      let(:encrypted) { true }
+
+      it 'returns the json response' do
+        expect(subject).to be_an_instance_of(String)
+      end
+    end
+
+    context 'when encryption' do
+      let(:encrypted) { false }
+
+      it 'returns the hash response' do
+        expect(subject).to eq(expected_hash)
+      end
+    end
+  end
+
   describe '#as_json' do
     subject { instance.as_json }
 

data/spec/lib/continuus_lenimentus/runner_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe ContinuusLenimentus::Runner do
+  let(:instance) { described_class.new }
+
+  describe '.rspec' do
+    subject { described_class.rspec }
+
+    it 'returns an instance of runner' do
+      expect(subject).to be_an_instance_of(ContinuusLenimentus::Runner)
+    end
+  end
+
+  describe "#results" do
+    subject { instance.results }
+
+    let(:default) { {} }
+    let(:new) { { key: :value} }
+
+    it "returns a hash" do
+      expect(subject).to be_an_instance_of(Hash)
+    end
+
+    it 'returns a default hash' do
+      expect(subject).to eq(default)
+    end
+
+    it 'returns altered hash' do
+      instance.results = new
+      expect(subject).to eq(new)
+    end
+  end
+end

data/spec/lib/continuus_lenimentus/save_spec.rb

@@ -20,13 +20,35 @@ describe ContinuusLenimentus::Save do
     let(:path) { 'path/to/file' }
     let(:mode) { 'w+' }
     let(:file) { double('File') }
+    let(:encrypted) { true }
 
-    it 'writes encryped string to file' do
-      ContinuusLenimentus::Path.should_receive(:full).and_return(path)
-      File.should_receive(:open).with(path, mode).and_yield(file)
-      file.should_receive(:puts).with(an_instance_of(String))
+    before do
+      ContinuusLenimentus.configuration.encrypted = encrypted
+    end
+
+    context 'with encryptd content' do
+      it 'writes encryped string to file' do
+        ContinuusLenimentus::Path.should_receive(:full).and_return(path)
+        ContinuusLenimentus::Safe.should_receive(:encrypt).
+          with(adapter).and_return('')
+
+        File.should_receive(:open).with(path, mode).and_yield(file)
+        file.should_receive(:puts).with('')
+
+        subject
+      end
+    end
+
+    context 'without encryptd content' do
+      let(:encrypted) { false }
+
+      it 'writes encryped string to file' do
+        ContinuusLenimentus::Path.should_receive(:full).and_return(path)
+        File.should_receive(:open).with(path, mode).and_yield(file)
+        file.should_receive(:puts).with(adapter)
 
-      subject
+        subject
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: continuus_lenimentus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chuck J hardy
@@ -100,6 +100,7 @@ files:
 - lib/continuus_lenimentus/adapter.rb
 - lib/continuus_lenimentus/configuration.rb
 - lib/continuus_lenimentus/path.rb
+- lib/continuus_lenimentus/runner.rb
 - lib/continuus_lenimentus/safe.rb
 - lib/continuus_lenimentus/save.rb
 - lib/continuus_lenimentus/version.rb
@@ -107,10 +108,11 @@ files:
 - spec/lib/continuus_lenimentus/adapter_spec.rb
 - spec/lib/continuus_lenimentus/configuration_spec.rb
 - spec/lib/continuus_lenimentus/path_spec.rb
+- spec/lib/continuus_lenimentus/runner_spec.rb
 - spec/lib/continuus_lenimentus/safe_spec.rb
 - spec/lib/continuus_lenimentus/save_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/ChuckJHardy/SimpleLocalCI
+homepage: https://github.com/ChuckJHardy/ContinuusLenimentus
 licenses:
 - MIT
 metadata: {}
@@ -134,13 +136,13 @@ rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: A SimpleCov Formatter for Continuus Lenimentus Local CI. When the spec suite
-  is run a file is generated with data on the state of the test suite. This is encrypted
-  with a key to ensure minimal conflicts when using version control.
+  is run a file is generated with metrics and the state of the test suite.
 test_files:
 - spec/continuus_lenimentus_spec.rb
 - spec/lib/continuus_lenimentus/adapter_spec.rb
 - spec/lib/continuus_lenimentus/configuration_spec.rb
 - spec/lib/continuus_lenimentus/path_spec.rb
+- spec/lib/continuus_lenimentus/runner_spec.rb
 - spec/lib/continuus_lenimentus/safe_spec.rb
 - spec/lib/continuus_lenimentus/save_spec.rb
 - spec/spec_helper.rb