chekku 0.0.3 → 0.0.4

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+branches:
+  only:
+    - master

data/README.md

@@ -1,5 +1,4 @@
-# Chekku
-
+# Chekku [![Build Status](https://secure.travis-ci.org/ys/chekku.png)](http://travis-ci.org/ys/chekku)
 The gem that checks your software dependencies
 
 ## WARNING
@@ -23,24 +22,44 @@ Or install it yourself as:
 ## Usage
 
 ```
-  $ chekku checks       # Check your software dependencies
+  $ chekku checks       # Check your software dependencies (default task)
   $ chekku help [TASK]  # Describe available tasks or one specific task
 ```
 
 ## Chekkufile
 
 This is the file that contains the dependencies we need to check
-For the moment only the name is executable is validated
 
 Chekkufile :
 
 ```ruby
  check 'mysql', '>= 5.0', env: :production
- check 'redis-server'
+ check 'redis'
  check 'mongod', '~> 1.0', env: :development, must_run: true
 ```
 
-**As you can see, you have to set the executable name for the moment, I'm trying to find an easy way to check for software which executables aren't name as the project (see imagemagick)**
+## def.yml
+
+This file is in an hidden folder of your home and should contain information about how to check the existance, versions,... of a dependency
+
+~/.chekku/def.yml :
+
+```
+mysql:
+  executable: 'mysqld'
+redis:
+  executable: 'redis-server'
+imagemagick:
+  executable: 'convert'
+```
+
+** I'm currently working on a webapp to define online all the values for this file. So it will be community based. **
+
+## Future
+
+I'll try to have a version that works for checking the version of the dependecy in the near future.
+And will add tests to check if the service is running or not.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--color', '--format doc', '--order rand']
+end
+
+task :default => :spec

data/chekku.gemspec

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+#encoding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'chekku/version'
@@ -8,17 +8,14 @@ Gem::Specification.new do |gem|
   gem.version       = Chekku::VERSION
   gem.authors       = ['Yannick Schutz']
   gem.email         = ['yannick.schutz@gmail.com']
-  gem.description   = %q{Chekku checks all your software dependencies in every environment. It will helps you installing them too.}
+  gem.description   = %q{Chekku checks all your software dependencies from development to production.}
   gem.summary       = %q{Chekku: software dependencies checker}
   gem.homepage      = 'http://ys.github.com/chekku'
-
   gem.required_ruby_version     = '>= 1.9'
   gem.required_rubygems_version = '>= 1.3.6'
-
   gem.add_development_dependency 'rspec', '>= 2.0'
-
   gem.add_dependency 'thor'
-
+  gem.add_dependency 'rake'
   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)/})

data/examples/Chekkufile

@@ -0,0 +1,3 @@
+check 'mysql'
+check 'redis'
+check 'imagemagick'

data/examples/def.yml

@@ -0,0 +1,8 @@
+mysql:
+  executable: 'mysqld'
+postgres:
+  executable: 'postgres'
+redis:
+  executable: 'redis-server'
+imagemagick:
+  executable: 'convert'

data/lib/chekku.rb

@@ -1,6 +1,7 @@
-require "chekku/version"
+require 'chekku/version'
 require 'thor'
 require 'thor/group'
+require 'chekku/errors'
 
 module Chekku
   class Command

data/lib/chekku/checker.rb

@@ -1,5 +1,6 @@
 require 'pathname'
 require_relative 'dsl'
+require_relative 'definitions_service'
 
 class Chekku::Checker < Thor
   include Thor::Actions
@@ -23,9 +24,9 @@ class Chekku::Checker < Thor
   end
 
   def verify_chekku_file_existence
-      chekkufile = Pathname.new(@chekkufile).expand_path
+    chekkufile = Pathname.new(@chekkufile).expand_path
 
-      unless chekkufile.file?
+    unless chekkufile.file?
       say "#{chekkufile} not found"
       exit -1
     end

data/lib/chekku/definitions_service.rb

@@ -0,0 +1,15 @@
+require_relative 'fetcher'
+
+class Chekku::DefinitionsService
+
+  attr_accessor :definitions, :chekkufile
+
+  def load_definitions_for(file)
+    @chekkufile = file
+    @definitions = Chekku::Fetcher.fetch_for_chekkufile file
+  end
+
+  def definition_for(dependency)
+    @definitions[dependency] if @definitions
+  end
+end

data/lib/chekku/dependency_checker.rb

