testament 0.0.1 → 0.1.0

data/.gitignore

@@ -1,2 +1,4 @@
 .rvmrc
 Gemfile.lock
+pkg
+.testament

data/README.md

@@ -1,9 +1,5 @@
 # Testament
 
-Note: readme driven development is being used -- not everything below will work yet!
-
-NOT READY FOR PRODUCTION USE
-
 Testament is a tool to track the cost of running tests.
 
 ## Installation
@@ -12,9 +8,15 @@ Testament is a tool to track the cost of running tests.
 
 ## Usage
 
+To setup testament with your project run testament init on your project directory.
+
+    $ testament init .
+
+This will create a .testament directory with the project config and the SQLite database that will store the test run information.  
+
 To track the time it takes to run your specs, run them like this every time:
 
-    $ testament record rspec spec/
+    $ testament record rspec spec
 
 If you have your default rake task set to run your whole test suite, then you can do this:
 
@@ -22,13 +24,25 @@ If you have your default rake task set to run your whole test suite, then you ca
 
 You may want to create an alias to rake and rspec to run it with testament track automatically.
 
-## Seeing Trends
+## Reports
+
+To view the default report, run the following in your project folder:
+
+    $ testament report
+
+This will yield output like this:
+
+    +-----------+---------+-------+--------------+------------+
+    | Project   | Command | Count | Average time | Total time |
+    +-----------+---------+-------+--------------+------------+
+    | testament | rspec   | 4     | 6.03675      | 24.147     |
+    +-----------+---------+-------+--------------+------------+
 
-To view some stats, run this:
+To see a report from just today run the following:
 
-    $ testament stats
+    $ testament report today
 
-in your project folder.
+The report definitions are stored in .testament/report. You can edit the existing reports or create new ones.
 
 ## Contributing
 

data/bin/testament

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
-require 'testament/csv_repository'
+require 'testament'
+require 'testament/cli'
 
-command = ARGV[1..-1].join(' ')
-
-start_time = Time.now
-system command
-end_time = Time.now
-
-Testament::CSVRepository.new('testament.log').store command, start_time, end_time
+CLI.start

data/lib/testament.rb

@@ -1,5 +1,9 @@
 require "testament/version"
 
+gem 'activesupport', '~> 3.2.9'
+gem 'sequel', '~> 3.42.0'
+gem 'terminal-table', '~> 1.4.5'
+
+
 module Testament
-  # Your code goes here...
 end

data/lib/testament/cli.rb

@@ -0,0 +1,51 @@
+require 'thor'
+require 'thor/group'
+require 'testament/project'
+require 'testament/report'
+
+class CLI < Thor
+  include Thor::Actions
+
+  source_root(File.join(File.dirname(__FILE__), "generators"))
+
+  attr_accessor :app_name
+
+  desc "init PATH", "initialize testament in directory PATH"
+  def init(path)
+    self.app_name = File.basename File.expand_path(path)
+    self.destination_root = path
+    directory ".testament", ".testament"
+
+    require 'testament/database'
+    database = Testament::Database.new adapter: :sqlite, database: "#{path}/.testament/db.sqlite"
+    database.create_schema
+  end
+
+  desc "record COMMAND", "record and execute COMMAND"
+  def record(*command_words)
+    command = command_words.join(' ')
+    project = Testament::Project.load
+    project.record command
+  end
+
+  desc "log", "print logs"
+  def log
+    project = Testament::Project.load
+    puts project.log
+  end
+
+  desc "report [REPORT_NAME]", "run REPORT_NAME"
+  long_desc <<-END_TXT
+Reports are stored in .testament/report. You can alter or create new reports
+there.
+
+Available reports: #{Testament::Report::Loader.new.report_names.join(' ')}
+END_TXT
+  def report(name='default')
+    require 'terminal-table'
+    project = Testament::Project.load
+    report = project.report name
+    table = Terminal::Table.new :headings => report.headers, :rows => report.rows
+    puts table
+  end
+end

data/lib/testament/database.rb

@@ -0,0 +1,29 @@
+require 'sequel'
+
+module Testament
+  class Database
+    attr_reader :db
+
+    def initialize(connection_parameters)
+      @db = Sequel.connect connection_parameters
+    end
+
+    def create_schema
+      db.create_table :executions do
+        primary_key :id, type: Bignum
+        String :project, null: false
+        String :command, null: false
+        Time :start_time, null: false
+        Fixnum :elapsed_milliseconds, null: false
+        String :user, null: false
+        String :version, null: false
+        String :category, null: false
+      end
+    end
+
+    def record(attributes)
+      db[:executions].insert attributes
+    end
+  end
+
+end

