verkilo 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: bd2f5eb4f0d596951567629d7a89ceb2f56b5f1c
4
+ data.tar.gz: 4ca518363f9fc626596f09203a649025091aeeff
5
+ SHA512:
6
+ metadata.gz: e7ba6ae387a4007f28f08c6862dc456b8eb95bea7acd30629b83e986a41c6fd0fbd265119430ef780d24b7bd8d8c8db20edee70058c05f5e3d60a8ba67314949
7
+ data.tar.gz: 3aa465a383910a850d8aeccc02ac682b8e84a9ff37f721345a6daacb87248001c3775f1f0311087281c7d15c3a4793a4dd278e43755e0bb6695a2343ff57e8b2
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at merovex@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in verkilo.gemspec
6
+ gemspec
@@ -0,0 +1,22 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ verkilo (0.1.1)
5
+ thor (~> 0)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ rake (12.3.3)
11
+ thor (0.20.3)
12
+
13
+ PLATFORMS
14
+ ruby
15
+
16
+ DEPENDENCIES
17
+ bundler (~> 1.17)
18
+ rake (~> 12.3.3, >= 12.3.3)
19
+ verkilo!
20
+
21
+ BUNDLED WITH
22
+ 1.17.3
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 Ben W
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,53 @@
1
+ # Verkilo
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/verkilo`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'verkilo'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install verkilo
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ### Use `gem-release` Gem
34
+
35
+ ```
36
+ $ gem bump --version minor # bumps to the next minor version
37
+ $ gem bump --version major # bumps to the next major version
38
+ $ gem bump --version 1.1.1 # bumps to the specified version
39
+ ```
40
+
41
+ https://bundler.io/guides/creating_gem.html
42
+
43
+ ## Contributing
44
+
45
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/verkilo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
46
+
47
+ ## License
48
+
49
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
50
+
51
+ ## Code of Conduct
52
+
53
+ Everyone interacting in the Verkilo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/verkilo/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "verkilo"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby
2
+ # -*- mode: ruby -*-
3
+
4
+ require "verkilo"
5
+ Verkilo::CLI.start
@@ -0,0 +1,30 @@
1
+ require "verkilo/version"
2
+
3
+ module Verkilo
4
+ class Error < StandardError; end
5
+ ROOT = Pathname.new(File.dirname(__FILE__) + "/..")
6
+
7
+ # require "verkilo/extensions/string"
8
+ require "verkilo/cli"
9
+ require "verkilo/book"
10
+ require "verkilo/log"
11
+ require "verkilo/shelf"
12
+ require 'verkilo/version'
13
+
14
+ Encoding.default_internal = "utf-8"
15
+ Encoding.default_external = "utf-8"
16
+
17
+ def self.config(root_dir = nil)
18
+ root_dir ||= Pathname.new(Dir.pwd)
19
+ path = root_dir.join("_verkilo.yml")
20
+
21
+ raise "Invalid Verku directory; couldn't found #{path} file." unless File.file?(path)
22
+ content = File.read(path)
23
+ erb = ERB.new(content).result
24
+ SafeYAML::OPTIONS[:default_mode] = true
25
+ YAML.load(erb, :safe => true)
26
+ end
27
+ def self.logger
28
+ @logger ||= Logger.new(File.open("/tmp/verkilo.log", "a"))
29
+ end
30
+ end
@@ -0,0 +1,123 @@
1
+ module Verkilo
2
+ class Book
3
+ def initialize(title, root_dir, repo="none")
4
+ @title = title
5
+ @root_dir = root_dir
6
+ @resource_dir = File.join(File.dirname(File.expand_path(__FILE__)), '../../resources')
7
+ @contents = ""
8
+ @today = Time.now.strftime("%F")
9
+ @repo = repo
10
+ @bib = Dir["#{@root_dir}/**/*.bib"].first || nil
11
+ @csl = Dir["#{@root_dir}/**/*.csl"].first || nil
12
+ end
13
+
14
+ def contents
15
+ @contents unless @contents.nil?
16
+ @contents = files.map { |f| File.open(f,'r').read }.join("\n\n")
17
+ end
18
+
19
+ def to_s
20
+ @title
21
+ end
22
+ alias title to_s
23
+
24
+ def to_i
25
+ self.contents.gsub(/[^a-zA-Z\s\d]/,"").split(/\W+/).count
26
+ end
27
+ alias wordcount to_i
28
+
29
+ def compile(dir=".")
30
+ @build_dir = File.join(dir, 'build', @title)
31
+ FileUtils.mkdir_p(@build_dir)
32
+ src = File.join("/tmp", "#{@title}.md")
33
+ f = File.new(src,'w')
34
+ f.write(self.contents)
35
+ f.close
36
+ %w(frontmatter).each {|action|
37
+ dst = File.join(["/tmp", "#{@title}-#{action}.tex"])
38
+ pandoc(action, src, dst)
39
+ }
40
+ %w(yaml tex pdf docx html epub docbook).each do |action|
41
+ pandoc(action,src)
42
+ end
43
+ end
44
+
45
+ protected
46
+ def files
47
+ Dir["./#{@root_dir}/**/*.md"].sort
48
+ end
49
+ def epub_image
50
+ fname = File.join(['.', 'covers', "#{@title}-epub.png"])
51
+ raise "Epub Cover Missing (#{fname})" unless File.exist?(fname)
52
+ return fname
53
+ end
54
+ def flags(action=nil)
55
+ templates_dir = @resource_dir
56
+ css_file = if File.exist?(".verkilo/style.css")
57
+ ".verkilo/style.css"
58
+ else
59
+ File.join([templates_dir, "style.css"])
60
+ end
61
+
62
+ f = %Q(
63
+ --lua-filter #{File.join([templates_dir, "latex.lua"])} \
64
+ --metadata-file=.verkilo/defaults.yml \
65
+ --fail-if-warnings
66
+ ) + case action
67
+ when 'docx'
68
+ %Q(
69
+ --reference-doc=#{File.join([templates_dir, "reference.docx"])}
70
+ )
71
+ when 'epub'
72
+ %Q(
73
+ --css=#{css_file} \
74
+ --epub-cover-image=#{epub_image} \
75
+ --template=#{File.join([templates_dir, "epub.html"])} \
76
+ --webtex
77
+ )
78
+ when 'html'
79
+ %Q(
80
+ --css=#{css_file} \
81
+ --self-contained \
82
+ --standalone --to=html5 \
83
+ --template=#{File.join([templates_dir, "epub.html"])} \
84
+ --html-q-tags
85
+ --webtex
86
+ )
87
+ when 'tex', 'pdf'
88
+ %Q(
89
+ -B #{File.join(['/tmp',"#{@title}-frontmatter.tex"])} \
90
+ --pdf-engine=xelatex \
91
+ --template=#{File.join([templates_dir, "template.tex"])} \
92
+ -V documentclass=memoir \
93
+ -V has-frontmatter=true \
94
+ -V indent=true \
95
+ --webtex
96
+ )
97
+ when 'docbook'
98
+ %Q(-t docbook)
99
+ when 'yaml'
100
+ %Q(
101
+ -t markdown \
102
+ --template=#{File.join([templates_dir, "yaml.md"])}
103
+ )
104
+ when 'frontmatter'
105
+ %Q(
106
+ --pdf-engine=xelatex
107
+ --template=#{File.join([templates_dir, "#{action}.tex"])}
108
+ )
109
+ else
110
+ ""
111
+ end
112
+ f.gsub(/\s+/," ").strip
113
+ end
114
+ def pandoc(action,src,fname=nil)
115
+ fname = File.join(@build_dir, "#{@title}-#{@today}.#{action}") if fname.nil?
116
+ bib = (@bib.nil?) ? "" : " --bibliography #{bib}"
117
+ csl = (@csl.nil?) ? "" : " --csl #{csl}"
118
+
119
+ cmd = "pandoc -o #{fname} #{flags(action)} #{src}"
120
+ puts "%15s .. %11s => %s %s" % [@title, action, fname, `#{cmd}`]
121
+ end
122
+ end
123
+ end
@@ -0,0 +1,62 @@
1
+ require 'thor'
2
+ require 'verkilo/version'
3
+ module Verkilo
4
+ class CLI < Thor
5
+ desc "compile", "Convert Markdown files in book directory into PDF, EPUB, HTML & DOCX"
6
+ map %w(-c --compile) => :compile
7
+ def compile(root_dir=".")
8
+ say "Verkilo v#{Verkilo::VERSION}"
9
+ shelf = Verkilo::Shelf.new(root_dir)
10
+ puts "Compiling #{shelf}"
11
+ shelf.books.each do |book|
12
+ fork do
13
+ book.compile
14
+ end
15
+ end
16
+ Process.waitall
17
+ end
18
+ desc "proof", "Convert Markdown files in book directory into PDF, EPUB, HTML & DOCX"
19
+ map %w(-p --proof) => :proof
20
+ def proof(root_dir=".")
21
+ puts "Proofing #{root_dir}"
22
+ end
23
+
24
+ desc "merge", "Converts MS Word composite file back into Markdown files."
25
+ map %w(-m --merge) => :merge
26
+ def merge(root_dir=".")
27
+ puts "Merging #{root_dir}"
28
+ end
29
+
30
+ desc "wordcount", "Wordcount the books in the repository and write to YAML file."
31
+ map %w(-w --wordcount) => :wordcount
32
+ def wordcount(root_dir=".")
33
+ shelf = Verkilo::Shelf.new(root_dir)
34
+ wc_log = Verkilo::Log.new('wordcount',root_dir)
35
+ wc_log.data = shelf.wordcount
36
+ wc_log.write
37
+
38
+ puts "Wordcount for #{shelf}: #{shelf.wordcount.to_yaml}Written to #{wc_log.filename}"
39
+ end
40
+ desc "version", "Prints the Verkilo's version information"
41
+ map %w(-v --version) => :version
42
+ def version
43
+ say "Verkilo version #{Verkilo::VERSION}"
44
+ end
45
+
46
+ private
47
+ # def config
48
+ # YAML.load_file(config_path).with_indifferent_access
49
+ # end
50
+ def config_path
51
+ root_dir.join(".verkilo/defaults.yml")
52
+ end
53
+ def root_dir
54
+ @root ||= Pathname.new(Dir.pwd)
55
+ end
56
+ def inside_ebook!
57
+ unless File.exist?(config_path)
58
+ raise Error, "You have to run this command from inside a Verkilo directory."
59
+ end
60
+ end
61
+ end
62
+ end