@@ -0,0 +1,51 @@
+#encoding: utf-8
+class Chekku::DependencyChecker
+
+  attr_accessor :definitions_service
+  attr_accessor :definition
+
+  def self.with(definitions_service)
+    new definitions_service
+  end
+
+  def initialize(definitions_service)
+    @definitions_service = definitions_service
+  end
+
+  def chekku(name, version, args)
+    definition = get_and_check_definition! name
+    if exists? definition
+      "Checked #{name} [\033[32m✓\033[0m]"
+    else
+      "Checked #{name} [\033[31m✗\033[0m] I think you must install it!"
+    end
+  end
+
+  def get_and_check_definition!(name)
+    @definitions_service.definition_for(name) ||
+      raise(DefinitionNotFoundError, "#{name} definition not be found. Check ~/.chekku/def.yml")
+  end
+
+  def exists?(definition)
+    command = definition['executable']
+    verify_command!(command) && found?(command)
+  end
+
+  def verify_command!(command)
+    raise AppNameNotStringError, 'You need to use strings for app names' unless command.is_a?(String)
+    raise AppNameNotSaneError, "Sorry the app name '#{@current_app}' is not sane" unless sane?(command)
+    true
+  end
+
+  def found?(command)
+    system("which #{command} > /dev/null")
+  end
+
+  def sane?(command)
+    command == sanitize(command)
+  end
+
+  def sanitize(command)
+    command.gsub(/&|"|'|;|\s/, "")
+  end
+end

data/lib/chekku/dsl.rb

@@ -1,16 +1,28 @@
-require_relative 'generic_checker.rb'
-class Chekku::Dsl < Thor::Group
+require_relative 'dependency_checker'
+
+class Chekku::Dsl
+
+  attr_accessor :definitions_service
+
   def self.evaluate(file)
-    builder = new
-    builder.eval_chekkufile(file)
+    new.eval_chekkufile(file)
+  end
+
+  def initialize
+    @definitions_service = Chekku::DefinitionsService.new
+    @definitions_service.load_definitions_for @chekkufile
   end
 
   def eval_chekkufile(file)
     instance_eval(read_file(file))
+  rescue NoMethodError => e
+    puts "\033[31mERROR: Please verify the syntax of your Chekkufile"
   end
 
   def check(name, version = nil, args ={})
-    say Chekku::GenericChecker.new(name, version, args).chekku!
+    puts Chekku::DependencyChecker.with(@definitions_service).chekku(name, version, args)
+  rescue DefinitionsError => e
+    puts "\033[31mERROR: #{e.message}\033[0m\n"
   end
 
   def read_file(file)

data/lib/chekku/errors.rb

@@ -0,0 +1,4 @@
+class DefinitionsError < StandardError; end
+class AppNameNotSaneError < DefinitionsError; end
+class AppNameNotStringError < DefinitionsError; end
+class DefinitionNotFoundError < DefinitionsError; end

data/lib/chekku/fetcher.rb

@@ -0,0 +1,20 @@
+#encoding: utf-8
+require 'yaml'
+
+class Chekku::Fetcher
+
+  CHEKKU_PATH = "#{ENV['HOME']}/.chekku"
+
+  attr_accessor :dependencies
+
+  def self.fetch_for_chekkufile(file)
+    # TODO: Implements server side of the file checker
+    # STUB: Load local file
+    fetcher = new
+    fetcher.dependencies_from_file
+  end
+
+  def dependencies_from_file
+    @dependencies = YAML.load_file("#{CHEKKU_PATH}/def.yml")
+  end
+end

data/lib/chekku/version.rb

@@ -1,3 +1,3 @@
 module Chekku
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/lib/definitions_service_spec.rb

@@ -0,0 +1,49 @@
+require 'chekku/definitions_service'
+require 'chekku/errors'
+
+describe Chekku::DefinitionsService do
+
+  describe '#load_definitions_for' do
+    let(:definitions_service) { Chekku::DefinitionsService.new }
+    let(:definitions) { { 'mysql' => { 'existance' => 'which mysqld' }} }
+
+    it 'should set definitions' do
+      Chekku::Fetcher.stub(:fetch_for_chekkufile).with('blabla').and_return(definitions)
+      expect { definitions_service.load_definitions_for('blabla') }
+        .to change(definitions_service, :definitions).from(nil).to(definitions)
+    end
+  end
+
+  describe '#definition_for' do
+    let(:definitions) { { 'mysql' => { 'existance' => 'which mysqld' }} }
+
+    context 'definitions are set' do
+      let(:definitions_service) { Chekku::DefinitionsService.new }
+      before(:each) do
+        definitions_service.definitions = definitions
+      end
+
+      context 'existing definition' do
+        it 'should return the definition of the asked element' do
+          definitions_service.definition_for('mysql').should == definitions['mysql']
+        end
+      end
+
+      context 'missing definition' do
+        it 'should return nil' do
+          definitions_service.definition_for('not-existing').should == nil
+        end
+      end
+    end
+
+    context 'definitions are not set' do
+      let(:definitions_service) { Chekku::DefinitionsService.new }
+      it 'should return nil' do
+        definitions_service.definition_for('not-existing').should == nil
+      end
+    end
+
+  end
+
+end
+

data/spec/lib/dependency_checker_spec.rb

@@ -0,0 +1,129 @@
+#encoding: utf-8
+require 'chekku/dependency_checker'
+require 'chekku/definitions_service'
+require 'chekku/errors'
+
+describe Chekku::DependencyChecker do
+
+
+  describe "#with" do
+    let(:definitions_service) { double(Chekku::DefinitionsService) }
+    let(:subject) { Chekku::DependencyChecker.with(definitions_service) }
+    it { should be_instance_of(Chekku::DependencyChecker) }
+    its(:definitions_service) { should == definitions_service }
+  end
+
+  describe 'instance methods' do
+    let(:checker) { Chekku::DependencyChecker.with(Chekku::DefinitionsService.new) }
+
+    describe ".sanitize" do
+      it "should not change a sane command" do
+        checker.sanitize("hello_you").should == "hello_you"
+      end
+
+      context "not sane commands" do
+        it "should remove &" do
+          checker.sanitize("hello&world").should == "helloworld"
+        end
+
+        it "should remove \"" do
+          checker.sanitize("hello\"world").should == "helloworld"
+        end
+
+        it "should remove '" do
+          checker.sanitize("hello'world").should == "helloworld"
+        end
+
+        it "should remove ;" do
+          checker.sanitize("hello;world").should == "helloworld"
+        end
+        it "should remove \s" do
+          checker.sanitize("hello world").should == "helloworld"
+        end
+      end
+    end
+
+    describe '.sane?' do
+      it "should be true with sane command" do
+        checker.sane?('ls').should be_true
+      end
+
+      it "should be false with not sane command" do
+        checker.sane?('ls & rm  ').should be_false
+      end
+    end
+
+    describe '.verify_command!' do
+      it 'should be ok with a sane string' do
+        checker.verify_command!('ls').should be_true
+      end
+
+      it 'should raise an error with symbol' do
+        expect { checker.verify_command!(:ls) }.to raise_error(AppNameNotStringError)
+      end
+
+      it 'should raise an error with not sane command' do
+        expect { checker.verify_command!('rm&') }.to raise_error(AppNameNotSaneError)
+      end
+    end
+
+    describe '.found?' do
+      it 'should be true for an existing command' do
+        checker.found?('ls').should be_true
+      end
+
+      it 'should be false for an existing command' do
+        checker.found?('lsrm').should be_false
+      end
+    end
+
+    describe '.exists?' do
+      let(:definition) { { 'executable' => 'mysql' } }
+      it 'should be true if command is valid and found' do
+        checker.stub(:verify_command!).with('mysql').and_return(true)
+        checker.stub(:found?).with('mysql').and_return(true)
+        checker.exists?(definition).should be_true
+      end
+
+      it 'should be false if command is invalid' do
+        checker.stub(:verify_command!).with('mysql').and_return(false)
+        checker.stub(:found?).with('mysql').and_return(true)
+        checker.exists?(definition).should be_false
+      end
+
+      it 'should be false if command is not found' do
+        checker.stub(:verify_command!).with('mysql').and_return(true)
+        checker.stub(:found?).with('mysql').and_return(false)
+        checker.exists?(definition).should be_false
+      end
+    end
+
+    describe '.get_and_check_definition' do
+      let(:definition) { { 'executable' => 'mysql' } }
+      it 'should return a hash with the definition' do
+        checker.definitions_service.stub(:definition_for).with('mysql').and_return(definition)
+        checker.get_and_check_definition!('mysql').should == definition
+      end
+
+      it 'should raise an error if not found' do
+        checker.definitions_service.stub(:definition_for).with('mysql').and_return(nil)
+        expect{ checker.get_and_check_definition!('mysql') }.to raise_error(DefinitionNotFoundError)
+      end
+    end
+
+    describe '.chekku' do
+      let(:definition) { { 'executable' => 'mysql' } }
+      it 'should if definition exists says ✓' do
+        checker.stub(:get_and_check_definition!).with('mysql').and_return(definition)
+        checker.stub(:exists?).with(definition).and_return(true)
+        checker.chekku('mysql', nil, nil).should == "Checked mysql [\033[32m✓\033[0m]"
+      end
+      it 'should if definition exists says x' do
+        checker.stub(:get_and_check_definition!).with('mysql').and_return(definition)
+        checker.stub(:exists?).with(definition).and_return(false)
+        checker.chekku('mysql', nil, nil).should == "Checked mysql [\033[31m✗\033[0m] I think you must install it!"
+      end
+    end
+
+  end
+end

data/spec/lib/dsl_spec.rb

@@ -0,0 +1,6 @@
+require 'chekku/dsl'
+
+describe Chekku::Dsl do
+  it 'should works' do
+  end
+end

data/spec/lib/fetcher_spec.rb

@@ -0,0 +1,26 @@
+require 'chekku/fetcher'
+
+describe Chekku::Fetcher do
+
+  describe ".dependencies_for_file" do
+    let(:fetcher) { Chekku::Fetcher.new() }
+    it 'should call YAML.load_file' do
+      YAML.should_receive(:load_file).with("#{ENV['HOME']}/.chekku/def.yml")
+      fetcher.dependencies_from_file
+    end
+
+    it 'should return an object with methods corresponding to dependencies' do
+      dependencies_hash = { 'mysql' => { 'existance' => 'which mysqld' }}
+      YAML.stub(:load_file).and_return(dependencies_hash)
+      fetcher.dependencies_from_file['mysql'].should == { 'existance' =>'which mysqld'}
+    end
+  end
+
+  describe '#fetch_for_chekkufile(file)' do
+    it 'should return an object with' do
+    end
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -2,7 +2,15 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'chekku'
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end
 
 RSpec.configure do |config|
-  # some (optional) config here
+  config.before :each do
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chekku
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-16 00:00:00.000000000 Z
+date: 2012-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,8 +43,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Chekku checks all your software dependencies in every environment. It
-  will helps you installing them too.
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Chekku checks all your software dependencies from development to production.
 email:
 - yannick.schutz@gmail.com
 executables:
@@ -53,18 +68,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/chekku
 - chekku.gemspec
+- examples/Chekkufile
+- examples/def.yml
 - lib/chekku.rb
 - lib/chekku/checker.rb
+- lib/chekku/definitions_service.rb
+- lib/chekku/dependency_checker.rb
 - lib/chekku/dsl.rb
-- lib/chekku/generic_checker.rb
+- lib/chekku/errors.rb
+- lib/chekku/fetcher.rb
 - lib/chekku/version.rb
-- spec/generic_checker_spec.rb
+- spec/lib/definitions_service_spec.rb
+- spec/lib/dependency_checker_spec.rb
+- spec/lib/dsl_spec.rb
+- spec/lib/fetcher_spec.rb
 - spec/spec_helper.rb
 homepage: http://ys.github.com/chekku
 licenses: []
@@ -91,5 +116,8 @@ signing_key:
 specification_version: 3
 summary: ! 'Chekku: software dependencies checker'
 test_files:
-- spec/generic_checker_spec.rb
+- spec/lib/definitions_service_spec.rb
+- spec/lib/dependency_checker_spec.rb
+- spec/lib/dsl_spec.rb
+- spec/lib/fetcher_spec.rb
 - spec/spec_helper.rb

data/lib/chekku/generic_checker.rb

@@ -1,24 +0,0 @@
-class Chekku::GenericChecker < Thor::Shell::Basic
-
-  def initialize(name, version = nil, args = {})
-    @name = sanitize name.to_s
-    @version = version
-    @args = args
-  end
-
-  def chekku!
-    if which_exists?
-      "\e[32m#{@name} exists!\e[0m"
-    else
-      "\e[31mI think you must install #{@name}\e[0m"
-    end
-  end
-
-  def which_exists?
-    system("which '#{@name}' > /dev/null")
-  end
-
-  def sanitize(name)
-    name.gsub(/&|"|'|;|\s/, "")
-  end
-end

data/spec/generic_checker_spec.rb

@@ -1,21 +0,0 @@
-require 'thor'
-require 'chekku/generic_checker'
-
-describe Chekku::GenericChecker do
-
-  context "The command exists" do
-    let(:valid_checker) { Chekku::GenericChecker.new('ls', nil, nil) }
-    it "should return a green string" do
-      valid_checker.chekku!.should == "\e[32mls exists!\e[0m"
-    end
-  end
-
-  context "The command does not exist" do
-    let(:invalid_checker) { Chekku::GenericChecker.new('lsdahpdahiofaiofhaoigfhoaugzza', nil, nil) }
-    it "should return a green string" do
-      invalid_checker.chekku!.should == "\e[31mI think you must install lsdahpdahiofaiofhaoigfhoaugzza\e[0m"
-    end
-  end
-
-
-end