neruda 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fec1e086d008db01ac799fc96019a2b04f284f5
-  data.tar.gz: bdd74e72f8116cf2c1156f085eb41c2b23744b1a
+  metadata.gz: 763f0127b37c30ad1d8bf6217259349364b5b0c3
+  data.tar.gz: e1e24d906ba72ff2432b27d2bafb960dd068b281
 SHA512:
-  metadata.gz: 9b08b4e4040c7ca5ec07f556b0b71dafaf141f6c25a2027188569a60661e5c0dc6354ed8efc1a22adc16ba43322f9c633d092656eb697efb60198226fc7e6452
-  data.tar.gz: 2b8457ae617246c0c96ac522d9cc3d0036daee5ae14089d74656bdb7e5b57a37b4d77fcb0aa646628b53b33b00d1dc846a47dba904945669b706151145228964
+  metadata.gz: f5067b657dc79aa4cec67e5be77d6cf475e3ee29a83da58a0583f502ae2fc55b44072577b6b17e90df46effc2e59fe214b02927bf2827f093525e6451d2e9c95
+  data.tar.gz: b1c4ffd1196f3c65267fca521bdb92a983888ec8b64d310262b7a4e437debd748334b9af16307609415cbc41062ad571d9cdd805c9b7671fcdf455e59bba43e1

data/README.md

