org_mode 0.0.1

data/spec/lib/org_mode/commands/agenda_spec.rb

@@ -0,0 +1,55 @@
+require 'org_mode/commands/agenda'
+require 'tempfile'
+require 'core_ext/string'
+require 'support/capture_stdout'
+require 'support/write_into_tempfile'
+require 'timecop'
+
+# Helper to execute agenda and compare the output
+def execute_and_compare_stdout_with args, options, expected_output
+  output = capture_stdout do
+    @org_mode_commands_agenda.execute(args, options)
+  end
+  output.should == expected_output
+end
+
+describe OrgMode::Commands::Agenda do
+  before do
+    Timecop.freeze('2012-01-01 15:00')
+
+    @org_mode_commands_agenda = OrgMode::Commands::Agenda.new
+  end
+
+  context '#execute' do
+    context 'when loaded with one file' do
+      it 'extracts and displays scheduled tasks correctly' do
+        org_file = write_into_tempfile <<-eos.strip_indent(10)
+          * TODO Scheduled task <1-1-2012 Wed 15:15>
+        eos
+        execute_and_compare_stdout_with [org_file.path], stub, <<-eos.strip_indent(10)
+          Agenda ()
+            2012-01-01
+              TODO Scheduled task 
+        eos
+      end
+    end
+    context 'when loaded with two files' do
+      it 'displays both in expected format and sorted correctly' do
+        org_file = write_into_tempfile <<-eos.strip_indent(10)
+          * TODO Scheduled task on the 5th <5-1-2012 Wed 15:15>
+        eos
+        org_file2 = write_into_tempfile <<-eos.strip_indent(10)
+          * TODO Scheduled task on the 1th <1-1-2012 Wed 15:15>
+        eos
+        execute_and_compare_stdout_with [org_file, org_file2].map(&:path), stub, 
+          <<-eos.strip_indent(10)
+          Agenda ()
+            2012-01-01
+              TODO Scheduled task on the 1th 
+            2012-01-05
+              TODO Scheduled task on the 5th 
+        eos
+      end
+    end
+  end
+end

data/spec/lib/org_mode/parser_spec.rb

