todo_next 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.0.1
+	- $ todo_next creates a sample rspec test with an todo_next usage example

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in todo_next.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color --format nested --fail-fast" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})  { "spec" }
+  watch('spec/spec_helper.rb')
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alain Ravet
+
+MIT License
+
+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,67 @@
+# Goal::Tdd
+
+A small DSL that converts free text into pending tests/specs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'todo_next'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create a first spec with a todo_next skeleton:
+
+```shell
+$ cd <project>
+$ todo_next stack
+    # => <project>/spec/stack_spec.rb was created.
+$ cat spec/stack_spec.rb
+    # =>
+```
+```ruby
+    require 'rubygems'
+    require 'rspec'
+    require 'todo_next'
+
+    todo_next(<<TEXT)
+    A Foobar
+      - is white by default
+      - can be resized
+      truthiness()
+        - is always true
+      (add more tests)
+    TEXT
+
+
+    #describe "<what you're testing>" do
+    #  specify 'this should happen' do
+    #    .. some code
+    #  end
+```
+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
+```
+
+![screenshot1](https://github.com/alainravet/todo_next/raw/master/doc/screenshot_1.png)
+![screenshot1](https://github.com/alainravet/todo_next/raw/master/doc/screenshot_2.png)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/todo_next

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/todo_next'
+
+TodoNext::CLI.run(ARGV)

data/bin/todonext

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/todo_next'
+
+TodoNext::CLI.run(ARGV)

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

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rspec'
+require 'todo_next'
+
+todo_next(<<TEXT)
+A <%= classname %>
+  - is white by default
+  - can be resized
+  truthiness()
+    - is always true
+  (add more tests)
+TEXT
+
+
+#describe "<what you're testing>" do
+#  specify 'this should happen' do
+#    .. some code
+#  end
+#end

data/lib/todo_next/cli/sample_file_generator.rb

@@ -0,0 +1,56 @@
+require 'erb'
+
+module TodoNext
+  class CLI
+    class SampleFileGenerator
+
+      TEMPLATE_PATH     = File.dirname(__FILE__) + '/assets/rspec_example_file.rb.erb'
+
+      def self.generate(object_name)
+        object_name = object_name && object_name.downcase
+        target_file = sample_file_path(object_name)
+
+        erb = ERB.new(File.read(TEMPLATE_PATH))
+        classname = (object_name || 'foobar').capitalize  # for ERB/binding
+        rspec_sample = erb.result(binding)
+
+        if File.exist?(target_file)
+          File.open(target_file, "r") do |orig|
+            @original = orig.read()
+          end
+          if @original.include?(rspec_sample)
+            puts "skipping : sample code already present in #{target_file}."
+          else
+            File.open(target_file, "r") do |orig|
+              File.unlink(target_file)
+              File.open(target_file, "w") do |new|
+                new.write rspec_sample
+                new.write(@original)
+              end
+              puts "sample code was inserted in #{target_file}."
+            end
+          end
+        else
+          File.open(target_file,'w') do |f| f.write(rspec_sample) end
+          puts "#{target_file} was created."
+        end
+      end
+
+    private
+
+      def self.sample_file_path(object_name)
+        file_name = object_name ?
+            "#{object_name}_spec.rb" :
+            'todo_next_spec.rb'
+        "#{sample_file_dir}/#{file_name}"
+      end
+
+      def self.sample_file_dir
+        curr_dir  = `pwd`.chomp
+        candidate = "#{curr_dir}/spec"
+        File.directory?(candidate) ? candidate : curr_dir
+      end
+
+    end
+  end
+end

data/lib/todo_next/cli.rb

@@ -0,0 +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

data/lib/todo_next/line.rb

@@ -0,0 +1,25 @@
+module TodoNext
+
+  class Line
+    attr_accessor :text, :col_offset, :leaf
+
+    def initialize(text, col_offset)
+      @text, @col_offset = text, col_offset
+    end
+
+    def to_s
+      "<Line# text:#{text}, leaf:#{leaf}, col_offset:#{col_offset}>"
+    end
+
+    def blank?
+      text =~ /^\s*$/
+    end
+    def comment?
+      text =~ /^#/
+    end
+
+    def leaf?   ; leaf   end
+    def branch? ; !leaf? end
+  end
+
+end

data/lib/todo_next/parser.rb

@@ -0,0 +1,26 @@
+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)
+      lines = extract_meaningful_lines(text)
+      tree  = Tree::Factory.build(lines)
+    end
+
+    def self.extract_meaningful_lines(text)
+       text.
+           split("\n").
+           collect do |text|
+         col_offset = text =~ /\S/
+         Line.new(text.strip, col_offset)
+       end.
+           reject{|l| l.blank?  }.
+           reject{|l| l.comment?}
+    end
+  end
+
+end

data/lib/todo_next/rspec_generator_visitor.rb

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,24 @@
+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

data/lib/todo_next/tree/factory.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/node'
+require File.dirname(__FILE__) + '/parents_list'
+
+module TodoNext
+
+  class Tree
+    class Factory
+
+      def self.build(lines)
+        mark_the_leaves_and_the_branches(lines)
+
+        tree    = Tree.new
+        parents = ParentsList.new
+
+        lines.each do |line|
+          curr_line_col = line.col_offset
+          parent        = parents.get_for_item_at_column(curr_line_col) || tree
+
+          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
+
+    private
+
+      def self.mark_the_leaves_and_the_branches(lines)
+        lines.each_with_index do |curr_line, idx|
+          next_line          = lines[1+idx]
+          next_line_is_child = next_line && curr_line.col_offset < next_line.col_offset
+          curr_line.leaf     = !next_line_is_child
+        end
+      end
+
+    end
+  end
+
+end

data/lib/todo_next/tree/node.rb

@@ -0,0 +1,25 @@
+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
+      end
+    end
+
+    class OL < Node ; end
+
+    class LI < Node
+      def terminal?
+        true
+      end
+    end
+  end
+
+end

data/lib/todo_next/tree/parents_list.rb

@@ -0,0 +1,23 @@
+module TodoNext
+
+  class Tree
+    class ParentsList
+
+      def initialize(parents=nil)
+        @parents = parents || { -1 => nil }
+      end
+
+      def register_parent(new_parent, options)
+        curr_col = options.fetch(:for_col)
+        @parents[1+curr_col] = new_parent
+        @parents.delete_if{|k, v| k > 1+curr_col }
+      end
+
+      def get_for_item_at_column(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.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/tree/factory'
+
+module TodoNext
+
+  class Tree
+    attr_accessor :children
+
+    def initialize
+      @children = []
+    end
+
+    def visit(visitor)
+      children.collect do |node|
+        visitor.visit(node, level=1)
+      end
+    end
+  end
+
+end

data/lib/todo_next/version.rb

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

data/lib/todo_next.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/todo_next/version'
+
+module TodoNext
+  # Your code goes here...
+end
+require File.dirname(__FILE__) + '/todo_next/parser'
+
+main = TOPLEVEL_BINDING.eval('self')
+def main.todo_next(text, puts_code=false)
+  code = TodoNext(text)
+  if puts_code
+    puts '---' ; puts code  ; puts '---'
+  end
+  eval code
+end
+
+def TodoNext(source)
+  TodoNext::Parser.
+      parse(source).
+      visit(TodoNext::RspecGeneratorVisitor.new).
+      flatten.
+      join("\n")
+end

data/spec/01_parse_the_text_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe TodoNext::Parser, 'parsing indented text and producing a Tree' do
+
+  it 'ignores comments and blank lines' do
+    @source = '# a comment'     + "\n" +
+              '   # a comment'  + "\n" +
+              '   '             + "\n" +
+              ''
+    result_should_be []
+  end
+
+  it 'converts a single line into a free :li element' do
+    @source =  'HEADER 1'            + "\n"
+
+    result_should_be [{:type => :li , :text => "HEADER 1"}]
+  end
+
+  it 'converts 2 lines starting in col 0 into 2 free :li elements' do
+    @source = 'HEADER 1'            + "\n" +
+              'HEADER 2'            + "\n"
+
+    result_should_be [   {:type => :li , :text => "HEADER 1"},
+                         {:type => :li , :text => "HEADER 2"}
+                     ]
+  end
+
+  it 'converts 2 lines under a header as 2 :li under 1 :ol' do
+    @source = 'HEADER 1'            + "\n" +
+              '  spec a'            + "\n" +
+              '  spec b'
+
+    result_should_be [  {:type  => :ol , :text  => "HEADER 1",
+                         :children  => [
+                             {:type  => :li, :text  => "spec a"},
+                             {:type  => :li, :text  => "spec b"}
+                         ]
+                        }
+                    ]
+  end
+
+  it 'converts a complex text into the proper Tree' do
+    @source = 'HEADER 1'            + "\n" +
+              '  HEADER 2'          + "\n" +
+              '    HEADER 3'        + "\n" +
+              '      spec a'        + "\n" +
+              'HEADER 4'            + "\n" +
+              '  spec b'            + "\n"
+
+    result_should_be [  {:type      =>  :ol, :text => "HEADER 1",
+                         :children  => [
+                             {:type     => :ol, :text => "HEADER 2",
+                              :children => [
+                                  {:type      =>:ol, :text => "HEADER 3",
+                                   :children  =>[ {:type => :li, :text => "spec a"} ]
+                                  }
+                              ]
+                             }
+                         ]
+                        },
+
+                        {:type      =>  :ol, :text =>  "HEADER 4",
+                         :children  =>  [
+                             {:type      =>  :li, :text=>"spec b"}
+                         ]
+                        }
+                    ]
+  end
+end

data/spec/02_visit_the_tree_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+
+describe TodoNext::Tree, 'visiting the tree depth-first' do
+
+
+  class SimpleVisitor < TodoNext::Tree::DepthFirstVisitorBase
+    def process_terminal_node(curr_node, level)
+      curr_node.text
+    end
+
+    def process_non_terminal_node(curr_node, level)
+      result = curr_node.children.collect { |node| visit(node, 1+level) }.join(', ')
+      "#{curr_node.text}=[#{result}]"
+    end
+  end
+
+
+  it 'visits the tree depth-first' do
+    expected = ['HEADER 1=[HEADER 2=[HEADER 3=[spec a, spec b]]]' ,
+                'HEADER 4=[spec c]',
+                'HEADER 5',
+                'HEADER 6'
+               ]
+
+    source = 'HEADER 1'            + "\n" +
+              '  HEADER 2'          + "\n" +
+              '    HEADER 3'        + "\n" +
+              '      spec a'        + "\n" +
+              '      spec b'        + "\n" +
+              'HEADER 4'            + "\n" +
+              '  spec c'            + "\n" +
+              'HEADER 5'            + "\n" +
+              'HEADER 6'
+
+    TodoNext::Parser.
+        parse(source).
+        visit(SimpleVisitor.new).
+        should == expected
+  end
+end

data/spec/03_rspec_generator_visitor_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe TodoNext::RspecGeneratorVisitor do
+
+  it 'visits the tree depth-first' do
+    source = 'HEADER 1'            + "\n" +
+        '  HEADER 2'          + "\n" +
+        '    HEADER 3'        + "\n" +
+        '      spec a'        + "\n" +
+        '      spec b'        + "\n" +
+        'HEADER 4'            + "\n" +
+        '  spec c'            + "\n" +
+        'HEADER 5'            + "\n" +
+        'HEADER 6'
+
+    expected =<<RUBY.chomp
+describe "HEADER 1" do
+  describe "HEADER 2" do
+    describe "HEADER 3" do
+      it("spec a", :pending => "spec a"){}
+      it("spec b", :pending => "spec b"){}
+    end
+  end
+end
+describe "HEADER 4" do
+  it("spec c", :pending => "spec c"){}
+end
+it("HEADER 5", :pending => "HEADER 5"){}
+it("HEADER 6", :pending => "HEADER 6"){}
+RUBY
+
+    TodoNext(source).should == expected
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require File.dirname(__FILE__) + '/../lib/todo_next.rb'
+
+class TodoNext::Tree
+  def to_hash
+    {
+        :children => children.collect{|ch| ch.to_hash }
+    }
+  end
+
+  class OL
+
+    def to_hash
+      {   :type => :ol,
+          :text => text,
+          :children => children.collect{|ch| ch.to_hash }
+      }
+    end
+  end
+  class LI
+    def to_hash
+      {   :type => :li,
+          :text => text
+      }
+    end
+  end
+end
+
+def parsed_result(source)
+  TodoNext::Parser.parse(source).to_hash[:children]
+end
+
+def result_should_be(expected)
+  parsed_result(@source).should == expected
+end

data/todo_next.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/todo_next/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alain Ravet"]
+  gem.email         = ["alainravet@gmail.com"]
+  gem.description   = %q{small DSL to convert free text into pending tests/specs}
+  gem.summary       = %q{small DSL to convert free text into pending tests/specs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "todo_next"
+  gem.require_paths = ["lib"]
+  gem.version       = TodoNext::VERSION
+
+  gem.add_development_dependency  'rake'  # to run 'All specs in Rubymine'
+  gem.add_development_dependency  'rspec'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: todo_next
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alain Ravet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rake
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rspec
+  requirement: *id002
+description: small DSL to convert free text into pending tests/specs
+email: 
+- alainravet@gmail.com
+executables: 
+- todo_next
+- todonext
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/todo_next
+- bin/todonext
+- doc/screenshot_1.png
+- doc/screenshot_2.png
+- lib/todo_next.rb
+- lib/todo_next/cli.rb
+- lib/todo_next/cli/assets/rspec_example_file.rb.erb
+- 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/parents_list.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/spec_helper.rb
+- todo_next.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: small DSL to convert free text into pending tests/specs
+test_files: 
+- spec/01_parse_the_text_spec.rb
+- spec/02_visit_the_tree_spec.rb
+- spec/03_rspec_generator_visitor_spec.rb
+- spec/spec_helper.rb