factis 0.0.8 → 1.0.0

data/README.md

@@ -14,8 +14,12 @@ end
 ```
 ## Using with Rails ##
 
+Included are a couple of generators to help you get rolling with Rails apps.
+
+### Cucumber ###
+
 ```bash
-rails generate factis:install
+rails generate factis:cucumber
 ```
 
 Truth be told, this just installs some example Factis steps and a support file
@@ -29,7 +33,18 @@ 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 ##
+### Rspec ###
+
+```bash
+rails generate factis:rspec
+```
+
+This adds a Factis support file to your spec tree. The default configuration
+is the same of that for Cucumber. It's important to note that Factis is
+brought into Rspec via ```config.include``` so the DSL is available in
+the examples, but not in the overall environment.
+
+## Manual Cucumber ##
 
 So, using Cucumber, but not Rails? Try this!
 
@@ -42,6 +57,27 @@ This gets you ready to use the DSL. Additionally, it forces Factis to forget
 everything that you have told it to memorize after each scenario. Because stale
 state information from one scenario to the next will make you a very sad panda.
 
+## Manual Rspec ##
+
+So, using Rspec, but not Rails? Try this!
+
+```ruby
+# spec/support/factis.rb
+require 'factis/rspec'
+```
+
+If you're not using an all-inclusive support directory for your specs, you can
+just toss that require into your spec_helper.rb or what have you.
+
+This gets you ready to use the DSL. Additionally, it forces Factis to forget
+everything that you have told it to memorize after each example. Because stale
+state information from one example to the next will make you an increddibly
+depressed platypus.
+
+The DSL methods are injected into Rspec via include, so they're available
+anywhere that example-level helpers are available. Primarily, in examples and
+before/after callbacks.
+
 ## How Do I Use This Thing? ##
 
 When I'm tracking state within a test, it's most likely a Cucumber feature.
@@ -138,8 +174,8 @@ 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 memorize and recalls them at your request. There is a generator
+Not much, really. It's just a simple DSL that hides away the things that you
+tell it to memorize 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

@@ -3,13 +3,13 @@ require File.expand_path('../lib/factis/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Dennis Walters"]
-  gem.email         = ["pooster@gmail.com"]
+  gem.email         = ["dennis@elevatorup.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.homepage      = "http://github.com/elevatorup/factis"
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)

data/lib/factis/memory.rb

@@ -1,10 +1,12 @@
 module Factis
+  # This is the workhorse of Factis. It's what does the actual tracking of
+  # facts.
   class Memory
 
     class << self
       private
       def init_memory!
-        @facts = Hash.new
+        @facts ||= Hash.new
       end
     end
 
@@ -13,7 +15,7 @@ module Factis
     # @return [Hash] all facts that have been stored
 
     def self.all_facts
-      init_memory! if @facts.nil?
+      init_memory!
       @facts
     end
 
@@ -30,7 +32,7 @@ module Factis
     #   is not active.
 
     def self.memorize(fact, content, options = {:overwrite => false})
-      init_memory! if @facts.nil?
+      init_memory!
       if known_fact?(fact)
         unless options[:overwrite] == true
           raise %{Cannot memorize a fact more than once: '#{fact}'}
@@ -46,7 +48,7 @@ module Factis
     # @return [Boolean] true if the key is known, false otherwise
 
     def self.known_fact?(fact)
-      init_memory! if @facts.nil?
+      init_memory!
       @facts.keys.include?(fact)
     end
 
@@ -59,7 +61,7 @@ module Factis
     # @raise [RuntimeError] if the key is not in the fact hash
 
     def self.forget(fact)
-      init_memory! if @facts.nil?
+      init_memory!
       unless known_fact?(fact)
         raise %{Trying to forget an unknown fact: '#{fact}'}
       end
@@ -75,7 +77,7 @@ module Factis
     # @raise [RuntimeError] if the key is not in the fact hash
 
     def self.recall(fact)
-      init_memory! if @facts.nil?
+      init_memory!
       unless known_fact?(fact)
         raise %{Trying to recall an unknown fact: '#{fact}'}
       end
@@ -85,7 +87,7 @@ module Factis
     # Clear the entire facts hash
 
     def self.reset!
-      init_memory! if @facts.nil?
+      init_memory!
       @facts.clear
     end
   end

data/lib/factis/rspec.rb

@@ -0,0 +1,9 @@
+require 'factis'
+
+RSpec.configure do |config|
+  config.include Factis
+  config.after(:each) do
+    puts "let's clear the facts!"
+    clear_all_facts!
+  end
+end

data/lib/factis/version.rb

@@ -1,3 +1,3 @@
 module Factis
-  VERSION = '0.0.8'
+  VERSION = '1.0.0'
 end

data/lib/generators/factis/cucumber_generator.rb

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

data/lib/generators/factis/rspec_generator.rb

@@ -0,0 +1,17 @@
+module Factis
+  module Generators
+
+    # This is a Rails generator to add Factis support to Rspec
+
+    class RspecGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc "Installs the Rspec support files for Factis"
+      
+      def copy_support
+        template "spec/support/factis.rb",
+          "spec/support/factis.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/spec/support/factis.rb

@@ -0,0 +1 @@
+require 'factis/rspec'

data/spec/factis/memory_spec.rb

@@ -90,14 +90,6 @@ describe Factis::Memory do
 
   end
 
-  describe %{.init_memory!} do
-    it %{should instantiate a new Hash for the memory} do
-      old = memory.all_facts.__id__
-      memory.class_eval('init_memory!')
-      memory.all_facts.__id__.should_not == old
-    end
-  end
-
   describe %{.reset!} do
     it %{should clear the memory} do
       memory.memorize(fact, content)

data/spec/factis_spec.rb

@@ -1,9 +1,13 @@
 require 'spec_helper'
 require 'factis'
 
+class Dummy
+  extend Factis
+end
+
 describe Factis do
   describe %{DSL} do
-    let(:factis) {Object.new.send(:extend, subject)}
+    let(:factis) {Dummy}
     let(:fact) {"Joe"}
     let(:content) {"likes pie"}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factis
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,7 +30,7 @@ dependencies:
 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
+- dennis@elevatorup.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -46,14 +46,17 @@ files:
 - lib/factis.rb
 - lib/factis/cucumber.rb
 - lib/factis/memory.rb
+- lib/factis/rspec.rb
 - lib/factis/version.rb
-- lib/generators/factis/install_generator.rb
-- lib/generators/templates/factis.rb
-- lib/generators/templates/factis_steps.rb
+- lib/generators/factis/cucumber_generator.rb
+- lib/generators/factis/rspec_generator.rb
+- lib/generators/templates/features/step_definitions/factis_steps.rb
+- lib/generators/templates/features/support/factis.rb
+- lib/generators/templates/spec/support/factis.rb
 - spec/factis/memory_spec.rb
 - spec/factis_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/ess/factis
+homepage: http://github.com/elevatorup/factis
 licenses:
 - MIT
 post_install_message: 
@@ -82,4 +85,3 @@ test_files:
 - spec/factis/memory_spec.rb
 - spec/factis_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/generators/factis/install_generator.rb

@@ -1,17 +0,0 @@
-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