page_ez 0.1.0

data/lib/page_ez/page_visitor.rb

@@ -0,0 +1,72 @@
+module PageEz
+  class PageVisitor
+    def initialize
+      @visitors = [
+        Visitors::DebugVisitor.new,
+        Visitors::RegisteredNameVisitor.new,
+        Visitors::MacroPluralizationVisitor.new,
+        Visitors::MatcherCollisionVisitor.new
+      ]
+    end
+
+    def begin_block_evaluation
+      @visitors.each do |visitor|
+        visitor.begin_block_evaluation
+      end
+    end
+
+    def end_block_evaluation
+      @visitors.each do |visitor|
+        visitor.end_block_evaluation
+      end
+    end
+
+    def define_method(name)
+      @visitors.each do |visitor|
+        visitor.define_method(name)
+      end
+    end
+
+    def inherit_from(subclass)
+      @visitors.each do |visitor|
+        visitor.inherit_from(subclass)
+      end
+    end
+
+    def track_method_added(name, construction_strategy)
+      @visitors.each do |visitor|
+        visitor.track_method_added(name, construction_strategy)
+      end
+    end
+
+    def track_method_undefined(name)
+      @visitors.each do |visitor|
+        visitor.track_method_undefined(name)
+      end
+    end
+
+    def track_method_renamed(from, to)
+      @visitors.each do |visitor|
+        visitor.track_method_renamed(from, to)
+      end
+    end
+
+    def track_method_delegated(name)
+      @visitors.each do |visitor|
+        visitor.track_method_delegated(name)
+      end
+    end
+
+    def process_macro(macro, name, construction_strategy)
+      @visitors.each do |visitor|
+        visitor.process_macro(macro, name, construction_strategy)
+      end
+    end
+
+    def reset
+      @visitors.each do |visitor|
+        visitor.reset
+      end
+    end
+  end
+end

data/lib/page_ez/parameters.rb

@@ -0,0 +1,54 @@
+module PageEz
+  class Parameters
+    def self.build(block)
+      if block&.respond_to?(:parameters) && block&.respond_to?(:arity)
+        new(block)
+      else
+        NullParameters.new
+      end
+    end
+
+    def keyword_args
+      @block.parameters.filter_map do |type, name|
+        param = Parameter.new(type, name)
+        param.name if param.kwarg?
+      end
+    end
+
+    def non_keyword_args
+      @block.parameters.filter_map do |type, name|
+        param = Parameter.new(type, name)
+        param.name if !param.kwarg?
+      end
+    end
+
+    private_class_method :new
+
+    def initialize(block)
+      @block = block
+    end
+
+    class NullParameters
+      def keyword_args
+        []
+      end
+
+      def non_keyword_args
+        []
+      end
+    end
+
+    class Parameter
+      attr_reader :name
+
+      def initialize(type, name)
+        @type = type
+        @name = name
+      end
+
+      def kwarg?
+        @type == :keyreq || @type == :key
+      end
+    end
+  end
+end

data/lib/page_ez/pluralization.rb

@@ -0,0 +1,25 @@
+require "active_support/core_ext/string/inflections"
+
+module PageEz
+  class Pluralization
+    def initialize(word)
+      @word = word.to_s
+    end
+
+    def singularize
+      @word.singularize
+    end
+
+    def pluralize
+      @word.pluralize
+    end
+
+    def plural?
+      @word == pluralize && @word != singularize
+    end
+
+    def singular?
+      !plural?
+    end
+  end
+end

data/lib/page_ez/selector_evaluator.rb

