tune_spec 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba1ac17c65ab0ae068e158cc836591d4abaef024
-  data.tar.gz: 3d92daa8e33f2d4e0a8e1ecf12bb46e76f47f969
+  metadata.gz: 94acadc6b27a86f11ef371aac9e2a90f180ea57b
+  data.tar.gz: 28eee0395583b8732170a452bec26176ecb2f1d0
 SHA512:
-  metadata.gz: 42ac8bd3f9dffa5a88c4505ec3e9c5b0bc9294a8fd0b808641790e325f5bd165d6b3b73faa9adb0496979fc97dada22ab41d58e4c0db6d1b65f610032204dd1e
-  data.tar.gz: 8451e1019f006a943aeadef2cae531b74d361d81b053d1d1f2d147d8414cd5c2a21a232f0afd1ed7876c24f54a9ae17ef6c3ae1c11ce5ce52452a236d8f7300a
+  metadata.gz: d4377597a557a0ddc9208e1fb88be8204debdced3dd17f2325f1580e0c9efa1a7a827d35dd3cd4500a15f20f35ac08a0253c6e799f528b97f673212e745becbf
+  data.tar.gz: 916bf7c6f7c77d25ffd7d4b0467b8991bbd6ffbc62ddcb63aa2ab8bb514a0afaadc18c1fffab1f5639ac59f86430072da8c7f89e3752777d466aad767a38972d

data/.gitignore

@@ -1,2 +1,7 @@
+*.gem
+.yardoc/
+doc/
+
 /tags
 *.swp
+*.vim

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in tune_spec.gemspec
 gemspec

data/Gemfile.lock

@@ -1,20 +1,43 @@
 PATH
   remote: .
   specs:
-    tune_spec (0.1.0)
+    tune_spec (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.5.0)
+    ast (2.3.0)
+    minitest (5.10.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.1.0)
+    rubocop (0.50.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+    yard (0.9.9)
+    yard-doctest (0.1.10)
+      minitest
+      yard
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.15)
-  rake (~> 10.0)
+  rubocop (~> 0.50.0)
   tune_spec!
+  yard (~> 0.9.9)
+  yard-doctest (~> 0.1.10)
 
 BUNDLED WITH
-   1.15.4
+   1.16.0.pre.3

data/README.md

@@ -20,7 +20,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To initialize framework folder structure run:
+
+    $ tune --init
+
+It creates a folder tree within your working directory:
+
+```
+lib
+├── groups
+├── pages
+└── steps
+```
+
+In your framework include the module:
+
+```ruby
+include TuneSpec::Instances
+```
+
+Then you can use TuneSpec DSL to store instances of your Groups, Steps and Page objects.
+Assume that you have LoginPage object and LoginSteps and LoginGroups:
+```ruby
+pages(:login).fill_in 'Email', with: 'user@example.com'
+pages(:login).fill_in 'Password', with: 'password'
+pages(:login).login.click
+```
+
+Or in your LoginSteps you can describe steps as a a group of interactions and verifications on a page:
+```ruby
+steps(:login).visit_page
+steps(:login).login_with_valid_credentials
+steps(:login).verify_login
+```
+
+You can go further and organize your steps within a group when details don't matter
+```ruby
+groups(:login).complete
+```
+
+The default instantiation of each of your objects is configurable:
+```ruby
+TuneSpec.configure do |config|
+  config.page_opts = { env: ENV['TEST_ENV'] }
+  config.steps_opts = { env: ENV['TEST_ENV'], page: :home }
+  config.groups_opts = {}
+end
+```
 
 ## Development
 

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "tune_spec"
+require 'bundler/setup'
+require 'tune_spec'
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/doctest_helper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'tune_spec'
+require 'fileutils'
+
+include TuneSpec::Instances
+TEST_ENV = 'STG'
+
+TuneSpec.configure do |conf|
+  conf.directory = 'test'
+  conf.groups_opts = { env: TEST_ENV }
+  conf.steps_opts = { env: TEST_ENV }
+  conf.page_opts = { env: TEST_ENV }
+end
+
+def create_file(name, type)
+  folder_name = type == :page ? 'pages' : type.to_s
+  file_name = "test/#{folder_name}/#{name}_#{type}.rb"
+  FileUtils.mkdir_p("test/#{folder_name}")
+  File.open(file_name, 'w+') { |f| f << file_content(name, type) }
+end
+
+def file_content(name, type)
+  <<~FILE
+    class_name = "#{name.capitalize}#{type.capitalize}"
+    klass = Object.const_set(class_name, Class.new)
+
+    klass.class_eval do
+      case "#{type}"
+      when 'groups'
+        define_method('initialize') do |env|; end
+        define_method('complete') do; end
+      when 'steps'
+        define_method('initialize') do |env, page_object|; end
+        define_method('verify_result') do; end
+      when 'page'
+        define_method('initialize') do |env|; end
+        define_method('click_element') do; end
+      end
+    end
+  FILE
+end
+
+create_file(:login, :groups)
+create_file(:calculator, :steps)
+create_file(:home, :page)
+
+YARD::Doctest.configure do |doctest|
+  doctest.after_run do
+    FileUtils.rm_rf('test')
+  end
+end

data/exe/tune

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'tune_spec/parser'

data/lib/tune_spec/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TuneSpec
+  # Defines all configurable attributes of TuneSpec
+  module Configuration
+    VALID_CONFIG_KEYS = %i[directory page_opts steps_opts groups_opts].freeze
+
+    DEFAULT_DIRECTORY = 'lib'
+
+    DEFAULT_PAGE_OPTS = {}.freeze
+
+    DEFAULT_STEPS_OPTS = {}.freeze
+
+    DEFAULT_GROUPS_OPTS = {}.freeze
+
+    VALID_CONFIG_KEYS.each { |key| attr_accessor key }
+
+    # Make sure the default values are set when the module is 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", self::Configuration.const_get("DEFAULT_#{key}".upcase))
+      end
+    end
+  end
+end

data/lib/tune_spec/instances/groups.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'tuner'
+
+module TuneSpec
+  module Instances
+    # Defines the group behavior and rules
+    class Groups < Tuner
+      class << self
+        # Groups specific rules
+        def rules_passed?(instance, _args)
+          instance
+        end
+
+        private
+
+        def file_directory
+          "#{TuneSpec.directory}/#{type}"
+        end
+      end
+    end
+  end
+end

data/lib/tune_spec/instances/page.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'tuner'
+
+module TuneSpec
+  module Instances
+    # Defines pages behavior and rules
+    class Page < Tuner
+      class << self
+        # Page specific rules
+        def rules_passed?(instance, _args)
+          instance
+        end
+
+        private
+
+        def file_directory
+          "#{TuneSpec.directory}/#{type}s"
+        end
+      end
+    end
+  end
+end

data/lib/tune_spec/instances/steps.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'tuner'
+
+module TuneSpec
+  module Instances
+    # Defines the steps behavior and rules
+    class Steps < Tuner
+      class << self
+        # Steps specific rules
+        def rules_passed?(instance, args)
+          same_page?(instance, args[1]) if args
+        end
+
+        private
+
+        # Verifies if the step requires a page_object
+        def same_page?(instance, page)
+          return false unless instance
+          return true unless instance.respond_to?(:page_object)
+          return true unless general_steps?(instance)
+          page.instance_of?(instance.page_object.class)
+        end
+
+        def general_steps?(instance)
+          argument_required?(:page_object, instance.class)
+        end
+
+        def file_directory
+          "#{TuneSpec.directory}/#{type}"
+        end
+      end
+    end
+  end
+end

data/lib/tune_spec/instances/tuner.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module TuneSpec
+  module Instances
+    # Abstract class for Group, Step and Page
+    class Tuner
+      class << self
+        def instance_method_name(name)
+          "#{name}_#{type}".downcase
+        end
+
+        # A hook to define rules by subclasses
+        def rules_passed?(_instance, _args)
+          raise "Implement a #rules_passed? method for #{self}"
+        end
+
+        def format_args(args, object_klass)
+          default_args = fetch_default_args
+          args.tap do |arr|
+            default_args.each do |key, value|
+              arr.insert(0, value) if argument_required?(key, object_klass)
+            end
+          end
+        end
+
+        def call_object(file_name)
+          ensure_required(file_name)
+          const_name = file_name.split('_').each(&:capitalize!).join('')
+          const_get(const_name)
+        end
+
+        private
+
+        def type
+          @type ||= itself.to_s.split('::').last.downcase
+        end
+
+        def fetch_default_args
+          TuneSpec.__send__("#{type}_opts".downcase)
+        end
+
+        def argument_required?(arg, klass)
+          klass.instance_method(:initialize).parameters.flatten.include?(arg)
+        end
+
+        def ensure_required(name)
+          path = load_files.detect { |f| f.include?("/#{name}.rb") }
+          path ? require("./#{path}") : raise("Unable to find #{name}.rb")
+        end
+
+        def load_files
+          @files ||= Dir.glob("#{file_directory}/**/*")
+        end
+
+        # A hook to implement folder name by subclass
+        def file_directory
+          raise "Implement a #folder_name method for #{self}"
+        end
+      end
+    end
+  end
+end

data/lib/tune_spec/instances.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'instances/groups'
+require_relative 'instances/steps'
+require_relative 'instances/page'
+
+module TuneSpec
+  # Maps instance variables of pages, steps and groups
+  # to corresponding objects under framework directory
+  module Instances
+    # Creates an instance of Group or calls an existing
+    #
+    # @param name [Symbol, String] the prefix of the Groups object class
+    # @param args [Any] additional optional arguments
+    # @param block [Block] that yields to self
+    # @return [GroupObject]
+    # @example
+    #   groups(:login).complete
+    def groups(name, *args, &block)
+      instance_handler(name, Groups, *args, block)
+    end
+
+    # Creates an instance of Step or calls an existing
+    #
+    # @param name [Symbol, String] the prefix of the Step object class
+    # @param args [Any] additional optional arguments
+    # @param block [Block] that yields to self
+    # @return [StepObject]
+    # @example
+    #   steps(:calculator, page: :home).verify_result
+    def steps(name, *args, page: nil, &block)
+      args.insert(0, pages(page)) if page
+      instance_handler(name, Steps, *args, block)
+    end
+
+    # Creates an instance of Page or calls an existing
+    #
+    # @param name [Symbol, String] the prefix of the Page object class
+    # @param args [Any] additional optional arguments
+    # @param block [Block] that yields to self
+    # @return [PageObject]
+    # @example
+    #   pages(:home).click_element
+    def pages(name, *args, &block)
+      instance_handler(name, Page, *args, block)
+    end
+
+    private
+
+    # @private
+    def instance_handler(name, klass, *args, block)
+      method_name = klass.instance_method_name(name)
+      create_instance_method(method_name, klass)
+      instance_klass = klass.call_object(method_name)
+      formatted_args = klass.format_args(args, instance_klass)
+      call_instance_method(method_name, *formatted_args, block)
+    end
+
+    # @private
+    def create_instance_method(method_name, klass)
+      return if respond_to?(method_name)
+      define_singleton_method(method_name) do |*args|
+        instance_var = instance_variable_get("@#{method_name}")
+        return instance_var if klass.rules_passed?(instance_var, args)
+        new_instance = klass.call_object(method_name).new(*args)
+        instance_variable_set("@#{method_name}", new_instance)
+      end
+    end
+
+    # @private
+    def call_instance_method(method_name, *args, block)
+      return __send__(method_name, *args) unless block
+      __send__(method_name, *args).instance_eval(&block)
+    end
+  end
+end

data/lib/tune_spec/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require 'fileutils'
 
@@ -18,7 +20,8 @@ module TuneSpec
       parser.parse!(original_args)
     end
 
-		def parser
+    # rubocop:disable MethodLength
+    def parser
       OptionParser.new do |parser|
         parser.summary_width = 34
 
@@ -27,9 +30,9 @@ module TuneSpec
         parser.on('--init [PATH]',
                   'Create framework folder structure') do |dir|
           base_path = dir || 'lib'
-          %w[groups pages steps].each do |dir|
+          %w[groups pages steps].each do |folder|
             FileUtils.mkdir_p(base_path)
-            path = "#{base_path}/#{dir}"
+            path = "#{base_path}/#{folder}"
             exists = directory_exists?(path)
             print_directory(path, exists)
             create_directory(path) unless exists
@@ -45,7 +48,7 @@ module TuneSpec
     end
 
     def create_directory(dir)
-      Dir.mkdir(dir) 
+      Dir.mkdir(dir)
     end
 
     def directory_exists?(dir)

data/lib/tune_spec/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TuneSpec
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/tune_spec.rb

@@ -1,5 +1,12 @@
-require "tune_spec/version"
+# frozen_string_literal: true
 
+require 'tune_spec/configuration'
+require 'tune_spec/version'
+
+# Namespace for all TuneSpec objects
 module TuneSpec
-  # Your code goes here...
+  extend Configuration
+  # TODO: Add method missing
 end
+
+require 'tune_spec/instances'

data/tune_spec.gemspec

@@ -1,24 +1,27 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "tune_spec/version"
+require 'tune_spec/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tune_spec"
+  spec.name          = 'tune_spec'
   spec.version       = TuneSpec::VERSION
-  spec.authors       = ["Igor Starostenko"]
-  spec.email         = ["contactigorstar@gmail.com"]
+  spec.authors       = ['Igor Starostenko']
+  spec.email         = ['contactigorstar@gmail.com']
 
   spec.summary       = "tune_spec_#{TuneSpec::VERSION}"
-  spec.description   = 'e2e Ruby tests in Page Objects'
-  spec.homepage      = "https://github.com/igor-starostenko/tune_spec"
-  spec.license       = "MIT"
+  spec.description   = 'In Development. e2e Ruby tests in Page Objects'
+  spec.homepage      = 'https://github.com/igor-starostenko/tune_spec'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
+  spec.add_development_dependency 'yard-doctest', '~> 0.1.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tune_spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Igor Starostenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2017-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,20 +25,48 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: e2e Ruby tests in Page Objects
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.9
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+description: In Development. e2e Ruby tests in Page Objects
 email:
 - contactigorstar@gmail.com
 executables:
@@ -54,11 +82,17 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
+- doctest_helper.rb
 - exe/tune
 - lib/tune_spec.rb
+- lib/tune_spec/configuration.rb
+- lib/tune_spec/instances.rb
+- lib/tune_spec/instances/groups.rb
+- lib/tune_spec/instances/page.rb
+- lib/tune_spec/instances/steps.rb
+- lib/tune_spec/instances/tuner.rb
 - lib/tune_spec/parser.rb
 - lib/tune_spec/version.rb
 - tune_spec.gemspec
@@ -85,5 +119,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: tune_spec_0.1.0
+summary: tune_spec_0.3.0
 test_files: []

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec