checkit 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in checkit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Maximilian Schulz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Checkit
+
+This gem provides a small executable which can be run from every ruby project in order to help new developers to check if they are ready to run the project. It checks for various dependencies:
+
+* Bundled gems
+* Config files
+* Servers installed and running
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'checkit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkit
+
+## Usage
+
+Change to your project directory and run ```checkit```, read the data and if something red is printed get some help ;)
+
+## ToDo
+
+* Check if foreman is installed and tell user to use it for running dependencies
+* Check if a test suite is present and can be run
+* Cleanup the existing code
+* Create a central service repository whcih resolves all dependencies
+* Check environments
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/checkit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby -w
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'checkit'
+
+CheckIt::Core.run

data/checkit.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkit/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'checkit'
+  gem.version       = CheckIt::VERSION
+  gem.authors       = ['Maximilian Schulz']
+  gem.email         = ['m.schulz@kulturfluss.de']
+  gem.description   = %q{A little tool to check the your ruby project dependencies}
+  gem.summary       = %q{This gem provides an executable which checks common project dependencies. It checks if the bundle is installed, all servers are running and if your config files are in place.}
+  gem.homepage      = 'https://github.com/railslove/checkit'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'bundler'
+  gem.add_dependency 'ansi'
+end

data/lib/checkit.rb

@@ -0,0 +1,16 @@
+# Disable all warnings
+$VERBOSE = nil
+
+# Create namespace
+CheckIt = Module.new
+
+# Utility classes
+require "checkit/version"
+require "checkit/styled_io"
+
+# Checks
+require "checkit/config_files"
+require "checkit/services"
+
+# Core application
+require "checkit/core"

data/lib/checkit/config_files.rb

@@ -0,0 +1,38 @@
+module CheckIt
+  class ConfigFiles
+
+    attr_accessor :io
+
+    def initialize(io)
+      self.io = io
+    end
+
+    def perform_checks
+      if File.directory?('config')
+        check_unmatched_example_files
+      else
+        io.puts colorize(:help, 'No config directory')
+      end
+    end
+
+    private
+
+    def check_unmatched_example_files
+      Dir['config/*sample*', 'config/*example*'].each do |example_file|
+        cleaned_file_name = example_file.gsub(/\.sample|\.example/, '')
+        io.print "   #{cleaned_file_name}: "
+        output = if File.exists?(cleaned_file_name)
+          io.colorize(:notice, 'Ok')
+        else
+          if %w(.json .yml).include?(File.extname(cleaned_file_name))
+            io.colorize(:alert, 'Missing')
+          else
+            io.colorize(:warning, 'Probably not a config file or a duplicate')
+          end
+        end
+        io.puts output
+      end
+    end
+
+  end
+end

data/lib/checkit/core.rb