@@ -0,0 +1,76 @@
+module PageEz
+  class SelectorEvaluator
+    def self.build(name, dynamic_options:, options:, selector:)
+      run_def = ->(args, target:) do
+        PageEz::SelectorEvaluator.new(name, args, dynamic_options: dynamic_options, options: options, selector: selector, target: target)
+      end
+
+      name_def = -> { name }
+
+      Class.new.tap do |klass|
+        klass.define_singleton_method(:run, &run_def)
+        klass.define_singleton_method(:name, &name_def)
+      end
+    end
+
+    def initialize(name, args, dynamic_options:, options:, selector:, target:)
+      @name = name
+      @args = args
+      @dynamic_options = dynamic_options
+      @options = options
+      @selector = if selector.respond_to?(:bind)
+        selector.bind(target)
+      else
+        selector
+      end
+    end
+
+    def selector
+      if dynamic_selector?
+        if selector_args.none?
+          @selector.call(**kwargs.slice(*selector_kwargs))
+        else
+          @selector.call(*args[0..selector_args.length - 1], **kwargs.slice(*selector_kwargs))
+        end
+      else
+        @selector
+      end
+    end
+
+    def options
+      Options.merge(@options, @dynamic_options, *args[selector_args.length..])
+    end
+
+    private
+
+    def args
+      if @args.any? && kwargs.any?
+        cloned_args = @args.dup
+        cloned_args[-1] = kwargs.except(*selector_kwargs).merge(kwargs.slice(*dynamic_kwargs))
+        cloned_args
+      else
+        @args
+      end
+    end
+
+    def dynamic_selector?
+      @selector.respond_to?(:parameters) && @selector.respond_to?(:call)
+    end
+
+    def dynamic_kwargs
+      Parameters.build(@dynamic_options).keyword_args
+    end
+
+    def selector_kwargs
+      Parameters.build(@selector).keyword_args
+    end
+
+    def selector_args
+      Parameters.build(@selector).non_keyword_args
+    end
+
+    def kwargs
+      @args.last.is_a?(Hash) ? @args.last : {}
+    end
+  end
+end

data/lib/page_ez/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PageEz
+  VERSION = "0.1.0"
+end

data/lib/page_ez/visitors/debug_visitor.rb

@@ -0,0 +1,59 @@
+module PageEz
+  module Visitors
+    class DebugVisitor
+      def initialize
+        reset
+      end
+
+      def begin_block_evaluation
+        @depth_visitor.begin_block_evaluation
+      end
+
+      def end_block_evaluation
+        @depth_visitor.end_block_evaluation
+      end
+
+      def define_method(name)
+        @depth_visitor.define_method(name)
+        debug("* #{name}")
+      end
+
+      def inherit_from(subclass)
+        @depth_visitor.inherit_from(subclass)
+        debug("Declaring page object: #{subclass.name || "{anonymous page object}"}")
+      end
+
+      def track_method_added(name, construction_strategy)
+        @depth_visitor.track_method_added(name, construction_strategy)
+      end
+
+      def track_method_undefined(name)
+        @depth_visitor.track_method_undefined(name)
+      end
+
+      def track_method_renamed(from, to)
+        @depth_visitor.track_method_renamed(from, to)
+      end
+
+      def track_method_delegated(name)
+        @depth_visitor.track_method_delegated(name)
+        debug("* #{name} (delegated)")
+      end
+
+      def process_macro(macro, name, construction_strategy)
+        @depth_visitor.process_macro(macro, name, construction_strategy)
+        debug("#{macro} :#{name}, \"#{construction_strategy.selector}\"")
+      end
+
+      def reset
+        @depth_visitor = DepthVisitor.new
+      end
+
+      private
+
+      def debug(message)
+        PageEz.configuration.logger.debug("#{"  " * @depth_visitor.depth}#{message}")
+      end
+    end
+  end
+end

data/lib/page_ez/visitors/depth_visitor.rb

@@ -0,0 +1,44 @@
+module PageEz
+  module Visitors
+    class DepthVisitor
+      attr_reader :depth
+
+      def initialize
+        reset
+      end
+
+      def begin_block_evaluation
+        @depth += 1
+      end
+
+      def end_block_evaluation
+        @depth -= 1
+      end
+
+      def define_method(name)
+      end
+
+      def inherit_from(subclass)
+      end
+
+      def track_method_added(*)
+      end
+
+      def track_method_undefined(*)
+      end
+
+      def track_method_renamed(*)
+      end
+
+      def track_method_delegated(*)
+      end
+
+      def process_macro(*)
+      end
+
+      def reset
+        @depth = 0
+      end
+    end
+  end
+end

data/lib/page_ez/visitors/macro_pluralization_visitor.rb

@@ -0,0 +1,70 @@
+module PageEz
+  module Visitors
+    class MacroPluralizationVisitor
+      def initialize
+        reset
+      end
+
+      def begin_block_evaluation
+        @depth_visitor.begin_block_evaluation
+      end
+
+      def end_block_evaluation
+        @depth_visitor.end_block_evaluation
+      end
+
+      def define_method(name)
+        @depth_visitor.define_method(name)
+      end
+
+      def inherit_from(subclass)
+        @depth_visitor.inherit_from(subclass)
+      end
+
+      def track_method_added(name, construction_strategy)
+        @depth_visitor.track_method_added(name, construction_strategy)
+      end
+
+      def track_method_undefined(name)
+        @depth_visitor.track_method_undefined(name)
+      end
+
+      def track_method_renamed(from, to)
+        @depth_visitor.track_method_renamed(from, to)
+      end
+
+      def track_method_delegated(name)
+        @depth_visitor.track_method_delegated(name)
+      end
+
+      def process_macro(macro, name, construction_strategy)
+        @depth_visitor.process_macro(macro, name, construction_strategy)
+        rendered = "#{macro} :#{name}, \"#{construction_strategy.selector}\""
+
+        message = case [macro, Pluralization.new(name).singular? ? :singular : :plural]
+        in [:has_one, :plural]
+          "consider singularizing :#{name} in #{rendered}"
+        in [:has_many, :singular]
+          "consider pluralizing :#{name} in #{rendered}"
+        in [:has_many_ordered, :singular]
+          "consider pluralizing :#{name} in #{rendered}"
+        in _
+        end
+
+        if message
+          message = "#{"  " * @depth_visitor.depth}#{message}"
+          case PageEz.configuration.on_pluralization_mismatch
+          when :warn
+            PageEz.configuration.logger.warn(message)
+          when :raise
+            raise PluralizationMismatchError, message
+          end
+        end
+      end
+
+      def reset
+        @depth_visitor = DepthVisitor.new
+      end
+    end
+  end
+end

data/lib/page_ez/visitors/matcher_collision_visitor.rb

@@ -0,0 +1,75 @@
+module PageEz
+  module Visitors
+    class MatcherCollisionVisitor
+      def initialize
+        reset
+      end
+
+      def begin_block_evaluation
+        @depth_visitor.begin_block_evaluation
+      end
+
+      def end_block_evaluation
+        @depth_visitor.end_block_evaluation
+      end
+
+      def define_method(name)
+        @depth_visitor.define_method(name)
+      end
+
+      def inherit_from(subclass)
+        @depth_visitor.inherit_from(subclass)
+      end
+
+      def track_method_added(name, construction_strategy)
+        @depth_visitor.track_method_added(name, construction_strategy)
+      end
+
+      def track_method_undefined(name)
+        @depth_visitor.track_method_undefined(name)
+      end
+
+      def track_method_renamed(from, to)
+        @depth_visitor.track_method_renamed(from, to)
+      end
+
+      def track_method_delegated(name)
+        @depth_visitor.track_method_delegated(name)
+      end
+
+      def process_macro(macro, name, construction_strategy)
+        @depth_visitor.process_macro(macro, name, construction_strategy)
+        if existing_matchers.include?(name.to_s)
+          rendered_macro = "#{macro} :#{name}, \"#{construction_strategy.selector}\""
+          whitespace = "  " * @depth_visitor.depth
+          message = "#{whitespace}#{rendered_macro} will conflict with Capybara's `have_#{name}` matcher"
+
+          case PageEz.configuration.on_matcher_collision
+          when :warn
+            PageEz.configuration.logger.warn(message)
+          when :raise
+            raise MatcherCollisionError, message
+          end
+        end
+      end
+
+      def reset
+        @depth_visitor = DepthVisitor.new
+      end
+
+      private
+
+      def existing_matchers
+        if defined?(Capybara::RSpecMatchers)
+          Capybara::RSpecMatchers.instance_methods.filter_map do |method_name|
+            if (match = method_name.to_s.match(/^have_(?!no_)(.+)$/))
+              match[1]
+            end
+          end
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/page_ez/visitors/registered_name_visitor.rb

