shoulda_matchmakers 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a89f47e57114fcca2dc77c4c79a23a5ea277bc32
-  data.tar.gz: be011754779db03bd674e9c01bbf8581facd864e
+  metadata.gz: cd3a9140db13b85f889956fc07054a4d3dc273bd
+  data.tar.gz: f4c9a4744856800bebaf0fba6ba8fec9576014db
 SHA512:
-  metadata.gz: 8e4a59e5ed17a4fa4cf2ecfb8eed4dca6dea9ff538d4d1562125f19beff6790bb29dcbda7a07192f8cfb3460292c898273f3198bdc11b1abc77adb9aa65cf525
-  data.tar.gz: 13cd5034e269701147394e088625648bda2bc638b2610b0044a3fa6eccdf1e20a75946818294649311486888210fcd5e7564b5167bc7d4c39431dbc00e382add
+  metadata.gz: ce1e5b634a33f8096ae66441260886eef59e51cf8b52fbd8cb501c899fca638b7626ed37c5e45fdc1491955b6aa0ec6920542ef9d1157ed0ea64ed1791e933b2
+  data.tar.gz: c75c145f7f7db6c2159f940b1474bb172c0c80c33a9923656ce7ca75c7b1faa71d03b696cd5df0b7b7f83ece21ec0c64b3da9dea017d96678aa105aa7a7fd33b

data/lib/controller/action_controller/action_controller_controller_sm_model_helper.rb

@@ -64,10 +64,3 @@ module ShouldaMatchmakers
     end
   end
 end
-
-# Reject procs
-# # TRACE.debug "ALL ACTIONS:"
-# # TRACE.debug all_actions.inspect
-# selected_actions.map(&:raw_filter).reject{ |action| action.class == Proc }
-# all_actions.map { |action| action.is_a?(Symbol) ? ":#{ action }" : action.to_s }
-

data/lib/controller/action_controller/matchmakers/permit.rb

@@ -1,17 +1,3 @@
-# IMPLEMENTATION TODO: Determine if the variables used in this matcher generator represent the appropriate values, as shown here:
-#
-# it do
-#   params = {
-#     <params_class>: {
-#       <permitted_params_def.permitted_params.each>: <sample_value>
-#     }
-#   }
-#   should permit(:<permitted_params_def.permitted_params.each>).
-#     for(:<calling_class_method>, params: params).
-#     on(:<calling_class>)
-# end
-#
-
 require 'controller/action_controller/permitted_params_definition'
 
 module ShouldaMatchmakers
@@ -341,6 +327,20 @@ module ShouldaMatchmakers
 end
 
 
+# IMPLEMENTATION TODO: Determine if the variables used in this matcher generator represent the appropriate values, as shown here:
+#
+# it do
+#   params = {
+#     <params_class>: {
+#       <permitted_params_def.permitted_params.each>: <sample_value>
+#     }
+#   }
+#   should permit(:<permitted_params_def.permitted_params.each>).
+#     for(:<calling_class_method>, params: params).
+#     on(:<calling_class>)
+# end
+#
+
 # TODO: Nested Attributes
 # def protected_branch_params
 #   params.require(:protected_branch).permit(:name,

data/lib/controller/action_controller/matchmakers/route.rb

@@ -201,386 +201,3 @@ module ShouldaMatchmakers
     end
   end
 end
-
-
-
-# module ShouldaMatchmakers
-#   module Controller
-#     module ActionController
-#       module Matchmaker
-#         module Route
-#
-#
-#           def route_matcher_tests
-#             if journey_routes_present(@sm_model_action_controller_controller)
-#               generate_route_matcher_tests(@sm_model_action_controller_controller)
-#             else
-#               []
-#             end
-#           end
-#
-#
-#           private
-#
-#           def generate_route_matcher_tests(controller)
-#             route_tests = []
-#             controller_path = get_app_controller_file_path(controller)
-#             controller.constantize.action_methods.sort.each do |action_method|
-#               journey_routes = extract_journey_routes(controller_path, action_method)
-#               journey_routes.each do |journey_route|
-#                 single_route_tests = generate_single_route_tests(journey_route)
-#                 route_tests = route_tests + single_route_tests
-#               end
-#             end
-#             format_tests(route_tests)
-#           end
-#
-#           def generate_single_route_tests(journey_route)
-#             single_route_tests = []
-#             route_parameters_hash = generate_route_parameters_hash(journey_route)
-#             test_comment = route_parameters_hash.extract!(:test_comment)[:test_comment]
-#             url_options_hash = { controller: journey_route.defaults[:controller], action: journey_route.defaults[:action], only_path: true }
-#             url_options_hash = url_options_hash.merge(route_parameters_hash)
-#
-#             ## TRACE.debug "      ROUTE PARAMETERS HASH:"
-#             ## TRACE.debug route_parameters_hash.inspect
-#             ## TRACE.debug "      URL OPTIONS HASH:"
-#             ## TRACE.debug url_options_hash.inspect
-#
-#             if test_comment.present?
-#               url = "<url required>"
-#             else
-#               url = url_for(url_options_hash)
-#             end
-#
-#            # TRACE.debug "      URL:"
-#            # TRACE.debug url.inspect
-#
-#             request_methods = get_request_methods(journey_route)
-#             # CONFIRMATION TODO: Determine if this is the proper way to handle controller actions with multiple HTTP verbs
-#             request_methods.each do |request_method|
-#               single_route_test = generate_route_test_single_line(journey_route, url, request_method, route_parameters_hash, test_comment)
-#               if single_route_test.length > @working_generated_code_line_length
-#                 single_route_test = generate_route_test_multiple_line(single_route_test)
-#               end
-#               single_route_tests << single_route_test
-#             end
-#             single_route_tests
-#           end
-#
-#           def generate_route_test_single_line(journey_route, url, request_method, route_parameters_hash, test_comment)
-#             route_test = "  it { is_expected.to route(#{ request_method }, '#{ url }').to(action: #{ journey_route.defaults[:action] }"
-#             route_parameters_hash.each do |param_key, param_value|
-#
-#               ## TRACE.debug ""
-#               ## TRACE.debug "      ROUTE PARAMETERS HASH KEY:         " + param_key.inspect
-#               ## TRACE.debug "      ROUTE PARAMETERS HASH VALUE:       " + param_value.inspect
-#               ## TRACE.debug "      ROUTE PARAMETERS HASH VALUE CLASS: " + param_value.class.name.to_s
-#
-#               route_test.concat(", " + param_key.to_s + ": " + param_value.to_s )
-#             end
-#             # "#{ route_parameters_hash.to_s.gsub("{", "{ ").gsub("{  ", "{ ").gsub("}", " }").gsub("  }", " }") }")
-#             route_test.concat(") }")
-#             if test_comment.present?
-#               route_test.prepend(test_comment)
-#               route_test.sub!("  it { ", "  xit { ")
-#             end
-#             route_test
-#           end
-#
-#           def generate_route_test_multiple_line(route_test)
-#
-#             ## TRACE.debug ""
-#             ## TRACE.debug " ROUTE TEST:"
-#             ## TRACE.debug route_test.to_s
-#
-#             route_test.sub("it { ", "it do\n    ").gsub(").to(", ").\n      to(").gsub(/\)\s\}$/, ")\n  end")
-#           end
-#
-#           def get_request_methods(journey_route)
-#             request_method_regex = journey_route.constraints[:request_method]
-#             request_method_regex.to_s.scan(/[A-Z]+/)
-#           end
-#
-#           def generate_route_parameters_hash(journey_route)
-#
-#             # if journey_route.required_keys.size > 2
-#               ## TRACE.debug ""
-#               ## TRACE.debug ""
-#               ## TRACE.debug ""
-#               # ## TRACE.debug "      ROUTE APP:"
-#               # ## TRACE.debug journey_route.app.inspect
-#               ## TRACE.debug "      ROUTE CONSTRAINTS:"
-#               ## TRACE.debug journey_route.defaults.inspect
-#               # ## TRACE.debug "      ROUTE DEFAULTS:"
-#               # ## TRACE.debug journey_route.defaults.inspect
-#               # ## TRACE.debug "      ROUTE NAME:"
-#               # ## TRACE.debug journey_route.name.inspect
-#               # ## TRACE.debug "      ROUTE PATH:"
-#               # ## TRACE.debug journey_route.path.inspect
-#               # ## TRACE.debug "      ROUTE PRECENDENCE:"
-#               # ## TRACE.debug journey_route.precedence.inspect
-#               # ## TRACE.debug "      ROUTE OPTIONAL PARTS:"
-#               # ## TRACE.debug journey_route.optional_parts.inspect
-#               # ## TRACE.debug "      ROUTE PARTS:"
-#               # ## TRACE.debug journey_route.parts.inspect
-#               # ## TRACE.debug "      ROUTE REQUIRED DEFAULTS:"
-#               # ## TRACE.debug journey_route.required_defaults.inspect
-#               ## TRACE.debug "      ROUTE REQUIRED KEYS: " + journey_route.required_keys.inspect
-#               # ## TRACE.debug "      ROUTE REQUIRED PARTS:"
-#               # ## TRACE.debug journey_route.required_parts.inspect
-#               # # journey_route.required_parts.each do |rp|
-#               # #  # TRACE.debug "      ROUTE REQUIRED PART:       " + rp.to_s
-#               # #  # TRACE.debug "      ROUTE REQUIRED PART CLASS: " + rp.class.name.to_s
-#               # # end
-#               ## TRACE.debug "      ROUTE REQUIREMENTS:"
-#               ## TRACE.debug journey_route.requirements.inspect
-#               # ## TRACE.debug "      ROUTE REQUIREMENTS KEYS:"
-#               # ## TRACE.debug journey_route.requirements.keys.inspect
-#               # ## TRACE.debug "      ROUTE SEGMENTS:"
-#               # ## TRACE.debug journey_route.segments.inspect
-#               # ## TRACE.debug "      ROUTE VERB:"
-#               # ## TRACE.debug journey_route.verb.inspect
-#               #
-#               ## TRACE.debug ""
-#               ## TRACE.debug "      ROUTE REQUIRED KEYS WITHOUT VALUES:"
-#               # require_keys_with_missing_values = journey_route.required_keys - journey_route.requirements.keys
-#               ## TRACE.debug require_keys_with_missing_values.inspect
-#             # end
-#
-#             route_parameters_hash = journey_route.requirements.select { |key, value| journey_route.parts.include? key } || {}
-#             route_required_keys_with_missing_values = journey_route.required_keys - journey_route.requirements.keys
-#             # CONFIRMATION TODO: Determine if this is the proper way to handle route required ':id' parameter when value not provided
-#             if route_required_keys_with_missing_values.include? :id
-#               route_parameters_hash[:id] = 1
-#               route_required_keys_with_missing_values.delete(:id)
-#             end
-#             # CONFIRMATION TODO: Determine if this is the proper way to handle route required parameters that either have a regex or no value provided
-#             route_parameters_hash[:test_comment] = ""
-#             if route_required_keys_with_missing_values.present?
-#               route_required_keys_with_missing_values.each do |key_without_value|
-#                 route_parameters_hash[key_without_value] = "'<value required>'"
-#               end
-#               if route_required_keys_with_missing_values.size == 1
-#                 route_parameters_hash[:test_comment].concat("# A required value for route parameter ':#{ route_required_keys_with_missing_values[0] }' needs to be provided.\n")
-#               else
-#                 route_parameters_hash[:test_comment].concat("# Required values for route parameters '#{ route_required_keys_with_missing_values.to_s }' need to be provided.\n")
-#               end
-#             end
-#             if route_parameters_hash.values.any? { |route_parameter_value| route_parameter_value.is_a?(Regexp) }
-#               route_parameters_hash.each do |param_key, param_value|
-#                 if param_value.is_a? Regexp
-#                   param_regex_string = param_value.to_s.sub("(?-mix:","").gsub(/\)$/,"")
-#                   route_parameters_hash[:test_comment].concat("# A required value for route parameter ':#{ param_key }' matching regexp '#{ param_regex_string }' needs to be provided.\n")
-#                   route_parameters_hash[param_key] = "'<value matching regex required>'"
-#                 end
-#               end
-#             end
-#             if route_parameters_hash[:test_comment].present?
-#                 # if route_parameters_hash[:test_comment].scan("values").count > 0 || route_parameters_hash[:test_comment].scan("# ").count > 1
-#                   route_parameters_hash[:test_comment].concat("# Unable to determine URL without values to be provided.\n" +
-#                                                               "# Remove the 'x' from 'xit' once you have supplied the appropriate values.\n")
-#                 # else
-#                 #   route_parameters_hash[:test_comment].concat("# Remove the 'x' from 'xit' once you have supplied the appropriate value.\n")
-#                 # end
-#             end
-#
-#             ## TRACE.debug "      ROUTE REQUIREMENTS HASH:"
-#             ## TRACE.debug route_parameters_hash.inspect
-#
-#             route_parameters_hash
-#           end
-#
-#           def extract_journey_routes(controller_path, action_method)
-#             Rails.application.routes.routes.routes.select do |route|
-#               if route.defaults.present?
-#                 route.defaults[:controller].to_sym == controller_path.to_sym && route.defaults[:action].to_sym == action_method.to_sym
-#               else
-#                 false
-#               end
-#             end
-#           end
-#
-#           def journey_routes_present(controller)
-#             journey_routes_are_present = false
-#             controller_path = get_app_controller_file_path(controller)
-#             controller.constantize.action_methods.map do |action_method|
-#               journey_routes = extract_journey_routes(controller_path, action_method)
-#               journey_routes_are_present = true if journey_routes.present?
-#             end
-#             journey_routes_are_present
-#           end
-#
-#         end
-#       end
-#     end
-#   end
-# end
-
-
-# def route_matcher_tests
-#   if journey_routes_present(@sm_model_action_controller_controller)
-#     generate_route_matcher_tests(@sm_model_action_controller_controller)
-#   else
-#     []
-#   end
-# end
-#
-#
-# private
-#
-# def generate_route_matcher_tests(controller)
-#   route_tests = []
-#   controller_path = get_app_controller_file_path(controller)
-#   controller.constantize.action_methods.map do |action_method|
-#     journey_routes = extract_journey_routes(controller_path, action_method)
-#     journey_routes.each do |journey_route|
-#       single_route_tests = generate_single_route_tests(journey_route, controller_path, action_method)
-#       route_tests = route_tests + single_route_tests
-#     end
-#   end
-#   format_tests(route_tests)
-# end
-#
-# def generate_single_route_tests(journey_route, controller_path, action_method)
-#   single_route_tests = []
-#   route_parameters_hash = generate_route_parameters_hash(journey_route)
-#   url = url_for({controller: controller_path, action: action_method, only_path: true}.merge(route_parameters_hash.except(:test_comment)))
-#   if url.present?
-#     request_methods = get_request_methods(journey_route)
-#     # CONFIRMATION TODO: Determine if this is the proper way to handle controller actions with multiple HTTP verbs
-#     request_methods.each do |request_method|
-#       single_route_test = generate_route_test_single_line(journey_route, url, controller_path, action_method, request_method)
-#       if single_route_test.length > @working_generated_code_line_length
-#         single_route_test = generate_route_test_multiple_line(single_route_test)
-#       end
-#       single_route_tests << single_route_test
-#     end
-#   end
-#   single_route_tests
-# end
-#
-# def generate_route_test_single_line(journey_route, url, controller_path, action_method, request_method)
-#   route_parameters_hash = generate_route_parameters_hash(journey_route)
-#   route_test = "  it { is_expected.to route(#{ request_method }, '#{ url }').to('#{ controller_path }##{ action_method }'"
-#   if route_parameters_hash.present?
-#     route_test.concat(", #{ route_parameters_hash.except(:test_comment).to_s.gsub("{", "{ ").gsub("{  ", "{ ").gsub("}", " }").gsub("  }", " }") }")
-#   end
-#   route_test.concat(") }")
-#   if route_parameters_hash[:test_comment] =~ /#\s/
-#     route_test.prepend(route_parameters_hash[:test_comment])
-#   end
-#   route_test
-# end
-#
-# def generate_route_test_multiple_line(route_test)
-#   route_test.gsub!("  it { ", "  it do\n    ").gsub!(").to(", ").\n      to(").gsub!(/\)\s\}$/, ")\n  end")
-# end
-#
-# def get_request_methods(journey_route)
-#   request_method_regex = journey_route.constraints[:request_method]
-#   request_method_regex.to_s.scan(/[A-Z]+/)
-# end
-#
-# def generate_route_parameters_hash(journey_route)
-#
-#   if journey_route.required_keys.size > 2
-#    # TRACE.debug ""
-#    # TRACE.debug ""
-#    # TRACE.debug ""
-#     ## TRACE.debug "      ROUTE APP:"
-#     ## TRACE.debug journey_route.app.inspect
-#    # TRACE.debug "      ROUTE CONSTRAINTS:"
-#    # TRACE.debug journey_route.defaults.inspect
-#     ## TRACE.debug "      ROUTE DEFAULTS:"
-#     ## TRACE.debug journey_route.defaults.inspect
-#     ## TRACE.debug "      ROUTE NAME:"
-#     ## TRACE.debug journey_route.name.inspect
-#     ## TRACE.debug "      ROUTE PATH:"
-#     ## TRACE.debug journey_route.path.inspect
-#     ## TRACE.debug "      ROUTE PRECENDENCE:"
-#     ## TRACE.debug journey_route.precedence.inspect
-#     ## TRACE.debug "      ROUTE OPTIONAL PARTS:"
-#     ## TRACE.debug journey_route.optional_parts.inspect
-#     ## TRACE.debug "      ROUTE PARTS:"
-#     ## TRACE.debug journey_route.parts.inspect
-#     ## TRACE.debug "      ROUTE REQUIRED DEFAULTS:"
-#     ## TRACE.debug journey_route.required_defaults.inspect
-#    # TRACE.debug "      ROUTE REQUIRED KEYS: " + journey_route.required_keys.inspect
-#     ## TRACE.debug "      ROUTE REQUIRED PARTS:"
-#     ## TRACE.debug journey_route.required_parts.inspect
-#     # journey_route.required_parts.each do |rp|
-#     #  # TRACE.debug "      ROUTE REQUIRED PART:       " + rp.to_s
-#     #  # TRACE.debug "      ROUTE REQUIRED PART CLASS: " + rp.class.name.to_s
-#     # end
-#    # TRACE.debug "      ROUTE REQUIREMENTS:"
-#    # TRACE.debug journey_route.requirements.inspect
-#     ## TRACE.debug "      ROUTE REQUIREMENTS KEYS:"
-#     ## TRACE.debug journey_route.requirements.keys.inspect
-#     ## TRACE.debug "      ROUTE SEGMENTS:"
-#     ## TRACE.debug journey_route.segments.inspect
-#     ## TRACE.debug "      ROUTE VERB:"
-#     ## TRACE.debug journey_route.verb.inspect
-#
-#    # TRACE.debug ""
-#    # TRACE.debug "      ROUTE REQUIRED KEYS WITHOUT VALUES:"
-#     require_keys_with_missing_values = journey_route.required_keys - journey_route.requirements.keys
-#    # TRACE.debug require_keys_with_missing_values.inspect
-#
-#
-#   end
-#
-#   route_parameters_hash = journey_route.requirements.select { |key, value| journey_route.parts.include? key }
-#   route_required_keys_with_missing_values = journey_route.required_keys - journey_route.requirements.keys
-#   if route_required_keys_with_missing_values.include? :id
-#     route_parameters_hash[:id] = 1
-#     route_required_keys_with_missing_values.delete(:id)
-#   end
-#   # CONFIRMATION TODO: Determine if this is the proper way to handle route parts that do no have a required value provided
-#   if route_required_keys_with_missing_values.present?
-#     route_required_keys_with_missing_values.each do |key_without_value|
-#       route_parameters_hash[key_without_value] = "<value required>"
-#     end
-#     if route_required_keys_with_missing_values.size == 1
-#       route_parameters_hash[:test_comment] = "# A required value needs to be provided for route part '#{ route_required_keys_with_missing_values[0] }'.\n" +
-#                                              "# Remove the 'x' from 'xit' once you have supplied an appropriate value.\n"
-#     else
-#       route_parameters_hash[:test_comment] = "# Required values need to be provided for route parts '#{ route_required_keys_with_missing_values.to_s }'.\n" +
-#                                              "# Remove the 'x' from 'xit' once you have supplied the appropriate values.\n"
-#     end
-#   else
-#     route_parameters_hash[:test_comment] = ""
-#   end
-#
-#   # journey_route.requirements.each do |req_key, req_value |
-#   #   route_parameters_hash[req_key] = req_value
-#   # end
-#   # if journey_route.defaults[:format]
-#   #   route_parameters_hash.reverse_merge!({ format: journey_route.defaults[:format] })
-#   # end
-#
-#  # TRACE.debug "      ROUTE REQUIREMENTS HASH:"
-#  # TRACE.debug route_parameters_hash.inspect
-#
-#   route_parameters_hash
-# end
-#
-# def extract_journey_routes(controller_path, action_method)
-#   Rails.application.routes.routes.routes.select do |route|
-#     if route.defaults.present?
-#       route.defaults[:controller].to_sym == controller_path.to_sym && route.defaults[:action].to_sym == action_method.to_sym
-#     else
-#       false
-#     end
-#   end
-# end
-#
-# def journey_routes_present(controller)
-#   journey_routes_are_present = false
-#   controller_path = get_app_controller_file_path(controller)
-#   controller.constantize.action_methods.map do |action_method|
-#     journey_routes = extract_journey_routes(controller_path, action_method)
-#     journey_routes_are_present = true if journey_routes.present?
-#   end
-#   journey_routes_are_present
-# end

data/lib/model/active_record/matchmakers/have_db_index.rb

@@ -5,7 +5,7 @@ module ShouldaMatchmakers
         module HaveDbIndex
 
           def have_db_index_matcher_tests
-            # IMPLEMENTATION TODO: Determine if it is possible to indexes where 'using=:gin' (or anything not :btree)
+            # IMPLEMENTATION TODO: Determine if it is possible to handle indexes where 'using=:gin' (or anything not :btree)
             db_indexes = ::ActiveRecord::Base.connection.indexes(@app_class_name.tableize.gsub("/", "_")).select{ |ndx| ndx.using == :btree }
             if db_indexes.present?
               generate_have_db_index_matcher_tests(db_indexes)