filmrolls 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c76d0b39ce19d86260e8c2099db97ba2621f72855f53e4596e11b951c6f780
-  data.tar.gz: e80e00c4e49318a5bb033296273d2c47abc0d5004fd04847376c54ab30315f04
+  metadata.gz: bc2322c8fbcc81c5a5db45f32c3c936484bc2ed5ef52802b35c382c4fc32f7ce
+  data.tar.gz: 130a70fd8e9e36b8f2ac7a90aa12b8c7645049a095747311765b13da98b4d15d
 SHA512:
-  metadata.gz: 7ee694d21071c1702f6b81221981c0d593828e97875c82bbb6829edf36c5b06ea1cdd65277b6e5040833a7540459655f796123a171f6591a3a57a7f51c584a59
-  data.tar.gz: 07d72da124bae93814d8e5c57dedb059c00713b2eb7d15a0bc883896eda15d2f5d99919f03969a664a44a01c60837601729d92a97d0fc6edc1fbaf7f283cdb99
+  metadata.gz: da52df23af0ecfbefcfb0db808982b2a60d89c1e40329d1d3a03915814cf9f8a1a5f2948ea82c06954106dc87c532effc4beb19f22ab594a1f9e42ab76e3b94d
+  data.tar.gz: 9b0dd8f451a49c6450de2cb924071231a9e18d99976410f2df99573a7129e330a46c10e3596746fa764af589c0e797181b65cb98514d807c7a7741d8b6dd0a2b

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2019-06-01
+### Added
+- Support for writing author metadata (copyright, license, etc.)
+
+## [0.1.3] - 2019-05-30
+### Fixed
+- Write APEX shutter speed values and non-APEX aperture values
+
+## [0.1.2] - 2019-05-29
+### Fixed
+- Write correct values to GPS latitude/longitude reference fields
+- Set `ISOSpeed` and `SensitivityType` EXIF tags
+
+## [0.1.1] - 2019-05-26
+### Fixed
+- Write `ExposureTime` EXIF tag rather than `ShutterSpeedValue`
+- Trim spaces from camera and lens make/model EXIF tags
+
+## [0.1.0] - 2019-05-24
+### Added
+- First release of the `filmrolls` tool
+
+[Unreleased]: https://github.com/urdh/filmrolls/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/urdh/filmrolls/compare/v0.1.3...v0.2.0
+[0.1.3]: https://github.com/urdh/filmrolls/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/urdh/filmrolls/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/urdh/filmrolls/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/urdh/filmrolls/releases/tag/v0.1.0

data/filmrolls.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   EOF
 
   s.files = %w[
+    CHANGELOG.md
     filmrolls.gemspec
     Rakefile
     README.md
@@ -28,15 +29,20 @@ Gem::Specification.new do |s|
     lib/filmrolls.rb
     lib/filmrolls/cli.rb
     lib/filmrolls/exiftool.rb
+    lib/filmrolls/metadata.rb
     lib/filmrolls/negative.rb
     lib/filmrolls/version.rb
     lib/filmrolls/xmlformat.rb
     test/test_helper.rb
     test/test_exiftool.rb
+    test/test_metadata.rb
     test/test_xmlformat.rb
     test/data/filmrolls.xml
     test/data/with-exif.tiff
     test/data/without-exif.tiff
+    test/data/meta-copyright.yaml
+    test/data/meta-creative-commons.yaml
+    test/data/meta-public-domain.yaml
   ]
   # TODO: how to generate the man page and inclue in the gem?
 
@@ -48,6 +54,7 @@ Gem::Specification.new do |s|
   s.require_paths = 'lib'
   s.test_files    = %w[
     test/test_exiftool.rb
+    test/test_metadata.rb
     test/test_xmlformat.rb
   ]
 

data/lib/filmrolls.rb

@@ -1,3 +1,4 @@
 require 'filmrolls/version'
 require 'filmrolls/negative'
+require 'filmrolls/metadata'
 require 'filmrolls/xmlformat'

data/lib/filmrolls/cli.rb

@@ -13,6 +13,9 @@ module Filmrolls
       global_option '-r', '--rolls FILE', 'Film Rolls XML file (default: stdin)' do |r|
         $rolls_file = r
       end
+      global_option '-m', '--meta FILE', 'Author metadata YAML file' do |r|
+        $yaml_file = r
+      end
 
       command 'list-rolls' do |c|
         c.syntax      = 'filmrolls list-rolls [--rolls FILE]'
@@ -63,7 +66,7 @@ module Filmrolls
       end
 
       command :tag do |c|
-        c.syntax      = 'filmrolls tag [--dry-run] [--rolls FILE] --id ID IMAGE...'
+        c.syntax      = 'filmrolls tag [--dry-run] [--meta FILE] [--rolls FILE] --id ID IMAGE...'
         c.summary     = 'Write EXIF tags'
         c.description = 'Write EXIF tags to a set of images using data from ' \
                         'film roll with ID in input.'
@@ -83,6 +86,9 @@ module Filmrolls
             abort "Expected #{roll[:frames].length} images, got #{args.length}"
           end
 
+          meta = get_metadata($yaml_file)
+          meta.each { |k, v| log k.to_s.gsub('_',' ').capitalize, v }
+
           roll[:frames].zip(args).each do |frame, file|
             log 'Path', file
             negative = Filmrolls::Negative.new(file)
@@ -110,6 +116,28 @@ module Filmrolls
               log 'Position', frame[:position]
               negative.position = frame[:position]
             end
+            negative.merge(meta)
+            negative.save! unless options.dry_run
+          end
+        end
+      end
+
+      command 'apply-metadata' do |c|
+        c.syntax      = 'filmrolls apply-metadata [--dry-run] --meta FILE IMAGE...'
+        c.summary     = 'Write author metadata'
+        c.description = 'Write author metadata to a set of images using YAML data from FILE.'
+        c.option '-n', '--dry-run', "Don't actually modify any files"
+
+        c.action do |args, options|
+          abort "A YAML file must be supplied" if $yaml_file.nil?
+
+          meta = get_metadata($yaml_file)
+          meta.each { |k, v| log k.to_s.gsub('_',' ').capitalize, v }
+
+          args.each do |file|
+            log 'Path', file
+            negative = Filmrolls::Negative.new(file)
+            negative.merge(meta)
             negative.save! unless options.dry_run
           end
         end
@@ -126,6 +154,14 @@ module Filmrolls
           abort "Could not read input XML: #{err.message}"
         end
       end
+
+      def get_metadata(file)
+        begin
+          file.nil? ? Hash.new : Filmrolls::Metadata.load(File.read(file))
+        rescue SystemCallError => err
+          abort "Could not read input YAML: #{err.message}"
+        end
+      end
     end
   end
 end

data/lib/filmrolls/exiftool.rb

@@ -7,6 +7,7 @@ module Filmrolls
 
     def initialize(filename_or_io = nil, opts = {})
       opts[:timestamps] = DateTime unless opts.key? :timestamps
+      opts[:coord_format] = "%.6f degrees" unless opts.key? :coord_format
       super(filename_or_io, opts)
     end
   end

data/lib/filmrolls/metadata.rb

@@ -0,0 +1,81 @@
+require 'yaml'
+
+module Filmrolls
+  module Metadata
+    class Parser
+      def self.load(io)
+        doc = YAML.load(io)
+        # Data validation, sort of
+        raise 'YAML input missing `author` key' unless doc.key?('author')
+        raise 'YAML input missing `author.name` key' unless doc['author'].key?('name')
+        raise "YAML input has invalid license `#{doc['license']}`" unless is_valid_license(doc['license'])
+        # Output construction
+        {
+          author:      doc['author']['name'],
+          copyright:   get_copyright(doc['author']['name'], doc['license']),
+          author_url:  doc['license'].nil? ? nil : doc['author']['url'],
+          license_url: get_license_url(doc['license']),
+          marked:      !is_public_domain(doc['license']),
+          usage_terms: get_usage_terms(doc['author']['name'], doc['license'])
+        }.delete_if { |k, v| v.nil? }
+      end
+
+      class << self
+        private
+
+        def is_valid_license(license)
+          license.nil? or LICENSES.key?(license.to_sym)
+        end
+
+        def is_public_domain(license)
+          license == 'cc0'
+        end
+
+        def get_copyright(author, license)
+          is_public_domain(license) ?
+              "© #{author}, %{year}. No rights reserved." :
+            license.nil? ?
+              "© #{author}, %{year}. All rights reserved." :
+              "© #{author}, %{year}. Some rights reserved."
+        end
+
+        def get_license_url(license)
+          LICENSES[license.to_sym][:url] unless license.nil?
+        end
+
+        def get_usage_terms(author, license)
+          if is_public_domain(license)
+            [ "To the extent possible under law, #{author} has waived all",
+              'copyright and related or neighboring rights to this work.' ].join(' ')
+          elsif not license.nil?
+            name = LICENSES[license.to_sym][:name]
+            url = LICENSES[license.to_sym][:url]
+            [ "This work is licensed under the Creative Commons #{name} 4.0 International License.",
+              "To view a copy of this license, visit #{url} or send a letter to Creative Commons,",
+              '171 Second Street, Suite 300, San Francisco, California, 94105, USA.' ].join(' ')
+          end
+        end
+
+        LICENSES = {
+          'cc0': { 'url': 'https://creativecommons.org/publicdomain/zero/1.0/' },
+          'cc-by': {       'name': 'Attribution',
+                           'url': 'https://creativecommons.org/licenses/by/4.0/' },
+          'cc-by-sa': {    'name': 'Attribution-ShareAlike',
+                           'url': 'https://creativecommons.org/licenses/by-sa/4.0/' },
+          'cc-by-nd': {    'name': 'Attribution-NoDerivatives',
+                           'url': 'https://creativecommons.org/licenses/by-nd/4.0/' },
+          'cc-by-nc': {    'name': 'Attribution-NonCommercial',
+                           'url': 'https://creativecommons.org/licenses/by-nc/4.0/' },
+          'cc-by-nc-sa': { 'name': 'Attribution-NonCommercial-ShareAlike',
+                           'url': 'https://creativecommons.org/licenses/by-nc-sa/4.0/' },
+          'cc-by-nc-nd': { 'name': 'Attribution-NonCommercial-NoDerivatives',
+                           'url': 'https://creativecommons.org/licenses/by-nc-nd/4.0/' }
+        }
+      end
+    end
+
+    def self.load(io)
+      Parser.load(io)
+    end
+  end
+end

data/lib/filmrolls/negative.rb

@@ -3,13 +3,13 @@ require 'filmrolls/exiftool'
 module Filmrolls
   class Negative
     def initialize(path)
-      @file = Exiftool.new(path, :coord_format => "%.6f degrees")
+      @file = Exiftool.new(path)
     end
 
-    def merge(*args)
+    def merge(args)
       args.each do |key, value|
         method = "#{key}="
-        @self.public_send(method, value) if @self.respond_to? method
+        public_send(method, value) if respond_to? method
       end
     end
 
@@ -77,5 +77,39 @@ module Filmrolls
       @file[:Make] = make.strip
       @file[:Model] = model.strip
     end
+
+    def author=(val)
+      @file[:Artist] = val
+      @file['By-Line'] = val
+      @file[:Author] = val
+      @file[:Creator] = val
+      @file['By-lineTitle'] = 'Photographer'
+      @file[:AttributionName] = val if @file[:License]
+    end
+
+    def copyright=(val)
+      year = @file[:datetimecreated] ? @file[:datetimecreated].year : DateTime.now.year
+      notice = (val % {:year => year})
+      @file[:Copyright] = notice
+      @file[:CopyrightNotice] = notice
+      @file[:Rights] = notice
+    end
+
+    def author_url=(val)
+      @file[:AttributionURL] = val
+    end
+
+    def license_url=(val)
+      @file[:License] = val
+      @file[:AttributionName] = @file[:Artist] if @file[:Artist]
+    end
+
+    def marked=(val)
+      @file[:Marked] = val
+    end
+
+    def usage_terms=(val)
+      @file[:UsageTerms] = val
+    end
   end
 end

data/lib/filmrolls/version.rb

@@ -1,3 +1,3 @@
 module Filmrolls
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/man/filmrolls.1

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "FILMROLLS" "1" "May 2019" "" "filmrolls v0.1.3"
+.TH "FILMROLLS" "1" "June 2019" "" "filmrolls v0.2.0"
 .
 .SH "NAME"
 \fBfilmrolls\fR \- Tag TIFF files with EXIF data extracted from XML data
 .
 .SH "SYNOPSIS"
-\fBfilmrolls list\-rolls [\-\-rolls FILE]\fR \fBfilmrolls list\-frames [\-\-rolls FILE] \-\-id ID\fR \fBfilmrolls tag [\-\-rolls FILE] \-\-id ID FILES\.\.\.\fR
+\fBfilmrolls list\-rolls [\-\-rolls FILE]\fR \fBfilmrolls list\-frames [\-\-rolls FILE] \-\-id ID\fR \fBfilmrolls tag [\-\-meta FILE] [\-\-rolls FILE] \-\-id ID FILES\.\.\.\fR \fBfilmrolls apply\-metadata \-\-meta FILE FILES\.\.\.\fR
 .
 .SH "DESCRIPTION"
 Reads XML data from the \fIFilm Rolls\fR iOS app and displays or applies this data as EXIF tags to a given set of files\.
@@ -19,6 +19,10 @@ Reads XML data from the \fIFilm Rolls\fR iOS app and displays or applies this da
 Input XML file\. If this argument is not present, XML is read from standard input\.
 .
 .TP
+\fB\-m\fR, \fB\-\-meta\fR
+Input YAML file containing author metadata\. Only applicable to the \fBtag\fR and \fBapply\-metadata\fR commands\. For a brief description of the YAML keys, see \fIMETADATA FORMAT\fR\.
+.
+.TP
 \fB\-i\fR, \fB\-\-id\fR
 A specific film roll to work with, keyed by the \fINotes\fR field of the \fIFilm Rolls\fR content\.
 .
@@ -28,20 +32,69 @@ Don\'t actually modify any files\.
 .
 .SH "COMMANDS"
 .
+.IP "\(bu" 4
+\fBlist\-rolls\fR: List all film rolls in the input XML, along with some common metadata\.
+.
+.IP "\(bu" 4
+\fBlist\-frames\fR: List all frames of the given roll in the input XML, along with all the relevant metadata\.
+.
+.IP "\(bu" 4
+\fBtag\fR: Tag the given input files with EXIF data based on the given roll in the input XML\. All file formats supported by exiftool(1) are supported\. The number of files to tag must match the number of frames in the given roll\.
+.
+.IP
+\fBNote:\fR No attempt to validate the file format of the target files will be made, and the command will exit after the first failure\. Use the \fB\-\-dry\-run\fR flag to verify the command\-line arguments before performing real actions\.
+.
+.IP "\(bu" 4
+\fBapply\-metadata\fR Apply author metadata to the given input files based on the given YAML author metadata file\.
+.
+.IP "" 0
+.
+.SH "METADATA FORMAT"
+The YAML author metadata format is extremely simple:
+.
+.IP "" 4
+.
+.nf
+
+author:
+  name: A\. Photographer
+  url: https://example\.com/
+license: cc\-by\-sa
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The \fBurl\fR key may be omitted, as may the \fBlicense\fR key to indicate that the usual "all rights reserved" copyright restrictions apply\. Valid values for the \fBlicense\fR key are the following:
+.
 .TP
-\fBlist\-rolls\fR
-List all film rolls in the input XML, along with some common metadata\.
+\fBcc0\fR
+Creative Commons 1\.0 Universal Public Domain Declaration
 .
 .TP
-\fBlist\-frames\fR
-List all frames of the given roll in the input XML, along with all the relevant metadata\.
+\fBcc\-by\fR
+Creative Commons 4\.0 Attribution International License
 .
 .TP
-\fBtag\fR
-Tag the given input files with EXIF data based on the given roll in the input XML\. All file formats supported by exiftool(1) are supported\. The number of files to tag must match the number of frames in the given roll\.
+\fBcc\-by\-sa\fR
+Creative Commons 4\.0 Attribution\-ShareAlike International License
 .
-.IP
-\fBNote:\fR No attempt to validate the file format of the target files will be made, and the command will exit after the first failure\. Use the \fB\-\-dry\-run\fR flag to verify the command\-line arguments before performing real actions\.
+.TP
+\fBcc\-by\-nd\fR
+Creative Commons 4\.0 Attribution\-NoDerivatives International License
+.
+.TP
+\fBcc\-by\-nc\fR
+Creative Commons 4\.0 Attribution\-NonCommercial International License
+.
+.TP
+\fBcc\-by\-nc\-sa\fR
+Creative Commons 4\.0 Attribution\-NonCommercial\-ShareAlike International License
+.
+.TP
+\fBcc\-by\-nc\-nd\fR
+Creative Commons 4\.0 Attribution\-NonCommercial\-NoDerivatives International License
 .
 .SH "SEE ALSO"
 exiftool(1)

data/test/data/meta-copyright.yaml

@@ -0,0 +1,3 @@
+author:
+  name: Simon Sigurdhsson
+  url: http://photography.sigurdhsson.org/

data/test/data/meta-creative-commons.yaml

@@ -0,0 +1,4 @@
+author:
+  name: Simon Sigurdhsson
+  url: http://photography.sigurdhsson.org/
+license: cc-by-nc

data/test/data/meta-public-domain.yaml

@@ -0,0 +1,4 @@
+author:
+  name: Simon Sigurdhsson
+  url: http://photography.sigurdhsson.org/
+license: cc0

data/test/test_metadata.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+require 'minitest/autorun'
+require 'filmrolls/metadata'
+
+describe 'Filmrolls::Metadata.load' do
+  describe 'a creative-commons configuration' do
+    let(:data) do
+      @output ||= Filmrolls::Metadata.load(File.read('test/data/meta-creative-commons.yaml'))
+    end
+
+    it 'should have the correct author' do
+      data[:author].must_equal 'Simon Sigurdhsson'
+    end
+
+    it 'should have the correct copyright string' do
+      data[:copyright].must_equal '© Simon Sigurdhsson, %{year}. Some rights reserved.'
+    end
+
+    it 'should have the correct attribution url' do
+      data[:author_url].must_equal 'http://photography.sigurdhsson.org/'
+    end
+
+    it 'should have the correct license url' do
+      data[:license_url].must_equal 'https://creativecommons.org/licenses/by-nc/4.0/'
+    end
+
+    it 'should have the marked attribute' do
+      data[:marked].must_equal true
+    end
+
+    it 'should have the correct usage terms' do
+      data[:usage_terms].must_equal [
+        'This work is licensed under the Creative Commons',
+        'Attribution-NonCommercial 4.0 International License. To view a copy',
+        'of this license, visit https://creativecommons.org/licenses/by-nc/4.0/',
+        'or send a letter to Creative Commons, 171 Second Street, Suite 300,',
+        'San Francisco, California, 94105, USA.'
+      ].join(' ')
+    end
+  end
+
+  describe 'a copyright configuration' do
+    let(:data) do
+      @output ||= Filmrolls::Metadata.load(File.read('test/data/meta-copyright.yaml'))
+    end
+
+    it 'should have the correct author' do
+      data[:author].must_equal 'Simon Sigurdhsson'
+    end
+
+    it 'should have the correct copyright string' do
+      data[:copyright].must_equal '© Simon Sigurdhsson, %{year}. All rights reserved.'
+    end
+
+    it 'should have no attribution url' do
+      data.keys.wont_include :author_url
+    end
+
+    it 'should have no license url' do
+      data.keys.wont_include :license_url
+    end
+
+    it 'should have the marked attribute' do
+      data[:marked] = true
+    end
+
+    it 'should have no usage terms' do
+      data.keys.wont_include :usage_terms
+    end
+  end
+
+  describe 'a public domain configuration' do
+    let(:data) do
+      @output ||= Filmrolls::Metadata.load(File.read('test/data/meta-public-domain.yaml'))
+    end
+
+    it 'should have the correct author' do
+      data[:author].must_equal 'Simon Sigurdhsson'
+    end
+
+    it 'should have the correct copyright string' do
+      data[:copyright].must_equal '© Simon Sigurdhsson, %{year}. No rights reserved.'
+    end
+
+    it 'should have the correct attribution url' do
+      data[:author_url].must_equal 'http://photography.sigurdhsson.org/'
+    end
+
+    it 'should have the correct license url' do
+      data[:license_url].must_equal 'https://creativecommons.org/publicdomain/zero/1.0/'
+    end
+
+    it 'should not have the marked attribute' do
+      data[:marked] = false
+    end
+
+    it 'should have the correct usage terms' do
+      data[:usage_terms].must_equal [
+        'To the extent possible under law, Simon Sigurdhsson has waived',
+        'all copyright and related or neighboring rights to this work.'
+      ].join(' ')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filmrolls
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Sigurdhsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_exiftool
@@ -219,6 +219,7 @@ extra_rdoc_files:
 - LICENSE.md
 - bin/filmrolls
 files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - Rakefile
@@ -227,15 +228,20 @@ files:
 - lib/filmrolls.rb
 - lib/filmrolls/cli.rb
 - lib/filmrolls/exiftool.rb
+- lib/filmrolls/metadata.rb
 - lib/filmrolls/negative.rb
 - lib/filmrolls/version.rb
 - lib/filmrolls/xmlformat.rb
 - man/filmrolls.1
 - test/data/filmrolls.xml
+- test/data/meta-copyright.yaml
+- test/data/meta-creative-commons.yaml
+- test/data/meta-public-domain.yaml
 - test/data/with-exif.tiff
 - test/data/without-exif.tiff
 - test/test_exiftool.rb
 - test/test_helper.rb
+- test/test_metadata.rb
 - test/test_xmlformat.rb
 homepage: https://github.com/urdh/filmrolls
 licenses:
@@ -268,4 +274,5 @@ specification_version: 4
 summary: Tag TIFF files with EXIF data extracted from XML data
 test_files:
 - test/test_exiftool.rb
+- test/test_metadata.rb
 - test/test_xmlformat.rb