scrunch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 541e2ba569fefb5b4f0d15d8f3924f9f0af36b89
+  data.tar.gz: cbb4f381a749fd35f5465b1d266b8030d67dbc7d
+SHA512:
+  metadata.gz: f16189be8c93ea4253933c702d0cbdef2e87cee931ede426175a564a23ffc829c39da27e916df2095cbf3c69e9f19d298c263083357dad73bd7904d9510056b2
+  data.tar.gz: acb3137385082612f9533badc1e5daba1ff7263c2c22b6080acf0241d4d3a41af82d90cff5f90814e87724b240a0a2324da1f2b8f26dc7dfd8a767d930348fe1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.rdoc_options

@@ -0,0 +1,30 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- "."
+charset: UTF-8
+exclude:
+- "todo.org"
+- "CODE_OF_CONDUCT.md"
+- "README.org"
+- "LICENSE.txt"
+- "Gemfile.lock"
+- "Gemfile"
+- "srcunch.gemspec"
+- "Rakefile"
+hyperlink_all: true
+line_numbers: true
+locale:
+locale_dir: locale
+locale_name:
+main_page:
+markup: markdown
+output_decoration: true
+page_dir:
+show_hash: false
+tab_width: 8
+template_stylesheets: []
+title:
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.0
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at geoff@mac.into.sh. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scrunch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Geoff MacIntosh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.org

@@ -0,0 +1,39 @@
+#+TITLE: Scrunch
+
+Squish audiobooks with force.
+
+Scrunch is a Ruby Gem that converts audiobooks into tiny, [[https://en.wikipedia.org/wiki/High-Efficiency_Advanced_Audio_Coding#Versions][HE-AAC
+v2]]-encoded files. These files are high-quality with small file sizes
+and designed for things like audiobooks. Importantly, they are totally
+supported on iOS, so you can carry enough books on your phone to last
+a lifetime or two. That's how you win at the game of life.
+
+* Requirements
+You need a few things to scrunch.
+
+1. A computer running macOS. 10.12 Sierra and 10.11 El Capitan are
+   supported for sure. Previous versions probably work fine too, but I
+   don't have computers to test for sure. macOS is needed for the
+   ~afcovert~ tool that is made by Apple, and only present on macOS.
+   Sorry.
+2. AtomicParsley. This is best installed via [[http://brew.sh][Homebrew]]. Install
+   Homebrew via its instructions then run ~brew install atomicparsley~
+   in your terminal. It's available on [[https://www.macports.org][MacPorts]] and [[https://nixos.org/nix/][Nix]] too.
+3. (Optional) Ruby. macOS ships with a totally useable version of
+   Ruby, but it requires a password to install gems. So maybe ~brew
+   install ruby~?
+
+* Installation
+Scrunch is a ruby gem. Install it via ~gem install scrunch~ and get
+scrunching. Also then listen to the audiobook. Why would you make an
+audiobook totally awesome and not listen to it after? That's crazy.
+
+* Usage
+That's the easy part. Get an audiobook that you want to scrunch, then
+run ~scrunch path/to/audiobook.m4b~ in the terminal. Scrunch currently
+only supports m4a/m4b files, and it won't currently concatenate
+audiobooks that are broken up into multiple files.
+
+* Notes
+Scrunch is currently under development. It will be better in the
+future. Check out what's [[file:todo.org][upcoming]].

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scrunch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/scrunch

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scrunch"
+
+Main.run

data/lib/scrunch/main.rb

@@ -0,0 +1,49 @@
+# Generic. Basically everything.
+module Main
+  # Checks to see if a program is on $PATH.
+  def self.on_path?(prog_name)
+    !`which "#{prog_name}"`.empty?
+  end
+
+  # Complains if the requested program is not on $PATH
+  def self.assert_required(prog_name)
+    raise "Could not find \"#{prog_name}\".\n" unless on_path?(prog_name)
+  end
+
+  # Checks to ensure the correct  number of arguments have been passed
+  # to scrunch.
+  def self.check_args
+    return if ARGV.length == 1
+    abort "Usage: scrunch <audiobook>"
+  end
+
+  # AtomicParsley and afconvert are required for scrunch to scrunch,
+  # so they needs checking for.
+  def self.check_reqs
+    assert_required "AtomicParsley"
+    assert_required "afconvert"
+  end
+
+  # Well, scrunch doesn't fly, but it does scrunch, so some checks are
+  # made to ensure that it is ready to scrunch. This runs the other
+  # methods that check for problems before scrunchery.
+  def self.preflight
+    check_args
+    check_reqs
+    abort "No such file or directory" unless File.file?(ARGV[0])
+  end
+
+  # Scrunches.
+  def self.run
+    preflight
+    input_filename = File.absolute_path(ARGV[0])
+    metadata = Meta.get_metadata(input_filename)
+    output_filename = Meta.make_filename(input_filename)
+
+    puts "Scrunching..."
+    system Transcode.crush_file(input_filename, output_filename)
+    cover = Meta.get_cover(input_filename)
+    system Meta.apply_metadata(output_filename, metadata, cover)
+    system "rm \"#{cover}\""
+  end
+end

data/lib/scrunch/meta.rb

@@ -0,0 +1,44 @@
+# The part that deals with metadata collection and generation.
+# Currently, all metadata is collected and written by the
+# command-line-tool atomicparsley.
+module Meta
+  # Uses atomicparsley to collect metadata from the audiobook and
+  # return it as a fancy hash. Returns the following values:
+  # - nam (Title)
+  # - alb (Series)
+  # - ART (Author)
+  def self.get_metadata(file)
+    atoms = `AtomicParsley \"#{file}\" -t`
+    atoms.each_line.each_with_object({}) do |line, hash|
+      prefix, contents = line.split(": ")
+      atom_name = /([\w]{3,4})(?=\" contains)/.match(prefix).to_s
+      hash[atom_name] = contents.strip unless atom_name.empty?
+      hash
+    end
+  end
+
+  # Uses atomicparsley to write the embedded cover image to disk in
+  # the same directory as the audiobook.
+  def self.get_cover(input_file)
+    unprocessed = `AtomicParsley \"#{input_file}\" -E`
+    /(?<=\: ).*/.match(unprocessed).to_s
+  end
+
+  ## Returns the final filename that is written finally.
+  def self.make_filename(input_file)
+    input_file[0...-4] + "-new.m4b"
+  end
+
+  # Writes the metadata to the file.
+  def self.apply_metadata(file, metadata, cover)
+    %(AtomicParsley \"#{file}\" \
+--title \"#{metadata["nam"]}\" \
+--album \"#{metadata["alb"]}\" \
+--artist \"#{metadata["ART"]}\" \
+--genre \"Audiobooks\" \
+--stik \"Audiobook\" \
+--artwork \"#{cover}\" \
+--overWrite \
+2>&1 1>/dev/null)
+  end
+end

data/lib/scrunch/transcode.rb

@@ -0,0 +1,8 @@
+# Everything reincoding. Compression and concatenation mostly.
+module Transcode
+  #  Compresses the file using afconvert. The output file is an He-AAC
+  #  v2 file that is 32 kB/s.
+  def self.crush_file(input_file, output_file)
+    "afconvert \"#{input_file}\" -f m4bf -d aacp 32000 -o \"#{output_file}\""
+  end
+end

data/lib/scrunch/version.rb

@@ -0,0 +1,4 @@
+module Scrunch
+  # The current version number.
+  VERSION = "0.1.0".freeze
+end

data/lib/scrunch.rb

@@ -0,0 +1,7 @@
+require "scrunch/version"
+require "scrunch/meta"
+require "scrunch/transcode"
+require "scrunch/main"
+
+# Scrunches.
+module Scrunch end

data/scrunch.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scrunch/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = "scrunch"
+  spec.version       = Scrunch::VERSION
+  spec.authors       = ["Geoff MacIntosh"]
+  spec.email         = ["geoff@mac.into.sh"]
+
+  spec.executables   = ["scrunch"]
+
+  spec.summary       = "Squish audiobooks with force"
+  spec.description   = "A tool to make audiobooks smaller"
+  spec.homepage      = "https://github.com/geoffmacintosh/scrunch"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.46.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc", ">= 0.6.0"
+  spec.add_development_dependency "method_source", ">= 0.8.2"
+end
+# rubocop:enable Metrics/BlockLength

data/todo.org

@@ -0,0 +1,23 @@
+#+TITLE: Scrunch: Game Plan
+
+* [0/5] Fixes
+** TODO [[file:lib/scrunch/meta.rb::def%20self.get_metadata(file)][Meta.get_metadata]]
+- [ ] Change the name of Meta.get_metadata to Meta.get
+- [ ] Describe what the regex in Meta.get_metadata does
+- [ ] Add support to get the series number metadata (includes Meta.apply_metadata)
+
+** TODO [[file:lib/scrunch/meta.rb::def%20self.get_cover(input_file)][Meta.get_cover]]
+- [ ] I have no idea what that regex matches. Find out.
+- [ ] Move this possibly. It's kind of metadata, but it's also dealt
+  with totally differently. Maybe it is totally different.
+
+** TODO [[file:lib/scrunch/meta.rb::def%20self.apply_metadata(file,%20metadata,%20cover)][Meta.apply_metadata]]
+- [ ] Change this method to something like Meta.write.
+- [ ] Oh god it's ugly. Make it less that.
+
+** TODO [[file:lib/scrunch/transcode.rb::def%20self.crush_file(input_file,%20output_file)][Transcode.crush_file]]
+- [ ] Rename this to Transcode.crush or something.
+
+** TODO Shell rm
+- [ ] Change Main.run so that it deletes the cover with ruby instead
+  of a shell script: [[file:lib/scrunch/main.rb::system%20"rm%20\"#{cover}\""][Shell rm]]

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: scrunch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff MacIntosh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: A tool to make audiobooks smaller
+email:
+- geoff@mac.into.sh
+executables:
+- scrunch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- exe/scrunch
+- lib/scrunch.rb
+- lib/scrunch/main.rb
+- lib/scrunch/meta.rb
+- lib/scrunch/transcode.rb
+- lib/scrunch/version.rb
+- scrunch.gemspec
+- todo.org
+homepage: https://github.com/geoffmacintosh/scrunch
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Squish audiobooks with force
+test_files: []