spbtv_pickle 0.5.1

data/lib/pickle/email.rb

@@ -0,0 +1,87 @@
+module Pickle
+  module Email
+    # return the deliveries array, optionally selected by the passed fields
+    def emails(fields = nil)
+      @emails = ActionMailer::Base.deliveries.select {|m| email_has_fields?(m, fields)}
+    end
+
+    def email(ref, fields = nil)
+      (match = ref.match(/^#{capture_index_in_email}$/)) or raise ArgumentError, "argument should match #{match_email}"
+      @emails or raise RuntimeError, "Call #emails before calling #email"
+      index = parse_index(match[1])
+      email_has_fields?(@emails[index], fields) ? @emails[index] : nil
+    end
+
+    def email_has_fields?(email, fields)
+      parse_fields(fields).each do |key, val|
+        return false unless (Array(email.send(key)) & Array(val)).any?
+      end
+      true
+    end
+
+    def visit_in_email(email, link_text)
+      visit(parse_email_for_link(email, link_text))
+    end
+
+    def click_first_link_in_email(email)
+      link = links_in_email(email).first
+      visit link
+    end
+
+  protected
+    def open_in_browser(path) # :nodoc
+      require "launchy"
+      Launchy.open(path)
+    rescue LoadError
+      warn "Sorry, you need to install launchy to open emails: `gem install launchy`"
+    end
+
+    # Saves the emails out to RAILS_ROOT/tmp/ and opens it in the default
+    # web browser if on OS X. (depends on webrat)
+    def save_and_open_emails
+      emails_to_open = @emails || emails
+      filename = "pickle-email-#{Time.now.to_i}.html"
+      File.open(filename, "w") do |f|
+        emails_to_open.each_with_index do |e, i|
+          f.write "<h1>Email #{i+1}</h1><pre>#{e}</pre><hr />"
+        end
+      end
+      open_in_browser(filename)
+    end
+
+    def parse_email_for_link(email, text_or_regex)
+      url = parse_email_for_explicit_link(email, text_or_regex)
+      url ||= parse_email_for_anchor_text_link(email, text_or_regex)
+      raise "No link found matching #{text_or_regex.inspect} in #{email}" unless url
+      url
+    end
+
+    # e.g. confirm in http://confirm
+    def parse_email_for_explicit_link(email, regex)
+      regex = /#{Regexp.escape(regex)}/ unless regex.is_a?(Regexp)
+      links_in_email(email).detect { |link| link =~ regex }
+    end
+
+    # e.g. Click here in  <a href="http://confirm">Click here</a>
+    def parse_email_for_anchor_text_link(email, link_text)
+      if email.multipart?
+        body = email.html_part.body
+      else
+        body = email.body
+      end
+      if match_data = body.match(%r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>})
+        match_data[1]
+      end
+    end
+
+    def links_in_email(email, protos=['http', 'https'])
+      if email.multipart?
+        body = email.html_part.body
+      else
+        body = email.body
+      end
+      URI.extract(body.to_s, protos)
+    end
+
+  end
+end

data/lib/pickle/email/parser.rb

@@ -0,0 +1,18 @@
+module Pickle
+  module Email
+    # add ability to parse emails
+    module Parser
+      def match_email
+        "(?:#{match_prefix}?(?:#{match_index} )?email)"
+      end
+
+      def capture_email
+        "(#{match_email})"
+      end
+
+      def capture_index_in_email
+        "(?:#{match_prefix}?(?:#{capture_index} )?email)"
+      end
+    end
+  end
+end

data/lib/pickle/email/world.rb

@@ -0,0 +1,13 @@
+require 'pickle'
+require 'pickle/email'
+require 'pickle/email/parser'
+
+# add email parser expressions
+Pickle::Parser.send :include, Pickle::Email::Parser
+
+World(Pickle::Email)
+
+# shortcuts for use in step regexps
+class << self
+  delegate :capture_email, :to => 'Pickle.parser'
+end

data/lib/pickle/parser.rb

@@ -0,0 +1,65 @@
+require 'pickle/parser/matchers'
+
+module Pickle
+  class Parser
+    include Matchers
+
+    attr_reader :config
+
+    def initialize(options = {})
+      @config = options[:config] || raise(ArgumentError, "Parser.new requires a :config")
+    end
+
+    # given a string like 'foo: "bar", bar: "baz"' returns {"foo" => "bar", "bar" => "baz"}
+    def parse_fields(fields)
+      if fields.blank?
+        {}
+      elsif fields =~ /^#{match_fields}$/
+        fields.scan(/(#{match_field})(?:,|$)/).inject({}) do |m, match|
+          m.merge(parse_field(match[0]))
+        end
+      else
+        raise ArgumentError, "The fields string is not in the correct format.\n\n'#{fields}' did not match: #{match_fields}"
+      end
+    end
+
+    # given a string like 'foo: expr' returns {key => value}
+    def parse_field(field)
+      if field =~ /^#{capture_key_and_value_in_field}$/
+        { $1 => eval($2) }
+      else
+        raise ArgumentError, "The field argument is not in the correct format.\n\n'#{field}' did not match: #{match_field}"
+      end
+    end
+
+    # returns really underscored name
+    def canonical(str)
+      str.to_s.underscore.gsub(' ','_').gsub('/','_')
+    end
+
+    # return [factory_name, name or integer index]
+    def parse_model(model_name)
+      apply_mappings!(model_name)
+      if /#{capture_index} #{capture_factory}$/ =~ model_name
+        [canonical($2), parse_index($1)]
+      elsif /#{capture_factory}#{capture_name_in_label}?$/ =~ model_name
+        [canonical($1), canonical($2)]
+      end
+    end
+
+    def parse_index(index)
+      case index
+      when nil, '', 'last' then -1
+      when /#{capture_number_in_ordinal}/ then $1.to_i - 1
+      when 'first' then 0
+      end
+    end
+
+  private
+    def apply_mappings!(string)
+      config.mappings.each do |mapping|
+        string.sub! /^#{mapping.search}$/, mapping.replacement
+      end
+    end
+  end
+end

data/lib/pickle/parser/matchers.rb

@@ -0,0 +1,87 @@
+module Pickle
+  class Parser
+    module Matchers
+      def match_ordinal
+        '(?:\d+(?:st|nd|rd|th))'
+      end
+
+      def match_index
+        "(?:first|last|#{match_ordinal})"
+      end
+
+      def match_prefix
+        '(?:(?:a|an|another|the|that) )'
+      end
+
+      def match_quoted
+        '(?:\\\\"|[^\\"]|\\.)*'
+      end
+
+      def match_label
+        "(?::? \"#{match_quoted}\")"
+      end
+
+      def match_value
+        "(?:\"#{match_quoted}\"|nil|true|false|[+-]?[0-9_]+(?:\\.\\d+)?)"
+      end
+
+      def match_field
+        "(?:\\w+: #{match_value})"
+      end
+
+      def match_fields
+        "(?:#{match_field}, )*#{match_field}"
+      end
+
+      def match_mapping
+        "(?:#{config.mappings.map(&:search).join('|')})"
+      end
+
+      def match_factory
+        "(?:#{config.factories.keys.map{|n| n.gsub('_','[_ ]')}.join('|')})"
+      end
+
+      def match_plural_factory
+        "(?:#{config.factories.keys.map{|n| n.pluralize.gsub('_','[_ ]')}.join('|')})"
+      end
+
+      def match_indexed_model
+        "(?:(?:#{match_index} )?#{match_factory})"
+      end
+
+      def match_labeled_model
+        "(?:#{match_factory}#{match_label})"
+      end
+
+      def match_model
+        "(?:#{match_mapping}|#{match_prefix}?(?:#{match_indexed_model}|#{match_labeled_model}))"
+      end
+
+      def match_predicate
+        "(?:#{config.predicates.map{|m| m.to_s.sub(/^has_/,'').sub(/\?$/,'').gsub('_','[_ ]')}.join('|')})"
+      end
+
+      # create capture analogues of match methods
+      instance_methods.select{|m| m =~ /^match_/}.each do |method|
+        eval <<-end_eval
+          def #{method.to_s.sub('match_', 'capture_')}         # def capture_field
+            "(" + #{method} + ")"                         #   "(" + match_field + ")"
+          end                                             # end
+        end_eval
+      end
+
+      # special capture methods
+      def capture_number_in_ordinal
+        '(?:(\d+)(?:st|nd|rd|th))'
+      end
+
+      def capture_name_in_label
+        "(?::? \"(#{match_quoted})\")"
+      end
+
+      def capture_key_and_value_in_field
+        "(?:(\\w+): #{capture_value})"
+      end
+    end
+  end
+end

data/lib/pickle/path.rb

@@ -0,0 +1,45 @@
+module Pickle
+  module Path
+    # given args of pickle model name, and an optional extra action, or segment, will attempt to find
+    # a matching named route
+    #
+    #   path_to_pickle 'the user', :action => 'edit'       # => /users/3/edit
+    #   path_to_pickle 'the user', 'the comment'           # => /users/3/comments/1
+    #   path_to_pickle 'the user', :segment => 'comments'  # => /users/3/comments
+    #
+    # If you don;t know if the 'extra' part of the path is an action or a segment, then just
+    # pass it as 'extra' and this method will run through the possibilities
+    #
+    #   path_to_pickle 'the user', :extra => 'new comment' # => /users/3/comments/new
+    def path_to_pickle(*pickle_names)
+      options = pickle_names.extract_options!
+      resources = pickle_names.map{|n| model(n) || n.to_sym}
+      if options[:extra]
+        parts = options[:extra].underscore.gsub(' ','_').split("_")
+        find_pickle_path_using_action_segment_combinations(resources, parts)
+      else
+        pickle_path_for_resources_action_segment(resources, options[:action], options[:segment])
+      end or raise "Could not figure out a path for #{pickle_names.inspect} #{options.inspect}"
+    end
+
+  protected
+    def find_pickle_path_using_action_segment_combinations(resources, parts)
+      path = nil
+      (0..parts.length).each do |idx|
+        action  = parts.slice(0, idx).join('_')
+        segment = parts.slice(idx, parts.length).join('_')
+        path = pickle_path_for_resources_action_segment(resources, action, segment) and break
+      end
+      path
+    end
+
+    def pickle_path_for_resources_action_segment(resources, action, segment)
+      action.blank? or action = action.downcase.gsub(' ','_')
+      segment.blank? or segment = segment.downcase.gsub(' ','_')
+      resource_names = resources.map{|s| s.is_a?(Symbol) ? s.to_s : s.class.name.underscore.gsub('/', '_')}.join("_")
+      models = resources.reject{|s| s.is_a?(Symbol)}
+      parts = [action, resource_names, segment].reject(&:blank?)
+      send("#{parts.join('_')}_path", *models) rescue nil
+    end
+  end
+end

data/lib/pickle/path/world.rb

@@ -0,0 +1,5 @@
+require 'pickle'
+require 'pickle/path'
+
+# make world pickle/path aware
+World(Pickle::Path)

data/lib/pickle/session.rb

@@ -0,0 +1,244 @@
+module Pickle
+  module Session
+    class ModelNotKnownError < RuntimeError
+      attr_reader :name
+
+      def initialize(name, message = nil)
+        @name = name
+        @message = message.presence || "The model: '#{name}' is not known in this scenario.  Use #create_model to create, or #find_model to find, and store a reference in this scenario."
+      end
+
+      def to_s
+        @message
+      end
+    end
+
+    class ModelNotFoundError < RuntimeError
+    end
+
+    class << self
+      def included(world_class)
+        proxy_to_pickle_parser(world_class)
+      end
+
+      def extended(world_object)
+        proxy_to_pickle_parser(class << world_object; self; end) # metaclass is not 2.1 compatible
+      end
+
+    protected
+      def proxy_to_pickle_parser(world_class)
+        world_class.class_eval do
+          unless methods.include?('method_missing_with_pickle_parser')
+            alias_method_chain :method_missing, :pickle_parser
+            alias_method_chain :respond_to?, :pickle_parser
+          end
+        end
+      end
+    end
+
+    def create_model(pickle_ref, fields = nil)
+      create_or_build_model(:create, 1, pickle_ref, fields)
+    end
+
+    def create_models(count, pickle_ref, fields = nil)
+      create_or_build_model(:create, count, pickle_ref, fields)
+    end
+
+    def build_model(pickle_ref, fields = nil)
+      create_or_build_model(:build, 1, pickle_ref, fields)
+    end
+
+    def build_models(count, pickle_ref, fields = nil)
+      create_or_build_model(:build, count, pickle_ref, fields)
+    end
+
+    # if a column exists in the table which matches the singular factory name, this is used as the pickle ref
+    def create_models_from_table(plural_factory, table)
+      factory = plural_factory.singularize
+      table.hashes.map do |hash|
+        pickle_ref = factory + (hash[factory] ? " \"#{hash.delete(factory)}\"" : "")
+        create_model(pickle_ref, hash)
+      end
+    end
+
+    def find_model(a_model_name, fields = nil)
+      factory, name = *parse_model(a_model_name)
+
+      raise ArgumentError, "Can't find a model with an ordinal (e.g. 1st user)" if name.is_a?(Integer)
+
+      model_class = pickle_config.factories[factory].klass
+      fields      = fields.is_a?(Hash) ? parse_hash(fields) : parse_fields(fields)
+      conditions  = convert_models_to_attributes(model_class, fields)
+      record      = Pickle::Adapter.find_first_model(model_class, conditions)
+
+      store_model(factory, name, record) if record
+
+      record
+    end
+
+    def find_model!(name, fields = nil)
+      find_model(name, fields) or raise ModelNotFoundError, "Can't find #{name}#{" with #{fields}" if fields.present?} from the orm in this scenario"
+    end
+
+    def find_models(factory, fields = nil)
+      factory = pickle_parser.canonical(factory)
+
+      models_by_index(factory).clear
+
+      model_class = pickle_config.factories[factory].klass
+      conditions  = convert_models_to_attributes(model_class, parse_fields(fields))
+      records     = Pickle::Adapter.find_all_models(model_class, conditions)
+
+      records.each {|record| store_model(factory, nil, record)}
+    end
+
+    # if a column exists in the table which matches the singular factory name, this is used as the pickle ref
+    def find_models_from_table(plural_factory, table)
+      factory = plural_factory.singularize
+      table.hashes.map do |hash|
+        pickle_ref = factory + (hash[factory] ? " \"#{hash.delete(factory)}\"" : "")
+        find_model(pickle_ref, hash)
+      end
+    end
+
+    # return the original model stored by create_model or find_model
+    def created_model(name)
+      factory, name_or_index = *parse_model(name)
+
+      if name_or_index.blank?
+        models_by_index(factory).last
+      elsif name_or_index.is_a?(Integer)
+        models_by_index(factory)[name_or_index]
+      else
+        models_by_name(factory)[name_or_index] or raise ModelNotKnownError, name
+      end
+    end
+
+    # predicate version which raises no errors
+    def created_model?(name)
+      (created_model(name) rescue nil) ? true : false
+    end
+
+    # return a newly selected model
+    def model(name)
+      model = created_model(name)
+      return nil unless model
+      Pickle::Adapter.get_model(model.class, model.id)
+    end
+
+    # predicate version which raises no errors
+    def model?(name)
+      (model(name) rescue nil) ? true : false
+    end
+
+    # like model, but raise an error if it can't be found
+    def model!(name)
+      model(name) or raise ModelNotKnownError, name
+    end
+
+    # like created_model, but raise an error if it can't be found
+    def created_model!(name)
+      created_model(name) or raise ModelNotKnownError, name
+    end
+
+    # return all original models of specified type
+    def created_models(factory)
+      models_by_index(factory)
+    end
+
+    # return all models of specified type (freshly selected from the database)
+    def models(factory)
+      created_models(factory).map do |model|
+        Pickle::Adapter.get_model(model.class, model.id)
+      end
+    end
+
+    def respond_to_with_pickle_parser?(method, include_private = false)
+      respond_to_without_pickle_parser?(method, include_private) || pickle_parser.respond_to?(method, include_private)
+    end
+
+  protected
+    def create_or_build_model(method, count, pickle_ref, fields = nil)
+      factory, label = *parse_model(pickle_ref)
+      raise ArgumentError, "Can't #{method} with an ordinal (e.g. 1st user)" if label.is_a?(Integer)
+      fields = fields.is_a?(Hash) ? parse_hash(fields) : parse_fields(fields)
+
+      count.to_i.times.map do
+        record = pickle_config.factories[factory].send(method, fields)
+        store_model(factory, label, record)
+        return record if count == 1
+        record
+      end
+    end
+
+    def method_missing_with_pickle_parser(method, *args, &block)
+      if pickle_parser.respond_to?(method)
+        pickle_parser.send(method, *args, &block)
+      else
+        method_missing_without_pickle_parser(method, *args, &block)
+      end
+    end
+
+    def pickle_parser=(parser)
+      parser.session = self
+      @pickle_parser = parser
+    end
+
+    def pickle_parser
+      @pickle_parser or self.pickle_parser = Pickle.parser
+    end
+
+    def pickle_config
+      pickle_parser.config
+    end
+
+    def convert_models_to_attributes(klass, attrs)
+      columns = nil
+      conditions = {}
+
+      attrs.each do |key, val|
+        if supported = supported_association_model_type?(val) or val.nil?
+          columns ||= Pickle::Adapter.column_names(klass)
+        end
+
+        if supported && columns.include?("#{key}_id")
+          conditions["#{key}_id"] = val.id
+          conditions["#{key}_type"] = val.class.base_class.name if columns.include?("#{key}_type")
+        elsif val.nil? && columns.include?("#{key}_id") && !columns.include?("#{key}")
+          # NOOP
+        else
+          conditions[key] = val
+        end
+      end
+
+      conditions
+    end
+
+    def supported_association_model_type?(associated_model)
+      (defined?(ActiveRecord::Base) && associated_model.is_a?(ActiveRecord::Base)) ||
+        (defined?(DataMapper::Model) && associated_model.is_a?(DataMapper::Model)) ||
+        (defined?(Mongoid::Document) && associated_model.is_a?(Mongoid::Document))
+    end
+
+    def models_by_name(factory)
+      @models_by_name ||= {}
+      @models_by_name[pickle_parser.canonical(factory)] ||= {}
+    end
+
+    def models_by_index(factory)
+      @models_by_index ||= {}
+      @models_by_index[pickle_parser.canonical(factory)] ||= []
+    end
+
+    # if the factory name != the model name, store under both names
+    def store_model(factory, name, record)
+      store_record(record.class.name, name, record) unless pickle_parser.canonical(factory) == pickle_parser.canonical(record.class.name)
+      store_record(factory, name, record)
+    end
+
+    def store_record(factory, name, record)
+      models_by_name(factory)[name] = record
+      models_by_index(factory) << record
+    end
+  end
+end