unpack_macbinary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f18f006fd2f33eec88dd43ee62e86261964384d
+  data.tar.gz: 55318a7e66a6e465adf3ec9ce44c0e84290b49c7
+SHA512:
+  metadata.gz: eb67f1f07f167f93049c0d4e8f2a677f84c8153444889a3c31dd5d2e5fc26e73c5388e666a66b8322fe066f5a23c2055741f5b90bf35e554a7fe221603a4f603
+  data.tar.gz: 95ee4be1521c839e798a1482cd8c2f475210d5d4709bcf6c42fd21bb58b15f8b0ca17388a0def310d9ca691017db6247aef87a7da39ab66da3e32d210fbc9027

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mistydemeo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,15 @@
+                     KINDEST PUBLIC LICENSE
+                    Version 1, September 2015                    
+
+ Copyright (C) 2015 Misty De Meo <mistydemeo@gmail.com>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+                      KINDEST PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+  1. At your option, you may perform an act of kindness for a stranger.
+     This is encouraged, but not a condition of using this software.

data/README.md

@@ -0,0 +1,46 @@
+# unpack_macbinary
+
+This tool provides a helper to convert files from MacBinary format into native Mac HFS+ files.
+
+Mac OS's HFS and HFS+ filesystems has a concept of file "forks"; each file has both a *data fork*, which contains arbitrary binary data like on other filesystems, and a *resource fork*, which contains structured data in a Mac OS-specific format.
+The [MacBinary format](https://en.wikipedia.org/wiki/MacBinary) is a format designed to bundle files with both data and resource forks in a format which can be losslessly transferred to other filesystems; it was most widely used in the 1990s.
+
+However, if a Mac user should *receive* a MacBinary file, it's not straightforward to convert that file back into a native Mac OS file.
+This tool simplifies the process of turning a MacBinary file into a native Mac file by wrapping a tool from the [macutils](http://ibiblio.org/pub/linux/utils/compress/macutils.tar.gz) package.
+
+## Installation
+
+To run this, you'll need macutils to be installed.
+If you use Homebrew, you can:
+
+    $ brew install mistydemeo/formulae/macutils
+
+Then install the gem using:
+
+    $ gem install unpack_macbinary
+
+Note that, because this produces native Mac OS files, you can only use this tool on OS X.
+
+## Usage
+
+Just provide this tool the names of the files to unpack:
+
+    $ unpack_macbinary first.bin second.bin third.bin
+
+The MacBinary files should all have filenames ending in ".bin".
+The processed output file will be named the same as the input file, except without the file extension.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/unpack_macbinary. 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.
+
+## License
+
+unpack_macbinary is licensed using the Kindest Public License.
+See LICENSE for usage details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unpack_macbinary"
+
+# 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/unpack_macbinary

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require "fileutils"
+
+include FileUtils
+
+require "slop"
+
+require "unpack_macbinary"
+
+def which(cmd, path = ENV["PATH"])
+  path.split(File::PATH_SEPARATOR).each do |p|
+    begin
+      pcmd = File.expand_path(cmd, p)
+    rescue ArgumentError
+      # File.expand_path will raise an ArgumentError if the path is malformed.
+      # See https://github.com/Homebrew/homebrew/issues/32789
+      next
+    end
+    return pcmd if File.file?(pcmd) && File.executable?(pcmd)
+  end
+  nil
+end
+
+def unpack macbinary
+  output_files = MacBinary.unpack macbinary
+
+  output = File.basename(macbinary, ".bin")
+
+  # Data fork forms the basis of the output file.
+  mv output_files[:data], output
+  # Copy the resource fork into it
+  begin
+    MacBinary.add_resource_fork output, output_files[:rsrc]
+  rescue
+    # Remove the data fork if something goes wrong
+    rm output
+    raise
+  ensure
+    # Always make sure the temporary resource forks are cleaned up.
+    rm [output_files[:info], output_files[:rsrc]]
+  end
+end
+
+if self.to_s == "main"
+  opts = Slop.parse do |o|
+    o.on "-h", "--help", "Display this message" do
+      puts o
+    end
+    o.on "-v", "--version", "Print the version" do
+      puts MacBinary::VERSION
+      exit
+    end
+  end
+
+  if !which "macunpack"
+    $stderr.puts "macunpack is not installed!"
+    exit 1
+  end
+
+  if opts.arguments.empty?
+    $stderr.puts "No files specified!"
+    exit 1
+  end
+
+  missing_files = opts.arguments.select {|f| !File.exist? f}
+  if !missing_files.empty?
+    $stderr.puts "The following input files cannot be found: #{missing_files.join(" ")}"
+    exit 1
+  end
+
+  success = true
+
+  opts.arguments.each do |macbinary|
+    puts "Processing #{macbinary}..."
+    begin
+      unpack macbinary
+    rescue MacBinary::MacunpackException
+      $stderr.puts "macunpack failed while processing file \"#{macbinary}\"!"
+      success = false
+    end
+  end
+
+  exit success ? 0 : 1
+end

data/lib/macbinary_unpack.rb

@@ -0,0 +1,35 @@
+require "unpack_macbinary/version"
+
+require "fileutils"
+
+module MacBinary
+  class MacunpackException < StandardError; end
+
+  def self.unpack macbinary, target_dir=Dir.pwd
+    # macunpack always unpacks into the working directory
+    cd target_dir do
+      # macunpack will sanitize the source filename if it contains spaces
+      sanitized = File.basename(macbinary.gsub(" ", "_"), ".bin")
+
+      # -3 extracts data and resource forks even if they're empty
+      if !system "macunpack", "-3", macbinary
+        raise MacunpackException, "macunpack returned non-zero exit status"
+      end
+
+      output_files = {
+        data: "#{target_dir}/#{sanitized}.data",
+        info: "#{target_dir}/#{sanitized}.info",
+        rsrc: "#{target_dir}/#{sanitized}.rsrc"
+      }
+
+      raise MacunpackException, "macunpack did not generate a data fork" unless File.exist? output_files[:data]
+      raise MacunpackException, "macunpack did not generate a data fork" unless File.exist? output_files[:rsrc]
+
+      return output_files
+    end
+  end
+
+  def self.add_resource_fork data_fork, resource_fork
+    FileUtils.cp resource_fork, "#{data_fork}/..namedfork/rsrc"
+  end
+end

data/lib/unpack_macbinary.rb

@@ -0,0 +1,35 @@
+require "unpack_macbinary/version"
+
+require "fileutils"
+
+module MacBinary
+  class MacunpackException < StandardError; end
+
+  def self.unpack macbinary, target_dir=Dir.pwd
+    # macunpack always unpacks into the working directory
+    cd target_dir do
+      # macunpack will sanitize the source filename if it contains spaces
+      sanitized = File.basename(macbinary.gsub(" ", "_"), ".bin")
+
+      # -3 extracts data and resource forks even if they're empty
+      if !system "macunpack", "-3", macbinary
+        raise MacunpackException, "macunpack returned non-zero exit status"
+      end
+
+      output_files = {
+        data: "#{target_dir}/#{sanitized}.data",
+        info: "#{target_dir}/#{sanitized}.info",
+        rsrc: "#{target_dir}/#{sanitized}.rsrc"
+      }
+
+      raise MacunpackException, "macunpack did not generate a data fork" unless File.exist? output_files[:data]
+      raise MacunpackException, "macunpack did not generate a data fork" unless File.exist? output_files[:rsrc]
+
+      return output_files
+    end
+  end
+
+  def self.add_resource_fork data_fork, resource_fork
+    FileUtils.cp resource_fork, "#{data_fork}/..namedfork/rsrc"
+  end
+end

data/lib/unpack_macbinary/version.rb

@@ -0,0 +1,3 @@
+module MacBinary
+  VERSION = "0.1.0"
+end

data/unpack_macbinary.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unpack_macbinary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unpack_macbinary"
+  spec.version       = MacBinary::VERSION
+  spec.authors       = ["Misty De Meo"]
+  spec.email         = ["mistydemeo@gmail.com"]
+  spec.licenses      = ["kindest"]
+
+  spec.summary       = %q{Tool to unpack MacBinary files into native Mac data/resource fork files.}
+  spec.homepage      = "https://github.com/mistydemeo/unpack_macbinary"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "slop", "~> 4.2"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: unpack_macbinary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Misty De Meo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- mistydemeo@gmail.com
+executables:
+- unpack_macbinary
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/unpack_macbinary
+- lib/macbinary_unpack.rb
+- lib/unpack_macbinary.rb
+- lib/unpack_macbinary/version.rb
+- unpack_macbinary.gemspec
+homepage: https://github.com/mistydemeo/unpack_macbinary
+licenses:
+- kindest
+metadata: {}
+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.1
+signing_key: 
+specification_version: 4
+summary: Tool to unpack MacBinary files into native Mac data/resource fork files.
+test_files: []