todo_next 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,2 +1,22 @@
-v0.0.1
+v0.0.2:
+	- cleanup leading characters ('-', '+') before converting to rspec
+	- you can include an example in a spec. It won't be converted
+		 <text>
+		  √ is white by default
+  	    ex: puts Foobar.new.colour  # => 'white'
+  	    ex :
+  	      this is a comment too
+  	  * can be resized
+  	    example:
+  	      foobar.resize!(+10, -2)
+     </text>
+
+	 will generate the same rspec code as :
+
+		 <text>
+		  √ is white by default
+  	  * can be resized
+     </text>
+
+v0.0.1:
 	- $ todo_next creates a sample rspec test with an todo_next usage example

data/README.md

@@ -29,14 +29,22 @@ $ cat spec/stack_spec.rb
     require 'todo_next'
 
     todo_next(<<TEXT)
-    A Foobar
-      - is white by default
-      - can be resized
-      truthiness()
-        - is always true
-      (add more tests)
+		A Foobar
+		  √ is white by default
+		    ex: puts Foobar.new.colour  # => 'white'
+		  * can be resized
+		    example:
+		      foobar.resize!(+10, -2)
+		  - can be reset
+		  truthiness()
+		    is always true
+		    is never false
+		  (add more tests)
     TEXT
 
+		# √ == passed   => same as a comment line
+		# * == current  => leading char - '*' - is kept
+    # example blocks (ex:, example:) are ignored, like comments.
 
     #describe "<what you're testing>" do
     #  specify 'this should happen' do
@@ -46,13 +54,15 @@ $ cat spec/stack_spec.rb
 This text is equivalent to :
 
 ```ruby
-    describe "A Foobar" do
-      it "- is white by default"
-      describe "- can be resized" do
-        it "- is always true"
-      end
-      it "(add more tests)"
-    end
+		describe "A Foobar" do
+		  it '* can be resized'
+		  it 'can be reset'
+		  describe 'truthiness()' do
+		    it 'is always true'
+		    it 'is never false'
+		  end
+		  it '(add more tests)'
+		end
 ```
 
 ![screenshot1](https://github.com/alainravet/todo_next/raw/master/doc/screenshot_1.png)
@@ -65,3 +75,5 @@ This text is equivalent to :
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/alainravet/todo_next)

data/lib/todo_next.rb

@@ -6,7 +6,7 @@ end
 require File.dirname(__FILE__) + '/todo_next/parser'
 
 main = TOPLEVEL_BINDING.eval('self')
-def main.todo_next(text, puts_code=false)
+def main.todo_next(text, puts_code=true)
   code = TodoNext(text)
   if puts_code
     puts '---' ; puts code  ; puts '---'
@@ -15,9 +15,6 @@ def main.todo_next(text, puts_code=false)
 end
 
 def TodoNext(source)
-  TodoNext::Parser.
-      parse(source).
-      visit(TodoNext::RspecGeneratorVisitor.new).
-      flatten.
-      join("\n")
+  tree = TodoNext::Parser.parse(source)
+  tree.to_rspec
 end

data/lib/todo_next/cli.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/cli/sample_file_generator'
 
 module TodoNext
-
   class CLI
+
     def self.run(argv)
       SampleFileGenerator.generate(object_name = argv.shift)
     end
-  end
 
-end
+  end
+end

data/lib/todo_next/cli/assets/rspec_example_file.rb.erb

@@ -4,13 +4,22 @@ require 'todo_next'
 
 todo_next(<<TEXT)
 A <%= classname %>
-  - is white by default
-  - can be resized
-  truthiness()
-    - is always true
-  (add more tests)
+	  √ is white by default
+	    ex: puts Foobar.new.colour  # => 'white'
+	  * can be resized
+	    example:
+	      foobar.resize!(+10, -2)
+	  - can be reset
+	  truthiness()
+	    is always true
+	    is never false
+	  (add more tests)
+  TEXT
 TEXT
 
+# √ == passed   => same as a comment line
+# * == current  => leading char - '*' - is kept
+# example blocks (ex:, example:) are ignored, like comments.
 
 #describe "<what you're testing>" do
 #  specify 'this should happen' do

data/lib/todo_next/line.rb

@@ -1,6 +1,6 @@
 module TodoNext
-
   class Line
+
     attr_accessor :text, :col_offset, :leaf
 
     def initialize(text, col_offset)
@@ -17,9 +17,15 @@ module TodoNext
     def comment?
       text =~ /^#/
     end
