audio_book_creator 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9f56e4fa63b655b47b0d52b825263b0d755d6ca
-  data.tar.gz: 501684df9d61ef2fc39573f8e445718c3c61d42b
+  metadata.gz: 37bad1a54e431efdc1cb4bbca03b71f0a2a64128
+  data.tar.gz: 06d824f006b444f47d6bfb6da12b53d602e623b5
 SHA512:
-  metadata.gz: c78b612fe641e112006a348b2e9e196579c8edf6788dbf7d4b421c420285b1bf7b866b869ed8051b41a34684552e99f9eb9352f42b6045155c709a51952341ed
-  data.tar.gz: ccfddad3fe91416a3f463163d441570e27ab3b4b95926f7e3cbd187f637e2f3e732c25c497de12469578610276ae6302bd8ddebca69027db3f5f2beaa5a839ad
+  metadata.gz: 7c055f5ed6ea4f208c0ae3f2d92f4c6658cb25ec3f03557b8552f82c2168ece25c6b7f753b0b797afd77358af1a02492141e766735de128292f5bbcd0ff46d93
+  data.tar.gz: 5e3b8fb2bc059bb78ec951ceffeb27ebb6b59f61ada16d5da134ef9b2f887c4ea30e37ee5bfe5705d2b675800f945bf1054c30bf3d6e22b26622c54b9db04a9f

data/.gitignore

@@ -21,3 +21,5 @@ tmp
 *.txt
 *.m4a
 *.m4b
+# bundler files
+bin

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.1.0
-  - "ruby-head"
+  - 2.3.0
 addons:
   code_climate:
     repo_token:

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+- **option** --no-verbose (turns off --verbose)
+- 100% mutant coverage
+
+### Changed
+- move 'bin' to 'exe' directory
+
+## [0.0.1] - 2015-05-23
+### Added
+- **option** --title, --body, --link, --chapter to parse html pages
+- **option** --max to limit the number of pages visited
+- **option** --force-html, --force-audio to regenerate
+- **option** --voice, --rate sets speaker and words per minute
+- **option** --base-dir sets directory to hold files
+- **option** -A, --itunes loads book into itunes
+
+[unreleased]: https://github.com/kbrock/html-pipeline-abbr/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/kbrock/html-pipeline-abbr/compare/v0.0.1...v0.1.0
+[0.0.1]: https://github.com/kbrock/html-pipeline-abbr/commits/v0.0.1

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in audio_book_creator.gemspec
 gemspec
 
-# gem "pry"
-# gem "mutant"
-# gem "mutant-rspec"
+gem "byebug", require: "byebug"
+gem "mutant", "~> 0.8.0"
+gem "mutant-rspec", "~> 0.8.0"

data/README.md

@@ -25,6 +25,13 @@
 This takes html files and creates a chapterized audiobook.
   It leverages Apple's speak command and audio book binder
 
+## Goals
+
+1. create an audio book.
+2. explore [mutant](https://github.com/mbj/mutant) usage and full test coverage.
+3. explore [functional core imperative shell](https://www.destroyallsoftware.com/screencasts/catalog/functional-core-imperative-shell)
+4. explore local queued components
+4. explore javascript plugins that leverage local daemons [TODO]
 ## Installation
 
 Download [audio book binder][], link the executable into the path, and install gem. The current app store version of the application does not have the cli available.
@@ -36,14 +43,12 @@ Download [audio book binder][], link the executable into the path, and install g
 
 ## Usage
 
-audio_book_creator the_great_book http://bookurl.com/greak_book/
-
-# **TODO:** provide the command line flags
+audio_book_creator http://bookurl.com/greak_book/ --body '.content p' --link 'a.page' --chapter 'a.chapter'
 
 it will spider the files referenced by the url and create the following:
 
+pages.db
 the_great_book.mpa
-the_great_book/pages.db
 the_great_book/chapter1.txt
 the_great_book/chapter1.mpg
 the_great_book/chapter2.txt

data/audio_book_creator.gemspec

@@ -14,18 +14,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://github.com/kbrock/audio_book_creator"
   spec.license       = "MIT"
 
+  spec.bindir        = 'exe'
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "sqlite3-ruby"
+  spec.add_runtime_dependency "sqlite3"
   spec.add_runtime_dependency "nokogiri"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "codeclimate-test-reporter"
 end

data/{bin → exe}/audio_book_creator

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+lib_dir = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
 require 'audio_book_creator'
 require 'audio_book_creator/cli'
 

data/lib/audio_book_creator.rb

@@ -19,11 +19,11 @@ module AudioBookCreator
   end
 
   def self.logger=(val)
-    @log = val
+    @logger = val
   end
 
   def self.logger
-    @log ||= Logger.new(STDOUT).tap { |log| log.level = Logger::WARN }
+    @logger ||= Logger.new(STDOUT).tap { |log| log.level = Logger::WARN }
   end
 end
 
@@ -40,6 +40,7 @@ require "audio_book_creator/speaker_def"
 require "audio_book_creator/surfer_def"
 
 # data models
+require "audio_book_creator/web_page"
 require "audio_book_creator/chapter"
 require "audio_book_creator/spoken_chapter"
 
@@ -57,3 +58,4 @@ require "audio_book_creator/speaker"
 require "audio_book_creator/binder"
 require "audio_book_creator/book_creator" # full workflow
 require "audio_book_creator/conductor" # creates components of flow
+require "audio_book_creator/defaulter" # loads and stores default parameters

data/lib/audio_book_creator/binder.rb

@@ -30,6 +30,7 @@ module AudioBookCreator
 
     def params(chapters)
       ret = {
+        "-A" => nil,
         "-a" => book_def.author,
         "-t" => book_def.title,
         "-b" => speaker_def.bit_rate,
@@ -42,7 +43,7 @@ module AudioBookCreator
         # "-C" => "file.png" cover image
         nil  => chapter_params(chapters),
       }
-      ret["-A"] = nil if itunes # add audiobook to iTunes
+      ret.delete("-A") unless itunes # add audiobook to iTunes
       ret
     end
 

data/lib/audio_book_creator/book_def.rb

@@ -12,7 +12,7 @@ module AudioBookCreator
       @base_dir = base_dir
       @author   = author   || "Vicki"
       @urls = urls
-      @itunes = itunes
+      @itunes = itunes.nil? ? true : itunes
     end
 
     def filename
@@ -30,7 +30,7 @@ module AudioBookCreator
     private
 
     def self.sanitize_filename(*filenames)
-      filenames.compact.join(".").gsub(/[^-._a-z0-9A-Z]/, "-").gsub(/--*/, "-").sub(/-$/, "")
+      filenames.join(".").gsub(/[^-._a-z0-9A-Z]/, "-").gsub(/-+/, "-").sub(/-\z/, "")
     end
   end
 end

data/lib/audio_book_creator/cached_hash.rb

@@ -14,7 +14,7 @@ module AudioBookCreator
     end
 
     def [](name)
-      @cache[name] ||= @main[name]
+      @cache[name] ||= main[name]
     end
   end
 end

data/lib/audio_book_creator/cascading_array.rb

@@ -22,8 +22,8 @@ module AudioBookCreator
     end
 
     def add_chapter(value)
-      @all << value
-      @alt << value
+      all << value
+      alt << value
     end
 
     def add_unique_chapter(value)
@@ -31,8 +31,8 @@ module AudioBookCreator
     end
 
     def add_page(value)
-      @all << value
-      @main << value
+      all << value
+      main << value
     end
 
     def add_unique_page(value)
@@ -41,17 +41,17 @@ module AudioBookCreator
 
     def each(&block)
       return enum_for unless block_given?
-      @main.each(&block)
-      @alt.each(&block)
+      main.each(&block)
+      alt.each(&block)
     end
 
     # note: ever included
     def include?(value)
-      @all.include?(value)
+      all.include?(value)
     end
 
     def shift
-      @main.shift || @alt.shift
+      main.shift || alt.shift
     end
   end
 end

data/lib/audio_book_creator/chapter.rb

@@ -4,7 +4,7 @@ module AudioBookCreator
 
     def initialize(options = {})
       options.each { |n, v| public_send("#{n}=", v) }
-      @body = Array(@body).compact.join("\n\n")
+      @body = Array(body).compact.join("\n\n")
     end
 
     def filename

data/lib/audio_book_creator/cli.rb

@@ -6,34 +6,13 @@ require 'uri'
 module AudioBookCreator
   class Cli
     include Logging
-    def initialize
-      self.verbose = false
-      page_def.title_path = "h1"
-      page_def.body_path = "p"
-      page_def.link_path = "a"
-    end
 
     # stub for testing
     attr_writer :web
 
-    def set_args(argv, usage)
-      if argv.empty?
-        puts "please url", usage
-        exit 2
-      elsif argv.first.include?("://")
-        book_def.title = argv.first.split("/").last
-        book_def.urls = argv
-      else
-        book_def.title = argv.shift
-        book_def.urls = argv
-      end
-      surfer_def.cache_filename = database
-      surfer_def.host = book_def.urls.first
-    end
-
-    def database
-      "pages.db"
-    end
+    # true if we are setting the defaults
+    attr_accessor :set_defaults
+    attr_accessor :skip_defaults
 
     def verbose=(val)
       logger.level = val ? Logger::INFO : Logger::WARN
@@ -43,9 +22,11 @@ module AudioBookCreator
       options = OptionParser.new do |opts|
         opts.program_name = "audio_book_creator"
         opts.version = VERSION
-        opts.banner = "Usage: audio_book_creator [options] title url [url] [...]"
+        opts.banner = "Usage: audio_book_creator [options] [title] url [url] [...]"
         opt(opts, self) do |o|
-          o.opt(:verbose, "-v", "--verbose", "Run verbosely")
+          o.opt(:verbose, "-v", "--verbose", "--[no-]verbose", "Run verbosely")
+          o.opt(:set_defaults, "--default", "Set these parameters as default for this url regular expression")
+          o.opt(:skip_defaults, "--skip-defaults", "Skip using defaults")
         end
         opt(opts, page_def) do |o|
           o.opt(:title_path, "--title STRING", "Title css (e.g.: h1)")
@@ -55,7 +36,7 @@ module AudioBookCreator
         end
         opt(opts, surfer_def) do |o|
           o.opt(:max, "--no-max", "Don't limit the number of pages to visit")
-          o.opt(:max, "--max NUMBER", Integer, "Maximum number of pages to visit (default: 10)")
+          o.opt(:max, "--max NUMBER", Integer, "Maximum number of pages to visit")
           o.opt(:regen_html, "--force-html", "Regerate the audio")
         end
         opt(opts, speaker_def) do |o|
@@ -65,7 +46,7 @@ module AudioBookCreator
         end
         opt(opts, book_def) do |o|
           o.opt(:base_dir, "--base-dir STRING", "Directory to hold files")
-          o.opt(:itunes, "--itunes", "-A", "Load book into itunes")
+          o.opt(:itunes, "--[no-]itunes", "-A", "Load book into itunes")
         end
       end
       options.parse!(argv)
@@ -91,12 +72,26 @@ module AudioBookCreator
       @surfer_def ||= SurferDef.new
     end
 
+    def defaulter
+      @defaulter ||= Defaulter.new(page_def, book_def)
+    end
+
     def conductor
       @conductor ||= Conductor.new(page_def, book_def, speaker_def, surfer_def)
     end
 
+    # integration method
     def run
-      conductor.run
+      if set_defaults
+        if defaulter.store
+          puts "stored for #{defaulter.host}"
+        else
+          puts "not stored"
+        end
+      else
+        defaulter.load_unset_values unless skip_defaults
+        conductor.run
+      end
     end
 
     private
@@ -115,5 +110,17 @@ module AudioBookCreator
         @opts.on(*args) { |v| @model.send("#{value}=", v) }
       end
     end
+
+    def set_args(argv, usage)
+      if argv.empty?
+        puts "please url", usage
+        exit 2
+      elsif argv.first.include?("://")
+        book_def.title = argv.first.split("/").last
+      else
+        book_def.title = argv.shift
+      end
+      book_def.urls = argv
+    end
   end
 end

data/lib/audio_book_creator/conductor.rb

@@ -10,6 +10,8 @@ module AudioBookCreator
       @book_def    = book_def
       @speaker_def = speaker_def
       @surfer_def  = surfer_def
+
+      page_def.invalid_urls = invalid_urls
     end
 
     # components
@@ -17,7 +19,7 @@ module AudioBookCreator
     ## spider
 
     def page_cache
-      @page_cache ||= PageDb.new(surfer_def.cache_filename)
+      @page_cache ||= PageDb.new("pages.db", "pages", false)
     end
 
     def web
@@ -29,11 +31,11 @@ module AudioBookCreator
     end
 
     def invalid_urls
-      @invalid_urls ||= UrlFilter.new(surfer_def.host)
+      @invalid_urls ||= UrlFilter.new(book_def.urls.first)
     end
 
     def spider
-      @spider ||= Spider.new(page_def, cached_web, invalid_urls)
+      @spider ||= Spider.new(page_def, cached_web)
     end
 
     ##

data/lib/audio_book_creator/defaulter.rb

@@ -0,0 +1,41 @@
+require 'forwardable'
+module AudioBookCreator
+  class Defaulter
+    extend Forwardable
+
+    ATTRIBUTES = [:title_path, :body_path, :link_path, :chapter_path]
+    def_delegators :page_def, *ATTRIBUTES, *ATTRIBUTES.map { |a| "#{a}="}
+
+    attr_accessor :page_def
+    attr_accessor :book_def
+    attr_writer   :settings
+
+    def initialize(page_def, book_def)
+      @page_def    = page_def
+      @book_def    = book_def
+    end
+
+    def host
+      url = book_def.urls.first
+      url && URI.parse(url).host
+    end
+
+    def settings
+      # in the future, move into pages
+      @settings ||= PageDb.new("settings.db", "settings", true)
+    end
+
+    def load_unset_values
+      value = host && settings[host]
+      value.each { |n, v| public_send("#{n}=", v) } if value
+    end
+
+    def store
+      return unless host
+      settings[host] = ATTRIBUTES.each_with_object(settings[host] || {}) do |attr, h|
+        v = public_send(attr)
+        h[attr] = v if v
+      end
+    end
+  end
+end

data/lib/audio_book_creator/editor.rb

@@ -10,9 +10,8 @@ module AudioBookCreator
     # convert page[] -> chapter[]
     def parse(pages)
       pages.each_with_index.map do |page, i|
-        dom = Nokogiri::HTML(page)
-        title = page_def.title(dom) || "Chapter #{i + 1}"
-        body = page_def.body(dom)
+        title = page.css(page_def.title_path).first || "Chapter #{i + 1}"
+        body = page.css(page_def.body_path)
         Chapter.new(number: (i + 1), title: title, body: body)
       end
     end