hit_counter 0.0.1 → 0.0.2

data/README.rdoc

@@ -4,38 +4,67 @@ Ruby version of that old 90s chestnut, the web-site hit counter.
 
 == How to Install
 
-1. Install the gem.
+1. Install the gem and supporting files.
 
-   Gemfile:
+   +Gemfile+:
 
      gem 'hit_counter'
 
+   Run:
+
+     bundle
+     rake hit_counter:install
+
 2. Add a controller action to your app.
 
-   controller.rb:
+   +application_controller.rb+:
 
      def hit_counter
        return if params[:url].blank?
+
+       # find or create a hit counter for this URL
        hc = HitCounter.get params[:url]
+
+       # increase the tally by one
        hc.increment
+
+       # get the image as a blog and stream it to the browser
        send_data hc.image(params[:style]).to_blob, :disposition => 'inline', :filename => "#{hc.hits}.png", :type => :png
      end
 
-   routes.rb:
+   +routes.rb+:
 
-     get 'hit-counter' => 'webmaster_tools#hit_counter' # technically should be PUT, but GET makes integration simpler
+     get 'hit-counter' => 'application#hit_counter' # technically should be POST/PUT, but GET makes integration simpler
 
 3. Add the hit-counter image tag to your site's HTML:
 
-   <img alt="Hit Counter" border="0" src="/hit-counter?url=http://cnn.com&style=1" />
+     <img alt="Hit Counter" border="0" src="/hit-counter?url=http://cnn.com&style=1" />
 
 == How to Customize the Hit-Counter Image
 
-1. Create a GIF for each of the digits, 0.gif through 9.gif.
+=== Use an Existing Style
+
+* You can use one of the three included styles by specifying a different +style+ param in the HTML:
+
+    <img alt="Hit Counter" border="0" src="/hit-counter?url=cnn.com&style=1" />
+
+  The included styles are:
+
+  http://github.com/ivanoblomov/hit_counter/raw/master/public/images/digits/odometer/1.gif odometer
+  http://github.com/ivanoblomov/hit_counter/raw/master/public/images/digits/scout/2.gif scout
+  http://github.com/ivanoblomov/hit_counter/raw/master/public/images/digits/celtic/3.gif Celtic
+
+=== Create Your Own Style
+
+1. To add your own style, create a GIF for each of the digits, +0.gif+ through +9.gif+. Save the images in a folder named after your new style in +public/images/digits+.
+
+2. In your controller, declare a new +STYLES+ constant and add the folder name to it:
+
+     HitCounter::STYLES = ['odometer', 'scout', 'celtic', '(folder name)']
 
-2. Add the images to a folder named after your new style in public/images/digits.
+3. In your HTML, specify the new style with a +style+ param equal to its index in the array plus one (unlike arrays, the +style+ param's index is one-based):
 
-3. Add the folder name to HitCounter::STYLES. In your HTML, specify the new style with a params[:style] equal to its index in the array plus one.
+     <img alt="Hit Counter" border="0" src="/hit-counter?url=cnn.com&style=4" />
 
 == Contributing to hit_counter
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/hit_counter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "hit_counter"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roderick Monje"]
-  s.date = "2011-09-17"
+  s.date = "2011-09-18"
   s.email = "rod@seologic.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/hit_counter.rb

@@ -79,8 +79,8 @@ class HitCounter
   #   - +style_number+ -> the image style
   # * *Returns*
   #   - the current hit count as a PNG image
-  def image style_number = 0
-    image = HitCounter.cat_image self.hits.to_s, style_number.to_i - 1
+  def image style_number
+    image = HitCounter.cat_image self.hits.to_s, HitCounter.normalize_style_number(style_number)
     image.format = 'png'
     image
   end
@@ -98,11 +98,22 @@ class HitCounter
 
   STYLES = ['odometer', 'scout', 'celtic']
 
-  def self.cat_image number = '0', style_index = 0, images = Magick::ImageList.new
+  def self.cat_image number, style_index, images = Magick::ImageList.new
     return images.append(false) if number.blank?
     HitCounter.cat_image number[1..-1], style_index, images << Magick::Image.read("#{Rails.root}/public/images/digits/#{STYLES[style_index]}/#{number[0..0]}.gif").first
   end
 
+  def self.normalize_style_number value
+    value = value.to_i
+    value -= 1 if value > 0
+
+    if value >= 0 && value < STYLES.size
+      return value
+    else
+      value % 3
+    end
+  end
+
   def self.normalize_url value
     value !~ %r{^http://} ? "http://#{value}" : value
   end

data/spec/lib/hit_counter_spec.rb

@@ -35,12 +35,56 @@ describe HitCounter do
   end
 
   describe '#image' do
-    subject { @hit_counter.image }
+    subject { @hit_counter.image '1' }
 
     it { should be_a Magick::Image }
     pending 'should reflect hits'
   end
 
+  describe '#normalize_style_number' do
+    context 'when undefined' do
+      it 'should return 0' do
+        HitCounter.normalize_style_number(nil).should == 0
+      end
+    end
+
+    context 'when within range' do
+      it 'should return 0 for 1' do
+        HitCounter.normalize_style_number('1').should == 0
+      end
+
+      it 'should return 2 for 3' do
+        HitCounter.normalize_style_number('3').should == 2
+      end
+    end
+
+    context 'when outside range' do
+      context 'and negative' do
+        context 'should return 2 for' do
+          it -1 do
+            HitCounter.normalize_style_number('-1').should == 2
+          end
+
+          it -31 do
+            HitCounter.normalize_style_number('-31').should == 2
+          end
+        end
+      end
+
+      context 'and positive' do
+        context 'should return 0 for' do
+          it 4 do
+            HitCounter.normalize_style_number('4').should == 0
+          end
+
+          it 34 do
+            HitCounter.normalize_style_number('34').should == 0
+          end
+        end
+      end
+    end
+  end
+
   describe '#normalize_url' do
     context 'with "cnn.com"' do
       specify { HitCounter.normalize_url('cnn.com').should == 'http://cnn.com' }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hit_counter
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Roderick Monje
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-17 00:00:00 Z
+date: 2011-09-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: addressable