placekitten 1.0.0 → 1.1.0

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 .rvmrc
+.yardoc/*
+doc/*

data/README.md

@@ -34,6 +34,15 @@ Rails Helpers
       include PlaceKitten::Helpers
     end
 
+    # in your views:
+    <%= image_tag placekitten(400, 500) %>
+    <%= image_tag placekitten_gray(400, 500) %>
+
+Contributing
+------------
+
+Just fork the project, create a topic branch, push your changes, and issue a Pull Request. Avoid changing `Rakefile` or `VERSION` (or do it in a separate commit so I can skip pulling those changes).
+
 License
 -------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/placekitten/helpers.rb

@@ -1,9 +1,12 @@
 module PlaceKitten::Helpers
-  def placekitten(width = 200, height = 300, grayscale = false)
+  # @see PlaceKitten.image
+  def placekitten(width = nil, height = nil, grayscale = false)
     PlaceKitten.image(width, height, grayscale)
   end
 
-  def placekitten_gray(width = 200, height = 300)
+  # @see PlaceKitten.grayscale
+  def placekitten_grayscale(width = nil, height = nil)
     PlaceKitten.grayscale(width, height)
   end
+  alias placekitten_gray placekitten_grayscale
 end

data/lib/placekitten/placekitten.rb

@@ -1,11 +1,22 @@
 class PlaceKitten
+  DEFAULT_WIDTH  = 300
+  DEFAULT_HEIGHT = 300
+
   # Returns the URL for an optionally grayscale placekitten with
-  # the given width and height.
+  # the given width and height. If the width is given but the height
+  # is not, the image will be square.
   #
   # @param [Number] width the width of the placekitten
   # @param [Number] height the height of the placekitten
   # @param [Boolean] grayscale whether or not to make the placekitten grayscale
-  def self.image(width = 300, height = 200, grayscale = false)
+  def self.image(width = nil, height = nil, grayscale = false)
+    if width.nil?
+      width = DEFAULT_WIDTH
+      height = DEFAULT_HEIGHT
+    elsif height.nil?
+      height = width
+    end
+
     if grayscale
       "http://placekitten.com/g/#{width}/#{height}"
     else
@@ -14,11 +25,12 @@ class PlaceKitten
   end
 
   # Returns the URL for a grayscale placekitten with the given
-  # width and height.
+  # width and height. If the width is given but the height
+  # is not, the image will be square.
   #
   # @param [Number] width the width of the placekitten
   # @param [Number] height the height of the placekitten
-  def self.grayscale(width = 300, height = 200)
+  def self.grayscale(width = nil, height = nil)
     self.image(width, height, true)
   end
 

data/test/placekitten_helpers_test.rb

@@ -12,4 +12,9 @@ class KittenRailsTest < Test::Unit::TestCase
     image = placekitten_gray(400, 500)
     assert_equal "http://placekitten.com/g/400/500", image
   end
+
+  def test_placekitten_grayscale_helper
+    image = placekitten_grayscale(400, 500)
+    assert_equal "http://placekitten.com/g/400/500", image
+  end
 end

data/test/placekitten_test.rb

@@ -2,6 +2,16 @@ require 'placekitten'
 require 'test/unit'
 
 class KittenTest < Test::Unit::TestCase
+  def test_no_params
+    image = PlaceKitten.image
+    assert_equal "http://placekitten.com/#{PlaceKitten::DEFAULT_WIDTH}/#{PlaceKitten::DEFAULT_HEIGHT}", image
+  end
+
+  def test_width_only
+    image = PlaceKitten.image(500)
+    assert_equal "http://placekitten.com/500/500", image
+  end
+
   def test_width_height
     image = PlaceKitten.image(300, 200)
     assert_equal "http://placekitten.com/300/200", image
@@ -17,6 +27,16 @@ class KittenTest < Test::Unit::TestCase
     assert_equal "http://placekitten.com/g/100/300", image
   end
 
+  def test_grayscale_no_params
+    image = PlaceKitten.gray
+    assert_equal "http://placekitten.com/g/#{PlaceKitten::DEFAULT_WIDTH}/#{PlaceKitten::DEFAULT_HEIGHT}", image
+  end
+
+  def test_grayscale_width_only
+    image = PlaceKitten.gray(500)
+    assert_equal "http://placekitten.com/g/500/500", image
+  end
+
   def test_grayscale_method
     image = PlaceKitten.grayscale(200, 400)
     assert_equal "http://placekitten.com/g/200/400", image

metadata

@@ -2,7 +2,7 @@
 name: placekitten
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brandon Tilley