hit_counter 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36573d86b5005fa7d992427ba4446c6ab7b4d1ac5fb2519cc9163d0404aee5ac
-  data.tar.gz: 61a10766d8d156b6bd2fe6316230c2102d8271952ef9f6419d50f99e4aea4043
+  metadata.gz: 7fda3c8ce5cf2522c3484d1320cf0a9c0699babc2cf5a798f33a62836bf22960
+  data.tar.gz: e4481b5da767e640461569f54dc0488ac2f55e8a8bb01df7e1243345140871e0
 SHA512:
-  metadata.gz: 67e2bf0e5375f4a133c4770b351694c4b91b15dbd09b387dd6f00b3ac5070d354dee1505b5accb3892ceca10d8cc2f51285a2111b50892eade3a5b96f12ce868
-  data.tar.gz: 25c5224c5004299e810a37a59dcb5db135f7178887255027c929f0992df8d45e580f838bebf9208c1651e7ef13d675336fa36d9822b1a8ada7edb7c9d76a997f
+  metadata.gz: a9c34c10421251e18abc582522669a6292f831fe1fdee1cd97d8edbe7fb1ae9812fd74698b8e3ea02aee94b90cbd645c385df7ff832f1da2a30acc12e226dcb1
+  data.tar.gz: 76d58f7a643749eb22c38e04b2d6c5e2cac97ba98b1233a2c7813d2c534523ba58f5eb0583358c0578f8e60a7b6fd34eb45f6ffd1f643896f6884377776a6481

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,9 @@
-Closes: #
+# Closes: #
 
-# Goal
+## Goal
 What problem does this pull request solve? This should be close to the goal of the issue this pull request addresses.
 
-# Approach
+## Approach
 1. **Describe, in numbered steps, the approach you chose** to solve the above problem.
     1. This will help code reviewers get oriented quickly.
     2. It will also document for future maintainers exactly what changed (and why) when this PR was merged.

data/.github/workflows/test.yml

@@ -27,9 +27,16 @@ jobs:
         mongodb-version: '4.4'
     - name: Run tests
       run: bundle exec rake
-    - name: Coveralls
+    - name: Send Code Climate coverage
+      uses: amancevice/setup-code-climate@v0
+      with:
+        cc_test_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}
+    - run: cc-test-reporter after-build --coverage-input-type lcov
+    - name: Send Coveralls coverage
       uses: coverallsapp/github-action@master
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Rubocop
+    - name: Run RuboCop
       run: bundle exec rubocop
+    - name: Run Inch
+      run: bundle exec inch --pedantic

data/CONTRIBUTING.md

@@ -2,13 +2,13 @@
 
 ## **New to open-source?**
 
-Try your hand at one of the small tasks ideal for new or casual contributors that are [up-for-grabs](https://github.com/ivanoblomov/hit_counter/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs). Welcome to the community!
+Try your hand at one of the small tasks ideal for new or casual contributors that are [up-for-grabs](https://github.com/FoveaCentral/hit_counter/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs). Welcome to the community!
 
 ## **Did you find a bug?**
 
-1. **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/ivanoblomov/hit_counter/issues).
+1. **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/FoveaCentral/hit_counter/issues).
 
-2. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ivanoblomov/hit_counter/issues/new/choose). Be sure to include:
+2. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/FoveaCentral/hit_counter/issues/new/choose). Be sure to include:
     1. a **title and clear description**
     2. as much **relevant information** as possible
     3. a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
@@ -21,7 +21,7 @@ Try your hand at one of the small tasks ideal for new or casual contributors tha
 
 3. **Update the inline documentation.** Format it with [YARD](https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md). For example, see [`HitCounter.get`](../lib/hit_counter/hit_counter.rb).
 
-4. [Open a pull request](https://github.com/ivanoblomov/hit_counter/compare) with the patch or feature. Follow the template's directions.
+4. [Open a pull request](https://github.com/FoveaCentral/hit_counter/compare) with the patch or feature. Follow the template's directions.
 
 ## Developer Certificate of Origin (DCO)
 

data/Gemfile

@@ -2,3 +2,13 @@
 
 source 'https://rubygems.org'
 gemspec
+
+gem 'inch', '~> 0.8'
+gem 'pry', '~> 0.14.1'
+gem 'rake', '>= 12.3.3', '~> 13.0'
+gem 'rspec', '~> 3'
+gem 'rubocop', '< 1.24'
+gem 'rubocop-rake', '~> 0'
+gem 'rubocop-rspec', '~> 2'
+gem 'simplecov', '~> 0.18'
+gem 'simplecov-lcov', '~> 0.8'

data/README.md

@@ -1,13 +1,12 @@
 # HitCounter
 
-![Build status](https://github.com/ivanoblomov/hit_counter/workflows/test/badge.svg)
-[![Code Climate](https://codeclimate.com/github/ivanoblomov/hit_counter.png)](https://codeclimate.com/github/ivanoblomov/hit_counter)
-[![Coveralls](https://coveralls.io/repos/ivanoblomov/hit_counter/badge.svg?branch=master&service=github)](https://coveralls.io/github/ivanoblomov/hit_counter?branch=master)
-[![Inch CI](https://inch-ci.org/github/ivanoblomov/hit_counter.svg?branch=master&style=flat)](https://inch-ci.org/github/ivanoblomov/hit_counter)
+[![Build status](https://github.com/FoveaCentral/hit_counter/workflows/test/badge.svg)](https://github.com/FoveaCentral/hit_counter/actions/workflows/test.yml)
+[![Code Climate](https://codeclimate.com/github/FoveaCentral/hit_counter.svg)](https://codeclimate.com/github/FoveaCentral/hit_counter)
+[![Coveralls](https://coveralls.io/repos/FoveaCentral/hit_counter/badge.svg?branch=master&service=github)](https://coveralls.io/github/FoveaCentral/hit_counter?branch=master)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5375/badge)](https://bestpractices.coreinfrastructure.org/projects/5375)
 [![Gem Version](https://badge.fury.io/rb/hit_counter.svg)](https://badge.fury.io/rb/hit_counter)
 
-Ruby version of that old 90s chestnut, `<BLINK>`the web-site hit counter`</BLINK>`.
+Self-hosted Ruby version of that old 90s chestnut, `<BLINK>`the web-site hit counter`</BLINK>`.
 
 ## Installation
 
@@ -30,7 +29,7 @@ Ruby version of that old 90s chestnut, `<BLINK>`the web-site hit counter`</BLINK
     `HitCounter` is cryptographically signed. To insure the gem you install hasn’t been tampered with, add my public key as a trusted certificate and then install:
 
     ```sh
-    gem cert --add <(curl -Ls https://raw.github.com/ivanoblomov/hit_counter/master/certs/ivanoblomov.pem)
+    gem cert --add <(curl -Ls https://raw.github.com/FoveaCentral/hit_counter/master/certs/ivanoblomov.pem)
     gem install hit_counter -P HighSecurity
     ```
 
@@ -61,6 +60,12 @@ Ruby version of that old 90s chestnut, `<BLINK>`the web-site hit counter`</BLINK
      # technically should be POST/PUT, but GET makes integration simpler
     ````
 
+3. Add the hit-counter image tag to your site's HTML:
+
+    ```html
+      <img alt="Hit Counter" border="0" src="/hit-counter?url=https://cnn.com&style=1" />
+    ````
+
 Or try it out in `irb` with:
 
 ```ruby
@@ -68,17 +73,11 @@ require './spec/spec_helper'
 hc = HitCounter.get('cnn.com')
 ```
 
-3. Add the hit-counter image tag to your site's HTML:
-
-    ```html
-      <img alt="Hit Counter" border="0" src="/hit-counter?url=https://cnn.com&style=1" />
-    ````
-
 ## Customizing the Hit-Counter Image
 
 ### Use an Existing Style
 
-| Name     | Image                                                                 |
+| Name     | Style number                                                          |
 | -------- | --------------------------------------------------------------------- |
 | Celtic   | ![image of 3 in celtic style](/public/images/digits/celtic/3.png)     |
 | Odometer | ![image of 1 in odometer style](/public/images/digits/odometer/1.png) |

data/Rakefile

@@ -3,6 +3,19 @@
 require 'bundler'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+
+def load_rake_tasks
+  Dir.glob('./lib/tasks/**/*.rake').each { |f| import f }
+end
+load_rake_tasks
+
+if defined? Rails
+  # override Rails to include tasks
+  class Railtie < Rails::Railtie
+    rake_tasks { load_rake_tasks }
+  end
+end
+
 RSpec::Core::RakeTask.new(:test) do |t|
   t.pattern = 'spec/*/*_spec.rb'
   t.verbose = false

data/SECURITY.md

@@ -2,15 +2,15 @@
 
 ## Supported Versions
 
-[Dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) automatically [patches known vulnerabilities](https://github.com/ivanoblomov/hit_counter/pulls?q=is%3Apr+is%3Aclosed+author%3Aapp%2Fdependabot).
+[Dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) automatically [patches known vulnerabilities](https://github.com/FoveaCentral/hit_counter/pulls?q=is%3Apr+is%3Aclosed+author%3Aapp%2Fdependabot).
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.1.4   | :white_check_mark: |
-| < 0.1.4 | :x:                |
+| 0.1.5   | :white_check_mark: |
+| < 0.1.5 | :x:                |
 
 ## Reporting a Vulnerability
 
-1. To report a security vulnerability, [open an issue](https://github.com/ivanoblomov/hit_counter/issues/new/choose).
+1. To report a security vulnerability, [open an issue](https://github.com/FoveaCentral/hit_counter/issues/new/choose).
 2. Updates are made within 48 hours.
 3. If the vulnerability is accepted, we'll try to patch it within a week.

data/hit_counter.gemspec

@@ -4,33 +4,22 @@ require File.expand_path 'lib/version', __dir__
 Gem::Specification.new do |s|
   s.name = 'hit_counter'
   s.version = HitCounter::VERSION.dup
-  s.summary = 'Ruby version of that old 90s chestnut, the web-site hit counter.'
+  s.summary = 'Self-hosted Ruby version of that old 90s chestnut, the web-site hit counter.'
   s.description = 'Why roast this chestnut by that open fire, you ask? Cause '\
     'thousands and thousands of Internet vets are still using the one we '\
     "wrote in PHP eons ago and we don't want to be squandering any incidental "\
     "Google juice, that's why."
-  s.homepage = 'https://github.com/ivanoblomov/hit_counter'
+  s.homepage = 'https://github.com/FoveaCentral/hit_counter'
   s.authors = ['Roderick Monje']
   s.cert_chain = ['certs/ivanoblomov.pem']
   s.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME =~ /gem\z/
 
-  s.add_development_dependency 'rake', '>= 12.3.3', '~> 13.0'
-  s.add_development_dependency 'rspec', '~> 3'
-  s.add_development_dependency 'rubocop', '< 1.24'
-  s.add_development_dependency 'rubocop-rake', '~> 0'
-  s.add_development_dependency 'rubocop-rspec', '~> 2'
-  s.add_development_dependency 'simplecov', '~> 0.18'
-  s.add_development_dependency 'simplecov-lcov', '~> 0.8'
-
   s.add_runtime_dependency 'addressable', '~> 2'
   s.add_runtime_dependency 'bson_ext', '~> 1'
   s.add_runtime_dependency 'mongoid', '~> 7'
   s.add_runtime_dependency 'rmagick', '>= 2', '< 5'
 
   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.required_ruby_version = '>= 2.5'
 end

data/lib/hit_counter.rb

@@ -6,7 +6,7 @@ require 'rubygems'
 require 'bundler/setup'
 Bundler.require :default
 
-# Ruby version of that old 90s chestnut, <BLINK>the web-site hit counter</BLINK>
+# Self-hosted Ruby version of that old 90s chestnut, <BLINK>the web-site hit counter</BLINK>
 #
 # @example
 #   hc = HitCounter.get 'cnn.com'
@@ -24,6 +24,8 @@ class HitCounter
   # If the URI library can parse the value and the scheme is valid, then we
   # assume the url is valid.
   class UrlValidator < ActiveModel::EachValidator
+    private
+
     def validate_each(record, attribute, value)
       uri = Addressable::URI.parse value
       raise Addressable::URI::InvalidURIError unless %w[http https].include?(
@@ -55,6 +57,18 @@ class HitCounter
     find_or_create_by args
   end
 
+  # 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.
@@ -104,6 +118,7 @@ class HitCounter
     save
   end
 
+  # Defines the available image styles as an array. Add yours to the end.
   STYLES = %w[odometer scout celtic].freeze
 
   private_class_method def self.cat_image(number, style_index, images = Magick::ImageList.new)
@@ -127,21 +142,3 @@ class HitCounter
     value !~ %r{^http://} ? "http://#{value}" : value
   end
 end
-
-if defined? Rails
-  # Overriding Rails to include install task
-  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

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

data/spec/lib/hit_counter_spec.rb

@@ -56,6 +56,13 @@ describe HitCounter do
       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
     it { expect(subject.hits).to eq 0 }
 

data/spec/spec_helper.rb

@@ -19,3 +19,45 @@ module Rails
     '.'
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hit_counter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Roderick Monje
@@ -34,112 +34,8 @@ cert_chain:
   G5iWAeYsmSjJxz7iOZOsx+vPCwMy7j6nWF2CDbaxioGR/hIqNbVBveCCRyjyunD3
   kvv576EuULmQcLpOKwB3RlxAG7j8JJl4ueqjF+rz7x1lBqEU
   -----END CERTIFICATE-----
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.24'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.24'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +128,7 @@ files:
 - config/mongoid.yml
 - hit_counter.gemspec
 - lib/hit_counter.rb
+- lib/tasks/install.rake
 - lib/version.rb
 - public/images/digits/celtic/0.png
 - public/images/digits/celtic/1.png
@@ -265,7 +162,7 @@ files:
 - public/images/digits/scout/9.png
 - spec/lib/hit_counter_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/ivanoblomov/hit_counter
+homepage: https://github.com/FoveaCentral/hit_counter
 licenses: []
 metadata: {}
 post_install_message:
@@ -283,10 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Ruby version of that old 90s chestnut, the web-site hit counter.
-test_files:
-- spec/lib/hit_counter_spec.rb
-- spec/spec_helper.rb
+summary: Self-hosted Ruby version of that old 90s chestnut, the web-site hit counter.
+test_files: []