at 0.1.4 → 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/
+doc/
+.yardoc/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@at

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    at (0.1.3)
-      version (~> 1.0.0)
+    at (0.1.4)
+      version (~> 1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
     coderay (1.0.8)
     diff-lcs (1.1.3)
     fuubar (1.1.0)
@@ -26,9 +28,11 @@ GEM
     guard-yard (2.0.1)
       guard (>= 1.1.0)
       yard (>= 0.7.0)
+    i18n (0.6.1)
     listen (0.6.0)
     lumberjack (1.0.2)
     method_source (0.8.1)
+    multi_json (1.6.1)
     pry (0.9.10)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -54,11 +58,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3)
+  activesupport (~> 3.2)
   at!
   fuubar (~> 1.1)
   github-markup (~> 0.7)
   guard-rspec (~> 2.1)
   guard-yard (~> 2.0)
   rb-fsevent (~> 0.9)
-  redcarpet (~> 2.2.2)
+  redcarpet (~> 2.2)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Ryan Scott Lewis <ryan@rynet.us>
+Copyright (c) 2012-2013 Ryan Scott Lewis <ryan@rynet.us>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,44 +1,118 @@
 # At
 
-`At` is a small library that allows you to access instance variables on an object as 
-if they were `attr_accessor`s for testing purposes.
+`At` is a small library provides an `at` method for all Objects which allows you to access instance variables
+on an object as if they were accessors for testing purposes, usually within test setups and teardowns.
+
+## Install
+
+### Bundler: `gem 'at'` in `group :test`
+
+### RubyGems: `gem install at`
+
+## Usage
+
+### TL;DR
 
 Basically, `at` directly translates this:
 
 ```ruby
-value = object.instance_eval { @instance_variable }
-object.instance_eval { @instance_variable = "#{value}!" }
+value = user.instance_eval { @name }
+user.instance_eval { @name = "#{value}!" }
 ```
 
 into this:
 
 ```ruby
-value = object.at.instance_variable
-object.at.instance_variable = "#{value}!"
+value = user.at.name
+user.at.name = "#{value}!"
 ```
 
-## Install
+### Use Case
 
-### Bundler: `gem 'at'`
+`lib/user.rb`
 
-### RubyGems: `gem install at`
+```ruby
+class User
+  
+  def initialize(first_name=nil, last_name=nil)
+    @first_name, @last_name = first_name, last_name
+  end
+  
+  def full_name
+    [@first_name, @last_name].compact.join(" ")
+  end
+  
+end
+```
 
-## Usage
+`spec/spec_helper.rb`
+
+```ruby
+require 'user'
+require 'at/setup'
+```
+
+`spec/user_spec.rb`
+
+```ruby
+describe User do
+  
+  describe '#full_name' do
+    
+    before :all do
+      subject.at.first_name = 'John'
+      subject.at.last_name = 'Doe'
+    end
+    
+    it 'should output the full name correctly' do
+      subject.full_name.should == 'John Doe'
+    end
+    
+  end
+  
+end
+```
+
+Check out the specs for a better usage example.
+
+## FAQ
+
+### Why is this named "At"?
 
-If I want to test the output of the `full_name` method in my `User` class
-below, I would normally have three options for testing all possible outcomes; 
-initialize a `User` object for each test case, initialize one `User` object and 
-use `instance_eval` to set the instance variables individually, or create 
-`attr_accessor`s for each instance variable I would like to test. In Rspec, I 
-can use `assigns` to test the value of the instance variable, but I can't 
-_get_ the value of the instance variable.
+Because the at symbol (`@`) is how an instance variable is declared in Ruby!
 
-`At` solves these problems.
+### What if my class defines an `at` instance method?
+
+`At` is included on the `Object` class, so when your class defines the `at` instance method, you are actually overwriting
+the `At#at` method. Luckily, the `at` method is just an alias of the `_at` method, which you can use instead:
 
 ```ruby
-require 'at'
+describe Event do
+  
+  describe "#at" do
+    
+    let(:event_at) { DateTime.now }
+    
+    before(:all) { subject._at.at = event_at }
+    
+    it 'should return the DateTime the Event is happening' do
+      subject.at.should == event_at
+    end
+    
+  end
+  
+end
+```
 
+### How can I include the `at` and `_at` methods on a single object?
+
+Include `At` to the object's class:
+
+`lib/user.rb`
+
+```ruby
 class User
+  
   def initialize(first_name=nil, last_name=nil)
     @first_name, @last_name = first_name, last_name
   end
@@ -46,19 +120,105 @@ class User
   def full_name
     [@first_name, @last_name].compact.join(" ")
   end
+  
 end
+```
+
+`spec/spec_helper.rb`
 
