page_object_stubs 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7343fff9ae29dab31e7311a15f938b9b6429b65
-  data.tar.gz: bc89e3acc327f9977e0c4f321ec715b7c4f69dbc
+  metadata.gz: 716c20c673742b01540464d83d5183e42c85b4b2
+  data.tar.gz: 95efba24aede01013c5097798e02e898aeba4141
 SHA512:
-  metadata.gz: b9d4377cc5bdafc7c5041976a89645ae3b7f0fb46db4f9256038e9f8f330cca5c4fffdeee6cdfdddb10247721b85cb8036fe2fed92f93ea413d4d14176e8ba3b
-  data.tar.gz: 15cf30dcc987cd87a7f8c8575ab7b921730f98b07568d6bae8ce102de437ba06bb0011e5b91b3b388ce32d031d9bc76b02ac858e7dc28d848ea6cf4fd8cd3641
+  metadata.gz: d47c10367e54726902fbb8766fb023b1639fe3a80fa3910bb42d8cab7b049b7d5f072748033667ddd21269527b23ef59866e842aec0bcc4e74c192ab51d7acb0
+  data.tar.gz: 6dadc68d3ded50285fbc3ae72a9be739ccef5b53bd2ee485f8ca7a410ffe3d7911a2a1569e32bebf4bf462328733e14653feae692af01858f62c3c0ea62ba3c1

data/.travis.yml

@@ -2,7 +2,7 @@ sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.2.3
 before_install: gem update --remote bundler
 install:
   - bundle install --retry=3

data/README.md

@@ -7,20 +7,22 @@
 [PageObject](https://github.com/cheezy/page-object) stub generator for RubyMine.
 
 ```ruby
-targets       = Dir.glob(File.join(__dir__, '..', 'page', '*_page.rb'))
-output_folder = File.join(__dir__, '..', 'stub')
-PageObjectStubs.generate targets: targets, output_folder: output_folder, angularjs: false
+targets = Dir.glob(File.join(__dir__, '..', 'page', '*_page.rb'))
+output  = File.join(__dir__, '..', 'stub')
+exclude = /#{Regexp.escape('base_page.rb')}/
+PageObjectStubs.generate targets: targets, output: output, exclude: exclude
 ```
 
 ```ruby
 # Creates stubs from target Ruby files in output folder with the format
 # target_filename_stub.rb
 #
+# Note the output folder is **DELETED** each time stubs are generated.
+#
 # @param [Hash] opts
 # @option opts [Array<File>] :targets Array of target files to create stubs from (required)
-# @option opts [Dir] :output_folder Folder to create stubs in (required)
-# @option opts [Boolean] :angularjs Enable angularjs support (optional, default false)
-def generate opts={}
+# @option opts [Dir] :output Folder to create stubs in (required)
+# @option opts [Dir] :exclude Exclusion regex use to reject targets (optional)
 ```
 
 ## Contributing

data/lib/page_object_stubs/ast_processor.rb

@@ -1,5 +1,4 @@
 module PageObjectStubs
-
   class ProcessPageObjects < Parser::AST::Processor
 
     attr_reader :name_type_pairs
@@ -61,6 +60,15 @@ table_cell table_row text_area text_field unordered_list video] + %w[page_url]
       # the rest of the data is in the children.
     end
 
+    def on_def node
+      if node.is_a?(AST::Node)
+        c = node.children
+        return unless c
+        method_name = c.first
+        @name_type_pairs << [method_name] if method_name.class == Symbol
+      end
+    end
+
     def on_send node
       generate_send node
       super

data/lib/page_object_stubs/page_object_stubs.rb

@@ -3,22 +3,30 @@ module PageObjectStubs
     # Creates stubs from target Ruby files in output folder with the format
     # target_filename_stub.rb
     #
+    # Note the output folder is **DELETED** each time stubs are generated.
+    #
     # ```ruby
     # targets = Dir.glob(File.join(__dir__, '..', 'page', '*_page.rb'))
     # output = File.join(__dir__, '..', 'stub')
-    # PageObjectStubs.generate targets: targets, output: output
+    # exclude = /#{Regexp.escape('base_page.rb')}/
+    # PageObjectStubs.generate targets: targets, output: output, exclude: exclude
     # ```
     #
     # @param [Hash] opts
     # @option opts [Array<File>] :targets Array of target files to create stubs from (required)
-    # @option opts [Dir] :output_folder Folder to create stubs in (required)
+    # @option opts [Dir] :output Folder to create stubs in (required)
+    # @option opts [Dir] :exclude Exclusion regex use to reject targets (optional)
     def generate opts={}
       targets = opts.fetch(:targets)
       targets = targets.select do |target|
         File.file?(target) && File.readable?(target)
       end
 
-      output_folder = File.expand_path(opts.fetch(:output_folder))
+      regex = opts.fetch(:exclude, false)
+      targets.reject! { |t| t.match regex } if regex
+
+      output_folder = File.expand_path(opts.fetch(:output))
+      FileUtils.rm_rf output_folder
       FileUtils.mkdir_p output_folder
 
       targets.each do |f|
@@ -35,28 +43,34 @@ module Stub
   module #{file_module_name}
     class << self
 R
-        output = ''
+        data = ''
 
         def wrap method_name
           ' ' * 6 + "def #{method_name}; fail('stub called!'); end" + "\n"
         end
 
         page_objects.name_type_pairs.each do |pair|
+          # process custom methods that aren't defined in page_object
+          if pair.length == 1
+            data += wrap "#{pair.first}(*args)"
+            next
+          end
+
           element_type = pair.first
           # if 'page_url' exists, then we need `def goto`
           # for all others, we need the name of the element to generate the remaining methods.
           if element_type == 'page_url'
-            output += wrap 'goto'
+            data += wrap 'goto'
             next
           end
 
           element_name = pair.last
 
-          output += wrap "#{element_name}"
-          output += wrap "#{element_name}_element"
-          output += wrap "#{element_name}?"
+          data += wrap "#{element_name}"
+          data += wrap "#{element_name}_element"
+          data += wrap "#{element_name}?"
 
-          output += wrap "#{element_name}=" if element_type == 'text_field'
+          data += wrap "#{element_name}=" if element_type == 'text_field'
         end
 
 
@@ -83,10 +97,10 @@ module RSpec
 end
 R
 
-        output = output_prefix + output + output_postfix
+        data = output_prefix + data + output_postfix
 
         File.open(stub_file, 'w') do |file|
-          file.write output
+          file.write data
         end
       end
     end

data/lib/page_object_stubs/raketask.rb

@@ -7,22 +7,25 @@ module PageObjectStubs
     # @option opts [String] :task_name the name of the stubs task (optional)
     # @option opts [String] :task_desc the description of the stubs task (optional)
     # @option opts [lambda] :targets lambda that will return an array of targets (optional)
-    # @option opts [lambda] :output_folder lambda that will return the output folder (optional)
+    # @option opts [lambda] :output lambda that will return the output folder (optional)
     def add_stubs_task opts={}
-      task_name     = opts.fetch(:task_name, 'stubs')
-      task_desc     = opts.fetch(:task_desc, 'Generate stubs')
+      task_name = opts.fetch(:task_name, 'stubs')
+      task_desc = opts.fetch(:task_desc, 'Generate stubs')
 
       # Get the dir that contains the Rakefile via Rake (__dir__ will not work)
-      targets       = opts.fetch(:targets, lambda { Dir.glob(File.join(Rake.application.original_dir, 'page', '*_page.rb')) })
-      output_folder = opts.fetch(:output_folder, lambda { File.join(Rake.application.original_dir, 'helper', 'stub') })
+      targets   = opts.fetch(:targets, lambda { Dir.glob(File.join(Rake.application.original_dir, 'page', '*_page.rb')) })
+      output    = opts.fetch(:output, lambda { File.join(Rake.application.original_dir, 'helper', 'stub') })
+      exclude   = opts.fetch(:exclude, false)
 
       raise 'targets must be a lambda' unless targets.lambda?
-      raise 'output_folder must be a lambda' unless output_folder.lambda?
+      raise 'output must be a lambda' unless output.lambda?
+      raise 'exclude must be a regex' if exclude && exclude.class != Regexp
 
       Rake.application.last_description = task_desc
       Rake::Task.define_task task_name do
-        PageObjectStubs.generate targets:       targets.call,
-                                 output_folder: output_folder.call
+        PageObjectStubs.generate targets: targets.call,
+                                 output:  output.call,
+                                 exclude: exclude
       end
     end
   end

data/lib/page_object_stubs/version.rb

@@ -1,4 +1,4 @@
 module PageObjectStubs
-  VERSION = '1.0.1' unless defined? ::PageObjectStubs::VERSION
-  DATE    = '2015-06-19' unless defined? ::PageObjectStubs::DATE
+  VERSION = '2.0.0' unless defined? ::PageObjectStubs::VERSION
+  DATE    = '2015-09-24' unless defined? ::PageObjectStubs::DATE
 end

data/page_object_stubs.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'parser', '~> 2.2.2.2'
 
   spec.add_development_dependency 'pry', '~> 0.10.1'
-  spec.add_development_dependency 'appium_thor', '~> 0.0.7'
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
-  spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'coveralls', '~> 0.8.1'
+  spec.add_development_dependency 'appium_thor', '~> 1.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'bundler', '~> 1.10.6'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'coveralls', '~> 0.8.2'
 end

data/release_notes.md

@@ -1,3 +1,13 @@
+#### v2.0.0 2015-09-24
+
+- [8c5f194](https://github.com/bootstraponline/page_object_stubs/commit/8c5f1947d717aa0c8e434e1e26570375170090ab) Release 2.0.0
+- [e3e02a2](https://github.com/bootstraponline/page_object_stubs/commit/e3e02a25ad58e02721dd8a74343fc8de372b6ea6) Update readme
+- [00cb6fc](https://github.com/bootstraponline/page_object_stubs/commit/00cb6fc371bd10778c85697dfd98069092cc03b9) Add exclude regex
+- [f12a90c](https://github.com/bootstraponline/page_object_stubs/commit/f12a90cbcd190bcad7d2ddc01cec5ce755c0e088) Always remove old stubs
+- [b15a9c4](https://github.com/bootstraponline/page_object_stubs/commit/b15a9c4dacee4b0a7e1b3696fe74709ba3988e79) Enable stubbing of regular methods
+- [aa797d4](https://github.com/bootstraponline/page_object_stubs/commit/aa797d4dfb694f8e454ad821063408431a557ee5) Update dependencies
+
+
 #### v1.0.1 2015-06-19
 
 - [bb715a0](https://github.com/bootstraponline/page_object_stubs/commit/bb715a0db3bdf9822d566d1b4486deac616a529d) Release 1.0.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_object_stubs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -44,70 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.10.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.10.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
 description: PageObject stub generator for RubyMine.
 email:
 - code@bootstraponline.com
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: PageObject stub generator for RubyMine