puzzlize 0.0.1

data/lib/puzzlize/model_additions.rb

@@ -0,0 +1,18 @@
+require "puzzlize/model_instance_methods"
+module Puzzlize
+  module ModelAdditions
+    def puzzlize(attribute)
+      include Puzzlize::ModelInstanceMethods
+      @@puzzle_attribute_name = attribute
+      
+      # one of the main reason why this doesn't run off of after create is because paperclip callback hook is after_save.
+      # since I use paper's medium image, we need to run after save.
+      # Because I did not want to tightly integrate with paperclip, I did not use their callback hooks.
+      after_save :make_puzzle
+      
+      def get_puzzlize_attribute_name
+        @@puzzle_attribute_name
+      end
+    end
+  end
+end

data/lib/puzzlize/model_instance_methods.rb

@@ -0,0 +1,125 @@
+module Puzzlize
+  module ModelInstanceMethods
+    def default_puzzle_image_url
+      self.send(self.class.get_puzzlize_attribute_name).url(:medium)
+    end
+
+    def default_puzzle_image_path
+      self.send(self.class.get_puzzlize_attribute_name).path(:medium)
+    end
+
+    def puzzle_images_urls
+      output = []
+      self.vertical_pieces.to_i.times do |y_axis|
+        self.horizontal_pieces.to_i.times do |x_axis|
+          output << piece_file_name(x_axis, y_axis, self.default_puzzle_image_url)
+        end
+      end
+      output
+    end
+
+    def puzzle_pieces_names
+      output = []
+      self.vertical_pieces.to_i.times do |y_axis|
+        self.horizontal_pieces.to_i.times do |x_axis|
+          output << "puzzle_#{x_axis}-#{y_axis}"
+        end
+      end
+      output
+    end
+
+    def make_puzzle
+      if puzzle_created?
+        determine_parameters
+        make_all_piece
+        update_piece_information
+      end
+    end
+    
+    def puzzle_created?
+      !self.vertical_pieces?
+    end
+    
+    def determine_parameters
+      @file_location = self.default_puzzle_image_path
+      @source_file = Magick::Image.read(@file_location).first
+      @cutter = Puzzlize::Cutter.new
+      @cutter.piece_size = (@source_file.columns * 0.25).to_i
+      @cutter.image_width = @source_file.columns
+      @cutter.image_height = @source_file.rows
+      @source_file = @source_file.crop(*(@cutter.piece_fitting_diamentions + [true]))
+    end
+    
+    # this is isolated because supermodel treats update_attributes the same as save
+    # ActiveRecord does not do this.
+    def update_piece_information
+      self.update_attributes({
+        :vertical_pieces => @cutter.vertical_pieces, 
+        :horizontal_pieces => @cutter.horizontal_pieces, 
+        :vertical_piece_size => @cutter.real_piece_size, 
+        :horizontal_piece_size => @cutter.real_piece_size,
+        :image_width => @cutter.image_width,
+        :image_height => @cutter.image_height})
+    end
+
+    def make_single_piece(row_x, row_y)
+      # get the source image and crop it to the appropriate size.
+      bg = @source_file.crop(*(@cutter.piece_points(row_x, row_y) + [true]))
+
+      # This will be the final image output
+      img = Magick::Image.new(bg.columns,bg.rows)
+      img.compression = Magick::LZWCompression
+
+      # draw the image that is suppose to be invisible.
+      gc = Magick::Draw.new
+      gc.stroke_antialias(false)
+      gc.stroke_width(0)
+
+      # first start with black box.
+      gc.fill('#000000')
+      gc.rectangle(0,0,bg.columns, bg.rows)
+
+      # draw rectangles around the edges of the images aka "buffers"
+      # that will later be made transperant
+      gc.fill('#09f700')
+      @cutter.rectangle_locations(row_x, row_y).each do |a_rectangle|
+        gc.rectangle(*a_rectangle) unless a_rectangle.nil?
+      end
+
+      # draw the up to 4 connectors
+      connector_types = @cutter.connector_types(row_x, row_y)
+      @cutter.connector_locations(row_x, row_y).each_with_index do |connector, index|
+        unless connector.nil?
+          gc.fill('#09f700') if connector_types[index] == -1
+          gc.fill('#000000') if connector_types[index] == 1
+          points = connector
+          points << (connector[0] + @cutter.connector_radius)
+          points << connector[1]
+          gc.circle(*points)
+        end
+      end
+
+      # draw the image and composite the background image (bg) and set the transparency.
+      # Creating a cookie cutter affect.
+      gc.draw(img)
+      img = img.matte_replace((bg.columns / 2).to_i,(bg.rows / 2).to_i)
+      img = bg.composite(img, Magick::CenterGravity, Magick::OverCompositeOp)
+      img = img.transparent('#09f700')
+      
+      Rails.logger.debug { "[puzzle_maker] writing image to #{@file_location.sub(/\..*$/, "-#{row_x}_#{row_y}.gif")}".inspect } if defined? Rails
+      img.write(piece_file_name(row_x, row_y, @file_location))
+    end
+
+    def piece_file_name(row_x, row_y, file_location)
+      file_location.sub(/\..*$/, "-#{row_x}_#{row_y}.gif")
+    end
+
+    def make_all_piece
+      @cutter.vertical_pieces.times do |y_axis|
+        @cutter.horizontal_pieces.times do |x_axis|
+          make_single_piece(x_axis, y_axis)
+        end
+      end
+    end
+  end
+end

data/lib/puzzlize/railtie.rb

@@ -0,0 +1,17 @@
+module Puzzlize
+  class Railtie < Rails::Railtie
+    initializer 'puzzlize.model_additons' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+        
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, Puzzlize::Schema)
+        ActiveRecord::ConnectionAdapters::Table.send(:include, Puzzlize::Schema)
+        ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Puzzlize::Schema)
+      end
+      
+      ActiveSupport.on_load :action_view do
+        include ViewHelpers
+      end
+    end
+  end
+end

