factis 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/log/*.log
+/tmp
+*~
+*.swp

data/.ruby-gemset

@@ -0,0 +1 @@
+factis

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    factis (0.0.0)
+      awesome_print
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.2.0)
+    builder (3.2.2)
+    cucumber (1.3.8)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.1)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    multi_json (1.8.0)
+    multi_test (0.0.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber
+  factis!
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Dennis Walters
+
+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,107 @@
+## Factis ##
+
+Ruby DSL for safely tracking facts through a test
+
+## Gem Setup ##
+
+```ruby
+gem install factis
+
+# Gemfile
+group :test do
+  gem 'factis'
+end
+```
+## Using with Rails ##
+
+```bash
+rails generate factis:install
+```
+
+Truth be told, this just installs some example Factis steps and a support file
+for Cucumber. For the time being, it's on you to figure out how to use it with
+other testing frameworks.
+
+### factis_steps.rb ###
+
+Much like our once beloved web_steps.rb, you should read factis_steps.rb exactly
+one time, and then you should delete it. It's really just an example, and using
+those steps in a feature will make your stakeholders hate you with the fury of
+a thousand burning suns.
+
+## Cucumber ##
+
+So, using Cucumber, but not Rails? Try this!
+
+```ruby
+# features/support/factis.env
+require 'factis/cucumber'
+```
+
+This gets you ready to use the DSL. Additionally, it forces Factis to forget
+everything that you have told it to remember after each scenario. Because stale
+state information from one scenario to the next will make you a very sad panda.
+
+## How Do I Use This Thing? ##
+
+When I'm tracking state within a test, it's most likely a Cucumber feature.
+That being the case, I'm going to use terminology from that side of the
+experience. Here's everything that World gets when you use Factis.
+
+```ruby
+# Let's remember that my brother, Joe, just loves pie.
+remember_fact("What does Joe love?", "Joe loves pie.")
+
+# Hey Factis, what does Joe love?
+recall_fact("What does Joe love?")
+
+# That's not very interesting. Let's forget about it.
+forget_fact("What does Joe love?")
+
+# Wait, what does Joe love again?
+recall_fact("What does Joe love?")
+  => Trying to recall an unkown fact: 'What does Joe love?' (RuntimeError)
+
+# Let's just forget everything.
+clear_all_facts!
+
+# So, what facts do we know?
+all_facts
+  => {}
+
+class Foo
+end
+
+# The content can be pretty much anything.
+remember_fact(:some_foo, Foo.new)
+
+# What's a foo?
+recall_fact(:some_foo)
+  => #<Foo:0x007ffd84394728>
+```
+
+## So, Uh, Why? ##
+
+There are two sides of this story, really:
+
+* It's generally accepted that being able to track things over the course of an
+  indempotent test (a user's email address, the number of stars in the known
+  galaxy, etc) makes it easier to write tests. Rather than thinking "my email
+  address is user@example.com" repeatedly, you can just accept that you have
+  an email address.
+
+* It's generally accepted that tracking things with instance variables over the
+  course of a test is a pretty bad scene. On top of generally muddying up the
+  object space, it makes it really easy to rely on state that's left over from
+  a previously-run scenario, forget to set them up in the first place, etc.
+
+I've run into a lot of problems with tracking state in my tests in unsafe ways,
+so this thing got thrown together.
+
+## Okay, So What's So Great About It? ##
+
+Not much, really. It's really just a simple DSL that hides away the things that
+you tell it to remember and recalls them at your request. There is a generator
+to get you up and running with Cucumber, but you should be able to use it with
+just about any test framework that allows you to extend the global namespace
+(a-la `World(Factis)`).

data/factis.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/factis/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dennis Walters"]
+  gem.email         = ["pooster@gmail.com"]
+  gem.summary       = %q{Discretely remember and recall facts in your tests}
+  gem.description   = <<-EOD
+    Factis is a simple DSL for tracking state and such in your tests
+    without muddying up the global object space.
+  EOD
+  gem.homepage      = "http://github.com/ess/factis"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "factis"
+  gem.require_paths = ["lib"]
+  gem.version       = Factis::VERSION
+
+  gem.add_dependency 'awesome_print'
+  gem.add_development_dependency 'cucumber'
+  #gem.add_development_dependency 'rspec-core'
+  #gem.add_development_dependency 'rspec-expectations'
+  #gem.add_development_dependency 'rspec-mocks'
+  gem.add_development_dependency 'rspec'
+end

data/lib/factis.rb

@@ -0,0 +1,24 @@
+require 'factis/memory'
+
+module Factis
+
+  def clear_all_facts!
+    Factis::Memory.reset!
+  end
+
+  def all_facts
+    Factis::Memory.all_facts
+  end
+
+  def remember_fact(fact, content)
+    Factis::Memory.remember(fact, content)
+  end
+
+  def recall_fact(fact)
+    Factis::Memory.recall(fact)
+  end
+
+  def forget_fact(fact)
+    Factis::Memory.forget(fact)
+  end
+end

data/lib/factis/cucumber.rb

@@ -0,0 +1,6 @@
+require 'factis'
+World(Factis)
+
+After do
+  clear_all_facts!
+end

data/lib/factis/memory.rb

@@ -0,0 +1,46 @@
+require 'awesome_print'
+
+module Factis
+  class Memory
+
+    def self.init_memory!
+      @facts = Hash.new
+    end
+
+    def self.all_facts
+      init_memory! if @facts.nil?
+      @facts
+    end
+
+    def self.remember(fact, content)
+      init_memory! if @facts.nil?
+      @facts[fact] = content
+    end
+
+    def self.known_fact?(fact)
+      init_memory! if @facts.nil?
+      @facts.keys.include?(fact)
+    end
+
+    def self.forget(fact)
+      init_memory! if @facts.nil?
+      unless known_fact?(fact)
+        raise %{Trying to forget an unknown fact: '#{fact}'}
+      end
+      @facts.delete(fact)
+    end
+
+    def self.recall(fact)
+      init_memory! if @facts.nil?
+      unless known_fact?(fact)
+        raise %{Trying to recall an unknown fact: '#{fact}'}
+      end
+      @facts[fact]
+    end
+
+    def self.reset!
+      init_memory! if @facts.nil?
+      @facts.clear
+    end
+  end
+end

data/lib/factis/version.rb

@@ -0,0 +1,3 @@
+module Factis
+  VERSION = '0.0.1'
+end

data/lib/generators/factis/install_generator.rb

@@ -0,0 +1,17 @@
+module Factis
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc "Installs the Cucumber step and support files for Factis"
+      
+      def copy_steps
+        template "factis_steps.rb", "features/step_definitions/factis_steps.rb"
+      end
+
+      def copy_support
+        template "factis.rb", "features/support/factis.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/factis.rb

@@ -0,0 +1,6 @@
+# Hey there! I'm sure that you'd really like to do things in this support file,
+# but the fact of the matter is that there really isn't any configuration for
+# Factis just yet. And there probably really never will be, because it's both
+# simple and stubborn.
+
+require 'factis/cucumber'

data/lib/generators/templates/factis_steps.rb

@@ -0,0 +1,20 @@
+# These steps were installed by the Factis install generator to help get you
+# started. You probably shouldn't really use these, and you should probably
+# even go as far as to delete this file. Think of it the same way you'd think
+# about the very far removed web_steps.rb from older versions of Cucumber.
+
+Given %r{^I remember (.*?) is "(.*?)"$} do |fact, content|
+  remember_fact(fact, content)
+end
+
+Then %r{^I should recall (.*?) as "(.*?)"$} do |fact, expected_content|
+  recall_fact(fact).should == expected_content
+end
+
+When %r{^I forget (.*?)$} do |fact|
+  forget_fact(fact)
+end
+
+When %{I clear the facts memory} do
+  clear_all_facts!
+end

data/spec/factis/memory_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'factis/memory'
+
+describe Factis::Memory do
+
+  let(:memory) {Factis::Memory}
+  let(:fact) {"Joe"}
+  let(:content) {"Likes pie"}
+
+  describe '.all_facts' do
+    it 'is a Hash' do
+      memory.all_facts.should be_a(Hash)
+    end
+  end
+
+  describe '.remember' do
+    context "when given a fact name and content" do
+      it "records the fact" do
+        memory.remember(fact, content)
+        memory.all_facts.keys.include?(fact).should be_true
+        memory.all_facts[fact].should == content
+      end
+    end
+  end
+
+  describe '.known_fact?' do
+    before(:each) do
+      memory.remember(fact, content)
+    end
+
+    it "returns true for known facts" do
+      memory.known_fact?(fact).should be_true
+    end
+
+    it "returns false for unknown facts" do
+      memory.known_fact?(:unknown).should be_false
+    end
+  end
+
+  describe '.forget' do
+    before(:each) do
+      memory.remember(fact, content)
+    end
+
+    
+
+    it "removes a known fact from memory" do
+      memory.forget(fact)
+      memory.known_fact?(fact).should be_false
+    end
+
+    it "raises an error when given an unknown fact" do
+      lambda {memory.forget("unknown fact")}.should raise_error
+    end
+  end
+
+  describe '.recall' do
+    before(:each) do
+      memory.remember(fact, content)
+    end
+
+    it "returns the content of a known fact" do
+      memory.recall(fact).should == content
+    end
+
+    it "raises an error when given an unknown fact" do
+      lambda {memory.recall(:unknown)}.should raise_error
+    end
+
+  end
+
+  describe '.init_memory!' do
+    it 'should instantiate a new Hash for the memory' do
+      old = memory.all_facts.__id__
+      memory.init_memory!
+      memory.all_facts.__id__.should_not == old
+    end
+  end
+
+  describe '.reset!' do
+    it 'should clear the memory' do
+      memory.remember(fact, content)
+      memory.known_fact?(fact).should be_true
+      memory.reset!
+      memory.known_fact?(fact).should be_false
+    end
+  end
+end

data/spec/factis_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'factis'
+
+describe Factis do
+  describe %{DSL} do
+    let(:factis) {Object.new.send(:extend, subject)}
+    let(:fact) {"Joe"}
+    let(:content) {"likes pie"}
+
+    describe %{#clear_all_facts!} do
+      it %{resets the Factis memory core} do
+        Factis::Memory.should_receive(:reset!)
+        factis.clear_all_facts!
+      end
+    end
+
+    describe %{#all_facts} do
+      it %{returns the contents of the Factis memory core} do
+        facts = {fact => content}
+        Factis::Memory.should_receive(:all_facts).and_return(facts)
+        factis.all_facts.should == facts
+      end
+    end
+
+    describe %{remember_fact} do
+      it %{stores the provided fact} do
+        Factis::Memory.should_receive(:remember).with(fact, content).and_call_original
+        factis.remember_fact(fact, content)
+      end
+    end
+
+    describe %{recall_fact} do
+      before(:each) {factis.remember_fact(fact, content)}
+
+      it %{recalls the provided fact if known} do
+        Factis::Memory.should_receive(:recall).with(fact).and_call_original
+        factis.recall_fact(fact).should == content
+      end
+
+      it %{raises an error if the fact is not known} do
+        lambda {factis.recall_fact(:unknown)}.should raise_error
+      end
+    end
+
+    describe %{forget_fact} do
+      before(:each) {factis.remember_fact(fact, content)}
+
+      it %{forgets the provided fact if known} do
+        Factis::Memory.should_receive(:forget).with(fact).and_call_original
+        factis.forget_fact(fact)
+        factis.all_facts.keys.include?(fact).should_not be_true
+      end
+
+      it %{raises an error if the fact is not known} do
+        lambda {factis.forget_fact(:unknown)}.should raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec/expectations'
+
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: factis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Factis is a simple DSL for tracking state and such in your tests\n
+  \   without muddying up the global object space.\n"
+email:
+- pooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- factis.gemspec
+- lib/factis.rb
+- lib/factis/cucumber.rb
+- lib/factis/memory.rb
+- lib/factis/version.rb
+- lib/generators/factis/install_generator.rb
+- lib/generators/templates/factis.rb
+- lib/generators/templates/factis_steps.rb
+- spec/factis/memory_spec.rb
+- spec/factis_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ess/factis
+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.8.25
+signing_key: 
+specification_version: 3
+summary: Discretely remember and recall facts in your tests
+test_files:
+- spec/factis/memory_spec.rb
+- spec/factis_spec.rb
+- spec/spec_helper.rb