spec_producer 0.11.0 → 0.13.0

data/lib/spec_producer/spec_production_module.rb

@@ -1,114 +1,6 @@
-module SpecProducer::SpecProductionModule
-  def self.produce_specs_for_models
-    Dir.glob(Rails.root.join('app/models/*.rb')).each do |x|
-      require x
-    end
-    
-    not_valid_descendants = [ ActiveRecord::SchemaMigration, Delayed::Backend::ActiveRecord::Job ]
-
-    ActiveRecord::Base.descendants.reject { |descendant| not_valid_descendants.include? descendant }.each do |descendant|
-      final_text = "require '#{require_helper_string}'\n\n"
-      final_text << "describe #{descendant.name}, :type => :model do\n"
-
-      descendant.attribute_names.each do |attribute|
-        final_text << "  it { should respond_to :#{attribute}, :#{attribute}= }\n"
-      end
-
-      descendant.readonly_attributes.each do |attribute|
-        final_text << "  it { should have_readonly_attribute :#{attribute} }\n"
-      end
-
-      if descendant.validators.reject { |validator| validator.kind == :associated }.present?
-        final_text << "\n  # Validators\n"
-      end
-
-      descendant.validators.each do |validator|
-        if validator.kind == :presence
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_presence_of :#{attribute} }\n"
-          end
-        elsif validator.kind == :uniqueness
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_uniqueness_of :#{attribute} }\n"
-          end
-        elsif validator.kind == :numericality
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_numericality_of :#{attribute} }\n"
-          end
-        elsif validator.kind == :acceptance
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_acceptance_of :#{attribute} }\n"
-          end
-        elsif validator.kind == :confirmation
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_confirmation_of :#{attribute} }\n"
-          end
-        elsif validator.kind == :length
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_length_of :#{attribute} }\n"
-          end
-        elsif validator.kind == :absence
-          validator.attributes.each do |attribute|
-            final_text << "  it { should validate_absence_of :#{attribute} }\n"
-          end
-        end
-      end
-
-      if descendant.column_names.present?
-        final_text << "\n  # Columns\n"
-      end
-
-      descendant.column_names.each do |column_name|
-        final_text << "  it { should have_db_column :#{column_name} }\n"
-      end
-
-      if descendant.reflections.keys.present?
-        final_text << "\n  # Associations\n"
-      end
-
-      descendant.reflections.each_pair do |key, reflection|
-        final_text << case reflection.macro
-                        when :belongs_to then "  it { should belong_to(:#{key})#{produce_association_options(reflection)} }\n"
-                        when :has_one then "  it { should have_one(:#{key})#{produce_association_options(reflection)} }\n"
-                        when :has_many then "  it { should have_many(:#{key})#{produce_association_options(reflection)} }\n"
-                        when :has_and_belongs_to_many then "  it { should have_and_belong_to_many(:#{key})#{produce_association_options(reflection)} }\n"
-                      end
-      end
-
-      final_text << "end"
-
-      if File.exists?(Rails.root.join("spec/models/#{descendant.name.underscore}_spec.rb"))
-        if File.open(Rails.root.join("spec/models/#{descendant.name.underscore}_spec.rb")).read == final_text
-          # nothing to do here, pre-existing content is the same :)
-        else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + descendant.name.underscore + "_spec.rb\n"
-          puts '#'*100
-          puts "\n"
-          puts final_text
-        end
-      else
-        check_if_spec_folder_exists
-
-        unless Dir.exists? Rails.root.join("spec/models")
-          puts "Generating spec/models directory"
-          Dir.mkdir(Rails.root.join("spec/models"))
-        end
-
-        path = "spec/models/#{descendant.name.underscore}_spec.rb"
-        puts "Producing model spec file for: #{path}"
-        f = File.open("#{Rails.root.join(path)}", 'wb+')
-        f.write(final_text)
-        f.close
-      end
-    end
+require 'colorize'
 
-    nil
-  rescue NameError
-    puts "ActiveRecord is not set for this project. Skipping model specs production."
-  rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping model specs production."
-  end
+module SpecProducer::SpecProductionModule
 
   def self.produce_specs_for_routes
     routes = Rails.application.routes.routes.map do |route|
@@ -147,17 +39,17 @@ module SpecProducer::SpecProductionModule
         if File.open(Rails.root.join("spec/routing/#{route_group[0]}_routing_spec.rb")).read == final_text
           # nothing to do here, pre-existing content is the same :)
         else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: spec/routing/#{route_group[0]}_routing_spec.rb\n"
