page_magic 2.0.0.alpha1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eec3ec93f7cd6ba430ba78860160822632cdc8949da2aea83afddc3366ea3d3
-  data.tar.gz: e3b3634979f0499bd0db1012a209a2d12cce94b7c0b870b1e91d3f8048e3f92b
+  metadata.gz: 92b6df866c2bbcae9351e24417bf141c50101f96b74ce6a1225318998c30da9b
+  data.tar.gz: 2a605e1c74eda006717474066d6824806a20f35ca05ddeef75d684951ebea257
 SHA512:
-  metadata.gz: afe8591e16f7afaa2e464b48ac9eabff046a140df8558dee5bb51aa3eac0ccb43c43cbb43eb7af9d7a2529f242f1cc87b7f63160c5c70decb3bbc9d2cd8d060a
-  data.tar.gz: 95802bd6ab8e1acca9f0d8142452469a743177cdbbf3a44e679016960a23bfe56b453ad53db758bd9ce9edc82f388f90a03c72f76341c24ff517995678e9f2eb
+  metadata.gz: 773b643dcf348bd77718e53e924754dd47d23e2edc1bbc1c904a82d332a66b00f9d7285c409a91be37d7ecca27cdbb11f62d6b938ea47e7a9396a2dd97a724d3
+  data.tar.gz: 7864c97e2e3b196809835ad8a9d4ede8fd44a7ad84276a3bd06d72fb706b2400437ded32301f5e5bb299d13cbfbe2314d606c57fc1de809dfa396e3d8070de85

data/.rubocop.yml

@@ -1,7 +1,10 @@
-Metrics/LineLength:
+require: rubocop-rspec
+
+Layout/LineLength:
   Max: 120
 
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.7
   Exclude:
     - 'lib/active_support/**/*'
@@ -33,4 +36,4 @@ Style/PercentLiteralDelimiters:
     '%I': '[]'
     '%r': '{}'
     '%w': '[]'
-    '%W': '[]'
+    '%W': '[]'

data/.zsh_config

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-#alias bundle="docker run -v ${HOME}/.gitconfig:/root/.gitconfig -v $(pwd):/page_magic -t lvl-up/page-magic bundle"
-#alias ruby="bundle exec ruby"
-#alias rake="bundle exec rake"
-#alias rubocop="bundle exec rubocop"
-#alias gem="docker run -v $(pwd):/page_magic -t lvl-up/page-magic gem"
+alias bundle="docker run -v $(pwd):/page_magic -t lvl-up/page-magic bundle"
+alias ruby="bundle exec ruby"
+alias rake="bundle exec rake"
+alias rubocop="bundle exec rubocop"
+alias gem="docker run -v $(pwd):/page_magic -t lvl-up/page-magic gem"

data/Dockerfile

@@ -7,4 +7,5 @@ COPY . $APP_HOME
 WORKDIR $APP_HOME
 
 RUN apk --update --no-cache add build-base git
-RUN bundle install
+RUN bundle install
+RUN rm -rf $APP_HOME

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 
 gem 'activesupport'
-gem 'capybara', ">=3.0"
+gem 'capybara', '>=3.0'
 
 group :test do
   gem 'poltergeist'
@@ -18,6 +18,7 @@ group :development do
   gem 'jeweler'
   gem 'redcarpet'
   gem 'rubocop', require: 'rubocop/rake_task'
+  gem 'rubocop-rspec', require: false
   gem 'ruby-debug-ide', require: false
   gem 'yard', '~> 0.8'
 end

data/Gemfile.lock

@@ -72,7 +72,7 @@ GEM
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
     parallel (1.20.1)
-    parser (3.0.1.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     poltergeist (1.18.1)
       capybara (>= 2.1, < 4)
@@ -105,17 +105,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.12.1)
+    rubocop (1.15.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-debug-ide (0.7.2)
       rake (>= 0.8.1)
     ruby-progressbar (1.11.0)
@@ -164,6 +167,7 @@ DEPENDENCIES
   redcarpet
   rspec
   rubocop
+  rubocop-rspec
   ruby-debug-ide
   simplecov
   sinatra

data/Makefile

@@ -1,13 +1,17 @@
 .PHONY: help
 DOCKER_IMAGE = lvl-up/page-magic
+MOUNT_DIR = /page_magic
 
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-build: ## build project docker image
+docker: ## build project docker image
 	docker build -t $(DOCKER_IMAGE) .
 
 test: ## Run tests
-	docker run -v $(PWD):/usr/src/app -t $(DOCKER_IMAGE) bundle exec rspec
+	docker run -v $(PWD):$(MOUNT_DIR) -w $(MOUNT_DIR) -t $(DOCKER_IMAGE) bundle exec rspec
 
-all: test
+build: docker ## build gem
+	rake build
+
+all: docker test build ## run all targets before building gem

data/README.md

@@ -59,7 +59,7 @@ Check it out :)
 - [Page mapping](#page-mapping)
   - [Mapping against query string parameters](#mapping-against-query-string-parameters)
   - [Mapping against fragment identifiers](#mapping-against-fragment-identifiers)
-- [Loading pages from source](#loading-pages-from-source)
+- [Loading pages/elements from source](#loading-pages/elements-from-source)
 - [Watchers](#watchers)
   - [Method watchers](#method-watchers)
   - [Simple watchers](#simple-watchers)
@@ -381,16 +381,27 @@ against URL fragments.
 browser.define_page_mappings PageMagic.mapping(fragment: string_or_regex) => ResultsPage                            
 ```
 
-# Loading pages from source
+# Loading pages/elements from source
 PageMagic supports loading page objects using html source. This technique can be useful for getting quick feedback that 
-your templates correctly render based on your view objects. I.e you can test your templates in isolation.
+your templates correctly render based on your view objects. I.e you can test your templates and partials/fragments in isolation.
 ```ruby
 class MyPage
   include PageMagic
+  element(:link, id: 'link_id')
   #element definitions
 end
 
 page_instance = Page.load(html_string)
+page_instance.link.text # returns the link text
+
+
+class CustomElement < PageMagic::Element
+  element(:link, id: 'link_id')
+  #element definitions
+end
+
+page_element = CustomElement.load(html_string)
+page_element.link.text # returns the link text
 ```
 
 # Watchers
@@ -453,7 +464,8 @@ You can register any Capybara compliant driver as follows
 Webkit = PageMagic::Driver.new(:webkit) do |app, options, browser_alias_chosen|
   # Write the code necessary to initialise the driver you have chosen
   require 'capybara/webkit'
-  Capybara::Webkit::Driver.new(app, options)
+  Capybara::Webkit::Driver.new(app, 
+  )
 end
 
 #2. Register driver

data/VERSION

@@ -1 +1 @@
-2.0.0.alpha1
+2.0.0

data/lib/active_support/core_ext/object/to_query.rb

@@ -59,14 +59,14 @@ end
 class Hash
   # Returns a string representation of the receiver suitable for use as a URL
   # query string:
-  #
-  #   {name: 'David', nationality: 'Danish'}.to_query
-  #   # => "name=David&nationality=Danish"
+  # @example
+  #  {name: 'David', nationality: 'Danish'}.to_query
+  #  # => "name=David&nationality=Danish"
   #
   # An optional namespace can be passed to enclose key names:
-  #
-  #   {name: 'David', nationality: 'Danish'}.to_query('user')
-  #   # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"
+  # @example
+  #  {name: 'David', nationality: 'Danish'}.to_query('user')
+  #  # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"
   #
   # The string pairs "key=value" that conform the query string
   # are sorted lexicographically in ascending order.

data/lib/page_magic.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.dirname(__FILE__).to_s)
 require 'capybara'
-require 'page_magic/exceptions'
-require 'page_magic/wait_methods'
-require 'page_magic/watchers'
-require 'page_magic/session'
-require 'page_magic/session_methods'
-require 'page_magic/elements'
-require 'page_magic/element_context'
-require 'page_magic/element'
-require 'page_magic/class_methods'
-require 'page_magic/instance_methods'
-require 'page_magic/drivers'
+require_relative 'page_magic/exceptions'
+require_relative 'page_magic/wait_methods'
+require_relative 'page_magic/watchers'
+require_relative 'page_magic/session'
+require_relative 'page_magic/session_methods'
+require_relative 'page_magic/elements'
+require_relative 'page_magic/element_context'
+require_relative 'page_magic/element'
+require_relative 'page_magic/class_methods'
+require_relative 'page_magic/instance_methods'
+require_relative 'page_magic/drivers'
 
 # module PageMagic - PageMagic is an api for modelling pages in a website.
 module PageMagic
@@ -20,9 +19,9 @@ module PageMagic
 
   # @!method matcher
   # define match critera for loading a page object class
-  # @see Matcher#initialize
-  # @return [Matcher]
-  def_delegator Matcher, :new, :matcher
+  # @see Mapping#initialize
+  # @return [Mapping]
+  def_delegator Mapping, :new, :matcher
 
   class << self
     # @return [Drivers] registered drivers
@@ -43,7 +42,7 @@ module PageMagic
     #   PageMagic.mapping '/', parameters: {project: 'page_magic'}, fragment: 'display'
     # @see Matchers#initialize
     def mapping(path = nil, parameters: nil, fragment: nil)
-      Matcher.new(path, parameters: parameters, fragment: fragment)
+      Mapping.new(path, parameters: parameters, fragment: fragment)
     end
 
     # Visit this page based on the class level registered url

data/lib/page_magic/class_methods.rb

@@ -30,7 +30,7 @@ module PageMagic
 
     # Visit this page based on the class level registered url
     # @param [Object] application rack application (optional)
-    # @param [Symbol] browser name of browser
+    # @param [Symbol] browser name of browser driver to use
     # @param [Hash] options browser driver specific options
     # @return [Session] active session configured to be using an instance of the page object modeled by this class
     def visit(application: nil, browser: :rack_test, options: {})

data/lib/page_magic/comparator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'comparator/fuzzy'
+require_relative 'comparator/literal'
+require_relative 'comparator/parameter_map'
+require_relative 'comparator/null'
+
+module PageMagic
+  # class Comparator - used for comparing components used for mapping pages
+  class Comparator
+    class << self
+      def for(comparator)
+        klass = { Regexp => Fuzzy, Hash => ParameterMap, NilClass => Null }.fetch(comparator.class, Literal)
+        klass.new(comparator)
+      end
+    end
+
+    attr_reader :comparator, :fuzzy
+
+    def initialize(comparator, fuzzy)
+      @comparator = comparator
+      @fuzzy = fuzzy
+    end
+
+    def fuzzy?
+      fuzzy
+    end
+
+    def to_s
+      comparator.to_s
+    end
+
+    def ==(other)
+      comparator == other.comparator
+    end
+  end
+end

data/lib/page_magic/comparator/fuzzy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PageMagic
+  class Comparator
+    # class Fuzzy - used for modeling and comparing components that are 'fuzzy' i.e. respond to `=~` e.g. a Regexp
+    class Fuzzy < Comparator
+      def initialize(comparator)
+        super(comparator, true)
+      end
+
+      def match?(value)
+        comparator =~ value ? true : false
+      end
+
+      def <=>(other)
+        return -1 if other.is_a?(Null)
+        return 1 unless other.fuzzy?
+
+        0
+      end
+    end
+  end
+end

data/lib/page_magic/comparator/literal.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module PageMagic
+  class Comparator
+    # class Literal - used for modeling and comparing thing directly. E.g. strings
+    class Literal < Comparator
+      def initialize(comparator)
+        super(comparator, false)
+      end
+
+      def match?(value)
+        comparator == value
+      end
+
+      def <=>(other)
+        return 1 if other.fuzzy? || other.is_a?(Null)
+
+        0
+      end
+    end
+  end
+end

data/lib/page_magic/comparator/null.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module PageMagic
+  class Comparator
+    # models mapping used to relate pages to uris
+    class Null < Comparator
+      def initialize(_comparator = nil)
+        super(nil, false)
+      end
+
+      def match?(_value)
+        true
+      end
+
+      def <=>(other)
+        return 0 if other.is_a?(Null)
+
+        1
+      end
+
+      def present?
+        false
+      end
+    end
+  end
+end

data/lib/page_magic/comparator/parameter_map.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module PageMagic
+  class Comparator
+    # class Map - used to model parameter matching requirements
+    class ParameterMap < Comparator
+      def initialize(map)
+        comparator = normalise(map).keys.each_with_object({}) do |key, params|
+          params[key] = Comparator.for(map[key])
+        end
+
+        fuzzy = comparator.values.any?(&:fuzzy?)
+        super(comparator, fuzzy)
+      end
+
+      def <=>(other)
+        return 0 if empty? && other.empty?
+        return 1 if other.empty?
+        if (comparator.keys.size <=> other.comparator.keys.size).zero?
+          return literal_matchers.size <=> other.literal_matchers.size
+        end
+
+        0
+      end
+
+      def empty?
+        comparator.empty?
+      end
+
+      def literal_matchers
+        comparator.values.find_all { |matcher| !matcher.fuzzy? }
+      end
+
+      def match?(params)
+        params_copy = normalise(params)
+        comparator.each do |key, value|
+          param = params_copy[key]
+          return false unless value&.match?(param)
+        end
+        true
+      end
+
+      private
+
+      def normalise(hash)
+        hash.keys.each_with_object({}) do |key, map|
+          map[key.to_sym] = hash[key]
+        end
+      end
+    end
+  end
+end

data/lib/page_magic/drivers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'page_magic/driver'
-require 'page_magic/utils/string'
+require_relative 'driver'
+require_relative 'utils/string'
 module PageMagic
   # class Drivers - creates an object that can be used to hold driver definitions
   # These PageMagic gets the user's chosen driver from this object.