+    def passed?
+      text =~ /^\s*√/
+    end
+    def example?
+      text =~ /\s*(ex|example)\s*:/
+    end
 
     def leaf?   ; leaf   end
     def branch? ; !leaf? end
-  end
 
+  end
 end

data/lib/todo_next/parser.rb

@@ -1,14 +1,18 @@
 require File.dirname(__FILE__) + '/tree'
 require File.dirname(__FILE__) + '/line'
-require File.dirname(__FILE__) + '/rspec_generator_visitor'
 require File.dirname(__FILE__) + '/cli'
 
 module TodoNext
-
   class Parser
-    def self.parse(text)
+
+    def self.parse(text, prune_example_nodes=true)
       lines = extract_meaningful_lines(text)
       tree  = Tree::Factory.build(lines)
+      if prune_example_nodes
+        tree.visit(TodoNext::Tree::Visitor::ExampleNodesRemover.new)
+        tree.visit(TodoNext::Tree::Visitor::LeafMaker          .new)
+      end
+      tree
     end
 
     def self.extract_meaningful_lines(text)
@@ -19,8 +23,9 @@ module TodoNext
          Line.new(text.strip, col_offset)
        end.
            reject{|l| l.blank?  }.
-           reject{|l| l.comment?}
+           reject{|l| l.comment?}.
+           reject{|l| l.passed?}
     end
-  end
 
+  end
 end

data/lib/todo_next/tree.rb

@@ -1,8 +1,11 @@
 require File.dirname(__FILE__) + '/tree/factory'
+require File.dirname(__FILE__) + '/tree/visitor/example_remover_visitor'
+require File.dirname(__FILE__) + '/tree/visitor/rspec_generator'
+require File.dirname(__FILE__) + '/tree/visitor/leaf_maker'
 
 module TodoNext
-
   class Tree
+
     attr_accessor :children
 
     def initialize
@@ -10,10 +13,16 @@ module TodoNext
     end
 
     def visit(visitor)
-      children.collect do |node|
-        visitor.visit(node, level=1)
+      result = []
+      children.each do |node|
+        result << visitor.visit(node, level=1, parent=self)
       end
+      result
     end
-  end
 
+    def to_rspec
+      visit(TodoNext::Tree::Visitor::RspecGenerator.new).flatten.join("\n")
+    end
+
+  end
 end

data/lib/todo_next/tree/factory.rb

@@ -1,8 +1,8 @@
 require File.dirname(__FILE__) + '/node'
+require File.dirname(__FILE__) + '/nodes'
 require File.dirname(__FILE__) + '/parents_list'
 
 module TodoNext
-
   class Tree
     class Factory
 
@@ -16,13 +16,15 @@ module TodoNext
           curr_line_col = line.col_offset
           parent        = parents.get_for_item_at_column(curr_line_col) || tree
 
+          new_node = if     line.example? then Tree::EX.new(line.text, parent)
+                     elsif  line.branch?  then Tree::OL.new(line.text, parent)
+                     else                      Tree::LI.new(line.text, parent)
+                     end
+          parent.children << new_node
+
           if line.branch?
-            new_node = Tree::OL.new(line.text, parent)
             parents.register_parent(new_node, :for_col => curr_line_col)
-          else
-            new_node = Tree::LI.new(line.text, parent)
           end
-          parent.children << new_node
         end
         tree
       end
@@ -39,5 +41,4 @@ module TodoNext
 
     end
   end
-
 end

data/lib/todo_next/tree/node.rb

@@ -1,25 +1,32 @@
 module TodoNext
-
   class Tree
     class Node
+
       attr_accessor :text, :parent, :children
       def initialize(text, parent=nil)
         @text, @parent = text, parent
         @children = []
       end
 
-      def terminal?
-        false
+      def terminal? ; false end
+      def example?  ; false end
+
+      def has_children?
+        !children.empty?
       end
-    end
 
-    class OL < Node ; end
+      def remove_from_parent_children
+        parent.children.delete_if do |child|
+          child==self
+        end
+      end
 
-    class LI < Node
-      def terminal?
-        true
+      def make_me_a_leaf
+        me_as_leaf = Tree::LI.new(text, parent)
+        idx =  parent.children.find_index(self)
+        parent.children[idx] = me_as_leaf
       end
+
     end
   end
-
-end
+end

data/lib/todo_next/tree/nodes.rb

@@ -0,0 +1,14 @@
+class TodoNext::Tree
+
+  class OL < Node ; end
+
+  class LI < Node
+    def terminal? ; true  end
+  end
+
+  class EX < Node
+    def example? ; true   end
+    def terminal?; children.empty?  end
+  end
+
+end