data/lib/testament/project.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+require 'erb'
+require 'testament/database'
+
+module Testament
+  class Project
+    attr_reader :name, :user, :version, :default_category
+
+    def initialize(arguments)
+      @database = Database.new arguments.fetch('database')
+      @name = arguments.fetch('project')
+      @user = arguments.fetch('user')
+      @version = arguments.fetch('version')
+      @default_category = arguments.fetch('default_category')
+    end
+
+    def record(command)
+      start_time = Time.now
+      system command
+      end_time = Time.now
+      elapsed_milliseconds = ((end_time - start_time) * 1000).round
+
+      database.record project: name,
+        command: command,
+        start_time: start_time,
+        elapsed_milliseconds: elapsed_milliseconds,
+        user: user,
+        version: version,
+        category: default_category
+    end
+
+    def log
+      database.db[:executions].order(:start_time).all
+    end
+
+    def report(name)
+      require 'testament/report'
+      Testament::Report.find(name).new database.db
+    end
+
+    def self.load
+      config_path = ".testament/config.yml"
+      config = YAML.load(ERB.new(File.read(config_path)).result)
+      new config
+    end
+
+    private
+
+    attr_reader :database
+  end
+end

data/lib/testament/report.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/time/calculations'
+
+require 'testament/report/base'
+
+module Testament
+  module Report
+    def self.find(name)
+      Loader.new.load
+      "Testament::Report::#{name.camelize}".constantize
+    end
+
+    class Loader
+      def load
+        report_paths.each do |report_path|
+          ::Kernel.load report_path
+        end 
+      end
+
+      def report_names
+        report_paths.map do |report_path|
+          report_path[/\w+(?=\.rb$)/]
+        end
+      end
+
+      private
+        def report_paths
+          Dir.glob('.testament/report/*.rb')
+        end
+    end
+  end
+end

data/lib/testament/report/base.rb

@@ -0,0 +1,27 @@
+module Testament
+  module Report
+    class Base
+      attr_reader :database
+
+      def initialize(database)
+        @database = database
+      end
+
+      def headers
+        @headers ||= dataset.columns.map(&:to_s).map(&:humanize)
+      end
+
+      def rows
+        @rows ||= result_set.map(&:values)
+      end
+
+      def result_set
+        @result_set ||= dataset.all
+      end
+
+      def dataset
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/testament/version.rb

@@ -1,3 +1,3 @@
 module Testament
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'pry'
+
+require 'testament'
+require 'testament/database'

data/spec/testament/database_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Testament::Database do
+  subject(:database) { described_class.new adapter: :sqlite }
+
+  describe 'create_schema' do
+    before { database.create_schema }
+
+    it 'creates executions table' do
+      expect(database.db.tables).to include(:executions)
+    end
+  end
+
+  describe 'record' do
+    before { database.create_schema }
+
+    it 'inserts row in executions table' do
+      database.record project: 'testament',
+        command: 'record',
+        start_time: Time.now,
+        elapsed_milliseconds: 42,
+        user: 'jack',
+        version: '12345678abcdef',
+        category: 'test'
+
+      expect(database.db[:executions].count).to eq(1)
+    end
+  end
+end

data/spec/testament/project_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'testament/project'
+
+describe Testament::Project do
+
+end

data/spec/testament_spec.rb

@@ -1,32 +1,82 @@
 require 'rspec'
 require 'pry'
-require 'time' # for Time.parse
+require 'fileutils'
+require 'securerandom'
 
 RSpec.configure do |config|
   def testament(args="")
     lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
     bin = File.expand_path(File.join(File.dirname(__FILE__), '..', 'bin', 'testament'))
-    `ruby -I #{lib} #{bin} #{args}`
+    `cd #{directory}; ruby -I #{lib} #{bin} #{args}`
   end
 end
 
 describe 'testament' do
+  let(:directory) { File.expand_path(File.join(File.dirname(__FILE__), 'tmp', SecureRandom.hex)) }
+
+  before do
+    FileUtils.mkdir_p directory
+  end
+
+  after do
+    FileUtils.rm_rf directory
+  end
+
+  context 'init' do
+    it 'creates a .testament directory in path argument' do
+      testament "init #{directory}"
+      expect(File.directory?( File.join(directory, '.testament') )).to be_true
+    end
+  end
+
   context 'record' do
-    it 'execute it\'s argument' do
-      result = testament('record echo foo')
+    before do
+      testament "init #{directory}"
+    end
+
+    it 'executes a single word argument' do
+      result = testament 'record pwd'
+      expect(`pwd`.chomp).to eq(FileUtils.pwd)
+    end
+
+    it 'executes a multiple word argument' do
+      result = testament 'record echo foo'
       expect(result).to eq("foo\n")
     end
 
     it 'records the execution of the command' do
+      testament 'record echo foo'
+      output = testament 'log'
+      expect(output).to match(/echo foo/)
+    end
+  end
+
+  context 'log' do
+    before do
+      testament "init #{directory}"
+      testament('record echo foo')
+    end
+
+    it 'outputs the previously logged data' do
+      output = testament 'log'
+      expect(output).to match(/echo foo/)
+    end
+  end
+
+  context 'report' do
+    before do
+      testament "init #{directory}"
       testament('record echo foo')
