statefulton 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rvmrc

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p290@statefulton"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
+# then
+#   bundle install
+# fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Dave Lyon
+
+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,69 @@
+# Statefulton
+
+A simple interface for the state of objects under test. Useful as an interface along with Cucumber Transforms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'statefulton'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statefulton
+
+## Usage
+
+Defined DSL methods:
+
+* *builder* - Stores a block to use as a default builder method. Block is called when a 'make' method is triggered.
+* *make*    - Creates a state method that returns a newly created instance of the object. Raises if called again.
+* *expects* - Creates a state method that returns an existing instance of the object. Raises if no instance exists.
+
+Accessing the state of something:
+
+* StateOf(:name, "context")
+
+Creating a statefulton:
+
+* Statefulton(:name) { # a block of calls to the DSL methods }
+
+To define a new statefulton:
+
+	Statefulton(:user) do
+	  builder { User.new }
+
+	  make "an"
+
+	  expects "that" # Calling "that" will return the singular instance
+	end
+
+	StateOf(:user, "that") #raise error: instance not created
+	StateOf(:user, "an")   #build the object
+	StateOf(:user, "an")   #raise error: instance already created
+	StateOf(:user, "that") #get the object
+
+Cucumber Usage:
+
+	Given a user
+	When I activate that user
+
+	Transform /^(a|that) user$/ do |state|
+	  StateOf(:user, state)
+	end
+
+	When /^I activate (that user)$/ do |user|
+	  user.activate!
+	end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (with tests!) (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'

data/lib/statefulton/builder.rb

@@ -0,0 +1,31 @@
+require 'singleton'
+
+class Statefulton::Builder
+  include Singleton
+
+  def register(name, &block)
+    state = Statefulton::Statefulton.new &block
+    add_state name, state
+  end
+
+  def get_state name, method
+    states[name].public_method(method).call
+  end
+
+  def reset_all!
+    states.values.map(&:reset!).none?
+  end
+
+  private
+
+  attr_reader :states
+
+  def initialize
+    @states = {}
+  end
+
+  def add_state name, state
+    @states[name] = state
+    state
+  end
+end

data/lib/statefulton/statefulton.rb

@@ -0,0 +1,37 @@
+class Statefulton::Statefulton
+  attr_reader :instance
+
+  def initialize &block
+    instance_eval &block
+  end
+
+  def builder &block
+    @builder = block
+  end
+
+  def make string, &block
+    define_singleton_method string do
+      build_instance &block
+    end
+  end
+
+  def expects string
+    define_singleton_method string do
+      instance or fail "No instance exists!"
+    end
+  end
+
+  def reset!
+    @instance = nil
+  end
+
+  private
+  def build_instance &block
+    fail "Instance already created!" unless @instance.nil?
+    @instance = if block_given?
+      block.call
+    else
+      @builder.call
+    end
+  end
+end

data/lib/statefulton/version.rb

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

data/lib/statefulton.rb

@@ -0,0 +1,22 @@
+require "statefulton/version"
+
+module Statefulton
+  autoload :Builder,      'statefulton/builder'
+  autoload :Statefulton,  'statefulton/statefulton'
+  State = Builder.instance
+  Reset = Class.new do
+    define_singleton_method :all do
+      Builder.instance.reset_all!
+    end
+  end
+end
+
+def Statefulton(name, &block)
+  name = name.to_sym
+  Statefulton::State.register name, &block
+end
+
+def StateOf(name, method)
+  name = name.to_sym
+  Statefulton::State.get_state name, method
+end

data/spec/spec_helper.rb

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

data/spec/statefulton/builder_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Statefulton::Builder do
+  subject { Statefulton::Builder.instance }
+  after { subject.send(:initialize) }
+  describe "#register" do
+    it "returns a new statefulton" do
+      subject.register('a'){}.should be_a Statefulton::Statefulton
+    end
+  end
+
+  describe "#get_state" do
+    before do
+      subject.register('hash'){
+        builder { Hash.new }
+        make "one"
+      }.should be_a Statefulton::Statefulton
+    end
+    it "returns an object from a statefulton" do
+      subject.get_state("hash", "one").should be_a Hash
+    end
+  end
+
+  describe "#reset_all!" do
+    before do
+      subject.register(:one){}
+      subject.register(:two){}
+    end
+    it "resets all known states" do
+      subject.reset_all!.should be_true
+    end
+  end
+end

data/spec/statefulton/statefulton_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe Statefulton::Statefulton do
+  let(:statefulton) { Statefulton::Statefulton.new &block }
+  subject { statefulton }
+
+  describe "Domain Specific Language" do
+    describe "#builder" do
+      let(:block) { Proc.new { builder { Object.new } } }
+      it "sets a builder with a block" do
+        subject.instance_variable_get("@builder").should be_a Proc
+      end
+    end
+
+    describe "#make" do
+      let(:block) do
+        Proc.new { make "one instance" }
+      end
+
+      it "defines a singleton method on this instance" do
+        subject.should respond_to "one instance"
+      end
+
+      context "with a block" do
+        let(:block) do
+          Proc.new do
+            make "instance with stuff" do
+              [1,2]
+            end
+          end
+        end
+
+        subject { statefulton.send("instance with stuff") }
+
+        it "calls the block when activated" do
+          subject.should == [1,2]
+        end
+
+        it "saves the state of the object" do
+          subject.should == [1,2]
+          statefulton.instance.should == [1,2]
+        end
+
+        it "raises if a creation attempt occurs" do
+          expect do
+            subject.send("instance with stuff")
+          end.to raise_error
+        end
+      end
+    end
+
+    describe "#expects" do
+      let(:block) do
+        Proc.new do
+          builder { Object.new }
+          expects "an instance"
+        end
+      end
+
+      it "defines a singleton method on this instance" do
+        subject.should respond_to "an instance"
+      end
+
+      it "raises if no instance exists" do
+        expect do
+          subject.send("an instance")
+        end.to raise_error
+      end
+    end
+
+    describe "#reset!" do
+      let(:block) do
+        Proc.new do
+          builder { Hash.new }
+          make "one"
+        end
+      end
+      before { subject.send "one" }
+      it "sets the instance to nil" do
+        subject.reset!
+        subject.instance.should be_nil
+      end
+    end
+  end
+
+  describe "Internal API" do
+    let(:block) do
+      Proc.new do
+        builder { Hash.new }
+        make "one instance"
+        expects "that instance"
+      end
+    end
+
+    describe "#build_instance" do
+      context "first call" do
+        it "builds the singular instance" do
+          subject.send "one instance"
+          subject.send(:instance).should be_a Hash
+        end
+      end
+
+      context "with a block" do
+        subject { Statefulton::Statefulton.new{} }
+        it "calls the block instead of the builder" do
+          subject.instance_eval do
+            build_instance {:ok}.should == :ok
+          end
+        end
+      end
+
+      context "subsquent call" do
+        it "builds the singular instance" do
+          subject.send "one instance"
+          expect do
+            subject.send "one instance"
+          end.to raise_error "Instance already created!"
+        end
+      end
+    end
+
+    describe "#get_instace" do
+      context "with an instance" do
+        before { subject.send "one instance" }
+        it "returns the singular instance" do
+          subject.send("that instance").should be_a Hash
+        end
+      end
+
+      context "with no instance" do
+        it "raises an error" do
+          expect do
+            subject.send("that instance")
+          end.to raise_error "No instance exists!"
+        end
+      end
+    end
+  end
+
+end

data/spec/statefulton_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "Statefulton" do
+  describe "Pretty API methods" do
+    describe "Statefulton()" do
+      it "returns a new statefulton" do
+        Statefulton("a"){}.should be_a Statefulton::Statefulton
+      end
+    end
+
+    describe "StateOf()" do
+      before do
+        Statefulton :foo do
+          builder { Hash.new }
+          make "an"
+          expects "the one"
+        end
+      end
+      it "returns a statefultons instance" do
+        StateOf(:foo, "an").should be_a Hash
+        StateOf(:foo, "the one").should be_a Hash
+      end
+    end
+
+    describe "::Reset.alll" do
+      it "calls reset_all! on the builder" do
+        Statefulton::Reset.all.should == true
+      end
+    end
+  end
+end

data/statefulton.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/statefulton/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dave Lyon", "Matt Polito"]
+  gem.email         = ["gems@davelyon.net"]
+  gem.description   = %q{A simple utility to manage state when testing}
+  gem.summary       = %q{A fancy way to manage state in complex environments. Helpful when in Cucumber with lots of expected state.}
+  gem.homepage      = "https://github.com/davelyon/statefulton"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "statefulton"
+  gem.require_paths = ["lib"]
+  gem.version       = Statefulton::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.7"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: statefulton
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dave Lyon
+- Matt Polito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-28 00:00:00.000000000 -06:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165793320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2165793320
+description: A simple utility to manage state when testing
+email:
+- gems@davelyon.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/statefulton.rb
+- lib/statefulton/builder.rb
+- lib/statefulton/statefulton.rb
+- lib/statefulton/version.rb
+- spec/spec_helper.rb
+- spec/statefulton/builder_spec.rb
+- spec/statefulton/statefulton_spec.rb
+- spec/statefulton_spec.rb
+- statefulton.gemspec
+has_rdoc: true
+homepage: https://github.com/davelyon/statefulton
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A fancy way to manage state in complex environments. Helpful when in Cucumber
+  with lots of expected state.
+test_files:
+- spec/spec_helper.rb
+- spec/statefulton/builder_spec.rb
+- spec/statefulton/statefulton_spec.rb
+- spec/statefulton_spec.rb