org-converge 0.0.5 → 0.0.6

data/TODO

@@ -2,7 +2,7 @@
 #+TODO:    TODO | DONE CANCELED 
 #+startup: showeverything
 
-* [0/7] > 0.0.9 version
+* [0/8] > 0.0.9 version
 
 - [ ] Macros can be loaded and applied to the configuration
 - [ ] Actually support converging and idempotency
@@ -14,12 +14,14 @@
   : org-converge setupfile.org --dry-run
 - [ ] Use :eval for evaling blocks (off by default)
 - [ ] Can use :dir for running a process relative to that directory
+- [ ] Use rake task manager
 
-* [0/3] 0.0.6 version
+* [3/3] 0.0.6 version
 
-- [ ] Keyword to accumulate run blocks
-- [ ] Do not run commented blocks
-- [ ] Use rake task manager
+# - [ ] Keyword to accumulate run blocks
+- [X] Run specific blocks defined by name (using a regex expression)
+- [X] Change the format of the logger
+- [X] Do not run blocks in commented headlines
 
 * [2/2] 0.0.5 version
 
@@ -53,7 +55,7 @@ Need some basic functionality of what Org babel offers first.
 - [X] ~--tangle~ flag
 - [X] Support a root dir for when not running relative to the directory
 
-* [3/19] Ideas
+* [3/20] Ideas
 ** CANCELED How to set the permissions from the directory from the file that is being tangled when it does not exists?
 
 By default, this would be 0644, but we also need to specify the
@@ -65,6 +67,7 @@ hmm dont't like this syntax for folders
 
 Let's keep it simple and just use a babel block that shells out to create the directories
 until I can think of something better.
+** TODO Inject macros within the environment variables from a runnable process
 ** TODO Clarify which ones of the header arguments to implement
 
 http://orgmode.org/manual/Specific-header-arguments.html#Specific-header-arguments

data/bin/org-converge

@@ -8,7 +8,7 @@ doc = <<OPTIONS
 org-converge: A light configuration management tool for Org mode
 
 Usage:
-  org-converge <org_file> [--tangle] [--showfiles] [--log=<logfile>] [--root-dir=<root_dir>] [--runmode=<runmode>]
+  org-converge <org_file> [--tangle] [--showfiles] [--log=<logfile>] [--root-dir=<root_dir>] [--runmode=<runmode>] [--name=<block_name>]
 
 Options:
 

data/examples/apt-get-install/setup.org

@@ -1,9 +1,11 @@
-#+TITLE: Installing some packages
+#+TITLE:   Installing some packages
+#+runmode: sequential
 
 * Just install some packages for example
 
+#+name: install_build_essentials
 #+begin_src sh
-sudo apt-get install build-essentials
+sudo apt-get install build-essential -y
 #+end_src
 
 Should be able to be run with something like:

data/examples/fluentd/setup.org

@@ -12,7 +12,9 @@ Fluentd can be installed either as a package from treasure data or
 just as a gem. In this example, we only install as a gem:
 
 # Fails because of permissions
-#+begin_src sh :shebang #!/bin/bash
+
+#+name: install_fluentd
+#+begin_src sh :shebang #!/bin/bash :before all
 gem list | grep fluentd
 fluentd_installed=$?
 if [ $fluentd_installed -ne 0 ]; then
@@ -53,6 +55,7 @@ to ~fluentd_filepath~.
 
 Send some logs:
 
+#+name: flush_logs
 #+begin_src ruby :shebang #!/usr/local/bin/ruby
 require 'fluent-logger'
 
@@ -70,12 +73,14 @@ end
 
 And yet another process which will be tailing the file that we are sending logs too:
 
+#+name: tail_logs
 #+begin_src sh :shebang #!/bin/bash
 tail -f here.*
 #+end_src
 
 * Start which was configured here 				      :start:
 
+#+name: fluentd_run
 #+begin_src bash :shebang #!/bin/bash
 fluentd -c fluentd.conf -vvv
 #+end_src

data/examples/simple/setup.org

@@ -1,10 +1,11 @@
-#+TITLE: Simple example
+#+TITLE:   Simple tangle example
+#+runmode: sequential
 
 It does not get more simple than this:
 
-- First, configure something:
+First, configure something:
 
-  #+begin_src conf :tangle /tmp/my-conf
+#+begin_src conf :tangle /tmp/my-conf
 <source>
   bind 0.0.0.0
   port 4224
@@ -14,29 +15,31 @@ It does not get more simple than this:
   type file
   path /var/tmp/a.log
 </match>
-  #+end_src
+#+end_src
 
-- And then run something
+Then run something:
 
-  #+begin_src sh
+#+name: first_run
+#+begin_src sh
 echo "1) Hello world" > /tmp/my-echo
 echo "2) Hello world" > /tmp/my-echo
 echo "3) Hello world" > /tmp/my-echo
-  #+end_src
+#+end_src
 
-- Then configure something again
+Then configure something again:
 
-  #+begin_src sh
+#+name: second_run
+#+begin_src sh
 echo "4) Hello world" >> /tmp/my-echo
 echo "5) Hello world" >> /tmp/my-echo
 echo "6) Hello world" >> /tmp/my-echo
 
 echo "7) Hello world" >> /tmp/my-echo
-  #+end_src
+#+end_src
 
-- And send something to babel once again
+And send something to babel once again:
 
-  #+begin_src conf :tangle /tmp/hello-conf.yml
+#+begin_src conf :tangle /tmp/hello-conf.yml
 status_port: 9090
 no_tab_after_that: true
-  #+end_src
+#+end_src

data/lib/org-converge.rb

@@ -11,6 +11,8 @@ module Orgmode
     # This would return a babel output buffer which has the methods
     # needed in order to be able to tangle the files
     def babelize
+      mark_trees_for_export
+
       # Feed the parsed contens and create the necessary internal structures
       # for doing babel like features
       output = ''
@@ -20,6 +22,7 @@ module Orgmode
       ob = BabelOutputBuffer.new(output, babel_options)
       translate(@header_lines, ob)
       @headlines.each do |headline|
+        next if headline.export_state == :exclude
         translate(headline.body_lines, ob)
       end
 

data/lib/org-converge/babel.rb

@@ -33,7 +33,6 @@ module Orgmode
         if not Dir.exists?(directory)
           begin
             if script[:header][:mkdirp] == 'true'
-              p script
               logger.info "Create dir for #{file} since it does not exists..."
               FileUtils.mkdir_p(File.dirname(file), :mode => 0755)
             else
@@ -65,7 +64,7 @@ module Orgmode
       logger.info "Tangling succeeded!"
     end
 
-    def tangle_runnable_blocks!(run_dir='run')
+    def tangle_runnable_blocks!(run_dir='run', options={})
       FileUtils.mkdir_p(run_dir)
 
       logger.info "Tangling #{ob.scripts.count} scripts within directory: #{run_dir}..."

data/lib/org-converge/command.rb

@@ -8,7 +8,6 @@ module OrgConverge
     def initialize(options)
       @options = options
       @dotorg  = options['<org_file>']
-      @logger  = Logger.new(options['--log'] || STDOUT)
       @root_dir = options['--root-dir']
       @run_dir  = if @root_dir
                     File.expand_path(File.join(@root_dir, 'run'))
@@ -17,6 +16,10 @@ module OrgConverge
                   end
       @ob    = Orgmode::Parser.new(File.read(dotorg)).babelize
       @babel = nil
+      @logger  = Logger.new(options['--log'] || STDOUT)
+      logger.formatter = proc do |severity, datetime, progname, msg| 
+        "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S %z')}] #{msg}\n"
+      end
     end
 
     def execute!
@@ -37,8 +40,11 @@ module OrgConverge
 
     def converge!
       tangle!
-      if @options['--runmode']
+      case
+      when @options['--runmode']
         dispatch_runmode(@options['--runmode'])
+      when @options['--name']
+        run_matching_blocks!
       else
         # Try to find one in the buffer
         runmode = ob.in_buffer_settings['RUNMODE']
@@ -110,6 +116,22 @@ module OrgConverge
       logger.info "Run has completed successfully.".fg 'green'
     end
 
+    def run_matching_blocks!
+      @engine = OrgConverge::Engine.new(:logger => @logger, :babel => @babel)
+      babel.tangle_runnable_blocks!(@run_dir, :filter => @options['--name'])
+      scripts = babel.ob.scripts.select {|k, h| h[:header][:name] =~ Regexp.new(@options['--name']) }
+      scripts.each do |key, script|
+        file = File.expand_path("#{@run_dir}/#{key}")
+        cmd = "#{script[:lang]} #{file}"
+        display_name = script[:header][:name]
+        @engine.register display_name, cmd, { :cwd => @root_dir, :logger => logger }
+      end
+
+      logger.info "Running code blocks now! (#{scripts.count} runnable blocks found in total)"
+      @engine.start
+      logger.info "Run has completed successfully.".fg 'green'
+    end
+
     def with_running_engine
       engine = OrgConverge::Engine.new(:logger => @logger, :babel => @babel)
       yield engine

data/lib/org-converge/version.rb

@@ -1,3 +1,3 @@
 module OrgConverge
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/converge_examples/commented_block/run.org

