image_mosaic 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a1a7071ef66b370eb317cb4253fc2a27f1dabe6
-  data.tar.gz: 44e791111586332891ef202a18cc3995b25cee15
+  metadata.gz: 16c5f7ada72b064ecf1bef0bd89f7dc50dc28a28
+  data.tar.gz: 5da2b55388a4897099f432885488fe124601790b
 SHA512:
-  metadata.gz: 281facb0beed13789225c0463cdc90257d144d2fb3634140d5c04152ca84fe016c5e12bc72dc9fe2555696d97eff0cc8bf032407077f2e6e5b26b84afcdca69d
-  data.tar.gz: 3a924e0c83cb1d5e124226abec8e5da90d5e24a07b7e39f7f64f946fc45d39520527e08ec15a2481b9145fbec7494eefb17d7164897e493e0e6d8262f6af8b1a
+  metadata.gz: df1829264594f547382597ca356919679b6a58ba9bd605a1da517e4bb29f219ea70dd03eca958ed637525086b4b59dd378a29a6348abc6b09a1080e565873973
+  data.tar.gz: 240a137ef6e4c0453dcb2df2d7e607cd8160b605c47ac1ce7fdc96c307a794f0d199d7faf979b8a093481f5b07dfefabdc54e18abe24c3f694077236658bed46

data/README.md