data/lib/puzzlize/schema.rb

@@ -0,0 +1,26 @@
+module Puzzlize
+  module Schema
+    @@schema = [
+      :vertical_piece_size,
+      :horizontal_piece_size,
+      :vertical_pieces,
+      :horizontal_pieces,
+      :image_width,
+      :image_height
+    ]
+    
+    
+    def add_puzzlize_columns
+      @@schema.each do |column_name|
+        column(column_name, :integer)
+      end
+    end
+    
+    def remove_puzzlize_columns(table_name)
+      @@schema.each do |column_name|
+        remove_column(table_name, column_name)        
+      end
+    end
+  end
+  
+end

data/lib/puzzlize/version.rb

@@ -0,0 +1,3 @@
+module Puzzlize
+  VERSION = "0.0.1"
+end

data/puzzlize.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "puzzlize/version"
+
+Gem::Specification.new do |s|
+  s.name        = "puzzlize"
+  s.version     = Puzzlize::VERSION
+  s.authors     = ["Ziemek Wolski"]
+  s.email       = ["ziemek.wolski+gem@gmail.com"]
+  s.homepage    = "https://github.com/ziemekwolski/puzzlize"
+  s.summary     = %q{Gem created a puzzle using images from a predefined image on a model.}
+  s.description = %q{This gem is made up off two libraries. A cutter library - determines all the points to cut. Rmagick rapper, which actually cuts up the images.}
+
+  s.rubyforge_project = "puzzlize"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "supermodel"
+  s.add_runtime_dependency "paperclip"
+  s.add_runtime_dependency "rmagick"
+end

data/spec/puzzlize/cutter_spec.rb

