vim_printer 0.1.4 → 0.1.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/README.md +15 -13
  4. data/lib/vim_printer/cli.rb +23 -21
  5. data/lib/vim_printer/core_ext/file.rb +3 -3
  6. data/lib/vim_printer/version.rb +1 -1
  7. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 68504b44732aaf36bcda265109f09c747fe7d6d6
4
- data.tar.gz: 6f804fd2c714914e8d603ae37b3a470287bcca97
3
+ metadata.gz: 3a75ff67ccc6b202fd6587fadac534be086941ad
4
+ data.tar.gz: 58fbbc9b941c6537f53e6d2616e25673591354b8
5
5
  SHA512:
6
- metadata.gz: 27a961c2e2815543dc300b421c5f6d03e9230743737d23586f387fe3ddbaba1627367290d51d092a014b4e6bcaa0f0805029f48fe19effa88635bfd673b136dc
7
- data.tar.gz: 10cc2d66de8eea91d90c2cabb613510b0385d28a3d04ed78433c38df3484702d02a5822fee40126d7de2ae7f74d99895e72f7a3675617617a6dfec4ac66edd41
6
+ metadata.gz: 067b0aedbd412da782ec5956ec20224532d8ad4bef8f46f8650a6cf416083874cbee841390b3dc34601c979260ed5b5652d313ad4856ec3e6a76449b14c5d67f
7
+ data.tar.gz: 640003a5420b48306f6d497069c655e5ec5a45652f696a19c7b214087eb98a7cc29353ea996bbb3cec15b49afa335d284a6fc832805ac8045f1b644f1b668eb3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  ### Changelog
2
2
 
3
+ #### 0.1.5
4
+
5
+ - Add option '--index' to make it possible to skip the cration of 'index.html'
6
+ - Make the final output filename 'vim_printer_<base_dir>.tar.gz'
7
+
3
8
  #### 0.1.4
4
9
 
5
10
  - Skip binary input files when applicable
data/README.md CHANGED
@@ -55,10 +55,10 @@ The html output as renderd in the browser
55
55
  - Run with the sample fixture files
56
56
 
57
57
  ```sh
58
- vim_printer -b test/fixtures/inputs -e rb java -r
58
+ vim_printer -b test/fixtures -e rb java -r
59
59
  ```
60
60
 
61
- Will produce the file `output.tar.gz` with the following result on the screen.
61
+ Will produce the file `vim_printer_fixtures.tar.gz` with the following result on the screen.
62
62
 
63
63
  ```
64
64
  FYI: process file 1 of 8 : ./demo1.xxx.rb
@@ -69,7 +69,7 @@ FYI: process file 5 of 8 : ./java/demo3.xxx.java
69
69
  FYI: process file 6 of 8 : ./java/demo3.yyy.java
70
70
  FYI: process file 7 of 8 : ./java/demo4.xxx.java
71
71
  FYI: process file 8 of 8 : ./java/demo4.yyy.java
72
- Your output file is ./test/fixtures/inputs/vim_printer_output.tar.gz
72
+ Your output file is ./test/fixtures/vim_printer_fixtures.tar.gz
73
73
  ```
74
74
 
75
75
  ### Usage
@@ -101,14 +101,14 @@ vim_printer --base-dir ./test/fixtures \
101
101
  --theme solarized
102
102
  ```
103
103
 
104
- Your output will be saved to the default `output.tar.gz` in the directory where you run this command.
104
+ Your output will be saved to the default `vim_printer_fixtures.tar.gz` in the directory where you run this command.
105
105
  To see the output in your browser just type:
106
106
 
107
107
  ```sh
108
108
  mkdir -p ~/Desktop/vim_printer
109
- mv vim_printer_output.tar.gz ~/Desktop/vim_printer
109
+ mv vim_printer_fixtures.tar.gz ~/Desktop/vim_printer
110
110
  cd ~/Desktop/vim_printer
111
- tar zxvf vim_printer_output.tar.gz
111
+ tar zxvf vim_printer_fixtures.tar.gz
112
112
  ```
113
113
 
114
114
  - Print only files that contain the word `xxx` in the title
@@ -131,24 +131,26 @@ vim_printer -e ruby -f Gemfile Rakefile -r
131
131
 
132
132
  ```
133
133
  Usage:
134
- vim_printer
134
+ vim_printer print
135
135
 
136
136
  Options:
137
137
  -b, [--base-dir=BASE_DIR] # Base directory
138
138
  # Default: . (current directory)
139
139
  -e, [--exts=one two three] # List of extensions to search for
140
- -f, [--non-exts=one two three] # List of extensions to search for
141
- -n, [--inc-words=one two three] # List of words to be included in the result
142
- -x, [--exc-words=one two three] # List of words to be excluded from the result
140
+ -f, [--non-exts=one two three] # List of files without extension to search for
141
+ -n, [--inc-words=one two three] # List of words in the filename to be included in the result if any
142
+ -x, [--exc-words=one two three] # List of words in the filename to be excluded from the result if any
143
143
  -i, [--ignore-case], [--no-ignore-case] # Match case insensitively
144
144
  # Default: true
145
145
  -r, [--recursive], [--no-recursive] # Search for files recursively
146
146
  # Default: true
147
- -t, [--theme=THEME] # Vim colorscheme to use
148
- # Default: default
149
147
  -v, [--version], [--no-version] # Display version information
148
+ -t, [--theme=THEME] # Vim colorscheme to use
149
+ # Default: 'default'
150
+ -c, [--index], [--no-index] # Generate the index.html file for the result
151
+ # Default: true
150
152
 