@@ -1,9 +1,7 @@
 # ImageMosaic
 [![Build Status](https://travis-ci.org/Dannyguk/image_mosaic.svg?branch=master)](https://travis-ci.org/Dannyguk/image_mosaic)
 
-ImageMosaic takes an array of up to 20 images and returns a collage of the images in a grid format.
-
-Each image in the collage is currently resized to 200x200 pixels. The image it returns in 1000x1000 pixels.
+ImageMosaic takes an array of images and returns a collage of the images in a grid format.
 
 ## Installation
 
@@ -33,12 +31,35 @@ Or install it yourself as:
 
 ## Usage
 
-Create an image from an array of image URLs. The resulting image is saved to the local file system.
+Create an image from an array of image URLs.
+
+The size of each piece of the final image and the number of columns and rows will vary depending on how many images are provided.
+
+**Note**: the final image is fixed to 1000x1000 pixels with a white background.
+
+An instance of a `Mosaic` object is returned, calling `save` on this will save the image to the filesystem with a random name.
 
 ```ruby
 images =  (0..20).map { 'https://unsplash.it/200/200?random' }
-mosaic = ImageMosaic::Construct.new(images)
+mosaic = ImageMosaic.create(images)
 mosaic.save
+mosaic.filename
+=> "mosaic_9ebfcb8c-b554-4748-9b2e-3d4eb7b8f2b0.png"
+```
+
+If you want to retrieve the instance of `MiniMagick::Image` behind and manipulate it further you can.
+
+```ruby
+images =  (0..20).map { 'https://unsplash.it/200/200?random' }
+mosaic = ImageMosaic.create(images)
+mosaic.image
+=> #<MiniMagick::Image:0x007fbfb2a6b868 @path="/var/folders/7g/7wdhmvx96856frwy0jf78rsr0000gn/T/mini_magick20170426-64311-eom10b.png", @tempfile=#<Tempfile:/var/folders/7g/7wdhmvx96856frwy0jf78rsr0000gn/T/mini_magick20170426-64311-eom10b.png (closed)>, @info=#<MiniMagick::Image::Info:0x007fbfb2a6b818 @path="/var/folders/7g/7wdhmvx96856frwy0jf78rsr0000gn/T/mini_magick20170426-64311-eom10b.png", @info={}>>
+```
+### Background Colour
+The default background colour is white, background colour can be specified as a valid hex code (with preceeding #). If an invalid code is provided the background will be white.
+
+```ruby
+ImageMosaic.create(images, colour: '#00ff00')
 ```
 
 ## Contributing

data/lib/image_mosaic/data/background.rb

@@ -0,0 +1,25 @@
+module ImageMosaic
+  module Data
+    class Background
+      PATTERN = /^#([0-9a-fA-F]{3}){1,2}$/
+
+      def initialize(hex)
+        @hex = hex
+      end
+
+      def hex
+        valid? ? @hex : COLOUR
+      end
+
+      private
+
+      def valid?
+        !!match
+      end
+
+      def match
+        @hex =~ PATTERN
+      end
+    end
+  end
+end

data/lib/image_mosaic/image/mosaic.rb

@@ -0,0 +1,20 @@
+module ImageMosaic
+  module Image
+    class Mosaic
+      attr_reader :image
+
+      def initialize(image)
+        @image = image
+        @securerandom = SecureRandom.uuid
+      end
+
+      def save
+        @image.write(filename)
+      end
+
+      def filename
+        "mosaic_#{@securerandom}.png"
+      end
+    end
+  end
+end

data/lib/image_mosaic/image/parent.rb

@@ -2,7 +2,7 @@ module ImageMosaic
   module Image
     #Takes an array of images and metrics and then returns a single image of composited images.
     class Parent
-      def initialize(items, colour: 'white', columns: 5, dimension: 200)
+      def initialize(items, colour:, columns:, dimension:)
         @items = items
         @colour = colour
         @columns = columns
@@ -20,7 +20,7 @@ module ImageMosaic
           end
           y += @dimension
         end
-        image
+        Mosaic.new(image)
       end
 
       private

data/lib/image_mosaic/operations/construct.rb

@@ -0,0 +1,28 @@
+module ImageMosaic
+  module Operations
+    class Construct
+      def initialize(items, colour: COLOUR)
+        @items = items
+        @colour = colour
+      end
+
+      def parent
+        @parent ||= Image::Parent.new(valid_items, colour: @colour, columns: setting.columns, dimension: setting.dimension).create
+      end
+
+      private
+
+      def setting
+        @setting ||= Data::Setting.new(valid_items.count)
+      end
+
+      def valid_items
+        @valid_items ||= Data::Validator.new(@items).items
+      end
+
+      def background
+        @background ||= Data::Background.new(@colour).hex
+      end
+    end
+  end
+end

data/lib/image_mosaic/railtie.rb

@@ -0,0 +1,4 @@
+module ImageMosaic
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/image_mosaic/version.rb

@@ -1,3 +1,3 @@
 module ImageMosaic
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/image_mosaic.rb

@@ -1,38 +1,23 @@
-require "image_mosaic/version"
+require 'image_mosaic/version'
 require 'mini_magick'
 require 'tempfile'
 require 'securerandom'
-require 'image_mosaic/operations/compositor'
+require 'image_mosaic/data/background'
 require 'image_mosaic/data/setting'
 require 'image_mosaic/data/validator'
-require 'image_mosaic/image/parent'
 require 'image_mosaic/image/child'
+require 'image_mosaic/image/mosaic'
+require 'image_mosaic/image/parent'
+require 'image_mosaic/operations/compositor'
+require 'image_mosaic/operations/construct'
+require 'image_mosaic/railtie' if defined?(Rails)
 
 module ImageMosaic
   HEIGHT = 1000
   WIDTH = 1000
+  COLOUR = '#ffffff'.freeze
 
-  class Construct
-    def initialize(items)
-      @items = items
-    end
-
-    def save
-      parent.write("#{SecureRandom.uuid}.png")
-    end
-
-    private
-
-    def parent
-      @parent ||= Image::Parent.new(valid_items, colour: 'white', columns: setting.columns, dimension: setting.dimension).create
-    end
-
-    def setting
-      @setting ||= Data::Setting.new(valid_items.count)
-    end
-
-    def valid_items
-      @valid_items ||= Data::Validator.new(@items).items
-    end
+  def self.create(items, colour: COLOUR)
+    Operations::Construct.new(items, colour: colour).parent
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_mosaic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dan Goodwin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,11 +85,15 @@ files:
 - bin/setup
 - image_mosaic.gemspec
 - lib/image_mosaic.rb
+- lib/image_mosaic/data/background.rb
 - lib/image_mosaic/data/setting.rb
 - lib/image_mosaic/data/validator.rb
 - lib/image_mosaic/image/child.rb
+- lib/image_mosaic/image/mosaic.rb
 - lib/image_mosaic/image/parent.rb
 - lib/image_mosaic/operations/compositor.rb
+- lib/image_mosaic/operations/construct.rb
+- lib/image_mosaic/railtie.rb
 - lib/image_mosaic/version.rb
 homepage: http://github.com/dannyguk
 licenses: