ataru 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcbdef8608fe4c9f4b1980f83af3aef1fd23bcd6
-  data.tar.gz: 1a6d8144749525a5a9b7b5b6eaa2b8415c7d7aca
+  metadata.gz: 275aed877820525a59f2c7ad8843ca1cf75deec6
+  data.tar.gz: b26d4c1513cc9448578df33c5ba326865c22f58a
 SHA512:
-  metadata.gz: 21e1251423908020c79a09eec665fb495c7f5549f315bcd0ad4978475fd135c586b80ebaa71a1d66533de918cd991ce22c2b4b92c531ec547d826a30719ceef9
-  data.tar.gz: 922a4de8be0b190c4095dd3ad1eeec4407f4d6bd33a73b90af6f8f8795cfd9be066b646a06f7a332fd710412fb47ded005393a27660aa0d492457d37f2dbb2af
+  metadata.gz: e8112d22c879ec32f86ed22370097e5c4988a60ef7b98cbf9c439d4967bc7d1d83e465ba658154a5b9d44a1c7e4c47cec7588f34dee6de70f6036f6e138508f2
+  data.tar.gz: d3b74b70233e7c708a35421998b829e9553772e5df083d4c162cffbb91437a8e2f47975ca3226357302c3682b90e1c87f7d72c9bfe16b0a1822eb2913d3f7315

data/README.md

@@ -16,16 +16,17 @@ The output of the results has the MiniTest style.
 - 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.
+It checks the Ruby syntax and implements assertions (`assert_equal`) in place of `#=>` and `# =>`.
 
 ## Requirements
 
 - The dependencies of your gem have to be in the range of the latest major versions of:
 
-    - minitest (~> 5)
-    - kramdown (~> 1)
-    - thor (~> 0)
+    - minitest (~> 5.0)
+    - kramdown (~> 1.3)
+    - thor (~> 0.19.0)
 
-- You need to create the setup file (for more info read Setup section).
+- In most cases, you need to create the setup file (for more info read Setup section).
 
 ## Usage as command line tool
 
@@ -55,6 +56,61 @@ The output of the results has the MiniTest style.
     ```
 5. Check the results.
 
+## Example
+
+If this is a file called `example.md`:
+
+    ```ruby
+    def bad
+      false
+    end
+
+    def good
+      true
+    end
+
+    bad #=> true
+    good #=> true
+    ```
+    
+
+which renders as:
+
+```ruby
+def bad
+  false
+end
+
+def good
+  true
+end
+
+bad #=> true
+good #=> true
+```
+    
+Check it with ataru:
+
+```sh 
+ $ ataru check example.md
+Run options: --seed 33946
+
+# Running:
+
+F
+
+Finished in 0.001232s, 811.9236 runs/s, 811.9236 assertions/s.
+
+  1) Failure:
+#<Class:0x000000033451b8>#test_example_0 [example.md:10]:
+Expected: true
+  Actual: false
+
+1 runs, 1 assertions, 1 failures, 0 errors, 0 skips
+```
+
+
+
 ## Workflow with Travis CI
 
 1. Add ataru to your project Gemfile.
@@ -71,7 +127,7 @@ The output of the results has the MiniTest style.
   $ bundle exec ataru setup
   ```
 
-4. In your .travis.yml file add:
+4. In your `.travis.yml` file add:
     - in case you want to check all the markdown files from your project:
     
     ```
@@ -92,8 +148,43 @@ The output of the results has the MiniTest style.
 ## Setup
 
 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.
+What is more, in that file you can write some setup code, that will be run before (and after, shall you want that) each snippet.
+If you'd like to use instance variables, define them in `setup` method.
+If you'd like to clean up after running tests, write your clean up code in `teardown` method.
+If you like local variables, you can use methods (see example below).
+
+#### Example
+
+This is `ataru_setup.rb` file for an imaginary gem `my_fancy_lib`, where instance and local variables `@number` and `number` are defined:
+
+```ruby
+require 'my_fancy_lib'
+
+module Setup
+def setup
+  @number = 21
+end
+
+def teardown
+end    
+
+def number
+  12
+end
+```
+    
+which allows us to use them in the code snippets in `README.md` file:
+
+    ```ruby
+    assert_equal @number + 1, 22
+    ```
+    
+    ```ruby
+    assert_equal number + 1, 13
+    ```
+    
+Ataru comes with an easy to use generator for creating the setup file. When the generator process is finished, created
+file is automatically passed to ataru.
 
 To create the setup file execute:
 
@@ -101,13 +192,8 @@ To create the setup file execute:
   $ bundle exec ataru setup
   ```
 