151
- Print the list of files
153
+ Print files to (x)html using Vim
152
154
  ```
153
155
 
154
156
  ### Development/Testing
data/lib/vim_printer/cli.rb CHANGED
@@ -6,7 +6,7 @@ require_relative "../vim_printer"
6
6
  module VimPrinter
7
7
  include AgileUtils
8
8
  class CLI < Thor
9
- desc "print", "Print the list of files"
9
+ desc "print", "Print files to (x)html using Vim"
10
10
  method_option *AgileUtils::Options::BASE_DIR
11
11
  method_option *AgileUtils::Options::EXTS
12
12
  method_option *AgileUtils::Options::NON_EXTS
@@ -17,8 +17,13 @@ module VimPrinter
17
17
  method_option *AgileUtils::Options::VERSION
18
18
  method_option :theme,
19
19
  aliases: "-t",
20
- desc: "Vim colorscheme to use",
20
+ desc: "Vim colorscheme to use",
21
21
  default: "default"
22
+ method_option :index,
23
+ aliases: "-c",
24
+ desc: "Generate the index.html file for the result",
25
+ type: :boolean,
26
+ default: true
22
27
  def print
23
28
  opts = options.symbolize_keys
24
29
  if opts[:version]
@@ -32,24 +37,26 @@ module VimPrinter
32
37
  def usage
33
38
  puts <<-EOS
34
39
  Usage:
35
- vim_printer
40
+ vim_printer print
36
41
 
37
42
  Options:
38
43
  -b, [--base-dir=BASE_DIR] # Base directory
39
44
  # Default: . (current directory)
40
45
  -e, [--exts=one two three] # List of extensions to search for
41
- -f, [--non-exts=one two three] # List of extensions to search for
42
- -n, [--inc-words=one two three] # List of words to be included in the result
43
- -x, [--exc-words=one two three] # List of words to be excluded from the result
46
+ -f, [--non-exts=one two three] # List of files without extension to search for
47
+ -n, [--inc-words=one two three] # List of words to be included in the result if any
48
+ -x, [--exc-words=one two three] # List of words to be excluded from the result if any
44
49
  -i, [--ignore-case], [--no-ignore-case] # Match case insensitively
45
50
  # Default: true
46
51
  -r, [--recursive], [--no-recursive] # Search for files recursively
47
52
  # Default: true
53
+ -v, [--version], [--no-version] # Display version information
48
54
  -t, [--theme=THEME] # Vim colorscheme to use
49
55
  # Default: default
50
- -v, [--version], [--no-version] # Display version information
56
+ -c, [--index], [--no-index] # Generate the index.html file for the result
57
+ # Default: true
51
58
 
52
- Print the list of files
59
+ Print files to (x)html using Vim
53
60
  EOS
54
61
  end
55
62
 
@@ -62,32 +69,27 @@ Print the list of files
62
69
  # @param [Hash<Symbol, Object>] options the options argument
63
70
  def execute(options = {})
64
71
  input_files = CodeLister.files(options)
65
- input_files.delete_if { |file| File.binary?(file.gsub(/^\./,options[:base_dir])) }
72
+ input_files.delete_if { |file| File.binary?(file.gsub(/^\./, options[:base_dir])) }
66
73
  if input_files.empty?
67
74
  puts "No file found for your option: #{options}"
68
75
  return
69
76
  end
70
77
 
71
78
  to_htmls(input_files, options)
72
-
73
- # The generated files is the same as input file but with '.xhtml' appended
74
- generated_files = input_files.map do |f|
75
- "#{f}.xhtml"
76
- end
77
-
79
+ generated_files = input_files.map { |f| "#{f}.xhtml" }
78
80
  index_file = "./index.html"
79
81
  IndexHtml.htmlify generated_files,
80
82
  base_dir: options[:base_dir],
81
83
  output: index_file
82
-
83
- generated_files << index_file
84
- AgileUtils::FileUtil.tar_gzip_files(generated_files, "vim_printer_output.tar.gz")
84
+ generated_files << index_file if options[:index]
85
+ output_file = "vim_printer_#{File.basename(File.expand_path(options[:base_dir]))}.tar.gz"
86
+ AgileUtils::FileUtil.tar_gzip_files(generated_files, output_file)
85
87
  AgileUtils::FileUtil.delete(generated_files)
86
- FileUtils.rm_rf(index_file)
87
- puts "Your output file is #{File.absolute_path("vim_printer_output.tar.gz")}"
88
+ FileUtils.rm_rf(index_file) if options[:index]
89
+ puts "Your output file is '#{File.absolute_path(output_file)}'"
88
90
  end
89
91
 
90
- # convert multiple files to 'html'
92
+ # convert multiple files to html
91
93
  def to_htmls(files, options = {})
92
94
  FileUtils.chdir(File.expand_path(options[:base_dir]))
93
95
  files.each_with_index do |file, index|
data/lib/vim_printer/core_ext/file.rb CHANGED
@@ -2,10 +2,10 @@
2
2
  class File
3
3
  def self.binary?(name)
4
4
  name = File.expand_path(name)
5
- myStat = stat(name)
6
- return false unless myStat.file?
5
+ my_stat = stat(name)
6
+ return false unless my_stat.file?
7
7
  open(name) do |file|
8
- blk = file.read(myStat.blksize)
8
+ blk = file.read(my_stat.blksize)
9
9
  return blk.size == 0 ||
10
10
  blk.count("^ -~", "^\r\n") / blk.size > 0.3 || blk.count("\x00") > 0
11
11
  end
data/lib/vim_printer/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module VimPrinter
2
- VERSION = "0.1.4"
2
+ VERSION = "0.1.5"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vim_printer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.4
4
+ version: 0.1.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Burin Choomnuan
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-05-25 00:00:00.000000000 Z
11
+ date: 2014-06-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: thor