-describe User, '#full_name' do
-  it 'should output the full name correctly' do
-    subject.at.first_name = 'John'
-    subject.at.last_name = 'Doe'
-      
-    subject.full_name.should == 'John Doe'
+```ruby
+require 'user'
+require 'at'
+
+class User
+  include At
+end
+```
+
+`spec/user_spec.rb`
+
+```ruby
+
+describe User do
+  
+  describe '#full_name' do
+    
+    before :all do
+      subject.at.first_name = 'John'
+      subject.at.last_name = 'Doe'
+    end
+    
+    it 'should output the full name correctly' do
+      subject.full_name.should == 'John Doe'
+    end
+    
   end
+  
 end
 ```
 
-Check out the specs for a better usage example.
+### How can I include the `at` method outside of a test environment?
+
+Same premise as the above answer:
+
+```ruby
+require 'at'
+
+class User
+  
+  include At
+  
+  def initialize(first_name=nil, last_name=nil)
+    @first_name, @last_name = first_name, last_name
+  end
+  
+  def full_name
+    [@first_name, @last_name].compact.join(" ")
+  end
+  
+end
+```
+
+### How can I use instance variable delegation without the `at` method?
+
+Simply use `At::InstanceVariableDelegator`:
+
+```ruby
+require 'at/instance_variable_delegator'
+
+class Application
+  
+  class Config
+    attr_reader :hostname, :port
+  end
+  
+  attr_reader :config
+  
+  def initialize(&block)
+    @config = Config.new
+    
+    configure(&block) if block_given?
+  end
+  
+  def configure(&block)
+    raise ArgumentError, 'block must be supplied' unless block_given?
+    delegator = At::InstanceVariableDelegator.new(@config)
+    
+    block.call(delegator)
+  end
+  
+end
+
+# Usage:
+app = Application.new
+app.configure do |c|
+  c.hostname = 'example.com'
+  c.port = 8080
+end
+
+p app.config.hostname # => 'example.com'
+p app.config.port     # => 8080
+```
 
 ## Contributing
 
@@ -72,6 +232,6 @@ Check out the specs for a better usage example.
 
 ## Copyright
 
-Copyright © 2012 Ryan Scott Lewis <ryan@rynet.us>.
+Copyright © 2012-2013 Ryan Scott Lewis <ryan@rynet.us>.
 
-The MIT License (MIT) - See LICENSE for further details.
+The MIT License (MIT) - See LICENSE for further details.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/at.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = "at"
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Scott Lewis"]
-  s.date = "2012-12-11"
+  s.date = "2013-02-16"
   s.description = "Make instance variables accessible for testing purposes."
   s.email = "ryan@rynet.us"
-  s.files = [".yardoc/object_types", ".yardoc/objects/root.dat", ".yardoc/proxy_types", "Gemfile", "Gemfile.lock", "Guardfile", "LICENSE", "README.md", "Rakefile", "VERSION", "at.gemspec", "lib/at.rb", "lib/at/import.rb", "spec/at_spec.rb", "spec/spec_helper.rb"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "Gemfile.lock", "Guardfile", "LICENSE", "README.md", "Rakefile", "VERSION", "at.gemspec", "lib/at.rb", "lib/at/instance_variable_delegator.rb", "lib/at/setup.rb", "spec/at_spec.rb", "spec/spec_helper.rb"]
   s.homepage = "http://github.com/RyanScottLewis/at"
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"

data/lib/at.rb

@@ -1,39 +1,17 @@
 require 'version'
 
+# `At` is a small library provides an `at` method for all Objects which allows you to access instance variables
+# on an object as if they were accessors for testing purposes, usually within test setups and teardowns
 module At
-  
   is_versioned
   
-  class MethodToInstanceVariableProxy
-    
-    def initialize(parent)
-      @parent = parent
-    end
-    
-    def method_missing(meth, *args)
-      @parent.instance_eval do
-        
-        if match = meth.to_s.match(/(.*)\=$/)
-          value = args.length == 1 ? args.first : args
-          instance_variable_set("@#{match[1]}", value)
-        else
-          if args.empty?
-            instance_variable_get("@#{meth}")
-          else
-            value = args.length == 1 ? args.first : args
-            instance_variable_set("@#{meth}", value)
-          end
-        end
-        
-      end
-    end
-    
+  require 'at/instance_variable_delegator'
+  # @return [InstanceVariableDelegator] The memoized InstanceVariableDelegator proxy instance for this Object instance
+  def _at
+    @_at ||= InstanceVariableDelegator.new(self)
   end
   