-Open created file in your text editor and write:
-
-  ```
-  require "your_project_name"
-  ```
-
-Save the file.
+Open created file in your text editor, do your requires and, optionally, write some setup code.
+Save the file. 
 
 ## Contributing
 

data/ataru.gemspec

@@ -5,7 +5,7 @@ require 'ataru/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ataru"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Code_Padawans"]
   spec.email         = ["hello@code-padawans.de"]
   spec.summary       = %q{A documentation testing tool}
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   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"
+  spec.add_runtime_dependency "minitest", "~> 5.0"
+  spec.add_runtime_dependency "kramdown", "~> 1.3"
+  spec.add_runtime_dependency "thor", "~> 0.19.0"
 end

data/example.md

@@ -0,0 +1,12 @@
+```ruby
+def bad
+  false
+end
+
+def good
+  true
+end
+
+bad #=> true
+good #=> true
+```

data/lib/ataru/cli/application.rb

@@ -12,20 +12,36 @@ module Ataru
 
       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"
+        create_file(File.join(Dir.pwd, "ataru_setup.rb"), <<-EOS)
+# "Require your project source code, with the correct path"
 
-# require "path_to_your_project_source_code"
-          eos
-        end
+# require 'my_fancy_lib'
+
+module Setup
+def setup
+# Do some nice setup that is run before every snippet
+# If you'd like to use instance variables define them here, e.g
+#  @important_variable_i_will_use_in_my_code_snippets = true
+end
+
+def teardown
+# Do some cleanup that is run after every snippet
+end
+
+# If you like local variables you can define methods, e.g
+# def number_of_wishes
+#  101
+# end
+
+end
+EOS
         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')
+          filenames = Dir.glob('**/*md') - Dir.glob("vendor/**/*.md")
         end
         path = Dir.pwd + '/ataru_setup.rb'
         require path if File.exist?(path)

data/lib/ataru/test_class_builder.rb

@@ -1,6 +1,5 @@
 require 'minitest'
 require 'pathname'
-require_relative 'errors'
 require_relative 'code_sample'
 
 module Ataru
@@ -14,17 +13,12 @@ module Ataru
     def build_test_class
       samples = code_samples
       klass = Class.new(MiniTest::Test) do
+        path = Dir.pwd + '/ataru_setup.rb'
+        include Setup if File.exist?(path)
         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
+            sample.run(binding)
           end
         end
       end

data/test/resources/test_markdown.md

@@ -19,7 +19,7 @@ end
 
 a = 10
 b = add2(a)
-assert_equal 11, b
+asert_equal 11, b
 b #=> 11
 ```
 

data/test/test_class_builder_test.rb

@@ -1,7 +1,6 @@
 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
@@ -32,11 +31,13 @@ class TestClassBuilderTest < MiniTest::Test
 
   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
+    #rubinius bug https://github.com/rubinius/rubinius/issues/3101
+    exception_class = if RUBY_ENGINE == 'rbx'
+      NoMethodError
+    else
+      NameError
+    end
+    assert_raises(exception_class) { klass.new(@name_of_the_runnable).send(:test_my_test_0) }
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ataru
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Code_Padawans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
 description: A documentation testing tool, for documentation in Markdown files, for
   Ruby code
 email:
@@ -97,12 +97,12 @@ files:
 - Rakefile
 - ataru.gemspec
 - bin/ataru
+- example.md
 - 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

data/lib/ataru/errors.rb

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