spec_producer 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dc0df225c68f60eaba14c10ce0df5d1e034a700
-  data.tar.gz: 154ac15712e0627720352253248b53f55e788544
+  metadata.gz: 99eb0473031f263db6636d226b5fccf77a457642
+  data.tar.gz: 5659f755c10d008827383066296556a862abb626
 SHA512:
-  metadata.gz: c22e5ee62ae1a302e6db6d206e0fbb96df5c34900ddc3ff4761505587c3ea992f85dddebe117d1d28188f8deac07767e3b0fd8a79a8a5301997e34dc70a11c51
-  data.tar.gz: 2db9ee13638bf2f18ce909e14cb587bfda6c050447e12c5fef095a1fb07abb2a0a936c82424f6732fe645907a42b0cd6e6e47bdcb5e44dcf9aa2443de204f74d
+  metadata.gz: db4f51442225f9e5939e6391abfe21abc8622406264781e3058beb44c1b4f488d3aedac6715f4ce202b1545167314d4159f7d135567ead401021f3becd97f9c1
+  data.tar.gz: c5619012c248e4c808545bf54ab223be438ae45e7bbbc3eefbb666fc53752ce29660b2cb49f1e713ae7ccc3902ecaceda24b4e0f80e79964ec9014c788029d77

data/.ruby-version

@@ -0,0 +1 @@
+2.2.5

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.13.0 (2017-01-05)
+
+Features:
+* Major refactoring on how specs are produced (some previous functionality may not be supported here)
+* Add rake tasks for each functionality supported
+
+## 0.12.0 (2016-11-8)
+
+Features:
+* Cover more characteristics through static analysis
+* Update serializer specs
+* Colorized responses
+* Run specs after production
+* Initial attempt for command line runs
+
 ## 0.11.0 (2016-10-18)
 
 Features:

data/README.md

