extractexifgps 0.1.0.alpha → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 520e90a163beaf80af6f69fa4e0583a9e2729f4289917a1563980e80395eb2e3
-  data.tar.gz: 0464be9c8c7c14b94ad119b6498e00402f333d8dc3ed7bc49e7c9db39a52cbc9
+  metadata.gz: 7142bb7da371c0971216e138a8ca090320a7dc7117426fbc93c237fd9d59d321
+  data.tar.gz: 176e49db29381207153297d529f259b5ce4b9e2029eaceefdb2cbaaa21db32c7
 SHA512:
-  metadata.gz: f4a69e1094d31aff3fe02e2b6004cb809b82aa1b6f83a75a1357d1e8d4fcb11cba88c5ab2e336777c9d96c16076284a8d19b63057a736b4c13c71b55a93116be
-  data.tar.gz: 02ff1a5af99c9880936a9feb4f80e1c48e17f3f04b6c9e08c5ebb52810379cfaa2d80bbe9f8dbc09d34e212241770c03483f1d5e29368c247662ee59bd8b9b75
+  metadata.gz: 6ec235f10e4ab9287a7c01ac617aef631f405788297727caac3d8f42000b64eed6a9eafa35d1821ad7ecc64bca56e5d196fb88cac12c39ff1b8e5a389a69d008
+  data.tar.gz: 7fc72ac70efc953836081c880912a22f84416fd320fda66d84983c8d2f8c976d0d93e60b787308ff4a5e0e7f0cff8e994bb31d2f3c40b5ab582789c58db1ba03

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  Exclude:
+    - test/**/*
+    - "*.gemspec"
+
+  TargetRubyVersion:
+    2.5
+
+GuardClause:
+  MinBodyLength: 3
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+MethodLength:
+  Severity: warning
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/AndOr:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: False
+
+Style/StderrPuts:
+  Enabled: False
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -1,20 +1,21 @@
 source 'https://rubygems.org'
 
 gem 'exif', '~> 2.2'
+gem 'thor', '~> 0.20'
 
 group :development do
   gem 'bundler', '~> 1.11'
-  gem 'jeweler', '~> 2.3.9'
   gem 'byebug', '~> 8.2'
+  gem 'jeweler', '~> 2.3.9'
 
-  gem 'yard', '~> 0.7'
   gem 'rdoc', '~> 3.12'
+  gem 'yard', '~> 0.7'
 
+  gem 'guard', '~> 2.14'
+  gem 'guard-minitest', '~> 2.4'
   gem 'minitest', '~> 5.0'
   gem 'minitest-reporters', '~> 1.1'
   gem 'simplecov', '~> 0.11'
-  gem 'guard', '~> 2.14'
-  gem 'guard-minitest', '~> 2.4'
 
   gem 'rubocop', '~> 0.48'
 end

data/Gemfile.lock

@@ -134,6 +134,7 @@ DEPENDENCIES
   rdoc (~> 3.12)
   rubocop (~> 0.48)
   simplecov (~> 0.11)
+  thor (~> 0.20)
   yard (~> 0.7)
 
 BUNDLED WITH

data/README.md

@@ -14,9 +14,64 @@ gem install extractexifgps
 ```sh
 extractexifgps > images_in_current_directory.csv
 extractexifgps /some/directory/ > images_in_some_directory.csv
+
+# CSV format
+extractexifgps csv ./
+extractexifgps -C ./ # short alias
+extractexifgps csv -r ./ # file images recursively
+extractexifgps csv -o /path/to/output.csv ./ # write directly to a file
+
+# HTML format
+extractexifgps html ./
+extractexifgps -H ./ # short alias
+extractexifgps html -r ./ # file images recursively
+extractexifgps html -o /path/to/output.html ./ # write directly to a file
+extractexifgps html -t /path/to/template.erb ./ # use a custom ERB template
+```
+
+### HTML Templates
+
+`extractexifgps` comes with a default template to generate a decent-looking
+HTML table, but you can supply your own
+[ERB](https://ruby-doc.org/stdlib-2.5.1/libdoc/erb/rdoc/ERB.html) template to
+generate any kind of HTML file you like. See the built-in
+[templates/basic.html.erb](templates/basic.html.erb) as an example template.
+
+
+### Command-line Help
+
+You can get information about the command-line interface in general, or for
+specific commands:
+
+```sh
+extractexifgps help
+extractexifgps help csv
+extractexifgps help html
+```
+
+## Development
+
+### Testing
+
+A few Rake commands will help your testing:
+
+  - `rake test`: Run the test suite
+  - `rake lint`: Run the code linters
+  - `rake`: Run all tests and linters
+
+To facilitate development, consider running `guard` in the background while you
+work. Whenver a source file it changed, it will automatically run the relevent
+tests. This will provide you immediate test feedback at all times.
+
+### Documentation
+
+Generate code docs with:
+
+```sh
+rake doc
 ```
 
-## Contributing to ExtractExifGps
+### Contributing to ExtractExifGps
 
   * Check out the latest master to make sure the feature hasn't been
     implemented or the bug hasn't been fixed yet.
@@ -30,7 +85,3 @@ extractexifgps /some/directory/ > images_in_some_directory.csv
   * Please try not to mess with the Rakefile, version, or history. If you want
     to have your own version, or is otherwise necessary, that is fine, but
     please isolate to its own commit so I can cherry-pick around it.
-
-## Copyright
-
-Copyright (c) 2018 Jon Sangster. See LICENSE.txt for further details.

data/Rakefile

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
@@ -18,12 +16,12 @@ Jeweler::Tasks.new do |gem|
   gem.name = 'extractexifgps'
   gem.homepage = 'http://github.com/sangster/extractexifgps'
   gem.license = 'MIT'
-  gem.summary = %Q{Extracts EXIF GPS data from images}
-  gem.description = %Q{Extracts EXIF GPS data from images}
+  gem.summary = %(Extracts EXIF GPS data from images)
+  gem.description = %(Extracts EXIF GPS data from images)
   gem.email = 'jon@ertt.ca'
   gem.authors = ['Jon Sangster']
   gem.version = ExtractExifGps::Version::STRING
-  gem.executables = %W{extractexifgps}
+  gem.executables = %w[extractexifgps]
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -36,12 +34,10 @@ end
 
 desc 'Code coverage detail'
 task :simplecov do
-  ENV['COVERAGE'] = "true"
+  ENV['COVERAGE'] = 'true'
   Rake::Task['test'].execute
 end
 
-task :default => :test
-
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ''
@@ -51,3 +47,19 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+desc 'Run all linters'
+task lint: [:rubocop]
+
+desc 'Run all tests and linters'
+task check: %i[test rubocop]
+
+task default: :check

data/bin/extractexifgps

@@ -1,6 +1,3 @@
 #!/usr/bin/env ruby
-
 require 'extractexifgps'
-
-extractor = ExtractExifGps::DirectoryFilesExtractor.new(ARGV[0] || Dir.pwd)
-puts extractor.to_csv
+ExtractExifGps::Cli.start(ARGV)

data/extractexifgps.gemspec

@@ -0,0 +1,109 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: extractexifgps 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "extractexifgps".freeze
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Jon Sangster".freeze]
+  s.date = "2018-08-11"
+  s.description = "Extracts EXIF GPS data from images".freeze
+  s.email = "jon@ertt.ca".freeze
+  s.executables = ["extractexifgps".freeze]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rubocop.yml",
+    ".ruby_version",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/extractexifgps",
+    "extractexifgps.gemspec",
+    "lib/cli.rb",
+    "lib/coord.rb",
+    "lib/csv_renderer.rb",
+    "lib/extractexifgps.rb",
+    "lib/file_set.rb",
+    "lib/gps_extractor.rb",
+    "lib/html_renderer.rb",
+    "templates/basic.html.erb",
+    "test/coord_test.rb",
+    "test/csv_renderer_test.rb",
+    "test/extractexifgps_test.rb",
+    "test/helper.rb",
+    "test/html_renderer_test.rb",
+    "test/images/cats/.DS_Store",
+    "test/images/cats/image_e.jpg",
+    "test/images/image_a.jpg",
+    "test/images/image_b.jpg",
+    "test/images/image_c.jpg",
+    "test/images/image_d.jpg",
+    "test/integration/file_set_test.rb",
+    "test/integration/gps_extractor_test.rb"
+  ]
+  s.homepage = "http://github.com/sangster/extractexifgps".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.7.6".freeze
+  s.summary = "Extracts EXIF GPS data from images".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<exif>.freeze, ["~> 2.2"])
+      s.add_runtime_dependency(%q<thor>.freeze, ["~> 0.20"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.11"])
+      s.add_development_dependency(%q<byebug>.freeze, ["~> 8.2"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<yard>.freeze, ["~> 0.7"])
+      s.add_development_dependency(%q<guard>.freeze, ["~> 2.14"])
+      s.add_development_dependency(%q<guard-minitest>.freeze, ["~> 2.4"])
+      s.add_development_dependency(%q<minitest>.freeze, ["~> 5.0"])
+      s.add_development_dependency(%q<minitest-reporters>.freeze, ["~> 1.1"])
+      s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.11"])
+      s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.48"])
+    else
+      s.add_dependency(%q<exif>.freeze, ["~> 2.2"])
+      s.add_dependency(%q<thor>.freeze, ["~> 0.20"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.11"])
+      s.add_dependency(%q<byebug>.freeze, ["~> 8.2"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<yard>.freeze, ["~> 0.7"])
+      s.add_dependency(%q<guard>.freeze, ["~> 2.14"])
+      s.add_dependency(%q<guard-minitest>.freeze, ["~> 2.4"])
+      s.add_dependency(%q<minitest>.freeze, ["~> 5.0"])
+      s.add_dependency(%q<minitest-reporters>.freeze, ["~> 1.1"])
+      s.add_dependency(%q<simplecov>.freeze, ["~> 0.11"])
+      s.add_dependency(%q<rubocop>.freeze, ["~> 0.48"])
+    end
+  else
+    s.add_dependency(%q<exif>.freeze, ["~> 2.2"])
+    s.add_dependency(%q<thor>.freeze, ["~> 0.20"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.11"])
+    s.add_dependency(%q<byebug>.freeze, ["~> 8.2"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<yard>.freeze, ["~> 0.7"])
+    s.add_dependency(%q<guard>.freeze, ["~> 2.14"])
+    s.add_dependency(%q<guard-minitest>.freeze, ["~> 2.4"])
+    s.add_dependency(%q<minitest>.freeze, ["~> 5.0"])
+    s.add_dependency(%q<minitest-reporters>.freeze, ["~> 1.1"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.11"])
+    s.add_dependency(%q<rubocop>.freeze, ["~> 0.48"])
+  end
+end
+

data/lib/cli.rb

@@ -0,0 +1,58 @@
+require 'thor'
+
+require_relative 'csv_renderer'
+require_relative 'html_renderer'
+require_relative 'file_set'
+
+module ExtractExifGps
+  # Defines the CLI interface for this application.
+  #
+  # You can get information about command-line options with
+  # +extractexifgps help+ or +extractexifgps help <command>+ to information
+  # pertaining to the particular command.
+  class Cli < Thor
+    default_command :csv
+    map '-C' => :csv
+    map '-H' => :html
+
+    class_option :recursive, type: :boolean, aliases: %w[-r],
+                             desc: 'Recursively search subdirectories'
+    class_option :output, type: :string, aliases: %w[-o],
+                          desc: 'Write to OUTPUT instead of stdout'
+
+    desc 'csv [OPTION]... [DIR]...',
+         'Export EXIF GPS data from the images in DIR in CSV format'
+    def csv(*dirs)
+      extractor = ExtractExifGps::GpsExtractor.new(
+        FileSet.new(dirs.empty? ? ['.'] : dirs, recursive: options[:recursive])
+      )
+
+      $stdout.reopen(options[:output], 'w') if options[:output]
+      puts CsvRenderer.new(extractor)
+    end
+
+    option :template, type: :string, aliases: %w[-t],
+                      desc: 'Generate the HTML with TEMPLATE'
+    desc 'html [OPTION]... [DIR]...',
+         'Export EXIF GPS data from the images in DIR in HTML format'
+    def html(*dirs)
+      search_paths = dirs.empty? ? ['.'] : dirs
+      extractor = ExtractExifGps::GpsExtractor.new(
+        FileSet.new(search_paths, recursive: options[:recursive])
+      )
+
+      template = options[:template] || template_path('templates/basic.html.erb')
+
+      $stdout.reopen(options[:output], 'w') if options[:output]
+      puts HtmlRenderer.new(extractor,
+                            search_paths: search_paths,
+                            template: template)
+    end
+
+    private
+
+    def template_path(path)
+      Pathname.new(__FILE__).join('../../').join(path)
+    end
+  end
+end

data/lib/{coords.rb → coord.rb}

@@ -1,15 +1,17 @@
 module ExtractExifGps
-  class Coords
-    GPS_ICONS = %w{° ' "}.freeze
+  # Represents a single coordinate, either latitude or longitude, in a GPS
+  # coordinate.
+  class Coord
+    GPS_ICONS = %w[° ' "].freeze
     MAX_DECIMALS = 5
 
     class << self
       # @param [Exif::Data] data
-      # @return [Hash<Symbol, Coords>, nil] the pair of GPS coordinates from in
+      # @return [Hash<Symbol, Coord>, nil] the pair of GPS coordinates from in
       #   the given EXIF data, or +nil+ if there is none
       def from_exif(data)
         if (gps = data&.[](:gps))&.any?
-          {lat: extract(gps, :latitude), lon: extract(gps, :longitude)}
+          { lat: extract(gps, :latitude), lon: extract(gps, :longitude) }
         end
       end
 
@@ -20,11 +22,17 @@ module ExtractExifGps
       end
     end
 
+    # @param dir [#to_s] A charcter representing a cardinal direction: N, E,
+    #   S, W
+    # @param coords [Array<Number>] An array containing the coordinate 1-3
+    # numbers, representing degrees, minutes, and seconds
     def initialize(dir, coords)
       @dir = dir
       @coords = coords
     end
 
+    # @return [String] formats the given coordinate in degrees, minutes, and
+    #   secondes. ex: +N 38° 24' 10"+ +W 122° 49' 20"+
     def to_s
       parts = @coords.reject(&:zero?).map(&method(:rational_str)).zip(GPS_ICONS)
       "#{@dir} #{parts.map(&:join).join(' ')}"

data/lib/csv_renderer.rb

@@ -0,0 +1,23 @@
+require 'csv'
+
+module ExtractExifGps
+  # Render a {FileSet} as a CSV file
+  class CsvRenderer
+    CSV_COLUMNS = %w[Path Latitude Longitude].freeze
+
+    # @param files [FileSet]
+    def initialize(files)
+      @files = files
+    end
+
+    def to_s
+      CSV.generate do |csv|
+        csv << CSV_COLUMNS
+
+        @files.each do |item|
+          csv << [item[:path], item[:lat]&.to_s, item[:lon]&.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/extractexifgps.rb

@@ -1,12 +1,13 @@
 module ExtractExifGps
   module Version
-    MAJOR = 0
-    MINOR = 1
+    MAJOR = 1
+    MINOR = 0
     PATCH = 0
-    BUILD = 'alpha'
+    BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end
 end
 
-require_relative 'directory_files_extractor'
+require_relative 'cli'
+require_relative 'gps_extractor'

data/lib/file_set.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+
+module ExtractExifGps
+  # Enumerates over all the files within one or more given directories,
+  # optionally including files in subdirectories.
+  class FileSet
+    include Enumerable
+
+    # @param dirs [Array,String] one more paths to search
+    # @param recursive [Boolean] if this file set should include files from
+    #    subdirectories
+    def initialize(dirs, recursive: false)
+      @dirs = Array(dirs)
+      @recursive = recursive
+    end
+
+    def each(&block)
+      @dirs.flat_map { |d| Pathname.new(d).glob(glob_pattern).select(&:file?) }.
+        each(&block)
+    end
+
+    private
+
+    def glob_pattern
+      @recursive ? '**/*' : '*'
+    end
+  end
+end

data/lib/gps_extractor.rb

@@ -0,0 +1,38 @@
+require 'csv'
+require 'exif'
+
+require_relative 'coord'
+
+module ExtractExifGps
+  # Reads EXIF data from a given {FileSet} and extracts any available GPS data
+  class GpsExtractor
+    extend Forwardable
+    include Enumerable
+
+    def_delegator :gps_list, :each
+
+    # @param fileset [FileSet]
+    def initialize(file_set)
+      @file_set = file_set
+    end
+
+    private
+
+    def gps_list
+      exif_list.map do |item|
+        gps = Coord.from_exif(item[:exif])
+        { path: item[:path], lat: gps&.[](:lat), lon: gps&.[](:lon) }
+      end
+    end
+
+    def exif_list
+      @file_set.map { |file| { path: file, exif: exif(file) } }
+    end
+
+    def exif(path)
+      Exif::Data.new(path.binread)
+    rescue Exif::Error
+      nil
+    end
+  end
+end

data/lib/html_renderer.rb

@@ -0,0 +1,39 @@
+require 'erb'
+
+module ExtractExifGps
+  HTML_TEMPLATE = 'templates/basic.html.erb'.freeze
+
+  # Render a {FileSet} as an HTML file
+  class HtmlRenderer
+    attr_reader :search_paths, :title, :files
+
+    # @param files [FileSet]
+    # @param template [StringIO,#to_s] A +StringIO+ containing the body of an
+    #   ERB template, or the path to a template file
+    # @param title [String] The title to use in the rendered HTML file
+    # @param search_paths [Array<#to_s>] The directories searched for images
+    def initialize(files, template:, title: 'EXIF GPS', search_paths: [])
+      @files = files
+      @template = template
+      @title = title
+      @search_paths = search_paths
+    end
+
+    def to_s
+      erb.result(binding)
+    end
+
+    private
+
+    def erb
+      ERB.new(read_template, nil, '<>')
+    end
+
+    def read_template
+      case @template
+      when StringIO then @template.read
+      else IO.read(@template)
+      end
+    end
+  end
+end

data/templates/basic.html.erb

@@ -0,0 +1,97 @@
+<%
+require 'cgi'
+
+ICON_GOOGLE_MAPS =  <<BASE64.gsub(/\s+/, '')
+iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAARnQU1BAACxj
+wv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAATYSURBVGhD7ZZvbBNlHMdrjLzipe/ghYEEdYkaaT
+sUu3ZuEEVUZlhLIsOI4Y8GFaIuEtGpaNhERBMX7CKBLHSbTgkFIoZ0LUNZtnYtpdq1ReafwrqxP66
+UjaGj5Of9zufK3fW569PZFhL7TT5Zd89zfT7f6z3Xaor5PydYUjIrYtRbwkZ9W8ioj3B/JxHyuhXH
+cA6ZfmslbNJWc6L9YZMeVDHqz4XLdSvJaTc/YDbfzol/TJVVAc/Bc8nb3LyETLpdNEEWuBI7ydtkT
+km7edacJsvOOVZLbG7TKsgFz769nCqWDX2m0iqiqJ65Vks9TWKm3LXHAq7li6lS2YD7xqvV3kE0lc
+Nd+UG5hKFtM9hCHTA0+Sdcu56E2MQY//9DrS9L5tFY/Zb61fcYtGDX38+Dr2lzBCKmUjPRVI5cYM2
+xepicvgq0XJgYhfl7ayTz5ex57lGqDHKEk95693yoXTCPB1/jMdpchNtHNqKpHPHii9tegalrf/Gy
+fyQuwuudVnjmcB28cdIKZ0b6YdnBrRJZGo6n6LeP+xGtRF5cwmNYSD0nbNKdJZrKES/eGnam5O/Z9
+7xEjBXfklKKiJ67Ze5LkxfAMdo53CdwmWgqR7z4xSvjfAG88sKx6iPvww53i4SNjt2pcTmBipwWmC
+KayhEvjhsWs8L+TupYo9/OHxPHPRROjctxPkm/hXDDZnsLcU+iCNFUjnhxfOpgxJ/AuuO7+CcQ8sv
+4BX7cEfWlxuXsfqGCKoPQNvHRUrVNrLcSTeWIFxf2QDQxDPfuXysRe6B5PYxcifPjDe42yZiY8oYq
+qowAXm18hB7mbptexc37L31G3YNEUznixfEpJDxCz18ehtqTTVDF3U6vdX4B/fEYfxzHFx7YKJGW0
+24uowplhVHXQRTVI1+85tgOmJie4mXl+Ts5DS86PpXMlzPvy1Xwo70CIpX0zcxCyKi7GjLoFxBF9d
+AkFrVsggMhBwxwX1wojV9gh86dgscPvpk2VwzKn+haChAug7HPHqbKsaGrJXqZQxOZCWJ5nr4yOP/
+SIoqcOtzV/x40mtuIXubQZLIlTZ6Q9Bjg7Ar2H3ahp5dwv3+0dxI1ttCEskFJHrkUXA/+r5ohVJ55
+P+Cc01/buIufZWhSrGSS93q7oNfrhsD2bVRpMT99WMfPJVrsoYmxoCafEMkj3p4u6Kt+giqO4Fhvz
+6nCFVCTn/51MwwORsHr86QKIH7bPqo8crqlOTWPaLGHJqhGJvn4+AjE43GIDcbSSgQ3rEmTx2PiOU
+SLPTRJJVjlBeQl/M170wr4bfsLU0BN3uPaAp3+UYk8tYSnG0Irb+wFfI3H8l5ATd7t3AKVdWNQ+W4
+CXP5LGUsEGranCgQ++kAin5cCLPLGbQkelhI++7epAr6jh/JbIBt55hKcZOgxI4SXGdPkc1pgJvIC
+mUoE163mqMlfgf8iL6BW4rfPP4FA/Xv5KZALeQHWjZ2zArmUF8i2BNFiTz7lBdRLDEhKEC325FteQ
+LVE7EYJosWeQsgLqJUYICWIFnsKJS+gVuL3gWj2BYYDpuuFkhdQKtE/FE0SLfZ898PSbrF8j/PVvM
+oLYAmnf1xS4JufXd1Eiz2NJ0yzscRIwJTsdm0qiLwAlug4M8pfeZRvDLbPJlrFFFNMMbdUNJp/AAA
+NFzA9z3URAAAAAElFTkSuQmCC
+BASE64
+%><!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- load MUI -->
+    <link href="http://cdn.muicss.com/mui-0.9.39/css/mui.min.css" rel="stylesheet" type="text/css" />
+    <title><%= title %></title>
+    <style>
+      .google-map {
+        background-image: url(data:image/png;base64,<%= ICON_GOOGLE_MAPS %>);
+        background-size: cover;
+        display: block;
+        width: 24px;
+        height: 24px;
+      }
+    </style>
+  </head>
+  <body>
+    <!-- example content -->
+    <div class="mui-container">
+      <h1><%= title %></h1>
+
+      <div class="mui-panel">
+        <h2>Search Paths</h2>
+        <ul>
+<%        search_paths.each do |path| %>
+            <li><code><%= path %></code></li>
+<%        end %>
+        </ul>
+      </div>
+
+      <div class="mui-panel">
+        <h2>Results</h2>
+
+        <table class="mui-table">
+          <thead>
+            <tr>
+              <th>Path</th>
+              <th>Latitude</th>
+              <th>Longitude</th>
+              <th>Map</th>
+            </tr>
+          </thead>
+          <tbody>
+<%          files.each do |item| %>
+              <tr>
+                <td>
+                  <a href="<%= item[:path] %>"><code><%= item[:path] %></code></a>
+                </td>
+                <td><%= item[:lat] %></td>
+                <td><%= item[:lon] %></td>
+                <td>
+<%              if item[:lat] && item[:lon] %>
+                  <a class="google-map" href="https://www.google.com/maps?q=<%= CGI::escape item[:lat].to_s %>, <%= CGI::escape item[:lon].to_s  %>">
+                  </a>
+<%              end %>
+                </td>
+              </tr>
+<%          end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </body>
+</html>
+

data/test/coord_test.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+module ExtractExifGps
+  class TestCoord < UnitTest
+    def test_from_exif__missing
+      assert_nil Coord.from_exif(nil)
+      assert_nil Coord.from_exif({})
+      assert_nil Coord.from_exif(gps: {})
+    end
+
+    def test_from_exif__present
+      assert_equal({lat: %{N 38°}, lon: %{W 122°} },
+        from_exif(gps:
+          {gps_latitude_ref: "N", gps_latitude: [(38/1), (0/1), (0/1)],
+           gps_longitude_ref: "W", gps_longitude: [(122/1), (0/1), (0/1)]}
+        )
+      )
+
+      assert_equal({lat: %{N 38° 24'}, lon: %{W 122° 49'} },
+        from_exif(gps:
+          {gps_latitude_ref: "N", gps_latitude: [(38/1), (24/1), (0/1)],
+           gps_longitude_ref: "W", gps_longitude: [(122/1), (1243/25), (0/1)]}
+        )
+      )
+
+      assert_equal({lat: %{N 38° 24' 10"}, lon: %{W 122° 49' 20"} },
+        from_exif(gps:
+          {gps_latitude_ref: "N", gps_latitude: [(38/1), (24/1), (0/1), (10/1)],
+           gps_longitude_ref: "W", gps_longitude: [(122/1), (1243/25), (0/1), (20/1)]}
+        )
+      )
+    end
+
+    def test_to_s__integers
+      assert_equal %{N 1°}, coords('N', 1).to_s
+      assert_equal %{N 1° 2'}, coords('N', 1, 2).to_s
+      assert_equal %{N 1° 2' 3"}, coords('N', 1, 2, 3).to_s
+    end
+
+    def test_to_s__floats_short
+      assert_equal %{N 0.5°}, coords('N', 1/2r).to_s
+      assert_equal %{N 0.5° 0.25'}, coords('N', 1/2r, 2/8r).to_s
+      assert_equal %{N 0.5° 0.25' 0.1875"}, coords('N', 1/2r, 2/8r, 3/16r).to_s
+    end
+
+    def test_to_s__floats_long
+      assert_equal %{N 0.33333°}, coords('N', 1/3r).to_s
+      assert_equal %{N 0.33333° 0.16667'}, coords('N', 1/3r, 1/6r).to_s
+      assert_equal %{N 0.33333° 0.16667' 0.08333"}, coords('N', 1/3r, 1/6r, 1/12r).to_s
+    end
+
+    private
+
+    def from_exif(data)
+      coords = Coord.from_exif(data)
+      {lat: coords[:lat].to_s, lon: coords[:lon].to_s}
+    end
+
+    def coords(dir, *coords)
+      Coord.new(dir, coords)
+    end
+  end
+end

data/test/csv_renderer_test.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+module ExtractExifGps
+  class CsvRendererTest < UnitTest
+    def test_to_s__empty_set
+      assert_equal "Path,Latitude,Longitude\n", render([])
+    end
+
+    def test_to_s__simple
+      assert_equal "Path,Latitude,Longitude\na,b,c\n",
+                   render([item('a', 'b', 'c')])
+      assert_equal "Path,Latitude,Longitude\na,b,c\n1,2,3\n",
+                   render([item('a', 'b', 'c'), item('1', '2', '3')])
+    end
+
+    def test_to_s__no_gps
+      assert_equal "Path,Latitude,Longitude\na,,\n",
+                   render([item('a')])
+      assert_equal "Path,Latitude,Longitude\na,,\n1,,\n",
+                   render([item('a'), item('1')])
+    end
+
+    private
+
+    def render(set)
+      CsvRenderer.new(set).to_s
+    end
+
+    def item(*parts)
+      { path: parts[0], lat: parts[1], lon: parts[2] }
+    end
+  end
+end

data/test/extractexifgps_test.rb

@@ -1,8 +1,10 @@
 require 'helper'
 
-class TestExtractExifGps < UnitTest
-  def test_version
-    refute_nil ExtractExifGps::Version::MAJOR
-    refute_nil ExtractExifGps::Version::STRING
+module ExtractExifGps
+  class TestExtractExifGps < UnitTest
+    def test_version
+      refute_nil Version::MAJOR
+      refute_nil Version::STRING
+    end
   end
 end

data/test/html_renderer_test.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+module ExtractExifGps
+  class HtmlRendererTest < UnitTest
+    def test_to_s__empty_set
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', 'FILES:'),
+                   render([])
+    end
+
+    def test_to_s__simple
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', 'FILES:', '  a|b|c'),
+                   render([item('a', 'b', 'c')])
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', 'FILES:', '  a|b|c', '  1|2|3'),
+                   render([item('a', 'b', 'c'), item('1', '2', '3')])
+    end
+
+    def test_to_s__no_gps
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', 'FILES:', '  a||'),
+                   render([item('a')])
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', 'FILES:', '  a||', '  1||'),
+                   render([item('a'), item('1')])
+    end
+
+    def test_to_s__title
+      assert_equal expected_lines('TITLE: TEST', 'PATHS:', 'FILES:', '  a|b|c'),
+                   render([item('a', 'b', 'c')], title: 'TEST')
+    end
+
+    def test_to_s__search_path
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', '  path', 'FILES:', '  a|b|c'),
+                   render([item('a', 'b', 'c')], search_paths: %w[path])
+    end
+
+    def test_to_s__search_paths
+      assert_equal expected_lines('TITLE: EXIF GPS', 'PATHS:', '  a', '  b', 'FILES:', '  a|b|c'),
+                   render([item('a', 'b', 'c')], search_paths: %w[a b])
+    end
+
+    private
+
+    def render(set, args = {})
+      HtmlRenderer.new(set, {template: template_stub}.merge(args)).to_s.strip
+    end
+
+    def item(*parts)
+      { path: parts[0], lat: parts[1], lon: parts[2] }
+    end
+
+    def template_stub
+      StringIO.new <<ERB
+TITLE: <%= title %>
+PATHS:
+<% search_paths.each do |path| %>
+  <%= path %>
+<% end %>
+FILES:
+<% files.each do |item| %>
+  <%= item[:path] %>|<%= item[:lat] %>|<%= item[:lon] %>
+<% end %>
+ERB
+    end
+
+    def expected_lines(*lines)
+      lines.join("\n")
+    end
+  end
+end

data/test/integration/file_set_test.rb

@@ -0,0 +1,20 @@
+require 'helper'
+require 'pathname'
+
+module ExtractExifGps
+class FileTestTest < IntegrationTest
+    def test_each__flat
+      file_set = FileSet.new('test/images')
+
+      assert_equal %w[image_a.jpg image_b.jpg image_c.jpg image_d.jpg],
+                   file_set.each.map(&:basename).map(&:to_s).sort
+    end
+
+    def test_each__recursive
+      file_set = FileSet.new('test/images', recursive: true)
+
+      assert_equal %w[image_a.jpg image_b.jpg image_c.jpg image_d.jpg image_e.jpg],
+                   file_set.each.map(&:basename).map(&:to_s).sort
+    end
+  end
+end

data/test/integration/gps_extractor_test.rb

@@ -0,0 +1,33 @@
+require 'helper'
+require 'pathname'
+
+module ExtractExifGps
+  class GpsExtractorTest < IntegrationTest
+    def test_to_csv
+      expected = <<-CSV.gsub(/^\s+/, '')
+        Path,Latitude,Longitude
+        images/image_c.jpg,N 38° 24',W 122° 49.72'
+        images/image_a.jpg,N 50° 5.48',W 122° 56.74'
+        images/image_b.jpg,,
+        images/image_d.jpg,,
+      CSV
+
+      Dir.chdir(Pathname.new(__FILE__).join('../..')) do
+        extractor = GpsExtractor.new(FileSet.new('images'))
+        assert_equal expected, CsvRenderer.new(extractor).to_s
+      end
+    end
+
+    def test_to_csv__cats
+      expected = <<-CSV.gsub(/^\s+/, '')
+        Path,Latitude,Longitude
+        images/cats/image_e.jpg,"N 59° 55' 29.11829""","E 10° 41' 44.15323"""
+      CSV
+
+      Dir.chdir(Pathname.new(__FILE__).join('../..')) do
+        extractor = GpsExtractor.new(FileSet.new('images/cats'))
+        assert_equal expected, CsvRenderer.new(extractor).to_s
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extractexifgps
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha
+  version: 1.0.0
 platform: ruby
 authors:
 - Jon Sangster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exif
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
+        version: '0.20'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.2'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 2.3.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 2.3.9
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -95,75 +95,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +202,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".rubocop.yml"
 - ".ruby_version"
 - Gemfile
 - Gemfile.lock
@@ -196,20 +211,28 @@ files:
 - README.md
 - Rakefile
 - bin/extractexifgps
-- lib/coords.rb
-- lib/directory_files_extractor.rb
+- extractexifgps.gemspec
+- lib/cli.rb
+- lib/coord.rb
+- lib/csv_renderer.rb
 - lib/extractexifgps.rb
-- test/coords_test.rb
+- lib/file_set.rb
+- lib/gps_extractor.rb
+- lib/html_renderer.rb
+- templates/basic.html.erb
+- test/coord_test.rb
+- test/csv_renderer_test.rb
 - test/extractexifgps_test.rb
 - test/helper.rb
-- test/images/.DS_Store
+- test/html_renderer_test.rb
 - test/images/cats/.DS_Store
 - test/images/cats/image_e.jpg
 - test/images/image_a.jpg
 - test/images/image_b.jpg
 - test/images/image_c.jpg
 - test/images/image_d.jpg
-- test/integration/directory_files_extractor_test.rb
+- test/integration/file_set_test.rb
+- test/integration/gps_extractor_test.rb
 homepage: http://github.com/sangster/extractexifgps
 licenses:
 - MIT
@@ -225,9 +248,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/lib/directory_files_extractor.rb

@@ -1,50 +0,0 @@
-require 'csv'
-require 'exif'
-require 'pathname'
-
-require_relative 'coords'
-
-module ExtractExifGps
-  class DirectoryFilesExtractor
-    CSV_COLUMNS = ['Path', 'Latitude', 'Longitude'].freeze
-
-    def initialize(dir_path)
-      @dir_path = dir_path
-    end
-
-    def to_csv
-      CSV.generate do |csv|
-        csv << CSV_COLUMNS
-
-        gps_list.each do |item|
-          csv << [ item[:path],
-            item[:gps]&.[](:lat)&.to_s,
-            item[:gps]&.[](:lon)&.to_s
-          ]
-        end
-      end
-    end
-
-    private
-
-    def gps_list
-      exif_list.map do |item|
-        { path: item[:path], gps: Coords.from_exif(item[:exif]) }
-      end
-    end
-
-    def exif_list
-      files.map { |file| { path: file, exif: exif(file) } }
-    end
-
-    def files
-      Pathname.new(@dir_path).glob('*').select(&:file?)
-    end
-
-    def exif(path)
-      Exif::Data.new(path.binread)
-    rescue Exif::Error
-      nil
-    end
-  end
-end

data/test/coords_test.rb

@@ -1,61 +0,0 @@
-require 'helper'
-
-class TestCoords < UnitTest
-  def test_from_exif__missing
-    assert_nil ExtractExifGps::Coords.from_exif(nil)
-    assert_nil ExtractExifGps::Coords.from_exif({})
-    assert_nil ExtractExifGps::Coords.from_exif(gps: {})
-  end
-
-  def test_from_exif__present
-    assert_equal({lat: %{N 38°}, lon: %{W 122°} },
-      from_exif(gps:
-        {gps_latitude_ref: "N", gps_latitude: [(38/1), (0/1), (0/1)],
-         gps_longitude_ref: "W", gps_longitude: [(122/1), (0/1), (0/1)]}
-      )
-    )
-
-    assert_equal({lat: %{N 38° 24'}, lon: %{W 122° 49'} },
-      from_exif(gps:
-        {gps_latitude_ref: "N", gps_latitude: [(38/1), (24/1), (0/1)],
-         gps_longitude_ref: "W", gps_longitude: [(122/1), (1243/25), (0/1)]}
-      )
-    )
-
-    assert_equal({lat: %{N 38° 24' 10"}, lon: %{W 122° 49' 20"} },
-      from_exif(gps:
-        {gps_latitude_ref: "N", gps_latitude: [(38/1), (24/1), (0/1), (10/1)],
-         gps_longitude_ref: "W", gps_longitude: [(122/1), (1243/25), (0/1), (20/1)]}
-      )
-    )
-  end
-
-  def test_to_s__integers
-    assert_equal %{N 1°}, coords('N', 1).to_s
-    assert_equal %{N 1° 2'}, coords('N', 1, 2).to_s
-    assert_equal %{N 1° 2' 3"}, coords('N', 1, 2, 3).to_s
-  end
-
-  def test_to_s__floats_short
-    assert_equal %{N 0.5°}, coords('N', 1/2r).to_s
-    assert_equal %{N 0.5° 0.25'}, coords('N', 1/2r, 2/8r).to_s
-    assert_equal %{N 0.5° 0.25' 0.1875"}, coords('N', 1/2r, 2/8r, 3/16r).to_s
-  end
-
-  def test_to_s__floats_long
-    assert_equal %{N 0.33333°}, coords('N', 1/3r).to_s
-    assert_equal %{N 0.33333° 0.16667'}, coords('N', 1/3r, 1/6r).to_s
-    assert_equal %{N 0.33333° 0.16667' 0.08333"}, coords('N', 1/3r, 1/6r, 1/12r).to_s
-  end
-
-  private
-
-  def from_exif(data)
-    coords = ExtractExifGps::Coords.from_exif(data)
-    {lat: coords[:lat].to_s, lon: coords[:lon].to_s}
-  end
-
-  def coords(dir, *coords)
-    ExtractExifGps::Coords.new(dir, coords)
-  end
-end

data/test/integration/directory_files_extractor_test.rb

@@ -1,31 +0,0 @@
-require 'helper'
-require 'pathname'
-
-class DirectoryFilesExtractorTest < IntegrationTest
-  def test_to_csv
-    expected = <<-CSV.gsub(/^\s+/, '')
-      Path,Latitude,Longitude
-      images/image_c.jpg,N 38° 24',W 122° 49.72'
-      images/image_a.jpg,N 50° 5.48',W 122° 56.74'
-      images/image_b.jpg,,
-      images/image_d.jpg,,
-    CSV
-
-    Dir.chdir(Pathname.new(__FILE__).join('../..')) do
-      assert_equal expected,
-                   ExtractExifGps::DirectoryFilesExtractor.new('images').to_csv
-    end
-  end
-
-  def test_to_csv__cats
-    expected = <<-CSV.gsub(/^\s+/, '')
-      Path,Latitude,Longitude
-      images/cats/image_e.jpg,"N 59° 55' 29.11829""","E 10° 41' 44.15323"""
-    CSV
-
-    Dir.chdir(Pathname.new(__FILE__).join('../..')) do
-      assert_equal expected,
-                   ExtractExifGps::DirectoryFilesExtractor.new('images/cats').to_csv
-    end
-  end
-end