@@ -0,0 +1,61 @@
+require 'bundler'
+
+module CheckIt
+  class Core
+
+    attr_accessor :io
+
+    def self.run(io = STDOUT)
+      self.new(io).perform_checks
+      io.puts
+    end
+
+    def initialize(io)
+      self.io = StyledIO.new(io)
+    end
+
+    def perform_checks
+      check_bundle
+      check_dependencies
+      # TODO: check if foreman is installed
+      check_config_files
+      # TODO: notify about test suites
+    end
+
+    protected
+
+    def check_bundle
+      io.print_header('Bundled rubygems')
+      simple_check('bundle check', 'Bundle', %(Run 'bundle install'))
+    end
+
+    def check_dependencies
+      io.print_header('Server dependencies')
+      Services.new(io).perform_checks
+    end
+
+    def check_config_files
+      io.print_header('Configuration files')
+      ConfigFiles.new(io).perform_checks
+    end
+
+    private
+
+    def simple_check(cmd, message, hint = nil)
+      %x[#{cmd}]
+      io.print " * #{message}: "
+      if $?.exitstatus == 1
+        io.print io.colorize(:alert, 'failed')
+        if hint
+          io.puts
+          io.print io.colorize(:help, "   Hint: #{hint}")
+        end
+      else
+        io.print io.colorize(:notice, 'OK')
+      end
+      io.puts
+      $?.exitstatus == 0
+    end
+
+  end
+end

data/lib/checkit/services.rb

@@ -0,0 +1,90 @@
+module CheckIt
+  class Services
+
+    attr_accessor :io
+
+    DEPENDENCY_STATES = [:ok, :not_running, :not_installed]
+
+    EXTERNAL_DEPENDENCIES = {
+      'pg'          => ['postgres'],
+      'mysql'       => ['mysqld'],
+      'mysql2'      => ['mysqld'],
+      'tire'        => ['elasticsearch'],
+      'neography'   => ['neo4j'],
+      'redis'       => ['redis-server'],
+      'amqp'        => ['rabbitmq-server'],
+      'sqlite3'     => ['sqlite3'],
+      'carrierwave' => ['convert']
+    }
+
+    def initialize(io)
+      self.io = io
+    end
+
+    def perform_checks
+      dependency_states.each do |name, command_states|
+        io.puts " * Gem '#{name}' will need:"
+        command_states.each do |cmd, state|
+          io.puts "   #{cmd}: #{human_state(state)}"
+        end
+      end
+    end
+
+    private
+
+    def command_running?(cmd)
+      %x[ps acux | grep '#{grepable_command(cmd.clone)}'].class
+      $?.exitstatus == 0
+    end
+
+    def command_installed?(cmd)
+      %x[which #{cmd}]
+      $?.exitstatus == 0
+    end
+
+    def dependency_states
+      @dependency_states ||= begin
+        data = {}
+        EXTERNAL_DEPENDENCIES.each do |name, commands|
+          if bundled_gems.include?(name)
+            data[name] = gem_dependency_state(name, commands)
+          end
+        end
+        data
+      end
+    end
+
+    def gem_dependency_state(name, commands)
+      commands.reduce({}) { |memo, cmd| memo[cmd] = command_state(cmd); memo }
+    end
+
+    def command_state(cmd)
+      if command_installed?(cmd)
+        command_running?(cmd) ? :ok : :not_running
+      else
+        :not_installed
+      end
+    end
+
+    def grepable_command(cmd)
+      cmd.insert(0, '[').insert(2, ']')
+    end
+
+    def bundled_gems
+      @bundled_gems = Bundler.definition.dependencies.map { |dep| dep.name }
+    end
+
+    def human_state(state)
+      case state
+      when :not_installed
+        io.colorize(:alert, 'not installed')
+        io.colorize(:help, " Hint: The command might not be in the PATH")
+      when :not_running
+        io.colorize(:alert, 'not running')
+      when :ok
+        io.colorize(:notice, 'OK')
+      end
+    end
+
+  end
+end

data/lib/checkit/styled_io.rb

@@ -0,0 +1,28 @@
+require 'ansi'
+require 'delegate'
+
+module CheckIt
+  class StyledIO < ::SimpleDelegator
+    def colorize(type, text)
+      color = case type
+      when :alert, :error
+        :red
+      when :notice, :ok
+        :green
+      when :help, :warning
+        :yellow
+      else
+        :white
+      end
+      ANSI.color(color) { text }
+    end
+
+    def print_header(txt)
+      self.puts
+      self.puts '+' + '-' * 78 + '+'
+      self.puts '| ' + txt.ljust(76) + ' |'
+      self.puts '+' + '-' * 78 + '+'
+      self.puts
+    end
+  end
+end

data/lib/checkit/version.rb

@@ -0,0 +1,3 @@
+module CheckIt
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: checkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maximilian Schulz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A little tool to check the your ruby project dependencies
+email:
+- m.schulz@kulturfluss.de
+executables:
+- checkit
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/checkit
+- checkit.gemspec
+- lib/checkit.rb
+- lib/checkit/config_files.rb
+- lib/checkit/core.rb
+- lib/checkit/services.rb
+- lib/checkit/styled_io.rb
+- lib/checkit/version.rb
+homepage: https://github.com/railslove/checkit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem provides an executable which checks common project dependencies.
+  It checks if the bundle is installed, all servers are running and if your config
+  files are in place.
+test_files: []
+has_rdoc: