octodown 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 924195e613b34c37eb8ac469ef281003f395ffae
-  data.tar.gz: a5ec1d270575c5beb67a44d99fb315a904dbfd18
+  metadata.gz: f90a2ef4162d809a6a4b3b36317b68be7f5634c9
+  data.tar.gz: 3ec9707771065783b2ec7450d51b6cfc3cd4b61d
 SHA512:
-  metadata.gz: 35f8720e42935d3e16c50d79d915cae4c50fef7d10fbfd9297f39ed3d244e3fec4682a1a858335b8f6dd5f5a22f1fb47cf36f8b931e9aeb21050709492d7ed33
-  data.tar.gz: 16e84424b7d6c52986b4bc8986d2443782250e7c4ee5db9fee916a95c9725ec75e1606e3030a047a9d21886799c97fd854095a342bbc01fc6096c47f1765d183
+  metadata.gz: 55e9a5523ef91ce72831232c8ee4bd30a3e730bb05f62b490358acdfd3eea44fb3d32d06de1fe54d5d7c6c704816c82b9c2a1b2e9e56e74dba54114ba45a8471
+  data.tar.gz: d5fe2d2797b00fb9f33cf073aacf8eb55556a7ea22c7a2148a3c1d190ca6b373aeef819ef0310f583a1e22dd3fd847fa9407ac168e76628dc7bcfa88b9aed72c

data/bin/octodown

@@ -1,19 +1,20 @@
 #!/usr/bin/env ruby
 
 require 'octodown'
+require 'octodown/support/file_chooser'
+require 'octodown/support/logger'
 require 'optparse'
 require 'launchy'
-
-include Octodown
-
 # Default options
 options = {
-  port: 8080,
-  presenter: :html,
-  style: :github
+  port: 8887,
+  presenter: :server,
+  style: :github,
+  stdin: false,
+  logger: Octodown::Support::Logger.build,
+  no_open: false
 }
 
-# rubocop:disable Metrics/BlockLength
 OptionParser.new do |opts|
   opts.banner = 'Usage: octodown [options]'
 
@@ -28,6 +29,14 @@ OptionParser.new do |opts|
     options[:style] = s
   end
 
+  opts.on '--stdin', 'Read from STDIN' do
+    options[:stdin] = true
+  end
+
+  opts.on '--quiet', 'Shhhh.. keep quiet' do
+    options[:logger].level = Logger::FATAL
+  end
+
   opts.on '-r', '--raw', 'Print raw HTML to STDOUT' do
     options[:presenter] = :raw
   end
@@ -36,6 +45,10 @@ OptionParser.new do |opts|
     options[:presenter] = :server
   end
 
+  opts.on '-h', '--html', 'Render to HTML' do
+    options[:presenter] = :html
+  end
+
   opts.on(
     '-P', '--port [PORT]', "LiveReload port (default: #{options[:port]})"
   ) do |port|
@@ -47,6 +60,23 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
+
+  opts.on '--no-open', 'Do not open the browser' do
+    options[:no_open] = true
+  end
 end.parse!
 
+require 'tty-prompt'
+
+STDOUT.sync = true
+TUI = TTY::Prompt.new(enable_color: true)
+
+options[:file] = if ARGF.file == STDIN && options[:stdin]
+                   STDIN
+                 elsif ARGF.file != STDIN
+                   ARGF.file
+                 else
+                   FileChooser.new(prompt: TUI).choose_file
+                 end
+
 Octodown.call options

data/lib/octodown/renderer/github_markdown.rb

@@ -10,11 +10,12 @@ module Octodown
       include HTML
       include Renderable
 
-      attr_reader :options, :file
+      attr_reader :options, :file, :logger
 
       def initialize(file, options = {})
         @file = file
         @options = options
+        @logger = options[:logger]
       end
 
       def content
@@ -24,7 +25,7 @@ module Octodown
           begin
             File.open(file.path, 'r') { |f| buffer = f.read }
           rescue Errno::ENOENT
-            puts '[WARN] something went wrong when trying to open the file'
+            logger.warn 'Something went wrong when trying to open the file'
           end
         end
         pipeline.call(buffer ||= 'could not read changes')[:output].to_s

data/lib/octodown/renderer/html.rb

@@ -7,9 +7,10 @@ module Octodown
       include Octodown::Support
       include Renderable
 
-      attr_reader :rendered_markdown, :filepath, :options
+      attr_reader :rendered_markdown, :filepath, :options, :logger
 
       def initialize(rendered_markdown, options = {})
+        @logger = options[:logger]
         @rendered_markdown = rendered_markdown
         @options = options
         @filepath = File.join parent_dir, 'template', 'octodown.html.erb'
@@ -39,7 +40,11 @@ module Octodown
       end
 
       def present
-        Launchy.open PersistentTempfile.create(content, :html).path
+        if options[:no_open]
+          logger.warn('--no-open argument was used so no browser will be opened')
+        else
+          Launchy.open PersistentTempfile.create(content, :html).path
+        end
       end
 
       private

data/lib/octodown/renderer/raw.rb

@@ -12,7 +12,7 @@ module Octodown
       end
 
       def present
-        puts content
+        STDOUT.puts content
       end
     end
   end

data/lib/octodown/renderer/server.rb

@@ -8,10 +8,11 @@ require 'launchy'
 module Octodown
   module Renderer
     class Server
-      attr_reader :file, :path, :options, :port
+      attr_reader :file, :path, :options, :port, :logger
 
       def initialize(_content, options = {})
-        @file = ARGF.file
+        @logger = options[:logger]
+        @file = options[:file]
         @options = options
         @path = File.dirname(File.expand_path(file.path))
         @port = options[:port]
@@ -33,19 +34,20 @@ module Octodown
       end
 
       def boot_server
-        puts "[INFO] Server running on http://localhost:#{port}"
+        logger.info "#{file.path} is getting octodown'd"
+        logger.info "Server running on http://localhost:#{port}"
         Rack::Handler::Puma.run app, Host: 'localhost', Port: port, Silent: true
       end
 
       def maybe_launch_browser
-        return if ENV['TEST']
+        return if options[:no_open]
 
         sleep 2.5
 
         @mutex.synchronize do
           if @already_opened == false
             @already_opened = true
-            puts '[INFO] Loading preview in a new browser tab'
+            logger.info 'Loading preview in a new browser tab'
             Launchy.open "http://localhost:#{port}"
           end
         end
@@ -72,19 +74,19 @@ module Octodown
         socket.on(:open) do
           @mutex.synchronize do
             if @already_opened == false
-              puts '[INFO] Re-using octodown client from previous browser tab'
+              logger.info 'Re-using octodown client from previous browser tab'
             end
 
             @already_opened = true
           end
 
           socket.send md
-          puts "Clients: #{@websockets.size}" if ENV['DEBUG']
+          logger.debug "Clients: #{@websockets.size}"
         end
 
         socket.on(:close) do
           @websockets = @websockets.reject { |s| s == socket }
-          puts "Clients: #{@websockets.size}" if ENV['DEBUG']
+          logger.debug "Clients: #{@websockets.size}"
         end
 
         @websockets << socket
@@ -111,7 +113,7 @@ module Octodown
 
       def register_listener
         Octodown::Support::Services::Riposter.call file do
-          puts '[INFO] Recompiling markdown...'
+          logger.info "Changes to #{file.path} detected, updating"
           md = render_md(file)
           @websockets.each do |socket|
             socket.send md

data/lib/octodown/support/file_chooser.rb

@@ -0,0 +1,40 @@
+class FileChooser
+  attr_reader :prompt
+
+  def initialize(prompt:)
+    @prompt = prompt
+  end
+
+  def choose_file
+    choices = all_markdown_files
+    choice = prompt.select('Which markdown file would you like to edit?', choices)
+    File.open(choice, 'r')
+  end
+
+  def abort_no_files_found!
+    prompt.error 'We could not find any markdown files in this folder.'
+    puts
+    prompt.error 'Try passing the file explicitly such as, i.e:'
+    prompt.error '    $ octodown README.md'
+    exit 1
+  end
+
+  def all_markdown_files
+    extensions = %w[markdown
+                    mdown
+                    mkdn
+                    md
+                    mkd
+                    mdwn
+                    mdtxt
+                    mdtext
+                    text
+                    Rmd]
+
+    choices = Dir.glob "**/*.{#{extensions.join(',')}}"
+
+    abort_no_files_found! if choices.empty?
+
+    choices.sort_by! { |c| c.split(File::SEPARATOR).length }
+  end
+end

data/lib/octodown/support/logger.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+module Octodown
+  module Support
+    class Logger
+      FORMAT = "%-5s: %s\n".freeze
+
+      def self.build(dev: STDOUT, level: ::Logger::INFO)
+        logger = ::Logger.new(dev)
+        logger.level = level
+        logger.formatter = method(:formatter)
+        logger
+      end
+
+      def self.formatter(severity, _datetime, _progname, msg)
+        format(FORMAT, severity, msg)
+      end
+    end
+  end
+end

data/lib/octodown/version.rb

@@ -1,3 +1,3 @@
 module Octodown
-  VERSION = '1.7.0'.freeze
+  VERSION = '1.8.0'.freeze
 end

data/lib/octodown.rb

@@ -13,7 +13,7 @@ module Octodown
   def self.call(options)
     include Octodown::Support::Services
 
-    DocumentPresenter.call ARGF.file, options
+    DocumentPresenter.call options[:file], options
   end
 
   def self.root

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -156,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -227,25 +241,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.34'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.34.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
-    - - ">="
+        version: '0.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.2
+        version: '0.55'
 description: 
 email:
 - i.kerseymer@gmail.com
@@ -266,6 +288,8 @@ files:
 - lib/octodown/renderer/raw.rb
 - lib/octodown/renderer/renderable.rb
 - lib/octodown/renderer/server.rb
+- lib/octodown/support/file_chooser.rb
+- lib/octodown/support/logger.rb
 - lib/octodown/support/persistent_tempfile.rb
 - lib/octodown/support/relative_root_filter.rb
 - lib/octodown/support/renderable.rb