@@ -0,0 +1,34 @@
+# -*- mode: org -*-
+#+TITLE:	Runnable vs. Commented blocks
+#+DATE:		2014-05-03
+#+STARTUP:	showeverything
+#+NOTEBOOK:	commented_block
+#+runmode:      sequential
+
+** Runnable blocks
+
+#+name: runnable_block_1
+#+begin_src sh :results output
+echo "first" > output.log
+#+end_src
+
+** COMMENT Non runnable blocks
+
+#+name: not_runnable_block_2
+#+begin_src sh :results output
+echo "should not run" >> output.log
+#+end_src
+
+** More runnable blocks
+
+#+name: runnable_block_3
+#+begin_src sh :results output
+echo "third" >> output.log
+#+end_src
+
+*** COMMENT Not runnable block
+
+#+name: not_runnable_block_4
+#+begin_src sh :results output
+echo "fourth" >> output.log
+#+end_src

data/spec/converge_examples/specified_block/run.org

@@ -0,0 +1,21 @@
+# -*- mode: org -*-
+#+OPTIONS:	^:nil
+#+TITLE:	Runs specified blocks
+#+DATE:		2014-05-03
+#+STARTUP:	showeverything
+
+Considering that there are the following blocks defined:
+
+#+name: first_block
+#+begin_src sh
+echo "Running first block!"
+echo 'First block' > same.log
+#+end_src
+
+Second block:
+
+#+name: second_block
+#+begin_src sh
+echo "Running second block!"
+echo 'Second block' >> same.log
+#+end_src

data/spec/converge_spec.rb

@@ -38,6 +38,37 @@ describe OrgConverge::Command do
     expected_contents.lines.count.should == 16
   end
 
+  it "should run specified block from 'specified_block' example" do
+    example_dir = File.join(EXAMPLES_DIR, 'specified_block')
+    setup_file = File.join(example_dir, 'run.org')
+    o = OrgConverge::Command.new({ 
+                                   '<org_file>' => setup_file,
+                                   '--root-dir' => example_dir,
+                                   '--name'     => 'first'
+                                 })
+    success = o.execute!
+    success.should == true
+
+    expected_contents = File.read(File.join(example_dir, 'same.log'))
+    expected_contents.lines.count.should == 1
+    expected_contents.should == "First block\n"
+  end
+
+  it "should run not commented blocks from 'commented_block' example" do
+    example_dir = File.join(EXAMPLES_DIR, 'commented_block')
+    setup_file = File.join(example_dir, 'run.org')
+    o = OrgConverge::Command.new({ 
+                                   '<org_file>' => setup_file,
+                                   '--root-dir' => example_dir,
+                                 })
+    success = o.execute!
+    success.should == true
+
+    expected_contents = File.read(File.join(example_dir, 'output.log'))
+    expected_contents.lines.count.should == 2
+    expected_contents.should == "first\nthird\n"
+  end
+
   it "should converge 'runlist_example' sequentially" do
     example_dir = File.join(EXAMPLES_DIR, 'runlist_example')
     setup_file = File.join(example_dir, 'setup.org')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: org-converge
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
-  requirement: &70344197198100 !ruby/object:Gem::Requirement
+  requirement: &70130002051260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70344197198100
+  version_requirements: *70130002051260
 - !ruby/object:Gem::Dependency
   name: org-ruby
-  requirement: &70344197197620 !ruby/object:Gem::Requirement
+  requirement: &70130002050780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70344197197620
+  version_requirements: *70130002050780
 - !ruby/object:Gem::Dependency
   name: foreman
-  requirement: &70344196892060 !ruby/object:Gem::Requirement
+  requirement: &70130002050320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.63.0
   type: :runtime
   prerelease: false
-  version_requirements: *70344196892060
+  version_requirements: *70130002050320
 - !ruby/object:Gem::Dependency
   name: tco
-  requirement: &70344196890840 !ruby/object:Gem::Requirement
+  requirement: &70130002049860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70344196890840
+  version_requirements: *70130002049860
 description: A light configuration management tool for Org mode
 email:
 - waldemar.quevedo@gmail.com
@@ -85,7 +85,9 @@ files:
 - spec/converge_examples/basic_run_example/setup.org
 - spec/converge_examples/basic_tangle/conf.yml.expected
 - spec/converge_examples/basic_tangle/setup.org
+- spec/converge_examples/commented_block/run.org
 - spec/converge_examples/runlist_example/setup.org
+- spec/converge_examples/specified_block/run.org
 - spec/converge_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/wallyqs/org-converge
@@ -117,7 +119,9 @@ test_files:
 - spec/converge_examples/basic_run_example/setup.org
 - spec/converge_examples/basic_tangle/conf.yml.expected
 - spec/converge_examples/basic_tangle/setup.org
+- spec/converge_examples/commented_block/run.org
 - spec/converge_examples/runlist_example/setup.org
+- spec/converge_examples/specified_block/run.org
 - spec/converge_spec.rb
 - spec/spec_helper.rb
 has_rdoc: