kapnismology 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a662a1647e4ff01d3de77f9161a447a3341ffa4f
+  data.tar.gz: 730c6710054f95a57c72cff0a89f40ab19df018a
+SHA512:
+  metadata.gz: e66ded22c30d6eb294165e0d5c62215be82ae8fcf059d49ae7a6afc54dc246247bf24c6fdc4b5112f98b39d13efb964a5fa20b4eb17effd12be101e29caba029
+  data.tar.gz: 79f7130926266fcd9de53c854f70d05e04523b82af428a73eee0b538f520e80a6ced0d1c6fc8c9e4b59d8b7ca65a53309d2ef3dc90c0820a65d05cbba67fc33b

data/README.md

@@ -0,0 +1,55 @@
+# Kapnismology
+
+Kapnismology 'the study of smoke', is a gem which contains an engine to easily create smoke tests.
+
+## Installation
+
+Kapnismology only supports Rails.
+In the Gemfile write:
+```
+gem 'kapnismology', git: 'git@github.com:mdsol/kapnismology.git'
+```
+
+In your config/routes write:
+
+```
+  mount Kapnismology::Engine, at: "/smoke_test"
+```
+
+## Usage
+
+Access the path '/smoke_test' to see the results of the smoke_test
+
+
+## Adding more smoke tests
+
+Create a class like this:
+```
+class MySmokeTest < Kapnismology::SmokeTest
+
+  def self.name
+    'my_test'
+  end
+
+  def result
+    "BOOO"
+  end
+end
+```
+
+The class must:
+- Inherit from `Kapnismology::SmokeTest`
+- Have a method `self.name` returning a string
+- Have an instance method `result` returning a Kapnismology::Result object
+
+Any class created this way will be called and its result will be added to a resulting hash.
+In this case the result of this class would be added to the result as:
+```
+{'my_test' => 'BOOO'}
+```
+
+## TODO
+
+- rspecs
+- Automount routes
+- Hypermedia output

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Kapnismology'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/kapnismology/application_controller.rb

@@ -0,0 +1,4 @@
+module Kapnismology
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/kapnismology/smoke_tests_controller.rb

@@ -0,0 +1,8 @@
+module Kapnismology
+  class SmokeTestsController < ApplicationController
+    def index
+      result   = SmokeTest.result
+      render text: result.to_json
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Kapnismology::Engine.routes.draw do
+  root to: 'smoke_tests#index'
+end

data/lib/kapnismology.rb

@@ -0,0 +1,8 @@
+#Engines blow up when being autoloaded by Rails and at the same time loaded by other gems
+unless defined?(Kapnismology::Engine)
+  require "kapnismology/engine"
+end
+require 'contracts'
+require 'kapnismology/result'
+require 'kapnismology/evaluation'
+require 'kapnismology/smoke_test'

data/lib/kapnismology/engine.rb

@@ -0,0 +1,15 @@
+module Kapnismology
+  class Engine < ::Rails::Engine
+    initializer "kapnismology.add_autoload_paths", before: :set_autoload_paths do |app|
+      app.config.eager_load_paths += Dir["#{app.config.root}/lib/**/*"]
+    end
+
+   # config.eager_load_paths += Dir["#{app.config.root}/lib/**/*"]
+    isolate_namespace Kapnismology
+    Rails.application.routes.draw do
+      mount Kapnismology::Engine, at: "/smoke_test"
+    end
+
+  end
+
+end

data/lib/kapnismology/evaluation.rb

@@ -0,0 +1,19 @@
+module Kapnismology
+
+  # Mapping of test_name => result for each smoke test
+  class Evaluation
+    include Contracts
+    extend Forwardable
+    attr_reader :test_name
+    def_delegators :@result, :data, :passed, :message
+
+#    Contract String, Any
+    def initialize(test_name, result)
+      @test_name, @result = test_name, result
+    end
+
+    def to_json
+      {test_name => @result.to_hash}.to_json
+    end
+  end
+end

data/lib/kapnismology/result.rb

@@ -0,0 +1,22 @@
+module Kapnismology
+
+  # This is the result of each smoke test.
+  # This class makes sense to enforce smoke test to return something known
+  # Params of the constructor:
+  # * data   : Typically Array or Hash representing the result of the test
+  # * passed : Boolean: true -> test passed, false -> test failed
+  # * message: String: extra message set by the test if it wants to provide more information
+  class Result
+    include Contracts
+    attr_reader :data, :passed, :message
+
+   # Contract Any, Bool, String => nil
+    def initialize(data, passed, message)
+      @data, @passed, @message = data, passed, message
+    end
+
+    def to_hash
+      {result: @data, passed: @passed, message: @message}
+    end
+  end
+end

data/lib/kapnismology/smoke_test.rb

@@ -0,0 +1,53 @@
+
+module Kapnismology
+
+  class RakeTask
+    def output
+      evaluations = SmokeTest.result
+      evaluations.each do |evaluation|
+        puts "The smoke test #{evaluation.test_name} #{passed_or_failed(evaluation.passed)}"
+        puts evaluation.message
+        puts
+      end
+      all_passed = evaluations.map(&:passed).inject{|m, result| m && result}
+      fail 'We have some failures in our smoke tests' unless all_passed
+    end
+
+    def passed_or_failed(passed)
+      passed ? "passed" : "failed"
+    end
+  end
+
+  #
+  # This is the base class for all the smoke tests.
+  # Inherit from this class and implement the result and self.name method
+  #
+  class SmokeTest
+
+    def result
+      raise 'this method has to be implemented in inherited classes'
+    end
+
+    def self.name
+      raise 'this method has to be implemented in inherited classes'
+    end
+
+    class << self
+
+      def inherited(klass)
+        smoke_tests << klass
+      end
+
+      def smoke_tests
+        @smoke_tests ||= []
+      end
+
+      def result
+        smoke_tests.inject([]) do |memo, smoke_test|
+          memo.push(Evaluation.new(smoke_test.name, smoke_test.new.result))
+        end
+      end
+    end
+
+  end
+end

data/lib/kapnismology/version.rb

@@ -0,0 +1,3 @@
+module Kapnismology
+  VERSION = "0.0.1"
+end

data/lib/tasks/kapnismology_tasks.rake

@@ -0,0 +1,5 @@
+# desc "Explaining what the task does"
+# task :smoke_tests do
+
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: kapnismology
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordi Polo Carres
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Engine for smoke tests and base classes
+email:
+- mumismo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/kapnismology/application_controller.rb
+- app/controllers/kapnismology/smoke_tests_controller.rb
+- config/routes.rb
+- lib/kapnismology.rb
+- lib/kapnismology/engine.rb
+- lib/kapnismology/evaluation.rb
+- lib/kapnismology/result.rb
+- lib/kapnismology/smoke_test.rb
+- lib/kapnismology/version.rb
+- lib/tasks/kapnismology_tasks.rake
+homepage: https://www.github.com/JordiPolo/kapnismology
+licenses: []
+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: Engine for smoke tests.
+test_files: []
+has_rdoc: