neruda 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 763f0127b37c30ad1d8bf6217259349364b5b0c3
-  data.tar.gz: e1e24d906ba72ff2432b27d2bafb960dd068b281
+  metadata.gz: e7b04958f3e5482160f89ecc7fda88258c6fc521
+  data.tar.gz: 0b534ba550a1a09068e39b37ee7194e45a22c54b
 SHA512:
-  metadata.gz: f5067b657dc79aa4cec67e5be77d6cf475e3ee29a83da58a0583f502ae2fc55b44072577b6b17e90df46effc2e59fe214b02927bf2827f093525e6451d2e9c95
-  data.tar.gz: b1c4ffd1196f3c65267fca521bdb92a983888ec8b64d310262b7a4e437debd748334b9af16307609415cbc41062ad571d9cdd805c9b7671fcdf455e59bba43e1
+  metadata.gz: b16aa22a09ca945a513280104244b20298e9a2fb7d992d41ceb65479bd9307a8053778e804d5c0daae0371825e2b2f5762373bd0a34035f747a71894d21e35ad
+  data.tar.gz: 26992b799de7fcbada2dfc2bc1e0f624d13f806c77ebd43fa0c96595bce5b06a5eccee5c46051003a0d8f5955774066582128719b593f69610cb0079612a6eff

data/bin/pablo

@@ -4,117 +4,107 @@
 
 require 'yaml'
 require 'rainbow'
+require 'optparse'
 require 'fileutils'
 
-def help
-  unless File.exist? 'config/config.yml'
-    STDERR.puts 'Please init your website: ' +
-                Rainbow('pablo init').yellow
-    exit 1
+# Methods used to play with bundler
+module BundlerHelper
+  def bundler_is_present?
+    return false unless File.exist?('Gemfile')
+    ENV['PATH'].split(':').each do |folder|
+      return true if File.exist? File.join(folder, 'bundle')
+    end
+    false
   end
 
-  options = ['start', 'stop', 'new', 'compile']
-  options << 'capify' if File.exist? 'Capfile'
-
-  STDERR.puts 'Usage: ' + Rainbow("pablo [ #{options.join(' | ')} ]").yellow
-end
-
-def bundler_is_present?
-  ENV['PATH'].split(':').each do |folder|
-    return true if File.exist? File.join(folder, 'bundle')
+  def rake_or_bundle_run(cmd)
+    cmd.insert(1, '-s') unless @options[:verbose]
+    cmd = ['bundle', 'exec'] + cmd if bundler_is_present?
+    puts Rainbow(cmd.join(' ')).blue if @options[:verbose]
+    exec(*cmd)
   end
-  false
 end
 
-def capify
-  unless File.exist? 'Capfile'
-    STDERR.puts Rainbow('ERROR: Capfile does not exist.').red
-    exit 1
+# Methods used with pablo init method
+module PabloInit
+  def init_path
+    FileUtils.mkdir_p 'config'
+    FileUtils.mkdir_p 'public'
+    FileUtils.mkdir_p 'tmp/pids'
+    FileUtils.mkdir_p 'private/characters'
+    FileUtils.mkdir_p 'private/sceneries'
+    FileUtils.mkdir_p 'private/chapters'
+    FileUtils.mkdir_p 'private/notes'
+    FileUtils.mkdir_p 'private/epubs'
   end
 
-  capfile = File.new('Capfile', 'a')
-  capfile.write <<~EOF
-    neruda_spec = Gem::Specification.find_by_name 'neruda'
-    Dir.glob("\#{neruda_spec.gem_dir}/lib/tasks/*.rake").each { |r| import r }
-    Dir.glob("\#{neruda_spec.gem_dir}/lib/tasks/capistrano/*.rake").each { |r| import r }
-  EOF
-end
-
-def _init_path
-  FileUtils.mkdir_p 'config'
-  FileUtils.mkdir_p 'public'
-  FileUtils.mkdir_p 'tmp/pids'
-  FileUtils.mkdir_p 'private/orgs'
-  FileUtils.mkdir_p 'private/epubs'
-end
+  def init_config
+    config = {}
+    print 'Name of your website: '
+    config['title'] = STDIN.gets.strip
+    print 'Your author name: '
+    config['author'] = STDIN.gets.strip
+    print 'Main language of your website [en_US]: '
+    lang = STDIN.gets.strip
+    lang = 'en_US' if lang == ''
+    config['lang'] = lang
+
+    main_title = config['title'].tr(' ', '_').downcase.gsub(/[^a-z0-9_]/, '')
+    print "Filename of the main generated epub [#{main_title}]: "
+    epub = STDIN.gets.strip
+    if epub == ''
+      epub = main_title
+    else
+      epub = File.basename(epub, '.epub')
+    end
+    config['book_filename'] = epub
+    config['chapters'] = []
 
-def _init_config
-  config = {}
-  print 'Name of your website: '
-  config['title'] = STDIN.gets.strip
-  print 'Your author name: '
-  config['author'] = STDIN.gets.strip
-  print 'Main language of your website [en_US]: '
-  lang = STDIN.gets.strip
-  lang = 'en_US' if lang == ''
-  config['lang'] = lang
-
-  main_title = config['title'].tr(' ', '_').downcase.gsub(/[^a-z0-9_]/, '')
-  print "Filename of the main generated epub [#{main_title}]: "
-  epub = STDIN.gets.strip
-  if epub == ''
-    epub = main_title
-  else
-    epub = File.basename(epub, '.epub')
+    IO.write 'config/config.yml', config.to_yaml
   end
-  config['book_filename'] = epub
-  config['chapters'] = []
 
-  IO.write 'config/config.yml', config.to_yaml
-end
+  def init_assets
+    unless Dir.exist? 'views'
+      FileUtils.cp_r File.join(__dir__, '../lib/assets'), 'views'
+    end
 
-def _init_assets
-  unless Dir.exist? 'views'
-    FileUtils.cp_r File.join(__dir__, '../lib/assets'), 'views'
+    return if File.exist? 'public/style.css'
+    FileUtils.mv 'views/style.css', 'public/style.css'
   end
 
-  return if File.exist? 'public/style.css'
-  FileUtils.mv 'views/style.css', 'public/style.css'
-end
-
-def _init_rackup
-  unless File.exist? 'Rakefile'
-    FileUtils.copy File.join(__dir__, '../docs/Rakefile.example'), 'Rakefile'
-  end
+  def init_rackup
+    unless File.exist? 'Rakefile'
+      FileUtils.copy File.join(__dir__, '../docs/Rakefile.example'), 'Rakefile'
+    end
 
-  return if File.exist? 'config.ru'
-  rackup_conf = <<~EOF
+    return if File.exist? 'config.ru'
+    rackup_conf = <<~EOF
     # frozen_string_literal: true
 
     require 'neruda'
     run Neruda::App
   EOF
-  IO.write('config.ru', rackup_conf)
-end
+    IO.write('config.ru', rackup_conf)
+  end
 
-def _init_bundler
-  return if File.exist? 'Gemfile'
-  puts ''
-  puts 'Bundler has been detected in your path.'
-  # puts ''
-  # print 'Do you want to use [o]rg files, [m]arkdown files or [b]oth' \
-  #       ' (default is org): '
-  # markup = STDIN.gets.strip.downcase
-  # if markup == 'm'
-  #   markup_gem = 'gem \'kramdown\''
-  # elsif markup == 'b'
-  #   markup_gem = "gem 'kramdown'\ngem 'org-ruby'"
-  # else
-  #   markup_gem = 'gem \'org-ruby\''
-  # end
-  markup_gem = 'gem \'org-ruby\''
-
-  gemfile = <<~EOF
+  def init_bundler
+    return if File.exist? 'Gemfile'
+    puts ''
+    puts 'Bundler has been detected in your path.'
+    # puts ''
+    # print 'Do you want to use [o]rg files, [m]arkdown files or [b]oth' \
+    #       ' (default is org): '
+    # markup = STDIN.gets.strip.downcase
+    # if markup == 'm'
+    #   markup_gem = 'gem \'kramdown\''
+    # elsif markup == 'b'
+    #   markup_gem = "gem 'kramdown'\ngem 'org-ruby'"
+    # else
+    #   markup_gem = 'gem \'org-ruby\''
+    # end
+    markup_gem = 'gem \'org-ruby\''
+
+    gemfile = <<~EOF
     # frozen_string_literal: true
 
     source 'https://rubygems.org'
@@ -129,102 +119,159 @@ def _init_bundler
       gem 'rubocop'
     end
   EOF
-  IO.write('Gemfile', gemfile)
-  puts ''
-  puts 'To complete this installation, you must now run: ' +
-       Rainbow('bundle install').yellow
+    IO.write('Gemfile', gemfile)
+    puts ''
+    puts 'To complete this installation, you must now run: ' +
+         Rainbow('bundle install').yellow
+  end
 end
 
-def init
-  puts Rainbow('Creating main folders…').blue
-  _init_path
-  puts Rainbow('Populating config file…').blue
-  _init_config
-  puts Rainbow('Copying template files…').blue
-  _init_assets
-  puts Rainbow('Installing rake files…').blue
-  _init_rackup
-  puts ''
-  puts Rainbow('Neruda has been successfully installed.').green
-  _init_bundler if bundler_is_present?
-end
+# Main pablo class
+class Pablo
+  def initialize
+    @options = {
+      verbose: false
+    }
 
-def create_new(title)
-  if title == ''
-    filename = 'new'
-  else
-    filename = title.tr(' ', '_').downcase.gsub(/[^a-z0-9_]/, '')
-  end
+    parse_options
 
-  filename = "private/orgs/#{filename}.org"
+    if ARGV[0] == 'init'
+      pablo_init
 
-  FileUtils.mkdir_p 'private/orgs' unless Dir.exist? 'private/orgs'
-  config = YAML.load_file('config/config.yml')
-  IO.write filename, <<~EOF
-    #+title: #{title}
-    #+date: <#{Date.today.strftime('%Y-%m-%d %a.')}>
-    #+author: #{config['author']}
+    elsif ARGV[0] == 'capify'
+      capify
 
+    elsif ['start', 'run'].include?(ARGV[0])
+      start
 
-  EOF
+    elsif ARGV[0] == 'stop'
+      rake_or_bundle_run ['rake', 'sinatra:stop']
 
-  editor = ENV['EDITOR'] || ENV['VISUAL'] || 'emacs'
-  exec editor, filename
-end
+    elsif ARGV[0] == 'compile'
+      rake_or_bundle_run ['rake', 'chapters:build_epubs']
+    # rake_or_bundle_run ['rake', 'book:make']
 
-if ARGV[0] == 'init'
-  init
+    elsif ARGV[0] == 'new'
+      new_chapter
 
-elsif ARGV[0] == 'capify'
-  capify
+    elsif ARGV[0] == 'list'
+      list
 
-elsif ['start', 'run'].include?(ARGV[0])
-  loc_env = ENV['APP_ENV'] || 'development'
-  if loc_env != 'production'
-    puts Rainbow("Neruda is run in #{loc_env} environment").green
-  else
-    puts Rainbow('>> Neruda is run in production environment <<').yellow
+    elsif ARGV[0] == 'board'
+      tiddly_file = 'private/notes/tiddly.html'
+      unless File.exist? tiddly_file
+        FileUtils.copy File.join(__dir__, '../lib/tiddly.html'), tiddly_file
+      end
+      exec 'gio', 'open', tiddly_file
+    end
   end
-  puts ''
-  if bundler_is_present?
-    puts Rainbow('bundle exec rake sinatra:start').blue
-    exec 'bundle', 'exec', 'rake', 'sinatra:start'
-  else
-    puts Rainbow('rake sinatra:start').blue
-    exec 'rake', 'sinatra:start'
+
+  private
+
+  def parse_options
+    optparse = OptionParser.new do |opts|
+      opts.banner = <<~EOF
+        Usage:
+            pablo init
+            pablo [options] #{pablo_banner} [params]
+
+      EOF
+      opts.on('-v', '--verbose', 'Output more information') do
+        @options[:verbose] = true
+      end
+      opts.on('-h', '--help', 'Display this screen') do
+        STDERR.puts opts
+        STDERR.puts <<~EOF
+
+          Commands:
+              init   : Initialize your Neruda instance
+              start  : Start the rack web server (default is thin)
+              stop   : Stop the web server
+              compile: Generate the epubs files
+              list   : List various book elements
+
+          Chapters related commands:
+              new [title] : Create a new chapter
+
+        EOF
+        exit
+      end
+    end
+
+    optparse.parse!
+
+    return if ARGV[0]
+    STDERR.puts Rainbow('ERROR: no command given. Run pablo -h for ' \
+                        'options and available commands').red
+    exit 1
   end
 
-elsif ARGV[0] == 'stop'
-  if bundler_is_present?
-    puts Rainbow('bundle exec rake sinatra:stop').blue
-    exec 'bundle', 'exec', 'rake', 'sinatra:stop'
-  else
-    puts Rainbow('rake sinatra:stop').blue
-    exec 'rake', 'sinatra:stop'
+  include BundlerHelper
+  include PabloInit
+
+  def pablo_banner
+    options = ['start', 'stop', 'new', 'compile', 'list']
+    options << 'capify' if File.exist? 'Capfile'
+
+    "[ #{options.join(' | ')} ]"
   end
 
-elsif ARGV[0] == 'compile'
-  if bundler_is_present?
-    puts Rainbow('bundle exec rake chapters:build_epubs').blue
-    exec 'bundle', 'exec', 'rake', 'chapters:build_epubs'
-    puts Rainbow('bundle exec rake chapters:make_book').blue
-    exec 'bundle', 'exec', 'rake', 'chapters:make_book'
-  else
-    puts Rainbow('rake chapters:build_epubs').blue
-    exec 'rake', 'chapters:build_epubs'
-    puts Rainbow('rake chapters:make_book').blue
-    exec 'rake', 'chapters:make_book'
+  def pablo_init
+    puts Rainbow('Creating main folders…').blue
+    init_path
+    puts Rainbow('Populating config file…').blue
+    init_config
+    puts Rainbow('Copying template files…').blue
+    init_assets
+    puts Rainbow('Installing rake files…').blue
+    init_rackup
+    puts ''
+    puts Rainbow('Neruda has been successfully installed.').green
+    init_bundler if bundler_is_present?
   end
 
-elsif ARGV[0] == 'new'
-  if ARGV[1].nil?
-    print 'Title: '
-    title = STDIN.gets.strip
-  else
-    title = ARGV[1]
+  def capify
+    unless File.exist? 'Capfile'
+      STDERR.puts Rainbow('ERROR: Capfile does not exist.').red
+      exit 1
+    end
+
+    capfile = File.new('Capfile', 'a')
+    capfile.write <<~EOF
+    neruda_spec = Gem::Specification.find_by_name 'neruda'
+    Dir.glob("\#{neruda_spec.gem_dir}/lib/tasks/*.rake").each { |r| import r }
+    Dir.glob("\#{neruda_spec.gem_dir}/lib/tasks/capistrano/*.rake").each { |r| import r }
+  EOF
+  end
+
+  def start
+    loc_env = ENV['APP_ENV'] || 'development'
+    if loc_env != 'production'
+      puts Rainbow("Neruda is run in #{loc_env} environment").green
+    else
+      puts Rainbow('>> Neruda is run in production environment <<').yellow
+    end
+    puts ''
+    rake_or_bundle_run ['rake', 'sinatra:start']
   end
-  create_new title
 
-else
-  help
+  def new_chapter
+    if ARGV[1].nil?
+      print 'Title: '
+      title = STDIN.gets.strip
+    else
+      title = ARGV[1]
+    end
+    rake_or_bundle_run ['rake', "chapters:new[#{title}]"]
+  end
+
+  def list
+    if ARGV[1].nil?
+      STDERR.puts Rainbow('ERROR: No list type given.').red
+      exit 1
+    end
+    rake_or_bundle_run ['rake', "book:list[#{ARGV[1]}]"]
+  end
 end
+
+Pablo.new

data/lib/neruda.rb

@@ -72,7 +72,7 @@ class Neruda::App < Sinatra::Base
   get '/' do
     @slug = 'index'
     text_content = ''
-    if File.exist? File.join('private', 'orgs', 'index.org')
+    if File.exist? File.join('private', 'index.org')
       find_chapter
       @content = Orgmode::Parser.load @org_file
       text_content = @content.to_html

data/lib/tasks/book.rake

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'rainbow'
+
+namespace :book do
+  desc 'List various book elements'
+  task :list, :list_type do |t, args|
+    list_type = args[:list_type]
+    next unless ['chapters', 'characters', 'sceneries'].include?(list_type)
+    Dir.glob("private/#{list_type}/*.org") do |filename|
+      file_radix = File.basename(filename, '.org')
+      title = file_radix.split('_').map(&:capitalize).join(' ')
+      absolute_filename = File.join(Dir.pwd, filename)
+      puts Rainbow(title).blue + ": #{absolute_filename}"
+    end
+  end
+
+  desc 'Create the org file of the complete book'
+  task prepare: 'chapters:index' do
+    chapters = YAML.load_file('config/chapters.yml')
+    next if chapters.nil?
+
+    neruda_config = YAML.load_file('config/config.yml')
+    final_org = neruda_config['book_filename'] || 'all'
+    final_org = "tmp/#{final_org}.org"
+
+    Dir.mkdir 'tmp' unless Dir.exist? 'tmp'
+    File.unlink final_org if File.exist? final_org
+
+    org_file = File.open(final_org, 'a')
+    org_file.write("#+title: #{neruda_config['title']}\n")
+    org_file.write("#+author: #{neruda_config['author']}\n")
+    org_file.write("#+rights: #{neruda_config['license']}\n")
+    org_file.write("#+language: #{neruda_config['lang']}\n\n")
+
+    chapters.each do |c|
+      file_radix = c[:slug]
+      filename = "private/chapters/#{file_radix}.org"
+      next unless File.exist? filename
+      file_content = IO.read(filename)
+      file_content.gsub!(/^#\+date:.*$/mi, '')
+      file_content.gsub!(/^#\+author:.*$/mi, '')
+      file_content.gsub!(/^(\*+)\s+(.*)$/mi, '*\1 \2')
+      file_content.gsub!(/^#\+title:\s?(.*)$/mi, '* \1')
+
+      org_file.write(file_content + "\n")
+    end
+    org_file.close
+
+    IO.write('tmp/org_to_convert.yml', [final_org].to_yaml)
+  end
+
+  task make: ['book:prepare', 'chapters:convert_org']
+end

data/lib/tasks/capistrano/chapters.rake

@@ -24,7 +24,7 @@ namespace :chapters do
   end
 
   desc 'Upload the complete book'
-  task upload_book: ['chapters:make_book', 'chapters:upload_epubs']
+  task upload_book: ['book:make', 'chapters:upload_epubs']
 
   namespace :purge do
     desc 'Remove remote orphaned epub files'
@@ -43,7 +43,7 @@ namespace :chapters do
             filename.delete!("\n")
             file_radix = File.basename(filename, '.epub')
             next if file_radix == final_org
-            org_file = "private/orgs/#{file_radix}.org"
+            org_file = "private/chapters/#{file_radix}.org"
             unless test("[ -e '#{release_path}/#{org_file}' ]")
               execute :rm, filename
             end

data/lib/tasks/capistrano/sinatra.rake

@@ -9,7 +9,7 @@ namespace :sinatra do
           if test("[ -e '#{release_path}/tmp/pids/sinatra.pid' ]")
             execute :pkill, '-F', 'tmp/pids/sinatra.pid'
           end
-          execute :rackup, '-E', fetch(:app_env),
+          execute :bundle, :exec, :rackup, '-E', fetch(:app_env),
                   '-P', 'tmp/pids/sinatra.pid', '-D'
         end
       end

data/lib/tasks/chapters.rake

@@ -11,8 +11,7 @@ namespace :chapters do
     chapters = neruda_config['chapters']
     next unless chapters.any?
     chapters.each do |file_radix|
-      next if file_radix == 'index'
-      filename = "private/orgs/#{file_radix}.org"
+      filename = "private/chapters/#{file_radix}.org"
       org_to_convert << filename
     end
     next if org_to_convert.empty?
@@ -44,7 +43,6 @@ namespace :chapters do
     epub_to_upload = []
     org_to_convert.each do |filename|
       file_radix = File.basename(filename, '.org')
-      next if file_radix == 'index'
       epub_file = "private/epubs/#{file_radix}.epub"
       epub_to_upload << epub_file
       sh 'pandoc', '-S', "-o #{epub_file}", filename
@@ -66,7 +64,7 @@ namespace :chapters do
     neruda_config = YAML.load_file('config/config.yml')
     final_org = neruda_config['book_filename'] || 'all'
     chapters = neruda_config['chapters']
-    Dir.glob('private/orgs/*.org') do |filename|
+    Dir.glob('private/chapters/*.org') do |filename|
       file_radix = File.basename(filename, '.org')
       unless chapters.include? file_radix
         STDERR.puts "WARNING: #{filename} exists but #{file_radix} " \
@@ -77,7 +75,7 @@ namespace :chapters do
     Dir.glob('private/epubs/*.epub') do |filename|
       file_radix = File.basename(filename, '.epub')
       next if file_radix == final_org
-      org_file = "private/orgs/#{file_radix}.org"
+      org_file = "private/chapters/#{file_radix}.org"
       File.unlink filename unless File.exist? org_file
     end
   end
@@ -89,7 +87,7 @@ namespace :chapters do
     next if neruda_config['chapters'].nil?
     chapters = []
     neruda_config['chapters'].each do |file_radix|
-      filename = "private/orgs/#{file_radix}.org"
+      filename = "private/chapters/#{file_radix}.org"
       next unless File.exist? filename
       f = Orgmode::Parser.load filename
       title = f.in_buffer_settings['TITLE']
@@ -98,40 +96,32 @@ namespace :chapters do
     IO.write('config/chapters.yml', chapters.to_yaml)
   end
 
-  desc 'Create the org file of the complete book'
-  task prepare_book: 'chapters:index' do
-    chapters = YAML.load_file('config/chapters.yml')
-    next if chapters.nil?
-
-    neruda_config = YAML.load_file('config/config.yml')
-    final_org = neruda_config['book_filename'] || 'all'
-    final_org = "tmp/#{final_org}.org"
+  desc 'Open an editor to create a new chapter'
+  task :new, :title do |_, args|
+    if args[:title] == ''
+      filename = 'new'
+    else
+      filename = args[:title].tr(' ', '_').downcase.gsub(/[^a-z0-9_]/, '')
+    end
 
-    Dir.mkdir 'tmp' unless Dir.exist? 'tmp'
-    File.unlink final_org if File.exist? final_org
+    filename = "private/chapters/#{filename}.org"
 
-    org_file = File.open(final_org, 'a')
-    org_file.write("#+title: #{neruda_config['title']}\n")
-    org_file.write("#+author: #{neruda_config['author']}\n")
-    org_file.write("#+rights: #{neruda_config['license']}\n")
-    org_file.write("#+language: #{neruda_config['lang']}\n\n")
+    unless File.exist? filename
+      config = YAML.load_file('config/config.yml')
+      IO.write filename, <<~EOF
+        #+title: #{args[:title]}
+        #+date: <#{Date.today.strftime('%Y-%m-%d %a.')}>
+        #+author: #{config['author']}
 
-    chapters.each do |c|
-      file_radix = c[:slug]
-      filename = "private/orgs/#{file_radix}.org"
-      next unless File.exist? filename
-      file_content = IO.read(filename)
-      file_content.gsub!(/^#\+date:.*$/mi, '')
-      file_content.gsub!(/^#\+author:.*$/mi, '')
-      file_content.gsub!(/^(\*+)\s+(.*)$/mi, '*\1 \2')
-      file_content.gsub!(/^#\+title:\s?(.*)$/mi, '* \1')
 
-      org_file.write(file_content + "\n")
+      EOF
     end
-    org_file.close
 
-    IO.write('tmp/org_to_convert.yml', [final_org].to_yaml)
+    editor = ENV['EDITOR'] || ENV['VISUAL'] || 'emacs'
+    if editor.match?(/^emacs/)
+      sh editor, '+5', filename
+    else
+      sh editor, filename
+    end
   end
-
-  task make_book: ['chapters:prepare_book', 'chapters:convert_org']
 end

data/lib/tasks/sinatra.rake

@@ -21,7 +21,7 @@ namespace :sinatra do
     cmd = ['rackup', "-E #{loc_env}", '-P', 'tmp/pids/neruda.pid']
     cmd << '-D' if loc_env == 'production'
     begin
-      sh cmd.join(' ')
+      sh(*cmd)
     rescue Interrupt
       puts Rainbow(' Kthxbye').blue
     end