@@ -0,0 +1,100 @@
+module PageEz
+  module Visitors
+    class RegisteredNameVisitor
+      def initialize
+        reset
+      end
+
+      def begin_block_evaluation
+        @parents.push(@current_strategy)
+      end
+
+      def end_block_evaluation
+        @parents.pop
+      end
+
+      def define_method(*)
+      end
+
+      def inherit_from(*)
+      end
+
+      def track_method_undefined(name)
+        current_all_methods.delete(name)
+      end
+
+      def track_method_renamed(from, to)
+        current_renamed_methods.push(from)
+      end
+
+      def track_method_delegated(name)
+        if current_all_methods.count { _1 == name } > 1
+          raise DuplicateElementDeclarationError, "duplicate element :#{name} declared"
+        end
+
+        current_delegated_methods.push(name)
+      end
+
+      def track_method_added(name, construction_strategy)
+        @declared_constructors[parent_id] ||= []
+
+        found = @declared_constructors[parent_id].find { _1 == [name, construction_strategy] }
+
+        if found && found[1]&.selector_type != :dynamic
+          raise DuplicateElementDeclarationError, "duplicate element :#{name} declared"
+        end
+
+        if current_renamed_methods.include?(name) && current_all_methods.include?(name)
+          raise DuplicateElementDeclarationError, "duplicate element :#{name} declared"
+        end
+
+        if current_delegated_methods.include?(name) && current_all_methods.include?(name)
+          raise DuplicateElementDeclarationError, "duplicate element :#{name} declared"
+        end
+
+        current_all_methods.push(name)
+      end
+
+      def process_macro(_, name, construction_strategy)
+        @declared_constructors[parent_id] ||= []
+
+        if @declared_constructors[parent_id].map { _1.first }.include?(name)
+          raise DuplicateElementDeclarationError, "duplicate element :#{name} declared"
+        end
+
+        @declared_constructors[parent_id] += [[name, construction_strategy]]
+        @current_strategy = construction_strategy
+      end
+
+      def reset
+        @parents = []
+        @current_strategy = nil
+        @declared_constructors = {}
+        @all_methods = {}
+        @delegated_methods = {}
+        @renamed_methods = {}
+      end
+
+      private
+
+      def parent_id
+        @parents.last.object_id
+      end
+
+      def current_renamed_methods
+        @renamed_methods[parent_id] ||= []
+        @renamed_methods[parent_id]
+      end
+
+      def current_all_methods
+        @all_methods[parent_id] ||= []
+        @all_methods[parent_id]
+      end
+
+      def current_delegated_methods
+        @delegated_methods[parent_id] ||= []
+        @delegated_methods[parent_id]
+      end
+    end
+  end
+end

data/lib/page_ez.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "page_ez/version"
+require_relative "page_ez/errors"
+require_relative "page_ez/configuration"
+require_relative "page_ez/null_logger"
+require_relative "page_ez/delegates_to"
+require_relative "page_ez/parameters"
+require_relative "page_ez/selector_evaluator"
+require_relative "page_ez/method_generators/define_has_many_result_methods"
+require_relative "page_ez/method_generators/define_has_one_result_methods"
+require_relative "page_ez/method_generators/define_has_one_predicate_methods"
+require_relative "page_ez/method_generators/identity_processor"
+require_relative "page_ez/method_generators/has_one_static_selector"
+require_relative "page_ez/method_generators/has_one_dynamic_selector"
+require_relative "page_ez/method_generators/has_one_composed_class"
+require_relative "page_ez/method_generators/has_many_dynamic_selector"
+require_relative "page_ez/method_generators/has_many_ordered_dynamic_selector"
+require_relative "page_ez/method_generators/has_many_ordered_selector"
+require_relative "page_ez/method_generators/has_many_static_selector"
+require_relative "page_ez/visitors/matcher_collision_visitor"
+require_relative "page_ez/visitors/depth_visitor"
+require_relative "page_ez/visitors/debug_visitor"
+require_relative "page_ez/visitors/registered_name_visitor"
+require_relative "page_ez/visitors/macro_pluralization_visitor"
+require_relative "page_ez/page_visitor"
+require_relative "page_ez/page"
+require_relative "page_ez/pluralization"
+require_relative "page_ez/options"
+require_relative "page_ez/has_one_result"
+require_relative "page_ez/has_many_result"
+
+module PageEz
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/page_ez.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/page_ez/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "page_ez"
+  spec.version = PageEz::VERSION
+  spec.authors = ["Josh Clayton"]
+  spec.email = ["joshua.clayton@gmail.com"]
+
+  spec.summary = "PageEz is a tool to define page objects with Capybara"
+  spec.description = "PageEz is a tool to define page objects with Capybara"
+  spec.homepage = "https://github.com/joshuaclayton/page_ez"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/joshuaclayton/page_ez"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "capybara", "~> 3.0"
+  spec.add_runtime_dependency "activesupport", ">= 5.0"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard", "~> 1.3"
+  spec.add_development_dependency "sinatra", "~> 3.0"
+  spec.add_development_dependency "selenium-webdriver", "~> 4.10"
+  spec.add_development_dependency "puma", "~> 6.3"
+  spec.add_development_dependency "launchy", "~> 2.5"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+  spec.add_development_dependency "simplecov-lcov", "~> 0.8"
+end