@@ -0,0 +1,96 @@
+**Neruda** is a little [Sinatra](http://sinatrarb.com) 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 [cgit instance](https://git.deparis.io/neruda), while issues should be followed on my [redmine instance](https://projects.deparis.io/projects/neruda).
+
+Install
+=======
+
+These installation instructions use [rvm](https://rvm.io) 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.
+
+First we need to upgrade rvm (always do that from time to time):
+
+``` bash
+$ rvm get latest
+$ rvm install ruby-2.4.1
+```
+
+Then the installation itself:
+
+``` bash
+$ mkdir mysite
+$ rvm use ruby-2.4.1@neruda --create
+$ gem install neruda
+```
+
+Finally, you need to configure it to your needs.
+
+``` bash
+$ pablo init
+```
+
+Running it
+==========
+
+For testing it, you should just run:
+
+``` bash
+$ pablo start
+```
+
+For production use, just pass the right environnement variable:
+
+``` bash
+$ 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.
+
+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:
+
+``` ruby
+after 'deploy:finishing', 'chapters:sync'
+```
+
+This task depends on all the following. Or you can just select a bunch of them:
+
+``` 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'
+```
+
+Don't forget to restart the remote sinatra server:
+
+``` ruby
+after 'deploy:finished', 'sinatra:restart:remote'
+```
+
+Known issues
+============
+
+See [issues on redmine](https://projects.deparis.io/projects/neruda/issues).

data/bin/pablo

@@ -19,6 +19,13 @@ def help
   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')
+  end
+  false
+end
+
 def capify
   unless File.exist? 'Capfile'
     STDERR.puts Rainbow('ERROR: Capfile does not exist.').red
@@ -91,6 +98,10 @@ def _init_rackup
 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
@@ -119,22 +130,23 @@ def _init_bundler
     end
   EOF
   IO.write('Gemfile', gemfile)
+  puts ''
+  puts 'To complete this installation, you must now run: ' +
+       Rainbow('bundle install').yellow
 end
 
 def init
-  puts Rainbow('Creating main folders…').green
+  puts Rainbow('Creating main folders…').blue
   _init_path
-  puts Rainbow('Populating config file…').green
+  puts Rainbow('Populating config file…').blue
   _init_config
-  puts Rainbow('Copying template files…').green
+  puts Rainbow('Copying template files…').blue
   _init_assets
-  puts Rainbow('Installing rake and bundler files…').green
+  puts Rainbow('Installing rake files…').blue
   _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
+  puts Rainbow('Neruda has been successfully installed.').green
+  _init_bundler if bundler_is_present?
 end
 
 def create_new(title)
@@ -167,18 +179,42 @@ elsif ARGV[0] == 'capify'
   capify
 
 elsif ['start', 'run'].include?(ARGV[0])
-  puts Rainbow('bundle exec rake sinatra:start').green
-  system 'bundle', 'exec', 'rake', 'sinatra: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 ''
+  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'
+  end
 
 elsif ARGV[0] == 'stop'
-  puts Rainbow('bundle exec rake sinatra:stop').green
-  system 'bundle', 'exec', 'rake', 'sinatra: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'
+  end
 
 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'
+  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'
+  end
 
 elsif ARGV[0] == 'new'
   if ARGV[1].nil?
@@ -187,7 +223,6 @@ elsif ARGV[0] == 'new'
   else
     title = ARGV[1]
   end
-
   create_new title
 
 else

data/lib/tasks/capistrano/sinatra.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :sinatra do
   namespace :restart do
     desc 'Restart the remote neruda application'
@@ -7,7 +9,7 @@ namespace :sinatra do
           if test("[ -e '#{release_path}/tmp/pids/sinatra.pid' ]")
             execute :pkill, '-F', 'tmp/pids/sinatra.pid'
           end
-          execute :bundle, :exec, :rackup, '-E', fetch(:app_env),
+          execute :rackup, '-E', fetch(:app_env),
                   '-P', 'tmp/pids/sinatra.pid', '-D'
         end
       end

data/lib/tasks/chapters.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 namespace :chapters do
@@ -45,7 +47,7 @@ namespace :chapters do
       next if file_radix == 'index'
       epub_file = "private/epubs/#{file_radix}.epub"
       epub_to_upload << epub_file
-      system 'pandoc', '-S', "-o #{epub_file}", filename
+      sh '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,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rainbow'
+
 namespace :sinatra do
   desc 'Stop the underlaying sinatra application'
   task :stop do
@@ -10,6 +12,7 @@ namespace :sinatra do
     pid = IO.read('tmp/pids/neruda.pid').strip.to_i
     Process.kill('TERM', pid)
     File.unlink 'tmp/pids/neruda.pid'
+    puts Rainbow('Done').green
   end
 
   desc 'Start the underlaying sinatra application'
@@ -17,7 +20,11 @@ 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'
-    system cmd.join(' ')
+    begin
+      sh cmd.join(' ')
+    rescue Interrupt
+      puts Rainbow(' Kthxbye').blue
+    end
   end
 
   desc 'Restart local sinatra server'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neruda
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Étienne Deparis
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 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
@@ -101,11 +87,12 @@ email: etienne@depar.is
 executables:
 - pablo
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
 - LICENSE
-- README.org
-- TODO.org
+- README.md
 - bin/pablo
 - docs/Rakefile.example
 - docs/config.yml.example

data/README.org

@@ -1,107 +0,0 @@
-#+title: Neruda
-
-*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.
-
-First we need to upgrade rvm (always do that from time to time):
-
-#+begin_src shell
-$ rvm get latest
-$ rvm install ruby-2.4.1
-#+end_src
-
-Then the installation itself:
-
-#+begin_src shell
-$ mkdir mysite
-$ rvm use ruby-2.4.1@neruda --create
-$ gem install neruda
-#+end_src
-
-Finally, you need to configure it to your needs.
-
-#+begin_src shell
-$ pablo init
-$ bundle install
-#+end_src
-
-* Running it
-
-For testing it, you should just run:
-
-#+begin_src shell
-$ pablo start
-#+end_src
-
-For production use, just pass the right environnement variable:
-
-#+begin_src shell
-$ APP_ENV=production pablo start
-#+end_src
-
-To stop it, just enter =ctrl+C= if you are in development mode or enter
-=pablo stop= in production mode.
-
-* 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
-
-See [[TODO.org][TODO.org]]

data/TODO.org

@@ -1,12 +0,0 @@
-#+title: TODO
-
-* TODO Documentation
-
-Write a better documentation
-
-* TODO Capistrano tasks
-
-** TODO Add capistrano commands to =pablo=
-** TODO Complete documentation on capistrano
-
-* TODO Deploy a sample website