flickollage 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bf1524178358a9af7ccece83dff0511d631733f
-  data.tar.gz: 7b52460521ecd5ec1633f780b15c525ec9651afe
+  metadata.gz: bd6193362e407aafb5b2d322abeebd40963c5aed
+  data.tar.gz: 5d73f30c9e3557930b89379446446069892ab177
 SHA512:
-  metadata.gz: 2acf6edde06c4bc7a5326ba2401949c1f564d9fada5236cc6f0d90ac05c963606788d564fba590bd83dd0af853a9116586747ab6796ba42187277140e40186b8
-  data.tar.gz: 05fdea90eb41ebd282ab9c1ee32c355de1baceeab78dd93b138a35b0516cb76f62c9919de0cc9a63137aa2ada5f8fed2fd1c7eac9ad3db5d7417268c69a151a2
+  metadata.gz: b20723e02e0fb20733e7aa7d1dfa3719c7467a1e74c3a9b82327bc50f6b676e980be31f86aafd69a54cdea07924709b020fabd906439d3679531fcc16e00685c
+  data.tar.gz: 5e90c6469f43cef622a815609c589deaa2a75df71e107842c7e251ff4285e27041ad262fef322fb5053c882c505552ec9c1395a0f8cf95b20385dba6d8036024

data/README.md

@@ -18,6 +18,10 @@ variables `FLICKR_API_KEY` and `FLICKR_SHARED_SECRET` or command-line options
 
 ## Usage
 
+    $ flickollage help generate
+
+It will describe all available options.
+
     $ flickollage generate -n 2 --rows=1 --cols=2 --width=300 --height=200 Berlin 'New York'
 
 ![Cities Collage](spec/fixtures/cities.png)

data/flickollage.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'flickollage'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.date        = '2017-03-05'
   s.summary     = 'Flickollage Collage Generator'
   s.description = 'Flickollage is a simple command line tool for generating collages'

data/lib/flickollage.rb

@@ -19,8 +19,7 @@ module Flickollage
       FlickRaw.api_key = ENV['FLICKR_API_KEY'] || options[:flickr_api_key]
       FlickRaw.shared_secret = ENV['FLICKR_SHARED_SECRET'] || options[:flickr_shared_secret]
       return true if FlickRaw.api_key && FlickRaw.shared_secret
-      logger.error 'Flickr configuration is not provided.'
-      false
+      raise Error, 'Flickr configuration is not provided.'
     end
   end
 end

data/lib/flickollage/cli.rb

@@ -10,35 +10,74 @@ module Flickollage
     desc 'generate [LIST OF WORDS]', 'Generate collage from the list of words'
     option :dict,
            type: :string, aliases: '-d', default: Dictionary.default_dict_path,
-           desc: 'Path of the dictionatry file'
+           desc: 'Path to a dictionatry file'
     option :output,
            type: :string, aliases: '-o', default: 'collage.png',
            desc: 'Output image file name'
     option :flickr_api_key,
            type: :string,
-           desc: 'Flickr API Key, can also be set using environment variable'
+           desc: 'Flickr API Key, it can also be set using environment variable'
     option :flickr_shared_secret,
            type: :string,
-           desc: 'Flickr Shared Secret, can also be set using environment variable'
-    option :number, type: :numeric, aliases: '-n', default: 10
-    option :rows, type: :numeric, aliases: '-r', default: 5
-    option :cols, type: :numeric, aliases: '-c', default: 2
-    option :width, type: :numeric, aliases: '-w', default: 200
-    option :height, type: :numeric, aliases: '-h', default: 150
-    option :verbose, type: :boolean, aliases: '-v'
+           desc: 'Flickr Shared Secret, it can also be set using environment variable'
+    option :number,
+           type: :numeric, aliases: '-n', default: 10,
+           desc: 'Number of photos to be composed into a collage'
+    option :rows,
+           type: :numeric, aliases: '-r', default: 5,
+           desc: 'Number of rows in a collage grid'
+    option :cols,
+           type: :numeric, aliases: '-c', default: 2,
+           desc: 'Number of columns in a collage grid'
+    option :width,
+           type: :numeric, aliases: '-w', default: 200,
+           desc: 'Width of a cell in a collage grid'
+    option :height,
+           type: :numeric, aliases: '-h', default: 150,
+           desc: 'Height of a cell in a collage grid'
+    option :verbose,
+           type: :boolean, aliases: '-v',
+           desc: 'Print debug information'
     long_desc <<-LONGDESC
-      `flickollage generate dolomites annapurna` will generate a photo collage.
+      `flickollage generate -n 2 --rows=1 --cols=2 Berlin 'New York'` will generate
+      a photo collage and save it to `collage.png` file.
 
-      You can provide flickr api key and shared secret using options described before
-      or environment variables `FLICKR_API_KEY` and `FLICKR_SHARED_SECRET`.
+      Flickollage accepts a list of words as argument and generates a collage grid
+      from top-rated images found on Flickr using the keywords provided.
+
+      You need to provide flickr api key and shared secret using options or via
+      environment variables `FLICKR_API_KEY` and `FLICKR_SHARED_SECRET`.
     LONGDESC
     def generate(*words)
       Flickollage.init_logger(options)
-      return unless Flickollage.configure_flickraw(options)
+      validate_options(options)
+      Flickollage.configure_flickraw(options)
       Flickollage::Collage.new(words, options).generate_collage
     rescue Flickollage::Error => e
-      logger.error(e.message)
-      logger.debug(e.inspect)
+      print_error(e)
+    end
+
+    no_commands do
+      def validate_options(options)
+        validate_grid_layout(options)
+        validate_image_size(options)
+      end
+
+      def validate_grid_layout(options)
+        return unless options[:rows] * options[:cols] != options[:number]
+        raise Error,
+              'Number of photos should be equal to the number of places in a layout (rows * cols)'
+      end
+
+      def validate_image_size(options)
+        return unless options[:width] <= 0 || options[:height] <= 0
+        raise Error, 'Image width and height should be greater than 0'
+      end
+
+      def print_error(e)
+        logger.error("Error: #{e.message}")
+        logger.debug(e.inspect)
+      end
     end
   end
 end

data/lib/flickollage/collage.rb

@@ -20,14 +20,12 @@ module Flickollage
       crop_images(options[:width], options[:height])
     end
 
-    def generate_collage(path = nil)
-      path ||= options[:output]
+    def generate_collage(path = options[:output])
       MiniMagick::Tool::Montage.new do |montage|
         images.each { |image| montage << image.image.path }
 
         montage.geometry "#{options[:width]}x#{options[:height]}+0+0"
         montage.tile "#{options[:cols]}x#{options[:rows]}"
-        montage.background 'black'
 
         montage << path
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickollage
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Aleksandr Zykov
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Flickollage Collage Generator