specfactor 0.1.7 → 0.1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01a13f3f2f64bd2403f39348c65aa0b323d27944b580a433e2413d5b79b9e16b
-  data.tar.gz: 7c399d1104c9c5ec0aecaa2d8a029c35fb64badb75ff1e9b46efa7de4dc916eb
+  metadata.gz: fd878e0e62b69569097cfc2349b148e77efdc9bd6214061d307fad49541025ee
+  data.tar.gz: 5cd2423a4813d49a9821fc74d13471efe8beebb1ed628e8517ac010b466b6df7
 SHA512:
-  metadata.gz: e518dc8d7f4d3d1386d96e4467e652f42425b6e5e3d0d7e01d0f93be40c2e74d401088a6577fcab8a842f2f959085cb22f33289427ca9080de2202d60abd86b2
-  data.tar.gz: c01ffc8b9f818f18c9fe3f08af325079917e98276392c6c72bbec43d72a0219df41094b713d973b2ba2cc90dc41897a065af42f657ddcb70adecc68c2d7c1c9a
+  metadata.gz: 638c566c0df5dd98a09d5471b0b31bf209bd87bb297ffd741636e43617124e09ebbe843335aae2b97618bcd862e7164d2a007591ba0154412d618d928a61e482
+  data.tar.gz: 4de1048cac6bdecb3f04db1b2e586c84b3685ad83136a9403d6b1d8c1aed08f1756717443667ade8423c1d8b83f86e4824b442856762b188979844b323deafb9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    specfactor (0.1.7)
+    specfactor (0.1.8.1)
       activesupport (~> 5.2.0)
       thor (~> 0.20)
 