@@ -0,0 +1,198 @@
+require "spec_helper"
+
+
+describe "Cutter" do
+  it "test should store size of piece" do
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.piece_size.should == 20
+  end
+
+  it "test should store size of image" do
+    cutter = Puzzlize::Cutter.new
+    cutter.image_width = 20
+    cutter.image_height = 100
+    cutter.image_width.should == 20
+    cutter.image_height.should == 100
+  end
+
+  it "test determine number of horizontal pieces" do
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 40
+    cutter.image_height = 100
+
+    cutter.horizontal_pieces.should ==  2
+    cutter.vertical_pieces.should == 5
+  end
+
+  it "test determine connector size" do
+    #connector should be 20% or the size of the piece
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.connector_size.should == 4
+  end
+
+  it "test determine connector radius" do
+    #connector should be 20% or the size of the piece
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.connector_radius.should == 2
+  end
+
+  it "test should return the 4 positions of the first square" do
+    # the piece need to overlap so that we can correctly match the connectors.
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 40
+    cutter.image_height = 40
+  
+    cutter.get_piece_matrix.should == [[0,0, 22, 22], [18, 0, 22, 22], [0, 18, 22,22], [18, 18, 22 , 22]]
+  end
+
+  it "test return points for a given piece" do
+    #note: I think this is faulty - there is not enough overlap.
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 40
+    cutter.image_height = 40
+  
+    cutter.piece_points(0, 0).should == [0,0, 22, 22]
+    cutter.piece_points(1, 0).should == [18, 0, 22, 22]
+    cutter.piece_points(0, 1).should == [0, 18, 22, 22]
+    cutter.piece_points(1, 1).should == [18, 18, 22 , 22 ]
+
+    cutter.piece_points(0, 0, false).should == [0,0, 20, 20]
+    cutter.piece_points(1, 0, false).should ==  [20, 0, 20, 20]
+    cutter.piece_points(0, 1, false).should == [0, 20, 20,20]
+    cutter.piece_points(1, 1, false).should == [20, 20, 20 , 20 ] 
+  
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 60
+    cutter.image_height = 60
+  
+    cutter.piece_points(0, 0).should == [0,0, 22, 22] 
+    cutter.piece_points(1, 0).should == [18, 0, 24, 22] 
+    cutter.piece_points(2, 0).should == [38, 0, 22, 22] 
+  
+    cutter.piece_points(0, 1).should == [0, 18, 22, 24] 
+    cutter.piece_points(1, 1).should == [18, 18, 24 , 24 ] 
+    cutter.piece_points(2, 1).should == [38, 18, 22 , 24 ] 
+  
+    cutter.piece_points(0, 2).should == [0, 38, 22 , 22 ] 
+    cutter.piece_points(1, 2).should == [18, 38, 24 , 22 ] 
+    cutter.piece_points(2, 2).should == [38, 38, 22 , 22 ] 
+  end
+
+  it "test determine the radius of the connector" do
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.connector_radius.should == 2
+  end
+
+  it "test should return connector locations give a piece" do
+  
+    #       2
+    #   *********
+    # 3 *       * 4
+    #   *       *
+    #   *********
+    #       1
+
+    # because these points will be applied to individual cut up images, 
+    # I don't need the points as they relate to the full image. 
+    # I only need the points as they relate to the cut image, but
+    # you need to account for the overlap aka buffer for the connectors.
+    # remember connector radius and overlap is 2px not 4px.
+  
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 40
+    cutter.image_height = 40
+  
+               # [10,0], [10, 20], [0, 10], [20, 10]
+    cutter.connector_locations(0, 0).should == [nil, [10, 20], nil, [20, 10]]
+    cutter.connector_locations(1, 0).should == [nil, [12, 20], [2, 10], nil]
+    cutter.connector_locations(0, 1).should == [[10, 2], nil, nil, [20, 12]]
+    cutter.connector_locations(1, 1).should == [[12, 2], nil, [2, 12], nil]
+  
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 60
+    cutter.image_height = 60
+  
+               # [10,0], [10, 20], [0, 10], [20, 10]
+    cutter.connector_locations(0, 0).should == [nil, [10, 20], nil, [20, 10]]
+    cutter.connector_locations(1, 0).should == [nil, [12, 20], [2, 10], [22,10]]
+    cutter.connector_locations(2, 0).should == [nil, [12, 20], [2, 10], nil]
+
+    cutter.connector_locations(0, 1).should == [[10,2], [10, 22], nil, [20, 12]]
+    cutter.connector_locations(1, 1).should == [[12,2], [12, 22], [2, 12], [22, 12]]
+    cutter.connector_locations(2, 1).should == [[12,2], [12, 22], [2, 12], nil]
+
+    cutter.connector_locations(0, 2).should == [[10,2], nil, nil, [20, 12]]
+    cutter.connector_locations(1, 2).should == [[12,2], nil, [2, 12], [22, 12]]
+    cutter.connector_locations(2, 2).should == [[12,2], nil, [2, 12], nil]
+  end
+
+  it "test should get points for the rectangle for the transperant piece giving a place" do
+    # Again, I don't need the rectangles that apply to the image as a whole, only
+    # the rectangles that relate to each individual piece. 
+  
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 60
+    cutter.image_height = 60
+ 
+  
+      #       2
+      #   *********
+      # 3 *       * 4
+      #   *       *
+      #   *********
+      #       1
+
+    cutter.rectangle_locations(0, 0).should == [nil, [0, 20, 22, 22], nil, [20, 0, 22, 22]]
+    cutter.rectangle_locations(1, 0).should == [nil, [0, 20, 24, 22], [0, 0, 2, 22], [22, 0, 24, 22]]
+    cutter.rectangle_locations(2, 0).should == [nil, [0, 20, 22, 22], [0, 0, 2, 22], nil]
+
+    # here I have to account for the buffer space at the bottom as well as the top so 
+    # all the points are raised.
+    cutter.rectangle_locations(0, 1).should == [[0, 0, 22, 2], [0, 22, 22, 24], nil, [20, 0, 22, 24]]
+    # image is now 24 pixel wide cause, it's in the center of the image, not bound by anything. -- we need the buffer
+    cutter.rectangle_locations(1, 1).should == [[0,0, 24, 2], [0, 22, 24, 24], [0, 0, 2, 24], [22, 0, 24, 24]]
+    cutter.rectangle_locations(2, 1).should == [[0,0, 22, 2], [0, 22, 22, 24], [0, 0, 2, 24], nil]
+
+    cutter.rectangle_locations(0, 2).should == [[0,0, 22, 2], nil, nil, [20, 0, 22, 22]]
+    cutter.rectangle_locations(1, 2).should == [[0,0, 24, 2], nil, [0, 0, 2, 22], [22, 0, 24, 22]]
+    cutter.rectangle_locations(2, 2).should == [[0,0, 22, 2], nil, [0, 0, 2, 22], nil]
+  end
+
+  it "test should determine connector type" do
+    # CONNECTOR_TOP_PATTERN = [-1, -1 ,1]
+    # CONNECTOR_RIGHT_PATTERN = [1, 1, -1]
+  
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 40
+    cutter.image_height = 40
+ 
+    cutter.connector_types(0,0).should == [nil, -1, nil, 1]
+    cutter.connector_types(1,0).should == [nil, -1, -1, nil]
+    cutter.connector_types(0,1).should == [1, nil, nil, 1]
+    cutter.connector_types(1,1).should == [1, nil, -1, nil]
+  end
+
+  it "test should determine new size of image based on piece size" do
+    cutter = Puzzlize::Cutter.new
+    cutter.piece_size = 20
+    cutter.image_width = 40
+    cutter.image_height = 65
+  
+    cutter.piece_fitting_diamentions.should == [0,0, 40, 60]
+    cutter.image_width.should == 40
+    cutter.image_height.should == 60
+  end
+
+end

data/spec/puzzlize/model_additions_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe "puzzlize" do
+  describe "ModelAdditions" do
+    it "should add in get the right attribute" do
+      Puzzle.get_puzzlize_attribute_name.should == :puzzle
+    end
+  end
+  
+  describe "ModelInstanceMethods" do
+    it "should include the following methods" do
+      p = Puzzle.new
+      methods = [:default_puzzle_image_path, :default_puzzle_image_url, :puzzle_images_urls, :puzzle_pieces_names, :make_puzzle, :make_single_piece, :piece_file_name, :make_all_piece]
+      (p.methods & methods).should == methods
+    end
+    
+    it "should get the right puzzle_pieces_names" do
+      expected = ["puzzle_0-0", "puzzle_1-0", "puzzle_2-0", "puzzle_3-0", "puzzle_4-0", 
+                  "puzzle_0-1", "puzzle_1-1", "puzzle_2-1", "puzzle_3-1", "puzzle_4-1", 
+                  "puzzle_0-2", "puzzle_1-2", "puzzle_2-2", "puzzle_3-2", "puzzle_4-2", 
+                  "puzzle_0-3", "puzzle_1-3", "puzzle_2-3", "puzzle_3-3", "puzzle_4-3", 
+                  "puzzle_0-4", "puzzle_1-4", "puzzle_2-4", "puzzle_3-4", "puzzle_4-4"]
+      p = Puzzle.new
+      p.vertical_pieces = 5
+      p.horizontal_pieces = 5
+      p.puzzle_pieces_names.should == expected
+    end
+  
+  end
+end