ataru 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4767c7dd8ce82e36fab9f319d916c557766bb8c5
-  data.tar.gz: 884519a1d41e2430e2b2aa31a4e5a20292b66ddb
+  metadata.gz: fcbdef8608fe4c9f4b1980f83af3aef1fd23bcd6
+  data.tar.gz: 1a6d8144749525a5a9b7b5b6eaa2b8415c7d7aca
 SHA512:
-  metadata.gz: 86e70958e3ee6b22d4a32d7d08e424d28b01ef5a48889fb85a45389d2c3090f84b9f05c59bdcd64c58b2f249e4e0e3948f628a71af36a13aba2d44f76733033a
-  data.tar.gz: 41ab05b0f605926bb066a618791e2bcecee8366bc39f8aa4af52e7ef82df97c3a60be165f78c3a96e04534039a9d1f873d5d10f19a12a1b87f8bea06db27aa2e
+  metadata.gz: 21e1251423908020c79a09eec665fb495c7f5549f315bcd0ad4978475fd135c586b80ebaa71a1d66533de918cd991ce22c2b4b92c531ec547d826a30719ceef9
+  data.tar.gz: 922a4de8be0b190c4095dd3ad1eeec4407f4d6bd33a73b90af6f8f8795cfd9be066b646a06f7a332fd710412fb47ded005393a27660aa0d492457d37f2dbb2af

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+playground/
+lib/ataru/class.rb
+

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.2"
+  - "2.1.3"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/README.md

@@ -1,24 +1,113 @@
+| Project         | Ataru
+|:----------------|:--------------------------------------------------
+| CI              | [![Build Status](https://travis-ci.org/CodePadawans/ataru.svg?branch=master)](https://travis-ci.org/CodePadawans/ataru)
+| Gem Version     | [![Gem Version](https://badge.fury.io/rb/ataru.svg)](http://badge.fury.io/rb/ataru)
+
 # Ataru
 
-TODO: Write a gem description
+Ataru is a gem that provides a command line tool for testing code samples in the documentation files.
+You can also integrate ataru in your continuous integration process on Travis CI.
+
+Ataru will check if your documentation is still in sync with the application it was written for.
+The output of the results has the MiniTest style.
+
+## What can ataru check
+
+- Ataru can read files written in Github Flavoured Markdown, as it uses Kramdown with Github Flavoured Markdown Parser.
+
+- Ataru is currently able to test the Ruby code only.
+
+## Requirements
+
+- The dependencies of your gem have to be in the range of the latest major versions of:
+
+    - minitest (~> 5)
+    - kramdown (~> 1)
+    - thor (~> 0)
+
+- You need to create the setup file (for more info read Setup section).
+
+## Usage as command line tool
+
+1. Add ataru to your project Gemfile.
+
+2. From the top level of your project execute:
+
+  ```sh
+  $ bundle install
+  ```
+
+3. To create the setup file (for more info read Setup section) execute:
+  ```sh
+  $ bundle exec ataru setup
+  ```
+
+4. Finally, execute:
+    - in case you want to check all the markdown files from your project:
+    
+    ```sh
+    $ bundle exec ataru check
+    ```
+    - in case you want to check only specific markdown files from your project:
+
+    ```sh
+    $ bundle exec ataru check PROJECT_ROOT/foo/bar/filename_1.md PROJECT_ROOT/foo/bar/filename_2.md
+    ```
+5. Check the results.
+
+## Workflow with Travis CI
+
+1. Add ataru to your project Gemfile.
+
+2. From the top level of your project execute:
+
+  ```sh
+  $ bundle install
+  ```
+
+3. To create the setup file (for more info read Setup section) execute:
+
+  ```sh
+  $ bundle exec ataru setup
+  ```
 
-## Installation
+4. In your .travis.yml file add:
+    - in case you want to check all the markdown files from your project:
+    
+    ```
+      script:
+      - bundle exec rake build
+      - bundle exec rake ataru check
+    ```
+    - in case you want to check only specific markdown files from your project:
+    ```
+    script:
+    - bundle exec rake build
+    - bundle exec ataru check PROJECT_ROOT/foo/bar/filename_1.md PROJECT_ROOT/foo/bar/filename_2.md
+    ```
+5. Now you can commit and push the changes to github.
+6. Check the results of your build. 
 
-Add this line to your application's Gemfile:
 
-    gem 'ataru'
+## Setup
 
-And then execute:
+The setup file has to be created in order to enable ataru to read your project source code and use it for its checks.
+Ataru comes with an easy to use generator for creating that file. When the generator process is finished, the created
+setup file is automatically passed to ataru.
 
-    $ bundle
+To create the setup file execute:
 
-Or install it yourself as:
+  ```sh
+  $ bundle exec ataru setup
+  ```
 
-    $ gem install ataru
+Open created file in your text editor and write:
 
-## Usage
+  ```
+  require "your_project_name"
+  ```
 
-TODO: Write usage instructions here
+Save the file.
 
 ## Contributing
 
@@ -26,4 +115,4 @@ TODO: Write usage instructions here
 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 new Pull Request
+5. Create new Pull Request`

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+    t.pattern = "test/*.rb"
+end

data/ataru.gemspec

@@ -5,12 +5,12 @@ require 'ataru/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ataru"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Code_Padawans"]
   spec.email         = ["hello@code-padawans.de"]
   spec.summary       = %q{A documentation testing tool}
-  spec.description   = %q{A documentation testing tool}
-  spec.homepage      = ""
+  spec.description   = %q{A documentation testing tool, for documentation in Markdown files, for Ruby code}
+  spec.homepage      = "https://github.com/CodePadawans/ataru"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,5 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.3"
+
+  spec.add_runtime_dependency "minitest", "~> 5"
+  spec.add_runtime_dependency "kramdown", "~> 1"
+  spec.add_runtime_dependency "thor", "~> 0"
 end

data/bin/ataru

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'ataru'
+
+Ataru::CLI::Application.start(ARGV)

data/lib/ataru.rb

@@ -1,5 +1,9 @@
-require "ataru/version"
-
-module Ataru
-  # Your code goes here...
-end
+require 'ataru/version'
+require 'ataru/markdown_loader'
+require 'ataru/traverser'
+require 'ataru/code_sample'
+require 'ataru/argument_checker'
+require 'ataru/test_converter'
+require 'ataru/test_class_builder'
+require 'ataru/application'
+require 'ataru/cli/application'

data/lib/ataru/application.rb

@@ -0,0 +1,14 @@
+module Ataru
+  class Application
+    def self.run_test_for_file(file_name)
+
+      #creating kramdown doc out of md file
+      kramdown_doc = MarkdownLoader.load_file(file_name)
+      #pulling an array of codespans/code samples from markdown document
+      code_samples = Traverser.new(kramdown_doc, file_name).code_samples
+      #wrapping code samples in minitest tests
+      TestClassBuilder.new(code_samples).build_test_class
+      require 'minitest/autorun'
+    end
+  end
+end

data/lib/ataru/argument_checker.rb

@@ -0,0 +1,39 @@
+module Ataru
+  class ArgumentChecker
+
+    def initialize(file_names)
+      exit_if_empty(file_names)
+      @file_names = file_names
+    end
+
+    def exit_if_empty(file_names)
+      if file_names.empty?
+        puts "ataru: command line usage error"
+        puts "ataru: please give the file name"
+        puts "usage: ataru.rb <filename>"
+        exit 64
+      end
+    end
+
+    def verify(file_name)
+      if file_name !~ /.+\.md/
+        puts "ataru: data format error"
+        puts "ataru: #{file_name} is not a markdown file"
+        puts "ataru: markdown file required"
+        exit 65
+      elsif File.file?(file_name) == false
+        puts "ataru: cannot open input"
+        puts "ataru: #{file_name} file not found"
+        exit 66
+      else
+        file_name
+      end
+    end
+
+    def each
+      @file_names.each do |file_name|
+        yield verify(file_name)
+      end
+    end
+  end
+end

data/lib/ataru/cli/application.rb

@@ -0,0 +1,39 @@
+require 'thor'
+require 'ataru'
+
+module Ataru
+  module CLI
+    class Application < Thor
+      include Thor::Actions
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      desc "setup", "Create the setup file containing all dependencies for running code snippets"
+      def setup
+        create_file(Dir.pwd + "/ataru_setup.rb") do
+          <<-eos
+# "Please require your project source code, with the correct path"
+
+# require "path_to_your_project_source_code"
+          eos
+        end
+        puts "Well done, young Padawan!\nNow, change the created ataru_setup.rb file."
+      end
+
+      desc "check", "Check code snippets in all .md files of the project or, if given, specific .md files"
+      def check(*filenames)
+        if filenames.length == 0
+          filenames = Dir.glob('**/*md')
+        end
+        path = Dir.pwd + '/ataru_setup.rb'
+        require path if File.exist?(path)
+        Ataru::ArgumentChecker.new(filenames).each do |checked_file|
+          Ataru::Application.run_test_for_file(checked_file)
+        end
+      end
+    end
+  end
+end
+

data/lib/ataru/code_sample.rb

@@ -0,0 +1,26 @@
+module Ataru
+  class CodeSample
+    attr_accessor :code, :file, :line_number, :prepared_code
+
+    def initialize(code, file, line_number)
+      self.code = code
+      self.file = file
+      self.line_number = line_number
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        self.file == other.file &&
+        self.code == other.code &&
+        self.line_number == other.line_number
+    end
+
+    def prepared_code
+      @prepared_code ||= TestConverter.convert(self.code)
+    end
+
+    def run(b)
+      eval(self.prepared_code, b, self.file, self.line_number)
+    end
+  end
+end

data/lib/ataru/errors.rb

@@ -0,0 +1,4 @@
+module Ataru
+  class AtaruError < StandardError
+  end
+end

data/lib/ataru/markdown_loader.rb

@@ -0,0 +1,10 @@
+require 'kramdown'
+
+module Ataru
+  class MarkdownLoader
+    def self.load_file(file_name)
+      text = File.read(file_name)
+      Kramdown::Document.new(text, :input => 'GFM')
+    end
+  end
+end

data/lib/ataru/test_class_builder.rb

@@ -0,0 +1,35 @@
+require 'minitest'
+require 'pathname'
+require_relative 'errors'
+require_relative 'code_sample'
+
+module Ataru
+  class TestClassBuilder
+    attr_accessor :code_samples
+
+    def initialize(code_samples)
+      self.code_samples = code_samples
+    end
+
+    def build_test_class
+      samples = code_samples
+      klass = Class.new(MiniTest::Test) do
+        samples.each_with_index do |sample, index|
+          basename = Pathname.new(sample.file).basename(".*").to_s
+          define_method("test_#{basename}_#{index}") do
+
+            b = binding
+
+            begin
+              sample.run(b)
+            rescue StandardError => e
+              raise AtaruError.new("In the file: #{sample.file}, in line: #{sample.line_number}, the code sample number: #{index} is raising an error:" + e.inspect)
+            end
+          end
+        end
+      end
+
+      klass
+    end
+  end
+end

data/lib/ataru/test_converter.rb

@@ -0,0 +1,8 @@
+module Ataru
+  class TestConverter
+
+    def self.convert(code)
+      code.gsub(/(^.+) # ?=> (.+$)/, 'assert_equal(\2, \1)')
+    end
+  end
+end

data/lib/ataru/traverser.rb

@@ -0,0 +1,36 @@
+require_relative 'markdown_loader'
+require_relative 'code_sample'
+
+module Ataru
+  class Traverser
+    CODE_ELEMENTS = [:codeblock, :codespan]
+
+    attr_accessor :document, :language, :file_name
+
+    def initialize(document, file_name, language = "language-ruby")
+      self.document = document
+      self.language = language
+      self.file_name = file_name
+    end
+
+    def code_samples
+      tree = document.root
+      self.walk_tree(tree)
+    end
+
+    def walk_tree(element)
+      code_samples = []
+      element.children.each do |child|
+        if CODE_ELEMENTS.include?(child.type)
+          if child.attr["class"] == language
+            line_number = child.options[:location] + 1
+            code_samples << CodeSample.new(child.value.strip, file_name, line_number)
+          end
+        else
+          code_samples += walk_tree(child)
+        end
+      end
+      code_samples
+    end
+  end
+end

data/lib/ataru/version.rb

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

data/test/code_sample_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require_relative '../lib/ataru/code_sample'
+
+class CodeSampleTest < MiniTest::Test
+  include Ataru
+
+  class TestException < Exception
+  end
+
+  def test_run_with_file_name_and_line_number
+    code = CodeSample.new("1\n raise TestException.new('bad stuff')", "test.md", 1)
+    b = binding
+    begin
+      code.run(b)
+    rescue TestException => e
+      e.backtrace.first
+      file_name = e.backtrace.first.split(":").first
+      line_number = e.backtrace.first.split(":")[1].to_i
+    end
+
+    assert_equal "test.md", file_name
+    assert_equal 2, line_number
+  end
+end

data/test/resources/test.md

@@ -0,0 +1,9 @@
+# Getting started
+
+To get started, use the following code:
+
+```
+def add(a,b)
+a + b
+end
+```

data/test/resources/test.rb

@@ -0,0 +1,3 @@
+def test
+  def
+  end

data/test/resources/test1.md

@@ -0,0 +1,9 @@
+# Getting started
+
+To get started, use the following code:
+
+```
+def add(a,b)
+a + b
+end
+```

data/test/resources/test2.md

@@ -0,0 +1,9 @@
+# Getting started
+
+To get started, use the following code:
+
+```
+def add(a,b)
+a + b
+end
+```

data/test/resources/test_ataru_error.md

@@ -0,0 +1,5 @@
+that should raise ataru error
+
+```ruby
+b = a + 1
+```

data/test/resources/test_empty_string.md

@@ -0,0 +1,3 @@
+this code sample is empty
+```
+```

data/test/resources/test_expectation_incorrect.md

@@ -0,0 +1,8 @@
+# Expect an output
+foo
+bar
+bar
+```
+a = 1 + 2
+a #=> 4
+```

data/test/resources/test_expectation_running.md

@@ -0,0 +1,4 @@
+```
+a = 1 + 2
+a #=> 3
+```

data/test/resources/test_expectation_warning.md

@@ -0,0 +1,4 @@
+```
+a = 1 + 2
+#=> 3
+```

data/test/resources/test_linebreak.md

@@ -0,0 +1,6 @@
+```
+a = 2 + 3
+b = a + 1
+
+a #=> 5
+```

data/test/resources/test_markdown.md

@@ -0,0 +1,28 @@
+this is written without anythng
+
+```ruby
+def a
+2 + 2
+end
+```
+
+### header
+
+```
+bundle exec
+```
+
+```ruby
+def add2(number)
+number + 2
+end
+
+a = 10
+b = add2(a)
+assert_equal 11, b
+b #=> 11
+```
+
+```ruby
+a + 1
+```

data/test/test_class_builder_test.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require 'kramdown'
+require_relative '../lib/ataru/test_class_builder'
+require_relative '../lib/ataru/errors'
+require_relative '../lib/ataru/code_sample'
+
+class TestClassBuilderTest < MiniTest::Test
+  include Ataru
+  @name_of_the_runnable =  "the_name_of_the_runnable" 
+
+  def test_empty_list
+    code_samples = []
+    klass = TestClassBuilder.new(code_samples).build_test_class
+
+    refute_respond_to klass.new(@name_of_the_runnable), :test_my_test_0
+  end
+
+  def test_one_code_example
+    code_samples = [CodeSample.new("puts 'Hello world'", "my_test.md", 5)]
+    klass = TestClassBuilder.new(code_samples).build_test_class
+
+    assert_respond_to klass.new(@name_of_the_runnable), :test_my_test_0
+  end
+
+  def test_two_code_examples
+    code_samples = [CodeSample.new("puts 'blah'", "my_test.md", 5), CodeSample.new("puts 2 + 5", "my_test.md", 5)]
+    klass = TestClassBuilder.new(code_samples).build_test_class
+
+    assert_respond_to klass.new(@name_of_the_runnable), :test_my_test_0
+    assert_respond_to klass.new(@name_of_the_runnable), :test_my_test_1
+  end
+
+  def test_invalid_code_sample
+    code_samples = [CodeSample.new("a + 1", "my_test.md", 5)]
+    message = AtaruError.new("In the file: #{code_samples[0].file}, in line: #{code_samples[0].line_number}, is raising an error:")
+    klass = TestClassBuilder.new(code_samples).build_test_class
+
+    assert_raises(AtaruError) { klass.new(@name_of_the_runnable).send(:test_my_test_0) }
+    assert_equal "In the file: my_test.md, in line: 5, is raising an error:", message.to_s
+  end
+
+end

data/test/test_converter_test.rb

@@ -0,0 +1,48 @@
+require 'minitest/autorun'
+require_relative '../lib/ataru/test_converter'
+
+class TestConverterTest < MiniTest::Test
+  include Ataru
+
+  def test_no_hash
+    code_sample = CodeSample.new("puts 'blah'", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "puts 'blah'", converted
+  end
+
+  def test_hash_without_context_hash_without_space
+    code_sample = CodeSample.new("a #=> 5", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "assert_equal(5, a)", converted
+  end
+
+  def test_hash_without_context_hash_with_space
+    code_sample = CodeSample.new("a # => 5", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "assert_equal(5, a)", converted
+  end
+
+  def test_hash_with_context_hash_without_space
+    code_sample = CodeSample.new("a = 1 + 2\na #=> 3", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "a = 1 + 2\nassert_equal(3, a)", converted
+  end
+
+  def test_hash_with_context_hash_with_space
+    code_sample = CodeSample.new("a = 1 + 2\na # => 3", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "a = 1 + 2\nassert_equal(3, a)", converted
+  end
+
+  def test_assertion_in_the_middle
+    code_sample = CodeSample.new("a = 1 + 2\na # => 3\nb = 2", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "a = 1 + 2\nassert_equal(3, a)\nb = 2", converted
+  end
+
+  def test_assertion_at_the_end
+    code_sample = CodeSample.new("a = 1 + 2\nb = 2\na # => 3", "test.md", 2)
+    converted = TestConverter.convert(code_sample.code)
+    assert_equal "a = 1 + 2\nb = 2\nassert_equal(3, a)", converted
+  end
+end

data/test/traverser_test.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+require 'kramdown'
+require_relative "../lib/ataru/traverser"
+
+class TraverserTest < Minitest::Test
+
+  include Ataru
+
+  def test_single_codespan
+    doc = Kramdown::Document.new("```ruby\nputs 'Hello'\n```", :input => 'GFM')
+    assert_equal CodeSample.new("puts 'Hello'", "test.md", 2), Traverser.new(doc, "test.md").code_samples.first
+  end
+
+  def test_multiple_codespans
+    doc = Kramdown::Document.new("```ruby\nputs 'Hello'\n```\n```ruby\nputs 'Goodbye!'\n```", :input => 'GFM')
+    assert_equal [CodeSample.new("puts 'Hello'", "test.md", 2), CodeSample.new("puts 'Goodbye!'", "test.md", 5)], Traverser.new(doc, "test.md").code_samples
+
+  end
+
+  def test_no_codespans
+    doc = Kramdown::Document.new("#Header", :input => 'GFM')
+    assert_equal [], Traverser.new(doc, "test.md").code_samples
+  end
+
+  def test_codespan_in_complicated_structure
+    doc = Kramdown::Document.new <<-MARKDOWN, :input => 'GFM'
+#Header
+
+* list 1
+* list 2
+
+```ruby
+puts 'Hello'
+```
+MARKDOWN
+    assert_equal [CodeSample.new("puts 'Hello'", "test.md", 7)], Traverser.new(doc, "test.md").code_samples
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ataru
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Code_Padawans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,32 +28,103 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
-description: A documentation testing tool
+description: A documentation testing tool, for documentation in Markdown files, for
+  Ruby code
 email:
 - hello@code-padawans.de
-executables: []
+executables:
+- ataru
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ataru.gemspec
+- bin/ataru
 - lib/ataru.rb
+- lib/ataru/application.rb
+- lib/ataru/argument_checker.rb
+- lib/ataru/cli/application.rb
+- lib/ataru/code_sample.rb
+- lib/ataru/errors.rb
+- lib/ataru/markdown_loader.rb
+- lib/ataru/test_class_builder.rb
+- lib/ataru/test_converter.rb
+- lib/ataru/traverser.rb
 - lib/ataru/version.rb
-homepage: ''
+- playground/arrays.rb
+- test/code_sample_test.rb
+- test/resources/test.md
+- test/resources/test.rb
+- test/resources/test1.md
+- test/resources/test2.md
+- test/resources/test_ataru_error.md
+- test/resources/test_empty_string.md
+- test/resources/test_expectation_incorrect.md
+- test/resources/test_expectation_running.md
+- test/resources/test_expectation_warning.md
+- test/resources/test_linebreak.md
+- test/resources/test_markdown.md
+- test/test_class_builder_test.rb
+- test/test_converter_test.rb
+- test/traverser_test.rb
+homepage: https://github.com/CodePadawans/ataru
 licenses:
 - MIT
 metadata: {}
@@ -77,4 +148,19 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A documentation testing tool
-test_files: []
+test_files:
+- test/code_sample_test.rb
+- test/resources/test.md
+- test/resources/test.rb
+- test/resources/test1.md
+- test/resources/test2.md
+- test/resources/test_ataru_error.md
+- test/resources/test_empty_string.md
+- test/resources/test_expectation_incorrect.md
+- test/resources/test_expectation_running.md
+- test/resources/test_expectation_warning.md
+- test/resources/test_linebreak.md
+- test/resources/test_markdown.md
+- test/test_class_builder_test.rb
+- test/test_converter_test.rb
+- test/traverser_test.rb