ensurable 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.DS_Store
+.yardoc
+/doc
+/coverage
+

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jesse Storimer
+
+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.markdown

@@ -0,0 +1,65 @@
+Ensurable
+=========
+
+FYI this is very alpha software, also it's not meant to be used in production. Actually it aborts in production so...
+
+Use Case
+-------
+
+With Bundler we now have a great way of defining our gem deps and ensuring that all devs/machines are using the same set of gems, same versions, and all.
+
+This gem attempts to do something similar for system deps (like development tools, software an app depends on, databases, etc.). 
+
+Usually this isn't really an issue because these kinds of tools aren't developed as quickly as rubygems are, however I have run into issues like this. If a coworker of mine is using Redis 1.x and I am using Redis 2.x we will see subtle differences in our output. This gem aims to make sure stuff like this can't happen.
+
+Installation
+-----------
+
+    gem i ensurable
+
+In your Gemfile:
+    
+    gem 'ensurable'
+
+If you're using Rails you'll want to include this in your application.rb before the `require 'rails/all'`. This makes sure that this gem gets executed as early as possible and is able to ensure things before your app cries that it needs Msyql or Redis or something.
+
+    # config/application.rb
+    require File.expand_path('../boot', __FILE__)
+
+    require 'ensurable/now'
+    require 'rails/all'
+
+Usage
+-----
+
+Ensurable provides a DSL for defining your apps system deps. Stick this in a file called `ensure.rb` in the root of your application.
+
+    # ensure.rb
+    installed 'git'
+    installed 'imagemagick'
+
+    running 'redis'
+
+The `installed` method ensures that the given program is installed locally on the system. The `running` method ensures that the given program is currently running on the local system.
+
+There's no magic here, ie. this gem doesn't try to guess what it means for a program to be installed or running. There is a class inside the gem for each of these deps that knows how to check these things.
+
+Currently git and redis are the only supported deps. More are planned as needed.
+
+Roadmap/TODO
+-------
+
+* Allow passing of version numbers when defining ensurables. eg. installed 'git', '> 1.7' 
+* Add another method to the Ensurable::#{program} API that lets users know how to install missing deps.
+* Nicer error message when there's a missing dep. The default exception raised text is ugly.
+
+Contributing
+-----------
+
+Just fork it and send a pull request.
+
+License
+------
+
+MIT
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+

data/ensurable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ensurable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ensurable"
+  s.version     = Ensurable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jesse Storimer"]
+  s.email       = ["jstorimer@gmail.com"]
+  s.homepage    = "http://github.com/jstorimer/ensurable"
+  s.summary     = %q{Kind of like Bundler, but for system deps, and a lot less features}
+  s.description = %q{Ensurable gives you a DSL for defining the system development dependencies of your app. It's kind of like Bundler, but for system deps, and does a lot less.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'yard'
+end

data/lib/ensurable.rb

@@ -0,0 +1,51 @@
+module Ensurable
+  class NotInstalled < StandardError; end
+  class NotRunning < StandardError; end
+
+  autoload :Git, 'ensurables/git'
+  autoload :Redis, 'ensurables/redis'
+
+  class << self
+
+    # Ensures that the given programs are installed/running.
+    #
+    # @param [File] optional file to read defining the ensurables
+    # @yield optional block to allow any ensurables to be required
+    def ensure(file = nil, &bloc)
+      abortables = []
+      abortables << (defined?(Rails) && Rails.respond_to?(:env) && Rails.env)
+      abortables << ENV['RAILS_ENV']
+      abortables << ENV['RACK_ENV']
+
+      abort('Ensurable is not meant for production use!') if abortables.any? {|a| a == 'production'}
+
+      if file
+        instance_eval file.read
+      else
+        instance_eval &bloc
+      end
+    end
+
+    # Ensures the the given program needs to be installed on the local system
+    #
+    # @param [String] prog the name of the program that should be installed. Requires that 
+    #   the constant Ensurable::program exists and follows that API.
+    # @raise [NotInstalled] raised when the given program is not installed on the local system
+    def installed(prog)
+      # Would be nice to have a nicer fail mechanism if the constant doesn't exist
+      klass = const_get(prog.capitalize)
+
+      raise NotInstalled.new("Looks like you don't have #{prog} installed.") unless klass.new.installed?
+    end
+
+    # Ensures that the given program is running on the local system
+    # @param [String] prog the name of the program that should be running. Requires that 
+    #   the constant Ensurable::program exists and follows that API.
+    # @raise [NotRunning] raised when the given program is not running on the local system
+    def running(prog)
+      klass = const_get(prog.capitalize)
+
+      raise NotRunning.new("Looks like you don't have #{prog} running.") unless klass.new.running?
+    end
+  end
+end

data/lib/ensurable/now.rb

@@ -0,0 +1,18 @@
+require 'ensurable'
+
+module Ensurable
+  module Now
+    def self.now!
+      dir = Dir.pwd
+      path = dir + '/ensure.rb'
+      if File.exist?(path)
+        Ensurable.ensure(File.new(path))
+      else
+        Dir.chdir('..')
+        now!
+      end
+    end
+  end
+end
+
+Ensurable::Now.now!

data/lib/ensurable/version.rb

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

data/lib/ensurables/git.rb

@@ -0,0 +1,11 @@
+require 'open3'
+
+module Ensurable
+  class Git
+    def installed?
+      Open3.popen3('git --version') { |stdin, stdout, stderr|
+        true if stderr.read.empty?
+      }
+    end
+  end
+end

data/lib/ensurables/redis.rb

@@ -0,0 +1,10 @@
+module Ensurable
+  class Redis
+    def running?
+      # this is probly pretty dumb, it greps the proc list for redis-server
+      # taking into account that the grep counts as one
+      num = `ps aux | grep redis-server | wc -l`.to_i
+      true if num > 1
+    end
+  end
+end

data/test/ensurable_test.rb

@@ -0,0 +1,85 @@
+require 'helper'
+
+class EnsurableTest < MiniTest::Unit::TestCase
+  def test_aborts_if_rails_env_is_production
+    Rails.env = 'production'
+
+    Ensurable.expects(:abort)
+    Ensurable.ensure {}
+
+    Rails.env = nil
+  end
+
+  def test_no_abort_if_rails_env_is_development
+    Rails.env = 'development'
+
+    Ensurable.expects(:abort).never
+    Ensurable.ensure {}
+  end
+
+  def test_abort_if_rails_env_var_is_production
+    ENV['RAILS_ENV'] = 'production'
+
+    Ensurable.expects(:abort)
+    Ensurable.ensure {}
+
+    ENV['RAILS_ENV'] = nil
+  end
+
+  def test_abort_if_rack_env_var_is_production
+    ENV['RACK_ENV'] = 'production'
+
+    Ensurable.expects(:abort)
+    Ensurable.ensure {}
+
+    ENV['RACK_ENV'] = nil
+  end
+
+  def test_ensure_with_git_installed
+    Ensurable::Git.any_instance.expects(:installed?).returns(true)
+
+    Ensurable.ensure do
+      installed 'git'
+    end
+  end
+
+  def test_ensure_without_git_installed
+    Ensurable::Git.any_instance.expects(:installed?).returns(false)
+
+    assert_raises(Ensurable::NotInstalled) {
+      Ensurable.ensure do
+        installed 'git'
+      end
+    }
+  end
+
+  def test_ensure_with_redis_running
+    Ensurable::Redis.any_instance.expects(:running?).returns(true)
+
+    Ensurable.ensure do
+      running 'redis'
+    end
+  end
+
+  def test_ensure_without_redis_running
+    Ensurable::Redis.any_instance.expects(:running?).returns(false)
+
+    assert_raises(Ensurable::NotRunning) {
+      Ensurable.ensure do
+        running 'redis'
+      end
+    }
+  end
+
+  def test_ensure_with_file_arg_passed
+    Ensurable::Git.any_instance.expects(:installed?).returns(true)
+
+    file = File.new('ensure.rb', 'w+')
+    file.puts "installed 'git'"
+    file.seek(0)
+
+    Ensurable.ensure(file)
+
+    File.delete(file.path)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'mocha'
+
+require File.dirname(__FILE__) + "/../lib/ensurable"
+
+module Rails
+  class << self
+    attr_accessor :env
+  end
+end
+
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: ensurable
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jesse Storimer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Ensurable gives you a DSL for defining the system development dependencies of your app. It's kind of like Bundler, but for system deps, and does a lot less.
+email: 
+- jstorimer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- ensurable.gemspec
+- lib/ensurable.rb
+- lib/ensurable/now.rb
+- lib/ensurable/version.rb
+- lib/ensurables/git.rb
+- lib/ensurables/redis.rb
+- test/ensurable_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/jstorimer/ensurable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Kind of like Bundler, but for system deps, and a lot less features
+test_files: 
+- test/ensurable_test.rb
+- test/helper.rb