checky 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 688c096c18ce172e0c5394d4d4d8c7c26f20a640
+  data.tar.gz: 4e5819ad3812086712428d1c30bb4b9ac46bc9f2
+SHA512:
+  metadata.gz: 72fa236906c0f2fe4420f9c7782078c06824093cccb41321790fd82b9fd6bc4d7489e59882b1c62b3421218e5bee066023490bea303866c09b44375286fcd1e4
+  data.tar.gz: e782c78722f77d0c61123843b9ad336b5e323227a96ff711cbab67c9387a5f35e7074b569493fec4e55f14c1b9621c8d0a5e826391971833868e9d00ed921ac7

data/lib/checky.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+require 'core_ext'
+require 'checky/version'
+require 'checky/exceptions'
+
+validators = Dir[File.expand_path('../checky/validators/*.rb', __FILE__)].map do |file|
+  File.basename(file).sub(/\.rb$/, '')
+end
+validators.reject! { |file| file == 'all' }
+
+validators.each do |validator|
+  require "checky/validators/#{validator}"
+end
+require 'checky/validators/all'
+
+require 'checky/checker'
+
+module Checky
+  attr_accessor :colorize
+
+  def check(&block)
+    Checker.new.check(&block)
+  end
+
+  # :nocov:
+  def run(command)
+    `#{command}`
+  end
+  # :nocov:
+
+  module_function :check, :run, :colorize, :colorize=
+end
+
+# :nocov:
+begin
+  require 'colorize'
+  Checky.colorize = true
+rescue LoadError
+  Checky.colorize = false
+end
+# :nocov:

data/lib/checky/checker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module Checky
+  class Checker
+    include Checky::Validators::All
+
+    attr_reader :storage
+
+    def initialize
+      @storage = OpenStruct.new(checky_blocks: {}, checky_results: {})
+      @self_before_instance_eval = false
+    end
+
+    def check(&block)
+      @self_before_instance_eval = eval 'self', block.binding
+      instance_eval(&block)
+      with_hooks { check_result }
+      @storage.checky_final_result
+    end
+
+    # :nocov:
+    # :reek:BooleanParameter
+    def respond_to_missing?(method, _include_private = false)
+      methods.include?("run_#{method}".to_sym)
+    end
+    # :nocov:
+
+    # rubocop:disable Style/MethodMissing
+    def method_missing(method, *args, &block)
+      raise Checky::Exception unless methods.include?("populate_#{method}".to_sym)
+      @storage.send("#{method}=", send("populate_#{method}", *args, &block))
+      @storage.checky_blocks[method.to_sym] = block if block_given?
+    rescue Checky::Exception
+      @self_before_instance_eval.send method, *args, &block if @self_before_instance_eval.present?
+    end
+    # rubocop:enable Style/MethodMissing
+
+    private
+
+    def check_result
+      @storage.checky_final_result = active_validators.all? do |validator_name|
+        block = @storage.checky_blocks[validator_name]
+        @storage.checky_results[validator_name] = if block.present?
+                                                    instance_eval(&block)
+                                                  else
+                                                    send("check_#{validator_name}")
+                                                  end
+      end
+    end
+
+    def active_validators
+      @storage.to_h.keys.reject { |key| key.to_s.start_with?('checky_') }
+    end
+
+    def with_hooks
+      fire_hook :before
+      yield if block_given?
+      fire_hook :after
+    end
+
+    def fire_hook(hook_name)
+      active_validators.each { |validator_name| send("#{hook_name}_#{validator_name}") }
+    end
+  end
+end

data/lib/checky/exceptions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Checky
+  class Exception < RuntimeError
+  end
+
+  class ValidationError < RuntimeError
+  end
+end

data/lib/checky/validators/all.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Checky
+  module Validators
+    module All
+    end
+  end
+end
+
+Checky::Validators.constants.each do |child|
+  next if child == :All
+  mod = Checky::Validators.const_get(child)
+
+  next unless mod.is_a?(Module)
+  Checky::Validators::All.include(mod)
+
+  mod.send(:attr_accessor, :storage)
+  mod.send(:module_function, :storage, :storage=)
+  %w(populate check message before after).each do |method|
+    mod.send(:module_function, method) if mod.method_defined?(method)
+  end
+
+  Checky::Validators::All.send(:define_method, "populate_#{child.to_s.underscore}") do |*args, &block|
+    validator = Object.const_get("Checky::Validators::#{child}")
+    data = validator.respond_to?(:populate) ? validator.populate(*args, &block) : true
+    @storage.send("#{child.to_s.underscore}=", data)
+  end
+
+  %w(check message before after).each do |helper_method|
+    Checky::Validators::All.send(:define_method, "#{helper_method}_#{child.to_s.underscore}") do |*args, &block|
+      validator = Object.const_get("Checky::Validators::#{child}")
+      validator.storage = @storage
+      validator.respond_to?(helper_method) ? validator.send(helper_method, *args, &block) : true
+    end
+  end
+end

data/lib/checky/validators/binary.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Checky
+  module Validators
+    module Binary
+      # :reek:UtilityFunction
+      def populate(command)
+        command.which.to_s
+      end
+
+      def check
+        !storage.binary.empty?
+      end
+
+      # :reek:UtilityFunction
+      def message(value)
+        "Checking for #{File.basename(value)}"
+      end
+    end
+  end
+end

data/lib/checky/validators/fail_hard.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Checky
+  module Validators
+    module FailHard
+      def after
+        raise Checky::ValidationError if storage.fail_hard && !storage.checky_final_result
+      end
+    end
+  end
+end

data/lib/checky/validators/verbose.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Checky
+  module Validators
+    module Verbose
+      # :reek:ManualDispatch
+      def after
+        storage.to_h.keys.each do |key|
+          next if key.to_s.start_with?('checky_')
+
+          mod = Object.const_get("Checky::Validators::#{String(key).classify}")
+          next unless mod.respond_to?(:check)
+
+          display_message(mod, key)
+        end
+      end
+
+      def display_message(mod, key)
+        result = storage.checky_results[key]
+        stream = result ? $stdout : $stderr
+
+        stream.puts("#{build_message(mod, key)} #{result_message(key)}")
+      end
+
+      def build_message(mod, key)
+        value = storage.send(key)
+
+        # :nocov:
+        message = begin
+          mod.message(value)
+        rescue
+          "Checking #{key} (#{value})"
+        end
+        # :nocov:
+        format_message(message, key)
+      end
+
+      def format_message(message, key)
+        key_size = key.to_s.size
+
+        "#{message[0..(65 - key_size)].ljust(67 - key_size, '.')}[#{key.capitalize}]"
+      end
+
+      def result_message(key)
+        result = storage.checky_results[key]
+
+        if Checky.colorize
+          result ? 'OK'.green : 'FAIL'.red
+        else
+          result ? 'OK' : 'FAIL'
+        end
+      end
+
+      module_function :display_message, :build_message, :format_message, :result_message
+    end
+  end
+end

data/lib/checky/validators/version.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Checky
+  module Validators
+    module Version
+      def populate(requirement_string)
+        requirement_string
+      end
+
+      def check
+        version = Gem::Version.new(version_string)
+        requirement = Gem::Requirement.new(storage.version)
+        requirement.satisfied_by?(version)
+      end
+
+      def version_string
+        command_path = storage.binary
+        command_output = Checky.run("#{command_path} --version").presence || Checky.run("#{command_path} -v").presence
+        command_output[/[0-9]+(?:\.[0-9]+)+/]
+      end
+
+      def message(value)
+        "Checking #{File.basename(storage.binary)} version against #{value}"
+      end
+
+      module_function :version_string
+    end
+  end
+end

data/lib/checky/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Checky
+  VERSION = '0.1.0'
+end

data/lib/core_ext.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module CoreExt
+end
+
+class Object
+  # :reek:ManualDispatch
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+
+  def presence
+    self if present?
+  end
+end
+
+class String
+  def which
+    bin_path = ENV['PATH'].split(File::PATH_SEPARATOR).find do |path|
+      file = File.join(path, self)
+      File.exist?(file) && File.executable?(file)
+    end
+    bin_path ? File.join(bin_path, self) : nil
+  end
+
+  # :reek:TooManyStatements
+  def underscore
+    return self unless self =~ /[A-Z-]|::/
+    word = to_s.gsub('::', '/')
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    word.tr('-', '_').downcase
+  end
+
+  def classify
+    sub(/^[a-z\d]*/, &:capitalize).gsub(%r{(?:_|(\/))([a-z\d]*)}i) do
+      "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+    end.gsub('/', '::')
+  end
+
+  def satisfies_requirement?(requirement_string)
+    version = Gem::Version.new(self)
+    requirement = Gem::Requirement.new(requirement_string)
+    requirement.satisfied_by?(version)
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: checky
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Rzegocki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-07 00:00:00.000000000 Z
+dependencies: []
+description: Dependencies checker for CLI tools
+email:
+- igor@rzegocki.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/checky.rb
+- lib/checky/checker.rb
+- lib/checky/exceptions.rb
+- lib/checky/validators/all.rb
+- lib/checky/validators/binary.rb
+- lib/checky/validators/fail_hard.rb
+- lib/checky/validators/verbose.rb
+- lib/checky/validators/version.rb
+- lib/checky/version.rb
+- lib/core_ext.rb
+homepage: https://github.com/ajgon/checky
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Dependencies checker for CLI tools
+test_files: []