-      last_line = `tail -n 1 testament.log`
-      command, start_time, end_time = last_line.split(",")
-      expect(command).to eq('echo foo')
-
-      start_time = Time.parse(start_time) rescue nil
-      expect(start_time).to be
-      end_time = Time.parse(end_time) rescue nil
-      expect(end_time).to be
+    end
+
+    it 'runs default report when no name given' do
+      actual = testament 'report'
+      expect(actual).to match(/Command/)
+    end
+
+    it 'runs report by name' do
+      actual = testament 'report today'
+      expect(actual).to match(/echo foo/)
     end
   end
 end

data/testament.gemspec

@@ -12,6 +12,12 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Time, record, and analyze test runs}
   gem.homepage      = "https://github.com/JackC/testament"
 
+  gem.add_dependency 'activesupport', '~> 3.2.9'
+  gem.add_dependency 'sequel', '~> 3.42.0'
+  gem.add_dependency 'sqlite3', '~> 1.3.6'
+  gem.add_dependency 'terminal-table', '~> 1.4.5'
+  gem.add_dependency 'thor', '~> 0.16.0'
+
   gem.add_development_dependency 'rspec', '>= 2.11.0'
   gem.add_development_dependency 'pry'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testament
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.42.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.42.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +139,18 @@ files:
 - Rakefile
 - bin/testament
 - lib/testament.rb
-- lib/testament/csv_repository.rb
+- lib/testament/cli.rb
+- lib/testament/database.rb
+- lib/testament/generators/.testament/config.yml.tt
+- lib/testament/generators/.testament/report/default.rb
+- lib/testament/generators/.testament/report/today.rb
+- lib/testament/project.rb
+- lib/testament/report.rb
+- lib/testament/report/base.rb
 - lib/testament/version.rb
-- spec/testament/csv_repository_spec.rb
+- spec/spec_helper.rb
+- spec/testament/database_spec.rb
+- spec/testament/project_spec.rb
 - spec/testament_spec.rb
 - testament.gemspec
 homepage: https://github.com/JackC/testament
@@ -89,5 +178,7 @@ signing_key:
 specification_version: 3
 summary: Time, record, and analyze test runs
 test_files:
-- spec/testament/csv_repository_spec.rb
+- spec/spec_helper.rb
+- spec/testament/database_spec.rb
+- spec/testament/project_spec.rb
 - spec/testament_spec.rb

data/lib/testament/csv_repository.rb

@@ -1,27 +0,0 @@
-require 'csv'
-
-module Testament
-  class CSVRepository
-    attr_reader :file_name
-
-    def initialize(file_name)
-      @file_name = file_name
-    end
-
-    def store(command, start_time, end_time)
-      ensure_file_exists
-
-      CSV.open(file_name, 'ab') do |csv|
-        csv << [command, start_time, end_time]
-      end
-    end
-
-    private
-      def ensure_file_exists
-        return if File.exist?(file_name)
-        CSV.open(file_name, 'wb') do |csv|
-          csv << %w[command start_time end_time]
-        end
-      end
-  end
-end

data/spec/testament/csv_repository_spec.rb

@@ -1,60 +0,0 @@
-require 'rspec'
-require 'fileutils'
-require 'testament/csv_repository'
-
-describe Testament::CSVRepository do
-  before do
-    FileUtils.rm_f file_path
-  end
-
-  subject(:repository) { Testament::CSVRepository.new file_path }
-
-  let(:file_path) do
-    'spec/tmp/csv.log'
-  end
-
-  describe 'store' do
-    let(:command) { 'foo' }
-    let(:start_time) { Time.local(2012,1,1, 13,0,0) }
-    let(:end_time) { Time.local(2012,1,1, 13,0,1) }
-
-    def rows
-      CSV.read file_path
-    end
-
-    context 'when file does not exist' do
-      before do
-        repository.store command, start_time, end_time
-      end
-
-      it 'creates the file' do
-        expect(File.exist?(file_path)).to be_true
-      end
-
-      it 'writes the CSV header' do
-        expect(rows.first).to eq(%w[command start_time end_time])
-      end
-
-      it 'writes the record to the file' do
-        expect(rows.size).to eq(2)
-        actual_command, actual_start_time, actual_end_time = rows.last
-        actual_start_time = Time.parse(actual_start_time)
-        actual_end_time = Time.parse(actual_end_time)
-        expect(actual_command).to eq(command)
-        expect(actual_start_time).to eq(start_time)
-        expect(actual_end_time).to eq(end_time)
-      end
-    end
-
-    context 'when the file already exists' do
-      before do
-        repository.store command, start_time, end_time
-        repository.store command, start_time, end_time
-      end
-
-      it 'appends the record to the file' do
-        expect(rows.size).to eq(3)
-      end
-    end
-  end
-end