-  def at
-    @_method_to_instance_variable_proxy ||= MethodToInstanceVariableProxy.new(self)
-  end
+  alias_method :at, :_at
   
 end
 
-require 'at/import'

data/lib/at/instance_variable_delegator.rb

@@ -0,0 +1,25 @@
+module At
+  
+  # InstanceVariableDelegator is a simply class which delegates it's methods it an object's instance variables.
+  class InstanceVariableDelegator
+    
+    # @param [Object] parent The object to delegate accessors to it's instance variables.
+    def initialize(parent)
+      @parent = parent
+    end
+    
+    # If the method ends with an equal sign (`=`), we will set the instance variable on the @parent object.
+    # Otherwise, we will /get/ the instance variable on the @parent object.
+    def method_missing(meth, value=nil)
+      @parent.instance_eval do
+        match = meth.to_s.match(/(.*)\=$/)
+        raise ArgumentError, '`value` must be given' if match && value.nil?
+        raise ArgumentError, '`value` must not be given' if !match && !value.nil?
+        
+        match ? instance_variable_set("@#{match[1]}", value) : instance_variable_get("@#{meth}")
+      end
+    end
+    
+  end
+  
+end

data/lib/at/setup.rb

@@ -0,0 +1,6 @@
+require 'at'
+
+# Here, we include At to the Object class.
+class Object
+  include At
+end

data/spec/at_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
+# TODO: Move classes to spec/support
+
 class Configuration
   attr_reader :configuration
   
@@ -9,13 +11,17 @@ class Configuration
 end
 
 describe Configuration do
+  
   describe "#configuration" do
+    
     it "should return the @configuration instance variable" do
       subject.configuration.should == "default"
       subject.at.configuration = "the result"
       subject.configuration.should == "the result"
     end
+    
   end
+  
 end
 
 #===-----------------------------------------------------------------------===#
@@ -31,6 +37,7 @@ class User
 end
 
 describe User do
+  
   describe "#initialize" do
     subject { User.new("John", "Doe") }
     
@@ -60,6 +67,7 @@ describe User do
       Proc.new { subject.last_name }.should raise_error(NoMethodError)
     end
   end
+  
 end
 
 #===-----------------------------------------------------------------------===#
@@ -102,4 +110,69 @@ describe Twitter do
       Twitter.search(:q => "test").should == "{'some':'json response'}"
     end
   end
-end
+end
+
+#===-----------------------------------------------------------------------===#
+
+# This class has it's own `at` method
+class Event
+  
+  attr_reader :at
+  
+end
+
+describe Event do
+  
+  let(:event_at) { DateTime.now }
+  
+  before(:all) { subject._at.at = event_at }
+  
+  describe "#at" do
+    
+    it 'should return the DateTime the Event is happening' do
+      subject.at.should == event_at
+    end
+    
+  end
+  
+end
+
+
+
+
+
+
+
+
+
+# class Application
+#   
+#   class Config
+#     attr_reader :hostname, :port
+#   end
+#   
+#   attr_reader :config
+#   
+#   def initialize(&block)
+#     @config = Config.new
+#     
+#     configure(&block) if block_given?
+#   end
+#   
+#   def configure(&block)
+#     raise ArgumentError, 'block must be supplied' unless block_given?
+#     delegator = At::InstanceVariableDelegator.new(@config)
+#     
+#     block.call(delegator)
+#   end
+#   
+# end
+# 
+# app = Application.new
+# app.configure do |c|
+#   c.hostname = 'example.com'
+#   c.port = 8080
+# end
+# 
+# p app.config.hostname # => 'example.com'
+# p app.config.port     # => 8080

data/spec/spec_helper.rb

@@ -1,2 +1,2 @@
 require 'bundler/setup'
-require 'at'
+require 'at/setup'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: at
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version
@@ -145,9 +145,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardoc/object_types
-- .yardoc/objects/root.dat
-- .yardoc/proxy_types
+- .gitignore
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -157,7 +156,8 @@ files:
 - VERSION
 - at.gemspec
 - lib/at.rb
-- lib/at/import.rb
+- lib/at/instance_variable_delegator.rb
+- lib/at/setup.rb
 - spec/at_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/RyanScottLewis/at
@@ -172,6 +172,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1052782577
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/at/import.rb

@@ -1,10 +0,0 @@
-require 'pathname'
-
-__LIB__ ||= Pathname.new(__FILE__).join('..', '..').expand_path
-$:.unshift(__LIB__.to_s) unless $:.include?(__LIB__.to_s)
-
-require 'at'
-
-class Object
-  include At
-end