neruda 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f5fb5997c152378f937f4b226182001790d4c35
-  data.tar.gz: 5fd12f03ac8acdab7a6f26e03226a0dba2a39ee6
+  metadata.gz: 1fec1e086d008db01ac799fc96019a2b04f284f5
+  data.tar.gz: bdd74e72f8116cf2c1156f085eb41c2b23744b1a
 SHA512:
-  metadata.gz: dc0c38d5bfce0fd5c82e39fe0aedc5596a15e4e38a0d2b0fc400959708fc23b22f4feb5fa96691a0059e034791529f4ff927e21dde2559e1a82ca65daf2b2fd5
-  data.tar.gz: 81112c53025ca25ebcd6a64927455556948c486d0a05d624d1d8c502a54174dc7f5d70d8e0badf7fa3ffaf64eab67c3f385de3cd85d858fe1b8b46fc9dec467e
+  metadata.gz: 9b08b4e4040c7ca5ec07f556b0b71dafaf141f6c25a2027188569a60661e5c0dc6354ed8efc1a22adc16ba43322f9c633d092656eb697efb60198226fc7e6452
+  data.tar.gz: 2b8457ae617246c0c96ac522d9cc3d0036daee5ae14089d74656bdb7e5b57a37b4d77fcb0aa646628b53b33b00d1dc846a47dba904945669b706151145228964

data/README.org

@@ -3,11 +3,14 @@
 *Neruda* is a little [[http://sinatrarb.com][Sinatra]] app, which aims to offer a quick access for
 writers to web publication. It is named in memory of Pablo Neruda.
 
+Source code is available on my [[https://git.deparis.io/neruda][cgit instance]], while issues should be
+followed on my [[https://projects.deparis.io/projects/neruda][redmine instance]].
+
 * Install
 
 These installation instructions use [[https://rvm.io][rvm]] as ruby provider. If you want to
 use rbenv or your system ruby, please refer to their specific
-documentation to know how to install ruby 2.4 and [[https://bundler.io/][bundler]].
+documentation to know how to install ruby 2.4.
 
 First we need to upgrade rvm (always do that from time to time):
 
@@ -20,9 +23,7 @@ Then the installation itself:
 
 #+begin_src shell
 $ mkdir mysite
-$ rvm use ruby-2.4.1
-$ rvm gemset create neruda
-$ rvm gemset use neruda
+$ rvm use ruby-2.4.1@neruda --create
 $ gem install neruda
 #+end_src
 
@@ -30,6 +31,7 @@ Finally, you need to configure it to your needs.
 
 #+begin_src shell
 $ pablo init
+$ bundle install
 #+end_src
 
 * Running it
@@ -49,7 +51,56 @@ $ APP_ENV=production pablo start
 To stop it, just enter =ctrl+C= if you are in development mode or enter
 =pablo stop= in production mode.
 
-You can now start your first chapter: =pablo new=
+* Pablo command
+
+In order to manage you Neruda installation, this gem provides a little
+helper called =pablo=. You already used it to =init=, =start= and =stop=
+your local installation. It can do a little more.
+
+** New
+
+=pablo new [article title]= will open your favorite text editor to let
+you write a new chapter to your book.
+
+If you don't provide a title to the command, =pablo= will ask you for
+one before launching your editor.
+
+If you don't have configured the =EDITOR= or =VISUAL= environnement
+variable, =pablo= will default to Gnu Emacs.
+
+** Compile
+
+=pablo compile= will first convert your orphaned org files (the ones
+without a corresponding epub file), then producing the global epub book,
+made with all your chapters.
+
+** Capify
+
+=pablo capify= will add the correct references to Neruda rake tasks in
+your =Capfile=, what will allow you to call them as part of your
+deployment workflow.
+
+You can add the =chapters:sync= task:
+
+#+begin_src ruby
+after 'deploy:finishing', 'chapters:sync'
+#+end_src
+
+This task depends on all the following. Or you can just select a bunch
+of them:
+
+#+begin_src ruby
+after 'deploy:finishing', 'chapters:build_epubs'
+after 'deploy:finishing', 'chapters:upload_epubs'
+after 'deploy:finishing', 'chapters:upload_book'
+after 'deploy:finishing', 'chapters:purge:remote'
+#+end_src
+
+Don't forget to restart the remote sinatra server:
+
+#+begin_src ruby
+after 'deploy:finished', 'sinatra:restart:remote'
+#+end_src
 
 * Known issues
 

data/bin/pablo

@@ -1,33 +1,36 @@
 #!/usr/bin/env ruby
+# coding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
+require 'rainbow'
 require 'fileutils'
 
 def help
   unless File.exist? 'config/config.yml'
-    STDERR.puts 'Please init your website: pablo init'
+    STDERR.puts 'Please init your website: ' +
+                Rainbow('pablo init').yellow
     exit 1
   end
 
-  options = ['start', 'stop', 'new']
+  options = ['start', 'stop', 'new', 'compile']
   options << 'capify' if File.exist? 'Capfile'
 
-  STDERR.puts "pablo [ #{options.join(' | ')} ]"
-  exit 1
+  STDERR.puts 'Usage: ' + Rainbow("pablo [ #{options.join(' | ')} ]").yellow
 end
 
 def capify
   unless File.exist? 'Capfile'
-    STDERR.puts 'Capfile does not exist. Aborting'
+    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
+  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
@@ -78,20 +81,60 @@ def _init_rackup
   end
 
   return if File.exist? 'config.ru'
-  rackup_conf = <<EOF
-# frozen_string_literal: true
+  rackup_conf = <<~EOF
+    # frozen_string_literal: true
 
-require 'neruda'
-run Neruda::App
-EOF
+    require 'neruda'
+    run Neruda::App
+  EOF
   IO.write('config.ru', rackup_conf)
 end
 
+def _init_bundler
+  # 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'
+
+    gem 'neruda'
+    #{markup_gem}
+
+    group :development do
+      gem 'capistrano'
+      gem 'capistrano-bundler'
+      gem 'capistrano-rvm'
+      gem 'rubocop'
+    end
+  EOF
+  IO.write('Gemfile', gemfile)
+end
+
 def init
+  puts Rainbow('Creating main folders…').green
   _init_path
+  puts Rainbow('Populating config file…').green
   _init_config
+  puts Rainbow('Copying template files…').green
   _init_assets
+  puts Rainbow('Installing rake and bundler files…').green
   _init_rackup
+  _init_bundler
+  puts Rainbow('Neruda has been successfully installed.').green
+  puts ''
+  puts 'To complete this installation, you must now run: ' +
+       Rainbow('bundle install').yellow
 end
 
 def create_new(title)
@@ -103,18 +146,17 @@ def create_new(title)
 
   filename = "private/orgs/#{filename}.org"
 
-  if 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']}
+  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']}
 
 
-EOF
-  end
+  EOF
 
-  editor = ENV['EDITOR'] || 'emacs'
+  editor = ENV['EDITOR'] || ENV['VISUAL'] || 'emacs'
   exec editor, filename
 end
 
@@ -125,16 +167,18 @@ elsif ARGV[0] == 'capify'
   capify
 
 elsif ['start', 'run'].include?(ARGV[0])
-  puts 'You can also start neruda with the following command:'
-  puts 'rake sinatra:start'
-
-  exec 'rake', 'sinatra:start'
+  puts Rainbow('bundle exec rake sinatra:start').green
+  system 'bundle', 'exec', 'rake', 'sinatra:start'
 
 elsif ARGV[0] == 'stop'
-  puts 'You can also stop neruda with the following command:'
-  puts 'rake sinatra:stop'
-
-  exec 'rake', 'sinatra:stop'
+  puts Rainbow('bundle exec rake sinatra:stop').green
+  system 'bundle', 'exec', 'rake', 'sinatra:stop'
+
+elsif ARGV[0] == 'compile'
+  puts Rainbow('bundle exec rake chapters:build_epubs').green
+  system 'bundle', 'exec', 'rake', 'chapters:build_epubs'
+  puts Rainbow('bundle exec rake chapters:make_book').green
+  system 'bundle', 'exec', 'rake', 'chapters:make_book'
 
 elsif ARGV[0] == 'new'
   if ARGV[1].nil?

data/lib/tasks/capistrano/chapters.rake

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 namespace :chapters do
-
   desc 'Upload epub files listed in tmp/epub_to_upload.yml'
   task :upload_epubs do
     next unless File.exist?('tmp/epub_to_upload.yml')
@@ -32,7 +33,12 @@ namespace :chapters do
       final_org = neruda_config['book_filename'] || 'all'
       on roles(:app) do
         within release_path do
-          epub_files = capture :ls, '-1', 'private/epubs/*.epub'
+          begin
+            epub_files = capture :ls, '-1', 'private/epubs/*.epub'
+          rescue SSHKit::Command::Failed
+            warn 'No epub files found. Aborting.'
+            next
+          end
           epub_files.each_line do |filename|
             filename.delete!("\n")
             file_radix = File.basename(filename, '.epub')
@@ -46,4 +52,9 @@ namespace :chapters do
       end
     end
   end
+
+  desc 'Execute in one call the following: :build_epubs,' \
+       ':upload_epubs, :upload_book, :purge:remote'
+  task sync: ['chapters:build_epubs', 'chapters:upload_epubs',
+              'chapters:upload_book', 'chapters:purge:remote']
 end

data/lib/tasks/chapters.rake

@@ -45,7 +45,7 @@ namespace :chapters do
       next if file_radix == 'index'
       epub_file = "private/epubs/#{file_radix}.epub"
       epub_to_upload << epub_file
-      execute :pandoc, '-S', "-o #{epub_file}", filename
+      system 'pandoc', '-S', "-o #{epub_file}", filename
     end
     next if epub_to_upload.empty?
     IO.write('tmp/epub_to_upload.yml', epub_to_upload.to_yaml)

data/lib/tasks/sinatra.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :sinatra do
   desc 'Stop the underlaying sinatra application'
   task :stop do
@@ -15,7 +17,7 @@ namespace :sinatra do
     loc_env = ENV['APP_ENV'] || 'development'
     cmd = ['rackup', "-E #{loc_env}", '-P', 'tmp/pids/neruda.pid']
     cmd << '-D' if loc_env == 'production'
-    exec cmd.join(' ')
+    system cmd.join(' ')
   end
 
   desc 'Restart local sinatra server'

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: neruda
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: org-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Write your org files, we take care of the rest.
+description: |
+  A simplistic way to publish a book online.
+  Write your org files, we take care of the rest.
 email: etienne@depar.is
 executables:
 - pablo
@@ -90,7 +120,7 @@ files:
 - lib/tasks/capistrano/sinatra.rake
 - lib/tasks/chapters.rake
 - lib/tasks/sinatra.rake
-homepage: https://git.deparis.io/neruda/
+homepage: https://git.deparis.io/neruda/about/
 licenses:
 - WTFPL
 metadata: {}
@@ -102,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="