-          puts '#'*100
-          puts "\n"
+          puts ('#'*100).colorize(:light_blue)
+          puts "Please, check whether the following lines are included in: spec/routing/#{route_group[0]}_routing_spec.rb".colorize(:light_blue)
+          puts ('#'*100).colorize(:light_blue)
           puts final_text
+          puts "\n\n"
         end
       else
         check_if_spec_folder_exists
 
         unless Dir.exists? Rails.root.join("spec/routing")
-          puts "Generating spec/routing directory"
+          puts "Generating spec/routing directory".colorize(:yellow)
           Dir.mkdir(Rails.root.join("spec/routing"))
         end
 
@@ -179,7 +71,7 @@ module SpecProducer::SpecProductionModule
         end
 
         path = "spec/routing/#{route_group[0]}_routing_spec.rb"
-        puts "Producing routing spec file for: #{route_group[0]}"
+        puts "Producing routing spec file for: #{route_group[0]}".colorize(:green)
         f = File.open("#{Rails.root.join(path)}", 'wb+')
         f.write(final_text)
         f.close
@@ -188,7 +80,7 @@ module SpecProducer::SpecProductionModule
 
     nil
   rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping route specs production."
+    puts "Exception '#{e}' was raised. Skipping route specs production.".colorize(:red)
   end
 
   def self.produce_specs_for_views
@@ -212,17 +104,20 @@ module SpecProducer::SpecProductionModule
       templates_in_file = file_content.scan(/render ('|")(?<template>\S*)('|")/).flatten.uniq
       partials_in_file = file_content.scan(/render :partial => ('|")(?<partial>\S*)('|")/).flatten.uniq
       links_in_file = file_content.scan(/<a.*href=\"(\S*)\".*>(.*)<\/a>/).uniq
+      conditions_in_file = file_content.scan(/if (?<condition>.*)%>/).flatten.uniq
+      unless_conditions_in_file = file_content.scan(/unless (?<condition>.*)%>/).flatten.uniq
+      submit_tags_in_file = file_content.scan(/submit_tag (?<value>.*),/).flatten.uniq
 
       file_name = "#{file.gsub('app/', 'spec/')}_spec.rb"
       final_text = "require '#{require_helper_string}'\n\n"
       final_text << "describe '#{file.gsub('app/views/', '')}', :type => :view do\n"
-      final_text << "  let(:page) { Capybara::Node::Simple.new(rendered) }\n\n"
+      final_text << "  let(:page) { Capybara::Node::Simple.new(rendered) }\n"
 
       objects_in_file.each do |object|
-        final_text << "  let(:#{object}) { '#{object}' }\n"
+        final_text << "\n  let(:#{object}) { '#{object}' }"
       end
-      
-      final_text << "  subject { page }\n\n"
+
+      final_text << "\n  subject { page }\n\n"
       final_text << "  before do\n"
 
       objects_in_file.each do |object|
@@ -235,76 +130,39 @@ module SpecProducer::SpecProductionModule
       final_text << "  describe 'content' do\n"
 
       fields_in_file.each do |field_name|
-        final_text << "    it { should have_field '#{ field_name }' }\n"
-      end  
+        final_text << "    it { is_expected.to have_field '#{ field_name }' }\n"
+      end
+
+      submit_tags_in_file.each do |field_name|
+        final_text << "    it { is_expected.to have_css \"input[type='submit'][value=#{ field_name }]\" }\n"
+      end
 
       templates_in_file.each do |template_name|
         template_path_elements = template_name.split('/')
         template_path_elements.last.gsub!(/^/, '_')
 
-        final_text << "    it { should render_template '#{ template_path_elements.join('/') }' }\n"
+        final_text << "    it { is_expected.to render_template '#{ template_path_elements.join('/') }' }\n"
       end
 
       partials_in_file.each do |partial_name|
-        final_text << "    it { should render_template(:partial => '#{ partial_name }') }\n"
+        final_text << "    it { is_expected.to render_template(:partial => '#{ partial_name }') }\n"
       end
 
       links_in_file.each do |link|
-        final_text << "    it { should have_link '#{link[1]}', :href => '#{link[0]}' }\n"
-      end
-
-      final_text << "    pending 'view content test'\n"
-      final_text << "  end\n"
-      final_text << "end\n"
-
-      check_if_spec_folder_exists
-
-      if File.exists?(Rails.root.join(file_name))
-        if File.open(Rails.root.join(file_name)).read == final_text
-          # nothing to do here, pre-existing content is the same :)
-        else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + file_name + "\n"
-          puts '#'*100
-          puts "\n"
-          puts final_text
-        end
-      else
-        puts "Producing view spec file for: #{file_name}"
-        f = File.open(file_name, 'wb+')
-        f.write(final_text)
-        f.close
+        final_text << "    it { is_expected.to have_link '#{link[1]}', :href => '#{link[0]}' }\n"
       end
-    end
 
-    nil
-  rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping view specs production."
-  end
-
-  def self.produce_specs_for_helpers
-    helpers_list = ActionController::Base.modules_for_helpers(ActionController::Base.all_helpers_from_path 'app/helpers')
-
-    helpers_list.each do |helper|
-      file_name = "spec/helpers/#{helper.name.gsub("::", "/").underscore}_spec.rb"
-      full_path = 'spec'
-      file_name.gsub("spec/", "").split("/").each do |path|
-        unless /.*\.rb/.match path
-          full_path << "/#{path}"
-
-          unless Dir.exists? full_path
-            Dir.mkdir(Rails.root.join(full_path))
-          end
-        end
+      conditions_in_file.each do |condition|
+        final_text << "    pending 'if #{condition.strip}'\n"
       end
 
-      final_text = "require '#{require_helper_string}'\n\n"
-      final_text << "describe #{helper}, :type => :helper do\n"
-      helper.instance_methods.each do |method_name|
-        final_text << "  pending '#{method_name.to_s}'\n"
+      unless_conditions_in_file.each do |condition|
+        final_text << "    pending 'unless #{condition.strip}'\n"
       end
 
-      final_text << "end"
+      final_text << "    pending 'view content test'\n"
+      final_text << "  end\n"
+      final_text << "end\n"
 
       check_if_spec_folder_exists
 
@@ -312,14 +170,14 @@ module SpecProducer::SpecProductionModule
         if File.open(Rails.root.join(file_name)).read == final_text
           # nothing to do here, pre-existing content is the same :)
         else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + file_name + "\n"
-          puts '#'*100
-          puts "\n"
+          puts ('#'*100).colorize(:light_blue)
+          puts ("Please, check whether the following lines are included in: " + file_name).colorize(:light_blue)
+          puts ('#'*100).colorize(:light_blue)
           puts final_text
+          puts "\n\n"
         end
       else
-        puts "Producing helper spec file for: #{file_name}"
+        puts "Producing view spec file for: #{file_name}".colorize(:green)
         f = File.open(file_name, 'wb+')
         f.write(final_text)
         f.close
@@ -328,7 +186,7 @@ module SpecProducer::SpecProductionModule
 
     nil
   rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping helper specs production."
+    puts "Exception '#{e}' was raised. Skipping view specs production.".colorize(:red)
   end
 
   def self.produce_specs_for_mailers
@@ -349,7 +207,17 @@ module SpecProducer::SpecProductionModule
       file_name = "#{file.gsub('app/', 'spec/').gsub('.rb', '')}_spec.rb"
       final_text = "require '#{require_helper_string}'\n\n"
       final_text << "describe #{File.basename(file, ".rb").camelcase}, :type => :mailer do\n"
-      final_text << "  pending 'mailer tests'\n"
+      final_text << "  pending 'mailer tests' do\n"
+      final_text << "    let(:mail) { #{File.basename(file, ".rb").camelcase}.action }\n"
+      final_text << "    it 'renders the headers' do\n"
+      final_text << "      expect(mail.subject).to eq('subject')\n"
+      final_text << "      expect(mail.to).to eq('receiver@example.com')\n"
+      final_text << "      expect(mail.from).to eq('sender@example.com')\n"
+      final_text << "    end\n\n"
+      final_text << "    it 'renders the body' do\n"
+      final_text << "      expect(mail.body.encoded).to match('The body!')\n"
+      final_text << "    end\n"
+      final_text << "  end\n"
       final_text << "end"
 
       check_if_spec_folder_exists
@@ -358,14 +226,14 @@ module SpecProducer::SpecProductionModule
         if File.open(Rails.root.join(file_name)).read == final_text
           # nothing to do here, pre-existing content is the same :)
         else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + file_name + "\n"
-          puts '#'*100
-          puts "\n"
+          puts ('#'*100).colorize(:light_blue)
+          puts ("Please, check whether the following lines are included in: " + file_name).colorize(:light_blue)
+          puts ('#'*100).colorize(:light_blue)
           puts final_text
+          puts "\n\n"
         end
       else
-        puts "Producing helper spec file for: #{file_name}"
+        puts "Producing helper spec file for: #{file_name}".colorize(:green)
         f = File.open(file_name, 'wb+')
         f.write(final_text)
         f.close
@@ -374,7 +242,7 @@ module SpecProducer::SpecProductionModule
 
     nil
   rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping mailer specs production."
+    puts "Exception '#{e}' was raised. Skipping mailer specs production.".colorize(:red)
   end
 
   def self.produce_specs_for_jobs
@@ -395,135 +263,37 @@ module SpecProducer::SpecProductionModule
       file_name = "#{file.gsub('app/', 'spec/').gsub('.rb', '')}_spec.rb"
       final_text = "require '#{require_helper_string}'\n\n"
       final_text << "describe #{File.basename(file, ".rb").camelcase}, :type => :job do\n"
-      final_text << "  pending 'job tests'\n"
-      final_text << "end"
-
-      check_if_spec_folder_exists
-
-      if File.exists?(Rails.root.join(file_name))
-        if File.open(Rails.root.join(file_name)).read == final_text
-          # nothing to do here, pre-existing content is the same :)
-        else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + file_name + "\n"
-          puts '#'*100
-          puts "\n"
-          puts final_text
-        end
-      else
-        puts "Producing job spec file for: #{file_name}"
-        f = File.open(file_name, 'wb+')
-        f.write(final_text)
-        f.close
-      end
-    end
-
-    nil
-  rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping job specs production."
-  end
-
-  def self.produce_specs_for_serializers
-    Dir.glob(Rails.root.join('app/serializers/*.rb')).each do |x|
-      require x
-    end
-
-    not_valid_descendants = [ ActiveModel::Serializer::ErrorSerializer ]
-
-    ActiveModel::Serializer.descendants.reject { |descendant| not_valid_descendants.include? descendant }.each do |descendant|
-      final_text = "require '#{require_helper_string}'\n\n"
-      final_text << "describe #{descendant.name}, :type => :serializer do\n"
-
-      final_text << "  describe 'serializer tests' do\n"
-      final_text << "    subject { #{descendant.name}.new(FactoryGirl.build(:#{descendant.name.underscore.gsub('_serializer', '')})) }\n\n"
-      final_text << "    it 'includes the expected attributes' do\n"
-      final_text << "      expect(subject.attributes.keys).to contain_exactly(#{descendant._attributes.map { |x| ":#{x.to_s}" }.join(', ')})\n"
-      final_text << "      expect(subject.attributes).to eq({})\n"
-      final_text << "    end\n"
+      final_text << "  include ActiveJob::TestHelper\n\n"
+      final_text << "  subject(:job) { described_class.perform_later(123) }\n\n"
+      final_text << "  it 'queues the job' do\n"
+      final_text << "    expect { job }.to change(ActiveJob::Base.queue_adapter.enqueued_jobs, :size).by(1)\n"
+      final_text << "  end\n\n"
+      final_text << "  it 'is in proper queue' do\n"
+      final_text << "    expect(#{File.basename(file, ".rb").camelcase}.new.queue_name).to eq('default')\n"
+      final_text << "  end\n\n"
+      final_text << "  pending 'executes perform' do\n"
+      final_text << "    perform_enqueued_jobs { job }\n"
+      final_text << "  end\n\n"
+      final_text << "  after do\n"
+      final_text << "    clear_enqueued_jobs\n"
+      final_text << "    clear_performed_jobs\n"
       final_text << "  end\n"
       final_text << "end"
 
-      if File.exists?(Rails.root.join("spec/serializers/#{descendant.name.underscore}_spec.rb"))
-        if File.open(Rails.root.join("spec/serializers/#{descendant.name.underscore}_spec.rb")).read == final_text
-          # nothing to do here, pre-existing content is the same :)
-        else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + descendant.name.underscore + "_spec.rb\n"
-          puts '#'*100
-          puts "\n"
-          puts final_text
-        end
-      else
-        check_if_spec_folder_exists
-
-        unless Dir.exists? Rails.root.join("spec/serializers")
-          puts "Generating spec/serializers directory"
-          Dir.mkdir(Rails.root.join("spec/serializers"))
-        end
-
-        path = "spec/serializers/#{descendant.name.underscore}_spec.rb"
-        puts "Producing serializer spec file for: #{path}"
-        f = File.open("#{Rails.root.join(path)}", 'wb+')
-        f.write(final_text)
-        f.close
-      end
-    end
-
-    nil
-  rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping serializer specs production."
-  end
-
-  def self.produce_specs_for_controllers
-    Dir.glob(Rails.root.join('app/controllers/**/*.rb')).each do |x|
-      require x
-    end
-
-    controllers = ApplicationController.descendants
-    controllers << ApplicationController
-
-    controllers.each do |descendant|
-      path_name = 'app/controllers/' + descendant.name.split('::').map { |name| name.underscore }.join('/')
-
-      full_path = 'spec'
-      File.dirname(path_name.gsub('app/', 'spec/')).split('/').reject { |path| path == 'spec' }.each do |path|
-        unless /.*\.rb/.match path
-          full_path << "/#{path}"
-
-          unless Dir.exists? full_path
-            Dir.mkdir(Rails.root.join(full_path))
-          end
-        end
-      end
-
-      file_name = "#{path_name.gsub('app/', 'spec/')}_spec.rb"
-      final_text = "require '#{require_helper_string}'\n\n"
-      final_text << "describe #{descendant.name}, :type => :controller do\n"
-
-      descendant.action_methods.each do |method|
-        final_text << "  pending '##{method}'\n"
-      end
-
-      unless descendant.action_methods.size > 0
-        final_text << "  pending 'tests'\n"
-      end
-
-      final_text << "end\n"
-
       check_if_spec_folder_exists
 
       if File.exists?(Rails.root.join(file_name))
         if File.open(Rails.root.join(file_name)).read == final_text
           # nothing to do here, pre-existing content is the same :)
         else
-          puts '#'*100
-          puts "Please, check whether the following lines are included in: " + file_name + "\n"
-          puts '#'*100
-          puts "\n"
+          puts ('#'*100).colorize(:light_blue)
+          puts ("Please, check whether the following lines are included in: " + file_name).colorize(:light_blue)
+          puts ('#'*100).colorize(:light_blue)
           puts final_text
+          puts "\n\n"
         end
       else
-        puts "Producing controller spec file for: #{file_name}"
+        puts "Producing job spec file for: #{file_name}".colorize(:green)
         f = File.open(file_name, 'wb+')
         f.write(final_text)
         f.close
@@ -532,33 +302,13 @@ module SpecProducer::SpecProductionModule
 
     nil
   rescue Exception => e
-    puts "Exception '#{e}' was raised. Skipping controller specs production."
+    puts "Exception '#{e}' was raised. Skipping job specs production.".colorize(:red)
   end
 
   #######
   private
   #######
 
-  def self.produce_association_options(reflection)
-    return if reflection.options.empty?
-
-    final_text = []
-
-    reflection.options.each_pair do |key, value|
-      final_text << case key
-                      when :inverse_of then "inverse_of(:#{value})"
-                      when :autosave then "autosave(#{value})"
-                      when :through then "through(:#{value})"
-                      when :class_name then "class_name('#{value}')"
-                      when :foreign_key then "with_foreign_key('#{value}')"
-                      when :primary_key then "with_primary_key('#{value}')"
-                      when :source then "source(:#{value})"
-                      when :dependent then "dependent(:#{value})"
-                    end
-    end
-    final_text.reject(&:nil?).join('.').prepend('.')
-  end
-
   def self.require_helper_string
     @require_helper_string ||= collect_helper_strings
   end
@@ -578,19 +328,18 @@ module SpecProducer::SpecProductionModule
     if helper_strings_used.uniq.length == 1
       helper_strings_used.first
     else
-      puts "More than one helpers are in place in your specs! Proceeding with 'rails_helpers'."
+      puts "More than one helpers are in place in your specs! Proceeding with 'rails_helpers'.".colorize(:yellow)
       'rails_helper'
     end
   end
 
   def self.check_if_spec_folder_exists
-     unless Dir.exists? Rails.root.join("spec")
-        puts "Generating spec directory"
-        Dir.mkdir(Rails.root.join("spec"))
-      end
+    unless Dir.exists? Rails.root.join("spec")
+      puts "Generating spec directory".colorize(:yellow)
+      Dir.mkdir(Rails.root.join("spec"))
+    end
   end
 
-  private_class_method :produce_association_options
   private_class_method :require_helper_string
   private_class_method :collect_helper_strings
   private_class_method :check_if_spec_folder_exists