@@ -13,6 +13,7 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    byebug (10.0.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     i18n (1.1.0)
@@ -42,6 +43,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  byebug
   rake (~> 10.0)
   rspec (~> 3.0)
   specfactor!

data/README.md

@@ -2,6 +2,13 @@
 
 Specfactor is a gem that generates commonly used tests for commonly used controller actions.
 
+<p style="margin: 0 auto">
+  <img src="https://img.shields.io/badge/version-0.1.8-green.svg">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg">
+  <img src="https://img.shields.io/badge/downloads-1000+-red.svg">
+   <img src="https://img.shields.io/badge/development-PRs Welcome-green.svg">
+</p>
+
 ## Installation
 
 Specfactor is dependent on these gems: 
@@ -63,6 +70,44 @@ Or generate both E2E tests and the Factory:
     
 Currently, tests can be generated for :index, :show, :new, :create, :edit, :update, and :destroy.
 
+## Customizing Generated Tests
+
+Specfactor allows for customization of modules used to generate tests. First, type:
+
+    specfac extract <path to copy modules to>
+    
+Please indicate a path such as __Users/YOUR NAME/Desktop__. 
+Do not include a beginning or ending "/". If you run into issues where Specfactor stops executing, it may be due to an invalid path supplied in the __extract__ command. 
+If this is the case, you can access the path variable directly by going to your Ruby directory and
+modifying the options.json file.
+
+My directory is at __.rvm/gems/ruby-2.4.4/gems/specfactor/lib/specfac/options.json__
+
+Here is an example:
+
+    specfac extract Users/viktharien/Desktop
+    
+This will create a <code>modules</code> folder on my desktop. Inside the folder will be five ruby files:
+
+    spec_module.rb
+    factory_module.rb
+    support_module.rb
+    e2e_module.rb
+    utils.rb
+    
+<code>spec_module</code> contains the templates for controller tests.
+
+<code>factory_module</code> contains the templates for FactoryBot factories.
+
+<code>support_module</code> contains the templates for DatabaseCleaner and FactoryBot configuration.
+
+<code>e2e_module</code> contains the templates for Capybara tests.
+
+<code>utils</code> contains utility code used by the templates, so don't modify or else things will break.
+
+Replace or modify the code in these files and the next time you use Specfactor to generate tests,
+your modifications will be used.
+
 ## Other Commands
 
 To generate configuration settings for DatabaseCleaner and FactoryBot:

data/lib/specfac.rb

@@ -1,19 +1,56 @@
-require 'specfac'
-require 'specfac/version'
+require 'json'
+require 'fileutils'
 require 'thor'
-require 'spec_module'
-require 'factory_module'
-require 'support_module'
-require 'e2e_module'
+require 'thor/group'
+gem_path = 'specfac'
+mod_path = 'modules'
+lib_path = "/lib/#{gem_path}"
+abs_dir_path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
+path_join = lambda { |dir_path, file_path| dir_path + file_path }
+options_path = path_join.call(abs_dir_path,"#{lib_path}/options.json")
+options = JSON.parse(File.read(options_path))
+selector = options['path']
+
+
+actual_path =  if selector == 'root'
+    gem_path
+  else
+    selector = selector[0] == "/" ? selector : "/#{selector}"
+    $LOAD_PATH.unshift(selector)
+
+    if !Dir.exists?("#{selector}/#{mod_path}")
+      Dir.mkdir("#{selector}/#{mod_path}")
+      FileUtils.cp_r(path_join.call(abs_dir_path,"#{lib_path}/#{mod_path}/"), selector)
+    end
+    selector
+  end
+
+#### After directory preparation, require modules ####
+
+require "#{gem_path}"
+require "#{gem_path}/version"
+require "#{actual_path}/#{mod_path}/spec_module"
+require "#{actual_path}/#{mod_path}/factory_module"
+require "#{actual_path}/#{mod_path}/support_module"
+require "#{actual_path}/#{mod_path}/e2e_module"
+
 module Specfac
   class CLI < Thor
+    include Thor::Actions
     include Utils
     include SpecModule
     include FactoryModule
     include SupportModule
     include E2eModule
 
-    attr_accessor :dir_support, :dir_controllers, :dir_factories, :dir_features, :working_dirs, :working_file, :available_methods
+    attr_accessor :dir_support,
+                  :dir_controllers,
+                  :dir_factories,
+                  :dir_features,
+                  :working_dirs,
+                  :working_file,
+                  :available_methods,
+                  :paths
 
     ######### AVAILABLE COMMANDS
 
@@ -25,6 +62,21 @@ module Specfac
     #   puts args
     # end
 
+    # -----
+    #
+    #
+
+
+    desc "extract [destination]", "Extracts the Specfactor base modules to the destination specified for customization"
+    method_option :aliases => "ex"
+    def extract(dest)
+      @paths = $paths
+      @paths[:options]["path"] = dest
+      puts "Setting extract destination..."
+      create_file(@paths[:options_path])
+      opener(nil, @paths[:options].to_json, "w", @paths[:options_path])
+    end
+
     # -----
 
     desc "generate [controller] [actions]", "Generates tests for specified actions. Separate actions with spaces."
@@ -59,16 +111,15 @@ module Specfac
     def setup(*args)
       init_vars
       @working_file = "#{@dir_support}/specfac/config.rb"
+      create_file(@working_file)
       args != nil ? args.each {|arg| opener("support", SupportModule.public_send(arg.to_sym), "a")} : nil
-      puts "Generating support: #{@working_file}"
-      sleep 1
-      puts "> completed"
     end
 
     ######## UTILITY METHODS
     #
 
     no_commands do
+
       def init_vars(options=nil)
         @working_dirs = ["spec", "controllers", "factories", "support", "features"]
         @dir_support = "#{@working_dirs[0]}/#{@working_dirs[3]}"
@@ -102,7 +153,7 @@ module Specfac
 
         @working_file = "#{@dir_controllers}/#{controller.downcase}_controller_spec.rb"
         # Spec tests
-
+        create_file(@working_file)
         opener(
             "spec",
             ["require 'rails_helper'","RSpec.describe #{controller.capitalize}Controller, type: :controller do"],
@@ -117,8 +168,9 @@ module Specfac
 
         if options
           if options[:f]
-            puts
+
             @working_file = "#{@dir_factories}/#{Utils.pluralize(controller.downcase)}.rb"
+            create_file(@working_file)
             opener("factory", FactoryModule.create, "w")
             opener("end", nil, "a")
           end
@@ -126,8 +178,8 @@ module Specfac
           # end to end tests
 
           if options[:e]
-            puts
             @working_file = "#{@dir_features}/#{Utils.pluralize(controller.downcase)}_spec.rb"
+            create_file(@working_file)
             opener("feature",
                    ["require 'rails_helper'", "describe 'navigation' do"],
                    "w")
@@ -139,22 +191,19 @@ module Specfac
 
       end
 
-      def opener(mode, lines, open_type)
+      def opener(mode, lines, open_type, file = @working_file)
         filer = lambda do |type, output|
-          File.open(@working_file, type) { |handle| handle.puts output}
+          File.open(file, type) { |handle| handle.puts output}
         end
 
         if mode == "spec" || mode == "feature"
-          puts "Creating #{mode}: #{@working_file}."
           filer.call(open_type, nil)
           lines.each do |item|
             filer.call("a", item)
           end
         elsif mode == "end"
-          puts "> completed"
           filer.call(open_type, lines)
         else
-          puts "Creating #{mode}: #{@working_file}"
           filer.call(open_type, lines)
         end
       end
@@ -181,3 +230,18 @@ module Specfac
 
   end
 end
+
+$paths = {
+    :gem_path => gem_path,
+    :lib_path => lib_path,
+    :mod_path => mod_path,
+    :abs_path => abs_dir_path,
+    :options_path => options_path,
+    :options => options,
+    :path_join => path_join,
+    :selector => selector
+}
+
+
+
+

data/lib/{e2e_module.rb → specfac/modules/e2e_module.rb}

@@ -1,4 +1,4 @@
-require 'specfac_utils'
+require_relative './utils'
 
 module E2eModule
   #end to end testing

data/lib/{factory_module.rb → specfac/modules/factory_module.rb}

@@ -1,4 +1,4 @@
-require 'specfac_utils'
+require_relative './utils'
 
 module FactoryModule
   include Utils

data/lib/{spec_module.rb → specfac/modules/spec_module.rb}

@@ -1,4 +1,4 @@
-require 'specfac_utils'
+require_relative './utils'
 
 module SpecModule
   include Utils

data/lib/specfac/options.json

@@ -0,0 +1 @@
+{"path":"root"}

data/lib/specfac/version.rb

@@ -1,5 +1,5 @@
 module Specfac
-  VERSION = "0.1.7"
+  VERSION = "0.1.8.1"
 
   def self.show_v
     VERSION

data/specfac.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specfactor
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8.1
 platform: ruby
 authors:
 - viktharien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - viktharien@zoho.com
@@ -88,6 +102,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -99,13 +114,14 @@ files:
 - bin/console
 - bin/setup
 - exe/specfac
-- lib/e2e_module.rb
-- lib/factory_module.rb
-- lib/spec_module.rb
 - lib/specfac.rb
+- lib/specfac/modules/e2e_module.rb
+- lib/specfac/modules/factory_module.rb
+- lib/specfac/modules/spec_module.rb
+- lib/specfac/modules/support_module.rb
+- lib/specfac/modules/utils.rb
+- lib/specfac/options.json
 - lib/specfac/version.rb
-- lib/specfac_utils.rb
-- lib/support_module.rb
 - pull_me.txt
 - specfac.gemspec
 homepage: https://github.com/viktharien/specfacthor