data/lib/todo_next/tree/parents_list.rb

@@ -1,5 +1,4 @@
 module TodoNext
-
   class Tree
     class ParentsList
 
@@ -14,10 +13,10 @@ module TodoNext
       end
 
       def get_for_item_at_column(curr_col)
-        parent_key = @parents.keys.sort.reverse.detect {|col| col < curr_col}
+        parent_key = @parents.keys.sort.reverse.detect {|col| col <= curr_col}
         @parents[parent_key]
       end
+
     end
   end
-
 end

data/lib/todo_next/tree/visitor/base.rb

@@ -0,0 +1,27 @@
+module TodoNext::Tree::Visitor
+  class Base
+
+    def visit(curr_node, level, parent) #nodoc#
+      if curr_node.terminal?
+        process_terminal_node(curr_node, level, parent)
+      else
+        process_non_terminal_node(curr_node, level, parent)
+      end
+    end
+
+    def visit_children_of(parent, parent_level)
+      parent.children.each do |node|
+        visit(node, 1+parent_level, parent)
+      end
+    end
+
+    # overwrite in the concrete visitor class
+    def process_terminal_node(curr_node, level, parent)
+    end
+
+    # overwrite in the concrete visitor class
+    def process_non_terminal_node(curr_node, level, parent)
+    end
+
+  end
+end

data/lib/todo_next/tree/visitor/example_remover_visitor.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/base'
+
+module TodoNext::Tree::Visitor
+  class ExampleNodesRemover < Base
+
+    def visit(curr_node, level, parent) #nodoc#
+      if curr_node.example?
+        remove_from_tree(curr_node)
+      elsif curr_node.has_children?
+        visit_children_of(curr_node, level)
+      end
+    end
+
+  private
+
+    def remove_from_tree(curr_node)
+      curr_node.remove_from_parent_children
+    end
+
+  end
+end

data/lib/todo_next/tree/visitor/leaf_maker.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/base'
+
+module TodoNext::Tree::Visitor
+  class LeafMaker < Base
+
+    def process_terminal_node(curr_node, level, parent)
+    end
+
+    def process_non_terminal_node(curr_node, level, parent)
+      if curr_node.has_children?
+        visit_children_of(curr_node, level)
+      else
+        curr_node.make_me_a_leaf
+      end
+    end
+
+  end
+end

