temporaries 0.0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.0.1 2011-03-29
+
+ * Hi.

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) George Ogata
+
+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,102 @@
+# Temporaries
+
+Set things temporarily and declaratively. Best way to test.
+
+ * Set values of constants.
+ * Set values of attributes.
+ * Set values of hash keys.
+ * Set values of instance variables.
+ * Set values of class variables.
+ * Set values of globals.
+ * Set a temporary directory.
+
+Do it for the length of a test, or within a specific block in your
+code. Nest them arbitrarily; the innermost one applies.
+
+## How
+
+### In RSpec
+
+    describe MyClass do
+      # Mylib.foo will be 5 within these examples.
+      use_temporary_attribute_value MyLib, :foo, 5
+
+      describe MyClass do
+        # In this nested example group, it will be 7.
+        use_temporary_attribute_value MyLib, :foo, 7
+      end
+    end
+
+Here's the full list of methods you can use:
+
+    use_temporary_hash_value(hash, key, value)
+    use_temporary_constant_value(module, :constant, value)
+    use_temporary_attribute_value(object, :attribute, value)
+    use_temporary_instance_variable_value(object, :name, value)
+    use_temporary_class_variable_value(object, :name, value)
+    use_temporary_global_value(:name, value)
+
+Sigils in the `name` are unnecessary in the last 3 (unlike
+`instance_variable_get`, for instance).
+
+### In Test::Unit
+
+    class MyTest < Test::Unit::TestCase
+      use_temporary_attribute_value MyLib, :foo, 5
+    end
+
+## Digging Deeper
+
+You may also set the temporary for the duration of a particular block:
+
+    with_hash_value hash, key, value do
+      ...
+    end
+
+    with_constant_value module, :constant, value do
+      ...
+    end
+
+    with_attribute_value object, :attribute, value do
+      ...
+    end
+
+    with_instance_variable_value object, :name, value do
+      ...
+    end
+
+    with_class_variable_value object, :name, value do
+      ...
+    end
+
+    with_global_value :name, value do
+      ...
+    end
+
+    with_temporary_directory path do
+      # `tmp' refers to the directory.
+    end
+
+Or push and pop temporary values onto the stack yourself:
+
+    push_hash_value hash, key, value
+    pop_hash_value hash, key
+
+    push_constant_value module, :constant, value
+    pop_constant_value module, :constant
+
+    # etc.
+
+Keep 'em balanced, maestro.
+
+## Contributing
+
+ * [Source](https://github.com/oggy/temporaries)
+ * [Bug reports](https://github.com/oggy/temporaries/issues)
+ * Patches: Fork on Github, send pull request.
+   * Include tests where practical.
+   * Leave the version alone, or bump it in a separate commit.
+
+## Copyright
+
+Copyright (c) George Ogata. See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'ritual'

data/features/rspec_integration.feature

@@ -0,0 +1,25 @@
+Feature: Rspec Integration
+
+  As a developer using RSpec
+  I want to define temporary values
+  So I can run my tests in isolation
+
+  Scenario: Using temporary values with RSpec
+  Given I have a file "rspec.rb" containing:
+    """
+    require 'temporaries'
+
+    module Mod
+      X = 2
+    end
+
+    describe Mod do
+      use_constant_value Mod, :X, 5
+
+      it "should have X = 5 inside each example" do
+        Mod::X.should == 5
+      end
+    end
+    """
+  When I run "rspec rspec.rb"
+  Then I should see "1 example, 0 failures"

data/features/step_definitions/command_steps.rb

@@ -0,0 +1,14 @@
+Given /^I have a file "(.*?)" containing:$/ do |path, content|
+  open(path, 'w') do |file|
+    file.puts "$:.unshift '#{LIB}'"
+    file.print content
+  end
+end
+
+When /^I run "(.*?)"$/ do |command|
+  @output = `bundle exec #{command} 2>&1`
+end
+
+Then /^I should see "(.*?)"$/ do |expected|
+  @output.should include(expected)
+end

data/features/support/env.rb

@@ -0,0 +1,24 @@
+ROOT = File.expand_path('../..', File.dirname(__FILE__))
+$:.unshift File.expand_path('../../lib', File.dirname(__FILE__))
+ENV['BUNDLE_GEMFILE'] = "#{ROOT}/Gemfile"
+
+$TEMPORARIES_TEST = true
+require 'temporaries'
+require 'fileutils'
+require 'rspec/expectations'
+
+TMP = File.expand_path(File.dirname(__FILE__) + '/../tmp')
+LIB = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+original_pwd = nil
+
+Before do
+  FileUtils.mkdir_p TMP
+  original_pwd = Dir.pwd
+  Dir.chdir TMP
+end
+
+After do
+  Dir.chdir original_pwd
+  FileUtils.rm_rf TMP
+end

data/features/test_unit_integration.feature

@@ -0,0 +1,26 @@
+Feature: Test::Unit Integration
+
+  As a developer using Test::Unit
+  I want to define temporary values
+  So I can run my tests in isolation
+
+  Scenario: Using temporary values with Test::Unit
+  Given I have a file "test_unit.rb" containing:
+    """
+    require 'test/unit'
+    require 'temporaries'
+
+    module Mod
+      X = 2
+    end
+
+    class MyTest < Test::Unit::TestCase
+      use_constant_value Mod, :X, 5
+
+      def test_should_have_x_set_to_5_in_each_test
+        assert_equal 5, Mod::X
+      end
+    end
+    """
+  When I run "ruby test_unit.rb"
+  Then I should see "1 tests, 1 assertions, 0 failures, 0 errors"

data/lib/temporaries/adapters/base.rb

@@ -0,0 +1,19 @@
+module Temporaries
+  module Adapters
+    class Base
+      def initialize(context)
+        @context = context
+      end
+
+      attr_reader :context
+
+      def before
+        raise NotImplementedError, 'abstract'
+      end
+
+      def after
+        raise NotImplementedError, 'abstract'
+      end
+    end
+  end
+end

data/lib/temporaries/adapters/rspec.rb

@@ -0,0 +1,27 @@
+module Temporaries
+  module Adapters
+    class RSpec < Base
+      def self.install
+        ::RSpec.configure do |config|
+          config.extend Extension
+          config.include Values
+          config.include Directory
+        end
+      end
+
+      def before(&block)
+        context.before(&block)
+      end
+
+      def after(&block)
+        context.after(&block)
+      end
+
+      module Extension
+        def temporaries_adapter
+          RSpec.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/temporaries/adapters/test_unit.rb

@@ -0,0 +1,56 @@
+module Temporaries
+  module Adapters
+    class TestUnit < Base
+      def self.install
+        Test::Unit::TestCase.class_eval do
+          extend Extension
+          include Values
+          include Directory
+        end
+      end
+
+      def before(&block)
+        context.send(:include, self.module)
+        context.befores << block
+      end
+
+      def after(&block)
+        context.send(:include, self.module)
+        context.afters << block
+      end
+
+      def module
+        @module ||= Module.new do
+          def self.included(base)
+            base.extend self::ClassMethods
+          end
+
+          mod = Module.new do
+            def befores
+              @befores ||= []
+            end
+
+            def afters
+              @afters ||= []
+            end
+          end
+          const_set(:ClassMethods, mod)
+
+          def setup
+            self.class.befores.each{|proc| instance_eval(&proc)}
+          end
+
+          def teardown
+            self.class.afters.each{|proc| instance_eval(&proc)}
+          end
+        end
+      end
+
+      module Extension
+        def temporaries_adapter
+          TestUnit.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/temporaries/adapters.rb

@@ -0,0 +1,7 @@
+module Temporaries
+  module Adapters
+    autoload :Base, 'temporaries/adapters/base'
+    autoload :RSpec, 'temporaries/adapters/rspec'
+    autoload :TestUnit, 'temporaries/adapters/test_unit'
+  end
+end

data/lib/temporaries/core.rb

@@ -0,0 +1,21 @@
+module Temporaries
+  module Core
+    protected
+
+    def push_temporary(key, value)
+      temporaries[key].push(value)
+    end
+
+    def pop_temporary(key)
+      temporaries[key].pop
+    end
+
+    def top_temporary(key)
+      temporaries[key].last
+    end
+
+    def temporaries
+      @temporaries ||= Hash.new{|h,k| h[k] = []}
+    end
+  end
+end

data/lib/temporaries/directory.rb

@@ -0,0 +1,48 @@
+require 'fileutils'
+
+module Temporaries
+  module Directory
+    include Core
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def use_temporary_directory(directory)
+        temporaries_adapter.before do
+          push_temporary_directory(directory)
+        end
+
+        temporaries_adapter.after do
+          pop_temporary_directory
+        end
+      end
+    end
+
+    def push_temporary_directory(directory)
+      exists = File.exist?(directory)
+      push_temporary(:directory, [directory, exists])
+      FileUtils.mkdir_p directory unless exists
+    end
+
+    def pop_temporary_directory
+      directory, existed = pop_temporary(:directory)
+      FileUtils.rm_rf directory unless existed
+    end
+
+    def with_temporary_directory(directory)
+      push_temporary_directory(directory)
+      begin
+        yield
+      ensure
+        pop_temporary_directory
+      end
+    end
+
+    def tmp
+      top = top_temporary(:directory) and
+        top.first
+    end
+  end
+end

data/lib/temporaries/values.rb

@@ -0,0 +1,198 @@
+#
+# Set temporary values for the duration of a block. These may be
+# arbitrarily nested; the innermost definition applies.
+#
+#     with_hash_value hash, key, value do
+#       ...
+#     end
+#
+#     with_constant_value module, :constant, value do
+#       ...
+#     end
+#
+#     with_attribute_value object, :attribute, value do
+#       ...
+#     end
+#
+#     with_instance_variable_value object, :name, value do
+#       ...
+#     end
+#
+#     with_class_variable_value object, :name, value do
+#       ...
+#     end
+#
+#     with_global_value :name, value do
+#       ...
+#     end
+#
+# There are also the lower level:
+#
+#     push_hash_value hash, key, value
+#     pop_hash_value hash, key
+#
+#     push_constant_value Module, :Constant, value
+#     pop_constant_value Module, :Constant
+#
+#     push_attribute_value object, :attribute, value
+#     pop_attribute_value object :attribute
+#
+#     push_instance_variable_value object, :name, value
+#     pop_instance_variable_value object :name
+#
+#     push_class_variable_value klass, :name, value
+#     pop_class_variable_value klass, :name
+#
+#     push_global_variable_value :name, value
+#     pop_global_variable_value :name
+#
+module Temporaries
+  module Values
+    include Core
+
+    UNDEFINED = RUBY_VERSION < '1.9' ? Object.new : BasicObject.new
+    class << UNDEFINED
+      def inspect
+        '<UNDEFINED>'
+      end
+      alias to_s inspect
+    end
+
+    class Helpers
+      def initialize(name)
+        @name = name
+      end
+      attr_reader :name
+
+      def signature(signature = nil)
+        if signature
+          @signature = signature
+        else
+          @signature
+        end
+      end
+
+      [:exists, :get, :set, :remove].each do |name|
+        attr_reader name
+        class_eval <<-EOS
+          def #{name}(source=nil)
+            if source
+              @#{name} = '(' + source + ')'
+            else
+              @#{name}
+            end
+          end
+        EOS
+      end
+
+      def stack_key
+        sig_ids = signature.split(/\s*,\s*/).map{|s| s + '.__id__'}.join(', ')
+        "[:#{name}, #{sig_ids}]"
+      end
+
+      def define(mod)
+        if exists
+          save = "original_value = #{exists} ? #{get} : Temporaries::Values::UNDEFINED"
+          restore = "value == Temporaries::Values::UNDEFINED ? #{remove} : #{set}"
+        else
+          save = "original_value = #{get}"
+          restore = set
+        end
+
+        mod.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def push_#{name}_value(#{signature}, value)
+            #{save}
+            push_temporary(#{stack_key}, original_value)
+            #{set}
+          end
+
+          def pop_#{name}_value(#{signature})
+            value = pop_temporary(#{stack_key})
+            #{restore}
+          end
+
+          def with_#{name}_value(#{signature}, value)
+            push_#{name}_value(#{signature}, value)
+            begin
+              yield
+            ensure
+              pop_#{name}_value(#{signature})
+            end
+          end
+        EOS
+
+        mod::ClassMethods.module_eval <<-EOS, __FILE__, __LINE__ + 1
+          def use_#{name}_value(#{signature}, value)
+            temporaries_adapter.before do
+              push_#{name}_value(#{signature}, value)
+            end
+
+            temporaries_adapter.after do
+              pop_#{name}_value(#{signature})
+            end
+          end
+        EOS
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+    end
+
+    def self.define_helpers_for(name, &block)
+      helpers = Helpers.new(name)
+      helpers.instance_eval(&block)
+      helpers.define(self)
+    end
+
+    define_helpers_for :constant do
+      signature 'mod, constant'
+      exists 'mod.const_defined?(constant)'
+      get 'mod.const_get(constant)'
+      set <<-EOS
+        mod.instance_eval{remove_const(constant) if const_defined?(constant)
+        const_set(constant, value)}
+      EOS
+      remove 'mod.send :remove_const, constant'
+    end
+
+    define_helpers_for :attribute do
+      signature 'object, attribute'
+      get 'object.send(attribute)'
+      set 'object.send("#{attribute}=", value)'
+    end
+
+    define_helpers_for :hash do
+      signature 'hash, key'
+      exists 'hash.key?(key)'
+      get 'hash[key]'
+      set 'hash[key] = value'
+      remove 'hash.delete(key)'
+    end
+
+    define_helpers_for :instance_variable do
+      signature 'object, name'
+      exists 'object.instance_variable_defined?("@#{name}")'
+      get 'object.instance_variable_get "@#{name}"'
+      set 'object.instance_variable_set "@#{name}", value'
+      remove 'object.send :remove_instance_variable, "@#{name}"'
+    end
+
+    define_helpers_for :class_variable do
+      signature 'klass, name'
+      exists 'klass.class_variable_defined?("@@#{name}")'
+      get 'klass.send :class_variable_get, "@@#{name}"'
+      set 'klass.send :class_variable_set, "@@#{name}", value'
+      remove 'klass.send :remove_class_variable, "@@#{name}"'
+    end
+
+    define_helpers_for :global do
+      signature 'name'
+      get 'eval("$#{name}")'
+      set 'eval("$#{name} = value")'
+    end
+  end
+end

data/lib/temporaries/version.rb

@@ -0,0 +1,11 @@
+module Temporaries
+  VERSION = [0, 0, 1]
+
+  class << VERSION
+    include Comparable
+
+    def to_s
+      join('.')
+    end
+  end
+end

data/lib/temporaries.rb

@@ -0,0 +1,14 @@
+module Temporaries
+  autoload :Core, 'temporaries/core'
+  autoload :Values, 'temporaries/values'
+  autoload :Directory, 'temporaries/directory'
+  autoload :Adapters, 'temporaries/adapters'
+end
+
+if defined?($TEMPORARIES_TEST)
+  # Testing this library. Don't install anything.
+elsif defined?(RSpec)
+  Temporaries::Adapters::RSpec.install
+elsif defined?(Test::Unit)
+  Temporaries::Adapters::TestUnit.install
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$TEMPORARIES_TEST = true
+require 'temporaries'
+require 'support/test_context'
+
+TMP = File.dirname(__FILE__) + '/tmp'

data/spec/support/test_context.rb

@@ -0,0 +1,46 @@
+#
+# Represents a group of tests, such as a subclass of Test::Unit or
+# Spec::Example::ExampleGroup.
+#
+class TestContext
+  class << self
+    def temporaries_adapter
+      @temporaries_adapter ||= Adapter.new(self)
+    end
+
+    def before(&block)
+      befores << block
+    end
+
+    def after(&block)
+      afters << block
+    end
+
+    def befores
+      @befores ||= []
+    end
+
+    def afters
+      @afters ||= []
+    end
+  end
+
+  def run
+    self.class.befores.each{|proc| instance_eval(&proc)}
+    begin
+      yield
+    ensure
+      self.class.afters.each{|proc| instance_eval(&proc)}
+    end
+  end
+
+  class Adapter < Temporaries::Adapters::Base
+    def before(&block)
+      context.before(&block)
+    end
+
+    def after(&block)
+      context.after(&block)
+    end
+  end
+end