recot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 315a07523c46f23704d325b5e2af697a0c6ec5d2
+  data.tar.gz: 4852373998c41402ab84a47a40f742400a1de9cb
+SHA512:
+  metadata.gz: c222cb011ee356aec5ba82eb1232be1e96d43acbd12d797100be10f9c135a5a8434050eef24d64c32fb5e27557ce1e48b9285b60a90f42d2eb7319a2a2756333
+  data.tar.gz: ac7dfb345660e024fd94164bb3cc175d3d7de5c4cd3ad9ae2ec19ed95a42ae05e1ee4e89a1e1611dca2550ec54e9a585354156dc9ce7b4d5176c71640fc7c5e8

data/.gitignore

@@ -0,0 +1,43 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# output directory for recot
+/__output/
+/basket/
+/log/
+.cahce
+config.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,22 @@
+notification :off
+
+guard 'livereload' do
+  extensions = {
+    css: :css,
+    js: :js,
+    html: :html,
+    png: :png,
+    gif: :gif,
+    jpg: :jpg,
+    jpeg: :jpeg,
+  }
+
+  exts = %w(erb haml html)
+
+  # file types LiveReload may optimize refresh for
+  compiled_exts = extensions.values.uniq
+  watch(%r{__output/public/.+\.(#{compiled_exts * '|'})})
+
+  # file needing a full reload of the page anyway
+  watch(%r{__output/.+\.(#{exts * '|'})$})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Slowhand
+
+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,100 @@
+# Recot
+
+**R**uby **e**vidence **co**llect **t**ool<br>
+
+Recot is a tool to gather evidence of the test.
+
+## Description
+Create evidence document for test to easy.<br>
+Throw evidence(screen shots or file...) to specific folder for create evidence document.
+
+## Install
+
+Install the gem with:
+
+```sh
+gem install recot
+```
+## Usage
+
+To begin the test with the following command:
+
+```sh
+$ recot start
+Start recot ver 0.1.0
+
+    ____                  __
+   / __ \___  _________  / /
+  / /_/ / _ \/ ___/ __ \/ __/
+ / _, _/  __/ /__/ /_/ / /
+/_/ |_|\___/\___/\____/\__/
+```
+
+Enter the test number as follows:
+
+```sh
+[1](recot) > A1
+```
+
+Directory corresponding to the test number is created under `__output/resources`.
+
+```
+├── __output
+│   └── resources
+│       ├── A1
+```
+
+It threw the evidence to the `basket` directory.
+
+It will be reflected in the HTML automatically.
+
+```
+├── __output
+│   ├── index.html
+│   └── resources
+│       ├── A1
+│       │   ├── access.log
+│       │   └── screenshot.png
+│       └── A1.html
+```
+
+access the 'http://localhost:9292/__output/index.html'
+
+* index.html
+![img001](http://slowhand0309.github.io/images/recot/index_html.png)
+
+* resource.html
+![img002](http://slowhand0309.github.io/images/recot/resource_html.png)
+
+If you want to delete the previous evidence, run the following command:
+
+```sh
+[2](recot) > cancle
+```
+
+If you want to delete all the evidence of the particular test number, run the following command:
+
+```sh
+[3](recot) > clear
+```
+
+If you want to test the end, run the following command:
+
+```sh
+[4](recot) > exit
+```
+
+If you want to delete all file and directory,
+run the following command:
+
+```sh
+[5](recot) > destroy
+```
+
+## Licence
+
+[MIT](https://github.com/tcnksm/tool/blob/master/LICENCE)
+
+## Author
+
+[slowhand0309](https://github.com/Slowhand0309)

data/Rakefile

@@ -0,0 +1,7 @@
+# coding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/recot

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require "gli"
+require "recot"
+
+class RecotExecutable
+  extend GLI::App
+
+  version Recot::VERSION
+
+  desc 'Start server for recot'
+  command :s, :server do |cmd|
+
+    cmd.desc 'Server listen port'
+    cmd.flag [:p, :port], default_value: 9292
+    cmd.action do |_, options, _|
+      Recot::Commands.server(options[:port])
+    end
+  end
+
+  desc 'Start recot'
+  command :start do |cmd|
+
+    cmd.action do |_, options, _|
+      Recot::Commands.start
+    end
+  end
+
+  desc 'Clean cache'
+  command :cleanup do |cmd|
+
+    cmd.action do |_, options, _|
+      Recot::Cache::StateCache.clear
+      puts "Remove all of the cache."
+    end
+  end
+
+  desc 'Remove all files and cache'
+  command :destroy do |cmd|
+
+    cmd.action do |_, options, _|
+      Recot::Commands.destroy
+    end
+  end
+
+  exit run(ARGV)
+end

data/lib/recot.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+require 'recot/version'
+require 'recot/commands'
+require 'recot/tasks'
+
+module Recot
+
+  # Generate files directory name.
+  OUTPUT_DIR = '__output'.freeze
+
+  # Throw evidence directory name.
+  BASKET_DIR = 'basket'.freeze
+
+  # Resource files directory name.
+  RESOURCE_DIR = 'resources'.freeze
+
+  class << self
+
+    # Get output directory path.
+    #
+    # == Returns:
+    # A string of output directory path.
+    def output_dir()
+      "#{Dir.pwd}/#{OUTPUT_DIR}"
+    end
+
+    # Get resources directory path.
+    #
+    # == Returns:
+    # A string of resources directory path.
+    def resources_dir()
+      "#{output_dir}/#{RESOURCE_DIR}"
+    end
+
+    # Get basket directory path.
+    #
+    # == Returns:
+    # A string of basket directory path.
+    def basket_dir()
+      "#{Dir.pwd}/#{BASKET_DIR}"
+    end
+  end
+
+end

data/lib/recot/cache/state_cache.rb

@@ -0,0 +1,74 @@
+# coding: utf-8
+require 'active_support'
+
+module Recot
+  module Cache
+
+    class StateCache
+
+      # Cache directory name.
+      CACHE_FILE = '.cahce'.freeze
+
+      # Key of current test no.
+      CACHE_KEY_NO = 'current_number'.freeze
+
+      # Key of recent evidence file name.
+      CACHE_KEY_RECENT_EVIDENCE = 'recent_evidence'.freeze
+
+      class << self
+
+        # Store current test no to cache.
+        #
+        # == Parameters:
+        # Test no for cache.
+        def store_no(number)
+          fcache = get_cache()
+          fcache.write(CACHE_KEY_NO, number)
+        end
+
+        # Get cached current test no.
+        #
+        # == Returns:
+        # Current test no.
+        def restore_no()
+          fcache = get_cache()
+          fcache.read(CACHE_KEY_NO)
+        end
+
+        # Store recent evidence to cache.
+        #
+        # == Parameters:
+        # evidence file name.
+        def store_recent_evidence(evidence)
+          fcache = get_cache()
+          fcache.write(CACHE_KEY_RECENT_EVIDENCE, evidence)
+        end
+
+        # Get cached recent evidence.
+        #
+        # == Returns:
+        # evidence file name.
+        def restore_recent_evidence()
+          fcache = get_cache()
+          fcache.read(CACHE_KEY_RECENT_EVIDENCE)
+        end
+
+        # All clear cache.
+        #
+        def clear()
+          fcache = get_cache()
+          fcache.clear
+        end
+
+        # Get cache object.
+        #
+        # == Returns:
+        # ActiveSupport::Cache object.
+        def get_cache()
+          ActiveSupport::Cache::FileStore.new(CACHE_FILE)
+        end
+      end
+
+    end
+  end
+end

data/lib/recot/commands.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+require 'recot/config'
+require 'recot/commands/rack_server'
+require 'recot/commands/guard_server'
+require 'recot/commands/interactive_ui'
+require 'recot/commands/listener'
+require 'recot/utils/recot_util'
+
+module Recot
+  module Commands
+
+    # Start recot.
+    #
+    def self.start
+
+      # Prepare.
+      Utils::RecotUtil.prepare
+
+      # Start guard server.
+      GuardServer.new.run
+
+      # Start rack server.
+      Thread.new do
+        RackServer.new.run
+      end
+
+      # Start listener.
+      Listener.new.run
+
+      # Start interactive operate.
+      InteractiveUi.new.start
+    end
+
+    # Start server.
+    #
+    def self.server(port = nil)
+      RackServer.new(port).run
+    end
+
+    # All clear.
+    #
+    def self.destroy
+      InteractiveUi.new.destroy
+    end
+  end
+end

data/lib/recot/commands/current_clear.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+require 'fileutils'
+require 'recot/cache/state_cache'
+require 'recot/tasks/indexdoc_task'
+
+module Recot
+  module Commands
+    class CurrentClear
+
+      # Clear current test no resources.
+      #
+      # Set nil to cache after delete resources.
+      def self.clear
+        # Get current test no.
+        test_no = Recot::Cache::StateCache.restore_no
+        if test_no
+          # Delete resource directory.
+          FileUtils.rm_r("#{Recot.resources_dir}/#{test_no}")
+
+          # Delete resource html file.
+          FileUtils.rm("#{Recot.resources_dir}/#{test_no}.html")
+
+          # Update index html file.
+          Recot::Tasks::IndexdocTask.new.run
+
+          Recot::Cache::StateCache.store_no(nil)
+        end
+      end
+
+    end
+  end
+end