@@ -0,0 +1,323 @@
+require 'org_mode'
+require 'org_mode/parser'
+
+# Parser
+# ------
+#
+# Two way parser:
+#   First pass
+#     Find file settings
+#     Find all nodes
+#       Title and content tree structure
+#   Second pass
+#     Parse all nodes
+#       (using information from file, ak TODO keywords)
+#       Parse title
+#       Parse content
+#
+#   Node
+#     Title
+#       TodoStateKeyword
+#       Date
+#     Content
+#       CodeBlockParser
+#       PlainTextParser
+#
+# Nodes
+#   SettingsNode
+#     settings_hash
+#     SettingsAttachment
+#   PlainTextNode
+#     content
+#   CodeBlockNode
+#     language
+#     content
+
+
+# Private: Loads org example
+# 
+# name - takes part of filename
+#
+# Returns the contents of the file
+def load_org_example name
+  File.open("spec/data/org-file-#{name}.org").read
+end
+
+describe OrgMode::FileParser do
+  context ".parse_into_tokens" do
+    it "should pars only one" do
+      org_data = <<-org.gsub(/^\s{8}/,'')
+        * First
+      org
+      b,n,e = OrgMode::FileParser.parse_into_tokens(org_data)
+      b.should be_empty
+      n.should == [["* First", ""]]
+      e.should be_empty
+    end
+    it "should pars only one without enter" do
+      org_data = "* First"
+      b,n,e = OrgMode::FileParser.parse_into_tokens(org_data)
+      b.should be_empty
+      n.should == [["* First", ""]]
+      e.should be_empty
+    end
+    it "should divide data up correctly" do
+      org_data = <<-org.gsub(/^\s{8}/,'')
+        * First
+        ** Second
+      org
+      b,n,e = OrgMode::FileParser.parse_into_tokens(org_data)
+      b.should be_empty
+      n.should == [["* First", ""], ["** Second", ""]]
+      e.should be_empty
+    end
+    it "should handle nodes with content" do
+      org_data = <<-org.gsub(/^\s{8}/,'')
+        * First
+          Content for first node
+        ** Second
+           Content for nested node
+      org
+      b,n,e = OrgMode::FileParser.parse_into_tokens(org_data)
+      b.should be_empty
+      n.should == [["* First", "  Content for first node"], ["** Second", "   Content for nested node"]]
+      e.should be_empty
+    end
+    it "should handle content with no nodes" do
+      org_data = <<-org.gsub(/^\s{8}/,'')
+        Just some textfile without any nodes
+      org
+      b,n,e = OrgMode::FileParser.parse_into_tokens(org_data)
+      b.should == 'Just some textfile without any nodes'
+      n.should == []
+      e.should be_empty
+    end
+    it "should take an empty string" do
+      org_data = <<-org.gsub(/^\s{8}/,'')
+      org
+      b,n,e = OrgMode::FileParser.parse_into_tokens(org_data)
+      b.should be_empty
+      n.should == []
+      e.should be_empty
+    end
+  end
+
+  context ".parse" do
+    let(:org_data) { load_org_example '01-simple-node-structure' }
+    it "should just parse the file" do
+      parsed = OrgMode::FileParser.parse(org_data)
+    end
+    context 'with a parsed org_file' do
+      let(:org_file) { OrgMode::FileParser.parse(org_data) }
+
+      it "should return an OrgMode::File" do
+        org_file.should be_an_instance_of( OrgMode::File )
+      end
+
+      it "parses the tree correctly" do
+        org_file.nodes.length.should == 12
+      end
+
+      it "has an empty beginning" do
+        org_file.header.should be_empty
+      end
+      it "has an empty ending" do
+        org_file.footer.should be_empty
+      end
+      context 'parent_child relations' do
+        it "root node has no parent" do
+          org_file.nodes[0].parent.should be_nil
+        end
+        it "root node has 2 children" do
+          org_file.nodes[0].children.length.should == 2
+          org_file.nodes[0].children[0].title.should == 'FirstChildMain'
+          org_file.nodes[0].children[1].title.should == 'SecondChildMain'
+        end
+        it "ThirdMain should be in business" do
+          org_file.nodes[8].children[0].children[0].children[0].title.should ==
+            'FirstChildFirstChildFirstChildMain'
+        end
+        it "destilled the correct root nodes" do
+          org_file.root_nodes.map(&:title).should == %w[Main SecondMain ThirdMain]
+        end
+      end
+    end
+  end
+end
+
+describe OrgMode::NodeParser do
+  context ".parse" do
+    context "title" do
+      context "standard node title" do
+        let(:node) {OrgMode::NodeParser.parse('** Standard node title', nil)}
+        it "parses the title correctly" do
+          node.title.should == 'Standard node title'
+        end
+        it "determines the correct stars" do
+          node.stars.should == 2
+        end
+        it "determines the correct indent" do
+          node.indent.should == 3
+        end
+      end
+      context "level deeper node title" do
+        let(:node) {OrgMode::NodeParser.parse('*** Standard node title one level deeper', nil)}
+        it "parses the title correctly" do
+          node.title.should == 'Standard node title one level deeper'
+        end
+        it "determines the correct stars" do
+          node.stars.should == 3
+        end
+        it "determines the correct indent" do
+          node.indent.should == 4
+        end
+      end
+      context "node title with date" do
+        let(:node) {OrgMode::NodeParser.parse('** Date node title <2012-02-02 Wed>', nil) }
+        it "parses the date from the title correcty" do
+          node.date.strftime('%Y-%m-%d').should == '2012-02-02'
+        end
+      end
+      context "node title with date time" do
+        let(:node) {OrgMode::NodeParser.parse('** Date node title <2012-02-03 Wed 15:15>', nil)}
+        it "parses the date-time from the title correcty" do
+          node.date.strftime('%Y-%m-%d %H:%M').should == '2012-02-03 15:15'
+        end
+      end
+      context "node title with date-range" do
+        let(:node) {OrgMode::NodeParser.parse('** Date node title <2012-02-03 Wed 15:15-16:15>', nil)}
+        it "parses the date from the title correcty" do
+          node.date.strftime('%Y-%m-%d %H:%M').should == '2012-02-03 15:15'
+        end
+        it "parses the start_tiem correctly" do
+          node.date_start_time.strftime('%Y-%m-%d %H:%M').should == '2012-02-03 15:15'
+        end
+        it "parses the end_time correctly" do
+          node.date_end_time.strftime('%Y-%m-%d %H:%M').should == '2012-02-03 16:15'
+        end
+      end
+      context "parses TODO states correctly" do
+        let(:node) {OrgMode::NodeParser.parse('** TODO Date node title', nil)}
+        it "parses the TODO keyword correctly" do
+          node.todo_state.should == 'TODO'
+        end
+        context "parses DONE state correctly" do
+          let(:node) {OrgMode::NodeParser.parse('** DONE Date node title', nil)}
+          it "parses the TODO keyword correctly" do
+            node.todo_state.should == 'DONE'
+          end
+        end
+      end
+    end
+    context "content indentation" do
+      context "correctly indented" do
+        before do
+          org_title, *org_content = <<-eos.gsub(/^\s{10}/,'').lines.to_a
+          *** Title
+              Content belonging
+              at a certain indent
+              should be parsed correctly
+          eos
+          @node = OrgMode::NodeParser.parse(org_title, org_content.join)
+        end
+        it "parses content and removes indent" do
+          @node.content.should == <<-eos.gsub(/^\s{10}/,'')
+          Content belonging
+          at a certain indent
+          should be parsed correctly
+          eos
+        end
+      end
+      context "too far" do
+        before do
+          org_title, *org_content = <<-eos.gsub(/^\s{10}/,'').lines.to_a
+          *** Title
+                Content belonging
+                at a certain indent
+                should be parsed correctly
+          eos
+          @node = OrgMode::NodeParser.parse(org_title, org_content.join)
+        end
+        it "parses content and removes indent" do
+          @node.content.should == <<-eos.gsub(/^\s{10}/,'')
+            Content belonging
+            at a certain indent
+            should be parsed correctly
+          eos
+        end
+      end
+      context "indented in content block" do
+        before do
+          org_title, *org_content = <<-eos.gsub(/^\s{10}/,'').lines.to_a
+          *** Title
+              Content belonging
+                at a certain indent
+                should be parsed correctly
+          eos
+          @node = OrgMode::NodeParser.parse(org_title, org_content.join)
+        end
+        it "parses content and removes indent" do
+          @node.content.should == <<-eos.gsub(/^\s{10}/,'')
+          Content belonging
+            at a certain indent
+            should be parsed correctly
+          eos
+        end
+      end
+      context "one row outdented" do
+        before do
+          org_title, *org_content = <<-eos.gsub(/^\s{10}/,'').lines.to_a
+          *** Title
+            Content belonging
+              at a certain indent
+              should be parsed correctly
+          eos
+          @node = OrgMode::NodeParser.parse(org_title, org_content.join)
+        end
+        it "parses content and removes indent" do
+          @node.content.should == <<-eos.gsub(/^\s{10}/,'')
+          Content belonging
+            at a certain indent
+            should be parsed correctly
+          eos
+        end
+      end
+    end
+    context "content whitespace" do
+      it "removes whitespace at beginning" do
+        org_title, *org_content = <<-eos.gsub(/^\s{8}/,'').lines.to_a
+        *** Title
+            
+            
+            
+            Content belonging
+            at a certain indent
+            should be parsed correctly
+        eos
+        @node = OrgMode::NodeParser.parse(org_title, org_content.join)
+        @node.content.should == <<-eos.gsub(/^\s{8}/,'')
+        Content belonging
+        at a certain indent
+        should be parsed correctly
+        eos
+      end
+      it "removes whitespace at ending" do
+        org_title, *org_content = <<-eos.gsub(/^\s{8}/,'').lines.to_a
+        *** Title
+            Content belonging
+            at a certain indent
+            should be parsed correctly
+            
+            
+            
+        eos
+        @node = OrgMode::NodeParser.parse(org_title, org_content.join)
+        @node.content.should == <<-eos.gsub(/^\s{8}/,'')
+        Content belonging
+        at a certain indent
+        should be parsed correctly
+        eos
+      end
+    end
+  end
+end

