hit_counter 0.1.1 → 0.1.5

data/lib/hit_counter.rb

@@ -1,138 +1,144 @@
-# Copyright (c) 2011 Roderick Monje
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# Copyright the HitCounter contributors.
+# SPDX-License-Identifier: MIT
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 Bundler.require :default
 
+# Self-hosted Ruby version of that old 90s chestnut, <BLINK>the web-site hit counter</BLINK>
+#
+# @example
+#   hc = HitCounter.get 'cnn.com'
+#   hc.increment
 class HitCounter
   include Mongoid::Document
   include Mongoid::Timestamps
 
-  # Mongo Config ===================================================================================
+  # Mongo Config ===============================================================
+  field :hits, type: Integer, default: 0
   field :url
-  field :hits, :type => Integer, :default => 0
 
   # Validates the <code>HitCounter</code>'s URL.
   #
-  # If the URI library can parse the value and the scheme is valid, then we assume the url is valid.
+  # If the URI library can parse the value and the scheme is valid, then we
+  # assume the url is valid.
   class UrlValidator < ActiveModel::EachValidator
-    def validate_each record, attribute, value
-      begin
-        uri = Addressable::URI.parse value
-
-        if !['http', 'https'].include? uri.scheme
-          raise Addressable::URI::InvalidURIError
-        end
-      rescue Addressable::URI::InvalidURIError
-        record.errors[attribute] << 'Invalid URL'
-      end
+    private
+
+    def validate_each(record, attribute, value)
+      uri = Addressable::URI.parse value
+      raise Addressable::URI::InvalidURIError unless %w[http https].include?(
+        uri.scheme
+      )
+    rescue Addressable::URI::InvalidURIError
+      record.errors.add attribute, 'Invalid URL'
     end
   end
 
-  validates :url, :presence => true, :url => true, :uniqueness => true
+  validates :hits, numericality: { only_integer: true }
+  validates :url, presence: true, url: true, uniqueness: true
 
-  # Class methods ==================================================================================
+  # Class methods ==============================================================
 
-  # Returns a <code>HitCounter</code> matching the specified URL. The HitCounter is created if no
-  # matching one is found. In the latter case, the hits argument specifies the starting count.
+  # Returns a <code>HitCounter</code> matching the specified URL. The HitCounter
+  # is created if no matching one is found. In the latter case, the hits
+  # argument specifies the starting count.
   #
-  # * *Args*
-  #   - +url+ -> the URL for the site being counted
-  #   - +hits+ -> the number of hits to start with
-  # * *Returns*
-  #   - the site's HitCounter
-  def self.get url, hits = 0
-    args = {:url => HitCounter.normalize_url(url)}
-    args[:hits] = hits unless HitCounter.exists? :conditions => args
-    self.find_or_create_by args
+  # @param url [String] the URL for the site being counted
+  # @param hits [Integer] the number of hits to start with
+  # @return [HitCounter] the site's HitCounter
+  # @example
+  #   hc = HitCounter.get 'cnn.com'
+  #   hc = HitCounter.get 'cnn.com', 100
+  def self.get(url, hits = 0)
+    args = { url: normalize_url(url) }
+    args[:hits] = hits unless where(conditions: args).exists?
+    find_or_create_by args
   end
 
-  # Instance methods: Overrides ====================================================================
+  # Installs the required Mongoid configuration and image files.
+  #
+  # @return true
+  # @example
+  #   HitCounter.install
+  def self.install
+    puts 'Configuring Mongoid and installing image files...'
+    full_gem_path = Gem::Specification.find_by_name('hit_counter').full_gem_path
+    system "rsync -ruv #{full_gem_path}/config ."
+    system "rsync -ruv #{full_gem_path}/public ."
+  end
+
+  # Instance methods: Overrides ================================================
+
+  # Sets the number of hits.
+  #
+  # @param value [Integer] the initial number of hits
+  # @return [Integer] the number of hits
+  # @example
+  #   hc.hits = 100
+  def hits=(value)
+    self[:hits] = value.to_i
+  end
 
   # Sets the URL to be tracked. The http prefix is optional.
   #
-  # * *Args*
-  #   - +value+ -> the URL for the site being counted
-  # * *Returns*
-  #   - the value
-  def url= value
-    self[:url] = HitCounter.normalize_url value
+  # @param value [String] the URL for the site being counted
+  # @return [String] the normalized URL
+  # @example
+  #   hc.url = 'cnn.com'
+  def url=(value)
+    self[:url] = HitCounter.send(:normalize_url, value)
   end
 
-  # Instance methods ===============================================================================
+  # Instance methods ===========================================================
 
   # Returns the hit count as a PNG image, using the specified style:
   #   1 odometer
   #   2 scout
   #   3 Celtic
   #
-  # * *Args*
-  #   - +style_number+ -> the image style
-  # * *Returns*
-  #   - the current hit count as a PNG image
-  def image style_number
-    image = HitCounter.cat_image self.hits.to_s, HitCounter.normalize_style_number(style_number)
+  # @param style_number [String] the image style
+  # @return [Magick::Image] the current hit count as a PNG image
+  # @example
+  #   hc.image = 1
+  def image(style_number)
+    image = HitCounter.send(:cat_image, hits.to_s, HitCounter.send(:normalize_style_number, style_number))
     image.format = 'png'
     image
   end
 
   # Increments the hit count and saves the HitCounter.
   #
-  # * *Returns*
-  #   - true if the save was successful
+  # @return [true] if the save was successful
+  # @example
+  #   hc.increment
   def increment
     self.hits += 1
-    self.save
+    save
   end
 
-  private
-
-  STYLES = ['odometer', 'scout', 'celtic']
+  # Defines the available image styles as an array. Add yours to the end.
+  STYLES = %w[odometer scout celtic].freeze
 
-  def self.cat_image number, style_index, images = Magick::ImageList.new
+  private_class_method 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
+
+    cat_image(number[1..-1], style_index, images <<
+      Magick::Image.read("#{Rails.root}/public/images/digits/"\
+                         "#{STYLES[style_index]}/#{number[0..0]}.png").first)
   end
 
-  def self.normalize_style_number value
+  private_class_method def self.normalize_style_number(value)
     value = value.to_i
-    value -= 1 if value > 0
+    value -= 1 if value.positive?
 
-    if value >= 0 && value < STYLES.size
-      return value
-    else
-      value % 3
-    end
+    return value if value >= 0 && value < STYLES.size
+
+    value % 3
   end
 
-  def self.normalize_url value
+  private_class_method def self.normalize_url(value)
     value !~ %r{^http://} ? "http://#{value}" : value
   end
 end
-
-if defined? Rails
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      namespace :hit_counter do
-        desc 'Install HitCounter into your app.'
-        task :install do
-          puts 'Installing required image files...'
-          system "rsync -ruv #{Gem.searcher.find('hit_counter').full_gem_path}/config ."
-          system "rsync -ruv #{Gem.searcher.find('hit_counter').full_gem_path}/public ."
-        end
-      end
-    end
-  end
-end

data/lib/tasks/install.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+namespace :hit_counter do
+  desc 'Install HitCounter into your app.'
+  task(:install) { HitCounter.install }
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Self-hosted Ruby version of that old 90s chestnut, <BLINK>the web-site hit counter</BLINK>
+class HitCounter
+  # This gem's version
+  VERSION = '0.1.5' unless defined?(HitCounter::VERSION)
+end

data/spec/lib/hit_counter_spec.rb

@@ -1,109 +1,150 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# Copyright the HitCounter contributors.
+# SPDX-License-Identifier: MIT
+# frozen_string_literal: true
 
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+JAVASCRIPT_HACK = %q(eval("console.log('All your base belong to us!')"))
+# rubocop:disable Metrics/BlockLength
 describe HitCounter do
-  before :all do
-    HitCounter.delete_all
-    @hit_counter = HitCounter.get 'www.google.com'
-  end
+  before(:all) { described_class.delete_all }
+
+  subject { described_class.get 'www.google.com' }
 
-  describe '#get' do
-    context 'when existing URL' do
-      describe 'document count' do
-        specify { HitCounter.count.should == 1 }
+  describe '.get' do
+    context 'with existing URL' do
+      let!(:hit_counter2) { described_class.get subject.url, 10 }
+
+      describe '.count' do
+        it { expect(described_class.count).to eq 1 }
       end
 
       context 'with starting count 10' do
-        describe 'hits' do
-          specify { HitCounter.get(@hit_counter.url, 10).hits.should == 0 }
+        describe '#hits' do
+          it { expect(hit_counter2.hits).to eq 10 }
         end
       end
     end
+    context 'with new URL' do
+      before { described_class.get 'www.cnn.com' }
 
-    context 'when new URL' do
-      before { HitCounter.get 'www.cnn.com' }
-
-      describe 'document count' do
-        specify { HitCounter.count.should == 2 }
+      describe '.count' do
+        it { expect(described_class.count).to eq 2 }
       end
 
+      context 'with blank starting count' do
+        describe '#hits' do
+          it do
+            expect(described_class.get('www.nytimes.com', nil).hits).to eq 0
+          end
+        end
+      end
       context 'with starting count 10' do
-        describe 'hits' do
-          specify { HitCounter.get('www.nytimes.com', 10).hits.should == 10 }
+        describe '#hits' do
+          it { expect(described_class.get('online.wsj.com', 10).hits).to eq 10 }
         end
       end
     end
+    context 'with JavaScript' do
+      before { described_class.delete_all }
+
+      subject { described_class.get(JAVASCRIPT_HACK) }
+
+      it do
+        subject.save
+        expect(subject).to be_invalid
+      end
+    end
   end
+  describe '.install' do
+    before do
+      expect_any_instance_of(Object).to receive(:system).twice.with match(/config|public/)
+    end
 
+    it('copies configuration files and images') { described_class.install }
+  end
   describe '#hits' do
-    subject { @hit_counter.hits }
-
-    it { should == 0 }
+    it { expect(subject.hits).to eq 0 }
 
     context 'when incremented' do
-      before { @hit_counter.increment }
+      before { subject.increment }
 
-      specify { @hit_counter.hits.should == 1 }
+      it { expect(subject.hits).to eq 1 }
     end
   end
+  describe '#hits=' do
+    context 'with JavaScript' do
+      before { subject.hits = JAVASCRIPT_HACK }
 
-  describe '#image' do
-    subject { @hit_counter.image '1' }
-
-    it { should be_a Magick::Image }
-    pending 'should reflect hits'
+      it { expect(subject.hits).to eq 0 }
+    end
   end
-
-  describe '#normalize_style_number' do
-    context 'when undefined' do
-      it 'should return 0' do
-        HitCounter.normalize_style_number(nil).should == 0
-      end
+  describe '#image' do
+    context 'with a valid :style_number' do
+      it { expect(subject.image('1').filename).to eq "./public/images/digits/odometer/#{subject.hits}.png" }
     end
-
-    context 'when within range' do
-      it 'should return 0 for 1' do
-        HitCounter.normalize_style_number('1').should == 0
+    context 'with JavaScript' do
+      it {
+        expect(subject.image(JAVASCRIPT_HACK).filename).to eq "./public/images/digits/odometer/#{subject.hits}.png"
+      }
+    end
+  end
+  describe '#url=' do
+    context 'with JavaScript' do
+      before do
+        subject.url = JAVASCRIPT_HACK
+        subject.save
       end
 
-      it 'should return 2 for 3' do
-        HitCounter.normalize_style_number('3').should == 2
-      end
+      it { expect(subject).to be_invalid }
     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
+  describe '.normalize_style_number' do
+    context 'with nil' do
+      it { expect(described_class.send(:normalize_style_number, nil)).to be_zero }
+    end
+    context 'with empty string' do
+      it { expect(described_class.send(:normalize_style_number, '')).to be_zero }
+    end
+    context 'with JavaScript' do
+      it { expect(described_class.send(:normalize_style_number, JAVASCRIPT_HACK)).to be_zero }
+    end
+    context 'with number in range' do
+      {
+        '1' => 0,
+        '3' => 2
+      }.each do |input, output|
+        context "with '#{input}'" do
+          it do
+            expect(described_class.send(:normalize_style_number, input)).to eq output
           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
+    context 'with number outside range' do
+      {
+        '-31' => 2,
+        '-1' => 2,
+        '4' => 0,
+        '34' => 0
+      }.each do |input, output|
+        context "with '#{input}'" do
+          it do
+            expect(described_class.send(:normalize_style_number, input)).to eq output
           end
         end
       end
     end
   end
-
-  describe '#normalize_url' do
-    context 'with "cnn.com"' do
-      specify { HitCounter.normalize_url('cnn.com').should == 'http://cnn.com' }
-    end
-
-    context 'with "http://www.nytimes.com"' do
-      specify { HitCounter.normalize_url('http://www.nytimes.com').should == 'http://www.nytimes.com' }
+  describe '.normalize_url' do
+    {
+      'cnn.com' => 'http://cnn.com',
+      'http://www.nytimes.com' => 'http://www.nytimes.com'
+    }.each do |input, output|
+      context "with '#{input}'" do
+        it { expect(described_class.send(:normalize_url, input)).to eq output }
+      end
     end
   end
-end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -1,14 +1,63 @@
+# frozen_string_literal: true
+
+require 'simplecov'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'addressable/uri'
+require 'mongoid'
+require 'RMagick'
 require 'rspec'
+
 require 'hit_counter'
 
-Mongoid::Config.from_hash 'database' => 'hit_counter'
-Mongoid.logger = false
+Mongoid.load! 'config/mongoid.yml', :test
+Mongo::Logger.logger.level = ::Logger::WARN
 
 # Stub Rails root during tests.
 module Rails
   def self.root
     '.'
   end
-end
+end
+
+require 'rake'
+
+# load rake tasks
+# https://dev.to/cassidycodes/how-to-test-rake-tasks-with-rspec-without-rails-3mhb
+module TaskFormat
+  extend ActiveSupport::Concern
+  included do
+    let(:task_name) { self.class.top_level_description.sub(/\Arake /, '') }
+    let(:tasks) { Rake::Task }
+    # Make the Rake task available as `task` in your examples:
+    subject(:task) { tasks[task_name] }
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Dir.glob('lib/tasks/*.rake').each { |r| Rake::DefaultLoader.new.load r }
+  end
+
+  # Tag Rake specs with `:task` metadata or put them in the spec/tasks dir
+  config.define_derived_metadata(file_path: %r{/spec/tasks/}) do |metadata|
+    metadata[:type] = :task
+  end
+
+  config.include TaskFormat, type: :task
+end
+
+# silence output
+RSpec.configure do |config|
+  original_stderr = $stderr
+  original_stdout = $stdout
+  config.before(:all) do
+    # Redirect stderr and stdout
+    $stderr = File.open(File::NULL, 'w')
+    $stdout = File.open(File::NULL, 'w')
+  end
+  config.after(:all) do
+    $stderr = original_stderr
+    $stdout = original_stdout
+  end
+end