re-org 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/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Waldemar Quevedo
+
+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.org

@@ -0,0 +1,56 @@
+* ReOrg
+
+An Org mode file organizer.
+
+** Motivation
+
+Instead of having tons of sparsed Org mode files everywhere,
+this project attemtps to give the Org mode writer a framework
+to re-organize the files in a less chaotic manner.
+
+** Installation
+
+=re-org= is distributed using =rubygems=:
+
+#+begin_src sh
+    $ gem install re-org
+#+end_src
+
+** Usage
+
+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.
+
+#+begin_src sh
+re-org
+#+end_src
+
+(the name of these folders could depend of the project, and it marks the difference
+between the drafts and finished folders.
+
+For example, in Jekyll the name of these folders would be ~_drafts~
+and ~_posts~.
+
+- 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.
+  
+  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~.
+
+#+begin_src sh :results output
+bundle exec ruby bin/re-org --help
+#+end_src
+
+** 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ["--format", "documentation", "--colour"]
+end

data/TODO.org

@@ -0,0 +1,10 @@
+# -*- mode: org -*-
+
+- [X] Create new file with current datetime
+- [X] Put the current writings in =todo= directory
+- [X] Allow to use different templates
+- [ ] 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

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+require 'docopt'
+require 're-org'
+
+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 status           [--notebook=<notebook>] [--count-keywords]
+  re-org templates        [--name=<name>]
+
+Options:
+
+  -h --help               Show this screen.
+  --version               Show this version.
+
+OPTIONS
+
+begin
+  require "pp"
+  cmd = Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end
+
+exit 1 unless cmd
+
+o = ReOrg::Command.new(cmd)
+o.execute!

data/lib/re-org.rb

@@ -0,0 +1,4 @@
+require "re-org/version"
+require "re-org/ext"
+require "re-org/org_file"
+require "re-org/command"

data/lib/re-org/command.rb

@@ -0,0 +1,126 @@
+require 'erb'
+require 'fileutils'
+require 'org-ruby'
+
+module ReOrg
+
+  class Command
+
+    CUSTOM_TEMPLATES_DIRS = ['templates', '_templates']
+
+    def initialize(options)
+      @options = options
+    end
+
+    def execute!
+      case true
+      when @options['new']
+        new_file
+      when @options['status']
+        show_status
+      when (@options['templates'] and not @options['--name'].nil?)
+        cat_template
+      when @options['templates']
+        show_templates
+      end
+    end
+
+    def show_status
+      puts '* Current Status'.yellow
+      puts ''
+      summary = Hash.new { |h,k| h[k] = {} }
+
+      org_files = Dir["#{OrgFile.todo_dir}/*"]
+      org_files.each do |org_file|
+        org_content = Orgmode::Parser.new(File.open(org_file).read)
+        if org_content.in_buffer_settings["NOTEBOOK"]
+          notebook_name = org_content.in_buffer_settings["NOTEBOOK"]
+          summary[notebook_name][:texts]    ||= []
+          summary[notebook_name][:keywords] ||= {}
+          summary[notebook_name][:texts] << org_content
+          keywords = org_content.headlines.map { |h| h.keyword }
+          keywords.each do |k|
+            summary[notebook_name][:keywords][k] ||= 0
+            summary[notebook_name][:keywords][k]  += 1
+          end
+        else
+          puts "Org file without notebook defined: #{org_file}".yellow
+        end
+      end
+
+      summary.each_pair do |notebook, info|
+        puts "- #{info[:texts].count} org files for '#{notebook}' notebook".green
+        info[:keywords].each do |keyword, count|
+          keyword ||= 'NONE'
+          puts "#{keyword}: #{count}"
+        end if @options["--count-keywords"]
+        info[:texts].each { |o| puts ["\t", o.headlines.first].join('')}
+      end
+    end
+
+    def show_templates
+      puts '* Default Templates'.yellow
+      puts ''
+      default_template_dir = File.expand_path("templates/", File.dirname(__FILE__))
+      default_templates = Dir["#{default_template_dir}/*"]
+      default_templates.each do |template|
+        puts "- #{File.basename(template)}\t(default)"
+      end
+
+      CUSTOM_TEMPLATES_DIRS.each do |template_dir|
+        if Dir.exists?(template_dir)
+          Dir["#{template_dir}/*"].each do |template|
+            puts "- #{File.basename(template)}\t(found at #{template_dir}/)"
+          end
+        end
+      end
+    end
+
+    def cat_template
+      default_template_dir = File.expand_path("templates/", File.dirname(__FILE__))
+      default_templates = Dir["#{default_template_dir}/*"]
+      template_name = default_templates.select { |path| File.basename(path) == @options['--name']}
+      puts File.open(template_name.first).read
+    rescue => e
+      puts "Could not fetch template '#{@options['--name']}'".red
+    end
+
+    def new_file
+      @org = OrgFile.new({ :title => @options["--title"],
+                           :template => @options["<template>"],
+                           :notebook => @options["<notebook>"] || @options["--notebook"],
+                           :path => @options["--path"]
+                         })
+      OrgFile.prepare_directories(@org)
+
+      c = 1
+      while File.exists?(@org[:file])
+        c += 1
+        @org[:filename] = Time.at(@org[:time]).strftime("%Y-%m-%d-%s-#{c}")
+        @org[:file]     = File.expand_path(File.join(@org[:todo_dir], "#{@org[:filename]}.org"))
+      end
+      template =  @org[:template] || 'writing'
+      template_file = find_template(template)
+      if not File.exists?(template_file)
+        puts "Could not find template `#{template}.org' at #{template_file}".red
+        exit 1
+      end
+      template = File.open(template_file).read
+      content = ERB.new(template).result(binding)
+      File.open(@org[:file], 'w') {|f| f.puts content }
+      puts content.yellow if ENV['DEBUG']
+      puts "Created a new writing at `#{@org[:file]}'".green
+    end
+
+    private
+    def find_template(template)
+      CUSTOM_TEMPLATES_DIRS.each do |template_dir|
+        if Dir.exists?(template_dir) and File.exists?(File.join(template_dir, "#{template}.org"))
+          return File.expand_path(File.join(template_dir, "#{template}.org"))
+        end
+      end
+
+      return File.expand_path(File.join('templates', "#{template}.org"), File.dirname(__FILE__))
+    end
+  end
+end

data/lib/re-org/ext.rb

@@ -0,0 +1,10 @@
+module StringWithColors
+  def red;    colorize("\e[0m\e[31m");  end
+  def green;  colorize("\e[0m\e[32m");  end
+  def yellow; colorize("\e[0m\e[33m");  end
+  def bold;   colorize("\e[0m\e[1m");   end
+  def colorize(color_code); "#{color_code}#{self}\e[0m"; end
+end
+class String
+  include StringWithColors
+end

data/lib/re-org/org_file.rb

@@ -0,0 +1,78 @@
+module ReOrg
+  class OrgFile
+
+    attr_accessor :options
+
+    DEFAULT_TODO_ORGS_DIR = 'todo'
+    DEFAULT_DONE_ORGS_DIR = 'done'
+
+    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[:done_dir]      ||= OrgFile.done_dir
+      @options[:notebook]      ||= File.basename(File.expand_path('.'))
+      @options[:filename]        = resolve_filename
+      @options[:file]            = File.expand_path(File.join(@options[:todo_dir], "#{@options[:filename]}.org"))
+    end
+
+    def []=(key, value)
+      @options[key] = value
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+    def org_format_date(time=nil)
+      time ||= @options[:time]
+      Time.at(time).strftime("[%Y-%m-%d %a]")
+    end
+
+    def resolve_filename
+      slug = slugify(@options[:title] || @options[:notebook])
+      Time.at(@options[:time]).strftime("%Y-%m-%d-#{slug}")
+    end
+
+    def slugify(name)
+      return nil unless name
+      name.gsub(/[\s.\/\\]/, '-').downcase
+    end
+
+    def self.prepare_directories(org={})
+      todo_dir = org[:path] || OrgFile.todo_dir
+      if not File.exists?(todo_dir)
+        puts "Creating working dir at `#{todo_dir}'".green
+        FileUtils.mkdir(todo_dir)
+      end
+    end
+
+    def self.path
+      File.expand_path(ENV['ORG_NOTEBOOKS_PATH'] || '.')
+    end
+
+    # FIXME: There should be a todo dir and a done dir?
+    def self.todo_dir
+      # Detect that we are on a Jekyll site and use _drafts
+      if File.exists?(File.expand_path('_config.yml', File.dirname('.'))) \
+        and Dir.exists?('_drafts')
+        File.expand_path('_drafts', File.dirname('.'))
+      else
+        File.expand_path("#{self.path}/#{DEFAULT_TODO_ORGS_DIR}", File.dirname('.'))
+      end
+    end
+
+    def self.done_dir
+      # Detect that we are on a Jekyll site and use _posts
+      if File.exists?(File.expand_path('_config.yml', File.dirname('.'))) \
+        and Dir.exists?('_posts')
+        File.expand_path('_posts', File.dirname('.'))
+      else
+        File.expand_path("#{self.path}/#{DEFAULT_DONE_ORGS_DIR}", File.dirname('.'))
+      end
+    end
+  end
+end

data/lib/re-org/templates/clockfile.org

@@ -0,0 +1,14 @@
+# -*- mode: org -*-
+#+OPTIONS: ^:nil
+#+TODO: TODO STARTED | DONE CANCELED
+#+DATE: <%= @org[:date] %>
+#+STARTUP: showeverything
+#+NOTEBOOK: <%= @org[:notebook] %>
+
+* [0/1] <%= @org[:org_format_date] %>
+  :PROPERTIES:
+  :DATE:     <%= @org[:date] %>
+  :NOTEBOOK: <%= @org[:notebook] %>
+  :END:
+
+** TODO 

data/lib/re-org/templates/jekyll-post.org

@@ -0,0 +1,5 @@
+#+title:         <%= @org[:title].capitalize.gsub("-", " ") %>
+#+date:          <%= @org[:date] %>
+#+layout:        post
+#+category:      posts
+

data/lib/re-org/templates/notebook.org

@@ -0,0 +1,8 @@
+# -*- mode: org -*-
+#+OPTIONS: ^:nil
+#+TITLE: <%= @org[:title] %>
+#+DATE:  <%= @org[:date] %>
+#+STARTUP: showeverything
+#+NOTEBOOK: <%= @org[:notebook] %>
+
+<%= @org[:content] %>

data/lib/re-org/templates/writing.org

@@ -0,0 +1,19 @@
+# -*- mode: org -*-
+#+OPTIONS: ^:nil
+#+TITLE: <%= @org[:title] %>
+#+DATE:  <%= @org[:date] %>
+#+STARTUP: showeverything
+#+NOTEBOOK: <%= @org[:notebook] %>
+
+* 
+  :PROPERTIES:
+  :DATE:     <%= @org[:date] %> 
+  :NOTEBOOK: <%= @org[:notebook] %>
+  :END:
+
+
+* COMMENT ________
+# Local Variables:
+# eval: (auto-fill-mode t)
+# eval: (progn (goto-line 0)(re-search-forward ":PROPERTIES:") (org-narrow-to-subtree))
+# End:

data/lib/re-org/version.rb

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

data/re-org.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/re-org/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Waldemar Quevedo"]
+  gem.email         = ["waldemar.quevedo@gmail.com"]
+  gem.description   = %q{An Org mode file organizer}
+  gem.summary       = %q{Instead of having tons of sparsed Org mode files everywhere, this project attemtps to give the Org mode writer a framework to re-organize the files in a less chaotic manner.
+}
+  gem.homepage      = "https://github.com/wallyqs/re-org"
+
+  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          = "re-org"
+  gem.require_paths = ["lib"]
+  gem.version       = ReOrg::VERSION
+  gem.add_dependency(%q<docopt>)
+  gem.add_dependency(%q<org-ruby>)
+end

data/spec/command_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe ReOrg::Command do
+  before(:all)  { $test_number = 0 }
+  before(:each) { 
+    @dir = "#{RESULTS_DIR}/#{$test_number}"
+    FileUtils.mkdir_p(@dir)
+    ENV['ORG_NOTEBOOKS_PATH'] = @dir
+  }
+  after(:each)  { $test_number += 1 }
+
+  context "when using `re-org new`" do
+    before(:each) do
+      @cmd = {
+        "new"        => true,
+        "<template>" => 'writing',
+        "--notebook" => nil,
+        "--title"    => "test-#{$test_number}",
+      }
+    end
+
+    it 'should create new writing for a notebook with --notebook option' do
+      @cmd['--notebook'] = 'tests'
+      o = ReOrg::Command.new(@cmd)
+      o.execute!
+      orgs = Dir["#{@dir}/todo/*"]
+      orgs.count.should == 1
+    end
+
+    it 'should create new clockfile when the template is choosen' do
+      @cmd['<template>'] = 'clockfile'
+      @cmd['--notebook'] = 'tests'
+      o = ReOrg::Command.new(@cmd)
+      o.execute!
+      orgs = Dir["#{@dir}/todo/*"]
+      orgs.count.should == 1
+    end
+
+    it 'should create new writing with --title option' do
+      @cmd['--notebook'] = 'tests'
+      @cmd['--title']    = 'Testing the title'
+      o = ReOrg::Command.new(@cmd)
+      o.execute!
+      orgs = Dir["#{@dir}/todo/*"]
+      orgs.count.should == 1
+    end
+  end
+
+  context "when using `re-org templates`" do 
+    before(:each) do
+      @cmd = {
+        "templates"   => true
+      }
+    end
+
+    it 'should display the currently installed templates' do
+      pending
+      o = ReOrg::Command.new(@cmd)
+      o.execute!
+    end
+  end
+end

data/spec/org_file_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'time'
+
+describe ReOrg::OrgFile do
+  before(:each) do
+    @org = ReOrg::OrgFile.new
+  end
+
+  it 'should create date in org format' do
+    date = Time.at(1377411362)
+    @org.org_format_date(date).should == '[2013-08-25 Sun]'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 're-org'
+require 'fileutils'
+
+RESULTS_DIR = File.expand_path("/tmp/#{Time.now.strftime("test_%s")}", File.dirname(__FILE__))
+FileUtils.mkdir_p(RESULTS_DIR)

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: re-org
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Waldemar Quevedo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: &70292512920380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70292512920380
+- !ruby/object:Gem::Dependency
+  name: org-ruby
+  requirement: &70292512916760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70292512916760
+description: An Org mode file organizer
+email:
+- waldemar.quevedo@gmail.com
+executables:
+- re-org
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.org
+- Rakefile
+- TODO.org
+- bin/re-org
+- lib/re-org.rb
+- lib/re-org/command.rb
+- lib/re-org/ext.rb
+- lib/re-org/org_file.rb
+- lib/re-org/templates/clockfile.org
+- lib/re-org/templates/jekyll-post.org
+- lib/re-org/templates/notebook.org
+- lib/re-org/templates/writing.org
+- lib/re-org/version.rb
+- re-org.gemspec
+- spec/command_spec.rb
+- spec/org_file_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wallyqs/re-org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Instead of having tons of sparsed Org mode files everywhere, this project
+  attemtps to give the Org mode writer a framework to re-organize the files in a less
+  chaotic manner.
+test_files:
+- spec/command_spec.rb
+- spec/org_file_spec.rb
+- spec/spec_helper.rb