data/lib/todo_next/tree/visitor/rspec_generator.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/base'
+
+module TodoNext
+  class Tree
+    module Visitor
+      class RspecGenerator < Base
+
+        def process_terminal_node(curr_node, level, parent)
+          tabs  = '  '*(level-1)
+          label = label(curr_node)
+          code = %Q|#{tabs}it("#{label}", :pending => "#{label}"){}|
+        end
+
+        def process_non_terminal_node(curr_node, level, parent)
+          tabs = '  '*(level-1)
+          codes = curr_node.children.collect { |node| visit(node, 1+level, parent=self) }
+          [%Q|#{tabs}describe "#{label(curr_node)}" do|] + codes + ["#{tabs}end"]
+        end
+
+        def label(node)
+          text = node.text
+          text.gsub! /^[-\+]\s*/,''
+          text
+        end
+
+      end
+    end
+  end
+end

data/lib/todo_next/version.rb

@@ -1,3 +1,3 @@
 module TodoNext
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/01_parse_the_text_spec.rb

@@ -27,8 +27,8 @@ describe TodoNext::Parser, 'parsing indented text and producing a Tree' do
 
   it 'converts 2 lines under a header as 2 :li under 1 :ol' do
     @source = 'HEADER 1'            + "\n" +
-              '  spec a'            + "\n" +
-              '  spec b'
+              ' spec a'             + "\n" +
+              ' spec b'
 
     result_should_be [  {:type  => :ol , :text  => "HEADER 1",
                          :children  => [
@@ -39,6 +39,33 @@ describe TodoNext::Parser, 'parsing indented text and producing a Tree' do
                     ]
   end
 
+#--------------
+# ex: / example:
+#--------------
+  it 'converts an example block to a :ex element' do
+    @source = 'HEADER 1'            + "\n" +
+              '  spec a'            + "\n" +
+              '    ex :'            + "\n" +
+              '      blabla'        + "\n" +
+              '  spec b'
+
+    result_should_be [  {:type  => :ol , :text  => 'HEADER 1',
+                         :children  => [
+                             {:type  => :ol, :text  => 'spec a',
+                              :children  => [
+                                  {:type  => :ex, :text  => "ex :",
+                                   :children  => [{:type  => :li, :text  => "blabla"}]
+                                  }]
+                             },
+                             {:type  => :li, :text  => 'spec b'}
+                         ]
+                        }
+                    ]
+  end
+
+#--------------
+# ALL-in-one
+#--------------
   it 'converts a complex text into the proper Tree' do
     @source = 'HEADER 1'            + "\n" +
               '  HEADER 2'          + "\n" +

data/spec/02_visit_the_tree_spec.rb

@@ -3,14 +3,13 @@ require 'spec_helper'
 
 describe TodoNext::Tree, 'visiting the tree depth-first' do
 
-
-  class SimpleVisitor < TodoNext::Tree::DepthFirstVisitorBase
-    def process_terminal_node(curr_node, level)
+  class SimpleVisitor < TodoNext::Tree::Visitor::Base
+    def process_terminal_node(curr_node, level, parent)
       curr_node.text
     end
 
-    def process_non_terminal_node(curr_node, level)
-      result = curr_node.children.collect { |node| visit(node, 1+level) }.join(', ')
+    def process_non_terminal_node(curr_node, level, parent)
+      result = curr_node.children.collect { |node| visit(node, 1+level, self) }.join(', ')
       "#{curr_node.text}=[#{result}]"
     end
   end

data/spec/03_rspec_generator_visitor_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe TodoNext::RspecGeneratorVisitor do
+describe TodoNext::Tree::Visitor::RspecGenerator do
 
   it 'visits the tree depth-first' do
     source = 'HEADER 1'            + "\n" +

data/spec/04_generated_rspec_format_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe TodoNext::Tree::Visitor::RspecGenerator, 'fine-tuning' do
+
+  it 'visits the tree depth-first' do
+    source =  'HEADER 1'                    + "\n" +
+              '  HEADER 2'                  + "\n" +
+              '    - HEADER 3'              + "\n" +
+              '      √ spec a'              + "\n" +
+              '      * spec b'              + "\n" +
+              '      - spec c'
+
+    expected =<<RUBY.chomp
+describe "HEADER 1" do
+  describe "HEADER 2" do
+    describe "HEADER 3" do
+      it("* spec b", :pending => "* spec b"){}
+      it("spec c", :pending => "spec c"){}
+    end
+  end
+end
+RUBY
+
+    TodoNext(source).should == expected
+  end
+
+  it 'ignores the example blocks' do
+    source =  'A Foo'                       + "\n" +
+              '  it can be created'         + "\n" +
+              '    ex: '                    + "\n" +
+              '     Foo.create'             + "\n" +
+              '  it can be deleted'
+
+    expected =<<RUBY.chomp
+describe "A Foo" do
+  it("it can be created", :pending => "it can be created"){}
+  it("it can be deleted", :pending => "it can be deleted"){}
+end
+RUBY
+
+    source =  'A Foo'                       + "\n" +
+              '  it can be created'         + "\n" +
+              '    ex: '
+
+    expected =<<RUBY.chomp
+describe "A Foo" do
+  it("it can be created", :pending => "it can be created"){}
+end
+RUBY
+
+    TodoNext(source).should == expected
+  end
+
+end

data/spec/spec_helper.rb

@@ -25,26 +25,31 @@ class TodoNext::Tree
     }
   end
 
-  class OL
+  class EX
+    def to_hash
+      {   :type => :ex, :text => text,
+          :children => children.collect{|ch| ch.to_hash }
+      }
+    end
+  end
 
+  class OL
     def to_hash
-      {   :type => :ol,
-          :text => text,
+      {   :type => :ol, :text => text,
           :children => children.collect{|ch| ch.to_hash }
       }
     end
   end
+
   class LI
     def to_hash
-      {   :type => :li,
-          :text => text
-      }
+      {   :type => :li, :text => text}
     end
   end
 end
 
 def parsed_result(source)
-  TodoNext::Parser.parse(source).to_hash[:children]
+  TodoNext::Parser.parse(source, prune_example_nodes=false).to_hash[:children]
 end
 
 def result_should_be(expected)

data/spec/tree_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe TodoNext::Tree do
+
+  describe '#prune_example_nodes!' do
+
+    specify 'an top-level example line with a sibling is removed' do
+      source = 'spec 1'                 + "\n" +
+               'example : ignore me'    + "\n" +
+               'spec 2'
+      tree = TodoNext::Parser.parse(source, prune_example_nodes=false)
+      tree.to_hash[:children].should ==
+                [  {:type  => :li, :text  => 'spec 1'             },
+                   {:type  => :ex, :text  => 'example : ignore me', :children => []},
+                   {:type  => :li, :text  => 'spec 2'             }
+                ]
+      tree = TodoNext::Parser.parse(source)
+      tree.to_hash[:children].should ==
+                [  {:type  => :li, :text  => 'spec 1', },
+                   {:type  => :li, :text  => 'spec 2'}
+                ]
+    end
+
+    specify 'an sb-level example line with a sibling is removed'
+
+
+    specify 'an example block is removed' do
+      source = 'HEADER 1'            + "\n" +
+                '  ex :'              + "\n" +
+                '    blabla'          + "\n" +
+                '  spec b'
+
+      tree = TodoNext::Parser.parse(source)
+      tree.to_hash[:children].should ==
+                [  {:type     => :ol , :text  => "HEADER 1",
+                    :children => [{:type => :li, :text => "spec b"}]
+                   }
+                 ]
+    end
+
+    specify 'when an OL only child is an EX, it becomes a LI after pruning' do
+      source = 'spec 1'               + "\n" +
+                '  ex :'              + "\n" +
+                '    blabla'
+
+      tree = TodoNext::Parser.parse(source)
+      tree.to_hash[:children].should ==
+                [  {:type     => :li , :text  => "spec 1"}
+                ]
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: todo_next
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alain Ravet
@@ -74,17 +74,22 @@ files:
 - lib/todo_next/cli/sample_file_generator.rb
 - lib/todo_next/line.rb
 - lib/todo_next/parser.rb
-- lib/todo_next/rspec_generator_visitor.rb
 - lib/todo_next/tree.rb
-- lib/todo_next/tree/depth_first_visitor_base.rb
 - lib/todo_next/tree/factory.rb
 - lib/todo_next/tree/node.rb
+- lib/todo_next/tree/nodes.rb
 - lib/todo_next/tree/parents_list.rb
+- lib/todo_next/tree/visitor/base.rb
+- lib/todo_next/tree/visitor/example_remover_visitor.rb
+- lib/todo_next/tree/visitor/leaf_maker.rb
+- lib/todo_next/tree/visitor/rspec_generator.rb
 - lib/todo_next/version.rb
 - spec/01_parse_the_text_spec.rb
 - spec/02_visit_the_tree_spec.rb
 - spec/03_rspec_generator_visitor_spec.rb
+- spec/04_generated_rspec_format_spec.rb
 - spec/spec_helper.rb
+- spec/tree_spec.rb
 - todo_next.gemspec
 homepage: ""
 licenses: []
@@ -123,4 +128,6 @@ test_files:
 - spec/01_parse_the_text_spec.rb
 - spec/02_visit_the_tree_spec.rb
 - spec/03_rspec_generator_visitor_spec.rb
+- spec/04_generated_rspec_format_spec.rb
 - spec/spec_helper.rb
+- spec/tree_spec.rb

data/lib/todo_next/rspec_generator_visitor.rb

@@ -1,22 +0,0 @@
-require File.dirname(__FILE__) + '/tree/depth_first_visitor_base'
-
-module TodoNext
-
-  class RspecGeneratorVisitor < TodoNext::Tree::DepthFirstVisitorBase
-    def visit(curr_node, level) #nodoc#
-      super
-    end
-
-    def process_terminal_node(curr_node, level)
-      tabs = '  '*(level-1)
-      code = %Q|#{tabs}it("#{curr_node.text}", :pending => "#{curr_node.text}"){}|
-    end
-
-    def process_non_terminal_node(curr_node, level)
-      tabs = '  '*(level-1)
-      codes = curr_node.children.collect { |node| visit(node, 1+level) }
-      [%Q|#{tabs}describe "#{curr_node.text}" do|] + codes + ["#{tabs}end"]
-    end
-  end
-
-end

data/lib/todo_next/tree/depth_first_visitor_base.rb

@@ -1,24 +0,0 @@
-module TodoNext
-  class Tree
-
-    class DepthFirstVisitorBase
-
-      def visit(curr_node, level) #nodoc#
-        if curr_node.terminal?
-          process_terminal_node(curr_node, level)
-        else
-          process_non_terminal_node(curr_node, level)
-        end
-      end
-
-      # overwrite in the concrete visitor class
-      def process_terminal_node(curr_node, level)
-      end
-
-      # overwrite in the concrete visitor class
-      def process_non_terminal_node(curr_node, level)
-      end
-    end
-
-  end
-end