@@ -3,15 +3,17 @@
 [![Build Status](https://travis-ci.org/arcanoid/spec_producer.svg?branch=master)](https://travis-ci.org/arcanoid/spec_producer)
 [![Gem Version](https://badge.fury.io/rb/spec_producer.svg)](https://badge.fury.io/rb/spec_producer)
 
-SpecProducer is a gem that is meant to assist users in skipping the tedious work of creating spec tests for basic 
-functionality. It reads through the files of the project and prepares some of the basic spec tests for you. 
+SpecProducer is a library that is meant to assist users in skipping the tedious work of creating spec tests for basic
+Rails applications. It reads through Active Record subclasses of the project and prepares some of the basic spec tests for you.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'spec_producer'
+group :development do
+  gem 'spec_producer'
+end
 ```
 
 And then execute:
@@ -24,83 +26,130 @@ Or install it yourself as:
 
 ## Usage
 
-Currently this gem supports the production of spec tests for activemodel Models and routing specs. 
-If the spec file already exists then it prints what could be its contents.
+Currently this gem supports the production of spec tests for active record models.
+If the spec file already exists then it prints out the contents it would generated
+for a model.
 
-To produce all possible tests, run:
+To produce all possible tests you can run the public API methods directly from a Rails console
+or use the rake tasks provided by the gem (run rake -T | grep spec_producer for all available rake tasks)
+on  a rails project.
 
 ```ruby
-SpecProducer.produce_specs_for_all_types
-```
+  # Using a rake task (currently supports producing only model specs)
+  bundle exec rake spec_producer:all
 
-To produce all tests for models, run:
+  #or produce all tests for models:
 
-```ruby
-SpecProducer.produce_specs_for_models
+  bundle exec rake spec_producer:models
 ```
 
 To produce all tests for routes, run:
 
 ```ruby
-SpecProducer.produce_specs_for_routes
+bundle exec rake spec_producer:routes
 ```
 
 To produce all spec files for views, run:
 
 ```ruby
-SpecProducer.produce_specs_for_views
+bundle exec rake spec_producer:views
 ```
 
 To produce all spec files for helpers, run:
 
 ```ruby
-SpecProducer.produce_specs_for_helpers
+bundle exec rake spec_producer:helpers
 ```
 
 To produce all spec files for controllers, run:
 
 ```ruby
-SpecProducer.produce_specs_for_controllers
+bundle exec rake spec_producer:controllers
+```
+
+To produce all spec files for jobs, run:
+
+```ruby
+bundle exec rake spec_producer:jobs
+```
+
+To produce all spec files for mailers, run:
+
+```ruby
+bundle exec rake spec_producer:mailers
+```
+
+To produce all spec files for serializers, run:
+
+```ruby
+bundle exec rake spec_producer:serializers
+```
+
+In case you have factory_girl gem installed, to produce a list of sample factory files for your models, run:
+
+```ruby
+bundle exec rake spec_producer:factories
 ```
 
 Additionally this gem (from version 0.2.0) allows users to print all their missing spec files by reading all 
-directories for Views, Models, Controllers and Helpers.
+directories for Views, Models, Controllers, Helpers etc.
 
 To print all types of missing tests, run:
 
 ```ruby
-SpecProducer.print_all_missing_spec_files
+bundle exec rake missing_specs_printer:all
 ```
 
 To print all missing model tests, run:
 
 ```ruby
-SpecProducer.print_missing_model_specs
+bundle exec rake missing_specs_printer:models
 ```
 
 To print all missing controller tests, run:
 
 ```ruby
-SpecProducer.print_missing_controller_specs
+bundle exec rake missing_specs_printer:controllers
 ```
 
 To print all missing helper tests, run:
 
 ```ruby
-SpecProducer.print_missing_helper_specs
+bundle exec rake missing_specs_printer:helpers
 ```
 
 To print all missing view tests, run:
 
 ```ruby
-SpecProducer.print_missing_view_specs
+bundle exec rake missing_specs_printer:views
 ```
 
-## Development
+To print all missing job tests, run:
+
+```ruby
+bundle exec rake missing_specs_printer:jobs
+```
+
+To print all missing mailer tests, run:
+
+```ruby
+bundle exec rake missing_specs_printer:mailers
+```
 
-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.
+To print all missing route tests, run:
 
-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).
+```ruby
+bundle exec rake missing_specs_printer:routes
+```
+
+To print all missing serializer tests, run:
+
+```ruby
+bundle exec rake missing_specs_printer:serializers
+```
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
 ## Contributing
 

data/lib/configuration.rb

@@ -0,0 +1,41 @@
+module SpecProducer
+  module Configuration
+    CURRENT_ATTRS = [:raise_errors].freeze
+    DEPRECATED_ATTRS = [].freeze
+    CONFIG_ATTRS = (CURRENT_ATTRS + DEPRECATED_ATTRS).freeze
+
+    def configure
+      return unless block_given?
+      yield config
+    end
+
+    def configuration
+      config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+    private :config
+
+    class Configuration < Struct.new(*CONFIG_ATTRS)
+      def initialize
+        super
+
+        set_default_values
+      end
+
+      def options
+        Hash[ * CONFIG_ATTRS.map { |key| [key, send(key)] }]
+      end
+
+      #######
+      private
+      #######
+      
+      def set_default_values
+        self.raise_errors = true
+      end
+    end
+  end
+end

data/lib/generators/spec_producer/install/install_generator.rb

@@ -0,0 +1,13 @@
+module SpecProducer
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Adds spec_generator in bin/ folder"
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_executable
+        template "spec_producer", "bin/spec_producer.rb"
+      end
+    end
+
+  end
+end

data/lib/generators/spec_producer/install/templates/spec_producer

@@ -0,0 +1 @@
+# Basic bin/generator to add

data/lib/spec_producer.rb

@@ -1,82 +1,147 @@
 require "spec_producer/version"
+
+require 'spec_producer/railtie'
+
 require "spec_producer/missing_files_module"
+require "spec_producer/missing_gems_module"
 require "spec_producer/spec_production_module"
 require "spec_producer/factories_production_module"
 
+require 'active_support/core_ext/module/delegation'
+
+require 'spec_producer/producers'
+require 'spec_producer/rspec_builders'
+require 'spec_producer/spec_runner'
+
+require 'configuration'
+
 module SpecProducer
+  extend Configuration
+  # == Spec \Producer
+  # Produces specs for the given type(s)
+  #
+  # To produce all spec you simply run:
+  #   SpecProducer.produce
+  #
+  # You can provide some options to tell the producer to include or exclude some specs
+  # Example with <tt>:include</tt> option
+  #
+  #   SpecProducer.produce(only: [:models, :controllers])
+  #
+  # Example with <tt>exclude</tt> option
+  #   SpecProducer.produce(except: :views)
+  #
+  #
+  # We can produce specs for a single type by calling 
+  #
+  #   SpecProducer.produce_spec(:models)
+  #
+  # 
+  # To add a new type of a Producer (Concrete class under spec_producer/producers) for a given type
+  # we need to register it in this class. For example if we want to implement ControllersProducer
+  # we would register it as follows:
+  #
+  #   register(:models, Producers::ControllersProducer)
+  #
+  # This gives as the convention to lookup producers using a symbol and later on we can add
+  # extra functionality when registering a producer (optional params, init with lambdas etc.)
+  #
+
+  @registry = Producers::Registry.new
+
+  class << self
+    attr_reader :registry
+    delegate :run, to: SpecRunner
+
+    def produce(*args)
+      opts = args.extract_options!
+      spec_types = registry.types
+
+      if only = opts[:only]
+        spec_types &= Array(only).map(&:to_sym)
+      elsif except = opts[:except]
+        spec_types -= Array(except).map(&:to_sym)
+      end
+
+      # Produce the specs
+      spec_types.each { |t| produce_spec(t) }
+
+      # Run the specs
+      run(spec_types) if opts[:run_specs]
+    end
+
+    def register(type_name, klass)
+      registry.register(type_name, klass)
+    end
+
+    # Produces a single spec type. For example
+    #
+    #   SpecProducer.produce_spec(:models)
+    #
+    # Will fetch and execute the Producers::ModelsSpecProducer
+    #
+    def produce_spec(spec_type)
+      lookup!(spec_type)
+    end
+
+    # Fetches the producer from the registry. Note: that the #lookup method
+    # on registry instantiates and executes the producer to start generating
+    # the spec files. This execution is hidden in repository and the client 
+    # is not aware of what is going on underneath. TODO: Refactor this so
+    # registry#lookup! does not executes the regitered Producer.
+    #
+    # If no Producer is Found an ArgumentError exception is thown.
+    #
+    def lookup!(spec_type)
+      registry.lookup!(spec_type)
+    end
+  end
+
+  # Register new producers
+  register(:models, Producers::ModelsProducer)
+  register(:views, Producers::ViewsProducer)
+  register(:controllers, Producers::ControllersProducer)
+  register(:helpers, Producers::HelpersProducer)
+  register(:routes, Producers::RoutesProducer)
+  register(:mailers, Producers::MailersProducer)
+  register(:jobs, Producers::JobsProducer)
+  register(:serializers, Producers::SerializersProducer)
+
   def self.produce_specs_for_all_types
-    set_up_necessities
-    SpecProductionModule.produce_specs_for_models
     SpecProductionModule.produce_specs_for_routes
     SpecProductionModule.produce_specs_for_views
-    SpecProductionModule.produce_specs_for_controllers
-    SpecProductionModule.produce_specs_for_helpers
     SpecProductionModule.produce_specs_for_mailers
     SpecProductionModule.produce_specs_for_jobs
-    SpecProductionModule.produce_specs_for_serializers
-  end
 
-  def self.produce_specs_for_models
-    SpecProductionModule.produce_specs_for_models
+    run_spec_tests
   end
 
   def self.produce_specs_for_routes
     SpecProductionModule.produce_specs_for_routes
+
+    run_spec_tests 'routes'
   end
 
   def self.produce_specs_for_views
     SpecProductionModule.produce_specs_for_views
-  end
 
-  def self.produce_specs_for_controllers
-    SpecProductionModule.produce_specs_for_controllers
-  end
-
-  def self.produce_specs_for_helpers
-    SpecProductionModule.produce_specs_for_helpers
+    run_spec_tests 'views'
   end
 
   def self.produce_specs_for_mailers
     SpecProductionModule.produce_specs_for_mailers
+
+    run_spec_tests 'mailers'
   end
 
   def self.produce_specs_for_jobs
     SpecProductionModule.produce_specs_for_jobs
-  end
 
-  def self.produce_specs_for_serializers
-    SpecProductionModule.produce_specs_for_serializers
+    run_spec_tests 'jobs'
   end
 
   def self.set_up_necessities
-    gemfiles = Dir.glob(Rails.root.join('Gemfile'))
-
-    if gemfiles.size > 0
-      contents = File.read(gemfiles.first)
-      gems = contents.scan(/gem \'(?<gem>\S*)\'/).flatten.uniq
-      missing_gems = []
-
-      missing_gems << 'rspec-rails' unless (gems.include? 'rspec-rails')
-      missing_gems << 'factory_girl_rails' unless (gems.include? 'factory_girl_rails')
-      missing_gems << 'shoulda-matchers' unless (gems.include? 'shoulda-matchers')
-      missing_gems << 'capybara' unless (gems.include? 'capybara')
-
-      if missing_gems.size > 0
-        contents << "\ngroup :test do\n"
-
-        missing_gems.each do |gem|
-          contents << "  gem '#{gem}'\n"
-        end
-
-        contents << "end"
-      end
-
-      f = File.open(gemfiles.first, 'wb+')
-      f.write(contents)
-      f.close
-    else
-      puts "We couldn't find a Gemfile and setting up halted!"
-    end
+    MissingGemsModule.set_up_necessities
   end
 
   def self.produce_factories
@@ -90,6 +155,8 @@ module SpecProducer
     MissingFilesModule.print_missing_view_specs(options)
     MissingFilesModule.print_missing_mailer_specs(options)
     MissingFilesModule.print_missing_job_specs(options)
+    MissingFilesModule.print_missing_serializer_specs(options)
+    MissingFilesModule.print_missing_route_specs(options)
   end
 
   def self.print_missing_model_specs(options = {})
@@ -115,4 +182,30 @@ module SpecProducer
   def self.print_missing_job_specs(options = {})
     MissingFilesModule.print_missing_job_specs(options)
   end
-end
+
+  def self.print_missing_serializer_specs(options = {})
+    MissingFilesModule.print_missing_serializer_specs(options)
+  end
+
+  def self.print_missing_route_specs(options = {})
+    MissingFilesModule.print_missing_route_specs(options)
+  end
+
+  def self.run_spec_tests(type = nil)
+    puts "\nRunning related spec tests...\n"
+
+    if type.nil?
+      system 'bundle exec rake'
+    else
+      command = case type
+                  when 'views' then 'bundle exec rspec spec/views'
+                  when 'mailers' then 'bundle exec rspec spec/mailers'
+                  when 'jobs' then 'bundle exec rspec spec/jobs'
+                  when 'routes' then 'bundle exec rspec spec/routes'
+                  else 'bundle exec rspec'
+                end
+
+      system command
+    end
+  end
+end