alternator 0.0.2

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright 2011 Thibault Jouan. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+  * Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+  * Neither the name of the software nor the names of its contributors may be
+    used to endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+Alternator
+==========
+
+Alternator helps you alternating between alternatives, so that you can control
+wich files are executed by a program. It generates wrapper scripts to "stub"
+executed files.
+
+
+Usage
+-----
+
+If you want ruby19 to be run when `ruby` is called, execute alternator
+like this:
+
+    $ alternator wrap ruby ruby19
+
+The following shell script will be written in `~/bin/ruby`:
+
+    #!/usr/bin/env sh
+
+    exec ruby19 $@
+
+Then you prepend `~/bin` to your search path.
+
+
+Requirements
+------------
+
+* ruby
+* rubygems
+* env
+* sh (any POSIX shell should do it)
+
+
+Installation
+------------
+
+    $ gem install alternator
+
+
+FAQ
+---
+
+Q: Why?  
+A: I wanted to run various ruby code under various ruby interpreters
+   easily.
+
+Q: Why not using RVM?  
+A: First, the installation procedure don't look acceptable to me and as
+   far as I know RVM is not available in any package management system.
+   RVM requires that I change my shell configuration in such a way
+   that I never needed to do for any other software. RVM depends on bash
+   and I don't want to install a new shell on all my environments,
+   especially not bash. RVM is aimed at managing rubies, I wanted my
+   tool not to have this restriction.
+
+Q: Why not using rbenv?  
+A: I had great hope in rbenv, and I like the fact that it don't require
+   to modify the shell configuration. But all the other things I don't
+   like about RVM also apply to rbenv :-(
+
+
+Notes
+-----
+
+If you only want to alternate between different rubies, here is a light
+solution based on symlinks:
+<http://chris.mowforth.com/si-because-rvm-and-rbenv-are-overkill>

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/alternator.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '/lib')
+require 'alternator/version'
+
+Gem::Specification.new do |s|
+  s.name    = 'alternator'
+  s.version = Alternator::VERSION
+  s.summary = "alternator-#{Alternator::VERSION}"
+  s.description = <<-eoh.gsub(/^ +/, '')
+    Alternator generates alternative wrapper scripts; it helps you stubbing
+    executed files.
+  eoh
+
+  s.author  = 'Thibault Jouan'
+  s.email   = 'tj@a13.fr'
+
+  s.files       = `git ls-files`.split "\n"
+  s.test_files  = `git ls-files -- {test,features}/*`.split "\n"
+  s.executables = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+end

data/bin/alternator

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'alternator'
+
+cli = Alternator::CLI.new ARGV
+cli.run

data/features/steps/env_step.rb

@@ -0,0 +1,4 @@
+Given /^my home directory is the current working directory$/ do
+  # Use aruba temporary directory for $HOME.
+  ENV['HOME'] = '.'
+end

data/features/steps/wrapper_step.rb

@@ -0,0 +1,9 @@
+Then /^the file "([^"]*)" must be executable$/ do |file_path|
+  prep_for_fs_check do
+    File.executable?(file_path).should be_true
+  end
+end
+
+Then /^the file "([^"]*)" must contain exactly:$/ do |file_path, file_content|
+  Then %{the file "#{file_path}" should contain exactly:}, file_content
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/wrapper.feature

@@ -0,0 +1,19 @@
+Feature: Create a wrapper
+
+  So that I can control files executed by a program
+  As a user of the program
+  I want to create a wrapper in my search path
+
+  Scenario: Wrapper creation
+    Given my home directory is the current working directory
+    And a directory named "bin"
+    When I run `alternator wrap ruby ruby19`
+    Then the file "bin/ruby" must be executable
+    And the file "bin/ruby" must contain exactly:
+      """
+      #!/usr/bin/env sh
+
+      exec ruby19 $@
+
+      """
+    And the exit status should be 0

data/lib/alternator.rb

@@ -0,0 +1,3 @@
+require 'alternator/action'
+require 'alternator/actions/wrap'
+require 'alternator/cli'

data/lib/alternator/action.rb

@@ -0,0 +1,9 @@
+module Alternator
+  module Action
+    attr_accessor :arguments
+
+    def initialize(arguments)
+      @arguments = arguments
+    end
+  end
+end

data/lib/alternator/actions/wrap.rb

@@ -0,0 +1,29 @@
+module Alternator
+  module Actions
+    class Wrap
+      include Alternator::Action
+
+      def filename
+        @arguments.first
+      end
+
+      def file_path
+        "#{ENV['HOME']}/bin/#{filename}"
+      end
+
+      def target_binary
+        @arguments[1]
+      end
+
+      def execute
+        File.open file_path, 'w', 0700 do |f|
+          f.write <<-eoh
+#!/usr/bin/env sh
+
+exec #{target_binary} $@
+          eoh
+        end
+      end
+    end
+  end
+end

data/lib/alternator/cli.rb

@@ -0,0 +1,25 @@
+module Alternator
+  class CLI
+    attr_accessor :arguments, :action
+
+    def initialize(arguments)
+      @arguments = arguments
+    end
+
+    def action
+      @action ||= action_class_const.new action_arguments
+    end
+
+    def action_class_const
+      Alternator::Actions.const_get(arguments.first.capitalize)
+    end
+
+    def action_arguments
+      arguments.drop(1)
+    end
+
+    def run
+      action.execute
+    end
+  end
+end

data/lib/alternator/version.rb

@@ -0,0 +1,3 @@
+module Alternator
+  VERSION = '0.0.2'
+end

data/spec/action_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Alternator::Action do
+  before do
+    class Action
+      include Alternator::Action
+    end
+  end
+
+  let(:arguments) { ['some', 'arguments'] }
+  let(:action)    { Action.new arguments }
+
+  describe '#arguments' do
+    it 'return the arguments' do
+      action.arguments.must_equal arguments
+    end
+  end
+end

data/spec/actions/wrap_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'support/home_directory_helpers'
+
+describe Alternator::Actions::Wrap do
+  include HomeDirectoryHelpers
+
+  let(:arguments) { ['ruby', 'ruby19'] }
+  let(:action)    { Alternator::Actions::Wrap.new arguments }
+
+  it 'is an action' do
+    action.must_be_kind_of Alternator::Action
+  end
+
+  describe '#filename' do
+    it 'returns the first argument' do
+      action.filename.must_equal arguments.first
+    end
+  end
+
+  describe '#file_path' do
+    it 'returns the path to the wrapper script' do
+      action.file_path.must_equal "#{ENV['HOME']}/bin/#{action.filename}"
+    end
+  end
+
+  describe '#target_binary' do
+    it 'returns the second argument' do
+      action.target_binary.must_equal arguments[1]
+    end
+  end
+
+  describe '#execute' do
+    it 'writes the wrapper script content' do
+      with_fake_home_directory do
+        action.execute
+        File.read(action.file_path).must_equal <<-eoh
+#!/usr/bin/env sh
+
+exec ruby19 $@
+        eoh
+      end
+    end
+
+    it 'makes the wrapper script executable' do
+      with_fake_home_directory do
+        action.execute
+        File.executable?(action.file_path).must_equal true
+      end
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Alternator::CLI do
+  let(:arguments) { ['action', 'some', 'arguments'] }
+  let(:cli)       { Alternator::CLI.new arguments }
+
+  before do
+    module  Alternator
+      module Actions
+        class Action
+          include Alternator::Action
+        end
+      end
+    end
+  end
+
+  describe '#arguments' do
+    it 'returns all the arguments' do
+      cli.arguments.must_equal arguments
+    end
+  end
+
+  describe '#action' do
+    it 'returns the action instance' do
+      cli.action.must_be_instance_of Alternator::Actions::Action
+    end
+
+    it 'returns the action with action arguments assigned' do
+      cli.action.arguments.must_equal cli.action_arguments
+    end
+  end
+
+  describe '#action_class_const' do
+    it 'returns the action class const, named after the first argument' do
+      cli.action_class_const.must_equal Alternator::Actions::Action
+    end
+  end
+
+  describe '#action_arguments' do
+    it 'returns the action arguments' do
+      cli.action_arguments.must_equal arguments.drop(1)
+    end
+  end
+
+  describe '#run' do
+    it 'sends :execute to the action' do
+      action = MiniTest::Mock.new
+      action.expect :execute, nil
+      cli.action = action
+      cli.run
+      action.verify
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'alternator'
+
+class MiniTest::Spec < MiniTest::Unit::TestCase
+  class << self
+    alias :context  :describe
+  end
+end

data/spec/support/home_directory_helpers.rb

@@ -0,0 +1,18 @@
+require 'tmpdir'
+
+module HomeDirectoryHelpers
+  def with_fake_home_directory
+    Dir.mktmpdir do |tmp_directory|
+      real_home_directory = ENV['HOME']
+      ENV['HOME'] = tmp_directory
+      # FIXME: should not create the bin directory, write a feature for
+      # behavior when directory is missing.
+      Dir.mkdir("#{ENV['HOME']}/bin")
+      begin
+        yield
+      ensure
+        ENV['HOME'] = real_home_directory
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: alternator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Thibault Jouan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  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: minitest
+  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: rake
+  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: |
+  Alternator generates alternative wrapper scripts; it helps you stubbing
+  executed files.
+
+email: tj@a13.fr
+executables: 
+- alternator
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- alternator.gemspec
+- bin/alternator
+- features/steps/env_step.rb
+- features/steps/wrapper_step.rb
+- features/support/env.rb
+- features/wrapper.feature
+- lib/alternator.rb
+- lib/alternator/action.rb
+- lib/alternator/actions/wrap.rb
+- lib/alternator/cli.rb
+- lib/alternator/version.rb
+- spec/action_spec.rb
+- spec/actions/wrap_spec.rb
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/support/home_directory_helpers.rb
+homepage: 
+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.8.10
+signing_key: 
+specification_version: 3
+summary: alternator-0.0.2
+test_files: 
+- features/steps/env_step.rb
+- features/steps/wrapper_step.rb
+- features/support/env.rb
+- features/wrapper.feature