olfactory 0.0.1

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 StreetEasy
+
+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,51 @@
+Olfactory
+==========
+
+### Introduction
+
+Olfactory is a factory extension for creating complex object sets, as a supplement to *factory_girl*, *fabrication*, or other factories.
+
+It introduces the concept of **templates**: an abstract group of objects. These can be used to make test setup much quicker and easier.
+
+Templates are not intended to replace most factories. They are most useful when:
+ - Subjects are weakly related or non-relational (e.g. not joined by ActiveRecord associations)
+ - You require a collection of objects that are not directly related (or easily built using factories)
+ - You'd prefer short-hand notation, or to abstract Factory implementation out of your tests
+   - e.g. Define a set of generic factories other programmers can use, without requiring them to understand the underlying details
+
+For example, given:
+```ruby
+context "networkable people" do
+  let(:phone_user) { create(:person, :devices => [phone]) }
+  let(:phone) { create(:android, apps => [facebook_app_one, twitter_app_one]) } # Factory(:device)
+  let(:facebook_phone) { create(:facebook, :platform => :phone) } # Factory(:app)
+  let(:twitter_phone) { create(:twitter, :platform => :phone) } # Factory(:app)
+  
+  let(:tablet_user) { create(:person, :devices => [tablet]) }
+  let(:tablet) { create(:tablet, apps => [facebook_tablet]) }  # Factory(:device)
+  let(:facebook_tablet) { create(:facebook, :platform => :tablet) }  # Factory(:app)
+  
+  let(:desktop_user) { create(:person, :devices => [desktop]) }
+  let(:desktop) { create(:desktop, apps => [twitter_desktop]) }  # Factory(:device)
+  let(:twitter_desktop) { create(:twitter, :platform => :desktop) }  # Factory(:app)
+  
+  it { expect(phone_user.can_network_with(tablet_user, desktop_user).to be_true }
+end
+```
+
+This is a lot of setup for a simple test case. We could write a bunch of named factories, but then the test logic simply ends up in a factory file rather than our test; not good.
+
+Instead, we can use templates to simplify our definitions:
+```ruby
+context "networkable people" do
+  let(:user_group) do
+    Olfactory.create_template :user_group do |group|
+      group.user :desktop_user { |user| user.phone { |phone| phone.app :facebook, :twitter } }
+      group.user :tablet_user { |user| user.tablet { |tablet| tablet.app :facebook } }
+      group.user :phone_user { |user| user.desktop { |desktop| desktop.app :twitter } }
+    end
+  end
+  
+  it { expect(user_group[:desktop_user].can_network_with(user_group[:tablet_user], user_group[:phone_user]).to be_true }
+end
+```

data/lib/olfactory/template.rb

@@ -0,0 +1,103 @@
+# -*- encoding : utf-8 -*-
+module Olfactory
+  class Template < Hash
+    attr_accessor :definition, :transients, :default_mode
+
+    def initialize(definition, options = {})
+      self.definition = definition
+      self.transients = options[:transients] ? options[:transients].clone : {}
+    end
+
+    def build(block, options = {})
+      if block # Block can be nil (when we want only defaults)
+        if options[:value]
+          block.call(self, options[:value])
+        else
+          block.call(self)
+        end
+      end
+      if options[:defaults].nil? || options[:defaults]
+        # Only set defaults if configuration wasn't specified
+        self.add_defaults
+      end
+
+      self
+    end
+
+    def method_missing(meth, *args, &block)
+      # Explicit fields
+      if (definition.t_macros.has_key?(meth) || definition.t_subtemplates.has_key?(meth) || definition.t_items.has_key?(meth))
+        if definition.t_macros.has_key?(meth)
+          field_type = :macro
+          definition_of_field = definition.t_macros[meth]
+          field_value = build_macro(definition_of_field, args, block)
+        elsif definition.t_subtemplates.has_key?(meth) && !(self.default_mode && self.has_key?(meth))
+          field_type = :subtemplate
+          definition_of_field = definition.t_subtemplates[meth]
+          subtemplate_name = definition_of_field.has_key?(:template) ? definition_of_field[:template] : meth
+          field_value = build_subtemplate(Olfactory.templates[subtemplate_name], args, block)
+        elsif definition.t_items.has_key?(meth) && !(self.default_mode && self.has_key?(meth))
+          field_type = :item
+          definition_of_field = definition.t_items[meth]
+          field_value = build_item(definition_of_field, args, block)
+        end
+        # Add field value to template
+        if field_type && field_type != :macro
+          if definition_of_field[:collection]
+            self[meth] = [] if !self.has_key?(meth)
+            if field_type == :subtemplate && field_value.class <= Array
+              self[meth].concat(field_value)
+            else
+              self[meth] << field_value
+            end
+          else
+            self[meth] = field_value
+          end
+        end
+      # No field definition
+      else
+        super # Unknown method
+      end
+    end
+    def transient(name, value)
+      self.transients[name] = value if !(self.default_mode && self.transients.has_key?(name))
+    end
+    def add_defaults
+      # Prevents overwrites of custom values by defaults
+      self.default_mode = true # Hackish for sure, but its efficient...
+
+      default_definition = definition.t_default
+      if default_definition[:evaluator]
+        default_definition[:evaluator].call(self)
+      elsif default_definition[:preset_name]
+        preset_definition = definition.find_preset_definition(default_definition[:preset_name])
+        preset_definition[:evaluator].call(self)
+      end
+
+      self.default_mode = false
+    end
+    def build_macro(macro_definition, args, block)
+      if macro_definition[:evaluator]
+        macro_definition[:evaluator].call(self, *args)
+      end
+    end
+    def build_subtemplate(subtemplate_definition, args, block)
+      if block
+        subtemplate_definition.build(block, :transients => self.transients)
+      else
+        subtemplate_definition.build_preset((args.count == 1 ? args.first : args), :transients => self.transients)
+      end
+    end
+    def build_item(item_definition, args, block)
+      if block
+        block.call(*args)
+      else
+        if item_definition[:evaluator]
+          item_definition[:evaluator].call(*args)
+        else
+          args.count == 1 ? args.first : argsnew
+        end
+      end
+    end
+  end
+end

data/lib/olfactory/template_definition.rb

@@ -0,0 +1,82 @@
+# -*- encoding : utf-8 -*-
+module Olfactory
+  class TemplateDefinition
+    attr_accessor :t_items, :t_subtemplates, :t_macros, :t_presets, :t_default
+
+    def initialize
+      self.t_items = {}
+      self.t_subtemplates = {}
+      self.t_macros = {}
+      self.t_presets = {}
+      self.t_default = {}
+    end
+
+    def build(block, options = {})
+      if options[:preset]
+        self.build_preset(options[:preset], options.reject { |k,v| k == :preset })
+      else
+        new_template = Template.new(self, options)
+        new_template.build(block, options)
+      end
+      new_template
+    end
+    def build_preset(preset_name, options = {})
+      if preset_name.class <= Integer
+        # Build multiple
+        Array.new(preset_name) { self.build(nil, options) }
+      elsif preset_definition = self.find_preset_definition(preset_name)
+        # Build single
+        new_template = Template.new(self, options)
+        preset_block = preset_definition[:evaluator]
+        if preset_definition[:preset_name].class == Regexp
+          new_template.build(preset_block, options.merge(:value => preset_name))
+        else
+          new_template.build(preset_block, options)
+        end
+      else
+        raise "Missing preset matching '#{preset_value}' for template!"
+      end
+    end
+
+    def find_preset_definition(preset_name)
+      preset_definition = self.t_presets[preset_name]
+      if preset_definition.nil?
+        # Try to find a regexp named preset that matches
+        preset_name = self.t_presets.keys.detect { |p_name| p_name.class == Regexp && p_name.match(preset_name.to_s) }
+        preset_definition = self.t_presets[preset_name] if preset_name
+      end
+      preset_definition
+    end
+
+    # Defines a value holding field
+    def has_one(name, options = {}, &block)
+      self.t_items[name] = { :evaluator => block }.merge(options)
+    end
+    def has_many(name, options = {}, &block)
+      self.t_items[name] = { :evaluator => block, :collection => true }.merge(options)
+    end
+
+    # Defines a hash-holding field
+    def embeds_one(name, options = {}, &block)
+      self.t_subtemplates[name] = { :evaluator => block }.merge(options)
+    end
+    def embeds_many(name, options = {}, &block)
+      self.t_subtemplates[name] = { :evaluator => block, :collection => true }.merge(options)
+    end
+
+    # Defines a macro
+    def macro(name, options = {}, &block)
+      self.t_macros[name] = { :evaluator => block }.merge(options)
+    end
+
+    # Defines a preset of values
+    def preset(name, options = {}, &block)
+      self.t_presets[name] = { :evaluator => block }.merge(options)
+    end
+
+    # Defines defaults
+    def default(preset_name = nil, options = {}, &block)
+      self.t_default = { :preset_name => preset_name, :evaluator => block }.merge(options)
+    end
+  end
+end

data/lib/olfactory/version.rb

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

data/lib/olfactory.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+require 'olfactory/template_definition'
+require 'olfactory/template'
+
+module Olfactory
+  @@templates = {}
+  def self.templates
+    @@templates
+  end
+
+  def self.template(name, &block)
+    new_template_definition = TemplateDefinition.new
+    block.call(new_template_definition)
+    self.templates[name] = new_template_definition
+  end
+
+  def self.build_template(name, options = {}, &block)
+    self.templates[name].build(block, options)
+  end
+
+  def self.reload
+    @@templates = {}
+  end
+end

data/olfactory.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require 'olfactory/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'olfactory'
+  s.version     = Olfactory::VERSION
+  s.summary     = "Olfactory is an extension for factory gems, which adds templates."
+  s.description = "Olfactory is an extension for factory gems, which adds templates that allow for easy creation of groups of objects."
+  s.authors     = ["David Elner"]
+  s.email       = 'david@davidelner.com'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {spec,features,gemfiles}/*`.split("\n")
+  s.homepage    = 'https://github.com/StreetEasy/olfactory'
+  s.license     = 'MIT'
+
+  s.require_paths = ['lib']
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+
+  s.add_development_dependency("rspec",    "~> 1.3.2")
+  s.add_development_dependency("pry")
+  s.add_development_dependency("pry-nav")
+  s.add_development_dependency("pry-stack_explorer")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'pry'
+require 'spec/autorun'
+
+require 'olfactory'
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+
+Spec::Runner.configure do |config|
+  config.after do
+    Olfactory.reload
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: olfactory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Elner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-nav
+  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: pry-stack_explorer
+  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: Olfactory is an extension for factory gems, which adds templates that
+  allow for easy creation of groups of objects.
+email: david@davidelner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- lib/olfactory.rb
+- lib/olfactory/template.rb
+- lib/olfactory/template_definition.rb
+- lib/olfactory/version.rb
+- olfactory.gemspec
+- spec/olfactory/template_definition_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/StreetEasy/olfactory
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: Olfactory is an extension for factory gems, which adds templates.
+test_files:
+- spec/olfactory/template_definition_spec.rb
+- spec/spec_helper.rb