dzt 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c018286ce3a4f3757165b6161bf7b72bed6b27f7
-  data.tar.gz: a33c40482e316a18db138ae5e6a4874c6fcd2b16
+  metadata.gz: ce8a839471a23570ac4124ed734deeb67747ea4d
+  data.tar.gz: 9f7a6fcbb80de844dfb0f4398dfb32ce7f93b214
 SHA512:
-  metadata.gz: b0071e6a9db8c4c60d997ec3e74a99468a5772536efdba703ab4d69a2cda1dcea021d5d61c8cf8cab6734ca41cb561612dbe5a2d37d11ce647e94fe25b667d5b
-  data.tar.gz: 19b6653c1f5b024abe55f605eb38098f9eb43d3f786bf0c175ef1866fa9e311bc774e81351da38a01eb4dfb2b59cdf5cbf5aa20eaa804e5fd4fed47977013c45
+  metadata.gz: 1aa34f46fde849ee1719c4d27e4d87bb6a5fe6237cb093db7a689560ca7782b45006ccb7bdc0db1b66f0b3f4ca8b8db590ae171a012e0b36bfdf6b98ee776cc0
+  data.tar.gz: 8f4ac4a4d1ad796d92a52bd462bd508f19f91bce011312ff93ffc0bf504e64ece03575a4b45b46e1c0d2732565e293ff1232d8f3e7d720a83c0ae107a143eb75

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### Next Release (TBD)
+
+* Your contribution here.
+
+### 0.2.2 (6/12/2015)
+
+* [#9](https://github.com/dblock/dzt/issues/9): Do not require fog unless producing output to S3, clarify require fog - [@dblock](https://github.com/dblock).
+
 ### 0.2.1 (1/2/2015)
 
 * [#8](https://github.com/dblock/dzt/pull/8): Fixes setting quality via command line - [@dzucconi](https://github.com/dzucconi).

data/CONTRIBUTING.md

@@ -1,10 +1,118 @@
-Contributing
-============
+Contributing to Dzt
+===================
 
-You're encouraged to contribute to this gem.
+Dzt is work of [many of contributors](https://github.com/dblock/dzt/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/dblock/dzt/pulls), [propose features and discuss issues](https://github.com/dblock/dzt/issues).
 
-* Fork this project.
-* Make changes, write tests.
-* Updated [CHANGELOG](CHANGELOG.md).
-* Make a pull request, bonus points for topic branches.
+#### Fork the Project
 
+Fork the [project on Github](https://github.com/dblock/dzt) and check out your copy.
+
+```
+git clone https://github.com/contributor/dzt.git
+cd dzt
+git remote add upstream https://github.com/dblock/dzt.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/dzt](spec/dzt).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/dzt and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/dzt/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/bin/dzt

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 require 'gli'
 require 'dzt'
-require 'fog'
 
 include GLI::App
 
@@ -9,7 +8,7 @@ program_desc 'Tile images into deep-zoom tiles'
 
 default_command :slice
 
-desc "Slice an image"
+desc 'Slice an image'
 command :slice do |c|
   c.flag [:o, :output, 'output'], desc: 'Output folder'
   c.flag [:ts, :tilesize, 'tile-size'], desc: 'Tile size', default_value: DZT::Tiler::DEFAULT_TILE_SIZE, type: Integer
@@ -22,15 +21,13 @@ command :slice do |c|
   c.flag [:s3_key, 's3-key'], desc: 'S3 Key', default_value: DZT::S3Storage::DEFAULT_KEY
   c.flag [:aws_id, 'aws-id'], desc: 'AWS Id'
   c.flag [:aws_secret, 'aws-secret'], desc: 'AWS Secret'
-  c.action do |global_options, options, args|
-    if args.length < 1
-      raise 'You must specify an image file to slice.'
-    end
+  c.action do |_global_options, options, args|
+    fail 'You must specify an image file to slice.' if args.length < 1
     if options[:output]
       storage = DZT::FileStorage.new(
         destination: options[:output]
       )
-    else
+    elsif options[:aws_id] && options[:aws_secret] && options[:bucket]
       storage = DZT::S3Storage.new(
         s3_acl: options[:acl],
         s3_bucket: options[:bucket],
@@ -38,6 +35,8 @@ command :slice do |c|
         aws_id: options[:aws_id],
         aws_secret: options[:aws_secret]
       )
+    else
+      fail 'You must specify either --output or --aws_id, --aws_secret and --bucket.'
     end
     tiler = DZT::Tiler.new(
       source: args[0],

data/lib/dzt/file_storage.rb

@@ -8,7 +8,7 @@ module DZT
     end
 
     def exists?
-      File.directory?(@store_path) && ! Dir["@{@store_path}/*"].empty?
+      File.directory?(@store_path) && !Dir['@{@store_path}/*'].empty?
     end
 
     def storage_location(level)
@@ -24,4 +24,4 @@ module DZT
       file.write(dest) { self.quality = quality if quality }
     end
   end
-end
+end

data/lib/dzt/s3_storage.rb

@@ -18,11 +18,14 @@ module DZT
     end
 
     def s3
-      @s3 ||= Fog::Storage.new(
-        provider: 'AWS',
-        aws_access_key_id: @s3_id,
-        aws_secret_access_key: @s3_secret
-      )
+      @s3 ||= begin
+        require_fog!
+        Fog::Storage.new(
+          provider: 'AWS',
+          aws_access_key_id: @s3_id,
+          aws_secret_access_key: @s3_secret
+        )
+      end
     end
 
     # Currently does not supporting checking S3 fo overwritten files
@@ -31,19 +34,28 @@ module DZT
     end
 
     def storage_location(level)
-      "#{@s3_key}/#{level.to_s}"
+      "#{@s3_key}/#{level}"
     end
 
     # no-op
-    def mkdir(path)
+    def mkdir(_path)
     end
 
     def write(file, dest, options = {})
       quality = options[:quality]
       s3.put_object(@s3_bucket, dest, file.to_blob { @quality = quality if quality },
-        'Content-Type' => file.mime_type,
-        'x-amz-acl' => @s3_acl
-      )
+                    'Content-Type' => file.mime_type,
+                    'x-amz-acl' => @s3_acl
+                   )
     end
-  end 
-end
+
+    private
+
+    def require_fog!
+      require 'fog'
+    rescue LoadError => e
+      STDERR.puts 'Fog is required for storing data in S3, run `gem install fog`.'
+      raise e
+    end
+  end
+end

data/lib/dzt/tiler.rb

@@ -7,7 +7,7 @@ module DZT
     DEFAULT_TILE_SIZE = 512
     DEFAULT_TILE_OVERLAP = 0
     DEFAULT_QUALITY = 75
-    DEFAULT_TILE_FORMAT = "jpg"
+    DEFAULT_TILE_FORMAT = 'jpg'
     DEFAULT_OVERWRITE_FLAG = false
 
     # Generates the DZI-formatted tiles and sets necessary metadata on this object.
@@ -22,7 +22,7 @@ module DZT
     #
     def initialize(options)
       @tile_source = options[:source]
-      raise "Missing options[:source]." unless @tile_source
+      fail 'Missing options[:source].' unless @tile_source
 
       @tile_source = Magick::Image.read(@tile_source)[0] if @tile_source.is_a?(String)
       @tile_size = options[:size] || DEFAULT_TILE_SIZE
@@ -41,27 +41,29 @@ module DZT
     # Generates the DZI-formatted tiles and sets necessary metadata on this object.
     # Uses a default tile size of 512 pixels, with a default overlap of 2 pixel.
     ##
-    def slice!(&block)
-      raise "Output #{@destination} already exists!" if ! @overwrite && @storage.exists?
+    def slice!(&_block)
+      fail "Output #{@destination} already exists!" if ! @overwrite && @storage.exists?
 
       image = @tile_source.dup
-      orig_width, orig_height = image.columns, image.rows
+      orig_width = image.columns
+      orig_height = image.rows
 
       # iterate over all levels (= zoom stages)
       max_level(orig_width, orig_height).downto(0) do |level|
-        width, height = image.columns, image.rows
+        width = image.columns
+        height = image.rows
 
         current_level_storage_dir = @storage.storage_location(level)
         @storage.mkdir(current_level_storage_dir)
-        if block_given?
-          yield current_level_storage_dir
-        end
+        yield current_level_storage_dir if block_given?
 
         # iterate over columns
-        x, col_count = 0, 0
+        x = 0
+        col_count = 0
         while x < width
           # iterate over rows
-          y, row_count = 0, 0
+          y = 0
+          row_count = 0
           while y < height
             dest_path = File.join(current_level_storage_dir, "#{col_count}_#{row_count}.#{@tile_format}")
             tile_width, tile_height = tile_dimensions(x, y, @tile_size, @tile_overlap)
@@ -94,13 +96,13 @@ module DZT
       tile_width  = (x > 0) ? overlapping_tile_size : border_tile_size
       tile_height = (y > 0) ? overlapping_tile_size : border_tile_size
 
-      return tile_width, tile_height
+      [tile_width, tile_height]
     end
 
     # Calculates how often an image with given dimension can
     # be divided by two until 1x1 px are reached.
     def max_level(width, height)
-      return (Math.log([width, height].max) / Math.log(2)).ceil
+      (Math.log([width, height].max) / Math.log(2)).ceil
     end
 
     # Crops part of src image and writes it to dest path.
@@ -114,10 +116,10 @@ module DZT
       if src.is_a? Magick::Image
         img = src
       else
-        img = Magick::Image::read(src).first
+        img = Magick::Image.read(src).first
       end
 
-      quality = quality * 100 if quality < 1
+      quality *= 100 if quality < 1
 
       # The crop method retains the offset information in the cropped image.
       # To reset the offset data, adding true as the last argument to crop.

data/lib/dzt/version.rb

@@ -1,3 +1,3 @@
 module DZT
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: dzt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -66,17 +66,17 @@ 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: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Tile images for deep-zoom.