topoisomerase 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 824fa18b24c188d39f2e84ee5eec61098f0bdab0
-  data.tar.gz: 7c7c69f744f18fd88d4b6c9952cbf99bcf26e8d4
+  metadata.gz: 3d6fbc0409b85e6fee55102846a9ac377c227aa6
+  data.tar.gz: 544470dcb10e26a5575207c38bbeb1e17b955976
 SHA512:
-  metadata.gz: 6516b42b5be7580f4aa35b098ccc789fb47b5a9359f46b62626eec4257e408266c27c66f9dfd60b5b381a7c5e9356283b09cb8f3ba58c6f49008537dbffbe91c
-  data.tar.gz: cccfb7c414f0a4a0bd08548cd9939fff6d828fadc520653aa625b1769f5569a0851e3d3c358cf12c25241a5f4a5bdd96da2521858868518749b64300130a232f
+  metadata.gz: 6a2499fe4dd9e2ebb2d406edd7781e325c83f35b1c9e360f7bbd6bcf79c06f6c2654192a853f2a919f31129c4da5265bdabe258abf181d63e307af745fed9fa4
+  data.tar.gz: dbb63522e85182c36dd0f79ff7bc40439348eb81dd35ea4ddd6c7b08362facb41a8caf2b02a97e0527561f2fbc34bd8f3689eee7cd71e10a10a0f1091b3eb30a

data/README.md

@@ -34,6 +34,11 @@ Or install it yourself as:
 
 ## Usage
 
+### For one class
+
+Before creating stubs, make sure that you require all the files that you want to create stubs for.
+Otherwise it will not create stubs for anything.
+
 To create a stub file for a class, call the `create_stubs_for` passing that class.
 
 E.g:
@@ -58,6 +63,44 @@ Topoisomerase.create_stubs_for ParameterizedClass do
 end
 ```
 
+### For classes inheriting from another
+
+To create stubs for all classes inheriting from a class or module use the `create_stubs_based_on` method.
+If the instantiation of such objects require parameters pass a parameter in the block to represent each class
+that is found inheriting from the base class. 
+
+Eg:
+
+```ruby
+Topoisomerase.create_stubs_based_on PageObject do |inheriting_class|
+  inheriting_class.new(:config_1, 'config 2')
+end
+```
+
+### Comments
+
+If comments are used above a `define_method` method then they will be used as comments above the stub generated from it 
+by default.
+
+Otherwise the `Topoisomerase::Comments` class can be used. The following shows hows to add comments when generating stubs
+for all classes inheriting from / including the `PageObject` module. It adds 
+
+Eg:
+
+```ruby
+# 
+Topoisomerase::Comments.add_for_class PageObject do
+  comment "Set the '<%= method_to_stub.to_s.gsub('?', '') %>' text field", 
+  method_name: /=$/, source: /text_field_value_set/
+end
+```
+
+### Notes
+
+For efficiency and maintainability, it's recommended that the least needed to instantiate the class that will still
+generate the methods you need be used. However it may be just as easy to reuse the code you use when creating the objects
+themselves if it is generic enough.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/topoisomerase/version.rb

@@ -1,4 +1,4 @@
 module Topoisomerase
   # @return [String] Version of the gem
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/lib/topoisomerase.rb

@@ -2,7 +2,7 @@ require 'topoisomerase/version'
 require 'method_source'
 require 'fileutils'
 require 'topoisomerase/core_ext/string'
-require 'topoisomerase/comment_adder'
+require 'topoisomerase/comments'
 
 # Module for parsing and creating stubs for dynamic methods
 module Topoisomerase
@@ -54,7 +54,7 @@ module Topoisomerase
       method_data[:comment].strip.empty? ? '' : "Extracted comment #{method_data[:comment].strip}"
     end
 
-    # @return [Boolean]
+    # @return [Boolean] Whether there is a match based on value and matcher
     def match?(value_to_test, matcher_value)
       value_to_test = value_to_test.to_s
       case matcher_value
@@ -70,6 +70,7 @@ module Topoisomerase
     def comment_for(method_to_stub, method_data)
       return extracted_comment(method_data) unless comments_added[@inheriting_class]
 
+      method_to_stub = method_to_stub.to_s
       comments_added[@inheriting_class].each do |comment_matcher|
         matchers = comment_matcher[:matchers]
         return ERB.new(comment_matcher[:message]).result(binding) if matchers.all? do |matcher_type, matcher_value|
@@ -90,19 +91,17 @@ module Topoisomerase
     def create_stubs_for(class_name, inner_folder = nil)
       template = File.join(File.dirname(__FILE__), 'topoisomerase', 'stub_template.rb.erb')
       @class_name = class_name
-      @class_instance = if block_given?
-                          yield
-                        else
-                          class_name.new
-                        end
+      @class_instance = block_given? ? yield(class_name) : class_name.new
       @dynamic_methods = dynamic_instance_methods(class_name) do
         @class_instance
       end
       class_folder = inner_folder ? File.join(stub_folder, inner_folder) : stub_folder
-      FileUtils.mkdir_p class_folder
       filename = File.join(class_folder, "#{class_name.to_s.snakecase}.rb")
+      puts "Creating stubs for #{class_name} at #{filename}"
+      FileUtils.mkdir_p File.dirname(filename)
       IO.write filename, ERB.new(File.read(template)).result(binding)
-      `rubocop -a #{filename}`
+      require 'rubocop'
+      RuboCop::CLI.new.run(['-a', filename, '-f', 'q', '-o', 'stub_log'])
     end
 
     # Create stub files for each class that inherits from passed in class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topoisomerase
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -144,7 +144,7 @@ files:
 - bin/setup
 - exe/topoisomerase
 - lib/topoisomerase.rb
-- lib/topoisomerase/comment_adder.rb
+- lib/topoisomerase/comments.rb
 - lib/topoisomerase/core_ext/string.rb
 - lib/topoisomerase/stub_template.rb.erb
 - lib/topoisomerase/template/page_object.rb