halation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9308067582bac50fd0f310776ad78c9f39d1acb8
-  data.tar.gz: 9e3d0d27119569498dc2d18182db25f77d93e446
+  metadata.gz: 3f17cbb31bfe6de7fa8a260e962b84443392cccf
+  data.tar.gz: 709958a6604ad60526a116c8c4850d70992194cb
 SHA512:
-  metadata.gz: f5d8b142c7debffa1e1eea48e436be27dd2c1bf138c2615a3fe9ecfa11e3be5d870ea574b7585d3090bfc0b2fa92f3b0c5e55825e94b03b4a7e82e472cc872f0
-  data.tar.gz: 4432fc7e1667ec1ad8a848ba1084a6c1ac426ba3bfe343c90c2fb8afebff536a21701fb7ed1382aaea178f818b2296da474b4bc751e6a2255f577023e54da2f7
+  metadata.gz: 9bda60501dde8ab1d422326094d559c4a0265ecb51bba5bec00ba5bb1b5944215d083bae11918d4bc550cf2b50a9ab2978e01e4bef2c17a9dacd06de8b106439
+  data.tar.gz: 07b54f563fa6186b1d973c1b2d3bc0c7e05bc4fa29f38f98ff2844825b982f065e492e0405fb8c2b24b51580ba67666629ae4ad4982837a32ff020484903d7e3

data/README.md

@@ -1,3 +1,214 @@
 # Halation
 
+[![Gem Version](https://badge.fury.io/rb/halation.svg)](https://badge.fury.io/rb/halation)
+[![Coverage Status](https://coveralls.io/repos/github/amclain/halation/badge.svg?branch=master)](https://coveralls.io/github/amclain/halation?branch=master)
+[![API Documentation](https://img.shields.io/badge/docs-api-blue.svg)](http://www.rubydoc.info/gems/halation)
+[![MIT License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](https://github.com/amclain/halation/blob/master/LICENSE)
+
 Add Exif metadata to film photographs.
+
+## Issues, Bugs, Feature Requests
+
+Any bugs and feature requests should be reported on the GitHub issue tracker:
+
+https://github.com/amclain/halation/issues
+
+
+**Pull requests are preferred via GitHub.**
+
+Mercurial users can use [Hg-Git](http://hg-git.github.io/) to interact with
+GitHub repositories.
+
+## Installation
+
+Halation is available as a Ruby gem.
+
+1. Install [Ruby](https://www.ruby-lang.org) 2.1 or higher.
+    * Windows: Use [RubyInstaller](http://rubyinstaller.org/downloads/).
+    * Mac: Use [homebrew](https://www.ruby-lang.org/en/documentation/installation/#homebrew).
+    * Linux: Use [rbenv](https://github.com/sstephenson/rbenv#basic-github-checkout).
+    * [Additional installation instructions](https://www.ruby-lang.org/en/documentation/installation)
+
+2. Install [ExifTool](http://www.sno.phy.queensu.ca/~phil/exiftool/).
+
+3. Open the [command line](http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/)
+    and type:
+    
+```text
+    gem install halation
+```
+
+## Configuration
+
+Halation stores its global configuration data in `.halation` in the system's
+user directory. This is typically `~/.halation` on Mac and *nix-based systems,
+or `C:\Users\.halation` on Windows.
+
+>Halation uses the [YAML syntax](http://www.yaml.org/spec/1.2/spec.html#Preview)
+for its configuration files.
+
+By default Halation uses a global configuration file, `~/.halation/config.yml`.
+This is where your generic settings are stored, like your name, copyright info,
+and information about your cameras.
+
+```yaml
+# Example config.yml
+---
+artist: "Example User"
+copyright: "2016 Example User"
+cameras:
+  - tag: "rz67"
+    make: "Mamiya"
+    model: "Mamiya RZ67 Pro II"
+    lenses:
+      - tag: 65
+        model: "M65mm f/4L-A"
+        focal_length: 65
+      - tag: 110
+        model: "Z110mm f/2.8W"
+        focal_length: 110
+      - tag: 180
+        model: "Z180mm f/4.5W-N"
+        focal_length: 180
+      - tag: 250
+        model: "M65mm f/4L-A"
+        focal_length: 250
+```
+
+## Tags
+
+Tags are user-defined values that serve as a quick and simple way to reference
+complex information.
+
+Why is this important? Let's say you shot a roll of ten images with several
+different lenses. It would be cumbersome to have to specify a model number
+like `Z110mm f/2.8W` (and all the other lens information) on each of the frames.
+Even more importantly, if you're processing batches of images over a long period
+of time (months, years), you're bound to make mistakes in the spelling of the
+model number. This is important because any software that catalogs images based
+on Exif data (Lightroom, Flickr) doesn't know how to deal with these
+inconsistencies. This means `Z110mm f/2.8W` and `Z110mm f/2.8 W` will be
+considered two different lenses by the software (did you see the difference?),
+even though we as humans understand they're the same thing. If you try to filter
+by lens in Lightroom, some of the images will be under one spelling and some
+will be under the other, even though they were both shot with the same
+110mm lens.
+
+Tags solve this problem by letting us define all of the complex,
+infrequently-changing data in one place. We can then reference that complex
+data by its `tag`. For example, if we have a 65mm lens and a 110mm lens we can
+define their information once and tag them as `65` and `110` respectively (we
+choose the tag names).
+
+```yaml
+lenses:
+  - tag: 65
+    model: "M65mm f/4L-A"
+    focal_length: 65
+  - tag: 110
+    model: "Z110mm f/2.8W"
+    focal_length: 110
+```
+
+Now when we want to reference which lens was used when capturing a particular
+frame, all we have to do is specify the tag and Halation will fill in the
+correct Exif data for that lens when the image file is processed.
+
+```yaml
+frames:
+  - number: 1
+    lens: 110
+  - number: 2
+    lens: 65
+  - number: 3
+    lens: 110
+```
+
+## Processing A Roll
+
+Halation requires all of the image files for a roll of film to be in the same
+directory. The images should be named in ascending alphabetical order, with the
+first frame of the roll at the start of the list and the last frame at the end.
+This is typically the default when scanners save files. Halation will scan for
+tiff files (`.tif`, `.tiff`), which is the ideal format, as well as jpeg files
+(`.jpg`, `.jpeg`).
+
+This directory should also contain a `roll.yml` file, which specifies the data
+for each frame (image file) on the roll of film. A new `roll.yml` file can be
+generated in the current directory with the following command:
+
+```text
+    halation --new-roll
+```
+
+The data for the roll can then be entered into the file:
+
+```yaml
+# Example roll.yml
+---
+date: "2016-01-01"
+camera: "rz67"
+lens: 110
+iso: 100
+frames:
+  - number: 1
+    shutter: "1/125"
+    aperture: 8
+  - number: 2
+    shutter: "2"
+    lens: 65
+    aperture: 16
+  - number: 3
+    lens: 65
+    shutter: "0.5"
+    aperture: 16
+  - number: 4
+    lens: 65
+    shutter: "0.5"
+    aperture: 16
+  - number: 5
+    shutter: "1/250"
+    aperture: 4
+  - number: 6
+    shutter: "1/125"
+    aperture: 8
+  - number: 7
+    shutter: "1/125"
+    aperture: 8
+  - number: 8
+    shutter: "1/60"
+    aperture: 22
+  - number: 9
+    date: "2016-01-02"
+    shutter: "1/400"
+    aperture: 8
+    flash: yes
+  - number: 10
+    date: "2016-01-02"
+    shutter: "1/400"
+    aperture: 8
+    flash: yes
+```
+
+Default values can be set at the beginning of the file so that these settings
+don't have to be specified for each frame. For example, the roll of film has
+one ISO speed for all of the frames, so this can be specified at the top instead
+of for each individual frame.
+
+Values like the date are a little different, because maybe the whole roll was
+shot during the same day, or maybe it was shot over the course of several days.
+This is where the `roll.yml` file provides flexibility. Specifying `date` at the
+beginning of the file will make it the default date for all of the frames on the
+roll. If not all of the frames were shot on the same day, `date` can then be
+specified for each of the frames that have a different date (`9` and `10` in
+the example above). This concept works for most of the values.
+
+>A complete list of keywords are available in the [Halation API documentation](http://www.rubydoc.info/gems/halation),
+as well as in the [sample files](https://github.com/amclain/halation/tree/master/spec/samples).
+
+After all of the necessary values are entered into `roll.yml`, the images can
+be processed by running the following command:
+
+```text
+    halation
+```

data/bin/halation

@@ -1,2 +1,5 @@
 #! /usr/bin/env ruby
-require 'halation'
+
+require_relative '../lib/halation'
+
+Halation::Script.run

data/doc/Halation.html

@@ -81,7 +81,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/halation.rb<span class="defines">,<br />
-  lib/halation/version.rb</span>
+  lib/halation/roll.rb,<br /> lib/halation/coerce.rb,<br /> lib/halation/config.rb,<br /> lib/halation/engine.rb,<br /> lib/halation/script.rb,<br /> lib/halation/version.rb,<br /> lib/halation/roll/frame.rb,<br /> lib/halation/config/lens.rb,<br /> lib/halation/config/camera.rb,<br /> lib/halation/tools/exif_tool/image.rb</span>
 </dd>
   </dl>
   
@@ -98,7 +98,17 @@
 <div class="tags">
   
 
-</div>
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Halation/Coerce.html" title="Halation::Coerce (class)">Coerce</a></span>, <span class='object_link'><a href="Halation/Config.html" title="Halation::Config (class)">Config</a></span>, <span class='object_link'><a href="Halation/Engine.html" title="Halation::Engine (class)">Engine</a></span>, <span class='object_link'><a href="Halation/ExifToolImage.html" title="Halation::ExifToolImage (class)">ExifToolImage</a></span>, <span class='object_link'><a href="Halation/Roll.html" title="Halation::Roll (class)">Roll</a></span>, <span class='object_link'><a href="Halation/Script.html" title="Halation::Script (class)">Script</a></span>
+    
+  
+</p>
+
   <h2>Constant Summary</h2>
   
     <dl class="constants">
@@ -117,7 +127,7 @@
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -133,7 +143,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May  4 22:46:35 2016 by
+  Generated on Sat May 28 22:28:56 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.7).
 </div>

data/doc/Halation/AttrHelpers.html

@@ -0,0 +1,288 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Halation::AttrHelpers
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "Halation::AttrHelpers";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Halation.html" title="Halation (module)">Halation</a></span></span>
+     &raquo; 
+    <span class="title">AttrHelpers</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <iframe id="search_frame" src="../class_list.html"></iframe>
+
+      <div id="content"><h1>Module: Halation::AttrHelpers
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+  <dl>
+    <dt>Included in:</dt>
+    <dd><span class='object_link'><a href="Config/Camera.html" title="Halation::Config::Camera (class)">Config::Camera</a></span>, <span class='object_link'><a href="Config/Lens.html" title="Halation::Config::Lens (class)">Config::Lens</a></span></dd>
+  </dl>
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/halation/attr_helpers.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Class attr helpers. Extend this module to opt-in to its functionality.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#attr_reader_int_or_nil-instance_method" title="#attr_reader_int_or_nil (instance method)">#<strong>attr_reader_int_or_nil</strong>(*sym)  &#x21d2; Integer<sup>?</sup> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#attr_reader_str_or_nil-instance_method" title="#attr_reader_str_or_nil (instance method)">#<strong>attr_reader_str_or_nil</strong>(*sym)  &#x21d2; String<sup>?</sup> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="attr_reader_int_or_nil-instance_method">
+  
+    #<strong>attr_reader_int_or_nil</strong>(*sym)  &#x21d2; <tt>Integer</tt><sup>?</sup> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/halation/attr_helpers.rb', line 11</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_attr_reader_int_or_nil'>attr_reader_int_or_nil</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_with_instance_variables'>with_instance_variables</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>&amp;&amp;=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="attr_reader_str_or_nil-instance_method">
+  
+    #<strong>attr_reader_str_or_nil</strong>(*sym)  &#x21d2; <tt>String</tt><sup>?</sup> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+6
+7
+8</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/halation/attr_helpers.rb', line 6</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_attr_reader_str_or_nil'>attr_reader_str_or_nil</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_with_instance_variables'>with_instance_variables</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>&amp;&amp;=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Thu May  5 23:51:49 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.1.7).
+</div>
+
+    </div>
+  </body>
+</html>