data/spec/lib/org_mode/reporters/agenda_spec.rb

@@ -0,0 +1,74 @@
+require 'org_mode/reporters/agenda'
+require 'support/blueprints'
+require 'support/include_hash'
+require 'timecop'
+
+describe OrgMode::Reporters::Agenda do
+  before do
+    Timecop.freeze('2012-02-02')
+  end
+  let(:file_collection) do
+    nodes = []
+    files = []
+    nodes << OrgMode::Node.make(:stars => 1, :date=>Date.parse('2012-02-01'))
+    nodes << OrgMode::Node.make(:stars => 2, :date=>Date.parse('2012-02-05'))
+    files << OrgMode::File.make(:nodes => nodes)
+    nodes = []
+    nodes << OrgMode::Node.make(:stars => 1, 
+                                :todo_state => 'DONE', 
+                                :date => Date.parse('2012-06-01'))
+    nodes << OrgMode::Node.make(:stars => 2, :date=>Date.parse('2012-02-03'))
+    nodes << OrgMode::Node.make(:stars => 3, :date=>DateTime.parse('2012-02-01 15:00'))
+    files << OrgMode::File.make(:nodes => nodes)
+    OrgMode::FileCollection.make(:files => files)
+  end
+  let(:reporter) { OrgMode::Reporters::Agenda.new(file_collection) }
+
+  context '#open_nodes_grouped_by_day' do
+
+    let (:reported) { reporter.open_nodes_grouped_by_day }
+
+    it "extracts the correct dates and in the correct order" do
+      dates = reported.map {|e| e[:date] }
+      dates.should == ["2012-02-01", "2012-02-03", "2012-02-05"]
+    end
+    it "should group the nodecounts correctly" do
+      nodecount_per_date = reported.map { |e| [e[:date], e[:nodes].length] }
+      nodecount_per_date.should == [["2012-02-01", 2], ["2012-02-03", 1], ["2012-02-05", 1]]
+    end
+    it "should result in the following subhashes" do
+      reported.should ==
+         [{:date=>"2012-02-01",
+           :nodes=>
+            [{:title=>"org-node",
+              :content=>"org-node content",
+              :todo_state=>"TODO",
+              :date=>"2012-02-01 00:00",
+              :stars=>1},
+             {:title=>"org-node",
+              :content=>"org-node content",
+              :todo_state=>"TODO",
+              :date=>"2012-02-01 15:00",
+              :stars=>3}]},
+          {:date=>"2012-02-03",
+           :nodes=>
+            [{:title=>"org-node",
+              :content=>"org-node content",
+              :todo_state=>"TODO",
+              :date=>"2012-02-03 00:00",
+              :stars=>2}]},
+          {:date=>"2012-02-05",
+           :nodes=>
+            [{:title=>"org-node",
+              :content=>"org-node content",
+              :todo_state=>"TODO",
+              :date=>"2012-02-05 00:00",
+              :stars=>2}]}]
+    end
+    it "it ignores the DONE task" do
+      dates = reported.map {|e| e[:date] }
+      dates.should_not include("2012-06-01")
+    end
+  end
+
+end

