instance_tracker 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e07a37fdbc098d6c237777fb8a8fe015a282cdb7
+  data.tar.gz: d29f55338021f42da49ef5b255221add952eec30
+SHA512:
+  metadata.gz: 8ae681ade48cc0a46b1f89150731ef971da8907491789058df97479af2e2f6e0d97bf9389221a9205e0728f713644b6497f2339d0ed089c87dbd66d59cc2aafe
+  data.tar.gz: 02296562de4f8bf331da08f5c181927d1cdd27e18804591a1288d5764962a6d61974512b78f36a94e48eef33079f0ac7eccb702fae1c7528424c46bc26df55af

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Vim
+*.swp
+*.swo
+
+# Backup
+*~
+
+# Mac
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color --format documentation --fail-fast", :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael de Silva
+
+MIT License
+
+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.md

@@ -0,0 +1,50 @@
+# InstanceTracker
+
+A Simple Ruby DSL for Instance Tracking.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'instance_tracker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instance_tracker
+
+## API Summary
+
+Start by including `InstanceTracker::Trackable` within classes in which
+you want to track an instance variable; this provides the class
+a `track` class method which allows you to define which instance
+variable to track.
+
+```ruby
+  class Foo
+    include InstanceTracker::Trackable
+    track :wrapper
+
+    def initialize(wrapper)
+      @wrapper = wrapper
+    end
+  end
+```
+
+You are now able to access the `wrapper` by simply calling
+`trackable_instance` from any instance of your class.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/instance_tracker.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instance_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "instance_tracker"
+  spec.version       = InstanceTracker::VERSION
+  spec.authors       = ["Michael de Silva"]
+  spec.email         = ["michael@mwdesilva.com"]
+  spec.homepage      = "http://mwdesilva.com"
+  spec.summary       = "A Simple Ruby DSL for Instance Tracking"
+  spec.description   = spec.summary
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "yard"
+end

data/lib/instance_tracker/trackable.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+module InstanceTracker
+
+  module Trackable
+
+    # The instance of {CleanRoom} is used to store our instance.
+
+    class CleanRoom
+      attr_reader :instance
+
+      def initialize(instance)
+        @instance = instance
+      end
+
+    end
+
+    class << self
+
+      def included _klass
+        _klass.class_eval do
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+    end
+
+    module InstanceMethods
+
+      # @api private
+      #
+      # The instance of {CleanRoom} is memoised and returned
+      # accordingly.
+      #
+      # @return [CleanRoom]
+      # @raise [NotImplementedError] if the instance variable tracked has not been defined within the included _klass.
+
+      def trackable
+        @trackable ||= begin
+          entity = instance_variable_get(:"@#{singleton_class.trackable_instance}")
+          raise NotImplementedError unless entity
+          Class.new(CleanRoom).new(entity)
+        end
+      end
+
+      # Returns the instance tracked by {CleanRoom}
+
+      def trackable_instance
+        trackable.instance
+      end
+
+    end
+
+    module ClassMethods
+
+      # Sets the instance variable to be tracked.
+      #
+      # @param name [String] the instance variable to track
+
+      def track(name)
+        singleton_class.class_eval do
+          define_method :trackable_instance do
+            name
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/instance_tracker/version.rb

@@ -0,0 +1,3 @@
+module InstanceTracker
+  VERSION = "0.1.1"
+end

data/lib/instance_tracker.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+require "instance_tracker/version"
+
+module InstanceTracker
+  autoload :Trackable,    'instance_tracker/trackable'
+end

data/spec/plugin/trackable_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module InstanceTracker
+  describe Trackable do
+
+    class SpecHarness
+      include InstanceTracker::Trackable
+      track :context
+
+      def initialize
+        @context = "Foo"
+      end
+    end
+
+    let(:subject) { SpecHarness.new }
+
+    it "should respond to `#trackable_instance`" do
+      expect(subject.respond_to? :trackable_instance).to be
+      expect(subject.trackable_instance).to eq("Foo")
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'instance_tracker'
+require 'mocha/api'
+require 'pry'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # Disable should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: instance_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael de Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Simple Ruby DSL for Instance Tracking
+email:
+- michael@mwdesilva.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- instance_tracker.gemspec
+- lib/instance_tracker.rb
+- lib/instance_tracker/trackable.rb
+- lib/instance_tracker/version.rb
+- spec/plugin/trackable_spec.rb
+- spec/spec_helper.rb
+homepage: http://mwdesilva.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Simple Ruby DSL for Instance Tracking
+test_files:
+- spec/plugin/trackable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: