tune_spec 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b83bf10235e9377d6a6a3cf9c6a30a67b49b124
-  data.tar.gz: df48ef4b2cb6d703d80735e8300638fdd50b9622
+  metadata.gz: 4e58e3419f386d0e0c068bb72cb03c03f31fb77e
+  data.tar.gz: 9faee48a6c6360e4f881e514d552cb9390f76e0d
 SHA512:
-  metadata.gz: c1236ea27bc5238c533c86cd0e6d3164b786798cf7f37bfefcc1fc097af35e108cbe604977414346d679b6450f141fb22305e5362e5522d5aeb038a7d204f0f8
-  data.tar.gz: 4f7f0a5f9ce4ff5b7771d8b0ab734274e2a9502a69730895852c087d5df452cd1e76d03303e7da33b16235a984d27553a2d5011506067a9884f08a1b4130903d
+  metadata.gz: 29f5f6af0352a71fd419d0bd2aa7242c9d211f7654dc92054bbdf01e99e93a6d98f3653aafe000eac87f670212ef90dee74d7905e42ff8b42c082e5de9e51a69
+  data.tar.gz: f5ecdaa9a857697c5674ab5a25409c52559fadcd5eb33ed8f38ff3dbfeed48903a1b859df35c79ad5994a5f70805ba9739072120c19e754852ef4c5a22aa5b26

data/.gitignore

@@ -1,8 +1,11 @@
 .DS_Store
 *.gem
 .yardoc/
+coverage/
 doc/
 
+test_tmp/
+
 /tags
 *.swp
 *.vim

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.4.1
+  Exclude:
+    - 'test_tmp/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*_test.rb'

data/.travis.yml

@@ -1,8 +1,11 @@
 language: ruby
 rvm:
   - 2.4.1
-before_script:
-  - bundle exec yard config load_plugins true
+install:
+  - gem uninstall bundler
+  - gem install bundler --version '2.0.1'
+  - bundle install
 script:
   - bundle exec rubocop
   - bundle exec yard doctest
+  - bundle exec rake test TESTOPTS='-v -p'

data/.yardopts

@@ -0,0 +1 @@
+ --plugin yard-doctest

data/Gemfile.lock

@@ -1,31 +1,32 @@
 PATH
   remote: .
   specs:
-    tune_spec (0.5.3)
+    tune_spec (0.5.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.3.0)
-    minitest (5.11.1)
-    parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
-    rainbow (2.2.2)
-      rake
-    rake (12.3.0)
-    rubocop (0.50.0)
+    ast (2.4.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 3.0)
+      rainbow (>= 2.2.2, < 4.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.12)
-    yard-doctest (0.1.10)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+    yard (0.9.18)
+    yard-doctest (0.1.13)
       minitest
       yard
 
@@ -33,11 +34,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16, >= 1.16.2)
-  rubocop (~> 0.50.0)
+  rake (~> 12.3.2)
+  rubocop (~> 0.63.1)
   tune_spec!
-  yard (~> 0.9.12)
-  yard-doctest (~> 0.1.10)
+  yard (~> 0.9.18)
+  yard-doctest (~> 0.1.13)
 
 BUNDLED WITH
-   1.16.2
+   2.0.1

data/README.md

@@ -1,6 +1,10 @@
 # TuneSpec
 
-Organizes large scale integration tests following Convention over Configuration paradigm.
+[![Gem Version](https://badge.fury.io/rb/tune_spec.svg)](https://badge.fury.io/rb/tune_spec)
+[![Build Status](https://travis-ci.com/igor-starostenko/tune_spec.svg?branch=master)](https://travis-ci.com/igor-starostenko/tune_spec)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6d924fbd83bf675facf3/maintainability)](https://codeclimate.com/github/igor-starostenko/tune_spec/maintainability)
+
+Provides an easy to use DSL for Page Object model. Helps to organize large scale integration tests by following Convention over Configuration paradigm.
 
 ## Installation
 
@@ -33,10 +37,10 @@ lib
 └── steps
 ```
 
-In your framework include the module:
+Include the module in your framework:
 
 ```ruby
-include TuneSpec::Instances
+include TuneSpec
 ```
 
 Then you can use TuneSpec DSL to store instances of your Groups, Steps and Page objects.
@@ -94,6 +98,10 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Testing
+
+To test documentation with [yard-doctest](https://github.com/p0deje/yard-doctest), run `bundle exec yard doctest`. For unit tests run `bundle exec rake test`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/igor-starostenko/tune_spec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard-doctest'
+require_relative 'test/test_helper'
+
+namespace :test do
+  task :setup do
+    TestHelper.setup_directory
+  end
+
+  task :cleanup do
+    TestHelper.remove_directory
+  end
+end
+
+Rake::TestTask.new do |task|
+  task.pattern = 'test/**/*_test.rb'
+end
+
+YARD::Doctest::RakeTask.new do |task|
+  task.doctest_opts = %w[-v]
+  task.pattern = 'lib/**/*.rb'
+end

data/doctest_helper.rb

@@ -1,58 +1,22 @@
 # frozen_string_literal: true
 
 require 'tune_spec'
-require 'fileutils'
+require_relative 'test/test_helper'
 
-include TuneSpec::Instances
-TEST_ENV = 'STG'
+include TuneSpec # rubocop:disable Style/MixinUsage
 
 TuneSpec.configure do |conf|
-  conf.directory = 'test'
+  conf.directory = DIRECTORY
   conf.steps_page_arg = :page_object
   conf.groups_opts = { env: TEST_ENV, aut: 'WEB' }
   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 |test, env:, aut:|; end
-        define_method('complete') do; end
-      when 'steps'
-        define_method('initialize') do |env:, page_object:|
-          @env = env
-          @page_object = page_object
-        end
-        define_method('verify_result') do
-          @page_object.click_element
-        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)
+TestHelper.setup_directory
 
 YARD::Doctest.configure do |doctest|
   doctest.after_run do
-    FileUtils.rm_rf('test')
+    TestHelper.remove_directory
   end
 end

data/lib/tune_spec.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'tune_spec/configuration'
+require 'tune_spec/instances'
 require 'tune_spec/version'
 
-# Namespace for all TuneSpec objects
+# Main namespace
 module TuneSpec
   extend Configuration
+  include Instances
+
   # TODO: Add method missing
 end
-
-require 'tune_spec/instances'

data/lib/tune_spec/instances.rb

@@ -29,7 +29,7 @@ module TuneSpec
     # @param block [Block] that yields to self
     # @return [StepObject]
     # @example
-    #   steps(:calculator, page: :home).verify_result
+    #   steps(:calculator, page: :demo).verify_result
     def steps(name, opts = {}, *args, &block)
       opts[:page] && opts[:page] = pages(opts.fetch(:page))
       instance_handler(name, Steps, opts, *args, block)
@@ -63,9 +63,13 @@ module TuneSpec
     # @private
     def create_instance_method(method_name, klass, instance_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.first)
+        if instance_variable_defined?("@#{method_name}")
+          instance_var = instance_variable_get("@#{method_name}")
+          return instance_var if klass.rules_passed?(instance_var, args.first)
+        end
+
         new_instance = create_instance(klass, instance_klass, *args)
         instance_variable_set("@#{method_name}", new_instance)
       end
@@ -74,6 +78,7 @@ module TuneSpec
     # @private
     def create_instance(klass, instance_klass, *args)
       return instance_klass.new(*args) if klass.object_type == :common
+
       wait_opts = TuneSpec.calabash_wait_opts
       page(instance_klass, *args).await(wait_opts)
     end
@@ -81,6 +86,7 @@ module TuneSpec
     # @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

data/lib/tune_spec/instances/page.rb

@@ -14,6 +14,7 @@ module TuneSpec
 
         def object_type
           return super unless TuneSpec.calabash_enabled
+
           :calabash_page
         end
 

data/lib/tune_spec/instances/steps.rb

@@ -10,6 +10,7 @@ module TuneSpec
         # Steps specific rules
         def rules_passed?(instance, opts = {})
           return false if opts.nil?
+
           same_page?(instance, opts[page_arg]) unless opts.empty?
         end
 
@@ -21,6 +22,7 @@ module TuneSpec
           return true unless instance.respond_to?(page_arg)
           return true unless general_steps?(instance)
           return true if page.nil?
+
           page.instance_of?(instance.__send__(page_arg).class)
         end
 
@@ -38,6 +40,7 @@ module TuneSpec
 
         def pre_format_opts(opts)
           return opts unless opts.key?(:page)
+
           opts.tap { |hash| hash[page_arg] = hash.delete(:page) }
         end
       end

data/lib/tune_spec/instances/tuner.rb

@@ -49,7 +49,9 @@ module TuneSpec
 
         def ensure_required(name)
           path = project_files.detect { |f| f.include?("/#{name}.rb") }
-          path ? require("./#{path}") : raise("Unable to find #{name}.rb")
+          return require("./#{path}") if path
+
+          raise("Unable to find #{name}.rb in /#{TuneSpec.directory} directory")
         end
 
         def project_files

data/lib/tune_spec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TuneSpec
-  VERSION = '0.5.3'
+  VERSION = '0.5.4'
 end

data/test/test_files.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+TestHelper.create_file(:login, :groups) do
+  <<-FILE
+    class LoginGroups
+      def initialize(test, env:, aut:); end
+      def complete; end
+    end
+  FILE
+end
+
+TestHelper.create_file(:calculator, :steps) do
+  <<-FILE
+    class CalculatorSteps
+      attr_reader :page_object
+      def initialize(env:, page_object:)
+        @env = env
+        @page_object = page_object
+      end
+      def verify_result
+        raise unless page_object.title === 'ok'
+      end
+    end
+  FILE
+end
+
+TestHelper.create_file(:demo, :page) do
+  <<-FILE
+    class DemoPage
+      def initialize; end
+      def title
+        'ok'
+      end
+    end
+  FILE
+end
+
+TestHelper.create_file(:home, :page) do
+  <<-FILE
+    class HomePage
+      def initialize(env:); end
+      def click_element; end
+    end
+  FILE
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+TEST_ENV = 'STG'
+DIRECTORY = 'test_tmp'
+
+# Dynamically generates test files
+module TestHelper
+  def self.create_file(name, type, &block)
+    folder_name = type == :page ? 'pages' : type.to_s
+    file_name = "#{DIRECTORY}/#{folder_name}/#{name}_#{type}.rb"
+    FileUtils.mkdir_p("#{DIRECTORY}/#{folder_name}")
+    File.open(file_name, 'w+') { |f| f << block.call }
+  end
+
+  def self.setup_directory
+    require_relative 'test_files'
+  end
+
+  def self.remove_directory
+    FileUtils.rm_rf(DIRECTORY)
+  end
+end

data/test/tune_spec/instances_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'tune_spec'
+require_relative '../test_helper'
+
+TuneSpec.configure do |conf|
+  conf.directory = DIRECTORY
+  conf.steps_page_arg = :page_object
+  conf.groups_opts = { env: TEST_ENV, aut: 'WEB' }
+  conf.steps_opts = { env: TEST_ENV }
+  conf.page_opts = { env: TEST_ENV }
+end
+
+include TuneSpec::Instances # rubocop:disable Style/MixinUsage
+
+TestHelper.setup_directory
+
+describe TuneSpec::Instances do
+  describe Groups do
+    it 'generates an instance' do
+      instance = groups(:login, {}, 'Main')
+      instance.complete
+      instance.class.must_equal LoginGroups
+    end
+  end
+
+  describe Steps do
+    it 'generates an instance' do
+      instance = steps(:calculator, page: :demo)
+      instance.verify_result
+      instance.class.must_equal CalculatorSteps
+    end
+
+    it 'has page object' do
+      steps(:calculator, page: :demo) do
+        page_object.class.must_equal DemoPage
+      end
+    end
+  end
+
+  describe Page do
+    it 'generates an instance' do
+      instance = pages(:home)
+      instance.click_element
+      instance.class.must_equal HomePage
+    end
+  end
+end

data/tune_spec.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tune_spec/version'
 
@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
 
-  spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.2'
-  spec.add_development_dependency 'rubocop', '~> 0.50.0'
-  spec.add_development_dependency 'yard', '~> 0.9.12'
-  spec.add_development_dependency 'yard-doctest', '~> 0.1.10'
+  spec.add_development_dependency 'rake', '~> 12.3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.63.1'
+  spec.add_development_dependency 'yard', '~> 0.9.18'
+  spec.add_development_dependency 'yard-doctest', '~> 0.1.13'
 end

metadata

@@ -1,77 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: tune_spec
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Igor Starostenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: 12.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: 12.3.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.63.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.63.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.9.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.9.18
 - !ruby/object:Gem::Dependency
   name: yard-doctest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.1.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.1.13
 description: e2e Ruby tests in Page Objects
 email:
 - contactigorstar@gmail.com
@@ -81,14 +75,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bin/console
 - bin/setup
 - doctest_helper.rb
@@ -102,11 +99,15 @@ files:
 - lib/tune_spec/instances/tuner.rb
 - lib/tune_spec/parser.rb
 - lib/tune_spec/version.rb
+- test/test_files.rb
+- test/test_helper.rb
+- test/tune_spec/instances_test.rb
 - tune_spec.gemspec
 homepage: https://github.com/igor-starostenko/tune_spec
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,5 +127,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: tune_spec_0.5.3
+summary: tune_spec_0.5.4
 test_files: []