neruda 0.0.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3101ba04a16de9562d4834ebde5c9034103d14d
-  data.tar.gz: f50ebe738e0771b75ed532319e84cfe1027bea25
+SHA256:
+  metadata.gz: bf44dce40376682ca2835d1472ccd7eb2ea47d5e7b892623da09350077bf4a10
+  data.tar.gz: fcabfb117f2ac44a76fc325a84982be6dd6e389872f4fb6bfbd10bf05924d882
 SHA512:
-  metadata.gz: c3ca902065a455800fdd16b9b9ee0d81921b7971d4a25b9aa8e5bf0327ab05f97ddd39b7d710ab7937cee1b11a1b61e33b51ee04a140d31ad0418584de15c95d
-  data.tar.gz: 011f3df145a513b3b780fbf543db6eb5a76cd6c89acb8342428799bd32b3bfef21a38efc5019de9b686f4517bc642649fadbbd99864eb015b14e4bb957549a10
+  metadata.gz: 7113b65a71b026c419a6de56d7ba2b84cdf9fbf6b02a977736dbad0484a225c2d97acb4df906c957e51a9c3b968b3260fb748856630fc534c4f30a7d5aa280d7
+  data.tar.gz: 1e478aa7c7c9ac80cb9293fb873baeadbfa25864cffb81460ac5e727b46360228f5eeb0f525116e88b35a537a2ae07c94f5b373e037095168c1b929ccc07bb9b

data/bin/pablo

@@ -1,279 +1,176 @@
 #!/usr/bin/env ruby
-# coding: utf-8
 # frozen_string_literal: true
 
-require 'yaml'
-require 'rainbow'
+require 'rake'
 require 'optparse'
-require 'fileutils'
-
-# 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')
+require 'r18n-core'
+require 'neruda/utils'
+require 'neruda/version'
+
+R18n.default_places = File.expand_path('../locales', __dir__)
+R18n.set Neruda::Config.settings['lang']
+
+# Pablo commands
+module PabloCommands
+  def pablo_init
+    cnf = @options.merge
+    cnf.delete(:verbose)
+    cnf.delete(:directory)
+    cnf.transform_keys!(&:to_s)
+    Neruda::Config.save(Neruda::Config.settings.merge(cnf))
+    @rake.options.build_all = true
+    @rake.invoke_task('org:install')
+    return if File.exist? 'src/index.org'
+    Neruda::OrgFile.new('src/index.org', @options).write
+  end
+  alias_method :pablo_config, :pablo_init
+
+  def pablo_build(file = ARGV[0])
+    @rake.options.build_all = true
+    if file.nil?
+      @rake.invoke_task('site:build')
+    else
+      @rake.invoke_task("site:build:one[#{file}]")
     end
-    false
-  end
-
-  def rake_or_bundle_run(cmd, use_system = false)
-    cmd.insert(1, '-s') unless @options[:verbose]
-    cmd = ['bundle', 'exec'] + cmd if bundler_is_present?
-    joined_cmd = cmd.join(' ')
-    puts Rainbow(joined_cmd).blue if @options[:verbose]
-    return system(joined_cmd) if use_system
-    exec(*cmd)
   end
 
-  def capify
-    unless File.exist? 'Capfile'
-      STDERR.puts Rainbow('ERROR: Capfile does not exist.').red
-      exit 1
+  def pablo_preview
+    Thread.new do
+      sleep 1
+      port = Neruda::Config.settings.dig('preview', 'server_port') || 5000
+      uri = "http://127.0.0.1:#{port}/"
+      current_os = Neruda::Utils.current_os
+      case current_os
+      when 'windows'
+        system 'start', uri
+      when 'apple'
+        system 'open', uri
+      else
+        system 'gio', 'open', uri
+      end
     end
-
-    capfile = File.new('Capfile', 'a')
-    capfile.write <<~CAPFILE
-      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 }
-    CAPFILE
+    @rake.invoke_task('site:preview')
   end
-end
 
-# 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'
+  def pablo_open
+    filename = new_file_name(ARGV[0])
+    FileUtils.mkdir_p File.dirname(filename)
+    o = Neruda::OrgFile.new(filename, @options)
+    o.write unless File.exist? filename
+    editor = ENV['EDITOR'] || ENV['VISUAL'] || 'emacs'
+    cmd = [editor, '+6', filename]
+    system(*cmd)
   end
+  alias_method :pablo_edit, :pablo_open
 
-  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'] = []
-
-    IO.write 'config/config.yml', config.to_yaml
+  def pablo_publish
+    @rake.invoke_task('sync:push')
   end
 
-  def init_assets
-    unless Dir.exist? 'views'
-      FileUtils.cp_r File.join(__dir__, '../lib/assets'), 'views'
+  def pablo_help(command = 'basic', error: false)
+    warn R18n.t.pablo.error.no_command if error
+    cmd = Neruda::Utils.resolve_possible_alias(command)
+    cmd_opt = Neruda::Utils::PABLO_COMMANDS[cmd]
+    label = cmd_opt[:label] || command
+    warn format("%<label>s\n\n", label: R18n.t.pablo.usage(label))
+    if R18n.t.pablo.commands[cmd].translated?
+      warn format("%<label>s\n\n", label: R18n.t.pablo.commands[cmd])
     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
-
-    return if File.exist? 'config.ru'
-    IO.write 'config.ru', <<~CONFIG
-      # frozen_string_literal: true
-
-      require 'neruda'
-      run Neruda::App
-    CONFIG
+    warn help_command_body(cmd).join("\n")
+    exit 1 if error
+    exit
   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\''
-
-    IO.write 'Gemfile', <<~GEMFILE
-      # 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
-    GEMFILE
-    puts ''
-    puts 'To complete this installation, you must now run: ' +
-         Rainbow('bundle install').yellow
-  end
+  private
 
-  def setup
-    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?
+  def new_file_name(title)
+    title ||= @options[:title]
+    title = 'new' if title.nil? || title == ''
+    filename = Neruda::OrgFile.slug title
+    return "#{filename}.org" unless @options[:directory]
+    "#{filename}/index.org"
+  end
+
+  def help_command_body(command)
+    body = [
+      R18n.t.pablo.options.cmd_title,
+      Neruda::Utils.summarize_command(command)
+    ]
+    return body unless command == 'basic'
+    body + [
+      '',
+      R18n.t.pablo.commands.cmd_title,
+      Neruda::Utils.list_commands
+    ]
   end
 end
 
 # Main pablo class
 class Pablo
-  def initialize
-    @options = {
-      verbose: false
-    }
-    @available_commands = ['capify', 'list', 'start', 'edit',
-                           'setup', 'stop', 'compile']
-
-    parse_options
-    # Be sure required directories are always there
-    init_path unless @arg == 'setup'
-    route_command
+  def initialize(opts = {})
+    @options = { verbose: false }.merge(opts)
+    init_rake
   end
 
-  def route_command
-    if @arg == 'stop'
-      rake_or_bundle_run ['rake', 'sinatra:stop']
-      return
-    end
-
-    ARGV.shift
-    send @arg
-  end
+  include PabloCommands
 
   private
 
-  def parse_options
-    optparse = OptionParser.new do |opts|
-      opts.banner = <<~HELP
-        Usage:
-            pablo -h
-            pablo [ -v ] command
-
-      HELP
-      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
-        pablo_help
-      end
-    end
+  def init_rake
+    init_rakefile unless File.exist?('Rakefile')
+    @rake = Rake.application
+    Rake.verbose(false) unless @options[:verbose]
+    @rake.raw_load_rakefile
+  end
 
-    optparse.parse!
+  def init_rakefile
+    rakefile = <<~RAKE
+      # frozen_string_literal: true
 
-    @arg = ARGV[0]
-    if @arg == 'new'
-      @arg = 'edit'
-    elsif @arg == 'run'
-      @arg = 'start'
-    elsif @arg == 'init'
-      @arg = 'setup'
-    end
+      require 'neruda/config'
+      require 'r18n-core'
 
-    if !File.exist?('config/config.yml') && @arg != 'setup'
-      STDERR.puts Rainbow('ERROR: please run pablo setup before all').red
-      exit 1
-    end
-    return if @available_commands.include?(@arg)
-    STDERR.puts Rainbow('ERROR: no or unknown command given.').red
-    STDERR.puts Rainbow('Run pablo -h for options and available ' \
-                        'commands').red
-    exit 1
-  end
-
-  include BundlerHelper
-  include PabloInit
+      neruda_spec = Gem::Specification.find_by_name 'neruda'
+      R18n.default_places = "\#{neruda_spec.gem_dir}/locales"
+      R18n.set(Neruda::Config.settings['lang'] || 'en')
+      R18n::Filters.on(:named_variables)
 
-  def pablo_help
-    STDERR.puts <<~HELP
-      Book Commands:
-          new  [title]    Begin to write a new chapter
-          edit [title]    Continue the writing of a chapter
-          compile         Generate the epubs files
-          list [elements] List various book elements
-                          (chapters, characters, notes, sceneries)
+      Dir.glob("\#{neruda_spec.gem_dir}/lib/tasks/*.rake").each { |r| import r }
 
-      System Commands
-          setup           Initialize your Neruda instance
-                          (you just need to do it once).
-          start           Start a test web server
-          stop            Stop the web server
-    HELP
-    exit
+      task default: 'site:build'
+    RAKE
+    IO.write 'Rakefile', rakefile
   end
+end
 
-  def compile
-    rake_or_bundle_run ['rake', 'chapters:build_epubs'], true
-    rake_or_bundle_run ['rake', 'book:make'], true
-  end
+optparser = OptionParser.new
+optparser.version = Neruda::VERSION
 
-  def start
-    compile
+Neruda::Utils::PABLO_OPTIONS.each do |k, opt|
+  optparser.send(opt[:meth] || :on, *Neruda::Utils.decorate_option(k))
+end
 
-    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
+params = {}
+optparser.parse!(into: params)
 
-  def edit
-    if ARGV[0].nil?
-      print 'Title: '
-      title = STDIN.gets.strip
-    else
-      title = ARGV.join(' ')
-    end
-    rake_or_bundle_run ['rake', "chapters:create_or_edit[#{title}]"]
-  end
+if params[:version]
+  warn optparser.ver
+  exit
+end
 
-  def list
-    list_type = ARGV[0] || 'chapters'
-    rake_or_bundle_run ['rake', "book:list[#{list_type}]"]
-  end
+if ARGV[0] == 'help'
+  params[:help] = true
+  ARGV.shift
+end
+pablo = Pablo.new(params)
+command = "pablo_#{ARGV[0]}".to_sym
+cmd_err = !pablo.respond_to?(command)
+if params[:help] || cmd_err
+  cmd_err = false if params[:help] && !ARGV[0]
+  pablo.pablo_help(ARGV[0], error: cmd_err)
 end
+ARGV.shift
 
-Pablo.new
+init_cmds = [:pablo_init, :pablo_config]
+pablo.pablo_init unless File.exist?('config.yml') || init_cmds.include?(command)
+pablo.send command

data/lib/neruda/config.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'neruda/config/lisp_config'
+
+module Neruda
+  # Wrapper for configuration
+  #
+  # This class is a singleton interface, which share the static website
+  # being build settings among different steps or tasks.
+  #
+  # It expects the website author to holds their custom settings in a
+  # YAML file named ~config.yml~ available at the root of their
+  # project.
+  #
+  # For example, with the given config file:
+  #
+  # #+begin_src
+  # ---
+  # title: My website
+  # author: Alice Doe
+  # #+end_src
+  #
+  # Settings will be available like this:
+  #
+  # #+begin_src
+  # Neruda::Config.settings['author']
+  # => "Alice Doe"
+  # #+end_src
+  class Config
+    extend Neruda::LispConfig
+
+    class << self
+      # Access the current website settings
+      #
+      # If the settings have not been loaded yet, this method is
+      # responsible for calling the one, which actually loads them.
+      #
+      # @return [Hash] the website settings
+      def settings
+        return load_settings unless @config
+        @config
+      end
+
+      # Save the settings given as a parameter to the ~config.yml~ file.
+      #
+      # Not only this method overwrite the old settings, but it replace
+      # the current shared settings with the ones given in
+      # parameter. Later call to
+      # {file:Neruda/Config.html#settings-class_method settings}
+      # will, obviously, use these new settings.
+      #
+      # @param new_config [Hash] the settings to save
+      # @return [Hash] the new settings after save
+      def save(new_config)
+        # Do not save obvious default config values. We'll always try to
+        # save author and lang as they default on system variables,
+        # which may be different from a system to another. Thus it may
+        # be confusing if one use neruda on two different computer and
+        # these params always change.
+        new_config.delete_if do |k, v|
+          ['domain', 'public_folder', 'templates', 'theme'].include?(k) \
+          && v == default_settings[k]
+        end
+        IO.write 'config.yml', new_config.to_yaml
+        load_settings # Reload config, taking default settings into account
+      end
+
+      # Load the given settings as if they comes from the ~config.yml~ file.
+      #
+      # This method is handy for testing purpose. Later call to
+      # {file:Neruda/Config.html#settings-class_method settings} will
+      # use these new settings.
+      #
+      # @param config [Hash] the settings to artificially load
+      # @return [Hash] the new settings
+      def load_test(config)
+        @sources = nil # Reset sources
+        @config = default_settings.merge config
+      end
+
+      # Return the qualified projects sources list.
+      #
+      # @return [Array] the fully qualified projects sources list
+      def sources
+        return @sources if @sources
+        default_sources = [{ 'path' => 'src', 'target' => '.' }]
+        @sources = (settings['sources'] || default_sources).map do |s|
+          build_source(s)
+        end.compact
+      end
+
+      private
+
+      def load_settings
+        @sources = nil
+        conf_file = 'config.yml'
+        if File.exist? conf_file
+          @config = default_settings.merge(YAML.load_file(conf_file)).freeze
+        else
+          @config = default_settings
+        end
+      end
+
+      def extract_lang_from_env(default)
+        (ENV['LANG'] || default).split('_', 2).first
+      end
+
+      def default_settings
+        return @default_settings if @default_settings
+        @default_settings = {
+          'author' => (ENV['USER'] || ''),
+          'domain' => '',
+          'lang' => extract_lang_from_env('en'),
+          'public_folder' => 'public_html',
+          'templates' => [],
+          'theme' => 'default'
+        }.freeze
+      end
+
+      def build_source(seed)
+        opts = { 'recursive' => true, 'is_blog' => false }
+        case seed
+        when String
+          opts['path'] = seed
+        when Hash
+          opts.merge! seed
+        end
+        return nil unless opts.has_key?('path')
+        opts['path'] = File.expand_path(opts['path'])
+        opts['name'] ||= File.basename(opts['path']).sub(/^\./, '')
+        opts['target'] ||= opts['name']
+        opts
+      end
+    end
+  end
+end