re-org 0.0.1 → 0.0.2

data/README.org

@@ -13,7 +13,7 @@ to re-organize the files in a less chaotic manner.
 =re-org= is distributed using =rubygems=:
 
 #+begin_src sh
-    $ gem install re-org
+$ gem install re-org
 #+end_src
 
 ** Usage
@@ -22,31 +22,96 @@ The idea here is to have a pair of ~todo~ and ~done~ folders.
 Writings that are still in progress would go into the ~todo~ folder
 and those that are considered as finished can go into the ~done~ directory.
 
+Let's say that we want to create a new writing:
+
 #+begin_src sh
-re-org
+$ re-org new writing
+#+end_src
+
+This would create a file at =todo/2013-12-09-november.org= with the
+following contents below that we can use to just start writing:
+
+#+begin_src org
+  # -*- mode: org -*-
+  ,#+OPTIONS:      ^:nil
+  ,#+TITLE:        November
+  ,#+DATE:         2013-12-09
+  ,#+STARTUP:      showeverything
+  ,#+NOTEBOOK:     re-org
+  
+  ,* 
+    :PROPERTIES:
+    :DATE:     2013-12-09 
+    :NOTEBOOK: re-org
+    :END:
+  
+  ,* COMMENT ________
+  # Local Variables:
+  # eval: (auto-fill-mode t)
+  # eval: (progn (goto-line 0)(re-search-forward ":PROPERTIES:") (org-narrow-to-subtree))
+  # End:
 #+end_src
 
-(the name of these folders could depend of the project, and it marks the difference
-between the drafts and finished folders.
+That above is using the ~writing~ template that I like using for
+starting a new text that I don't usually would publish.
 
-For example, in Jekyll the name of these folders would be ~_drafts~
-and ~_posts~.
+We can inspect at the available templates as follows:
 
-- I suppose there is another kind of folder which works as the outline
-  of the work that is being done. (~_clockfiles~?). Maintenance of
-  this file is usually done per month from my experience.
-  ~re-org~ helps to create a new file by using the same template.
+#+begin_src sh
+    $ re-org templates
+    
+    * Default Templates
+    
+    - clockfile.org (default)
+    - jekyll-post.org       (default)
+    - notebook.org  (default)
+    - writing.org   (default)
+    
+    $ re-org templates --name=writing.org
+  # -*- mode: org -*-
+  ,#+OPTIONS: ^:nil
+  ,#+TITLE: <%= @org[:title] %>
+  ,#+DATE:  <%= @org[:date] %>
+  ,#+STARTUP: showeverything
+  ,#+NOTEBOOK: <%= @org[:notebook] %>
+  
+  ,* 
+    :PROPERTIES:
+    :DATE:     <%= @org[:date] %> 
+    :NOTEBOOK: <%= @org[:notebook] %>
+    :END:
   
-  Digressions on the site itself also would go here.
   
-  These kind of entries are much more useful to post them to a site
-  (like ~org-remote~) where you can track and see them published on a per Headline basis
-  by using what is included in the ~PROPERTIES~ drawer and ~CLOCK~.
+  ,* COMMENT ________
+  # Local Variables:
+  # eval: (auto-fill-mode t)
+  # eval: (progn (goto-line 0)(re-search-forward ":PROPERTIES:") (org-narrow-to-subtree))
+  # End:
+#+end_src
+
+A more interesting would be when preparing a Jekyll blog post.
+~re-org~ currently detects whether the project is a Jekyll project or
+not by checking whether a =_config.yml= exists at the =APP_ROOT=.
+When using Jekyll, ~re-org~ expects that the name of the folders 
+would be ~_drafts~ and ~_posts~.
+
+We can use the included template for Jekyll like this:
+
+#+begin_src sh
+re-org new jekyll-post --title=using-jekyll-and-org-mode
+#+end_src
 
-#+begin_src sh :results output
-bundle exec ruby bin/re-org --help
+...and this would create a file at =_drafts/2013-12-06-using-jekyll-and-org-mode=
+
+#+begin_src org
+  ,#+title:         Using jekyll and org mode
+  ,#+date:          2013-12-09
+  ,#+layout:        post
+  ,#+category:      posts
 #+end_src
 
+Other ideas are still a work in progress at this point.
+
 ** Contributing
 
 1. Fork it

data/TODO.org

@@ -3,8 +3,8 @@
 - [X] Create new file with current datetime
 - [X] Put the current writings in =todo= directory
 - [X] Allow to use different templates
+- [X] Make it possible to set a =templates= directory
+- [X] Add examples to README.org
 - [ ] Completed and organized files go to the =done= folder.
-- [ ] Make it possible to set a =templates= directory
 - [ ] Load an Org mode file, do some changes to it, and then export it again to Org
   + Needs work on this =org-ruby= branch: [[https://github.com/wallyqs/org-ruby/commits/feature/org-exporter][link]]
-- [ ] Add examples to README.org

data/bin/re-org

@@ -8,7 +8,7 @@ doc = <<OPTIONS
 re-org: A tool to help re-organize your texts written in Org mode
 
 Usage:
-  re-org new <template>   [--notebook=<notebook>] [--title=<title>]
+  re-org new <template>   [--notebook=<notebook>] [--title=<title>]  [--path=<path>]
   re-org status           [--notebook=<notebook>] [--count-keywords]
   re-org templates        [--name=<name>]
 

data/lib/re-org/command.rb

@@ -89,9 +89,9 @@ module ReOrg
       @org = OrgFile.new({ :title => @options["--title"],
                            :template => @options["<template>"],
                            :notebook => @options["<notebook>"] || @options["--notebook"],
-                           :path => @options["--path"]
+                           :path     => @options["--path"]
                          })
-      OrgFile.prepare_directories(@org)
+      OrgFile.prepare_directories(@org) unless @options["--path"]
 
       c = 1
       while File.exists?(@org[:file])

data/lib/re-org/org_file.rb

@@ -8,11 +8,12 @@ module ReOrg
 
     def initialize(opts={})
       @options = opts
+
       @options[:title]         ||= 'Untitled'
       @options[:time]            = Time.now
       @options[:date]            = Time.at(@options[:time]).strftime("%Y-%m-%d")
       @options[:org_format_date] = org_format_date(@options[:time])
-      @options[:todo_dir]      ||= OrgFile.todo_dir
+      @options[:todo_dir]      ||= @options[:path] || OrgFile.todo_dir
       @options[:done_dir]      ||= OrgFile.done_dir
       @options[:notebook]      ||= File.basename(File.expand_path('.'))
       @options[:filename]        = resolve_filename

data/lib/re-org/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: re-org
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
-  requirement: &70292512920380 !ruby/object:Gem::Requirement
+  requirement: &70115363142000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292512920380
+  version_requirements: *70115363142000
 - !ruby/object:Gem::Dependency
   name: org-ruby
-  requirement: &70292512916760 !ruby/object:Gem::Requirement
+  requirement: &70115363141580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292512916760
+  version_requirements: *70115363141580
 description: An Org mode file organizer
 email:
 - waldemar.quevedo@gmail.com