RubyGems - gamera - Versions diffs - 0.1.0 - Mend

gamera 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

checksums.yaml +7 -0
data/lib/gamera.rb +9 -0
data/lib/gamera/builder.rb +244 -0
data/lib/gamera/builders/sequel_fixture_builder.rb +249 -0
data/lib/gamera/exceptions.rb +32 -0
data/lib/gamera/general_proxy.rb +83 -0
data/lib/gamera/page.rb +203 -0
data/lib/gamera/page_sections/form.rb +150 -0
data/lib/gamera/page_sections/table.rb +231 -0
data/lib/gamera/utils/database_cleaner.rb +75 -0
data/lib/pry_setup.rb +34 -0
metadata +259 -0

data/lib/gamera/page_sections/table.rb ADDED

@@ -0,0 +1,231 @@
+# encoding:utf-8
+#--
+# The MIT License (MIT)
+#
+# Copyright (c) 2015, The Gamera Development Team. See the COPYRIGHT file at
+# the top-level directory of this distribution and at
+# http://github.com/gamera-team/gamera/COPYRIGHT.
+#
+# 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.
+#++
+require 'capybara'
+module Gamera
+  module PageSections
+    # This class represents a table on a web page. For example, if you had
+    # a page like
+    #
+    #   <html>
+    #     <body>
+    #       <p>Example table</p>
+    #       <table>
+    #         <tr>
+    #           <th>Item</th>
+    #           <th>Wholesale Cost</th>
+    #           <th>Retail Cost</th>
+    #           <th></th>
+    #           <th></th>
+    #         </tr>
+    #         <tr>
+    #           <td>Red Hat</td>
+    #           <td>2.00</td>
+    #           <td>15.00</td>
+    #           <td><a href="/item/12/edit">Edit</a></td>
+    #           <td><a href="/item/12/delete">Delete</a></td>
+    #         </tr>
+    #         <tr>
+    #           <td>Skull cap</td>
+    #           <td>2.00</td>
+    #           <td>27.00</td>
+    #           <td><a href="/item/1/edit">Edit</a></td>
+    #           <td><a href="/item/1/delete">Delete</a></td>
+    #         </tr>
+    #       </table>
+    #     </body>
+    #   </html>
+    #
+    # you could include this in a page object class like so:
+    #
+    #   class HatPage < Gamera::Page
+    #     include Forwardable
+    #     include Gamera::PageSections
+    #
+    #     attr_reader :registration_form, :table
+    #
+    #     def initialize
+    #       super(path_join(BASE_URL, '/hat'), %r{hat})
+    #
+    #       headers = ['Item', 'Wholesale Cost', 'Retail Cost']
+    #       @registration_form = Table.new(headers: headers, row_name:hat,
+    #                                      name_column: 'Item')
+    #       def_delegators :hat_table,
+    #                      :hat, :hats,
+    #                      :has_hat?, :has_hats?,
+    #                      :edit_hat, :delete_hat
+    #     end
+    #   end
+    #
+    class Table < DelegateClass(Capybara::Node::Element)
+      include Capybara::DSL
+     # @param headers [Array] An array of the strings from the tables header row
+      # @param row_name [String] A label that can be used to create more readable versions of general row methods
+      # @param plural_row_name [String] Plural form of [row_name]
+      # @param name_column [String] The column heading for the column which contains each row's name
+      # @param row_css [String] The CSS selector which is used to find individual rows in the table
+      # @param row_class [Class] The class which will represent a table row
+      # @param row_editor [Class] A class which defines the edit behavior for a row
+      # @param row_deleter [Class] A class which defines the edit behavior for a row
+      def initialize(headers:,
+                     row_name:,
+                     plural_row_name: nil,
+                     name_column: 'Name',
+                     row_css: 'tr + tr', # all tr's except the first one (which is almost always a table header)
+                     row_class: TableRow,
+                     row_editor: RowEditor.new,
+                     row_deleter: RowDeleter.new
+                    )
+        @row_css = row_css
+        @headers = headers
+        @row_class = row_class
+        @row_editor = row_editor
+        @row_deleter = row_deleter
+        @row_name = row_name
+        @plural_row_name = plural_row_name
+        @name_column = name_column.downcase.gsub(' ', '_').gsub(/[^a-z0-9_]+/, '')
+        add_custom_function_names
+      end
+      # Retrieves an array of rows from the table
+      #
+      # @return [Array] An array of row_class objects
+      def rows
+        has_rows?
+        all(row_css).map { |r| row_class.new(r, headers) }
+      end
+      # Finds and returns a row from the table
+      #
+      # @param name [String] [RegExp] The name to look for in the table's specified name column.
+      # @return [row_class] A row_class object that has the matching name or nil
+      def row_named(name)
+        if name.is_a? String
+          rows.detect { |r| r.send(name_column) == name } if has_row?(name)
+        elsif name.is_a? Regexp
+          rows.detect { |r| name.match r.send(name_column) } if has_row?(name)
+        end
+      end
+      # Checks for the existence of a row with the given name
+      #
+      # @param name [String] The name to look for in the table's specified name column.
+      # @return [Boolean] True if a row with the specified name is found, false
+      # otherwise
+      def has_row?(name)
+        page.has_selector?(row_css, text: name)
+      end
+      # Checks to see if the table has any rows
+      #
+      # @return [Boolean] True if the row selector is found, false otherwise
+      def has_rows?
+        has_selector?(row_css)
+      end
+      # Delete all of the rows from the table
+      def delete_all_rows
+        while has_rows?
+          r = rows.first.send(name_column)
+          delete_row(r)
+          has_row?(r)
+        end
+      end
+      # Start the delete process for the row matching the specified name
+      def delete_row(name)
+        row_deleter.delete(row_named(name))
+      end
+      # Start the edit process for the row matching the specified name
+      def edit_row(name)
+        row_editor.edit(row_named(name))
+      end
+      private
+      attr_reader :headers, :row_css, :row_name, :name_column, :row_class,
+        :row_editor, :row_deleter
+      def add_custom_function_names
+        row_name = @row_name # The attr_reader wasn't working here
+        plural_row_name = @plural_row_name
+        rows_name = plural_row_name ? plural_row_name.to_sym : "#{row_name}s".to_sym
+        has_row_name = "has_#{row_name}?".to_sym
+        has_rows_name = plural_row_name ? "has_#{plural_row_name}?".to_sym : "has_#{row_name}s?".to_sym
+        delete_all_rows_name = plural_row_name ? "delete_all_#{plural_row_name}".to_sym : "delete_all_#{row_name}s".to_sym
+        delete_row_name = "delete_#{row_name}".to_sym
+        edit_row_name = "edit_#{row_name}".to_sym
+        self.class.instance_eval do
+          alias_method rows_name, :rows
+          alias_method has_row_name, :has_row?
+          alias_method has_rows_name, :has_rows?
+          alias_method delete_all_rows_name, :delete_all_rows
+          alias_method delete_row_name, :delete_row
+          alias_method edit_row_name, :edit_row
+          alias_method row_name, :row_named
+        end
+      end
+    end
+    # Default class used to represent a row in a table
+    class TableRow < DelegateClass(Capybara::Node::Element)
+      # @param row_css [String] The css selector for the row
+      # @param headers [Array] An array of the strings from the tables header row
+      def initialize(row_css, headers)
+        super(row_css)
+        headers.each_with_index do |header, i|
+          cell_name = header.downcase.gsub(' ', '_').gsub(/[^a-z0-9_]+/, '')
+          self.class.send(:define_method, cell_name) do
+            find("td:nth-child(#{i + 1})").text
+          end
+        end
+      end
+    end
+    # Wrapper class for row edit action
+    class RowEditor
+      def edit(table_row)
+        table_row.find_link('Edit').click
+      end
+    end
+    # Wrapper class for row delete action
+    class RowDeleter
+      def delete(table_row)
+        table_row.find_link('Delete').click
+      end
+    end
+  end
+end

data/lib/gamera/utils/database_cleaner.rb ADDED

@@ -0,0 +1,75 @@
+# encoding:utf-8
+#--
+# The MIT License (MIT)
+#
+# Copyright (c) 2015, The Gamera Development Team. See the COPYRIGHT file at
+# the top-level directory of this distribution and at
+# http://github.com/gamera-team/gamera/COPYRIGHT.
+#
+# 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.
+#++
+require 'sequel'
+module Gamera
+  module Utils
+    # Cleans a database by truncating the tables
+    #
+    # Usage:
+    #
+    #   Gamera::Utils::DatabaseCleaner.new(connection).clean
+    #
+    # Or:
+    #
+    #   Gamera::Utils::DatabaseCleaner.new(connection, tables).clean
+    #
+    # +connection+ is a Sequel database connection.
+    # +tables+ is an array of table names (string or symbol).
+    #
+    # If +tables+ is given, only the tables supplied
+    # will be truncated. If +tables+ is not given,
+    # all tables in the database will be truncated.
+    class DatabaseCleaner
+      def initialize(connection, tables = nil)
+        @db = connection
+        @tables = tables || all_table_names
+      end
+      # Removes all data from the initialized tables.
+      # If no tables were given, removes all data from
+      # all tables in the database.
+      #
+      # Cleans via truncation.
+      def clean
+        tables.each do |table|
+          db[table].truncate
+        end
+        nil
+      end
+      private
+      attr_reader :db, :tables
+      def all_table_names
+        db.tables
+      end
+    end
+  end
+end

data/lib/pry_setup.rb ADDED

@@ -0,0 +1,34 @@
+$LOAD_PATH << '.'
+require_relative '../spec/spec_helper'
+require_relative '../spec/resources/simple_form/simple_form_page.rb'
+require_relative '../spec/resources/simple_form/simple_form.rb'
+require_relative '../spec/resources/simple_site/home_page.rb'
+require_relative '../spec/resources/simple_site/redirect_page.rb'
+require_relative '../spec/resources/simple_site/hit_counter_page.rb'
+require_relative '../spec/resources/simple_site/simple_site.rb'
+def simple_form_page
+  @simple_form_page ||= SimpleFormPage.new
+end
+def home_page
+  @home_page ||= HomePage.new
+end
+def hit_counter_page
+  @hit_counter_page ||= HitCounterPage.new
+end
+def redirect_page
+  @redirect_page ||= RedirectPage.new
+end
+def simple_site
+  set_app SimpleSite.new
+end
+def simple_form
+  set_app SimpleForm.new
+end

metadata ADDED

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: gamera
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Dobbs
+- Glen Aultman-Bettridge
+- Jillian Rosile
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.45'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.45.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.45'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.45.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.20.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.2
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+description: Provides a framework which let's you wrap any web page with a Ruby API.
+email:
+- eric@dobbse.net
+- glenab@koansolutions.net
+- jillian.rosile@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gamera.rb
+- lib/gamera/builder.rb
+- lib/gamera/builders/sequel_fixture_builder.rb
+- lib/gamera/exceptions.rb
+- lib/gamera/general_proxy.rb
+- lib/gamera/page.rb
+- lib/gamera/page_sections/form.rb
+- lib/gamera/page_sections/table.rb
+- lib/gamera/utils/database_cleaner.rb
+- lib/pry_setup.rb
+homepage: http://gamera-team.github.io/gamera/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: PageObject pattern implementation based on Capybara
+test_files: []
+has_rdoc: