jackasset 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bbac3afa95ece2628102ae3b506cccabb70bc13
+  data.tar.gz: ea7dffdd2ae06384c0ec6028aae366552c07f66b
+SHA512:
+  metadata.gz: 48843b2e7f6040aca68a88944938578dd533ddef1aa3f5cde2941588cdc208e11a70aa70dc86e691a98a81f5e2f82f55eb59bcbdc62815f7dae0a4e495b040af
+  data.tar.gz: 15547d586c79a63c372793352451de5d58be92dd6df6f367390fcf0b9cb15da98008889ca633264f7b2abf1815ee6e88325528af455880c3c6153dbc16677af3

data/README.md

@@ -0,0 +1,17 @@
+# jackasset
+
+A Ruby CLI for checking local static site assets.
+
+## Usage
+
+```
+jackasset [-p PORT] path/to/html_files
+```
+
+```
+$ jackasset path/to/html_files
+  200 OK http://localhost:8080/images/posts/deciphering-metrics/turbulence-d401c085.jpg
+  404 Not Found http://localhost:8080//platform.twitter.com/widgets.js
+  404 Not Found https://google.com/assets/cheese.png
+Finished checking 3 URLs and found 2 issues
+```

data/bin/jackasset

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/jackasset'
+
+Jackasset::Cli.call

data/config/environment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'colorize'
+require 'csv'
+require 'net/http'
+require 'openssl'
+
+require_relative '../lib/jackasset'
+require_relative '../lib/jackasset/assets_checker'
+require_relative '../lib/jackasset/cli'
+require_relative '../lib/jackasset/rescued_response'
+require_relative '../lib/jackasset/url_checker'
+require_relative '../lib/jackasset/version'

data/lib/jackasset.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative '../config/environment'
+
+# The main module
+module Jackasset
+end

data/lib/jackasset/assets_checker.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Jackasset
+  class AssetsChecker
+    attr_reader :host, :num_issues, :source_dir
+
+    def initialize(host:, source_dir:)
+      @host = host
+      @source_dir = source_dir
+      @num_issues = 0
+    end
+
+    def self.call(host: 'http://localhost:8080', source_dir:)
+      new(host: host, source_dir: source_dir).call
+    end
+
+    def call
+      img_urls
+      threads = img_urls.each_with_object([]) do |url, threads|
+        next unless url.match?(/\Ahttp/)
+        threads << Thread.new { check_url url }
+      end
+      threads.each(&:join)
+      puts "Finished checking #{img_urls.count} URLs and found #{num_issues} issues"
+    end
+
+    private
+
+    def check_url(url)
+      display_result Jackasset::UrlChecker.new(url: url).call
+    end
+
+    def clean_url(url)
+      cleaned_url = url.gsub('src=', '').gsub('"', '').strip # Remove src, quotes, and whitespace
+      cleaned_url.gsub! /\A\/\//, 'http://' # Set protocol if needed
+      cleaned_url.slice! /\A\// # Remove single leading slash
+      cleaned_url.match?(/\Ahttp/) ? cleaned_url : "#{host}/#{cleaned_url}"
+    end
+
+    def display_result(response)
+        msg = " #{response.code} #{response.message} #{response.uri.to_s}\n"
+        case response
+        when Net::HTTPSuccess, Net::HTTPRedirection
+          print msg.green
+        else
+          @num_issues += 1
+          print msg.red
+        end
+      end
+
+    def img_urls
+      @img_urls ||= Dir["#{source_dir}/**/*.html"].each_with_object([]) do |path, urls|
+        file_content = File.read path
+        file_content.scan(/src=\"\S*\"/).flatten.each do |src|
+          urls << clean_url(src)
+        end
+      end
+    end
+  end
+end

data/lib/jackasset/cli.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Jackasset
+  # The main class
+  class Cli
+    BAD_CALL_MSG = 'Usage: jackasset [-p PORT] path/to/html_files'
+    PORT_RANGE = 1..65535
+
+    def self.call
+      new.call
+    end
+
+    def call
+      if valid_args_without_port?
+        check_assets source_dir: ARGV.first
+      elsif valid_args_with_port?
+        check_assets host: "http://localhost:#{ARGV[1]}", source_dir: ARGV.last
+      else
+        puts BAD_CALL_MSG.red
+      end
+    end
+
+    private
+
+    def check_assets(args)
+      Jackasset::AssetsChecker.call args
+    end
+
+    def valid_args_with_port?
+      ARGV.length == 3 && valid_port_arg? && valid_dir_arg?
+    end
+
+    def valid_args_without_port?
+      ARGV.length == 1 && valid_dir_arg?
+    end
+
+    def valid_dir_arg?
+      File.directory? ARGV.last
+    end
+
+    def valid_port_arg?
+      ARGV.first == '-p' && PORT_RANGE.include?(ARGV[1])
+    end
+  end
+end

data/lib/jackasset/rescued_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Jackasset
+  class RecuedResponse
+    attr_reader :code, :message, :uri
+
+    def initialize(code:, message:, uri:)
+      raise TypeError, "#{uri} is not a URI" unless uri.is_a? URI
+      @code = code
+      @message = message
+      @uri = uri
+    end
+  end
+end

data/lib/jackasset/url_checker.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Jackasset
+  class UrlChecker
+    attr_reader :url_string, :uri
+
+    def initialize(url:)
+      @url_string = url
+    end
+
+    def call
+      check_url
+    end
+
+    private
+
+    def check_url
+      @uri = URI(URI.escape url_string)
+      return invalid_uri_response unless valid_url?
+      response = Net::HTTP.get_response uri
+      response.uri ||= uri # sometimes the uri is not set
+      response
+    rescue Errno::ECONNREFUSED => e
+      rescued_response('Connection refused', e.message)
+    rescue Errno::EINVAL => e
+      rescued_response('Invalid argument', e.message)
+    rescue => e
+      rescued_response(e.class.to_s, e.message)
+    end
+
+    def invalid_uri_response
+      rescued_response('Invalid URL', 'URL must begin with http')
+    end
+
+    def rescued_response(code, message)
+      Jackasset::RecuedResponse.new(
+        code: code,
+        message: message,
+        uri: uri
+      )
+    end
+
+    def valid_url?
+      uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+    end
+  end
+end

data/lib/jackasset/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Jackasset
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jackasset
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin McCormack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A Ruby CLI for checking local static site assets.
+email: HarlemSquirrel@gmail.com
+executables:
+- jackasset
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/jackasset
+- config/environment.rb
+- lib/jackasset.rb
+- lib/jackasset/assets_checker.rb
+- lib/jackasset/cli.rb
+- lib/jackasset/rescued_response.rb
+- lib/jackasset/url_checker.rb
+- lib/jackasset/version.rb
+homepage: https://github.com/HarlemSquirrel/jackasset
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Check asset sources in HTML files
+test_files: []