jury 0.1.0

data/bin/jury

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'jury/command_line_interface'
+Jury::CommandLineInterface.new.main([$0]+ARGV)
+

data/lib/jury.rb

@@ -0,0 +1,5 @@
+class Jury
+  def self.hi
+    puts "Hello world"
+  end
+end

data/lib/jury/command_line_interface.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+require 'jury/tchk'
+
+require 'pp'
+
+$VALID_COMMANDS = %w[help init]
+
+
+module Jury
+  class CommandLineInterface
+    include Jury::Tchk
+
+    def create_filesystem   # CB(2), BB(4)
+      # PRECONDITION -- current_directory not inside/under template_directory
+      current_directory = Dir.pwd
+      template_directory = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'template'))
+      set_of_files = Dir.glob(File.join(template_directory, "*"))
+      FileUtils.cp_r set_of_files, current_directory
+
+      # The above copy will not create empty directories, it seems.  Either that,
+      # or gem metadata refuses to accept that an empty template/spec directory
+      # holds value to me.  To work around this problem, we will need to create
+      # this directory manually if it doesn't already exist.
+      spec_directory = File.join(current_directory, "spec")
+      FileUtils.mkdir(spec_directory) if !File.directory?(spec_directory)
+    end
+
+    def show_help_message   # BB(3,1), BB(3,3)
+      puts <<EOM
+USAGE: #{@argv[0]} <command> <...>
+
+Commands supported includes:
+  init - initialize a new Jury instance.
+  help - show this message.
+EOM
+    end
+
+    def main(argv)  # US(3)
+      type_error if !is_array_of_T(argv, String, 1)
+
+      @argv = argv
+      if !argv[1].nil? then
+        command = argv[1].downcase
+      else
+        command = 'help'
+      end
+
+      case command
+      when 'init'
+        create_filesystem  # BB(3,2)
+      else
+        show_help_message  # BB(3,1) /\ BB(3,3)
+      end
+    end
+  end
+end

data/lib/jury/tchk.rb

@@ -0,0 +1,26 @@
+module Jury
+  module Tchk
+    def type_error
+      raise Exception.new, "Type error"
+    end
+
+    def is_string(s)
+      return s.kind_of?(String)
+    end
+
+    def is_array_of_T(ary, type = nil, minimum_length = 0)
+      is_an_array = ary.kind_of?(Array)
+
+      if !type.nil? then
+        type_error if !type.kind_of?(Class)
+        all_elements_of_type = ary.all? { |e| e.kind_of?(type) }
+      else
+        all_elements_of_type = true
+      end
+
+      minimum_length_met = ary.size >= minimum_length
+
+      return is_an_array && all_elements_of_type && minimum_length_met
+    end
+  end
+end

data/template/config-example.rb

@@ -0,0 +1,10 @@
+# This setting determines the web app installation's first page.  When in-
+# stantiating HomePage.new, the browser will open this URL.
+
+$home_page = "http://staging.example.com:3000"
+
+# If you defined a User class for your web-app, and you needed a globally de-
+# fined user, e.g., for an administrator account, you could define it like
+# this.
+#
+# $admin_user = User.new(:email => "sysop", :password => "sysop-password")

data/template/jury.rb

@@ -0,0 +1,47 @@
+# Include Capybara DSL
+
+require 'capybara/rspec'
+include Capybara::DSL
+
+# Support for multiple, concurrently-running Jury instances.
+
+begin
+  e = ENV['CAPYBARA_PORT_OFFSET'].to_i
+rescue
+  e = 0
+end
+Capybara.server_port = 8800 + e
+
+# Include commonly used testing tools
+
+require 'lib/page_object'
+require 'lib/helper'
+require 'lib/user'
+require 'lib/credit_card'
+
+# Make all the available helpers known to Jury.
+
+Dir["lib/helpers/*_helper.rb"].each {|file| require file}
+
+# Import all of our configuration settings.
+
+unless ENV['JURY_CONFIG'] then
+  puts <<-EOH
+
+You must define the JURY_CONFIG environment variable first.  This environment
+variable refers to a specific configuration file.  For example, if you have a
+configuration file named config-beta.rb inside your Jury project's directory,
+then you can invoke your tests like so:
+
+    JURY_CONFIG=config-beta rspec -I.  # ...etc...
+
+Similarly, if you have a configuration located outside of the Jury project's
+directory, you can invoke as follows:
+
+    JURY_CONFIG=/tmp/my_config.rb rspec -I.  # ..etc..
+
+EOH
+  exit 1
+end
+require ENV['JURY_CONFIG']
+

data/template/lib/helper.rb

@@ -0,0 +1,20 @@
+# Responsibilities
+#
+# - Maintain state common to all Helper classes.
+
+class Helper
+  def initialize(args={})
+    args.should be_kind_of(Hash)
+
+    @session = nil
+    if args[:session] then
+      @session = args[:session]
+      @session.should be_kind_of(Capybara::Session)
+    end
+  end
+
+  def on_home_page?
+    false
+  end
+end
+

data/template/lib/helpers/home_page_helper.rb

@@ -0,0 +1,9 @@
+module Helpers
+  class HomePageHelper < Helper
+    def on_home_page?
+      true
+    end
+
+    # . . . additional services go here.
+  end
+end

data/template/lib/page_object.rb

@@ -0,0 +1,62 @@
+# Responsibilities
+# - Visit URL
+# - Detect and handle redirects
+# - Proxy undefined methods to the appropriate helper class
+# - Return current session URL
+
+require 'lib/path_to_helper_mapper'
+
+class PageObject
+  attr_reader :session
+
+  def initialize(args)
+    @session = nil
+    @helper = nil
+    @pthm = PathToHelperMapper.new(args)
+
+    if args[:session] then
+      @session = args[:session]
+      @session.should be_kind_of(Capybara::Session)
+    end
+
+    self
+  end
+
+  def visit(url)
+    url.should be_kind_of(String)
+    url.size.should > 0
+
+    @session.visit(url)
+    choose_helper
+    self
+  end
+
+  def current_url_without_query_parameters
+    @session.current_url.split(/\?/).first
+  end
+
+  def method_missing(msg, *args, &blk)
+    results = @helper.send(msg, *args, &blk)
+    choose_helper
+    return results
+  end
+
+  def have_content?(text)
+    @session.have_content?(text)
+  end
+
+  private
+
+  def choose_helper
+    @helper = @pthm.helper_for_path(@session.current_path)
+  end
+end
+
+
+# Convenience class
+class HomePage < PageObject
+  def initialize
+    super(:session => page, :map_filename => "url-mappings.yaml").visit($home_page)
+  end
+end
+

data/template/lib/path_to_helper_mapper.rb

@@ -0,0 +1,76 @@
+# Responsibilities:
+# - Translate URL to helper object
+# - Configure set of mappings used in aforementioned translation.
+
+require 'rspec/expectations'
+require 'yaml'
+
+include RSpec::Matchers
+
+class String
+  def starts_with?(prefix)
+    self[0..prefix.size-1].eql?(prefix)
+  end
+end
+
+class PathToHelperMapper
+  def initialize(args={})
+    args.should be_kind_of(Hash)
+
+    @session = nil
+    if args[:session] then
+      @session = args[:session]
+      @session.should be_kind_of(Capybara::Session)
+    end
+
+    if args[:map_filename] then
+      map_filename = args[:map_filename]
+      map_filename.should be_kind_of(String)
+      map_filename.size.should > 0
+      mappings = File.open(map_filename, "r").read
+    end
+
+    if args[:map_file] then
+      map_file = args[:map_file]
+      map_file.should be_kind_of(File)
+      mappings = map_file.read
+    end
+
+    if args[:mappings] then
+      mappings = args[:mappings]
+      mappings.should be_kind_of(String)
+    end
+
+    mappings.should_not be_nil
+
+    @prefix_mapping = YAML.load(mappings)
+    @memo = {}
+  end
+
+  def helper_for_path(p)
+    p.should be_kind_of(String)
+
+    class_name = helper_class_for_path(p)
+    class_object = Kernel.const_get("Helpers").const_get(class_name)
+    @memo[class_object] = class_object.new(:session => @session) if @memo[class_object].nil?
+    return @memo[class_object]
+  end
+
+  private
+
+  def helper_class_for_path(p)
+    # Normalize URL to eliminate special cases.
+    p = '/' if p.size == 0
+
+    # Find all helpers that could potentially service the URL we're on.
+    class_mapping = @prefix_mapping.select{|k,_| p.starts_with?(k)}
+
+    # Choose the most specific handler (based on URL longest-prefix match).
+    class_mapping = class_mapping.sort {|a,b| b.first.size <=> a.first.size}
+
+    # Return the helper's class name.
+    class_name = class_mapping.first[1]
+    class_name.should be_kind_of(String)
+    return class_name
+  end
+end

data/template/url-mappings.yaml

@@ -0,0 +1 @@
+"/": HomePageHelper

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: jury
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Samuel A. Falvo II
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-07 00:00:00.000000000 Z
+dependencies: []
+description: ! 'A minimalist acceptance testing framework using page object pattern.  It
+
+  greatly simplifies the task of constructing, using, and maintaining page
+
+  objects in a Ruby/Capybara/RSpec environment.
+
+'
+email: kc5tja@arrl.net
+executables:
+- jury
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jury.rb
+- lib/jury/command_line_interface.rb
+- lib/jury/tchk.rb
+- bin/jury
+- template/config-example.rb
+- template/jury.rb
+- template/lib/helper.rb
+- template/lib/helpers/home_page_helper.rb
+- template/lib/page_object.rb
+- template/lib/path_to_helper_mapper.rb
+- template/url-mappings.yaml
+homepage: http://github.com/plumdistrict/jury
+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.17
+signing_key: 
+specification_version: 3
+summary: A minimalist acceptance testing framework using page object pattern.
+test_files: []