Class: Markdown::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/markdown/cli/runner.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Runner

Returns a new instance of Runner.



8
9
10
11
12
 
# File 'lib/markdown/cli/runner.rb', line 8

def initialize
  @logger       = Logger.new(STDOUT)
  @logger.level = Logger::INFO
  @opts         = Opts.new
end

Instance Attribute Details

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



5
6
7
 
# File 'lib/markdown/cli/runner.rb', line 5

def logger
  @logger
end

#opts ⇒ Object (readonly)

Returns the value of attribute opts.



6
7
8
 
# File 'lib/markdown/cli/runner.rb', line 6

def opts
  @opts
end

Instance Method Details

#find_file_with_markdown_extension(fn) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/markdown/cli/runner.rb', line 25

def find_file_with_markdown_extension( fn )
  dirname  = File.dirname( fn )
  basename = File.basename( fn, '.*' )
  extname  = File.extname( fn )
  logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"

  Markdown.extnames.each do |e|
    newname = File.join( dirname, "#{basename}#{e}" ) 
    logger.debug "File.exists? #{newname}"
    return newname if File.exists?( newname )
  end  # each extension (e)
    
  nil   # not found; return nil
end

#find_files(file_or_dir_or_pattern) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/markdown/cli/runner.rb', line 41

def find_files( file_or_dir_or_pattern )

  filtered_files = []
    
  # assume pattern if includes * or ? or {} or []
  if file_or_dir_or_pattern =~ /[*?{}\[\]]/
    puts "searching glob pattern '#{file_or_dir_or_pattern}'..."
    Dir.glob( file_or_dir_or_pattern ).each do |file|
      if File.directory?( file )  # skip (sub)directories
        puts "  skipping folder '#{file}'..."
        next
      else
        if has_markdown_extension?( file )
          logger.debug "  adding file '#{file}'..."
          filtered_files << file
        else
          puts "  skipping file   '#{file}'..."
        end
      end
    end
  elsif File.directory?(file_or_dir_or_pattern)
    puts "searching folder '#{file_or_dir_or_pattern}'..."
    Dir.entries( file_or_dir_or_pattern ).each do |entry|
      next if entry == '.' || entry == '..' # silently skip current and up dirs
        
      if file_or_dir_or_pattern == '.'
        file = entry
      else  # add dir (if not working dir)
        file = File.join( file_or_dir_or_pattern, entry )  
      end
         
      if File.directory?( file )  # skip (sub)directories
        puts "  skipping folder '#{file}'..."
        next
      else
        if has_markdown_extension?( file )
          logger.debug "  adding file '#{file}'..."
          filtered_files << file
        else
          puts "  skipping file   '#{file}'..."
        end
      end
    end
  else  # assume it's a single file (check for missing extension)
    if File.exists?( file_or_dir_or_pattern )
      file = file_or_dir_or_pattern
      if has_markdown_extension?( file )
        logger.debug "  adding file '#{file}'..."
        filtered_files << file
      else
        puts "  skipping file   '#{file}'..."
      end
    else  # check for existing file w/ missing extension
      file = find_file_with_markdown_extension( file_or_dir_or_pattern )
      if file.nil?
        puts "  skipping missing file '#{file_or_dir_or_pattern}{#{Markdown.extnames.join(',')}}'..."
      else
        logger.debug "  adding file '#{file}'..."
        filtered_files << file
      end
    end
  end

  filtered_files
end

#has_markdown_extension?(fn) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
18
19
20
21
22
23
 
# File 'lib/markdown/cli/runner.rb', line 14

def has_markdown_extension?( fn )
  dirname  = File.dirname( fn )
  basename = File.basename( fn, '.*' )
  extname  = File.extname( fn )
  logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"

  return false if extname.empty?   # no extension
    
  Markdown.extnames.include?( extname.downcase )
end

#run(args) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/markdown/cli/runner.rb', line 108

def run( args )
  opt=OptionParser.new do |cmd|

    cmd.banner = "Usage: markdown [options] files_or_dirs"

    cmd.on( '-o', '--output PATH', "Output Path (default is #{opts.output_path})" ) { |path| opts.output_path = path }

    cmd.on( '-v', '--version', "Show version" ) do
      puts Markdown.banner
      exit
    end
    
    cmd.on( '--about', "(Debug) Show more version info" ) do
      puts
      puts Markdown.banner
      puts

      # dump settings
      Markdown.dump
      puts
      
      exit
    end

    cmd.on( "--verbose", "(Debug) Show debug trace" )  do
      logger.datetime_format = "%H:%H:%S"
      logger.level = Logger::DEBUG
    end
 
## todo: add markdown.lib options (e.g. extensions,etc)
 
    cmd.on_tail( "-h", "--help", "Show this message" ) do
       puts <<EOS

markdown - Lets you convert plain text documents (#{Markdown.extnames.join(', ')}) to hypertext (.html) with your Markdown engine of choice (#{Markdown.lib}) and preprocessing text filters (#{Markdown.filters.join(', ')}).

#{cmd.help}

Examples:
  markdown                   # Process all documents in working folder (that is, .)
  markdown quickref          # Process document or folder using Markdown
  markdown quickref.text     # Process document using Markdown
  markdown -o site quickref  # Output documents to site folder

Note:
  markdown server            # Starts builtin markdown server
                         #  (aliases for server include serve, service, s)


Further information:
  https://github.com/geraldb/markdown

EOS
       exit
    end
  end

  opt.parse!( args )
  
  puts Markdown.banner
  
  # force loading of config
  Markdown.lib
  
  Markdown.dump   if logger.level == Logger::DEBUG   # dump settings if verbose/debug flag on

  
  logger.debug "args.length: #{args.length}"
  logger.debug "args: >#{args.join(',')}<"

  if args.length == 1 && ['server', 'serve', 'service', 's' ].include?( args[0] )
     # start service/server
     # NB: server (HTTP service) not included in standard default require
    require 'markdown/server'

    Markdown::Server.run!
  else

    # if no file args given; default to working folder (that is, .)
    args = ['.'] if args.length == 0

    args.each do |arg|
      files = find_files( arg )
      files.each do |file|
        Gen.new( logger, opts ).create_doc( file )
      end
    end
  end

  puts 'Done. Bye.'
  
end