data/spec/lib/org_mode_spec.rb

@@ -0,0 +1,52 @@
+require 'org_mode'
+require 'support/blueprints'
+
+describe OrgMode::File do
+  let(:file) do
+    nodes = []
+    files = []
+    nodes << OrgMode::Node.make(:stars => 1)
+    nodes << OrgMode::Node.make(:stars => 2, :date=>Time.now)
+    nodes << OrgMode::Node.make(:stars => 3)
+    nodes << OrgMode::Node.make(:stars => 1)
+    OrgMode::File.make(:nodes => nodes)
+  end
+
+  it "accumulates correctly" do
+    file.nodes.length.should == 4
+  end
+
+  it "detects all rootnodes correctly" do
+    file.root_nodes.length.should == 2
+  end
+
+  it "detects all scheduled nodes correctly" do
+    file.scheduled_nodes.length.should == 1
+  end
+end
+
+describe OrgMode::FileCollection do
+  let(:file_collection) do
+    nodes = []
+    files = []
+    nodes << OrgMode::Node.make(:stars => 1)
+    nodes << OrgMode::Node.make(:stars => 2)
+    files << OrgMode::File.make(:nodes => nodes)
+    nodes = []
+    nodes << OrgMode::Node.make(:stars => 1)
+    nodes << OrgMode::Node.make(:stars => 2, :date=>Time.now)
+    nodes << OrgMode::Node.make(:stars => 3)
+    files << OrgMode::File.make(:nodes => nodes)
+    OrgMode::FileCollection.make(:files => files)
+  end
+  it "accumulates correctly" do
+    file_collection.nodes.length.should == 5
+  end
+
+  it "detects all rootnodes correctly" do
+    file_collection.root_nodes.length.should == 2
+  end
+  it "detects all scheduled nodes correctly" do
+    file_collection.scheduled_nodes.length.should == 1
+  end
+end

data/spec/support/blueprints.rb

@@ -0,0 +1,27 @@
+require 'org_mode'
+
+class OrgMode::Node
+  def self.make(attrs={})
+    self.new.tap do |n|
+      n.title = attrs[:title] || "org-node"
+      n.stars = attrs[:stars] || rand(4)
+      n.content = attrs[:content] || "org-node content"
+      n.date = attrs[:date]
+      n.todo_state = attrs[:todo_state] || 'TODO'
+    end
+  end
+end
+
+class OrgMode::File
+  def self.make(attrs={})
+    nodes = attrs[:nodes] || Array.new(2) { OrgMode::Node.make }
+    self.new("aheader", nodes , "afooter")
+  end
+end
+
+class OrgMode::FileCollection
+  def self.make(attrs={})
+    files = attrs[:files] || Array.new(2) { OrgMode::File.make }
+    self.new( files ) 
+  end
+end

data/spec/support/capture_stdout.rb

@@ -0,0 +1,12 @@
+require 'stringio'
+ 
+def capture_stdout
+  out = StringIO.new
+  $stdout = out
+  yield
+  out.rewind
+  return out.read
+ensure
+  $stdout = STDOUT
+end
+ 

data/spec/support/include_hash.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :include_hash do |expected|
+
+  match do |actual|
+    actual.present? && actual.slice(*expected.keys) == expected
+  end
+
+end

data/spec/support/write_into_tempfile.rb

@@ -0,0 +1,6 @@
+def write_into_tempfile string
+  tmpfile = Tempfile.new('org_mode_file')
+  tmpfile.write(string)
+  tmpfile.flush
+  tmpfile
+end